javax.media.j3d
Class RotPosPathInterpolator

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 javax.media.j3d.Interpolator
                      extended by javax.media.j3d.TransformInterpolator
                          extended by javax.media.j3d.PathInterpolator
                              extended by javax.media.j3d.RotPosPathInterpolator

public class RotPosPathInterpolator
extends PathInterpolator

RotPosPathInterpolator behavior. This class defines a behavior that modifies the rotational and translational components of its target TransformGroup by linearly interpolating among a series of predefined knot/positon and knot/orientation pairs (using the value generated by the specified Alpha object). The interpolated position and orientation are used to generate a transform in the local coordinate system of this interpolator.


Field Summary
private  WakeupCriterion passiveWakeupCriterion
           
private  Vector3f pos
           
private  Point3f[] positions
           
private  float prevAlphaValue
           
private  float prevInterpolationValue
           
private  Quat4f[] quats
           
private  Transform3D rotation
           
private  Matrix4d tMat
           
private  Quat4f tQuat
           
 
Fields inherited from class javax.media.j3d.PathInterpolator
currentInterpolationValue, currentKnotIndex
 
Fields inherited from class javax.media.j3d.TransformInterpolator
axis, axisInverse, target
 
Fields inherited from class javax.media.j3d.Interpolator
alpha, 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_LOCALE_READ, ALLOW_PARENT_READ, ALLOW_PICKABLE_READ, ALLOW_PICKABLE_WRITE, ENABLE_COLLISION_REPORTING, ENABLE_PICK_REPORTING
 
Fields inherited from class javax.media.j3d.SceneGraphObject
nodeHashtable, retained
 
Constructor Summary
RotPosPathInterpolator()
           
RotPosPathInterpolator(Alpha alpha, TransformGroup target, Transform3D axisOfTransform, float[] knots, Quat4f[] quats, Point3f[] positions)
          Constructs a new interpolator that varies the rotation and translation of the target TransformGroup's transform.
 
Method Summary
 Node cloneNode(boolean forceDuplicate)
          Used to create a new instance of the node.
 void computeTransform(float alphaValue, Transform3D transform)
          Computes the new transform for this interpolator for a given alpha value.
(package private)  void duplicateAttributes(Node originalNode, boolean forceDuplicate)
          Copies all RotPosPathInterpolator information from originalNode into the current node.
 Transform3D getAxisOfRotPos()
          Deprecated. As of Java 3D version 1.3, replaced by TransformInterpolator.getTransformAxis()
 void getPosition(int index, Point3f position)
          Retrieves the position value at the specified index.
 void getPositions(Point3f[] positions)
          Copies the array of position values from this interpolator into the specified array.
 void getQuat(int index, Quat4f quat)
          Retrieves the quat value at the specified index.
 void getQuats(Quat4f[] quats)
          Copies the array of quaternion values from this interpolator into the specified array.
 void setAxisOfRotPos(Transform3D axisOfRotPos)
          Deprecated. As of Java 3D version 1.3, replaced by TransformInterpolator.setTransformAxis(Transform3D)
 void setPathArrays(float[] knots, Quat4f[] quats, Point3f[] positions)
          Replaces the existing arrays of knot values, quaternion values, and position values with the specified arrays.
private  void setPathArrays(Quat4f[] quats, Point3f[] positions)
           
 void setPosition(int index, Point3f position)
          Sets the position at the specified index for this interpolator.
 void setQuat(int index, Quat4f quat)
          Sets the quat at the specified index for this interpolator.
 
Methods inherited from class javax.media.j3d.PathInterpolator
computePathInterpolation, computePathInterpolation, getArrayLengths, getKnot, getKnots, setKnot, setKnots
 
Methods inherited from class javax.media.j3d.TransformInterpolator
getTarget, getTransformAxis, processStimulus, setTarget, setTransformAxis, updateNodeReferences
 
Methods inherited from class javax.media.j3d.Interpolator
getAlpha, initialize, setAlpha
 
Methods inherited from class javax.media.j3d.Behavior
createRetained, getEnable, getNumSchedulingIntervals, getSchedulingBoundingLeaf, getSchedulingBounds, getSchedulingInterval, getView, getWakeupCondition, postId, setEnable, setSchedulingBoundingLeaf, setSchedulingBounds, setSchedulingInterval, wakeupOn
 
Methods inherited from class javax.media.j3d.Node
checkDuplicateNode, checkForCycle, cloneTree, 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
capabilityBitsEmpty, checkForLiveOrCompiled, clearCapability, clearCapabilityIsFrequent, clearLive, duplicateSceneGraphObject, getCapability, getCapabilityIsFrequent, getName, getNamePrefix, getNodeComponent, getUserData, isCompiled, isLive, isLiveOrCompiled, setCapability, setCapabilityIsFrequent, setCompiled, setDefaultReadCapabilities, setLive, setName, setUserData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

