Package org.web3d.vrml.renderer.common.nodes

Class BaseTimeDependentNode

java.lang.Object

org.web3d.vrml.renderer.common.nodes.AbstractNode

org.web3d.vrml.renderer.common.nodes.BaseTimeDependentNode

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLNodeType, VRMLTimeDependentNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

BaseTimeControlledNode, BaseTimeController

public abstract class BaseTimeDependentNode
extends AbstractNode
implements VRMLTimeDependentNodeType

An abstract representation of any form of time dependent node for subclassing by specific implementations.

The implementation performs the basic handling of the time fields but does not create any data structures for them to run with.

Version:

$Revision: 1.2 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected VRMLClock	vrmlClock	The sim clock this node uses

Fields inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

errorReporter, FIELD_METADATA, fieldLocalData, hasChanged, inSetup, isDEF, isStatic, LAST_NODE_INDEX, layerIds, nodeName, pMetadata, refCounts, removedLayerIds, stateManager, STATIC_SCENE_GRAPH, vfMetadata, vrmlMajorVersion, vrmlMinorVersion

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseTimeDependentNode(String name)	Initialise the time dependent node and it's fields that are held locally.

Method Summary

Modifier and Type	Method	Description
void	setVRMLClock(VRMLClock clk)	Set the vrmlClock that this time dependent node will be running with.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getFieldValue, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getSecondaryType, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, sendRoute, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setupFinished, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, throwInitOnlyWriteException, throwInputOnlyWriteException, throwInvalidNodeException, throwInvalidProtoException, throwOutputOnlyWriteException, updateRefCount, updateRefs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

allEventsComplete

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

Field Details

vrmlClock

protected VRMLClock vrmlClock

The sim clock this node uses

Constructor Details

BaseTimeDependentNode

protected BaseTimeDependentNode(String name)

Initialise the time dependent node and it's fields that are held locally.

Parameters:

name - The name of the type of node

Method Details

setVRMLClock

public void setVRMLClock(VRMLClock clk)

Set the vrmlClock that this time dependent node will be running with. The vrmlClock provides all the information and listeners for keeping track of time. If we are enabled at the time that this method is called we automatically register the listener. Then, all the events that need to be generated will be handled at the next vrmlClock tick we get issued.

Specified by:

setVRMLClock in interface VRMLTimeDependentNodeType

Parameters:

clk - The vrmlClock to use for this node