com.interactivemesh.j3d.community.utils.navigation.orbit
Class OrbitBehaviorPoPInterim

java.lang.Object
  extended by javax.media.j3d.SceneGraphObject
      extended by javax.media.j3d.Node
          extended by javax.media.j3d.Leaf
              extended by javax.media.j3d.Behavior
                  extended by com.interactivemesh.j3d.community.utils.navigation.orbit.ViewPlatformBehaviorInterim
                      extended by com.interactivemesh.j3d.community.utils.navigation.orbit.ViewPlatformAWTBehaviorInterim
                          extended by com.interactivemesh.j3d.community.utils.navigation.orbit.OrbitBehaviorPoPInterim
All Implemented Interfaces:
java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

public class OrbitBehaviorPoPInterim
extends ViewPlatformAWTBehaviorInterim

Moves the View around a point of interest when the mouse is dragged with a mouse button pressed. Includes rotation, zoom, and translation actions. Zooming can also be obtained by using mouse wheel.

The rotate action rotates the ViewPlatform around the point of interest when the mouse is moved with the main mouse button pressed. The rotation is in the direction of the mouse movement, with a default rotation of 0.01 radians for each pixel of mouse movement.

The zoom action moves the ViewPlatform closer to or further from the point of interest when the mouse is moved with the middle mouse button pressed (or Alt-main mouse button on systems without a middle mouse button). The default zoom action is to translate the ViewPlatform 0.01 units for each pixel of mouse movement. Moving the mouse up moves the ViewPlatform closer, moving the mouse down moves the ViewPlatform further away.

By default, the zoom action allows the ViewPlatform to move through the center of rotation to orbit at a negative radius. The STOP_ZOOM constructor flag will stop the ViewPlatform at a minimum radius from the center. The default minimum radius is 0.0 and can be set using the setMinRadius method.

The PROPORTIONAL_ZOOM constructor flag changes the zoom action to move the ViewPlatform proportional to its distance from the center of rotation. For this mode, the default action is to move the ViewPlatform by 1% of its distance from the center of rotation for each pixel of mouse movement.

The translate action translates the ViewPlatform when the mouse is moved with the right mouse button pressed (Shift-main mouse button on systems without a right mouse button). The translation is in the direction of the mouse movement, with a default translation of 0.01 units for each pixel of mouse movement.

The sensitivity of the actions can be scaled using the setActionFactor() methods which scale the default movement by the factor. The rotate and translate actions have separate factors for x and y.

The actions can be reversed using the REVERSE_ACTION constructor flags. The default action moves the ViewPlatform around the objects in the scene. The REVERSE_ACTION flags can make the objects in the scene appear to be moving in the direction of the mouse movement.

The actions can be disabled by either using the DISABLE_ACTION constructor flags or the setActionEnable methods.

The default center of rotation is (0, 0, 0) and can be set using the setRotationCenter() method.

Since:
Java 3D 1.2.1

Field Summary
static int DISABLE_ROTATE
          Constructor flag to disable rotate
static int DISABLE_TRANSLATE
          Constructor flag to disable translate
static int DISABLE_ZOOM
          Constructor flag to disable zoom
protected  double maxClipRatio
           
protected  double minBackDistance
           
protected  int projection
           
static int PROPORTIONAL_ZOOM
          Constructor flag to use proportional zoom, which determines how much you zoom based on view's distance from the center of rotation.
protected  double radiusFactor
           
static int REVERSE_ALL
          Constructor flag to reverse all the behaviors
static int REVERSE_ROTATE
          Constructor flag to reverse the rotate behavior
static int REVERSE_TRANSLATE
          Constructor flag to reverse the translate behavior
static int REVERSE_ZOOM
          Constructor flag to reverse the zoom behavior
protected  javax.vecmath.Point3d sceneCenter
           
protected  double sceneRadius
           
protected  javax.media.j3d.BoundingSphere sceneSphere
           
static int STOP_ZOOM
          Constructor flag that indicates zoom should stop when it reaches the minimum orbit radius set by setMinRadius().
