jsynoptic.plugins.java3d
Class ViewTransform

java.lang.Object
  jsynoptic.plugins.java3d.ViewTransform

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ViewTransform
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

See Also:

Serialized Form

Field Summary

static int	FLY_BY_MODE In fly-by mode, the user can freely move in the scene.
static int	ROTATION_MODE In rotation mode, the user rotates the whole scene and can zoom in or out.

Constructor Summary

ViewTransform(ViewingPlatform viewingPlatform)

Method Summary

void	applyTransform()
void	autoZoom() Auto zooms the scene out of all objects
void	changeProjection() Turns perspective on an off
java.lang.Object	clone()
float	getEyeDistance()
int	getPos2DX()
int	getPos2DY()
float	getScaleFactor()
protected float	getSceneSize() Used for auto-zooming to englobe the scene
float	getTransFactorX()
float	getTranslationFactorY()
int	getViewingMode()
float	getWSize()
float	getZoomFactor()
void	init2DPosition(int posX, int posY) Initialize 2D rotation algorithm with the current position as origin.
boolean	isPerspective()
void	reset() Reset all values to default
void	rotate2D(int newX, int newY) Does a rotation of the scene according to moves in a 2D coordinate system.
void	rotate2D(int newX, int newY, boolean inverse) Does a rotation of the scene according to moves in a 2D coordinate system.
void	setEyeDistance(float eyeDistance)
void	setPerspective(boolean p)
void	setPos2DX(int pos2DX)
void	setPos2DY(int pos2DY)
void	setScaleFactor(float scaleFactor)
void	setTransFactorX(float transFactorX)
void	setTranslationFactorY(float transFactorY)
void	setViewingMode(int viewingMode)
void	setWSize(float wsize)
void	setZoomFactor(float zoomFactor)
void	translate2D(int newX, int newY) Does a translation of the scene according to moves in a 2D coordinate system.
void	updateTranslateMatrix() Updates the translation matrix with the translation factors previously specified This is intentionally a separate function, so that it is possible to do multiple factor modifications, in both directions, then finally update the matrix at the end.
void	updateZoomMatrix() Updates the zoom matrix with the translation factors previously specified This is intentionally a separate function, so that it is possible to do multiple factor modifications, then finally update the matrix at the end.
void	zoom(int zoomIncrement) Zooms in or out of the scene according to the increment.
void	zoom2D(int newX, int newY) Uses the 2D increments in position to compute a zoom factor, then zooms the scene accordingly.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROTATION_MODE

public static final int ROTATION_MODE

In rotation mode, the user rotates the whole scene and can zoom in or out. Rotation mode is adapted to study one object. This is the default

See Also:

Constant Field Values

FLY_BY_MODE

public static final int FLY_BY_MODE

In fly-by mode, the user can freely move in the scene. This is more adapted for scenes with multiple objects or for objects with a complex internal geometry to study.

See Also:

Constant Field Values

Constructor Detail

ViewTransform

public ViewTransform(ViewingPlatform viewingPlatform)

Method Detail

getEyeDistance

public float getEyeDistance()

setEyeDistance

public void setEyeDistance(float eyeDistance)

getScaleFactor

public float getScaleFactor()

setScaleFactor

public void setScaleFactor(float scaleFactor)

getTransFactorX

public float getTransFactorX()

setTransFactorX

public void setTransFactorX(float transFactorX)

getTranslationFactorY

public float getTranslationFactorY()

setTranslationFactorY

public void setTranslationFactorY(float transFactorY)

getWSize

public float getWSize()

setWSize

public void setWSize(float wsize)

getZoomFactor

public float getZoomFactor()

setZoomFactor

public void setZoomFactor(float zoomFactor)

setPerspective

public void setPerspective(boolean p)

isPerspective

public boolean isPerspective()

updateTranslateMatrix

public void updateTranslateMatrix()

Updates the translation matrix with the translation factors previously specified This is intentionally a separate function, so that it is possible to do multiple factor modifications, in both directions, then finally update the matrix at the end.

updateZoomMatrix

public void updateZoomMatrix()

Updates the zoom matrix with the translation factors previously specified This is intentionally a separate function, so that it is possible to do multiple factor modifications, then finally update the matrix at the end.

init2DPosition

public void init2DPosition(int posX,
                           int posY)

Initialize 2D rotation algorithm with the current position as origin. Typically, this is related to mouse positions in X and Y. Note that WSize should be set to the same value referential as the positions. This is typically a window dimension.

rotate2D

public void rotate2D(int newX,
                     int newY)

Does a rotation of the scene according to moves in a 2D coordinate system. Use init2DPosition to position an origin, then do as many rotate2D as required. Note that WSize should be set to the same value referential as the positions. This is typically a window dimension.

Parameters:

newX - The new X position in 2D, typically a mouse position

newY - The new Y position in 2D, typically a mouse position

rotate2D

public void rotate2D(int newX,
                     int newY,
                     boolean inverse)

Does a rotation of the scene according to moves in a 2D coordinate system. Use init2DPosition to position an origin, then do as many rotate2D as required. Note that WSize should be set to the same value referential as the positions. This is typically a window dimension.

Parameters:

newX - The new X position in 2D, typically a mouse position

newY - The new Y position in 2D, typically a mouse position

inverse - Inverse the direction of the rotation if true. This is used ROTATION_MODE viewing mode for the scene, in which case the scene rotates according to the mouse => in fact, the camera rotates in the opposite direction. => default is true

changeProjection

public void changeProjection()

Turns perspective on an off

reset

public void reset()

Reset all values to default

getPos2DX

public int getPos2DX()

Returns:

Returns the pos2DX.

setPos2DX

public void setPos2DX(int pos2DX)

Parameters:

pos2DX - The pos2DX to set.

getPos2DY

public int getPos2DY()

Returns:

Returns the pos2DY.

setPos2DY

public void setPos2DY(int pos2DY)

Parameters:

pos2DY - The pos2DY to set.

getViewingMode

public int getViewingMode()

Returns:

Returns the viewingMode.

setViewingMode

public void setViewingMode(int viewingMode)

Parameters:

viewingMode - The viewingMode to set.

autoZoom

public void autoZoom()

Auto zooms the scene out of all objects

getSceneSize

protected float getSceneSize()

Used for auto-zooming to englobe the scene

Returns:

<=0 if not supported, or the max distance from the origin for any point in the scene otherwise

zoom

public void zoom(int zoomIncrement)

Zooms in or out of the scene according to the increment. This is an arbitrary algorithm to help create correct zoom factors. You could use setZoomFactor and then update the zoom matrix directly, with the same effect.
The added value of this function is to provide a relative and easy to manipulate way to zoom in or out, with increments like +1 or -1 for small zooms, and +10 and -10 for greater zooms, etc...
Note that WSize should be set correctly.

Parameters:

zoomIncrement - A value typically 1 or -1, but which can be greater for fast zooms. Positive values zoom in, negative values zoom out.

zoom2D

public void zoom2D(int newX,
                   int newY)

Uses the 2D increments in position to compute a zoom factor, then zooms the scene accordingly.

Parameters:

newX - The new X position in 2D, typically a mouse position

newY - The new Y position in 2D, typically a mouse position

translate2D

public void translate2D(int newX,
                        int newY)

Does a translation of the scene according to moves in a 2D coordinate system. Use init2DPosition to position an origin, then do as many translate2D as required. Note that WSize should be set to the same value referential as the positions. This is typically a window dimension.

Parameters:

newX - The new X position in 2D, typically a mouse position

newY - The new Y position in 2D, typically a mouse position

applyTransform

public void applyTransform()

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException