ParticleSystemObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.X3DConcreteElement
- - org.web3d.x3d.jsail.X3DConcreteNode
  - - org.web3d.x3d.jsail.ParticleSystems.ParticleSystemObject

All Implemented Interfaces:

X3DChildNode, X3DNode, X3DBoundedObject, ParticleSystem, X3DShapeNode
```
public class ParticleSystemObject
extends X3DConcreteNode
implements ParticleSystem
```
X3D node tooltip: (X3D version 3.2 or later) ParticleSystem specifies a complete particle system. It can contain Appearance for particle appearance, a geometry node if gemoetryType='GEOMETRY', a colorRamp Color/ColorRGBA node for changing base color over each particle's lifetime, a texcoordRamp TextureCoordinate node to control texture coordinates of provided texture(s) in the Appearance node over time, a single emitter X3DParticleEmitterNode, and an array of physics X3DParticlePhysicsModelNode nodes.
- Hint: event timing details are explained in 4.4.8.3 Execution model http://www.web3d.org/files/specifications/19775-1/V3.3/Part01/concepts.html#ExecutionModel
- Hint: Wikipedia, particle system https://en.wikipedia.org/wiki/Particle_system
* Note that SFColorObject also provides a variety of color constants.

Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile using the org.web3d.x3d.sai package instead.
See Also:

X3D Abstract Specification: ParticleSystem, X3D Tooltips: ParticleSystem, X3D Scene Authoring Hints

Field Summary

Fields
Modifier and Type	Field and Description
`static float[]`	`BBOXCENTER_DEFAULT_VALUE` SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
`static float[]`	`BBOXSIZE_DEFAULT_VALUE` SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
`static java.lang.String`	`COMPONENT` String constant COMPONENT provides X3D component for this element: ParticleSystems.
`static boolean`	`CREATEPARTICLES_DEFAULT_VALUE` SFBool field named createParticles has default value true (Java syntax) or true (XML syntax).
`static boolean`	`ENABLED_DEFAULT_VALUE` SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
`static java.lang.String`	`fromField_APPEARANCE` fromField ROUTE name for SFNode field named appearance.
`static java.lang.String`	`fromField_CREATEPARTICLES` fromField ROUTE name for SFBool field named createParticles.
`static java.lang.String`	`fromField_ENABLED` fromField ROUTE name for SFBool field named enabled.
`static java.lang.String`	`fromField_GEOMETRY` fromField ROUTE name for SFNode field named geometry.
`static java.lang.String`	`fromField_ISACTIVE` fromField ROUTE name for SFBool field named isActive.
`static java.lang.String`	`fromField_LIFETIMEVARIATION` fromField ROUTE name for SFFloat field named lifetimeVariation.
`static java.lang.String`	`fromField_MAXPARTICLES` fromField ROUTE name for SFInt32 field named maxParticles.
`static java.lang.String`	`fromField_METADATA` fromField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`fromField_PARTICLELIFETIME` fromField ROUTE name for SFFloat field named particleLifetime.
`static java.lang.String`	`fromField_PARTICLESIZE` fromField ROUTE name for SFVec2f field named particleSize.
`static java.lang.String`	`GEOMETRYTYPE_DEFAULT_VALUE` SFString field named geometryType has default value "QUAD" (Java syntax) or QUAD (XML syntax).
`static java.lang.String`	`GEOMETRYTYPE_GEOMETRY` SFString field named geometryType can equal this enumeration value "GEOMETRY" (Java syntax) or GEOMETRY (XML syntax).
`static java.lang.String`	`GEOMETRYTYPE_LINE` SFString field named geometryType can equal this enumeration value "LINE" (Java syntax) or LINE (XML syntax).
`static java.lang.String`	`GEOMETRYTYPE_POINT` SFString field named geometryType can equal this enumeration value "POINT" (Java syntax) or POINT (XML syntax).
`static java.lang.String`	`GEOMETRYTYPE_QUAD` SFString field named geometryType can equal this enumeration value "QUAD" (Java syntax) or QUAD (XML syntax).
`static java.lang.String`	`GEOMETRYTYPE_SPRITE` SFString field named geometryType can equal this enumeration value "SPRITE" (Java syntax) or SPRITE (XML syntax).
`static java.lang.String`	`GEOMETRYTYPE_TRIANGLE` SFString field named geometryType can equal this enumeration value "TRIANGLE" (Java syntax) or TRIANGLE (XML syntax).
`static int`	`LEVEL` Integer constant LEVEL provides default X3D component level for this element: 2.
`static float`	`LIFETIMEVARIATION_DEFAULT_VALUE` SFFloat field named lifetimeVariation has default value 0.25f (Java syntax) or 0.25 (XML syntax).
`static int`	`MAXPARTICLES_DEFAULT_VALUE` SFInt32 field named maxParticles has default value 200 (Java syntax) or 200 (XML syntax).
`static java.lang.String`	`NAME` String constant NAME provides name of this element: ParticleSystem.
`static float`	`PARTICLELIFETIME_DEFAULT_VALUE` SFFloat field named particleLifetime has default value 5f (Java syntax) or 5 (XML syntax).
`static float[]`	`PARTICLESIZE_DEFAULT_VALUE` SFVec2f field named particleSize has default value {0.02f,0.02f} (Java syntax) or 0.02 0.02 (XML syntax).
`static java.lang.String`	`toField_APPEARANCE` toField ROUTE name for SFNode field named appearance.
`static java.lang.String`	`toField_CREATEPARTICLES` toField ROUTE name for SFBool field named createParticles.
`static java.lang.String`	`toField_ENABLED` toField ROUTE name for SFBool field named enabled.
`static java.lang.String`	`toField_GEOMETRY` toField ROUTE name for SFNode field named geometry.
`static java.lang.String`	`toField_LIFETIMEVARIATION` toField ROUTE name for SFFloat field named lifetimeVariation.
`static java.lang.String`	`toField_MAXPARTICLES` toField ROUTE name for SFInt32 field named maxParticles.
`static java.lang.String`	`toField_METADATA` toField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`toField_PARTICLELIFETIME` toField ROUTE name for SFFloat field named particleLifetime.
`static java.lang.String`	`toField_PARTICLESIZE` toField ROUTE name for SFVec2f field named particleSize.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
validationResult

Constructor Summary

