PositionInterpolator (Java 3D Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.java3d.SceneGraphObject
- - org.scijava.java3d.Node
  - - org.scijava.java3d.Leaf
    - - org.scijava.java3d.Behavior
      - org.scijava.java3d.Interpolator
        
        org.scijava.java3d.TransformInterpolator
        
        org.scijava.java3d.PositionInterpolator

```
public class PositionInterpolator
extends TransformInterpolator
```
Position interpolator behavior. This class defines a behavior that modifies the translational component of its target TransformGroup by linearly interpolating between a pair of specified positions (using the value generated by the specified Alpha object). The interpolated position is used to generate a translation transform along the local X-axis of this interpolator.

Field Summary
- Fields inherited from class org.scijava.java3d.TransformInterpolator
  axis, axisInverse, target
- Fields inherited from class org.scijava.java3d.Interpolator
  defaultWakeupCriterion
- Fields inherited from class org.scijava.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
`PositionInterpolator(Alpha alpha, TransformGroup target)` Constructs a trivial position interpolator with a specified target, an axisOfTranslation set to Identity, a startPosition of 0.0f, and an endPosition of 1.0f.
`PositionInterpolator(Alpha alpha, TransformGroup target, Transform3D axisOfTransform, float startPosition, float endPosition)` Constructs a new position interpolator that varies the target TransformGroup's translational component (startPosition and endPosition).

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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.
`Transform3D`	`getAxisOfTranslation()` Deprecated. As of Java 3D version 1.3, replaced by `TransformInterpolator.getTransformAxis()`
`float`	`getEndPosition()` This method retrieves this interpolator's endPosition.
`float`	`getStartPosition()` This method retrieves this interpolator's startPosition.
`void`	`setAxisOfTranslation(Transform3D axisOfTranslation)` Deprecated. As of Java 3D version 1.3, replaced by `TransformInterpolator.setTransformAxis(Transform3D)`
`void`	`setEndPosition(float position)` This method sets the endPosition for this interpolator.
`void`	`setStartPosition(float position)` This method sets the startPosition for this interpolator.

Methods inherited from class org.scijava.java3d.TransformInterpolator
getTarget, getTransformAxis, processStimulus, setTarget, setTransformAxis, updateNodeReferences

Methods inherited from class org.scijava.java3d.Interpolator
getAlpha, initialize, setAlpha

Methods inherited from class org.scijava.java3d.Behavior
getEnable, getNumSchedulingIntervals, getSchedulingBoundingLeaf, getSchedulingBounds, getSchedulingInterval, getView, getWakeupCondition, postId, setEnable, setSchedulingBoundingLeaf, setSchedulingBounds, setSchedulingInterval, wakeupOn

Methods inherited from class org.scijava.java3d.Node
cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, duplicateNode, getBounds, getBoundsAutoCompute, getCollidable, getLocale, getLocalToVworld, getLocalToVworld, getParent, getPickable, setBounds, setBoundsAutoCompute, setCollidable, setPickable

Methods inherited from class org.scijava.java3d.SceneGraphObject
clearCapability, clearCapabilityIsFrequent, duplicateSceneGraphObject, getCapability, getCapabilityIsFrequent, getName, getUserData, isCompiled, isLive, setCapability, setCapabilityIsFrequent, setName, setUserData, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PositionInterpolator
```
public PositionInterpolator(Alpha alpha,
                            TransformGroup target)
```
    Constructs a trivial position interpolator with a specified target, an axisOfTranslation set to Identity, a startPosition of 0.0f, and an endPosition of 1.0f.
    
    Parameters:
    
    alpha - The alpha object for this Interpolator
    
    target - The target for this position Interpolator
  - PositionInterpolator
```
public PositionInterpolator(Alpha alpha,
                            TransformGroup target,
                            Transform3D axisOfTransform,
                            float startPosition,
                            float endPosition)
```
    Constructs a new position interpolator that varies the target TransformGroup's translational component (startPosition and endPosition).
    
    Parameters:
    
    alpha - the alpha object for this interpolator
    
    target - the transformgroup node effected by this positionInterpolator
    
    axisOfTransform - the transform that defines the local coordinate system in which this interpolator operates. The translation is done along the X-axis of this local coordinate system.
    
    startPosition - the starting position
    
    endPosition - the ending position
- Method Detail
  - setStartPosition
```
public void setStartPosition(float position)
```
    This method sets the startPosition for this interpolator.
    
    Parameters:
    
    position - The new start position
  - getStartPosition
```
public float getStartPosition()
```
    This method retrieves this interpolator's startPosition.
    
    Returns:
    
    the interpolator's start position value
  - setEndPosition
```
public void setEndPosition(float position)
```
    This method sets the endPosition for this interpolator.
    
    Parameters:
    
    position - The new end position
  - getEndPosition
```
public float getEndPosition()
```
    This method retrieves this interpolator's endPosition.
    
    Returns:
    
    the interpolator's end position vslue
  - setAxisOfTranslation
```
public void setAxisOfTranslation(Transform3D axisOfTranslation)
```
    Deprecated. As of Java 3D version 1.3, replaced by TransformInterpolator.setTransformAxis(Transform3D)
  - getAxisOfTranslation
```
public Transform3D getAxisOfTranslation()
```
    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(org.scijava.java3d.Node, boolean), NodeComponent.setDuplicateOnCloneTree(boolean)

Class PositionInterpolator

Field Summary

Fields inherited from class org.scijava.java3d.TransformInterpolator

Fields inherited from class org.scijava.java3d.Interpolator

Fields inherited from class org.scijava.java3d.Node

Constructor Summary

Method Summary

Methods inherited from class org.scijava.java3d.TransformInterpolator

Methods inherited from class org.scijava.java3d.Interpolator

Methods inherited from class org.scijava.java3d.Behavior

Methods inherited from class org.scijava.java3d.Node

Methods inherited from class org.scijava.java3d.SceneGraphObject

Methods inherited from class java.lang.Object

Constructor Detail

PositionInterpolator

PositionInterpolator

Method Detail

setStartPosition

getStartPosition

setEndPosition

getEndPosition

setAxisOfTranslation

getAxisOfTranslation

computeTransform

cloneNode