TransformEventHandler3D (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- bdv.TransformEventHandler3D

All Implemented Interfaces:

TransformEventHandler
```
public class TransformEventHandler3D
extends Object
implements TransformEventHandler
```
A TransformEventHandler that changes an AffineTransform3D through a set of Behaviours.

Author:

Stephan Saalfeld, Tobias Pietzsch

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DRAG_ROTATE`
`static String`	`DRAG_ROTATE_FAST`
`static String[]`	`DRAG_ROTATE_FAST_KEYS`
`static String[]`	`DRAG_ROTATE_KEYS`
`static String`	`DRAG_ROTATE_SLOW`
`static String[]`	`DRAG_ROTATE_SLOW_KEYS`
`static String`	`DRAG_TRANSLATE`
`static String[]`	`DRAG_TRANSLATE_KEYS`
`static String`	`KEY_BACKWARD_Z`
`static String`	`KEY_BACKWARD_Z_FAST`
`static String[]`	`KEY_BACKWARD_Z_FAST_KEYS`
`static String[]`	`KEY_BACKWARD_Z_KEYS`
`static String`	`KEY_BACKWARD_Z_SLOW`
`static String[]`	`KEY_BACKWARD_Z_SLOW_KEYS`
`static String`	`KEY_FORWARD_Z`
`static String`	`KEY_FORWARD_Z_FAST`
`static String[]`	`KEY_FORWARD_Z_FAST_KEYS`
`static String[]`	`KEY_FORWARD_Z_KEYS`
`static String`	`KEY_FORWARD_Z_SLOW`
`static String[]`	`KEY_FORWARD_Z_SLOW_KEYS`
`static String`	`KEY_ZOOM_IN`
`static String`	`KEY_ZOOM_IN_FAST`
`static String[]`	`KEY_ZOOM_IN_FAST_KEYS`
`static String[]`	`KEY_ZOOM_IN_KEYS`
`static String`	`KEY_ZOOM_IN_SLOW`
`static String[]`	`KEY_ZOOM_IN_SLOW_KEYS`
`static String`	`KEY_ZOOM_OUT`
`static String`	`KEY_ZOOM_OUT_FAST`
`static String[]`	`KEY_ZOOM_OUT_FAST_KEYS`
`static String[]`	`KEY_ZOOM_OUT_KEYS`
`static String`	`KEY_ZOOM_OUT_SLOW`
`static String[]`	`KEY_ZOOM_OUT_SLOW_KEYS`
`static String`	`ROTATE_LEFT`
`static String`	`ROTATE_LEFT_FAST`
`static String[]`	`ROTATE_LEFT_FAST_KEYS`
`static String[]`	`ROTATE_LEFT_KEYS`
`static String`	`ROTATE_LEFT_SLOW`
`static String[]`	`ROTATE_LEFT_SLOW_KEYS`
`static String`	`ROTATE_RIGHT`
`static String`	`ROTATE_RIGHT_FAST`
`static String[]`	`ROTATE_RIGHT_FAST_KEYS`
`static String[]`	`ROTATE_RIGHT_KEYS`
`static String`	`ROTATE_RIGHT_SLOW`
`static String[]`	`ROTATE_RIGHT_SLOW_KEYS`
`static String`	`SCROLL_Z`
`static String`	`SCROLL_Z_FAST`
`static String[]`	`SCROLL_Z_FAST_KEYS`
`static String[]`	`SCROLL_Z_KEYS`
`static String`	`SCROLL_Z_SLOW`
`static String[]`	`SCROLL_Z_SLOW_KEYS`
`static String`	`SELECT_AXIS_X`
`static String[]`	`SELECT_AXIS_X_KEYS`
`static String`	`SELECT_AXIS_Y`
`static String[]`	`SELECT_AXIS_Y_KEYS`
`static String`	`SELECT_AXIS_Z`
`static String[]`	`SELECT_AXIS_Z_KEYS`
`static String`	`ZOOM_NORMAL`
`static String[]`	`ZOOM_NORMAL_KEYS`

Constructor Summary

Constructors
Constructor and Description

TransformEventHandler3D(TransformState transform)

Constructors
Constructor and Description
`TransformEventHandler3D(TransformState transform)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`install(Behaviours behaviours)` Install transformation behaviours into the specified `behaviours` contrainer.
`void`	`setCanvasSize(int width, int height, boolean updateTransform)` This is called, when the screen size of the canvas (the component displaying the image and generating mouse events) changes.

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

Field Detail

DRAG_TRANSLATE

public static final String DRAG_TRANSLATE

See Also:: Constant Field Values

ZOOM_NORMAL
```
public static final String ZOOM_NORMAL
```
See Also:

Constant Field Values

SELECT_AXIS_X

public static final String SELECT_AXIS_X

See Also:: Constant Field Values

SELECT_AXIS_Y

public static final String SELECT_AXIS_Y

See Also:: Constant Field Values

SELECT_AXIS_Z

public static final String SELECT_AXIS_Z

See Also:: Constant Field Values

DRAG_ROTATE
```
public static final String DRAG_ROTATE
```
See Also:

Constant Field Values

SCROLL_Z
```
public static final String SCROLL_Z
```
See Also:

Constant Field Values

ROTATE_LEFT
```
public static final String ROTATE_LEFT
```
See Also:

Constant Field Values

ROTATE_RIGHT

public static final String ROTATE_RIGHT

See Also:: Constant Field Values

KEY_ZOOM_IN
```
public static final String KEY_ZOOM_IN
```
See Also:

Constant Field Values

KEY_ZOOM_OUT

public static final String KEY_ZOOM_OUT

See Also:: Constant Field Values

KEY_FORWARD_Z

public static final String KEY_FORWARD_Z

See Also:: Constant Field Values

KEY_BACKWARD_Z

public static final String KEY_BACKWARD_Z

See Also:: Constant Field Values

DRAG_ROTATE_FAST

public static final String DRAG_ROTATE_FAST

See Also:: Constant Field Values

SCROLL_Z_FAST

public static final String SCROLL_Z_FAST

See Also:: Constant Field Values

ROTATE_LEFT_FAST

public static final String ROTATE_LEFT_FAST

See Also:: Constant Field Values

ROTATE_RIGHT_FAST

public static final String ROTATE_RIGHT_FAST

See Also:: Constant Field Values

KEY_ZOOM_IN_FAST

public static final String KEY_ZOOM_IN_FAST

See Also:: Constant Field Values

KEY_ZOOM_OUT_FAST

public static final String KEY_ZOOM_OUT_FAST

See Also:: Constant Field Values

KEY_FORWARD_Z_FAST

public static final String KEY_FORWARD_Z_FAST

See Also:: Constant Field Values

KEY_BACKWARD_Z_FAST

public static final String KEY_BACKWARD_Z_FAST

See Also:: Constant Field Values

DRAG_ROTATE_SLOW

public static final String DRAG_ROTATE_SLOW

See Also:: Constant Field Values

SCROLL_Z_SLOW

public static final String SCROLL_Z_SLOW

See Also:: Constant Field Values

ROTATE_LEFT_SLOW

public static final String ROTATE_LEFT_SLOW

See Also:: Constant Field Values

ROTATE_RIGHT_SLOW

public static final String ROTATE_RIGHT_SLOW

See Also:: Constant Field Values

KEY_ZOOM_IN_SLOW

public static final String KEY_ZOOM_IN_SLOW

See Also:: Constant Field Values

KEY_ZOOM_OUT_SLOW

public static final String KEY_ZOOM_OUT_SLOW

See Also:: Constant Field Values

KEY_FORWARD_Z_SLOW

public static final String KEY_FORWARD_Z_SLOW

See Also:: Constant Field Values

KEY_BACKWARD_Z_SLOW

public static final String KEY_BACKWARD_Z_SLOW

See Also:: Constant Field Values

DRAG_TRANSLATE_KEYS

public static final String[] DRAG_TRANSLATE_KEYS

ZOOM_NORMAL_KEYS

public static final String[] ZOOM_NORMAL_KEYS

SELECT_AXIS_X_KEYS

public static final String[] SELECT_AXIS_X_KEYS

SELECT_AXIS_Y_KEYS

public static final String[] SELECT_AXIS_Y_KEYS

SELECT_AXIS_Z_KEYS

public static final String[] SELECT_AXIS_Z_KEYS

DRAG_ROTATE_KEYS

public static final String[] DRAG_ROTATE_KEYS

SCROLL_Z_KEYS

public static final String[] SCROLL_Z_KEYS

ROTATE_LEFT_KEYS

public static final String[] ROTATE_LEFT_KEYS

ROTATE_RIGHT_KEYS

public static final String[] ROTATE_RIGHT_KEYS

KEY_ZOOM_IN_KEYS

public static final String[] KEY_ZOOM_IN_KEYS

KEY_ZOOM_OUT_KEYS

public static final String[] KEY_ZOOM_OUT_KEYS

KEY_FORWARD_Z_KEYS

public static final String[] KEY_FORWARD_Z_KEYS

KEY_BACKWARD_Z_KEYS

public static final String[] KEY_BACKWARD_Z_KEYS

DRAG_ROTATE_FAST_KEYS

public static final String[] DRAG_ROTATE_FAST_KEYS

SCROLL_Z_FAST_KEYS

public static final String[] SCROLL_Z_FAST_KEYS

ROTATE_LEFT_FAST_KEYS

public static final String[] ROTATE_LEFT_FAST_KEYS

ROTATE_RIGHT_FAST_KEYS

public static final String[] ROTATE_RIGHT_FAST_KEYS

KEY_ZOOM_IN_FAST_KEYS

public static final String[] KEY_ZOOM_IN_FAST_KEYS

KEY_ZOOM_OUT_FAST_KEYS

public static final String[] KEY_ZOOM_OUT_FAST_KEYS

KEY_FORWARD_Z_FAST_KEYS

public static final String[] KEY_FORWARD_Z_FAST_KEYS

KEY_BACKWARD_Z_FAST_KEYS

public static final String[] KEY_BACKWARD_Z_FAST_KEYS

DRAG_ROTATE_SLOW_KEYS

public static final String[] DRAG_ROTATE_SLOW_KEYS

SCROLL_Z_SLOW_KEYS

public static final String[] SCROLL_Z_SLOW_KEYS

ROTATE_LEFT_SLOW_KEYS

public static final String[] ROTATE_LEFT_SLOW_KEYS

ROTATE_RIGHT_SLOW_KEYS

public static final String[] ROTATE_RIGHT_SLOW_KEYS

KEY_ZOOM_IN_SLOW_KEYS

public static final String[] KEY_ZOOM_IN_SLOW_KEYS

KEY_ZOOM_OUT_SLOW_KEYS

public static final String[] KEY_ZOOM_OUT_SLOW_KEYS

KEY_FORWARD_Z_SLOW_KEYS

public static final String[] KEY_FORWARD_Z_SLOW_KEYS

KEY_BACKWARD_Z_SLOW_KEYS

public static final String[] KEY_BACKWARD_Z_SLOW_KEYS

Constructor Detail

TransformEventHandler3D

public TransformEventHandler3D(TransformState transform)

Method Detail
- install
```
public void install(Behaviours behaviours)
```
  Description copied from interface: TransformEventHandler
  
  Install transformation behaviours into the specified behaviours contrainer.
  
  Specified by:
  
  install in interface TransformEventHandler
- setCanvasSize
```
public void setCanvasSize(int width,
                          int height,
                          boolean updateTransform)
```
  Description copied from interface: TransformEventHandler
  
  This is called, when the screen size of the canvas (the component displaying the image and generating mouse events) changes. This can be used to determine screen coordinates to keep fixed while zooming or rotating with the keyboard, e.g., set these to (width/2, height/2). It can also be used to update the current source-to-screen transform, e.g., to change the zoom along with the canvas size.
  
  Specified by:
  
  setCanvasSize in interface TransformEventHandler
  
  Parameters:
  
  width - the new canvas width.
  
  height - the new canvas height.
  
  updateTransform - whether the current source-to-screen transform should be updated. This will be false for the initial update of a new TransformEventHandler and true on subsequent calls.

Class TransformEventHandler3D

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DRAG_TRANSLATE

ZOOM_NORMAL

SELECT_AXIS_X

SELECT_AXIS_Y

SELECT_AXIS_Z

DRAG_ROTATE

SCROLL_Z

ROTATE_LEFT

ROTATE_RIGHT

KEY_ZOOM_IN

KEY_ZOOM_OUT

KEY_FORWARD_Z

KEY_BACKWARD_Z

DRAG_ROTATE_FAST

SCROLL_Z_FAST

ROTATE_LEFT_FAST

ROTATE_RIGHT_FAST

KEY_ZOOM_IN_FAST

KEY_ZOOM_OUT_FAST

KEY_FORWARD_Z_FAST

KEY_BACKWARD_Z_FAST

DRAG_ROTATE_SLOW

SCROLL_Z_SLOW

ROTATE_LEFT_SLOW

ROTATE_RIGHT_SLOW

KEY_ZOOM_IN_SLOW

KEY_ZOOM_OUT_SLOW

KEY_FORWARD_Z_SLOW

KEY_BACKWARD_Z_SLOW

DRAG_TRANSLATE_KEYS

ZOOM_NORMAL_KEYS

SELECT_AXIS_X_KEYS

SELECT_AXIS_Y_KEYS

SELECT_AXIS_Z_KEYS

DRAG_ROTATE_KEYS

SCROLL_Z_KEYS

ROTATE_LEFT_KEYS

ROTATE_RIGHT_KEYS

KEY_ZOOM_IN_KEYS

KEY_ZOOM_OUT_KEYS

KEY_FORWARD_Z_KEYS

KEY_BACKWARD_Z_KEYS

DRAG_ROTATE_FAST_KEYS

SCROLL_Z_FAST_KEYS

ROTATE_LEFT_FAST_KEYS

ROTATE_RIGHT_FAST_KEYS

KEY_ZOOM_IN_FAST_KEYS

KEY_ZOOM_OUT_FAST_KEYS

KEY_FORWARD_Z_FAST_KEYS

KEY_BACKWARD_Z_FAST_KEYS

DRAG_ROTATE_SLOW_KEYS

SCROLL_Z_SLOW_KEYS

ROTATE_LEFT_SLOW_KEYS

ROTATE_RIGHT_SLOW_KEYS

KEY_ZOOM_IN_SLOW_KEYS

KEY_ZOOM_OUT_SLOW_KEYS

KEY_FORWARD_Z_SLOW_KEYS

KEY_BACKWARD_Z_SLOW_KEYS

Constructor Detail

TransformEventHandler3D

Method Detail

install

setCanvasSize