protected  javax.media.j3d.View view
           
 
Fields inherited from class com.interactivemesh.j3d.community.utils.navigation.orbit.ViewPlatformAWTBehaviorInterim
component, frameWakeup, motion, MOUSE_LISTENER, MOUSE_MOTION_LISTENER, MOUSE_WHEEL_LISTENER, POST_ID, postWakeup, targetTransform
 
Fields inherited from class com.interactivemesh.j3d.community.utils.navigation.orbit.ViewPlatformBehaviorInterim
homeRotCenter, homeTransform, targetTG
 
Fields inherited from class javax.media.j3d.Node
ALLOW_AUTO_COMPUTE_BOUNDS_READ, ALLOW_AUTO_COMPUTE_BOUNDS_WRITE, ALLOW_BOUNDS_READ, ALLOW_BOUNDS_WRITE, ALLOW_COLLIDABLE_READ, ALLOW_COLLIDABLE_WRITE, ALLOW_LOCAL_TO_VWORLD_READ, ALLOW_LOCALE_READ, ALLOW_PARENT_READ, ALLOW_PICKABLE_READ, ALLOW_PICKABLE_WRITE, ENABLE_COLLISION_REPORTING, ENABLE_PICK_REPORTING
 
Constructor Summary
OrbitBehaviorPoPInterim()
          Constructs a OrbitBehaviorPoPInterim with a null source of Component, a null target of TransformGroup, and no constructor flags.
OrbitBehaviorPoPInterim(java.awt.Component c, javax.media.j3d.TransformGroup tg)
          Constructs a OrbitBehaviorPoPInterim with a specified source of Component, a specified target of TransformGroup, and no constructor flags.
OrbitBehaviorPoPInterim(java.awt.Component c, javax.media.j3d.TransformGroup tg, int flags)
          Constructs a OrbitBehaviorPoPInterim with a specified source of Component, a specified target of TransformGroup, and specified constructor flags.
OrbitBehaviorPoPInterim(java.awt.Component c, javax.media.j3d.TransformGroup tg, javax.media.j3d.View view)
           
OrbitBehaviorPoPInterim(java.awt.Component c, javax.media.j3d.TransformGroup tg, javax.media.j3d.View view, int flags)
           
OrbitBehaviorPoPInterim(int flags)
          Constructs a OrbitBehaviorPoPInterim with a null source of Component, null target of TransformGroup, and specified constructor flags.
 
Method Summary
 javax.media.j3d.Bounds getClippingBounds()
           
 double getMinRadius()
          Returns the minimum orbit radius.
 boolean getRotateEnable()
          Retrieves the state of rotate enabled
 void getRotationCenter(javax.vecmath.Point3d center)
          Places the value of the center around which the View rotates into the Point3d.
 double getRotXFactor()
          Returns the x rotation movement multiplier
 double getRotYFactor()
          Returns the y rotation movement multiplier
 boolean getTranslateEnable()
          Retrieves the state of translate enabled
 double getTransXFactor()
          Returns the x translation movement multiplier
 double getTransYFactor()
          Returns the y translation movement multiplier
 javax.media.j3d.View getView()
           
 boolean getZoomEnable()
          Retrieves the state of zoom enabled
 double getZoomFactor()
          Returns the zoom movement multiplier
 void goHome()
          Positions and reorients the ViewingPlatform to its "home" transform.
 void goHome(boolean aroundHomeCenter)
          Positions and reorients the ViewingPlatform to its "home" transform and the current rotation center is set to the "home" one if desired.
protected  void integrateTransforms()
          Called once per frame (if the view is moving) to calculate the new view platform transform
 boolean isClippingEnabled()
           
 void lookAtRotationCenter()
          Moves the View to the current rotation center.
protected  void processAWTEvents(java.awt.AWTEvent[] events)
          This is called once per frame if there are any AWT events to process.
protected  void resetView()
          Reset the orientation and distance of this behavior to the current values in the ViewPlatform Transform Group
 void setAWTComponent(java.awt.Component c)
          Sets the Component used to listen for mouse, mouse motion, and mouse wheel events.
 void setClippingBounds(javax.media.j3d.Bounds sceneBounds)
           
