org.web3d.vrml.nodes
Interface VRMLSequencerNodeType

All Superinterfaces:

FrameStateListener, VRMLChildNodeType, VRMLNode, VRMLNodeType, VRMLWorldRootChildNodeType

All Known Implementing Classes:

BaseSequencerNode

public interface VRMLSequencerNodeType
extends VRMLChildNodeType

Sequencer nodes are designed for discrete animation.

Sequencers are driven by an input key ranging [0..1] and produce corresponding impulse output functions.

This interface represents the X3D abstract node type X3DInterpolatorNode, which is defined as:

  X3DSequencerNode : X3DChildNode {
    SFBool       [in]     next
    SFBool       [in]     previous
    SFFloat      [in]     set_fraction       (-inf,inf)
    MFFloat      [in,out] key           []   (-inf,inf)
    MF     [in,out] keyValue      []
    SFNode       [in,out] metadata      NULL [X3DMetadataObject]
    [S|M]F [out]    value_changed
  }
 

Version:

$Revision: 1.3 $

Author:

Alan Hudson

Method Summary

float	getFraction() Get the current value of the fraction field.
float[]	getKey() Get current value of the key field.
int	getNumKey() Get the number of valid keys defined for this interpolator.
void	setFraction(float fraction) Set a new value for the fraction field.
void	setKey(float[] keys, int numValid) Set a new value for the key field.
void	setNext() Cause the next value to be generated on the output.
void	setPrevious() Cause the previous value to be generated on the output.

Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType

addNodeListener, clearRemovedLayerIds, getFieldValue, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, sendRoute, setDEF, setFrameStateManager, setMetadataObject, setupFinished, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Methods inherited from interface org.web3d.vrml.lang.VRMLNode

getFieldDeclaration, getFieldIndex, getNodeFieldIndices, getNumFields, getPrimaryType, getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

Methods inherited from interface org.web3d.vrml.nodes.FrameStateListener

allEventsComplete

Method Detail

setNext

void setNext()

Cause the next value to be generated on the output. This is equivalent to sending a value to the next inputOnly field.

setPrevious

void setPrevious()

Cause the previous value to be generated on the output. This is equivalent to sending a value to the previous inputOnly field.

setFraction

void setFraction(float fraction)

Set a new value for the fraction field. This should cause an output interpolation.

Parameters:

fraction - The new value for fraction

getFraction

float getFraction()

Get the current value of the fraction field.

Returns:

The current value for fraction

setKey

void setKey(float[] keys,
            int numValid)

Set a new value for the key field. A valud of null will delete all key values.

Parameters:

keys - The new key values

numValid - The number of valid values to copy from the array

getKey

float[] getKey()

Get current value of the key field. If no keys exist a zero-length float[] will be returned. Use getNumKey to find out how many keys need to be set.

Returns:

The current key values

getNumKey

int getNumKey()

Get the number of valid keys defined for this interpolator.

Returns:

a value >= 0