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

Class BaseEmitter

java.lang.Object

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

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLNodeType, VRMLParticleEmitterNodeType

Direct Known Subclasses:

BaseExplosionEmitter, BasePointEmitter, BasePolylineEmitter

public abstract class BaseEmitter
extends AbstractNode
implements VRMLParticleEmitterNodeType

Common implementation of all Emitter nodes.

Version:

$Revision: 2.1 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_MASS	The field index for mass
protected static final int	FIELD_SPEED	The field index for speed
protected static final int	FIELD_SURFACE_AREA	The field index for surfaceArea
protected static final int	FIELD_VARIATION	The field index for variation
protected org.j3d.geom.particle.ParticleInitializer	initializer	The particle initializer corresponding to this emitter type
protected static final int	LAST_EMITTER_INDEX	The last field index used by this class
protected static final int	NUM_FIELDS	Number of fields constant
protected float	vfMass	The value of the mass field
protected float	vfSpeed	The value of the velocity field
protected float	vfSurfaceArea	The value of the surfaceArea field
protected float	vfVariation	The value of the variation 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	BaseEmitter(String type)	Construct a new time sensor object

Method Summary

Modifier and Type	Method	Description
protected void	copy(VRMLParticleEmitterNodeType node)	Copy the values of the given node to this one.
VRMLFieldData	getFieldValue(int index)	Get the value of a field.
org.j3d.geom.particle.ParticleInitializer	getInitializer()	Get the internal initialiser model that will be used for this particle system implementation.
float	getMass()	Get the current value of the mass field.
int	getPrimaryType()	Get the primary type of this node.
float	getSpeed()	Get the current value of the speed field.
float	getSurfaceArea()	Get the current value of the surfaceArea field.
float	getVariation()	Get the current value of the variation field.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setMass(float mass)	Set the position field value to the new value.
void	setSpeed(float speed)	Set the position field value to the new value.
void	setSurfaceArea(float surfaceArea)	Set the position field value to the new value.
void	setValue(int index, float value)	Set the value of the field at the given index as a float for the SFFloat fields.
void	setVariation(float variation)	Set the variation field value to the new value.

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

Field Details

FIELD_SPEED

protected static final int FIELD_SPEED

The field index for speed

See Also:

• Constant Field Values

FIELD_MASS

protected static final int FIELD_MASS

The field index for mass

See Also:

• Constant Field Values

FIELD_SURFACE_AREA

protected static final int FIELD_SURFACE_AREA

The field index for surfaceArea

See Also:

• Constant Field Values

FIELD_VARIATION

protected static final int FIELD_VARIATION

The field index for variation

See Also:

• Constant Field Values

LAST_EMITTER_INDEX

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

vfSpeed

protected float vfSpeed

The value of the velocity field

vfVariation

protected float vfVariation

The value of the variation field

vfMass

protected float vfMass

The value of the mass field

vfSurfaceArea

protected float vfSurfaceArea

The value of the surfaceArea field

initializer

protected org.j3d.geom.particle.ParticleInitializer initializer

The particle initializer corresponding to this emitter type

Constructor Details

BaseEmitter

protected BaseEmitter(String type)

Construct a new time sensor object

Parameters:

type -

Method Details

copy

protected void copy(VRMLParticleEmitterNodeType node)

Copy the values of the given node to this one.

Parameters:

node - The emitter to use

getInitializer

public org.j3d.geom.particle.ParticleInitializer getInitializer()

Get the internal initialiser model that will be used for this particle system implementation. This may not be available until after setupFinished() has been called.

Specified by:

getInitializer in interface VRMLParticleEmitterNodeType

Returns:

The initialiser instance to use

getSpeed

public float getSpeed()

Get the current value of the speed field.

Specified by:

getSpeed in interface VRMLParticleEmitterNodeType

Returns:

the current speed value 0 - inf.

setSpeed

public void setSpeed(float speed)
              throws InvalidFieldValueException

Set the position field value to the new value.

Specified by:

setSpeed in interface VRMLParticleEmitterNodeType

Parameters:

speed - The new position to set

Throws:

InvalidFieldValueException

getMass

public float getMass()

Get the current value of the mass field.

Specified by:

getMass in interface VRMLParticleEmitterNodeType

Returns:

the current mass value 0 - inf.

setMass

public void setMass(float mass)
             throws InvalidFieldValueException

Set the position field value to the new value.

Specified by:

setMass in interface VRMLParticleEmitterNodeType

Parameters:

mass - The new mass to set

Throws:

InvalidFieldValueException - The mass value was negative

getSurfaceArea

public float getSurfaceArea()

Get the current value of the surfaceArea field.

Specified by:

getSurfaceArea in interface VRMLParticleEmitterNodeType

Returns:

the current surfaceArea value 0 - inf.

setSurfaceArea

public void setSurfaceArea(float surfaceArea)
                    throws InvalidFieldValueException

Set the position field value to the new value.

Specified by:

setSurfaceArea in interface VRMLParticleEmitterNodeType

Parameters:

surfaceArea - The new amount of surface area to set

Throws:

InvalidFieldValueException - The area value was negative

getVariation

public float getVariation()

Get the current value of the variation field.

Specified by:

getVariation in interface VRMLParticleEmitterNodeType

Returns:

The current variation value

setVariation

public void setVariation(float variation)
                  throws InvalidFieldValueException

Set the variation field value to the new value. If it is out of range the throw an exception.

Specified by:

setVariation in interface VRMLParticleEmitterNodeType

Parameters:

variation - The new amount of variation to set

Throws:

InvalidFieldValueException - The field is out of range

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,
 float value)
              throws InvalidFieldException,
InvalidFieldValueException

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

Throws:

InvalidFieldException - The field index is not known

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