protected  void setClippingDistances()
           
 void setClippingEnabled(boolean enable)
           
 void setMinRadius(double r)
          Sets the minimum radius for the OrbitBehavior.
 void setProjectionMode(int mode)
           
 void setProjectionMode(int mode, double parScaleFac)
           
 void setProportionalZoom(boolean state)
          Set proportional zoom behavior.
 void setReverseRotate(boolean state)
          Set reverse rotate behavior.
 void setReverseTranslate(boolean state)
          Set reverse translate behavior.
 void setReverseZoom(boolean state)
          Set reverse zoom behavior.
 void setRotateEnable(boolean enabled)
          Enables or disables rotation.
 void setRotationCenter(javax.vecmath.Point3d center)
          Sets the center around which the View rotates.
 void setRotationCenter(javax.vecmath.Point3d center, boolean lookAtRotCenter)
          Sets the center around which the View rotates and moves the View to this center if desired.
 void setRotFactors(double xfactor, double yfactor)
          Sets the rotation x and y factors.
 void setRotXFactor(double xfactor)
          Sets the rotation x factor.
 void setRotYFactor(double yfactor)
          Sets the rotation y factor.
 void setTransFactors(double xfactor, double yfactor)
          Sets the translation x and y factors.
 void setTranslateEnable(boolean enabled)
          Enables or disables translate.
 void setTransXFactor(double xfactor)
          Sets the translation x factor.
 void setTransYFactor(double yfactor)
          Sets the translation y factor.
 void setView(javax.media.j3d.View view)
           
 void setViewingTransformGroup(javax.media.j3d.TransformGroup tg)
          Sets the ViewPlatform's TransformGroup for this behavior.
 void setZoomEnable(boolean enabled)
          Enables or disables zoom.
 void setZoomFactor(double zfactor)
          Sets the zoom factor.
 
Methods inherited from class com.interactivemesh.j3d.community.utils.navigation.orbit.ViewPlatformAWTBehaviorInterim
initialize, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, processStimulus, queueAWTEvent, setEnable, setListenerFlags
 
Methods inherited from class com.interactivemesh.j3d.community.utils.navigation.orbit.ViewPlatformBehaviorInterim
getHomeRotationCenter, getHomeTransform, getViewingTransformGroup, setHomeRotationCenter, setHomeTransform
 
Methods inherited from class javax.media.j3d.Behavior
getEnable, getNumSchedulingIntervals, getSchedulingBoundingLeaf, getSchedulingBounds, getSchedulingInterval, getWakeupCondition, postId, setSchedulingBoundingLeaf, setSchedulingBounds, setSchedulingInterval, updateNodeReferences, wakeupOn
 
Methods inherited from class javax.media.j3d.Node
cloneNode, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, duplicateNode, getBounds, getBoundsAutoCompute, getCollidable, getLocale, getLocalToVworld, getLocalToVworld, getParent, getPickable, setBounds, setBoundsAutoCompute, setCollidable, setPickable
 
Methods inherited from class javax.media.j3d.SceneGraphObject
clearCapability, clearCapabilityIsFrequent, duplicateSceneGraphObject, getCapability, getCapabilityIsFrequent, getName, getUserData, isCompiled, isLive, setCapability, setCapabilityIsFrequent, setName, setUserData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

REVERSE_ROTATE

public static final int REVERSE_ROTATE
Constructor flag to reverse the rotate behavior

See Also:
Constant Field Values

REVERSE_TRANSLATE

public static final int REVERSE_TRANSLATE
Constructor flag to reverse the translate behavior

See Also:
Constant Field Values

REVERSE_ZOOM

public static final int REVERSE_ZOOM
Constructor flag to reverse the zoom behavior

See Also:
Constant Field Values

REVERSE_ALL

public static final int REVERSE_ALL
Constructor flag to reverse all the behaviors

See Also:
Constant Field Values

STOP_ZOOM

public static final int STOP_ZOOM
Constructor flag that indicates zoom should stop when it reaches the minimum orbit radius set by setMinRadius(). The minimus radius default is 0.0.

See Also:
Constant Field Values

DISABLE_ROTATE

public static final int DISABLE_ROTATE
Constructor flag to disable rotate

See Also:
Constant Field Values

DISABLE_TRANSLATE

public static final int DISABLE_TRANSLATE
Constructor flag to disable translate

