com.sun.j3d.utils.behaviors.interpolators
Class RotPosScaleTCBSplinePathInterpolator

java.lang.Object
  |
  +--javax.media.j3d.SceneGraphObject
        |
        +--javax.media.j3d.Node
              |
              +--javax.media.j3d.Leaf
                    |
                    +--javax.media.j3d.Behavior
                          |
                          +--javax.media.j3d.Interpolator
                                |
                                +--com.sun.j3d.utils.behaviors.interpolators.TCBSplinePathInterpolator
                                      |
                                      +--com.sun.j3d.utils.behaviors.interpolators.RotPosScaleTCBSplinePathInterpolator

public class RotPosScaleTCBSplinePathInterpolator

extends TCBSplinePathInterpolator

RotPosScaleTCBSplinePathInterpolator behavior. This class defines a behavior that varies the rotational, translational, and scale components of its target TransformGroup by using the Kochanek-Bartels cubic spline interpolation to interpolate among a series of key frames (using the value generated by the specified Alpha object). The interpolated position, orientation, and scale are used to generate a transform in the local coordinate system of this interpolator.

Fields inherited from class com.sun.j3d.utils.behaviors.interpolators.TCBSplinePathInterpolator

currentU, keyFrames, lowerKnot, upperKnot

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

RotPosScaleTCBSplinePathInterpolator(Alpha alpha, TransformGroup target, Transform3D axisOfRotPosScale, TCBKeyFrame[] keys)
Constructs a new RotPosScaleTCBSplinePathInterpolator object that varies the rotation, translation, and scale of the target TransformGroup's transform.

Method Summary

Node	cloneNode(boolean forceDuplicate) Used to create a new instance of the node.
void	duplicateNode(Node originalNode, boolean forceDuplicate) Copies all node information from originalNode into the current node.
Transform3D	getAxisOfRotPosScale() This method retrieves this interpolator's axis of rotation, translation, and scale.
TransformGroup	getTarget() This method retrieves this interpolator's target TransformGroup reference.
void	processStimulus(java.util.Enumeration criteria) This method is invoked by the behavior scheduler every frame.
void	setAxisOfRotPosScale(Transform3D axisOfRotPosScale) This method sets the axis of rotation, translation, and scale for this interpolator, RotPosScale, which defines the local coordinate system in which this interpolator operates.
void	setTarget(TransformGroup target) This method sets the target TransformGroup for this interpolator.
void	updateNodeReferences(NodeReferenceTable refTable) 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 com.sun.j3d.utils.behaviors.interpolators.TCBSplinePathInterpolator

computePathInterpolation, getArrayLength, getKeyFrame

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, 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

RotPosScaleTCBSplinePathInterpolator

public RotPosScaleTCBSplinePathInterpolator(Alpha alpha,
                                            TransformGroup target,
                                            Transform3D axisOfRotPosScale,
                                            TCBKeyFrame[] keys)

Constructs a new RotPosScaleTCBSplinePathInterpolator object that varies the rotation, translation, and scale of the target TransformGroup's transform. At least 2 key frames are required for this interpolator. The first key frame's knot must have a value of 0.0 and the last knot must have a value of 1.0. An intermediate key frame with index k must have a knot value strictly greater than the knot value of a key frame with index less than k.

Parameters:

alpha - the alpha object for this interpolator

target - the TransformGroup node affected by this interpolator

axisOfRotPosScale - the transform that specifies the local coordinate system in which this interpolator operates.

keys - an array of key frames that defien the motion path

Method Detail

setAxisOfRotPosScale

public void setAxisOfRotPosScale(Transform3D axisOfRotPosScale)

This method sets the axis of rotation, translation, and scale for this interpolator, RotPosScale, which defines the local coordinate system in which this interpolator operates.

Parameters:

axisOfRotPosScale - the interpolators axis of RotPosScale

getAxisOfRotPosScale

public Transform3D getAxisOfRotPosScale()

This method retrieves this interpolator's axis of rotation, translation, and scale.

Returns:

the interpolator's axis of RotPosScale

setTarget

public void setTarget(TransformGroup target)

This method sets the target TransformGroup for this interpolator.

Parameters:

target - the target TransformGroup reference

getTarget

public TransformGroup getTarget()

This method retrieves this interpolator's target TransformGroup reference.

Returns:

the interpolator's target TransformGroup reference

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 translation, rotation, and scale values, computes a transform based on these values, and updates the specified TransformGroup node with this new transform.

Overrides:

processStimulus in class Behavior

Parameters:

criteria - enumeration of criteria that have triggered this wakeup

cloneNode

public Node cloneNode(boolean forceDuplicate)

Description copied from class: Node

Used to create a new instance of the node. This routine is called by cloneTree to duplicate the current node. cloneNode should be overridden by any user subclassed objects. All subclasses must have their cloneNode method consist of the following lines:

     public Node cloneNode(boolean forceDuplicate) {
         UserSubClass usc = new UserSubClass();
         usc.duplicateNode(this, forceDuplicate);
         return usc;
     }
 

Overrides:

cloneNode in class Node

Tags copied from 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.

Throws:

RestrictedAccessException - if this object is part of live or compiled scene graph

See Also:

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

duplicateNode

public void duplicateNode(Node originalNode,
                          boolean forceDuplicate)

Description copied from class: Node

Copies all node information from originalNode into the current node. This method is called from the cloneNode method which is, in turn, called by the cloneTree method.

For any NodeComponent objects contained by the object being duplicated, each NodeComponent object's duplicateOnCloneTree value is used to determine whether the NodeComponent should be duplicated in the new node or if just a reference to the current node should be placed in the new node. This flag can be overridden by setting the forceDuplicate parameter in the cloneTree method to true.
NOTE: Applications should not call this method directly. It should only be called by the cloneNode method.

Overrides:

duplicateNode in class Node

Tags copied from class: Node

Parameters:

originalNode - the original node to duplicate.

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:

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

updateNodeReferences

public void updateNodeReferences(NodeReferenceTable refTable)

Description copied from class: Behavior

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

Tags copied from class: Behavior

Parameters:

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

See Also:

NodeReferenceTable, Node.cloneTree(), DanglingReferenceException