java.lang.Object

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

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

All Implemented Interfaces:: VRMLNode, FrameStateListener, VRMLBoundedNodeType, VRMLChildNodeType, VRMLNodeType, VRMLParticleSystemNodeType, VRMLShapeNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:: NRParticleSystem, OGLParticleSystem

public abstract class BaseParticleSystem extends AbstractNode implements VRMLParticleSystemNodeType

Common base renderer implementation of a particle system shape node.

This implementation is renderer independent, but uses the common j3d.org interfaces for dealing with the particle systems.

Version:: $Revision: 2.6 $
Author:: Justin Couch

Field Summary

Fields

Modifier and Type

Field

Description

protected static final String

APPEARANCE_NODE_MSG

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

protected static final String

APPEARANCE_PROTO_MSG

Message for when the proto is not a Appearance

protected static final String

COLOR_NODE_MSG

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

protected static final String

COLOR_PROTO_MSG

Message for when the proto is not a Color

protected org.j3d.geom.particle.ColorRampFunction

colorFunction

Colour ramp handler for dealing with the colour keys changing

protected org.j3d.geom.particle.ParticleInitializer

emitter

Internal implementation of the emitter

protected static final String

EMITTER_NODE_MSG

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

protected static final String

EMITTER_PROTO_MSG

Message for when the proto is not a Emitter

protected static final int

FIELD_APPEARANCE

Index for the appearance field

protected static final int

FIELD_BBOX_CENTER

Index for the bbox_center field

protected static final int

FIELD_BBOX_DISPLAY

Index of the Bounding box display bboxDisplay field

protected static final int

FIELD_BBOX_SIZE

Index for the bbox_size field

protected static final int

FIELD_COLOR_KEY

Index for the colorKey field

protected static final int

FIELD_COLOR_RAMP

Index for the colorRamp field

protected static final int

FIELD_CREATE_PARTICLES

Index for the createParticles field

protected static final int

FIELD_EMITTER

Index for the emitter field

protected static final int

FIELD_ENABLED

Index for the enabled field

protected static final int

FIELD_GEOMETRY

Index for the geometry field

protected static final int

FIELD_GEOMETRY_TYPE

Index for the geometryType field

protected static final int

FIELD_IS_ACTIVE

Index for the colorKey field

protected static final int

FIELD_LIFETIME_VARIATION

Index for the lifetimeVariation field

protected static final int

FIELD_MAX_PARTICLES

Index for the maxParticles field

protected static final int

FIELD_PARTICLE_LIFETIME

Index for the particleLifetime field

protected static final int

FIELD_PARTICLE_SIZE

Index for the particleSize field

protected static final int

FIELD_PHYSICS

Index for the physics field

protected static final int

FIELD_TEXCOORD_KEY

Index for the texCoordKey field

protected static final int

FIELD_TEXCOORD_RAMP

Index for the texCoordRamp field

protected static final int

FIELD_VISIBLE

Index of the Bounding box display visible field

protected int

geometryType

The geometry type as a flag.

protected static final int

LAST_PARTICLE_INDEX

The last field index used by this class

protected static final int

NUM_FIELDS

Number of fields constant

protected int

numColorKey

Number of valid colorKey values

protected int

numTexCoordKey

Number of valid texCoordKey values

protected VRMLProtoInstance

pAppearance

Proto version of the appearance

protected org.j3d.geom.particle.ParticleSystem

particleSystem

The particle system this node is made of

protected VRMLProtoInstance

pColorRamp

Proto version of the colorRamp

protected VRMLProtoInstance

pEmitter

Proto version of the Emitter

protected static final String

PHYSICS_NODE_MSG

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

protected static final String

PHYSICS_PROTO_MSG

Message for when the proto is not a Physics

protected VRMLProtoInstance

pTexCoordRamp

Proto version of the texCoordRamp

protected static final String

TEXCOORD_NODE_MSG

Message for when the node in setValue() is not tex coords

protected static final String

TEXCOORD_PROTO_MSG

Message for when the proto is not a tex coords

protected org.j3d.geom.particle.MaxTimeParticleFunction

timeFunction

Particle function for limiting max particle life

