javax.media.j3d
Class RotationInterpolator

java.lang.Object
  |
  +--javax.media.j3d.SceneGraphObject
        |
        +--javax.media.j3d.Node
              |
              +--javax.media.j3d.Leaf
                    |
                    +--javax.media.j3d.Behavior
                          |
                          +--javax.media.j3d.Interpolator
                                |
                                +--javax.media.j3d.RotationInterpolator

public class RotationInterpolator

extends Interpolator

Rotation interpolator behavior. This class defines a behavior that modifies the rotational component of its target TransformGroup by linearly interpolating between a pair of specified angles (using the value generated by the specified Alpha object). The interpolated angle is used to generate a rotation transform about the local Y-axis of this interpolator.

Fields inherited from class javax.media.j3d.Interpolator

defaultWakeupCriterion

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_PICKABLE_READ, ALLOW_PICKABLE_WRITE, ENABLE_COLLISION_REPORTING, ENABLE_PICK_REPORTING

Constructor Summary

RotationInterpolator(Alpha alpha, TransformGroup target)
Constructs a trivial rotation interpolator with a specified target, an axisOfRotation set to identity, a minimum angle of 0.0f, and a maximum angle of 2*pi radians.

RotationInterpolator(Alpha alpha, TransformGroup target, Transform3D axisOfRotation, float minimumAngle, float maximumAngle)
Constructs a new rotation interpolator that varies the target transform node's rotational component.

Method Summary

Node	cloneNode(boolean forceDuplicate) Used to create a new instance of the node.
Transform3D	getAxisOfRotation() This method retrieves this interpolator's axis of rotation.
float	getMaximumAngle() This method retrieves this interpolator's maximumAngle, in radians.
float	getMinimumAngle() This method retrieves this interpolator's minimumAngle, in radians.
TransformGroup	getTarget() This method retrieves this interpolator's TransformGroup node reference.
void	processStimulus(java.util.Enumeration criteria) This method is invoked by the behavior scheduler every frame.
void	setAxisOfRotation(Transform3D axisOfRotation) This method sets the axis of rotation for this interpolator.
void	setMaximumAngle(float angle) This method sets the maximumAngle for this interpolator, in radians.
void	setMinimumAngle(float angle) This method sets the minimumAngle for this interpolator, in radians.
void	setTarget(TransformGroup target) This method sets the target TransformGroup node for this interpolator.
void	updateNodeReferences(NodeReferenceTable referenceTable) Callback used to allow a node to check if any scene graph objects referenced by that node have been duplicated via a call to cloneTree.

Methods inherited from class javax.media.j3d.Interpolator

getAlpha, initialize, setAlpha

Methods inherited from class javax.media.j3d.Behavior

getEnable, getSchedulingBoundingLeaf, getSchedulingBounds, getView, postId, setEnable, setSchedulingBoundingLeaf, setSchedulingBounds, wakeupOn

Methods inherited from class javax.media.j3d.Node

cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, duplicateNode, getBounds, getBoundsAutoCompute, getCollidable, getLocalToVworld, getLocalToVworld, getParent, getPickable, setBounds, setBoundsAutoCompute, setCollidable, setPickable

Methods inherited from class javax.media.j3d.SceneGraphObject

clearCapability, duplicateSceneGraphObject, getCapability, getUserData, isCompiled, isLive, setCapability, setUserData

Methods inherited from class java.lang.Object

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

Constructor Detail

RotationInterpolator

public RotationInterpolator(Alpha alpha,
                            TransformGroup target)

Constructs a trivial rotation interpolator with a specified target, an axisOfRotation set to identity, a minimum angle of 0.0f, and a maximum angle of 2*pi radians.

Parameters:

alpha - The alpha object for this Interpolator

target - The target for this rotation Interpolator

RotationInterpolator

public RotationInterpolator(Alpha alpha,
                            TransformGroup target,
                            Transform3D axisOfRotation,
                            float minimumAngle,
                            float maximumAngle)

Constructs a new rotation interpolator that varies the target transform node's rotational component.

Parameters:

alpha - the alpha generator to use in the rotation computation

target - the TransformGroup node affected by this interpolator

axisOfRotation - the transform that defines the local coordinate system in which this interpolator operates. The rotation is done about the Y-axis of this local coordinate system.

minimumAngle - the starting angle in radians

maximumAngle - the ending angle in radians

Method Detail

setMinimumAngle

public void setMinimumAngle(float angle)

This method sets the minimumAngle for this interpolator, in radians.

Parameters:

angle - the new minimal angle

getMinimumAngle

public float getMinimumAngle()

This method retrieves this interpolator's minimumAngle, in radians.

Returns:

the interpolator's minimal angle value

setMaximumAngle

public void setMaximumAngle(float angle)

This method sets the maximumAngle for this interpolator, in radians.

Parameters:

angle - the new maximal angle value

getMaximumAngle

public float getMaximumAngle()

This method retrieves this interpolator's maximumAngle, in radians.

Returns:

the interpolator's maximal angle value

setAxisOfRotation

public void setAxisOfRotation(Transform3D axisOfRotation)

This method sets the axis of rotation for this interpolator.

Parameters:

axisOfRotation - the new axis of rotation

getAxisOfRotation

public Transform3D getAxisOfRotation()

This method retrieves this interpolator's axis of rotation.

Returns:

this interpolator's axis of rotation

setTarget

public void setTarget(TransformGroup target)

This method sets the target TransformGroup node for this interpolator.

Parameters:

target - The target TransformGroup

getTarget

public TransformGroup getTarget()

This method retrieves this interpolator's TransformGroup node reference.

Returns:

the Interpolator's target TransformGroup

processStimulus

public void processStimulus(java.util.Enumeration criteria)

This method is invoked by the behavior scheduler every frame. It maps the alpha value that corresponds to the current time into a rotation angle, computes a transform based on this angle, and updates the specified TransformGroup node with this new transform.

Overrides:

processStimulus in class Behavior

Parameters:

criteria - an enumeration of the criteria that caused the stimulus

cloneNode

public Node cloneNode(boolean forceDuplicate)

Used to create a new instance of the node. This routine is called by cloneTree to duplicate the current node.

Overrides:

cloneNode in class Node

Parameters:

forceDuplicate - when set to true, causes the duplicateOnCloneTree flag to be ignored. When false, the value of each node's duplicateOnCloneTree variable determines whether NodeComponent data is duplicated or copied.

See Also:

Node.cloneTree(), Node.cloneNode(boolean), Node.duplicateNode(javax.media.j3d.Node, boolean), NodeComponent.setDuplicateOnCloneTree(boolean)

updateNodeReferences

public void updateNodeReferences(NodeReferenceTable referenceTable)

Callback used to allow a node to check if any scene graph objects referenced by that node have been duplicated via a call to cloneTree. This method is called by cloneTree after all nodes in the sub-graph have been duplicated. The cloned Leaf node's method will be called and the Leaf node can then look up any object references by using the getNewObjectReference method found in the NodeReferenceTable object. If a match is found, a reference to the corresponding object in the newly cloned sub-graph is returned. If no corresponding reference is found, either a DanglingReferenceException is thrown or a reference to the original object is returned depending on the value of the allowDanglingReferences parameter passed in the cloneTree call.

NOTE: Applications should not call this method directly. It should only be called by the cloneTree method.

Overrides:

updateNodeReferences in class Behavior

Parameters:

referenceTable - a NodeReferenceTableObject that contains the getNewObjectReference method needed to search for new object instances.

See Also:

NodeReferenceTable, Node.cloneTree(), DanglingReferenceException