Constructors
Constructor and Description
`ParticleSystemObject()` Constructor for ParticleSystemObject to initialize member variables with default values.
`ParticleSystemObject(java.lang.String DEFname)` Utility constructor that assigns DEF name after initializing member variables with default values

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ParticleSystemObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to contained commentsList.
`ParticleSystemObject`	`addComments(java.lang.String newComment)` Add comment as String to contained commentsList.
`ParticleSystemObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to contained commentsList.
`void`	`addPhysics(X3DNode[] newValue)` Add array of child physics nodes to array of existing nodes (if any).
`ParticleSystemObject`	`addPhysics(X3DParticlePhysicsModelNode newValue)` Add single child physics node to array of existing nodes (if any).
`ParticleSystemObject`	`clearAppearance()` Utility method to clear SFNode value of appearance field.
`ParticleSystemObject`	`clearColorKey()` Utility method to clear MFFloat value of colorKey field.
`ParticleSystemObject`	`clearColorRamp()` Utility method to clear SFNode value of colorRamp field.
`ParticleSystemObject`	`clearEmitter()` Utility method to clear SFNode value of emitter field.
`ParticleSystemObject`	`clearGeometry()` Utility method to clear SFNode value of geometry field.
`ParticleSystemObject`	`clearMetadata()` Utility method to clear SFNode value of metadata field.
`ParticleSystemObject`	`clearPhysics()` Utility method to clear MFNode value of physics field.
`ParticleSystemObject`	`clearTexCoordKey()` Utility method to clear MFFloat value of texCoordKey field.
`ParticleSystemObject`	`clearTexCoordRamp()` Utility method to clear SFNode value of texCoordRamp field.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteNode`	`findNodeByDEF(java.lang.String DEFvalue)` Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
`java.lang.String`	`getAccessType(java.lang.String fieldName)` Indicate accessType corresponding to given fieldName.
`X3DAppearanceNode`	`getAppearance()` Provide X3DAppearanceNode instance (using a properly typed node) from inputOutput SFNode field appearance.
`ProtoInstanceObject`	`getAppearanceProtoInstance()` Provide properly typed ProtoInstance for inputOutput SFNode field appearance, if available.
`float[]`	`getBboxCenter()` Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
`float[]`	`getBboxSize()` Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
`float[]`	`getColorKey()` Provide array of Float results using RGB values [0..1] from initializeOnly MFFloat field named colorKey.
`java.util.ArrayList<java.lang.Float>`	`getColorKeyList()` Utility method to get ArrayList value of MFFloat colorKey field, similar to `getColorKey()`.
`X3DColorNode`	`getColorRamp()` Provide X3DColorNode instance (using a properly typed node) using RGB values [0..1] from initializeOnly SFNode field colorRamp.
`ProtoInstanceObject`	`getColorRampProtoInstance()` Provide properly typed ProtoInstance for initializeOnly SFNode field colorRamp, if available.
`java.lang.String`	`getComponent()` Provides X3D component for this element: ParticleSystems.
`int`	`getComponentLevel()` Provides default X3D component level for this element: 2.
`boolean`	`getCreateParticles()` Provide boolean value from inputOutput SFBool field named createParticles.
`java.lang.String`	`getElementName()` Provides name of this element: ParticleSystem.
`X3DParticleEmitterNode`	`getEmitter()` Provide X3DParticleEmitterNode instance (using a properly typed node) from initializeOnly SFNode field emitter.
`ProtoInstanceObject`	`getEmitterProtoInstance()` Provide properly typed ProtoInstance for initializeOnly SFNode field emitter, if available.
`boolean`	`getEnabled()` Provide boolean value from inputOutput SFBool field named enabled.
`java.lang.String`	`getFieldType(java.lang.String fieldName)` Indicate type corresponding to given fieldName.
`X3DGeometryNode`	`getGeometry()` Provide X3DGeometryNode instance (using a properly typed node) from inputOutput SFNode field geometry.
`ProtoInstanceObject`	`getGeometryProtoInstance()` Provide properly typed ProtoInstance for inputOutput SFNode field geometry, if available.
`java.lang.String`	`getGeometryType()` Provide String enumeration value ['LINE'\|'POINT'\|'QUAD'\|'SPRITE'\|'TRIANGLE'\|'GEOMETRY'] from initializeOnly SFString field named geometryType.
`ISObject`	`getIS()` Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`boolean`	`getIsActive()` Provide boolean value from outputOnly SFBool field named isActive.
`float`	`getLifetimeVariation()` Provide float value within allowed range of [0,1] from inputOutput SFFloat field named lifetimeVariation.
`int`	`getMaxParticles()` Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named maxParticles.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`ProtoInstanceObject`	`getMetadataProtoInstance()` Provide properly typed ProtoInstance for inputOutput SFNode field metadata, if available.
`X3DConcreteNode`	`getNodeByDEF(java.lang.String DEFname)` Recursive method to provide object reference to node by DEF name, if found as this node or in a contained node.
`float`	`getParticleLifetime()` Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named particleLifetime.
`float[]`	`getParticleSize()` Provide array of 2-tuple float results within allowed range of [0,infinity) from inputOutput SFVec2f field named particleSize.
`X3DNode[]`	`getPhysics()` Provide array of X3DParticlePhysicsModelNode results (using an array consisting of properly typed nodes or X3DPrototypeInstance objects) from initializeOnly MFNode field physics.
`java.util.ArrayList<X3DParticlePhysicsModelNode>`	`getPhysicsList()` Utility method to get ArrayList value of MFNode physics field, similar to `getPhysics()`.
`float[]`	`getTexCoordKey()` Provide array of Float results within allowed range of [0,infinity) from initializeOnly MFFloat field named texCoordKey.
`java.util.ArrayList<java.lang.Float>`	`getTexCoordKeyList()` Utility method to get ArrayList value of MFFloat texCoordKey field, similar to `getTexCoordKey()`.
`TextureCoordinate`	`getTexCoordRamp()` Provide TextureCoordinate instance (using a properly typed node) from initializeOnly SFNode field texCoordRamp.
`ProtoInstanceObject`	`getTexCoordRampProtoInstance()` Provide properly typed ProtoInstance for initializeOnly SFNode field texCoordRamp, if available.
`boolean`	`hasAppearance()` Indicate whether an object is available for inputOutput SFNode field appearance.
`boolean`	`hasColorRamp()` Indicate whether an object is available for initializeOnly SFNode field colorRamp.
`boolean`	`hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
`boolean`	`hasEmitter()` Indicate whether an object is available for initializeOnly SFNode field emitter.
`boolean`	`hasGeometry()` Indicate whether an object is available for inputOutput SFNode field geometry.
`boolean`	`hasMetadata()` Indicate whether an object is available for inputOutput SFNode field metadata.
`boolean`	`hasNodeByDEF(java.lang.String DEFvalue)` Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
`boolean`	`hasPhysics()` Indicate whether an object is available for initializeOnly MFNode field physics.
`boolean`	`hasTexCoordRamp()` Indicate whether an object is available for initializeOnly SFNode field texCoordRamp.
`void`	`initialize()` Initialize all member variables to default values.
`ParticleSystemObject`	`setAppearance(ProtoInstanceObject newProtoInstanceNode)` Assign ProtoInstance to appearance field; WARNING: ProtoInstance must match acceptable node type X3DAppearanceNode.
`ParticleSystemObject`	`setAppearance(X3DAppearanceNode newValue)` Assign X3DAppearanceNode instance (using a properly typed node) to inputOutput SFNode field appearance.
`ParticleSystemObject`	`setBboxCenter(float[] newValue)` Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
`ParticleSystemObject`	`setBboxCenter(float x, float y, float z)` Assign values to SFVec3f bboxCenter field, similar to `setBboxCenter(float[])`.
`ParticleSystemObject`	`setBboxCenter(SFVec3fObject newValue)` Assign typed object value to SFVec3f bboxCenter field, similar to `setBboxCenter(float[])`.
`ParticleSystemObject`	`setBboxSize(float[] newValue)` Assign 3-tuple float array within allowed range of [0,infinity), or default value [-1 -1 -1], to initializeOnly SFVec3f field named bboxSize.
`ParticleSystemObject`	`setBboxSize(float x, float y, float z)` Assign values to SFVec3f bboxSize field, similar to `setBboxSize(float[])`.
`ParticleSystemObject`	`setBboxSize(SFVec3fObject newValue)` Assign typed object value to SFVec3f bboxSize field, similar to `setBboxSize(float[])`.
`ParticleSystemObject`	`setColorKey(java.util.ArrayList<java.lang.Float> newValue)` Assign ArrayList value of MFFloat colorKey field, similar to `setColorKey(float[])`.
`ParticleSystemObject`	`setColorKey(float[] newValue)` Assign Float array using RGB values [0..1] to initializeOnly MFFloat field named colorKey.
`ParticleSystemObject`	`setColorKey(int[] newValue)` Assign floating-point array value of MFFloat colorKey field, similar to `setColorKey(float[])`.
`ParticleSystemObject`	`setColorKey(MFFloatObject newValue)` Assign typed object value to MFFloat colorKey field, similar to `setColorKey(float[])`.
`ParticleSystemObject`	`setColorRamp(ProtoInstanceObject newProtoInstanceNode)` Assign ProtoInstance to colorRamp field; WARNING: ProtoInstance must match acceptable node type X3DColorNode.
`ParticleSystemObject`	`setColorRamp(X3DColorNode newValue)` Assign X3DColorNode instance (using a properly typed node) using RGB values [0..1] to initializeOnly SFNode field colorRamp.
`ParticleSystemObject`	`setCreateParticles(boolean newValue)` Assign boolean value to inputOutput SFBool field named createParticles.
`ParticleSystemObject`	`setCreateParticles(SFBoolObject newValue)` Assign typed object value to SFBool createParticles field, similar to `setCreateParticles(boolean)`.
`ParticleSystemObject`	`setCssClass(SFStringObject newValue)` Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`ParticleSystemObject`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`ParticleSystemObject`	`setDEF(SFStringObject newValue)` Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`ParticleSystemObject`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`ParticleSystemObject`	`setEmitter(ProtoInstanceObject newProtoInstanceNode)` Assign ProtoInstance to emitter field; WARNING: ProtoInstance must match acceptable node type X3DParticleEmitterNode.
`ParticleSystemObject`	`setEmitter(X3DParticleEmitterNode newValue)` Assign X3DParticleEmitterNode instance (using a properly typed node) to initializeOnly SFNode field emitter.
`ParticleSystemObject`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`ParticleSystemObject`	`setEnabled(SFBoolObject newValue)` Assign typed object value to SFBool enabled field, similar to `setEnabled(boolean)`.
`ParticleSystemObject`	`setGeometry(ProtoInstanceObject newProtoInstanceNode)` Assign ProtoInstance to geometry field; WARNING: ProtoInstance must match acceptable node type X3DGeometryNode.
`ParticleSystemObject`	`setGeometry(X3DGeometryNode newValue)` Assign X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field geometry.
`ParticleSystemObject`	`setGeometryType(SFStringObject newValue)` Assign typed object value to SFString geometryType field, similar to `setGeometryType(String)`.
`ParticleSystemObject`	`setGeometryType(java.lang.String newValue)` Assign String enumeration value ("LINE"\|"POINT"\|"QUAD"\|"SPRITE"\|"TRIANGLE"\|"GEOMETRY") ['LINE'\|'POINT'\|'QUAD'\|'SPRITE'\|'TRIANGLE'\|'GEOMETRY'] to initializeOnly SFString field named geometryType.
`ParticleSystemObject`	`setIS(ISObject newValue)` Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`ParticleSystemObject`	`setLifetimeVariation(float newValue)` Assign float value within allowed range of [0,1] to inputOutput SFFloat field named lifetimeVariation.
`ParticleSystemObject`	`setLifetimeVariation(SFFloatObject newValue)` Assign typed object value to SFFloat lifetimeVariation field, similar to `setLifetimeVariation(float)`.
`ParticleSystemObject`	`setMaxParticles(int newValue)` Assign int value within allowed range of [0,infinity) to inputOutput SFInt32 field named maxParticles.
`ParticleSystemObject`	`setMaxParticles(SFInt32Object newValue)` Assign typed object value to SFInt32 maxParticles field, similar to `setMaxParticles(int)`.
`ParticleSystemObject`	`setMetadata(ProtoInstanceObject newProtoInstanceNode)` Assign ProtoInstance to metadata field; WARNING: ProtoInstance must match acceptable node type X3DMetadataObject.
`ParticleSystemObject`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`ParticleSystemObject`	`setParticleLifetime(float newValue)` Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named particleLifetime.
`ParticleSystemObject`	`setParticleLifetime(SFFloatObject newValue)` Assign typed object value to SFFloat particleLifetime field, similar to `setParticleLifetime(float)`.
`ParticleSystemObject`	`setParticleSize(float[] newValue)` Assign 2-tuple float array within allowed range of [0,infinity) to inputOutput SFVec2f field named particleSize.
`ParticleSystemObject`	`setParticleSize(float x, float y)` Assign values to SFVec2f particleSize field, similar to `setParticleSize(float[])`.
`ParticleSystemObject`	`setParticleSize(SFVec2fObject newValue)` Assign typed object value to SFVec2f particleSize field, similar to `setParticleSize(float[])`.
`ParticleSystemObject`	`setPhysics(java.util.ArrayList<X3DParticlePhysicsModelNode> newValue)` Assign ArrayList value of MFNode physics field, similar to `setPhysics(X3DNode[])`.
`void`	`setPhysics(X3DNode newValue)` Set single child physics node, replacing prior array of existing nodes (if any).
`ParticleSystemObject`	`setPhysics(X3DNode[] newValue)` Assign X3DParticlePhysicsModelNode array (using an array consisting of properly typed nodes or X3DPrototypeInstance objects) to initializeOnly MFNode field physics.
`ParticleSystemObject`	`setTexCoordKey(java.util.ArrayList<java.lang.Float> newValue)` Assign ArrayList value of MFFloat texCoordKey field, similar to `setTexCoordKey(float[])`.
`ParticleSystemObject`	`setTexCoordKey(float[] newValue)` Assign Float array within allowed range of [0,infinity) to initializeOnly MFFloat field named texCoordKey.
`ParticleSystemObject`	`setTexCoordKey(int[] newValue)` Assign floating-point array value of MFFloat texCoordKey field, similar to `setTexCoordKey(float[])`.
`ParticleSystemObject`	`setTexCoordKey(MFFloatObject newValue)` Assign typed object value to MFFloat texCoordKey field, similar to `setTexCoordKey(float[])`.
`ParticleSystemObject`	`setTexCoordRamp(ProtoInstanceObject newProtoInstanceNode)` Assign ProtoInstance to texCoordRamp field; WARNING: ProtoInstance must match acceptable node type TextureCoordinate.
`ParticleSystemObject`	`setTexCoordRamp(TextureCoordinate newValue)` Assign TextureCoordinate instance (using a properly typed node) to initializeOnly SFNode field texCoordRamp.
`ParticleSystemObject`	`setUSE(ParticleSystemObject DEFnode)` Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`ParticleSystemObject`	`setUSE(SFStringObject newValue)` Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`ParticleSystemObject`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`java.lang.String`	`toStringClassicVRML(int level)` Recursive method to provide ClassicVRML string serialization.
`java.lang.String`	`toStringVRML97(int level)` Recursive method to provide VRML97 string serialization.
`java.lang.String`	`toStringX3D(int level)` Recursive method to provide X3D string serialization of this model subgraph.
`java.lang.String`	`validate()` Recursive method to validate this element plus all contained nodes and statements.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - GEOMETRYTYPE_LINE
```
public static final java.lang.String GEOMETRYTYPE_LINE
```
    SFString field named geometryType can equal this enumeration value "LINE" (Java syntax) or LINE (XML syntax).
    
    See Also:
    
    Constant Field Values
  - GEOMETRYTYPE_POINT
```
public static final java.lang.String GEOMETRYTYPE_POINT
```
    SFString field named geometryType can equal this enumeration value "POINT" (Java syntax) or POINT (XML syntax).
    
    See Also:
    
    Constant Field Values
  - GEOMETRYTYPE_QUAD
```
public static final java.lang.String GEOMETRYTYPE_QUAD
```
    SFString field named geometryType can equal this enumeration value "QUAD" (Java syntax) or QUAD (XML syntax).
    
    See Also:
    
    Constant Field Values
  - GEOMETRYTYPE_SPRITE
```
public static final java.lang.String GEOMETRYTYPE_SPRITE
```
    SFString field named geometryType can equal this enumeration value "SPRITE" (Java syntax) or SPRITE (XML syntax).
    
    See Also:
    
    Constant Field Values
  - GEOMETRYTYPE_TRIANGLE
```
public static final java.lang.String GEOMETRYTYPE_TRIANGLE
```
    SFString field named geometryType can equal this enumeration value "TRIANGLE" (Java syntax) or TRIANGLE (XML syntax).
    
    See Also:
    
    Constant Field Values
  - GEOMETRYTYPE_GEOMETRY
```
public static final java.lang.String GEOMETRYTYPE_GEOMETRY
```
    SFString field named geometryType can equal this enumeration value "GEOMETRY" (Java syntax) or GEOMETRY (XML syntax).
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: ParticleSystem.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT provides X3D component for this element: ParticleSystems.
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final int LEVEL
```
    Integer constant LEVEL provides default X3D component level for this element: 2.
    
    See Also:
    
    Constant Field Values
  - BBOXCENTER_DEFAULT_VALUE
