org.web3d.vrml.nodes
Interface VRMLTimeControlledNodeType

All Superinterfaces:

FrameStateListener, VRMLChildNodeType, VRMLNode, VRMLNodeType, VRMLTimeDependentNodeType

All Known Subinterfaces:

J3DAudioClipNodeType, NRAudioClipNodeType, VRMLAudioClipNodeType

All Known Implementing Classes:

BaseTimeControlledNode

public interface VRMLTimeControlledNodeType

extends VRMLTimeDependentNodeType

Nodes which can be controlled by a set of VCR-like commands.

Time information is provided by the clock that can be set by the implementing runtime system. With the clock, the node can then register clock ticks listeners for timing update information.

Version:

$Revision: 1.4 $

Author:

Alan Hudson

Method Summary

boolean	getLoop() Accessor method to get current value of field loop.
double	getStartTime() Accessor method to get current value of field startTime.
double	getStopTime() Accessor method to get current value of field stopTime.
void	setLoop(boolean newLoop) Accessor method to set a new value for field attribute loop.
void	setStartTime(double newStartTime) Accessor method to set a new value for field attribute startTime.
void	setStopTime(double newStopTime) Accessor method to set a new value for field attribute stopTime.

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

setVRMLClock

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

addNodeListener, getFieldValue, getMetadataObject, getRefCount, 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

setLoop

public void setLoop(boolean newLoop)

Accessor method to set a new value for field attribute loop.

Parameters:

newLoop - Whether this field loops or not

getLoop

public boolean getLoop()

Accessor method to get current value of field loop. default value is false

Returns:

The value of the loop field

setStartTime

public void setStartTime(double newStartTime)

Accessor method to set a new value for field attribute startTime.

Parameters:

newStartTime - The new start time

getStartTime

public double getStartTime()

Accessor method to get current value of field startTime. Default value is 0.

Returns:

The current startTime

setStopTime

public void setStopTime(double newStopTime)

Accessor method to set a new value for field attribute stopTime.

Parameters:

newStopTime - The new stop time

getStopTime

public double getStopTime()

Accessor method to get current value of field stopTime. Default value is 0

Returns:

The current stop Time