rotation

private Transform3D rotation

pos

private Vector3f pos

tQuat

private Quat4f tQuat

tMat

private Matrix4d tMat

quats

private Quat4f[] quats

positions

private Point3f[] positions

prevInterpolationValue

private float prevInterpolationValue

prevAlphaValue

private float prevAlphaValue

passiveWakeupCriterion

private WakeupCriterion passiveWakeupCriterion
Constructor Detail

RotPosPathInterpolator

RotPosPathInterpolator()

RotPosPathInterpolator

public RotPosPathInterpolator(Alpha alpha,
                              TransformGroup target,
                              Transform3D axisOfTransform,
                              float[] knots,
                              Quat4f[] quats,
                              Point3f[] positions)
Constructs a new interpolator that varies the rotation and translation of the target TransformGroup's transform.

Parameters:
alpha - the alpha object for this interpolator
target - the TransformGroup node affected by this translator
axisOfTransform - the transform that defines the local coordinate system in which this interpolator operates
knots - an array of knot values that specify interpolation points.
quats - an array of quaternion values at the knots.
positions - an array of position values at the knots.
Throws:
java.lang.IllegalArgumentException - if the lengths of the knots, quats, and positions arrays are not all the same.
Method Detail

setQuat

public void setQuat(int index,
                    Quat4f quat)
Sets the quat at the specified index for this interpolator.

Parameters:
index - the index to be changed
quat - the new quat value

getQuat

public void getQuat(int index,
                    Quat4f quat)
Retrieves the quat value at the specified index.

Parameters:
index - the index of the value requested
quat - the quat to receive the quat value at the index

setPosition

public void setPosition(int index,
                        Point3f position)
Sets the position at the specified index for this interpolator.

Parameters:
index - the index to be changed
position - the new position value

getPosition

public void getPosition(int index,
                        Point3f position)
Retrieves the position value at the specified index.

Parameters:
index - the index of the value requested
position - the position to receive the position value at the index

setPathArrays

public void setPathArrays(float[] knots,
                          Quat4f[] quats,
                          Point3f[] positions)
Replaces the existing arrays of knot values, quaternion values, and position values with the specified arrays. The arrays of knots, quats, and positions are copied into this interpolator object.

Parameters:
knots - a new array of knot values that specify interpolation points.
quats - a new array of quaternion values at the knots.
positions - a new array of position values at the knots.
Throws:
java.lang.IllegalArgumentException - if the lengths of the knots, quats, and positions arrays are not all the same.
Since:
Java 3D 1.2

setPathArrays

private void setPathArrays(Quat4f[] quats,
                           Point3f[] positions)

getQuats

public void getQuats(Quat4f[] quats)
Copies the array of quaternion values from this interpolator into the specified array. The array must be large enough to hold all of the quats. The individual array elements must be allocated by the caller.

Parameters:
quats - array that will receive the quats.
Since:
Java 3D 1.2

getPositions

public void getPositions(Point3f[] positions)
Copies the array of position values from this interpolator into the specified array. The array must be large enough to hold all of the positions. The individual array elements must be allocated by the caller.

Parameters:
positions - array that will receive the positions.
Since:
Java 3D 1.2

setAxisOfRotPos

public void setAxisOfRotPos(Transform3D axisOfRotPos)
Deprecated. As of Java 3D version 1.3, replaced by TransformInterpolator.setTransformAxis(Transform3D)


getAxisOfRotPos

public Transform3D getAxisOfRotPos()
Deprecated. As of Java 3D version 1.3, replaced by TransformInterpolator.getTransformAxis()


computeTransform

public void computeTransform(float alphaValue,
                             Transform3D transform)
Computes the new transform for this interpolator for a given alpha value.

Specified by:
computeTransform in class TransformInterpolator
Parameters:
alphaValue - alpha value between 0.0 and 1.0
transform - object that receives the computed transform for the specified alpha value
Since:
Java 3D 1.3

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)

duplicateAttributes

void duplicateAttributes(Node originalNode,
                         boolean forceDuplicate)
Copies all RotPosPathInterpolator information from originalNode into the current node. This method is called from the cloneNode method which is, in turn, called by the cloneTree method.

Overrides:
duplicateAttributes in class PathInterpolator
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.
Throws:
RestrictedAccessException - if this object is part of a live or compiled scenegraph.
See Also:
Node.duplicateNode(javax.media.j3d.Node, boolean), Node.cloneTree(), NodeComponent.setDuplicateOnCloneTree(boolean)


Copyright 1996-2008 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.