```
public static final float[] BBOXCENTER_DEFAULT_VALUE
```
    SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
  - BBOXSIZE_DEFAULT_VALUE
```
public static final float[] BBOXSIZE_DEFAULT_VALUE
```
    SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
  - CREATEPARTICLES_DEFAULT_VALUE
```
public static final boolean CREATEPARTICLES_DEFAULT_VALUE
```
    SFBool field named createParticles has default value true (Java syntax) or true (XML syntax).
    
    See Also:
    
    Constant Field Values
  - ENABLED_DEFAULT_VALUE
```
public static final boolean ENABLED_DEFAULT_VALUE
```
    SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
    
    See Also:
    
    Constant Field Values
  - GEOMETRYTYPE_DEFAULT_VALUE
```
public static final java.lang.String GEOMETRYTYPE_DEFAULT_VALUE
```
    SFString field named geometryType has default value "QUAD" (Java syntax) or QUAD (XML syntax).
    
    See Also:
    
    Constant Field Values
  - LIFETIMEVARIATION_DEFAULT_VALUE
```
public static final float LIFETIMEVARIATION_DEFAULT_VALUE
```
    SFFloat field named lifetimeVariation has default value 0.25f (Java syntax) or 0.25 (XML syntax).
    
    See Also:
    
    Constant Field Values
  - MAXPARTICLES_DEFAULT_VALUE
```
public static final int MAXPARTICLES_DEFAULT_VALUE
```
    SFInt32 field named maxParticles has default value 200 (Java syntax) or 200 (XML syntax).
    
    See Also:
    
    Constant Field Values
  - PARTICLELIFETIME_DEFAULT_VALUE
```
public static final float PARTICLELIFETIME_DEFAULT_VALUE
```
    SFFloat field named particleLifetime has default value 5f (Java syntax) or 5 (XML syntax).
    
    See Also:
    
    Constant Field Values
  - PARTICLESIZE_DEFAULT_VALUE
```
public static final float[] PARTICLESIZE_DEFAULT_VALUE
```
    SFVec2f field named particleSize has default value {0.02f,0.02f} (Java syntax) or 0.02 0.02 (XML syntax).
  - fromField_APPEARANCE
```
public static final java.lang.String fromField_APPEARANCE
```
    fromField ROUTE name for SFNode field named appearance.
    
    See Also:
    
    Constant Field Values
  - toField_APPEARANCE
```
public static final java.lang.String toField_APPEARANCE
```
    toField ROUTE name for SFNode field named appearance.
    
    See Also:
    
    Constant Field Values
  - fromField_CREATEPARTICLES
```
public static final java.lang.String fromField_CREATEPARTICLES
```
    fromField ROUTE name for SFBool field named createParticles.
    
    See Also:
    
    Constant Field Values
  - toField_CREATEPARTICLES