protected static final int

TYPE_CUSTOM

Particle geometry type is custom lvl 2

protected static final int

TYPE_LINES

Particle geometry type is Lines

protected static final int

TYPE_POINTS

Particle geometry type is Points

protected static final int

TYPE_QUADS

Particle geometry type is Quads

protected static final int

TYPE_SPRITES

Particle geometry type is point sprites

protected static final int

TYPE_TRIS

Particle geometry type is Triangles

protected VRMLAppearanceNodeType

vfAppearance

exposedField SFNode appearance NULL

protected float[]

vfBboxCenter

field SFVec3f bboxCenter 0, 0, 0

protected boolean

vfBboxDisplay

SFBool bboxDisplay false

protected float[]

vfBboxSize

field SFVec3f bboxSize [-1, -1, -1]

protected float[]

vfColorKey

field MFFloat colorKey

protected VRMLColorNodeType

vfColorRamp

field SFNode colorRamp NULL

protected boolean

vfCreateParticles

exposedField SFBool createParticles

protected VRMLParticleEmitterNodeType

vfEmitter

field SFNode emitter NULL

protected boolean

vfEnabled

exposedField SFBool enabled

protected String

vfGeometryType

field SFString geometryType "QUAD"

protected boolean

vfIsActive

Value of the isActive outputOnly field

protected float

vfLifetimeVariation

exposedField SFFloat lifetimeVariation

protected int

vfMaxParticles

exposedField SFInt32 maxParticles

protected float

vfParticleLifetime

exposedField SFFloat particleLifetime

protected float[]

vfParticleSize

exposedField SFFVec2f particleSize

protected VRMLNodeType[]

vfPhysics

The physics nodes mixed proto and child nodes

protected float[]

vfTexCoordKey

field MFFloat texCoordKey

protected VRMLTextureCoordinateNodeType

vfTexCoordRamp

field SFNode texCoordRamp NULL

protected boolean

vfVisible

SFBool visible true

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

BaseParticleSystem()

Construct a new default shape node implementation.

protected

