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

Class BasePhysicsModel

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.particle.BasePhysicsModel

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLNodeType, VRMLParticlePhysicsModelNodeType

Direct Known Subclasses:

BaseGravityPhysicsModel, BaseWindPhysicsModel

public abstract class BasePhysicsModel
extends AbstractNode
implements VRMLParticlePhysicsModelNodeType

Common implementation of a GravityPhysics node.

Version:

$Revision: 2.2 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_ENABLED	The field index for cycleInterval
protected static final int	LAST_PHYSICS_INDEX	The last field index used by this class
protected org.j3d.geom.particle.ParticleFunction	particleFunction	The j3d.org particle function implementation this node is wrapping
protected boolean	vfEnabled	The value of the cycle time field

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	BasePhysicsModel(String nodeName)	Construct a new time sensor object

Method Summary

Modifier and Type	Method	Description
protected void	copy(VRMLParticlePhysicsModelNodeType node)	Copy the node to this node.
boolean	getEnabled()	Get the current enabled state of this model.
VRMLFieldData	getFieldValue(int index)	Get the value of a field.
org.j3d.geom.particle.ParticleFunction	getParticleFunction()	Return the particle function implementation that this model controls.
int	getPrimaryType()	Get the primary type of this node.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setEnabled(boolean state)	Set the enabled state of the Physics model.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setValue(int index, boolean value)	Set the value of the field at the given index as a boolean.

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

addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getSecondaryType, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, 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, getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

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

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

Field Details

FIELD_ENABLED

protected static final int FIELD_ENABLED

The field index for cycleInterval

See Also:

• Constant Field Values

LAST_PHYSICS_INDEX

protected static final int LAST_PHYSICS_INDEX

The last field index used by this class

See Also:

• Constant Field Values

vfEnabled

protected boolean vfEnabled

The value of the cycle time field

particleFunction

protected org.j3d.geom.particle.ParticleFunction particleFunction

The j3d.org particle function implementation this node is wrapping

Constructor Details

BasePhysicsModel

protected BasePhysicsModel(String nodeName)

Construct a new time sensor object

Parameters:

nodeName -

Method Details

copy

protected void copy(VRMLParticlePhysicsModelNodeType node)

Copy the node to this node.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not the same type

getParticleFunction

public org.j3d.geom.particle.ParticleFunction getParticleFunction()

Return the particle function implementation that this model controls. May not be available until after setupFinished() is called.

Specified by:

getParticleFunction in interface VRMLParticlePhysicsModelNodeType

Returns:

The current function to control the system

setEnabled

public void setEnabled(boolean state)

Set the enabled state of the Physics model.

Specified by:

setEnabled in interface VRMLParticlePhysicsModelNodeType

Parameters:

state - true to enable the use of this model

getEnabled

public boolean getEnabled()

Get the current enabled state of this model.

Specified by:

getEnabled in interface VRMLParticlePhysicsModelNodeType

Returns:

The value of the enabled field

setupFinished

public void setupFinished()

Notification that the construction phase of this node has finished. If the node would like to do any internal processing, such as setting up geometry, then go for it now.

Specified by:

setupFinished in interface VRMLNodeType

Overrides:

setupFinished in class AbstractNode

getPrimaryType

public int getPrimaryType()

Get the primary type of this node. Replaces the instanceof mechanism for use in switch statements.

Specified by:

getPrimaryType in interface VRMLNode

Returns:

The primary type

getFieldValue

public VRMLFieldData getFieldValue(int index)
                            throws InvalidFieldException

Get the value of a field. If the field is a primitive type, it will return a class representing the value. For arrays or nodes it will return the instance directly.

Specified by:

getFieldValue in interface VRMLNodeType

Overrides:

getFieldValue in class AbstractNode

Parameters:

index - The index of the field to change.

Returns:

The class representing the field value

Throws:

InvalidFieldException - The field index is not known

sendRoute

public void sendRoute(double time,
 int srcIndex,
 VRMLNodeType destNode,
 int destIndex)

Send a routed value from this node to the given destination node. The route should use the appropriate setValue() method of the destination node. It should not attempt to cast the node up to a higher level. Routing should also follow the standard rules for the loop breaking and other appropriate rules for the specification.

Specified by:

sendRoute in interface VRMLNodeType

Overrides:

sendRoute in class AbstractNode

Parameters:

time - The time that this route occurred (not necessarily epoch time. Should be treated as a relative value only)

srcIndex - The index of the field in this node that the value should be sent from

destNode - The node reference that we will be sending the value to

destIndex - The index of the field in the destination node that the value should be sent to.

setValue

public void setValue(int index,
 boolean value)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as a boolean. This is be used to set SFBool field types isActive, enabled and loop.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is not in range or not appropriate for this field