```
public static final java.lang.String toField_CREATEPARTICLES
```
    toField ROUTE name for SFBool field named createParticles.
    
    See Also:
    
    Constant Field Values
  - fromField_ENABLED
```
public static final java.lang.String fromField_ENABLED
```
    fromField ROUTE name for SFBool field named enabled.
    
    See Also:
    
    Constant Field Values
  - toField_ENABLED
```
public static final java.lang.String toField_ENABLED
```
    toField ROUTE name for SFBool field named enabled.
    
    See Also:
    
    Constant Field Values
  - fromField_GEOMETRY
```
public static final java.lang.String fromField_GEOMETRY
```
    fromField ROUTE name for SFNode field named geometry.
    
    See Also:
    
    Constant Field Values
  - toField_GEOMETRY
```
public static final java.lang.String toField_GEOMETRY
```
    toField ROUTE name for SFNode field named geometry.
    
    See Also:
    
    Constant Field Values
  - fromField_ISACTIVE
```
public static final java.lang.String fromField_ISACTIVE
```
    fromField ROUTE name for SFBool field named isActive.
    
    See Also:
    
    Constant Field Values
  - fromField_LIFETIMEVARIATION
```
public static final java.lang.String fromField_LIFETIMEVARIATION
```
    fromField ROUTE name for SFFloat field named lifetimeVariation.
    
    See Also:
    
    Constant Field Values
  - toField_LIFETIMEVARIATION
```
public static final java.lang.String toField_LIFETIMEVARIATION
```
    toField ROUTE name for SFFloat field named lifetimeVariation.
    
    See Also:
    
    Constant Field Values
  - fromField_MAXPARTICLES
```
public static final java.lang.String fromField_MAXPARTICLES
```
    fromField ROUTE name for SFInt32 field named maxParticles.
    
    See Also:
    
    Constant Field Values
  - toField_MAXPARTICLES
```
public static final java.lang.String toField_MAXPARTICLES
```
    toField ROUTE name for SFInt32 field named maxParticles.
    
    See Also:
    
    Constant Field Values
  - fromField_METADATA
```
public static final java.lang.String fromField_METADATA
```
    fromField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - toField_METADATA
```
public static final java.lang.String toField_METADATA
```
    toField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - fromField_PARTICLELIFETIME
```
public static final java.lang.String fromField_PARTICLELIFETIME
```
    fromField ROUTE name for SFFloat field named particleLifetime.
    
    See Also:
    
    Constant Field Values
  - toField_PARTICLELIFETIME
```
public static final java.lang.String toField_PARTICLELIFETIME
```
    toField ROUTE name for SFFloat field named particleLifetime.
    
    See Also:
    
    Constant Field Values
  - fromField_PARTICLESIZE
```
public static final java.lang.String fromField_PARTICLESIZE
```
    fromField ROUTE name for SFVec2f field named particleSize.
    
    See Also:
    
    Constant Field Values
  - toField_PARTICLESIZE
```
public static final java.lang.String toField_PARTICLESIZE
```
    toField ROUTE name for SFVec2f field named particleSize.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ParticleSystemObject
```
public ParticleSystemObject()
```
    Constructor for ParticleSystemObject to initialize member variables with default values.
  - ParticleSystemObject
```
public ParticleSystemObject(java.lang.String DEFname)
```
    Utility constructor that assigns DEF name after initializing member variables with default values
    
    Parameters:
    
    DEFname - unique DEF name for this X3D node
- Method Detail
  - getElementName
```
public final java.lang.String getElementName()
```
    Provides name of this element: ParticleSystem.
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Provides X3D component for this element: ParticleSystems.
    
    Specified by:
    
    getComponent in class X3DConcreteElement
    
    Returns:
    
    X3D component for this element
  - getComponentLevel
```
public final int getComponentLevel()
```
    Provides default X3D component level for this element: 2.
    
    Specified by:
    
    getComponentLevel in class X3DConcreteElement
    
    Returns:
    
    default X3D component level for this element
  - getFieldType
```
public java.lang.String getFieldType(java.lang.String fieldName)
```
    Indicate type corresponding to given fieldName.
    
    Specified by:
    
    getFieldType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
  - getAccessType
```
public java.lang.String getAccessType(java.lang.String fieldName)
```
    Indicate accessType corresponding to given fieldName.
    
    Specified by:
    
    getAccessType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
  - initialize
```
public final void initialize()
```
    Initialize all member variables to default values.
    
    Overrides:
    
    initialize in class X3DConcreteNode
  - getAppearance
```
public X3DAppearanceNode getAppearance()
```
    Provide X3DAppearanceNode instance (using a properly typed node) from inputOutput SFNode field appearance.
    
    Specified by:
    
    getAppearance in interface ParticleSystem
    
    Specified by:
    
    getAppearance in interface X3DShapeNode
    
    Returns:
    
    value of appearance field
    
    See Also:
    
    Tooltip: [X3DAppearanceNode] The appearance field holds an Appearance node that is used for the geometry. All effects, such as material colours and/or multi-textures, are applied to each particle. Hint: if a texture coordinate ramp and key is supplied with this geometry, it shall be used in preference to any automatic texture coordinate generation. Hint: if automatic texture coordinate generation is used, results shall be based on the entire volume that the particles consume, not locally applied to each particle.
  - setAppearance
```
public ParticleSystemObject setAppearance(X3DAppearanceNode newValue)
```
    Assign X3DAppearanceNode instance (using a properly typed node) to inputOutput SFNode field appearance.
    
    Specified by:
    
    setAppearance in interface ParticleSystem
    
    Specified by:
    
    setAppearance in interface X3DShapeNode
    
    Parameters:
    
    newValue - is new value for the appearance field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    See Also:
    
    Tooltip: [X3DAppearanceNode] The appearance field holds an Appearance node that is used for the geometry. All effects, such as material colours and/or multi-textures, are applied to each particle. Hint: if a texture coordinate ramp and key is supplied with this geometry, it shall be used in preference to any automatic texture coordinate generation. Hint: if automatic texture coordinate generation is used, results shall be based on the entire volume that the particles consume, not locally applied to each particle.
  - clearAppearance
```
public ParticleSystemObject clearAppearance()
```
    Utility method to clear SFNode value of appearance field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setAppearance
```
public ParticleSystemObject setAppearance(ProtoInstanceObject newProtoInstanceNode)
```
    Assign ProtoInstance to appearance field; WARNING: ProtoInstance must match acceptable node type X3DAppearanceNode.
    
    Parameters:
    
    newProtoInstanceNode - is the new ProtoInstance node for the appearance field
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    
    See Also:
    
    setAppearance(X3DAppearanceNode)
  - getAppearanceProtoInstance
```
public ProtoInstanceObject getAppearanceProtoInstance()
```
    Provide properly typed ProtoInstance for inputOutput SFNode field appearance, if available.
    
    Returns:
    
    ProtoInstance value of geometry field
    
    See Also:
    
    getAppearance()
  - hasAppearance
```
public boolean hasAppearance()
```
    Indicate whether an object is available for inputOutput SFNode field appearance.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getAppearance(), getAppearanceProtoInstance()
  - getBboxCenter
```
public float[] getBboxCenter()
```
    Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
    
    Tooltip: Bounding box center: optional hint for position offset from origin of local coordinate system.
    
    Specified by:
    
    getBboxCenter in interface X3DBoundedObject
    
    Specified by:
    
    getBboxCenter in interface ParticleSystem
    
    Specified by:
    
    getBboxCenter in interface X3DShapeNode
    
    Returns:
    
    value of bboxCenter field
  - setBboxCenter
```
public ParticleSystemObject setBboxCenter(float[] newValue)
```
    Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
    
    Tooltip: Bounding box center: optional hint for position offset from origin of local coordinate system.
    
    Specified by:
    
    setBboxCenter in interface X3DBoundedObject
    
    Specified by:
    
    setBboxCenter in interface ParticleSystem
    
    Specified by:
    
    setBboxCenter in interface X3DShapeNode
    
    Parameters:
    
    newValue - is new value for the bboxCenter field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setBboxCenter
```
public ParticleSystemObject setBboxCenter(SFVec3fObject newValue)
```
    Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
    
    Parameters:
    
    newValue - is new value for the bboxCenter field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setBboxCenter
```
public ParticleSystemObject setBboxCenter(float x,
                                          float y,
                                          float z)
```
    Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
    
    Parameters:
    
    x - first component
    
    y - second component
    
    z - third component
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getBboxSize
```
public float[] getBboxSize()
```
    Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
    
    Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint. Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
    
    Specified by:
    
    getBboxSize in interface X3DBoundedObject
    
    Specified by:
    
    getBboxSize in interface ParticleSystem
    
    Specified by:
    
    getBboxSize in interface X3DShapeNode
    
    Returns:
    
    value of bboxSize field
  - setBboxSize