BaseParticleSystem(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node.
Method Summary

Modifier and Type

Method

Description

VRMLNodeType

getAppearance()

Get node content for appearance.

float[]

getBboxCenter()

Get the current value of field the bboxCenter field.

boolean

getBboxDisplay()

Get the current value of the bboxDisplay field.

float[]

getBboxSize()

Get the current value of the bboxSize field.

boolean

getEnabled()

Get the current enabled state of this model.

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.

VRMLNodeType

getGeometry()

Get node content for geometry

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.

int

getPrimaryType()

Get the primary type of this node.

int[]

getSecondaryType()

Get the secondary type of this node.

org.j3d.geom.particle.ParticleSystem

getSystem()

Get the internal initialiser model that will be used for this particle system implementation.

boolean

getVisible()

Get the current value of the visible field.

boolean

isActive()

Check to see if this node is currently active for evaluation.

boolean

isShared()

Check to see if this node has been used more than once.

void

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

Send a routed value from this node to the given destination node.

void

setActive(boolean state)

Manually set the particle system to inactive due to the behaviour of the internals.

void

setAppearance(VRMLNodeType newAppearance)

Set node content as replacement for appearance.

void

setBboxCenter(float[] newBboxCenter)

Convenience method to set a new value the vfBboxCenter fields

void

setBboxDisplay(boolean val)

Set the bounding box display for this node.

void

setBboxSize(float[] newBboxSize)

Convenience method to set a new value for the vfBboxSize field.

void

setEnabled(boolean state)

Set the enabled state of the Physics model.

void

setGeometry(VRMLNodeType newGeometry)

Set node content as replacement for geometry.

protected void

setParticleSize(float[] value)

Set the size of the particle to a new value.

void

setShared(boolean used)

Adjust the sharing count up or down one increment depending on the flag.

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.

void

setValue(int index, float value)

Set the value of the field at the given index as a float.

void

setValue(int index, float[] value, int numValid)

Set the value of the field at the given index as a float.

void

setValue(int index, int value)

Set the value of the field at the given index as an int.

void

setValue(int index, String value)

Set the value of the field at the given index as an string.

void

setValue(int index, VRMLNodeType child)

Set the value of the field at the given index as a node.

void

setValue(int index, VRMLNodeType[] children, int numValid)

Set the value of the field at the given index as a node.

void

setVisible(boolean val)

Set visible field for this node.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode
addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, 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
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, updateRefCount

Field Details
- FIELD_APPEARANCE
  protected static final int FIELD_APPEARANCE
  
  Index for the appearance field
  
  See Also:
  
  Constant Field Values
- FIELD_GEOMETRY
  protected static final int FIELD_GEOMETRY
  
  Index for the geometry field
  
  See Also:
  
  Constant Field Values
- FIELD_BBOX_SIZE
  protected static final int FIELD_BBOX_SIZE
  
  Index for the bbox_size field
  
  See Also:
  
  Constant Field Values
- FIELD_BBOX_CENTER
  protected static final int FIELD_BBOX_CENTER
  
  Index for the bbox_center field
  
  See Also:
  
  Constant Field Values
- FIELD_BBOX_DISPLAY
  protected static final int FIELD_BBOX_DISPLAY
  
  Index of the Bounding box display bboxDisplay field
  
  See Also:
  
  Constant Field Values
- FIELD_VISIBLE
  protected static final int FIELD_VISIBLE
  
  Index of the Bounding box display visible field
  
  See Also:
  
  Constant Field Values
- FIELD_GEOMETRY_TYPE
  protected static final int FIELD_GEOMETRY_TYPE
  
  Index for the geometryType field
  
  See Also:
  
  Constant Field Values
- FIELD_ENABLED
  protected static final int FIELD_ENABLED
  
  Index for the enabled field
  
  See Also:
  
  Constant Field Values
- FIELD_MAX_PARTICLES
  protected static final int FIELD_MAX_PARTICLES
  
  Index for the maxParticles field
  
  See Also:
  
  Constant Field Values
- FIELD_PARTICLE_LIFETIME
  protected static final int FIELD_PARTICLE_LIFETIME
  
  Index for the particleLifetime field
  
  See Also:
  
  Constant Field Values
- FIELD_LIFETIME_VARIATION
  protected static final int FIELD_LIFETIME_VARIATION
  
  Index for the lifetimeVariation field
  
  See Also:
  
  Constant Field Values
- FIELD_EMITTER
  protected static final int FIELD_EMITTER
  
  Index for the emitter field
  
  See Also:
  
  Constant Field Values
- FIELD_PHYSICS
  protected static final int FIELD_PHYSICS
  
  Index for the physics field
  
  See Also:
  
  Constant Field Values
- FIELD_COLOR_RAMP
  protected static final int FIELD_COLOR_RAMP
  
  Index for the colorRamp field
  
  See Also:
  
  Constant Field Values
- FIELD_COLOR_KEY
  protected static final int FIELD_COLOR_KEY
  
  Index for the colorKey field
  
  See Also:
  
  Constant Field Values
- FIELD_IS_ACTIVE
  protected static final int FIELD_IS_ACTIVE
  
  Index for the colorKey field
  
  See Also:
  
  Constant Field Values
- FIELD_PARTICLE_SIZE
  protected static final int FIELD_PARTICLE_SIZE
  
  Index for the particleSize field
  
  See Also:
  
  Constant Field Values
- FIELD_CREATE_PARTICLES
  protected static final int FIELD_CREATE_PARTICLES
  
  Index for the createParticles field
  
  See Also:
  
  Constant Field Values
- FIELD_TEXCOORD_RAMP
  protected static final int FIELD_TEXCOORD_RAMP
  
  Index for the texCoordRamp field
  
  See Also:
  
  Constant Field Values
- FIELD_TEXCOORD_KEY
  protected static final int FIELD_TEXCOORD_KEY
  
  Index for the texCoordKey field
  
  See Also:
  
  Constant Field Values
- LAST_PARTICLE_INDEX
  protected static final int LAST_PARTICLE_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
- EMITTER_PROTO_MSG
  protected static final String EMITTER_PROTO_MSG
  
  Message for when the proto is not a Emitter
  
  See Also:
  
  Constant Field Values
- EMITTER_NODE_MSG
  protected static final String EMITTER_NODE_MSG
  
  Message for when the node in setValue() is not a Emitter
  
  See Also:
  
  Constant Field Values
- PHYSICS_PROTO_MSG
  protected static final String PHYSICS_PROTO_MSG
  
  Message for when the proto is not a Physics
  
  See Also:
  
  Constant Field Values
- PHYSICS_NODE_MSG
  protected static final String PHYSICS_NODE_MSG
  
  Message for when the node in setValue() is not a Physics
  
  See Also:
  
  Constant Field Values
- APPEARANCE_PROTO_MSG
  protected static final String APPEARANCE_PROTO_MSG
  
  Message for when the proto is not a Appearance
  
  See Also:
  
  Constant Field Values
- APPEARANCE_NODE_MSG
  protected static final String APPEARANCE_NODE_MSG
  
  Message for when the node in setValue() is not a Appearance
  
  See Also:
  
  Constant Field Values
- COLOR_PROTO_MSG
  protected static final String COLOR_PROTO_MSG
  
  Message for when the proto is not a Color
  
  See Also:
  
  Constant Field Values
- COLOR_NODE_MSG
  protected static final String COLOR_NODE_MSG
  
  Message for when the node in setValue() is not a Color
  
  See Also:
  
  Constant Field Values
- TEXCOORD_PROTO_MSG
  protected static final String TEXCOORD_PROTO_MSG
  
  Message for when the proto is not a tex coords
  
  See Also:
  
  Constant Field Values
- TEXCOORD_NODE_MSG
  protected static final String TEXCOORD_NODE_MSG
  
  Message for when the node in setValue() is not tex coords
  
  See Also:
  
  Constant Field Values
- TYPE_QUADS
  protected static final int TYPE_QUADS
  
  Particle geometry type is Quads
  
  See Also:
  
  Constant Field Values
- TYPE_TRIS
  protected static final int TYPE_TRIS
  
  Particle geometry type is Triangles
  
  See Also:
  
  Constant Field Values
- TYPE_LINES
  protected static final int TYPE_LINES
  
  Particle geometry type is Lines
  
  See Also:
  
  Constant Field Values
- TYPE_POINTS
  protected static final int TYPE_POINTS
  
  Particle geometry type is Points
  
  See Also:
  
  Constant Field Values
- TYPE_SPRITES
  protected static final int TYPE_SPRITES
  
  Particle geometry type is point sprites
  
  See Also:
  
  Constant Field Values
- TYPE_CUSTOM
  protected static final int TYPE_CUSTOM
  
  Particle geometry type is custom lvl 2
  
  See Also:
  
  Constant Field Values
- pAppearance
  
  protected VRMLProtoInstance pAppearance
  
  Proto version of the appearance
- vfAppearance
  
  protected VRMLAppearanceNodeType vfAppearance
  
  exposedField SFNode appearance NULL
- pEmitter
  
  protected VRMLProtoInstance pEmitter
  
  Proto version of the Emitter
- vfEmitter
  
  protected VRMLParticleEmitterNodeType vfEmitter
  
  field SFNode emitter NULL
- pColorRamp
  
  protected VRMLProtoInstance pColorRamp
  
  Proto version of the colorRamp
- vfColorRamp
  
  protected VRMLColorNodeType vfColorRamp
  
  field SFNode colorRamp NULL
- pTexCoordRamp
  
  protected VRMLProtoInstance pTexCoordRamp
  
  Proto version of the texCoordRamp
- vfTexCoordRamp
  
  protected VRMLTextureCoordinateNodeType vfTexCoordRamp
  
  field SFNode texCoordRamp NULL
- vfPhysics
  
  protected VRMLNodeType[] vfPhysics
  
  The physics nodes mixed proto and child nodes
- vfBboxCenter
  
  protected float[] vfBboxCenter
  
  field SFVec3f bboxCenter 0, 0, 0
- vfBboxSize
  
  protected float[] vfBboxSize
  
  field SFVec3f bboxSize [-1, -1, -1]
- vfBboxDisplay
  
  protected boolean vfBboxDisplay
  
  SFBool bboxDisplay false
- vfVisible
  
  protected boolean vfVisible
  
  SFBool visible true
- vfGeometryType
  
  protected String vfGeometryType
  
  field SFString geometryType "QUAD"
- vfEnabled
  
  protected boolean vfEnabled
  
  exposedField SFBool enabled
- vfCreateParticles
  
  protected boolean vfCreateParticles
  
  exposedField SFBool createParticles
- vfMaxParticles
  
  protected int vfMaxParticles
  
  exposedField SFInt32 maxParticles
- vfParticleLifetime
  
  protected float vfParticleLifetime
  
  exposedField SFFloat particleLifetime
- vfParticleSize
  
  protected float[] vfParticleSize
  
  exposedField SFFVec2f particleSize
- vfLifetimeVariation
  
  protected float vfLifetimeVariation
  
  exposedField SFFloat lifetimeVariation
- vfColorKey
  
  protected float[] vfColorKey
  
  field MFFloat colorKey
- numColorKey
  
  protected int numColorKey
  
  Number of valid colorKey values
- vfTexCoordKey
  
  protected float[] vfTexCoordKey
  
  field MFFloat texCoordKey
- numTexCoordKey
  
  protected int numTexCoordKey
  
  Number of valid texCoordKey values
- vfIsActive
  
  protected boolean vfIsActive
  
  Value of the isActive outputOnly field
- geometryType
  
  protected int geometryType
  
  The geometry type as a flag. Set during setupFinished
- particleSystem
  
  protected org.j3d.geom.particle.ParticleSystem particleSystem
  
  The particle system this node is made of
- emitter
  
  protected org.j3d.geom.particle.ParticleInitializer emitter
  
  Internal implementation of the emitter
- colorFunction
  
  protected org.j3d.geom.particle.ColorRampFunction colorFunction
  
  Colour ramp handler for dealing with the colour keys changing
- timeFunction
  
  protected org.j3d.geom.particle.MaxTimeParticleFunction timeFunction
  
  Particle function for limiting max particle life
Constructor Details
- BaseParticleSystem
  
  protected BaseParticleSystem()
  
  Construct a new default shape node implementation.
- BaseParticleSystem
  
  protected BaseParticleSystem(VRMLNodeType node)
  
  Construct a new instance of this node based on the details from the given node. If the node is not a Shape node, an exception will be thrown.
  
  Parameters:
  
  node - The node to copy
  
  Throws:
  
  IllegalArgumentException - Incorrect node type
Method Details
- getSystem
  
  public org.j3d.geom.particle.ParticleSystem getSystem()
  
  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:
  
  getSystem in interface VRMLParticleSystemNodeType
  
  Returns:
  
  The initialiser instance to use
- setEnabled
  
  public void setEnabled(boolean state)
  
  Set the enabled state of the Physics model.
  
  Specified by:
  
  setEnabled in interface VRMLParticleSystemNodeType
  
  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 VRMLParticleSystemNodeType
  
  Returns:
  
  The value of the enabled field
- isActive
  
  public boolean isActive()
  
  Check to see if this node is currently active for evaluation.
  
  Specified by:
  
  isActive in interface VRMLParticleSystemNodeType
  
  Returns:
  
  true if the node still can run this frame
- setActive
  
  public void setActive(boolean state)
  
  Manually set the particle system to inactive due to the behaviour of the internals. The manager has decided that this node is no longer needing to be run, so indicate that the activity level has changed.
  
  Specified by:
  
  setActive in interface VRMLParticleSystemNodeType
  
  Parameters:
  
  state - true to set this as active, false for inActive
- getAppearance
  
  public VRMLNodeType getAppearance()
  
  Get node content for appearance.
  
  Specified by:
  
  getAppearance in interface VRMLShapeNodeType
  
  Returns:
  
  The current appearance
- setAppearance
  
  public void setAppearance(VRMLNodeType newAppearance) throws InvalidFieldValueException
  
  Set node content as replacement for appearance.
  
  Specified by:
  
  setAppearance in interface VRMLShapeNodeType
  
  Parameters:
  
  newAppearance - The new appearance. null will act like delete
  
  Throws:
  
  InvalidFieldValueException - The node does not match the required type.
- getGeometry
  
  public VRMLNodeType getGeometry()
  
  Get node content for geometry
  
  Specified by:
  
  getGeometry in interface VRMLShapeNodeType
  
  Returns:
  
  The current geoemtry field
- setGeometry
  
  public void setGeometry(VRMLNodeType newGeometry) throws InvalidFieldValueException
  
  Set node content as replacement for geometry.
  
  Specified by:
  
  setGeometry in interface VRMLShapeNodeType
  
  Parameters:
  
  newGeometry - The new value for geometry. Null will act like delete
  
  Throws:
  
  InvalidFieldValueException - The node does not match the required type.
- getBboxCenter
  
  public float[] getBboxCenter()
  
  Description copied from interface: VRMLBoundedNodeType
  
  Get the current value of field the bboxCenter field. The default value is 0 0 0.
  
  Specified by:
  
  getBboxCenter in interface VRMLBoundedNodeType
  
  Returns:
  
  The value of bboxCenter(SFVec3f)
- getBboxSize
  
  public float[] getBboxSize()
  
  Description copied from interface: VRMLBoundedNodeType
  
  Get the current value of the bboxSize field. The default value is -1 -1 -1.
  
  Specified by:
  
  getBboxSize in interface VRMLBoundedNodeType
  
  Returns:
  
  The size of the bboxSize(SFVec3f)
- getBboxDisplay
  
  public boolean getBboxDisplay()
  
  Description copied from interface: VRMLBoundedNodeType
  
  Get the current value of the bboxDisplay field. The default value is false.
  
  Specified by:
  
  getBboxDisplay in interface VRMLBoundedNodeType
  
  Returns:
  
  the value of the bboxDisplay(SFBool)
- getVisible
  
  public boolean getVisible()
  
  Description copied from interface: VRMLBoundedNodeType
  
  Get the current value of the visible field. The default value is true.
  
  Specified by:
  
  getVisible in interface VRMLBoundedNodeType
  
  Returns:
  
  the value of the visible(SFBool)
- isShared
  
  public boolean isShared()
  
  Check to see if this node has been used more than once. If it has then return true.
  
  Specified by:
  
  isShared in interface VRMLBoundedNodeType
  
  Returns:
  
  true if this node is shared
- setShared
  
  public void setShared(boolean used)
  
  Adjust the sharing count up or down one increment depending on the flag.
  
  Specified by:
  
  setShared in interface VRMLBoundedNodeType
  
  Parameters:
  
  used - true if this is about to have another reference added
- 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. Assumes that the derived node has initialised the particleSystem variable of this class before calling this method.
  
  Specified by:
  
  setupFinished in interface VRMLNodeType
  
  Overrides:
  
  setupFinished in class AbstractNode
- 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.
- 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
- getSecondaryType
  
  public int[] getSecondaryType()
  
  Get the secondary type of this node. Replaces the instanceof mechanism for use in switch statements.
  
  Specified by:
  
  getSecondaryType in interface VRMLNode
  
  Overrides:
  
  getSecondaryType in class AbstractNode
  
  Returns:
  
  The secondary 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
- setValue
  
  public void setValue(int index, int value) throws InvalidFieldException, InvalidFieldValueException
  
  Set the value of the field at the given index as an int. This would be used to set SFInt32 field types.
  
  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:
  
  InvalidFieldValueException - The node does not match the required type.
  
  InvalidFieldException - The field index is not known
- setValue
  
  public void setValue(int index, String value) throws InvalidFieldException, InvalidFieldValueException
  
  Set the value of the field at the given index as an string. This would be used to set SFString field types.
  
  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:
  
  InvalidFieldValueException - The node does not match the required type.
  
  InvalidFieldException - The field index is not known
- setValue
  
  public void setValue(int index, float value) throws InvalidFieldException, InvalidFieldValueException
  
  Set the value of the field at the given index as a float. This would be used to set SFFloat field types.
  
  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:
  
  InvalidFieldValueException - The node does not match the required type.
  
  InvalidFieldException - The field index is not known
- 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. This would be used to set SFFloat field types.
  
  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, InvalidFieldAccessException
  
  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 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[] children, int numValid) 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
  
  children - The new value to use for the node
  
  numValid - The number of valid values to copy from the array
  
  Throws:
  
  InvalidFieldValueException - The node does not match the required type.
  
  InvalidFieldException - The field index is not known
