ViewPlatformTransformer (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- ij3d.behaviors.ViewPlatformTransformer

Direct Known Subclasses:

InteractiveViewPlatformTransformer
```
public class ViewPlatformTransformer
extends Object
```
This class is a helper class which implements some functions for transforming the view part of the scene graph. The view transformation consists of 5 single transformations: A center transformation, which is responsible for shifting the view to a position so that the content of the universe is centered. A translate transformation, which is adjusted manually, either explicitly or interactively, when the user translates the view with the mouse. A rotation transformation, which is adjusted manually, either explicitly or interactively, when the user rotates the view with the mouse. An animation transformation, which is changed when the universe is animated. A zoom transformation, which translates the view backward and forward The functions in this class mainly aim to facilitate transformations related to the image plate.

Author:

bene

Field Summary

Fields
Modifier and Type Field and Description

protected ImageCanvas3D canvas

protected Point3d rotCenter

protected DefaultUniverse univ

Fields
Modifier and Type	Field and Description
`protected ImageCanvas3D`	`canvas`
`protected Point3d`	`rotCenter`
`protected DefaultUniverse`	`univ`

Constructor Summary

Constructors
Constructor and Description

ViewPlatformTransformer(DefaultUniverse univ, BehaviorCallback callback)
Initialize this ViewPlatformTransformer.

Constructors
Constructor and Description
`ViewPlatformTransformer(DefaultUniverse univ, BehaviorCallback callback)` Initialize this ViewPlatformTransformer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`centerAt(Point3d center)` Center the view at the given point.
`double`	`distanceEyeOrigin()` Calculates the distance between the viewer's eye and the origin in the vworld space.
`double`	`distanceEyeTo(Point3d p)` Calculates the distance between the viewer's eye and an arbitrary point in the vworld space.
`void`	`getAxisVworld(Vector3d axis, Vector3d axisVW)` Calculates from the specified axis in image plate coordinate system the corresponding vector in the vworld coordinate system.
`void`	`getCenterTranslation(Vector3d v)` Retrieves the translation vector which is responsible for centering the view.
`void`	`getRotationCenter(Tuple3d ret)` Copies the rotation center into the given Tuple3d.
`void`	`getTranslateTranslation(Vector3d v)` Retrieves the manual translation vector of the view.
`void`	`getXDir(Vector3d v)` Transforms the x-direction of the image plate to a normalized vector representing this direction in the vworld space.
`void`	`getXDir(Vector3d v, Transform3D ipToVWorld)` Transforms the x-direction of the image plate to a normalized vector representing this direction in the vworld space.
`void`	`getYDir(Vector3d v)` Stores the y-direction in the image plate coordinate system, i.e.
`void`	`getYDir(Vector3d v, Transform3D ipToVWorld)` Transforms the y-direction of the image plate to a normalized vector representing this direction in the vworld space.
`void`	`getZDir(Vector3d v)` Transforms the z-direction of the image plate to a normalized vector representing this direction in the vworld space.
`void`	`getZDir(Vector3d v, Transform3D ipToVWorld)` Transforms the z-direction of the image plate to a normalized vector representing this direction in the vworld space.
`void`	`getZoomTranslation(Vector3d v)` Retrieves the translation vector which is responsible for the current zooming and stores it in the given Vector3d.
`void`	`originInCanvas(Point2d out)` Stores the canvas position of the origin of the vworld in the specified Point2d.
`void`	`pointInCanvas(Point3d in, Point2d out)` Calculates where the specified point in the vworld space is placed on the canvas and stores the result in the specified Point2d.
`void`	`rotate(Vector3d axis, double angle)` Rotates the view around the center of view by the specified angle around the given axis (of the image plate).
`void`	`rotateX(double angle)` Rotates the view around the global rotation center by the specified angle around the x axis (of the image plate).
`void`	`rotateXY(double angleX, double angleY)` Rotates the view around the center of view by the specified angles around the x and y axis (of the image plate).
`void`	`rotateY(double angle)` Rotates the view around the global rotation center by the specified angle around the y axis (of the image plate).
`void`	`rotateZ(double angle)` Rotates the view around the global rotation center by the specified angle around the z axis (of the image plate).
`void`	`translate(Vector3d v)` Translates the view by the specified distances along the x, y and z direction (of the vworld).
`void`	`translateXY(double dx, double dy)` Translates the view by the specified distances along the x and y direction (of the image plate).
`void`	`translateXY(int dxPix, int dyPix)` Translates the view suitable to a mouse movement by dxPix and dyPix on the canvas.
`void`	`updateFrontBackClip()`
`void`	`zoom(int units)` Zoom by the specified amounts of units.
`void`	`zoomTo(double distance)` Moves the view back (i.e.

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

- Field Detail
  - univ
```
protected DefaultUniverse univ
```
  - canvas
```
protected ImageCanvas3D canvas
```
  - rotCenter
```
protected final Point3d rotCenter
```
- Constructor Detail
  - ViewPlatformTransformer
```
public ViewPlatformTransformer(DefaultUniverse univ,
                               BehaviorCallback callback)
```
    Initialize this ViewPlatformTransformer.
    
    Parameters:
    
    univ -
    
    callback -
- Method Detail
  - getRotationCenter
```
public void getRotationCenter(Tuple3d ret)
```
    Copies the rotation center into the given Tuple3d.
  - zoomTo
```
public void zoomTo(double distance)
```
    Moves the view back (i.e. in the z-direction of the image plate) to the specified distance.
    
    Parameters:
    
    distance -
  - updateFrontBackClip
```
public void updateFrontBackClip()
```
  - zoom
```
public void zoom(int units)
```
    Zoom by the specified amounts of units.
    
    Parameters:
    
    units -
  - centerAt
```
public void centerAt(Point3d center)
```
    Center the view at the given point.
    
    Parameters:
    
    center -
  - translateXY
```
public void translateXY(int dxPix,
                        int dyPix)
```
    Translates the view suitable to a mouse movement by dxPix and dyPix on the canvas.
    
    Parameters:
    
    dxPix -
    
    dyPix -
  - translate
```
public void translate(Vector3d v)
```
    Translates the view by the specified distances along the x, y and z direction (of the vworld).
    
    Parameters:
    
    v - The distances in x, y and z direction, given in vworld dimensions.
  - translateXY
```
public void translateXY(double dx,
                        double dy)
```
    Translates the view by the specified distances along the x and y direction (of the image plate).
    
    Parameters:
    
    dx - The distance in x direction, given in vworld dimensions.
    
    dy - The distance in y direction, given in vworld dimensions.
  - rotateX
```
public void rotateX(double angle)
```
    Rotates the view around the global rotation center by the specified angle around the x axis (of the image plate).
    
    Parameters:
    
    angle - The angle (in rad) around the x-axis
  - rotateY
```
public void rotateY(double angle)
```
    Rotates the view around the global rotation center by the specified angle around the y axis (of the image plate).
    
    Parameters:
    
    angle - The angle (in rad) around the y-axis
  - rotateZ
```
public void rotateZ(double angle)
```
    Rotates the view around the global rotation center by the specified angle around the z axis (of the image plate).
    
    Parameters:
    
    angle - The angle (in rad) around the z-axis
  - rotate
```
public void rotate(Vector3d axis,
                   double angle)
```
    Rotates the view around the center of view by the specified angle around the given axis (of the image plate).
    
    Parameters:
    
    axis - The axis of rotation (in image plate coordinate system)
    
    angle - The angle (in rad) around the given axis
  - rotateXY
```
public void rotateXY(double angleX,
                     double angleY)
```
    Rotates the view around the center of view by the specified angles around the x and y axis (of the image plate).
    
    Parameters:
    
    angleX - The angle (in rad) around the x-axis
    
    angleY - The angle (in rad) around the y-axis
  - getTranslateTranslation
```
public void getTranslateTranslation(Vector3d v)
```
    Retrieves the manual translation vector of the view.
    
    Parameters:
    
    v -
  - getCenterTranslation
```
public void getCenterTranslation(Vector3d v)
```
    Retrieves the translation vector which is responsible for centering the view.
    
    Parameters:
    
    v -
  - getZoomTranslation
```
public void getZoomTranslation(Vector3d v)
```
    Retrieves the translation vector which is responsible for the current zooming and stores it in the given Vector3d.
    
    Parameters:
    
    v -
  - originInCanvas
```
public void originInCanvas(Point2d out)
```
    Stores the canvas position of the origin of the vworld in the specified Point2d.
    
    Parameters:
    
    out -
  - pointInCanvas
```
public void pointInCanvas(Point3d in,
                          Point2d out)
```
    Calculates where the specified point in the vworld space is placed on the canvas and stores the result in the specified Point2d.
    
    Parameters:
    
    in -
    
    out -
  - distanceEyeTo
```
public double distanceEyeTo(Point3d p)
```
    Calculates the distance between the viewer's eye and an arbitrary point in the vworld space.
    
    Returns:
  - distanceEyeOrigin
```
public double distanceEyeOrigin()
```
    Calculates the distance between the viewer's eye and the origin in the vworld space.
    
    Returns:
  - getAxisVworld
```
public void getAxisVworld(Vector3d axis,
                          Vector3d axisVW)
```
    Calculates from the specified axis in image plate coordinate system the corresponding vector in the vworld coordinate system.
  - getXDir
```
public void getXDir(Vector3d v)
```
    Transforms the x-direction of the image plate to a normalized vector representing this direction in the vworld space.
    
    Parameters:
    
    v - Vector3d in which the result in stored.
  - getXDir
```
public void getXDir(Vector3d v,
                    Transform3D ipToVWorld)
```
    Transforms the x-direction of the image plate to a normalized vector representing this direction in the vworld space.
    
    Parameters:
    
    v - Vector3d in which the result in stored.
    
    ipToVWorld - the image plate to vworld transformation.
  - getYDir
```
public void getYDir(Vector3d v)
```
    Stores the y-direction in the image plate coordinate system, i.e. the direction towards the user, in the given Vector3d.
    
    Parameters:
    
    v - Vector3d in which the result in stored.
  - getYDir
```
public void getYDir(Vector3d v,
                    Transform3D ipToVWorld)
```
    Transforms the y-direction of the image plate to a normalized vector representing this direction in the vworld space.
    
    Parameters:
    
    v - Vector3d in which the result in stored.
    
    ipToVWorld - the image plate to vworld transformation.
  - getZDir
```
public void getZDir(Vector3d v)
```
    Transforms the z-direction of the image plate to a normalized vector representing this direction in the vworld space.
    
    Parameters:
    
    v - Vector3d in which the result in stored.
  - getZDir
```
public void getZDir(Vector3d v,
                    Transform3D ipToVWorld)
```
    Transforms the z-direction of the image plate to a normalized vector representing this direction in the vworld space.
    
    Parameters:
    
    v - Vector3d in which the result in stored.
    
    ipToVWorld - the image plate to vworld transformation.

Class ViewPlatformTransformer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

univ

canvas

rotCenter

Constructor Detail

ViewPlatformTransformer

Method Detail

getRotationCenter

zoomTo

updateFrontBackClip

zoom

centerAt

translateXY

translate

translateXY

rotateX

rotateY

rotateZ

rotate

rotateXY

getTranslateTranslation

getCenterTranslation

getZoomTranslation

originInCanvas

pointInCanvas

distanceEyeTo

distanceEyeOrigin

getAxisVworld

getXDir

getXDir

getYDir

getYDir

getZDir

getZDir