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

Class BasePolylineEmitter

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLNodeComponentListener, VRMLNodeType, VRMLParticleEmitterNodeType

Direct Known Subclasses:

NRPolylineEmitter, OGLPolylineEmitter

public abstract class BasePolylineEmitter
extends BaseEmitter
implements VRMLNodeComponentListener

Common implementation of a PolylineEmitter node.

Version:

$Revision: 2.3 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	COORD_NODE_MSG	Message for when the node in setValue() is not a Coord
protected static final String	COORD_PROTO_MSG	Message for when the proto is not a Coord
protected static final int	FIELD_COORDINDEX	The field index for the coordIndex field
protected static final int	FIELD_COORDS	The field index for the coordinate node
protected static final int	FIELD_DIRECTION	The field index for direction
protected static final int	FIELD_SET_COORDINDEX	The field index for the set_coordIndex field
protected static final int	LAST_LINE_EMITTER_INDEX	The last field index used by this class
protected static final int	NUM_FIELDS	Number of fields constant
protected int	numCoordIndex	Number of valid values in vfColorIndex
protected VRMLProtoInstance	pCoord	Proto version of the coord
protected VRMLCoordinateNodeType	vfCoord	exposedField SFNode coord
protected int[]	vfCoordIndex	The value of the cycle time field
protected float[]	vfDirection	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	BasePolylineEmitter()	Construct a new time sensor object
	BasePolylineEmitter(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
void	allEventsComplete()	Ignored by this base implementation.
void	fieldChanged(VRMLNodeType node, int index)	Notification that the field from the coordinate node has changed.
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	setCoord(int field, VRMLNodeType coord)	Set the coordinate node that forms the base of the line emitter.
protected void	setCoordIndex(int[] value, int numValid)	Set the coordIndex field.
protected void	setDirection(float[] dir)	The direction value has just been set.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setValue(int index, float[] value, int numValid)	Set the value of the field at the given index as a float for the SFRotation fields.
void	setValue(int index, int[] value, int numValid)	Set the value of the field at the given index as a int array for the MFInt32 and SF/MFImage fields.
void	setValue(int index, VRMLNodeType child)	Set the value of the field at the given index as a node.

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

Field Details

FIELD_COORDS

protected static final int FIELD_COORDS

The field index for the coordinate node

See Also:

• Constant Field Values

FIELD_COORDINDEX

protected static final int FIELD_COORDINDEX

The field index for the coordIndex field

See Also:

• Constant Field Values

FIELD_SET_COORDINDEX

protected static final int FIELD_SET_COORDINDEX

The field index for the set_coordIndex field

See Also:

• Constant Field Values

FIELD_DIRECTION

protected static final int FIELD_DIRECTION

The field index for direction

See Also:

• Constant Field Values

LAST_LINE_EMITTER_INDEX

protected static final int LAST_LINE_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

COORD_PROTO_MSG

protected static final String COORD_PROTO_MSG

Message for when the proto is not a Coord

See Also:

• Constant Field Values

COORD_NODE_MSG

protected static final String COORD_NODE_MSG

Message for when the node in setValue() is not a Coord

See Also:

• Constant Field Values

pCoord

protected VRMLProtoInstance pCoord

Proto version of the coord

vfCoord

protected VRMLCoordinateNodeType vfCoord

exposedField SFNode coord

vfCoordIndex

protected int[] vfCoordIndex

The value of the cycle time field

numCoordIndex

protected int numCoordIndex

Number of valid values in vfColorIndex

vfDirection

protected float[] vfDirection

The value of the cycle interval field

Constructor Details

BasePolylineEmitter

protected BasePolylineEmitter()

Construct a new time sensor object

BasePolylineEmitter

public BasePolylineEmitter(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

allEventsComplete

public void allEventsComplete()

Ignored by this base implementation. Any class that needs this method may override this method as required.

Specified by:

allEventsComplete in interface FrameStateListener

Overrides:

allEventsComplete in class AbstractNode

fieldChanged

public void fieldChanged(VRMLNodeType node,
 int index)

Notification that the field from the coordinate node has changed.

Specified by:

fieldChanged in interface VRMLNodeComponentListener

Parameters:

node - The source node that changed the field

index - The field index that changed

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.

Specified by:

getFieldIndex in interface VRMLNode

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.

Specified by:

getNodeFieldIndices in interface VRMLNode

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.

Specified by:

getFieldDeclaration in interface VRMLNode

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.

Specified by:

getNumFields in interface VRMLNode

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

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

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

Set the value of the field at the given index as a int array for the MFInt32 and SF/MFImage 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 out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 float[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as a float 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 out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 VRMLNodeType child)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as a node. This would be used to set SFNode field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

child - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The node does not match the required type.

setCoordIndex

protected void setCoordIndex(int[] value,
 int numValid)

Set the coordIndex field. Override to provide.renderer-specific behaviour, but remember to also call this implementation too.

Parameters:

value - The new set of coordinate index values

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

setCoord

protected void setCoord(int field,
 VRMLNodeType coord)
                 throws InvalidFieldValueException

Set the coordinate node that forms the base of the line emitter.

Parameters:

field -

coord - The coordinate node to source vertex data from

Throws:

InvalidFieldValueException

setDirection

protected void setDirection(float[] dir)

The direction value has just been set.

Parameters:

dir - The new direction of the emitter.