- setParticleSize
  
  protected void setParticleSize(float[] value) throws InvalidFieldValueException
  
  Set the size of the particle to a new value. This should be overridden by renderer-specific classes for telling the particle system about it.
  
  Parameters:
  
  value - The new 2D size to use
  
  Throws:
  
  InvalidFieldValueException - The value is negative
- setBboxCenter
  
  public void setBboxCenter(float[] newBboxCenter) throws InvalidFieldAccessException
  
  Convenience method to set a new value the vfBboxCenter fields
  
  Specified by:
  
  setBboxCenter in interface VRMLBoundedNodeType
  
  Parameters:
  
  newBboxCenter - The new center of the bounding box
  
  Throws:
  
  InvalidFieldAccessException - The call is attempting to write to after setup has finished
- setBboxSize
  
  public void setBboxSize(float[] newBboxSize) throws InvalidFieldAccessException
  
  Convenience method to set a new value for the vfBboxSize field.
  
  Specified by:
  
  setBboxSize in interface VRMLBoundedNodeType
  
  Parameters:
  
  newBboxSize - The new size for the bounding box
  
  Throws:
  
  InvalidFieldAccessException - The call is attempting to write to after setup has finished
- setBboxDisplay
  
  public void setBboxDisplay(boolean val)
  
  Set the bounding box display for this node. Only used by the field parser
  
  Specified by:
  
  setBboxDisplay in interface VRMLBoundedNodeType
  
  Parameters:
  
  val - the display value to set