See Also:
Constant Field Values

DISABLE_ZOOM

public static final int DISABLE_ZOOM
Constructor flag to disable zoom

See Also:
Constant Field Values

PROPORTIONAL_ZOOM

public static final int PROPORTIONAL_ZOOM
Constructor flag to use proportional zoom, which determines how much you zoom based on view's distance from the center of rotation. The percentage of distance that the viewer zooms is determined by the zoom factor.

See Also:
Constant Field Values

view

protected javax.media.j3d.View view

projection

protected int projection

sceneSphere

protected javax.media.j3d.BoundingSphere sceneSphere

sceneCenter

protected javax.vecmath.Point3d sceneCenter

sceneRadius

protected double sceneRadius

radiusFactor

protected double radiusFactor

maxClipRatio

protected double maxClipRatio

minBackDistance

protected double minBackDistance
Constructor Detail

OrbitBehaviorPoPInterim

public OrbitBehaviorPoPInterim()
Constructs a OrbitBehaviorPoPInterim with a null source of Component, a null target of TransformGroup, and no constructor flags.


OrbitBehaviorPoPInterim

public OrbitBehaviorPoPInterim(int flags)
Constructs a OrbitBehaviorPoPInterim with a null source of Component, null target of TransformGroup, and specified constructor flags.

Parameters:
flags - The option flags

OrbitBehaviorPoPInterim

public OrbitBehaviorPoPInterim(java.awt.Component c,
                               javax.media.j3d.TransformGroup tg)
Constructs a OrbitBehaviorPoPInterim with a specified source of Component, a specified target of TransformGroup, and no constructor flags.

Parameters:
c - The Component to add the behavior to
tg - The target TransformGroup for this behavior
Throws:
java.lang.NullPointerException - If the Component or TransformGroup are null.

OrbitBehaviorPoPInterim

public OrbitBehaviorPoPInterim(java.awt.Component c,
                               javax.media.j3d.TransformGroup tg,
                               javax.media.j3d.View view)

OrbitBehaviorPoPInterim

public OrbitBehaviorPoPInterim(java.awt.Component c,
                               javax.media.j3d.TransformGroup tg,
                               int flags)
Constructs a OrbitBehaviorPoPInterim with a specified source of Component, a specified target of TransformGroup, and specified constructor flags.

Parameters:
c - The Component to add the behavior to
tg - The target TransformGroup for this behavior
flags - The option flags
Throws:
java.lang.NullPointerException - If the Component or TransformGroup are null.

OrbitBehaviorPoPInterim

public OrbitBehaviorPoPInterim(java.awt.Component c,
                               javax.media.j3d.TransformGroup tg,
                               javax.media.j3d.View view,
                               int flags)
Method Detail

setProjectionMode

public void setProjectionMode(int mode)
Parameters:
mode - projection mode, one of View.PARALLEL_PROJECTION or View.PERSPECTIVE_PROJECTION
Throws:
java.lang.IllegalArgumentException - if mode is a value other than View.PARALLEL_PROJECTION or View.PERSPECTIVE_PROJECTION
java.lang.IllegalStateException - if no View object is set for this behavior
java.lang.IllegalStateException - if mode is View.PARALLEL_PROJECTION and the View object hold no Canvas3D instance
Since:
Version 2.0

setProjectionMode

public void setProjectionMode(int mode,
                              double parScaleFac)

isClippingEnabled

public boolean isClippingEnabled()

setClippingEnabled

public void setClippingEnabled(boolean enable)

getClippingBounds

public javax.media.j3d.Bounds getClippingBounds()

setClippingBounds

public void setClippingBounds(javax.media.j3d.Bounds sceneBounds)

setAWTComponent

public void setAWTComponent(java.awt.Component c)
Sets the Component used to listen for mouse, mouse motion, and mouse wheel events. If a subclass overrides this method, it must call super.setViewingTransformGroup(tg).

Overrides:
setAWTComponent in class ViewPlatformAWTBehaviorInterim
Parameters:
c - the source Component for this behavior

setViewingTransformGroup