```
public ParticleSystemObject setBboxSize(float[] newValue)
```
    Assign 3-tuple float array within allowed range of [0,infinity), or default value [-1 -1 -1], to initializeOnly SFVec3f field named bboxSize.
    
    Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint. Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
    
    Specified by:
    
    setBboxSize in interface X3DBoundedObject
    
    Specified by:
    
    setBboxSize in interface ParticleSystem
    
    Specified by:
    
    setBboxSize in interface X3DShapeNode
    
    Parameters:
    
    newValue - is new value for the bboxSize field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setBboxSize
```
public ParticleSystemObject setBboxSize(SFVec3fObject newValue)
```
    Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
    
    Parameters:
    
    newValue - is new value for the bboxSize field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setBboxSize
```
public ParticleSystemObject setBboxSize(float x,
                                        float y,
                                        float z)
```
    Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
    
    Parameters:
    
    x - first component
    
    y - second component
    
    z - third component
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getColorKey
```
public float[] getColorKey()
```
    Provide array of Float results using RGB values [0..1] from initializeOnly MFFloat field named colorKey.
    
    Tooltip: [0,+infinity) Array of time intervals in seconds, corresponding to particle lifetime, that are used to interpolate colorRamp array values. Hint: color values are interpolated in linear Hue Saturation Value (HSV) space, similar to ColorInterpolator node. Hint: color values are defined as per-vertex colour values. Warning: if an Appearance and Material nodes are provided, those material properties override colorRamp interpolation. Hint: number of colorKey values must match length of the per-vertex colorRamp arrays! Hint: X3D Scene Authoring Hints, Color http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color.
    
    Specified by:
    
    getColorKey in interface ParticleSystem
    
    Returns:
    
    value of colorKey field
  - getColorKeyList
```
public java.util.ArrayList<java.lang.Float> getColorKeyList()
```
    Utility method to get ArrayList value of MFFloat colorKey field, similar to getColorKey().
    
    Returns:
    
    value of colorKey field
  - setColorKey
```
public ParticleSystemObject setColorKey(float[] newValue)
```
    Assign Float array using RGB values [0..1] to initializeOnly MFFloat field named colorKey.
    
    Tooltip: [0,+infinity) Array of time intervals in seconds, corresponding to particle lifetime, that are used to interpolate colorRamp array values. Hint: color values are interpolated in linear Hue Saturation Value (HSV) space, similar to ColorInterpolator node. Hint: color values are defined as per-vertex colour values. Warning: if an Appearance and Material nodes are provided, those material properties override colorRamp interpolation. Hint: number of colorKey values must match length of the per-vertex colorRamp arrays! Hint: X3D Scene Authoring Hints, Color http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color.
    
    Specified by:
    
    setColorKey in interface ParticleSystem
    
    Parameters:
    
    newValue - is new value for the colorKey field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setColorKey
```
public ParticleSystemObject setColorKey(MFFloatObject newValue)
```
    Assign typed object value to MFFloat colorKey field, similar to setColorKey(float[]).
    
    Parameters:
    
    newValue - is new value for the colorKey field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setColorKey
```
public ParticleSystemObject setColorKey(java.util.ArrayList<java.lang.Float> newValue)
```
    Assign ArrayList value of MFFloat colorKey field, similar to setColorKey(float[]).
    
    Parameters:
    
    newValue - is new value for the colorKey field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - clearColorKey
```
public ParticleSystemObject clearColorKey()
```
    Utility method to clear MFFloat value of colorKey field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setColorKey
```
public ParticleSystemObject setColorKey(int[] newValue)
```
    Assign floating-point array value of MFFloat colorKey field, similar to setColorKey(float[]).
    
    Parameters:
    
    newValue - is new value for the colorKey field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getColorRamp
```
public X3DColorNode getColorRamp()
```
    Provide X3DColorNode instance (using a properly typed node) using RGB values [0..1] from initializeOnly SFNode field colorRamp.
    
    Specified by:
    
    getColorRamp in interface ParticleSystem
    
    Returns:
    
    value of colorRamp field
    
    See Also:
    
    Tooltip: [X3DColorNode] The colorRamp Color/ColorRGBA node holds a series of colour values to be used at the given colorKey points in time. Hint: color values are defined as per-vertex colour values. Warning: if an Appearance and Material nodes are provided, those material properties override colorRamp interpolation. Hint: number of colorKey values must match length of the per-vertex colorRamp arrays! Hint: X3D Scene Authoring Hints, Color http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color.
  - setColorRamp
```
public ParticleSystemObject setColorRamp(X3DColorNode newValue)
```
    Assign X3DColorNode instance (using a properly typed node) using RGB values [0..1] to initializeOnly SFNode field colorRamp.
    
    Specified by:
    
    setColorRamp in interface ParticleSystem
    
    Parameters:
    
    newValue - is new value for the colorRamp field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    See Also:
    
    Tooltip: [X3DColorNode] The colorRamp Color/ColorRGBA node holds a series of colour values to be used at the given colorKey points in time. Hint: color values are defined as per-vertex colour values. Warning: if an Appearance and Material nodes are provided, those material properties override colorRamp interpolation. Hint: number of colorKey values must match length of the per-vertex colorRamp arrays! Hint: X3D Scene Authoring Hints, Color http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color.
  - clearColorRamp
```
public ParticleSystemObject clearColorRamp()
```
    Utility method to clear SFNode value of colorRamp field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setColorRamp
```
public ParticleSystemObject setColorRamp(ProtoInstanceObject newProtoInstanceNode)
```
    Assign ProtoInstance to colorRamp field; WARNING: ProtoInstance must match acceptable node type X3DColorNode.
    
    Parameters:
    
    newProtoInstanceNode - is the new ProtoInstance node for the colorRamp field
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    
    See Also:
    
    setColorRamp(X3DColorNode)
  - getColorRampProtoInstance
```
public ProtoInstanceObject getColorRampProtoInstance()
```
    Provide properly typed ProtoInstance for initializeOnly SFNode field colorRamp, if available.
    
    Returns:
    
    ProtoInstance value of geometry field
    
    See Also:
    
    getColorRamp()
  - hasColorRamp
```
public boolean hasColorRamp()
```
    Indicate whether an object is available for initializeOnly SFNode field colorRamp.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getColorRamp(), getColorRampProtoInstance()
  - getCreateParticles
```
public boolean getCreateParticles()
```
    Provide boolean value from inputOutput SFBool field named createParticles.
    
    Tooltip: Enables/disables creation of new particles, while any existing particles remain in existence and continue to animate until the end of their lifetimes. Hint: if no particles are left in scene, system is considered both active and enabled.
    
    Specified by:
    
    getCreateParticles in interface ParticleSystem
    
    Returns:
    
    value of createParticles field
  - setCreateParticles
