ViewHandler (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.visbio.view.ViewHandler

All Implemented Interfaces:

Saveable
```
public class ViewHandler
extends Object
implements Saveable
```
Provides logic for controlling a VisAD display's view.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`boundingBox` Whether bounding box is visible.
`static double`	`DEFAULT_ROTATION` Default rotation factor for 3D displays.
`static double`	`DEFAULT_ZOOM_2D` Default zoom factor for 2D displays.
`static double`	`DEFAULT_ZOOM_3D` Default zoom factor for 3D displays.
`protected double[]`	`matrix` Matrix representing current display projection.
`static double`	`PAN_AMOUNT` How far display pans each time.
`protected ViewPanel`	`panel` GUI controls for view handler.
`protected boolean`	`parallel` Whether display is in parallel projection mode.
`static double`	`ROTATION_AMOUNT` How far display rotates each time.
`protected boolean`	`showScale` Whether scale is visible.
`protected DisplayWindow`	`window` Associated display window.
`protected double`	`xasp` Aspect ratio of the display.
`protected double`	`yasp` Aspect ratio of the display.
`protected double`	`zasp` Aspect ratio of the display.
`static double`	`ZOOM_AMOUNT` How far display zooms in or out each time.

Constructor Summary

Constructors
Constructor and Description

ViewHandler(DisplayWindow dw)
Creates a display view handler.

Constructors
Constructor and Description
`ViewHandler(DisplayWindow dw)` Creates a display view handler.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyMatrix(double[] m)` Applies the given matrix transform to the display.
`protected void`	`doAspect(double x, double y, double z)` Adjusts the aspect ratio.
`double`	`getAspectX()` Gets aspect ratio X component.
`double`	`getAspectY()` Gets aspect ratio Y component.
`double`	`getAspectZ()` Gets aspect ratio Z component.
`double[]`	`getMatrix()` Gets the display's current matrix transform.
`ViewPanel`	`getPanel()` Gets GUI controls for this view handler.
`DisplayWindow`	`getWindow()` Gets associated display window.
`void`	`guessAspect()` Guesses aspect ratio based on first linked data transform.
`void`	`initState(ViewHandler handler)` Modifies this object's state to match that of the given object.
`boolean`	`isBoundingBox()` Gets visibility of the display's bounding box.
`boolean`	`isParallel()` Gets whether 3D display uses a parallel projection.
`boolean`	`isScale()` Gets visibility of scale.
`protected double[]`	`makeDefaultMatrix()` Creates a matrix at the default orientation for the display.
`boolean`	`matches(ViewHandler handler)` Tests whether two objects are in equivalent states.
`void`	`pan(double panx, double pany, double panz)` Pans the display in the given direction.
`void`	`panDown()` Slides the display downward.
`void`	`panLeft()` Slides the display to the left.
`void`	`panRight()` Slides the display to the right.
`void`	`panUp()` Slides the display upward.
`void`	`reset()` Restores the display's zoom and orientation to the original values.
`void`	`restoreState(Element el)` Restores the current state from the given DOM element ("Display").
`void`	`rotate(double rotx, double roty, double rotz)` Rotates the display in the given direction.
`void`	`rotateClockwise()` Rotates the display clockwise (2D and 3D).
`void`	`rotateCounterclockwise()` Rotates the display counterclockwise (2D and 3D).
`void`	`rotateDown()` Rotates the display downward (3D only).
`void`	`rotateLeft()` Rotates the display to the left (3D only).
`void`	`rotateRight()` Rotates the display to the right (3D only).
`void`	`rotateUp()` Rotates the display upward (3D only).
`void`	`saveState(Element el)` Writes the current state to the given DOM element ("Display").
`void`	`setAspect(double x, double y, double z)` Adjusts the aspect ratio.
`protected void`	`setMatrix(double[] m)` Sets the display's projection matrix to match the given one.
`void`	`toggleBoundingBox(boolean value)` Toggles visibility of the display's bounding box.
`void`	`toggleParallel(boolean value)` Toggles whether 3D display uses a parallel projection.
`void`	`toggleScale(boolean value)` Toggles visibility of scale.
`void`	`zoom(double scale)` Zooms the display by the given amount.
`void`	`zoomIn()` Zooms in on the display.
`void`	`zoomOut()` Zooms out on the display.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_ZOOM_2D
```
public static final double DEFAULT_ZOOM_2D
```
    Default zoom factor for 2D displays.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ZOOM_3D
```
public static final double DEFAULT_ZOOM_3D
```
    Default zoom factor for 3D displays.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ROTATION
```
public static final double DEFAULT_ROTATION
```
    Default rotation factor for 3D displays.
    
    See Also:
    
    Constant Field Values
  - ZOOM_AMOUNT
```
public static final double ZOOM_AMOUNT
```
    How far display zooms in or out each time.
    
    See Also:
    
    Constant Field Values
  - ROTATION_AMOUNT
```
public static final double ROTATION_AMOUNT
```
    How far display rotates each time.
    
    See Also:
    
    Constant Field Values
  - PAN_AMOUNT
```
public static final double PAN_AMOUNT
```
    How far display pans each time.
    
    See Also:
    
    Constant Field Values
  - window
```
protected DisplayWindow window
```
    Associated display window.
  - xasp
```
protected double xasp
```
    Aspect ratio of the display.
  - yasp
```
protected double yasp
```
    Aspect ratio of the display.
  - zasp
```
protected double zasp
```
    Aspect ratio of the display.
  - showScale
```
protected boolean showScale
```
    Whether scale is visible.
  - boundingBox
```
protected boolean boundingBox
```
    Whether bounding box is visible.
  - parallel
```
protected boolean parallel
```
    Whether display is in parallel projection mode.
  - matrix
```
protected double[] matrix
```
    Matrix representing current display projection.
  - panel
```
protected ViewPanel panel
```
    GUI controls for view handler.
- Constructor Detail
  - ViewHandler
```
public ViewHandler(DisplayWindow dw)
```
    Creates a display view handler.
- Method Detail
  - getWindow
```
public DisplayWindow getWindow()
```
    Gets associated display window.
  - getPanel
```
public ViewPanel getPanel()
```
    Gets GUI controls for this view handler.
  - zoomIn
```
public void zoomIn()
```
    Zooms in on the display.
  - zoomOut
```
public void zoomOut()
```
    Zooms out on the display.
  - rotateClockwise
```
public void rotateClockwise()
```
    Rotates the display clockwise (2D and 3D).
  - rotateCounterclockwise
```
public void rotateCounterclockwise()
```
    Rotates the display counterclockwise (2D and 3D).
  - rotateLeft
```
public void rotateLeft()
```
    Rotates the display to the left (3D only).
  - rotateRight
```
public void rotateRight()
```
    Rotates the display to the right (3D only).
  - rotateUp
```
public void rotateUp()
```
    Rotates the display upward (3D only).
  - rotateDown
```
public void rotateDown()
```
    Rotates the display downward (3D only).
  - panLeft
```
public void panLeft()
```
    Slides the display to the left.
  - panRight
```
public void panRight()
```
    Slides the display to the right.
  - panUp
```
public void panUp()
```
    Slides the display upward.
  - panDown
```
public void panDown()
```
    Slides the display downward.
  - zoom
```
public void zoom(double scale)
```
    Zooms the display by the given amount.
  - rotate
```
public void rotate(double rotx,
                   double roty,
                   double rotz)
```
    Rotates the display in the given direction.
  - pan
```
public void pan(double panx,
                double pany,
                double panz)
```
    Pans the display in the given direction.
  - applyMatrix
```
public void applyMatrix(double[] m)
```
    Applies the given matrix transform to the display.
  - getMatrix
```
public double[] getMatrix()
```
    Gets the display's current matrix transform.
  - reset
```
public void reset()
```
    Restores the display's zoom and orientation to the original values.
  - guessAspect
```
public void guessAspect()
```
    Guesses aspect ratio based on first linked data transform.
  - setAspect
```
public void setAspect(double x,
                      double y,
                      double z)
```
    Adjusts the aspect ratio.
  - getAspectX
```
public double getAspectX()
```
    Gets aspect ratio X component.
  - getAspectY
```
public double getAspectY()
```
    Gets aspect ratio Y component.
  - getAspectZ
```
public double getAspectZ()
```
    Gets aspect ratio Z component.
  - toggleScale
```
public void toggleScale(boolean value)
```
    Toggles visibility of scale.
  - isScale
```
public boolean isScale()
```
    Gets visibility of scale.
  - toggleBoundingBox
```
public void toggleBoundingBox(boolean value)
```
    Toggles visibility of the display's bounding box.
  - isBoundingBox
```
public boolean isBoundingBox()
```
    Gets visibility of the display's bounding box.
  - toggleParallel
```
public void toggleParallel(boolean value)
```
    Toggles whether 3D display uses a parallel projection.
  - isParallel
```
public boolean isParallel()
```
    Gets whether 3D display uses a parallel projection.
  - matches
```
public boolean matches(ViewHandler handler)
```
    Tests whether two objects are in equivalent states.
  - initState
```
public void initState(ViewHandler handler)
```
    Modifies this object's state to match that of the given object. If the argument is null, the object is initialized according to its current state instead.
  - saveState
```
public void saveState(Element el)
               throws SaveException
```
    Writes the current state to the given DOM element ("Display").
    
    Specified by:
    
    saveState in interface Saveable
    
    Throws:
    
    SaveException
  - restoreState
```
public void restoreState(Element el)
                  throws SaveException
```
    Restores the current state from the given DOM element ("Display").
    
    Specified by:
    
    restoreState in interface Saveable
    
    Throws:
    
    SaveException
  - doAspect
```
protected void doAspect(double x,
                        double y,
                        double z)
```
    Adjusts the aspect ratio.
  - makeDefaultMatrix
```
protected double[] makeDefaultMatrix()
```
    Creates a matrix at the default orientation for the display.
  - setMatrix
```
protected void setMatrix(double[] m)
```
    Sets the display's projection matrix to match the given one.

Class ViewHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ZOOM_2D

DEFAULT_ZOOM_3D

DEFAULT_ROTATION

ZOOM_AMOUNT

ROTATION_AMOUNT

PAN_AMOUNT

window

xasp

yasp

zasp

showScale

boundingBox

parallel

matrix

panel

Constructor Detail

ViewHandler

Method Detail

getWindow

getPanel

zoomIn

zoomOut

rotateClockwise

rotateCounterclockwise

rotateLeft

rotateRight

rotateUp

rotateDown

panLeft

panRight

panUp

panDown

zoom

rotate

pan

applyMatrix

getMatrix

reset

guessAspect

setAspect

getAspectX

getAspectY

getAspectZ

toggleScale

isScale

toggleBoundingBox

isBoundingBox

toggleParallel

isParallel

matches

initState

saveState

restoreState

doAspect

makeDefaultMatrix

setMatrix