public void setViewingTransformGroup(javax.media.j3d.TransformGroup tg)
Sets the ViewPlatform's TransformGroup for this behavior. If a subclass overrides this method, it must call super.setViewingTransformGroup(tg).

Overrides:
setViewingTransformGroup in class ViewPlatformAWTBehaviorInterim
Parameters:
tg - the target TransformGroup for this behavior

getView

public javax.media.j3d.View getView()
Overrides:
getView in class javax.media.j3d.Behavior

setView

public void setView(javax.media.j3d.View view)

processAWTEvents

protected void processAWTEvents(java.awt.AWTEvent[] events)
Description copied from class: ViewPlatformAWTBehaviorInterim
This is called once per frame if there are any AWT events to process. The motion variable will be true when the method is called. If it is true when the method returns integrateTransforms will be called immediately. The AWTEvents are presented in the array in the order in which they arrived from AWT.

Specified by:
processAWTEvents in class ViewPlatformAWTBehaviorInterim

resetView

protected void resetView()
Reset the orientation and distance of this behavior to the current values in the ViewPlatform Transform Group


setClippingDistances

protected void setClippingDistances()

integrateTransforms

protected void integrateTransforms()
Description copied from class: ViewPlatformAWTBehaviorInterim
Called once per frame (if the view is moving) to calculate the new view platform transform

Specified by:
integrateTransforms in class ViewPlatformAWTBehaviorInterim

goHome

public void goHome()
Description copied from class: ViewPlatformBehaviorInterim
Positions and reorients the ViewingPlatform to its "home" transform.

Specified by:
goHome in class ViewPlatformBehaviorInterim

goHome

public void goHome(boolean aroundHomeCenter)
Description copied from class: ViewPlatformBehaviorInterim
Positions and reorients the ViewingPlatform to its "home" transform and the current rotation center is set to the "home" one if desired.

Specified by:
goHome in class ViewPlatformBehaviorInterim
Parameters:
aroundHomeCenter - if true the current roation center is set to the 'home' rotation center, otherwise the center remains unchanged

setRotationCenter

public void setRotationCenter(javax.vecmath.Point3d center)
Sets the center around which the View rotates. If ViewPlatform's TransformGroup isn't set the center is updated, but rotation may not behave as expected. The default center is (0,0,0).

Parameters:
center - The Point3d to set the center of rotation to

setRotationCenter

public void setRotationCenter(javax.vecmath.Point3d center,
                              boolean lookAtRotCenter)
Sets the center around which the View rotates and moves the View to this center if desired. If ViewPlatform's TransformGroup isn't set only the center is updated, but rotation may not behave as expected. The default center is (0,0,0).

Parameters:
center - The Point3d to set the center of rotation to
lookAtRotCenter - if true the View is moved to the rotation center, otherwise the View is unchanged
Since:
Version 1.1

lookAtRotationCenter

public void lookAtRotationCenter()
Moves the View to the current rotation center. This method has no effect if ViewPlatform's TransformGroup isn't set.

Since:
Version 1.1

getRotationCenter

public void getRotationCenter(javax.vecmath.Point3d center)
Places the value of the center around which the View rotates into the Point3d.

Parameters:
center - The Point3d

setRotFactors

public void setRotFactors(double xfactor,
                          double yfactor)
Sets the rotation x and y factors. The factors are used to determine how many radians to rotate the view for each pixel of mouse movement. The view is rotated factor * 0.01 radians for each pixel of mouse movement. The default factor is 1.0.

Parameters:
xfactor - The x movement multiplier
yfactor - The y movement multiplier

setRotXFactor

public void setRotXFactor(double xfactor)
Sets the rotation x factor. The factors are used to determine how many radians to rotate the view for each pixel of mouse movement. The view is rotated factor * 0.01 radians for each pixel of mouse movement. The default factor is 1.0.

Parameters:
xfactor - The x movement multiplier

setRotYFactor

public void setRotYFactor(double yfactor)
Sets the rotation y factor. The factors are used to determine how many radians to rotate the view for each pixel of mouse movement. The view is rotated factor * 0.01 radians for each pixel of mouse movement. The default factor is 1.0.

Parameters:
yfactor - The y movement multiplier

setTransFactors

public void setTransFactors(double xfactor,
                            double yfactor)