```
public ParticleSystemObject setCreateParticles(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named createParticles.
    
    Tooltip: Enables/disables creation of new particles, while any existing particles remain in existence and continue to animate until the end of their lifetimes. Hint: if no particles are left in scene, system is considered both active and enabled.
    
    Specified by:
    
    setCreateParticles in interface ParticleSystem
    
    Parameters:
    
    newValue - is new value for the createParticles field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setCreateParticles
```
public ParticleSystemObject setCreateParticles(SFBoolObject newValue)
```
    Assign typed object value to SFBool createParticles field, similar to setCreateParticles(boolean).
    
    Parameters:
    
    newValue - is new value for the createParticles field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getEmitter
```
public X3DParticleEmitterNode getEmitter()
```
    Provide X3DParticleEmitterNode instance (using a properly typed node) from initializeOnly SFNode field emitter.
    
    Specified by:
    
    getEmitter in interface ParticleSystem
    
    Returns:
    
    value of emitter field
    
    See Also:
    
    Tooltip: [X3DParticleEmitterNode] The emitter field specifies the type of emitter geometry and properties that the particles are given for their initial positions.
  - setEmitter
```
public ParticleSystemObject setEmitter(X3DParticleEmitterNode newValue)
```
    Assign X3DParticleEmitterNode instance (using a properly typed node) to initializeOnly SFNode field emitter.
    
    Specified by:
    
    setEmitter in interface ParticleSystem
    
    Parameters:
    
    newValue - is new value for the emitter field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    See Also:
    
    Tooltip: [X3DParticleEmitterNode] The emitter field specifies the type of emitter geometry and properties that the particles are given for their initial positions.
  - clearEmitter
```
public ParticleSystemObject clearEmitter()
```
    Utility method to clear SFNode value of emitter field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setEmitter
```
public ParticleSystemObject setEmitter(ProtoInstanceObject newProtoInstanceNode)
```
    Assign ProtoInstance to emitter field; WARNING: ProtoInstance must match acceptable node type X3DParticleEmitterNode.
    
    Parameters:
    
    newProtoInstanceNode - is the new ProtoInstance node for the emitter field
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    
    See Also:
    
    setEmitter(X3DParticleEmitterNode)
  - getEmitterProtoInstance
```
public ProtoInstanceObject getEmitterProtoInstance()
```
    Provide properly typed ProtoInstance for initializeOnly SFNode field emitter, if available.
    
    Returns:
    
    ProtoInstance value of geometry field
    
    See Also:
    
    getEmitter()
  - hasEmitter
```
public boolean hasEmitter()
```
    Indicate whether an object is available for initializeOnly SFNode field emitter.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getEmitter(), getEmitterProtoInstance()
  - getEnabled
```
public boolean getEnabled()
```
    Provide boolean value from inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation.
    
    Specified by:
    
    getEnabled in interface ParticleSystem
    
    Returns:
    
    value of enabled field
  - setEnabled
```
public ParticleSystemObject setEnabled(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation.
    
    Specified by:
    
    setEnabled in interface ParticleSystem
    
    Parameters:
    
    newValue - is new value for the enabled field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setEnabled
```
public ParticleSystemObject setEnabled(SFBoolObject newValue)
```
    Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
    
    Parameters:
    
    newValue - is new value for the enabled field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getGeometry
```
public X3DGeometryNode getGeometry()
```
    Provide X3DGeometryNode instance (using a properly typed node) from inputOutput SFNode field geometry.
    
    Specified by:
    
    getGeometry in interface ParticleSystem
    
    Specified by:
    
    getGeometry in interface X3DShapeNode
    
    Returns:
    
    value of geometry field
    
    See Also:
    
    Tooltip: [X3DGeometryNode] The geometry node provides geometry used for each particle when geometryType=GEOMETRY. Hint: include <component name='Geospatial' level='1'/>.
  - setGeometry
```
public ParticleSystemObject setGeometry(X3DGeometryNode newValue)
```
    Assign X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field geometry.
    
    Specified by:
    
    setGeometry in interface ParticleSystem
    
    Specified by:
    
    setGeometry in interface X3DShapeNode
    
    Parameters:
    
    newValue - is new value for the geometry field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    See Also:
    
    Tooltip: [X3DGeometryNode] The geometry node provides geometry used for each particle when geometryType=GEOMETRY. Hint: include <component name='Geospatial' level='1'/>.
  - clearGeometry
```
public ParticleSystemObject clearGeometry()
```
    Utility method to clear SFNode value of geometry field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setGeometry
```
public ParticleSystemObject setGeometry(ProtoInstanceObject newProtoInstanceNode)
```
    Assign ProtoInstance to geometry field; WARNING: ProtoInstance must match acceptable node type X3DGeometryNode.
    
    Parameters:
    
    newProtoInstanceNode - is the new ProtoInstance node for the geometry field
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    
    See Also:
    
    setGeometry(X3DGeometryNode)
  - getGeometryProtoInstance
```
public ProtoInstanceObject getGeometryProtoInstance()
```
    Provide properly typed ProtoInstance for inputOutput SFNode field geometry, if available.
    
    Returns:
    
    ProtoInstance value of geometry field
    
    See Also:
    
    getGeometry()
  - hasGeometry
```
public boolean hasGeometry()
```
    Indicate whether an object is available for inputOutput SFNode field geometry.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getGeometry(), getGeometryProtoInstance()
  - getGeometryType
```
public java.lang.String getGeometryType()
```
    Provide String enumeration value ['LINE'|'POINT'|'QUAD'|'SPRITE'|'TRIANGLE'|'GEOMETRY'] from initializeOnly SFString field named geometryType.
    
    Available enumeration values for string comparison: LINE, POINT, QUAD, SPRITE, TRIANGLE, GEOMETRY.
    
    Specified by:
    
    getGeometryType in interface ParticleSystem
    
    Returns:
    
    value of geometryType field
  - setGeometryType
```
public ParticleSystemObject setGeometryType(java.lang.String newValue)
```
    Assign String enumeration value ("LINE"|"POINT"|"QUAD"|"SPRITE"|"TRIANGLE"|"GEOMETRY") ['LINE'|'POINT'|'QUAD'|'SPRITE'|'TRIANGLE'|'GEOMETRY'] to initializeOnly SFString field named geometryType.
    
    WARNING: authors can only choose from a strict list of enumeration values (LINE, POINT, QUAD, SPRITE, TRIANGLE, GEOMETRY).
    
    Specified by:
    
    setGeometryType in interface ParticleSystem
    
    Parameters:
    
    newValue - is new value for the geometryType field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setGeometryType
```
public ParticleSystemObject setGeometryType(SFStringObject newValue)
```
    Assign typed object value to SFString geometryType field, similar to setGeometryType(String).
    
    Parameters:
    
    newValue - is new value for the geometryType field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getIsActive
```
public boolean getIsActive()
```
    Provide boolean value from outputOnly SFBool field named isActive.
    
    Tooltip: isActive true/false events are sent when playback starts/stops.
    
    Specified by:
    
    getIsActive in interface ParticleSystem
    
    Returns:
    
    value of isActive field
  - getLifetimeVariation
```
public float getLifetimeVariation()
```
    Provide float value within allowed range of [0,1] from inputOutput SFFloat field named lifetimeVariation.
    
    Tooltip: [0,1) TODO not properly defined in X3D spedification. Multiplier for the randomness used to control the range of possible output values. The bigger the value, the more random the output and the bigger the range of initial values possible. Hint: variation of zero does not allow any randomness.
    
    Specified by:
    
    getLifetimeVariation in interface ParticleSystem
    
    Returns:
    
    value of lifetimeVariation field
  - setLifetimeVariation
```
public ParticleSystemObject setLifetimeVariation(float newValue)
```
    Assign float value within allowed range of [0,1] to inputOutput SFFloat field named lifetimeVariation.
    
    Tooltip: [0,1) TODO not properly defined in X3D spedification. Multiplier for the randomness used to control the range of possible output values. The bigger the value, the more random the output and the bigger the range of initial values possible. Hint: variation of zero does not allow any randomness.
    
    Specified by:
    
    setLifetimeVariation in interface ParticleSystem
    
    Parameters:
    
    newValue - is new value for the lifetimeVariation field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setLifetimeVariation
```
public ParticleSystemObject setLifetimeVariation(SFFloatObject newValue)
```
    Assign typed object value to SFFloat lifetimeVariation field, similar to setLifetimeVariation(float).
    
    Parameters:
    
    newValue - is new value for the lifetimeVariation field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getMaxParticles
```
public int getMaxParticles()
```
    Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named maxParticles.
    
    Tooltip: [0,infinity] Maximum number of particles to be generated at one time (subject to player limitations).
    
    Specified by:
    
    getMaxParticles in interface ParticleSystem
    
    Returns:
    
    value of maxParticles field
  - setMaxParticles
```
public ParticleSystemObject setMaxParticles(int newValue)
```
    Assign int value within allowed range of [0,infinity) to inputOutput SFInt32 field named maxParticles.
    
    Tooltip: [0,infinity] Maximum number of particles to be generated at one time (subject to player limitations).
    
    Specified by:
    
    setMaxParticles in interface ParticleSystem
    
    Parameters:
    
    newValue - is new value for the maxParticles field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setMaxParticles
```
public ParticleSystemObject setMaxParticles(SFInt32Object newValue)
```
    Assign typed object value to SFInt32 maxParticles field, similar to setMaxParticles(int).
    
    Parameters:
    
    newValue - is new value for the maxParticles field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getMetadata
```
public X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface ParticleSystem
    
    Specified by:
    
    getMetadata in interface X3DShapeNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
public ParticleSystemObject setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface ParticleSystem
    
    Specified by:
    
    setMetadata in interface X3DShapeNode
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    See Also:
    
    setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
  - clearMetadata
```
public ParticleSystemObject clearMetadata()
```
    Utility method to clear SFNode value of metadata field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setMetadata
```
public ParticleSystemObject setMetadata(ProtoInstanceObject newProtoInstanceNode)
```
    Assign ProtoInstance to metadata field; WARNING: ProtoInstance must match acceptable node type X3DMetadataObject.
    
    Parameters:
    
    newProtoInstanceNode - is the new ProtoInstance node for the metadata field
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    
    See Also:
    
    setMetadata(X3DMetadataObject), X3D Scene Authoring Hints: Metadata Nodes
  - getMetadataProtoInstance
```
public ProtoInstanceObject getMetadataProtoInstance()
```
    Provide properly typed ProtoInstance for inputOutput SFNode field metadata, if available.
    
    Returns:
    
    ProtoInstance value of geometry field
    
    See Also:
    
    getMetadata(), X3D Scene Authoring Hints: Metadata Nodes
  - hasMetadata
```
public boolean hasMetadata()
```
    Indicate whether an object is available for inputOutput SFNode field metadata.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - getParticleLifetime
```
public float getParticleLifetime()
```
    Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named particleLifetime.
    
    Tooltip: [0,+infinity) TODO not properly defined in X3D spedification. Particle animation lifetime in base time units (default is seconds).
    
    Specified by:
    
    getParticleLifetime in interface ParticleSystem
    
    Returns:
    
    value of particleLifetime field
  - setParticleLifetime
```
public ParticleSystemObject setParticleLifetime(float newValue)
```
    Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named particleLifetime.
    
    Tooltip: [0,+infinity) TODO not properly defined in X3D spedification. Particle animation lifetime in base time units (default is seconds).
    
    Specified by:
    
    setParticleLifetime in interface ParticleSystem
    
    Parameters:
    
    newValue - is new value for the particleLifetime field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setParticleLifetime
```
public ParticleSystemObject setParticleLifetime(SFFloatObject newValue)
```
    Assign typed object value to SFFloat particleLifetime field, similar to setParticleLifetime(float).
    
    Parameters:
    
    newValue - is new value for the particleLifetime field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getParticleSize
```
public float[] getParticleSize()
```
    Provide array of 2-tuple float results within allowed range of [0,infinity) from inputOutput SFVec2f field named particleSize.
    
    Tooltip: [0,+infinity) particleSize describes width and height dimensions for each particle in length base units (default is meters). Changing this value dynamically will only change new particles created after the change. Hint: particles created before this timestamp will remain at the old size. Hint: his field only effects particles using LINE, QUAD, SPRITE, and TRIANGLE geometry types.
    
    Specified by:
    
    getParticleSize in interface ParticleSystem
    
    Returns:
    
    value of particleSize field
  - setParticleSize
```
public ParticleSystemObject setParticleSize(float[] newValue)
```
    Assign 2-tuple float array within allowed range of [0,infinity) to inputOutput SFVec2f field named particleSize.
    
    Tooltip: [0,+infinity) particleSize describes width and height dimensions for each particle in length base units (default is meters). Changing this value dynamically will only change new particles created after the change. Hint: particles created before this timestamp will remain at the old size. Hint: his field only effects particles using LINE, QUAD, SPRITE, and TRIANGLE geometry types.
    
    Specified by:
    
    setParticleSize in interface ParticleSystem
    
    Parameters:
    
    newValue - is new value for the particleSize field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setParticleSize
```
public ParticleSystemObject setParticleSize(SFVec2fObject newValue)
```
    Assign typed object value to SFVec2f particleSize field, similar to setParticleSize(float[]).
    
    Parameters:
    
    newValue - is new value for the particleSize field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setParticleSize
```
public ParticleSystemObject setParticleSize(float x,
                                            float y)
```
    Assign values to SFVec2f particleSize field, similar to setParticleSize(float[]).
    
    Parameters:
    
    x - first component
    
    y - second component
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getPhysics
```
public X3DNode[] getPhysics()
```
    Provide array of X3DParticlePhysicsModelNode results (using an array consisting of properly typed nodes or X3DPrototypeInstance objects) from initializeOnly MFNode field physics.
    
    Tooltip: [X3DParticlePhysicsModelNode] After being created, the individual particles are then manipulated according to the physics model(s) specified in the physics field.
    
    WARNING: according to Object Model for X3D (OMX3D), acceptable node types are limited to X3DParticlePhysicsModelNode.
    
    Specified by:
    
    getPhysics in interface ParticleSystem
    
    Returns:
    
    value of physics field
  - getPhysicsList
```
public java.util.ArrayList<X3DParticlePhysicsModelNode> getPhysicsList()
```
    Utility method to get ArrayList value of MFNode physics field, similar to getPhysics().
    
    Returns:
    
    value of physics field
  - setPhysics
```
public ParticleSystemObject setPhysics(X3DNode[] newValue)
```
    Assign X3DParticlePhysicsModelNode array (using an array consisting of properly typed nodes or X3DPrototypeInstance objects) to initializeOnly MFNode field physics.
    
    Tooltip: [X3DParticlePhysicsModelNode] After being created, the individual particles are then manipulated according to the physics model(s) specified in the physics field.
    
    Note: according to Object Model for X3D (OMX3D), acceptable node types are limited to X3DParticlePhysicsModelNode.
    
    Specified by:
    
    setPhysics in interface ParticleSystem
    
    Parameters:
    
    newValue - is new value for the physics field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setPhysics
```
public ParticleSystemObject setPhysics(java.util.ArrayList<X3DParticlePhysicsModelNode> newValue)
```
    Assign ArrayList value of MFNode physics field, similar to setPhysics(X3DNode[]).
    
    Parameters:
    
    newValue - is new value for the physics field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - addPhysics
```
public ParticleSystemObject addPhysics(X3DParticlePhysicsModelNode newValue)
```
    Add single child physics node to array of existing nodes (if any).
    
    Note: according to Object Model for X3D (OMX3D), acceptable node types are limited to X3DParticlePhysicsModelNode.
    
    Parameters:
    
    newValue - is new value to be appended the physics field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - addPhysics
```
public void addPhysics(X3DNode[] newValue)
```
    Add array of child physics nodes to array of existing nodes (if any).
    
    Note: according to Object Model for X3D (OMX3D), acceptable node types are limited to X3DParticlePhysicsModelNode.
    
    Specified by:
    
    addPhysics in interface ParticleSystem
    
    Parameters:
    
    newValue - is new value array to be appended the physics field.
  - setPhysics
```
public void setPhysics(X3DNode newValue)
```
    Set single child physics node, replacing prior array of existing nodes (if any).
    
    Note: according to Object Model for X3D (OMX3D), acceptable node types are limited to X3DParticlePhysicsModelNode.
    
    Specified by:
    
    setPhysics in interface ParticleSystem
    
    Parameters:
    
    newValue - is new node for the physics field.
  - clearPhysics
```
public ParticleSystemObject clearPhysics()
```
    Utility method to clear MFNode value of physics field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - hasPhysics
```
public boolean hasPhysics()
```
    Indicate whether an object is available for initializeOnly MFNode field physics.
    
    Returns:
    
    whether a properly typed node or ProtoInstance array or CommentsBlock is available.
    
    See Also:
    
    getPhysics()
  - getTexCoordKey
```
public float[] getTexCoordKey()
```
    Provide array of Float results within allowed range of [0,infinity) from initializeOnly MFFloat field named texCoordKey.
    
    Tooltip: [0,+infinity) Array of time intervals in seconds, corresponding to particle lifetime, that are used to sequence texCoordRamp array values. Hint: no interpolation is performed, texture coordinates are simply sequenced in order. Hint: texture-coordinate values map textures to vertices in the geometry. Hint: number of texCoordKey values must match length of the per-vertex texCoordRamp arrays!.
    
    Specified by:
    
    getTexCoordKey in interface ParticleSystem
    
    Returns:
    
    value of texCoordKey field
  - getTexCoordKeyList
```
public java.util.ArrayList<java.lang.Float> getTexCoordKeyList()
```
    Utility method to get ArrayList value of MFFloat texCoordKey field, similar to getTexCoordKey().
    
    Returns:
    
    value of texCoordKey field
  - setTexCoordKey
```
public ParticleSystemObject setTexCoordKey(float[] newValue)
```
    Assign Float array within allowed range of [0,infinity) to initializeOnly MFFloat field named texCoordKey.
    
    Tooltip: [0,+infinity) Array of time intervals in seconds, corresponding to particle lifetime, that are used to sequence texCoordRamp array values. Hint: no interpolation is performed, texture coordinates are simply sequenced in order. Hint: texture-coordinate values map textures to vertices in the geometry. Hint: number of texCoordKey values must match length of the per-vertex texCoordRamp arrays!.
    
    Specified by:
    
    setTexCoordKey in interface ParticleSystem
    
    Parameters:
    
    newValue - is new value for the texCoordKey field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setTexCoordKey
```
public ParticleSystemObject setTexCoordKey(MFFloatObject newValue)
```
    Assign typed object value to MFFloat texCoordKey field, similar to setTexCoordKey(float[]).
    
    Parameters:
    
    newValue - is new value for the texCoordKey field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setTexCoordKey
```
public ParticleSystemObject setTexCoordKey(java.util.ArrayList<java.lang.Float> newValue)
```
    Assign ArrayList value of MFFloat texCoordKey field, similar to setTexCoordKey(float[]).
    
    Parameters:
    
    newValue - is new value for the texCoordKey field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - clearTexCoordKey
```
public ParticleSystemObject clearTexCoordKey()
```
    Utility method to clear MFFloat value of texCoordKey field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setTexCoordKey
```
public ParticleSystemObject setTexCoordKey(int[] newValue)
```
    Assign floating-point array value of MFFloat texCoordKey field, similar to setTexCoordKey(float[]).
    
    Parameters:
    
    newValue - is new value for the texCoordKey field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getTexCoordRamp
```
public TextureCoordinate getTexCoordRamp()
```
    Provide TextureCoordinate instance (using a properly typed node) from initializeOnly SFNode field texCoordRamp.
    
    Specified by:
    
    getTexCoordRamp in interface ParticleSystem
    
    Returns:
    
    value of texCoordRamp field
    
    See Also:
    
    Tooltip: [TextureCoordinate] texture coordinates of the provided texture(s) in the Appearance node, over time. Particle systems frequently like to change the texture on a particle as it ages, yet there is no good way of accomplishing this through standard interpolators because interpolators have no concept of particle time. This pair of fields hold time-dependent values for the texture coordinates to be applied to the particle. When a particle reaches the next time stamp it moves to the next set of texture coordinates. Hint: texture-coordinate values map textures to vertices in the geometry. Hint: number of texCoordKey values must match length of the per-vertex texCoordRamp arrays!.
  - setTexCoordRamp
```
public ParticleSystemObject setTexCoordRamp(TextureCoordinate newValue)
```
    Assign TextureCoordinate instance (using a properly typed node) to initializeOnly SFNode field texCoordRamp.
    
    Specified by:
    
    setTexCoordRamp in interface ParticleSystem
    
    Parameters:
    
    newValue - is new value for the texCoordRamp field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    See Also:
    
    Tooltip: [TextureCoordinate] texture coordinates of the provided texture(s) in the Appearance node, over time. Particle systems frequently like to change the texture on a particle as it ages, yet there is no good way of accomplishing this through standard interpolators because interpolators have no concept of particle time. This pair of fields hold time-dependent values for the texture coordinates to be applied to the particle. When a particle reaches the next time stamp it moves to the next set of texture coordinates. Hint: texture-coordinate values map textures to vertices in the geometry. Hint: number of texCoordKey values must match length of the per-vertex texCoordRamp arrays!.
  - clearTexCoordRamp
```
public ParticleSystemObject clearTexCoordRamp()
```
    Utility method to clear SFNode value of texCoordRamp field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setTexCoordRamp
```
public ParticleSystemObject setTexCoordRamp(ProtoInstanceObject newProtoInstanceNode)
```
    Assign ProtoInstance to texCoordRamp field; WARNING: ProtoInstance must match acceptable node type TextureCoordinate.
    
    Parameters:
    
    newProtoInstanceNode - is the new ProtoInstance node for the texCoordRamp field
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    
    See Also:
    
    setTexCoordRamp(TextureCoordinate)
  - getTexCoordRampProtoInstance
```
public ProtoInstanceObject getTexCoordRampProtoInstance()
```
    Provide properly typed ProtoInstance for initializeOnly SFNode field texCoordRamp, if available.
    
    Returns:
    
    ProtoInstance value of geometry field
    
    See Also:
    
    getTexCoordRamp()
  - hasTexCoordRamp
```
public boolean hasTexCoordRamp()
```
    Indicate whether an object is available for initializeOnly SFNode field texCoordRamp.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getTexCoordRamp(), getTexCoordRampProtoInstance()
  - setDEF
```
public final ParticleSystemObject setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions.
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface ParticleSystem
    
    Specified by:
    
    setDEF in interface X3DShapeNode
    
    Specified by:
    
    setDEF in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setDEF
```
public ParticleSystemObject setDEF(SFStringObject newValue)
```
    Assign typed object value to SFString DEF field, similar to setDEF(String).
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setUSE
```
public final ParticleSystemObject setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    WARNING: invoking the setUSE() method resets all other fields to their default values and also releases all child nodes.
    
    WARNING: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface ParticleSystem
    
    Specified by:
    
    setUSE in interface X3DShapeNode
    
    Specified by:
    
    setUSE in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setUSE
```
public ParticleSystemObject setUSE(SFStringObject newValue)
```
    Assign typed object value to SFString USE field, similar to setUSE(String).
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setCssClass
```
public final ParticleSystemObject setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS.
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface ParticleSystem
    
    Specified by:
    
    setCssClass in interface X3DShapeNode
    
    Specified by:
    
    setCssClass in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    See Also:
    
    W3C Cascading Style Sheets
  - setCssClass
```
public ParticleSystemObject setCssClass(SFStringObject newValue)
```
    Assign typed object value to SFString cssClass field, similar to setCssClass(String).
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setIS
```
public ParticleSystemObject setIS(ISObject newValue)
```
    Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    setIS in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the description field.
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - getIS
```
public ISObject getIS()
```
    Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    getIS in class X3DConcreteNode
    
    Returns:
    
    current ISObject, if any.
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - setUSE
```
public ParticleSystemObject setUSE(ParticleSystemObject DEFnode)
```
    Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
    
    WARNING: note that the setUSE() method resets all other fields to their default values and also releases all child nodes.
    
    WARNING. no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Parameters:
    
    DEFnode - must have a DEF value defined
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - addComments
```
public ParticleSystemObject addComments(java.lang.String newComment)
```
    Add comment as String to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public ParticleSystemObject addComments(java.lang.String[] newComments)
```
    Add comments as String[] array to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComments - array of comments
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public ParticleSystemObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - toStringX3D
```
public java.lang.String toStringX3D(int level)
```
    Recursive method to provide X3D string serialization of this model subgraph.
    
    Specified by:
    
    toStringX3D in class X3DConcreteElement
    
    Parameters:
    
    level - number of levels of indentation for this element
    
    Returns:
    
    X3D string
  - toStringClassicVRML
```
public java.lang.String toStringClassicVRML(int level)
```
    Recursive method to provide ClassicVRML string serialization.
    
    Specified by:
    
    toStringClassicVRML in class X3DConcreteElement
    
    Parameters:
    
    level - number of levels of indentation for this element
    
    Returns:
    
    ClassicVRML string
    
    See Also:
    
    X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
  - toStringVRML97
```
public java.lang.String toStringVRML97(int level)
```
    Recursive method to provide VRML97 string serialization.
    
    Specified by:
    
    toStringVRML97 in class X3DConcreteElement
    
    Parameters:
    
    level - number of levels of indentation for this element
    
    Returns:
    
    VRML97 string
    
    See Also:
    
    X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
  - getNodeByDEF
```
public X3DConcreteNode getNodeByDEF(java.lang.String DEFname)
```
    Recursive method to provide object reference to node by DEF name, if found as this node or in a contained node.
    
    Specified by:
    
    getNodeByDEF in class X3DConcreteNode
    
    Parameters:
    
    DEFname - DEF name of node to find
    
    Returns:
    
    object reference to node
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, HAnim nodes.
    
    WARNING: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String)
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.String elementName)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, HAnim nodes.
    
    WARNING: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String)
  - hasElementByNameValue
```
public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.String elementName)
```
    Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findElementByNameValue(String, String)
  - findNodeByDEF
```
public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
    
    WARNING: more than one element may be found that has the same DEF, this method does not handle that case.
    
    Specified by:
    
    findNodeByDEF in class X3DConcreteElement
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found node, null otherwise
    
    See Also:
    
    findElementByNameValue(String)
  - hasNodeByDEF
