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

Class BasePointEmitter

java.lang.Object

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

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

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLNodeType, VRMLParticleEmitterNodeType

Direct Known Subclasses:

NRPointEmitter, OGLPointEmitter

public abstract class BasePointEmitter
extends BaseEmitter

Common implementation of a PointEmitter node.

Version:

$Revision: 2.3 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final float[]	DEFAULT_DIRECTION	The default direction of a point emitter - Straight up
protected static final int	FIELD_DIRECTION	The field index for direction
protected static final int	FIELD_POSITION	The field index for velocity
protected static final int	LAST_POINT_EMITTER_INDEX	The last field index used by this class
protected static final int	NUM_FIELDS	Number of fields constant
protected float[]	vfDirection	The value of the cycle time field
protected float[]	vfPosition	The value of the cycle interval field

Fields inherited from class org.web3d.vrml.renderer.common.nodes.particle.BaseEmitter

FIELD_MASS, FIELD_SPEED, FIELD_SURFACE_AREA, FIELD_VARIATION, initializer, LAST_EMITTER_INDEX, vfMass, vfSpeed, vfSurfaceArea, vfVariation

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	BasePointEmitter()	Construct a new time sensor object
	BasePointEmitter(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
VRMLFieldDeclaration	getFieldDeclaration(int index)	Get the declaration of the field at the given index.
int	getFieldIndex(String fieldName)	Get the index of the given field name.
VRMLFieldData	getFieldValue(int index)	Get the value of a field.
int[]	getNodeFieldIndices()	Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode).
int	getNumFields()	Get the number of fields.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
protected void	setDirection(float[] dir)	The direction value has just been set.
protected void	setPosition(float[] pos)	The position value has just been set.
void	setValue(int index, float[] value, int numValid)	Set the value of the field at the given index as a double for the SFRotation fields.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.particle.BaseEmitter

copy, getInitializer, getMass, getPrimaryType, getSpeed, getSurfaceArea, getVariation, setMass, setSpeed, setSurfaceArea, setValue, setVariation

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, setupFinished, setUserData, 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

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, setupFinished, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Field Details

DEFAULT_DIRECTION

protected static final float[] DEFAULT_DIRECTION

The default direction of a point emitter - Straight up

FIELD_DIRECTION

protected static final int FIELD_DIRECTION

The field index for direction

See Also:

• Constant Field Values

FIELD_POSITION

protected static final int FIELD_POSITION

The field index for velocity

See Also:

• Constant Field Values

LAST_POINT_EMITTER_INDEX

protected static final int LAST_POINT_EMITTER_INDEX

The last field index used by this class

See Also:

• Constant Field Values

NUM_FIELDS

protected static final int NUM_FIELDS

Number of fields constant

See Also:

• Constant Field Values

vfDirection

protected float[] vfDirection

The value of the cycle time field

vfPosition

protected float[] vfPosition

The value of the cycle interval field

Constructor Details

BasePointEmitter

protected BasePointEmitter()

Construct a new time sensor object

BasePointEmitter

public BasePointEmitter(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not the same type, an exception will be thrown.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not the same type

Method Details

getFieldIndex

public int getFieldIndex(String fieldName)

Get the index of the given field name. If the name does not exist for this node then return a value of -1.

Parameters:

fieldName - The name of the field we want the index from

Returns:

The index of the field name or -1

getNodeFieldIndices

public int[] getNodeFieldIndices()

Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode). Used for blind scene graph traversal without needing to spend time querying for all fields etc. If a node does not have any fields that contain nodes, this shall return null. The field list covers all field types, regardless of whether they are readable or not at the VRML-level.

Returns:

The list of field indices that correspond to SF/MFnode fields or null if none

getFieldDeclaration

public VRMLFieldDeclaration getFieldDeclaration(int index)

Get the declaration of the field at the given index. This allows for reverse lookup if needed. If the field does not exist, this will give a value of null.

Parameters:

index - The index of the field to get information

Returns:

A representation of this field's information

getNumFields

public int getNumFields()

Get the number of fields.

Returns:

The number of fields.

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 BaseEmitter

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 BaseEmitter

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,
 float[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as a double for the SFRotation fields.

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

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

Throws:

InvalidFieldException - The field index is not known

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

setPosition

protected void setPosition(float[] pos)

The position value has just been set.

Parameters:

pos - The new position of the emitter.

setDirection

protected void setDirection(float[] dir)

The direction value has just been set.

Parameters:

dir - The new direction of the emitter.