Sets the translation x and y factors. The factors are used to determine how many units to translate the view for each pixel of mouse movement. The view is translated factor * 0.01 units for each pixel of mouse movement. The default factor is 1.0.

Parameters:
xfactor - The x movement multiplier
yfactor - The y movement multiplier

setTransXFactor

public void setTransXFactor(double xfactor)
Sets the translation x factor. The factors are used to determine how many units to translate the view for each pixel of mouse movement. The view is translated factor * 0.01 units for each pixel of mouse movement. The default factor is 1.0.

Parameters:
xfactor - The x movement multiplier

setTransYFactor

public void setTransYFactor(double yfactor)
Sets the translation y factor. The factors are used to determine how many units to translate the view for each pixel of mouse movement. The view is translated factor * 0.01 units for each pixel of mouse movement. The default factor is 1.0.

Parameters:
yfactor - The y movement multiplier

setZoomFactor

public void setZoomFactor(double zfactor)
Sets the zoom factor. The factor is used to determine how many units to zoom the view for each pixel of mouse movement. The view is zoomed factor * 0.01 units for each pixel of mouse movement. For proportional zoom, the view is zoomed factor * 1% of the distance from the center of rotation for each pixel of mouse movement. The default factor is 1.0.

Parameters:
zfactor - The movement multiplier

getRotXFactor

public double getRotXFactor()
Returns the x rotation movement multiplier

Returns:
The movement multiplier for x rotation

getRotYFactor

public double getRotYFactor()
Returns the y rotation movement multiplier

Returns:
The movement multiplier for y rotation

getTransXFactor

public double getTransXFactor()
Returns the x translation movement multiplier

Returns:
The movement multiplier for x translation

getTransYFactor

public double getTransYFactor()
Returns the y translation movement multiplier

Returns:
The movement multiplier for y translation

getZoomFactor

public double getZoomFactor()
Returns the zoom movement multiplier

Returns:
The movement multiplier for zoom

setRotateEnable

public void setRotateEnable(boolean enabled)
Enables or disables rotation. The default is true.

Parameters:
enabled - true or false to enable or disable rotate

setZoomEnable

public void setZoomEnable(boolean enabled)
Enables or disables zoom. The default is true.

Parameters:
enabled - true or false to enable or disable zoom

setTranslateEnable

public void setTranslateEnable(boolean enabled)
Enables or disables translate. The default is true.

Parameters:
enabled - true or false to enable or disable translate

getRotateEnable

public boolean getRotateEnable()
Retrieves the state of rotate enabled

Returns:
the rotate enable state

getZoomEnable

public boolean getZoomEnable()
Retrieves the state of zoom enabled

Returns:
the zoom enable state

getTranslateEnable

public boolean getTranslateEnable()
Retrieves the state of translate enabled

Returns:
the translate enable state

setMinRadius

public void setMinRadius(double r)
Sets the minimum radius for the OrbitBehavior. The zoom will stop at this distance from the center of rotation. The default is 0.0. The minimum will have no affect if the STOP_ZOOM constructor flag is not set.

Parameters:
r - the minimum radius
Throws:
java.lang.IllegalArgumentException - if the radius is less than 0.0

getMinRadius

public double getMinRadius()
Returns the minimum orbit radius. The zoom will stop at this distance from the center of rotation if the STOP_ZOOM constructor flag is set.

Returns:
the minimum radius

setReverseTranslate

public void setReverseTranslate(boolean state)
Set reverse translate behavior. The default is false.

Parameters:
state - if true, reverse translate behavior
Since:
Java 3D 1.3

setReverseRotate

public void setReverseRotate(boolean state)
Set reverse rotate behavior. The default is false.

Parameters:
state - if true, reverse rotate behavior
Since:
Java 3D 1.3

setReverseZoom

public void setReverseZoom(boolean state)
Set reverse zoom behavior. The default is false.

Parameters:
state - if true, reverse zoom behavior
Since:
Java 3D 1.3

setProportionalZoom

public void setProportionalZoom(boolean state)
Set proportional zoom behavior. The default is false.

Parameters:
state - if true, use proportional zoom behavior
Since:
Java 3D 1.3