public class OrbitBehavior extends ViewPlatformAWTBehavior
This behavior must be added to the ViewingPlatform
using the ViewingPlatform.setViewPlatformBehavior
method.
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
set
ActionFactor()
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
set
ActionEnable
methods.
The default center of rotation is (0, 0, 0) and can be set using the
setRotationCenter()
method.
Modifier and Type | Field and Description |
---|---|
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
|
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.
|
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
|
static int |
STOP_ZOOM
Constructor flag that indicates zoom should stop when it reaches
the minimum orbit radius set by setMinRadius().
|
canvases, frameWakeup, KEY_LISTENER, motion, MOUSE_LISTENER, MOUSE_MOTION_LISTENER, MOUSE_WHEEL_LISTENER, POST_ID, postWakeup, targetTransform
homeTransform, targetTG, vp
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 and Description |
---|
OrbitBehavior()
Parameterless constructor for this behavior.
|
OrbitBehavior(Canvas3D c)
Creates a new OrbitBehavior
|
OrbitBehavior(Canvas3D c,
int flags)
Creates a new OrbitBehavior
|
Modifier and Type | Method and Description |
---|---|
double |
getMinRadius()
Returns the minimum orbit radius.
|
boolean |
getRotateEnable()
Retrieves the state of rotate enabled
|
void |
getRotationCenter(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
|
boolean |
getZoomEnable()
Retrieves the state of zoom enabled
|
double |
getZoomFactor()
Returns the zoom movement multiplier
|
protected void |
integrateTransforms()
Called once per frame (if the view is moving) to calculate the new
view platform transform
|
void |
MinRadius(Object[] r)
Property which sets the minimum radius for the OrbitBehavior.
|
protected void |
processAWTEvents(AWTEvent[] events)
This is called once per frame if there are any AWT events to
process.
|
protected void |
processMouseEvent(MouseEvent evt) |
void |
ProportionalZoom(Object[] state)
Property which sets proportional zoom behavior.
|
void |
ReverseRotate(Object[] state)
Property which sets reverse rotate behavior.
|
void |
ReverseTranslate(Object[] state)
Property which sets reverse translate behavior.
|
void |
ReverseZoom(Object[] state)
Property which sets reverse zoom behavior.
|
void |
RotateEnable(Object[] enabled)
Property which enables or disables rotation.
|
void |
RotationCenter(Object[] center)
Property which sets the center around which the View rotates.
|
void |
RotFactors(Object[] factors)
Property which sets the rotation x and y factors.
|
void |
RotXFactor(Object[] xFactor)
Property which sets the rotation x factor.
|
void |
RotYFactor(Object[] yFactor)
Property which sets the rotation y factor.
|
void |
setMinRadius(double r)
Sets the minimum radius for the OrbitBehavior.
|
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(Point3d center)
Sets the center around which the View rotates.
|
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 |
setViewingPlatform(ViewingPlatform vp)
Sets the ViewingPlatform for this behavior.
|
void |
setZoomEnable(boolean enabled)
Enables or disables zoom.
|
void |
setZoomFactor(double zfactor)
Sets the zoom factor.
|
void |
TransFactors(Object[] factors)
Property which sets the translation x and y factors.
|
void |
TranslateEnable(Object[] enabled)
Property which enables or disables translate.
|
void |
TransXFactor(Object[] xFactor)
Property which sets the translation x factor.
|
void |
TransYFactor(Object[] yFactor)
Property which sets the translation y factor.
|
void |
ZoomEnable(Object[] enabled)
Property which enables or disables zoom.
|
void |
ZoomFactor(Object[] zFactor)
Property which sets the zoom factor.
|
initialize, keyPressed, keyReleased, keyTyped, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, processStimulus, queueAWTEvent, setEnable, setListenerFlags
getHomeTransform, getViewingPlatform, goHome, setHomeTransform
getEnable, getNumSchedulingIntervals, getSchedulingBoundingLeaf, getSchedulingBounds, getSchedulingInterval, getView, getWakeupCondition, postId, setSchedulingBoundingLeaf, setSchedulingBounds, setSchedulingInterval, updateNodeReferences, wakeupOn
cloneNode, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, duplicateNode, getBounds, getBoundsAutoCompute, getCollidable, getLocale, getLocalToVworld, getLocalToVworld, getParent, getPickable, setBounds, setBoundsAutoCompute, setCollidable, setPickable
clearCapability, clearCapabilityIsFrequent, duplicateSceneGraphObject, getCapability, getCapabilityIsFrequent, getName, getUserData, isCompiled, isLive, setCapability, setCapabilityIsFrequent, setName, setUserData, toString
public static final int REVERSE_ROTATE
public static final int REVERSE_TRANSLATE
public static final int REVERSE_ZOOM
public static final int REVERSE_ALL
public static final int STOP_ZOOM
public static final int DISABLE_ROTATE
public static final int DISABLE_TRANSLATE
public static final int DISABLE_ZOOM
public static final int PROPORTIONAL_ZOOM
public OrbitBehavior()
public OrbitBehavior(Canvas3D c)
c
- The Canvas3D to add the behavior topublic OrbitBehavior(Canvas3D c, int flags)
c
- The Canvas3D to add the behavior toflags
- The option flagsprotected void processAWTEvents(AWTEvent[] events)
ViewPlatformAWTBehavior
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.processAWTEvents
in class ViewPlatformAWTBehavior
protected void processMouseEvent(MouseEvent evt)
public void setViewingPlatform(ViewingPlatform vp)
setViewingPlatform
in class ViewPlatformAWTBehavior
vp
- the target ViewingPlatform for this behaviorprotected void integrateTransforms()
ViewPlatformAWTBehavior
integrateTransforms
in class ViewPlatformAWTBehavior
public void setRotationCenter(Point3d center)
center
- The Point3d to set the center of rotation topublic void RotationCenter(Object[] center)
center
- array of length 1 containing an instance of Point3dpublic void getRotationCenter(Point3d center)
center
- The Point3dpublic void setRotFactors(double xfactor, double yfactor)
xfactor
- The x movement multiplieryfactor
- The y movement multiplierpublic void RotFactors(Object[] factors)
factors
- array of length 2 containing instances of Doublepublic void setRotXFactor(double xfactor)
xfactor
- The x movement multiplierpublic void RotXFactor(Object[] xFactor)
xFactor
- array of length 1 containing instance of Doublepublic void setRotYFactor(double yfactor)
yfactor
- The y movement multiplierpublic void RotYFactor(Object[] yFactor)
yFactor
- array of length 1 containing instance of Doublepublic void setTransFactors(double xfactor, double yfactor)
xfactor
- The x movement multiplieryfactor
- The y movement multiplierpublic void TransFactors(Object[] factors)
factors
- array of length 2 containing instances of Doublepublic void setTransXFactor(double xfactor)
xfactor
- The x movement multiplierpublic void TransXFactor(Object[] xFactor)
xFactor
- array of length 1 containing instance of Doublepublic void setTransYFactor(double yfactor)
yfactor
- The y movement multiplierpublic void TransYFactor(Object[] yFactor)
yFactor
- array of length 1 containing instance of Doublepublic void setZoomFactor(double zfactor)
zfactor
- The movement multiplierpublic void ZoomFactor(Object[] zFactor)
zFactor
- array of length 1 containing instance of Doublepublic double getRotXFactor()
public double getRotYFactor()
public double getTransXFactor()
public double getTransYFactor()
public double getZoomFactor()
public void setRotateEnable(boolean enabled)
enabled
- true or false to enable or disable rotatepublic void RotateEnable(Object[] enabled)
enabled
- array of length 1 containing instance of Booleanpublic void setZoomEnable(boolean enabled)
enabled
- true or false to enable or disable zoompublic void ZoomEnable(Object[] enabled)
enabled
- array of length 1 containing instance of Booleanpublic void setTranslateEnable(boolean enabled)
enabled
- true or false to enable or disable translatepublic void TranslateEnable(Object[] enabled)
enabled
- array of length 1 containing instance of Booleanpublic boolean getRotateEnable()
public boolean getZoomEnable()
public boolean getTranslateEnable()
public void setMinRadius(double r)
r
- the minimum radiusIllegalArgumentException
- if the radius is less than 0.0public void MinRadius(Object[] r)
r
- array of length 1 containing instance of Doublepublic double getMinRadius()
public void setReverseTranslate(boolean state)
state
- if true, reverse translate behaviorpublic void ReverseTranslate(Object[] state)
state
- array of length 1 containing instance of Booleanpublic void setReverseRotate(boolean state)
state
- if true, reverse rotate behaviorpublic void ReverseRotate(Object[] state)
state
- array of length 1 containing instance of Booleanpublic void setReverseZoom(boolean state)
state
- if true, reverse zoom behaviorpublic void ReverseZoom(Object[] state)
state
- array of length 1 containing instance of Booleanpublic void setProportionalZoom(boolean state)
state
- if true, use proportional zoom behaviorpublic void ProportionalZoom(Object[] state)
state
- array of length 1 containing instance of BooleanCopyright © 2016–2022 SciJava. All rights reserved.