- setVisible
  
  public void setVisible(boolean val)
  
  Set visible field for this node. Only used by the field parser
  
  Specified by:
  
  setVisible in interface VRMLBoundedNodeType
  
  Parameters:
  
  val - the display value to set

Class BaseParticleSystem

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.web3d.vrml.lang.VRMLNode

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

Field Details

FIELD_APPEARANCE

FIELD_GEOMETRY

FIELD_BBOX_SIZE

FIELD_BBOX_CENTER

FIELD_BBOX_DISPLAY

FIELD_VISIBLE

FIELD_GEOMETRY_TYPE

FIELD_ENABLED

FIELD_MAX_PARTICLES

FIELD_PARTICLE_LIFETIME

FIELD_LIFETIME_VARIATION

FIELD_EMITTER

FIELD_PHYSICS

FIELD_COLOR_RAMP

FIELD_COLOR_KEY

FIELD_IS_ACTIVE

FIELD_PARTICLE_SIZE

FIELD_CREATE_PARTICLES

FIELD_TEXCOORD_RAMP

FIELD_TEXCOORD_KEY

LAST_PARTICLE_INDEX

NUM_FIELDS

EMITTER_PROTO_MSG

EMITTER_NODE_MSG

PHYSICS_PROTO_MSG

PHYSICS_NODE_MSG

APPEARANCE_PROTO_MSG

APPEARANCE_NODE_MSG

COLOR_PROTO_MSG

COLOR_NODE_MSG

TEXCOORD_PROTO_MSG

TEXCOORD_NODE_MSG

TYPE_QUADS

TYPE_TRIS

TYPE_LINES

TYPE_POINTS

TYPE_SPRITES

TYPE_CUSTOM

pAppearance

vfAppearance

pEmitter

vfEmitter

pColorRamp

vfColorRamp

pTexCoordRamp

vfTexCoordRamp

vfPhysics

vfBboxCenter

vfBboxSize

vfBboxDisplay

vfVisible

vfGeometryType

vfEnabled

vfCreateParticles

vfMaxParticles

vfParticleLifetime

vfParticleSize

vfLifetimeVariation

vfColorKey

numColorKey

vfTexCoordKey

numTexCoordKey

vfIsActive

geometryType

particleSystem

emitter

colorFunction

timeFunction

Constructor Details