org.jogamp.java3d.utils.picking.behaviors

Class PickMouseBehavior

java.lang.Object

org.jogamp.java3d.SceneGraphObject

org.jogamp.java3d.Node

org.jogamp.java3d.Leaf

org.jogamp.java3d.Behavior

org.jogamp.java3d.utils.picking.behaviors.PickMouseBehavior

Direct Known Subclasses:

PickRotateBehavior, PickTranslateBehavior, PickZoomBehavior

public abstract class PickMouseBehavior
extends Behavior

Base class that allows users to adding picking and mouse manipulation to the scene graph (see PickDragBehavior for an example of how to extend this base class). This class is useful for interactive apps.

Field Summary

Fields inherited from class org.jogamp.java3d.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

Constructors

Constructor and Description
PickMouseBehavior(Canvas3D canvas, BranchGroup root, Bounds bounds) Creates a PickMouseBehavior given current canvas, root of the tree to operate on, and the bounds.

Method Summary

Modifier and Type	Method and Description
int	getMode() Returns the pickMode
float	getTolerance() Returns the pick tolerance
void	initialize() Initialize this behavior.
void	processStimulus(java.util.Iterator<WakeupCriterion> criteria) Process a stimulus meant for this behavior.
void	setMode(int pickMode) Sets the pick mode
void	setTolerance(float tolerance) Sets the pick tolerance
abstract void	updateScene(int xpos, int ypos) Subclasses shall implement this update function

Methods inherited from class org.jogamp.java3d.Behavior

getEnable, getNumSchedulingIntervals, getSchedulingBoundingLeaf, getSchedulingBounds, getSchedulingInterval, postId, setEnable, setSchedulingBoundingLeaf, setSchedulingBounds, setSchedulingInterval, updateNodeReferences

Methods inherited from class org.jogamp.java3d.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 org.jogamp.java3d.SceneGraphObject

clearCapability, clearCapabilityIsFrequent, getCapability, getCapabilityIsFrequent, getName, getUserData, isCompiled, isLive, setCapability, setCapabilityIsFrequent, setName, setUserData, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PickMouseBehavior

public PickMouseBehavior(Canvas3D canvas,
                         BranchGroup root,
                         Bounds bounds)

Creates a PickMouseBehavior given current canvas, root of the tree to operate on, and the bounds.

Method Detail

setMode

public void setMode(int pickMode)

Sets the pick mode

See Also:

PickTool.setMode(int)

getMode

public int getMode()

Returns the pickMode

See Also:

PickTool.getMode()

setTolerance

public void setTolerance(float tolerance)

Sets the pick tolerance

See Also:

PickCanvas.setTolerance(float)

getTolerance

public float getTolerance()

Returns the pick tolerance

See Also:

PickCanvas.getTolerance()

initialize

public void initialize()

Description copied from class: Behavior

Initialize this behavior. Classes that extend Behavior must provide their own initialize method.
NOTE: Applications should not call this method. It is called by the Java 3D behavior scheduler.

Specified by:

initialize in class Behavior

processStimulus

public void processStimulus(java.util.Iterator<WakeupCriterion> criteria)

Description copied from class: Behavior

Process a stimulus meant for this behavior. This method is invoked if the Behavior's wakeup criteria are satisfied and an active ViewPlatform's activation volume intersects with the Behavior's scheduling region. Classes that extend Behavior must provide their own processStimulus method.
NOTE: Applications should not call this method. It is called by the Java 3D behavior scheduler.

Specified by:

processStimulus in class Behavior

Parameters:

criteria - an iterator of triggered wakeup criteria for this behavior

updateScene

public abstract void updateScene(int xpos,
                                 int ypos)

Subclasses shall implement this update function