```
public boolean hasNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findNodeByDEF(String)
  - validate
```
public java.lang.String validate()
```
    Recursive method to validate this element plus all contained nodes and statements.
    
    Specified by:
    
    validate in class X3DConcreteElement
    
    Returns:
    
    validation results (if any)

Class ParticleSystemObject

Field Summary

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Constructor Summary

Method Summary

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Methods inherited from class java.lang.Object

Field Detail

GEOMETRYTYPE_LINE

GEOMETRYTYPE_POINT

GEOMETRYTYPE_QUAD

GEOMETRYTYPE_SPRITE

GEOMETRYTYPE_TRIANGLE

GEOMETRYTYPE_GEOMETRY

NAME

COMPONENT

LEVEL

BBOXCENTER_DEFAULT_VALUE

BBOXSIZE_DEFAULT_VALUE

CREATEPARTICLES_DEFAULT_VALUE

ENABLED_DEFAULT_VALUE

GEOMETRYTYPE_DEFAULT_VALUE

LIFETIMEVARIATION_DEFAULT_VALUE

MAXPARTICLES_DEFAULT_VALUE

PARTICLELIFETIME_DEFAULT_VALUE

PARTICLESIZE_DEFAULT_VALUE

fromField_APPEARANCE

toField_APPEARANCE

fromField_CREATEPARTICLES

toField_CREATEPARTICLES

fromField_ENABLED

toField_ENABLED

fromField_GEOMETRY

toField_GEOMETRY

fromField_ISACTIVE

fromField_LIFETIMEVARIATION

toField_LIFETIMEVARIATION

fromField_MAXPARTICLES

toField_MAXPARTICLES

fromField_METADATA

toField_METADATA

fromField_PARTICLELIFETIME

toField_PARTICLELIFETIME

fromField_PARTICLESIZE

toField_PARTICLESIZE

Constructor Detail

ParticleSystemObject

ParticleSystemObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

initialize

getAppearance

setAppearance

clearAppearance

setAppearance

getAppearanceProtoInstance

hasAppearance

getBboxCenter

setBboxCenter

setBboxCenter

setBboxCenter

getBboxSize

setBboxSize

setBboxSize

setBboxSize

getColorKey

getColorKeyList

setColorKey

setColorKey

setColorKey

clearColorKey

setColorKey

getColorRamp

setColorRamp