Class ParticleSystem

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.ParticleSystems.ParticleSystem

All Implemented Interfaces:

X3DChildNode, X3DNode, X3DBoundedObject, ParticleSystem, X3DShapeNode

public class ParticleSystem
extends X3DConcreteNode
implements ParticleSystem

ParticleSystem specifies a complete particle system.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. ParticleSystem node tooltip: (X3D version 3.2 or later) [X3DShapeNode] ParticleSystem specifies a complete particle system. It can contain Appearance for particle appearance, a geometry node if gemoetryType='GEOMETRY', a color field with Color|ColorRGBA node for changing base color over each particle's lifetime, a texcoord 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 X3D Specification 4.4.8.3 Execution model https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#ExecutionModelHint: Wikipedia, particle system https://en.wikipedia.org/wiki/Particle_system

Note that SFColor 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 separate code using only 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	Description
static final X3DAppearanceNode	APPEARANCE_DEFAULT_VALUE	SFNode field named appearance has default value null (Java syntax) or NULL (XML syntax).
static final float[]	BBOXCENTER_DEFAULT_VALUE	SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
static final boolean	BBOXDISPLAY_DEFAULT_VALUE	SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).
static final float[]	BBOXSIZE_DEFAULT_VALUE	SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
static final boolean	CASTSHADOW_DEFAULT_VALUE	SFBool field named castShadow has default value true (Java syntax) or true (XML syntax).
static final X3DColorNode	COLOR_DEFAULT_VALUE	SFNode field named color has default value null (Java syntax) or NULL (XML syntax).
static final ArrayList<Float>	COLORKEY_DEFAULT_VALUE	MFFloat field named colorKey has default value equal to an empty list.
static final String	COMPONENT	String constant COMPONENT defines X3D component for the ParticleSystem element: ParticleSystems
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final boolean	CREATEPARTICLES_DEFAULT_VALUE	SFBool field named createParticles has default value true (Java syntax) or true (XML syntax).
static final X3DParticleEmitterNode	EMITTER_DEFAULT_VALUE	SFNode field named emitter has default value null (Java syntax) or NULL (XML syntax).
static final boolean	ENABLED_DEFAULT_VALUE	SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
static final String	fromField_APPEARANCE	fromField ROUTE name for SFNode field named appearance.
static final String	fromField_BBOXDISPLAY	fromField ROUTE name for SFBool field named bboxDisplay.
static final String	fromField_CASTSHADOW	fromField ROUTE name for SFBool field named castShadow.
static final String	fromField_CREATEPARTICLES	fromField ROUTE name for SFBool field named createParticles.
static final String	fromField_ENABLED	fromField ROUTE name for SFBool field named enabled.
static final String	fromField_GEOMETRY	fromField ROUTE name for SFNode field named geometry.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_ISACTIVE	fromField ROUTE name for SFBool field named isActive.
static final String	fromField_LIFETIMEVARIATION	fromField ROUTE name for SFFloat field named lifetimeVariation.
static final String	fromField_MAXPARTICLES	fromField ROUTE name for SFInt32 field named maxParticles.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_PARTICLELIFETIME	fromField ROUTE name for SFFloat field named particleLifetime.
static final String	fromField_PARTICLESIZE	fromField ROUTE name for SFVec2f field named particleSize.
static final String	fromField_VISIBLE	fromField ROUTE name for SFBool field named visible.
static final X3DGeometryNode	GEOMETRY_DEFAULT_VALUE	SFNode field named geometry has default value null (Java syntax) or NULL (XML syntax).
static final String	GEOMETRYTYPE_DEFAULT_VALUE	SFString field named geometryType has default value "QUAD" (Java syntax) or QUAD (XML syntax).
static final String	GEOMETRYTYPE_GEOMETRY	Tooltip: geometry field is used for rendering each particle.
static final String	GEOMETRYTYPE_LINE	Tooltip: line is drawn along current velocity vector of particle.
static final String	GEOMETRYTYPE_POINT	Tooltip: point geometry is rendered at particle position.
static final String	GEOMETRYTYPE_QUAD	Tooltip: quad geometry is rendered at particle position facing direction traveled.
static final String	GEOMETRYTYPE_SPRITE	Tooltip: quad geometry is rendered at particle position facing screen.
static final String	GEOMETRYTYPE_TRIANGLE	Tooltip: pair of triangles creating quad geometry is rendered at particle position facing direction traveled.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D ParticleSystems component level for this element: 2
static final float	LIFETIMEVARIATION_DEFAULT_VALUE	SFFloat field named lifetimeVariation has default value 0.25f (Java syntax) or 0.25 (XML syntax).
static final int	MAXPARTICLES_DEFAULT_VALUE	SFInt32 field named maxParticles has default value 200 (Java syntax) or 200 (XML syntax).
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: ParticleSystem.
static final float	PARTICLELIFETIME_DEFAULT_VALUE	SFFloat field named particleLifetime has default value 5f (Java syntax) or 5 (XML syntax).
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).
static final X3DNode	TEXCOORD_DEFAULT_VALUE	SFNode field named texCoord has default value null (Java syntax) or NULL (XML syntax).
static final ArrayList<Float>	TEXCOORDKEY_DEFAULT_VALUE	MFFloat field named texCoordKey has default value equal to an empty list.
static final String	toField_APPEARANCE	toField ROUTE name for SFNode field named appearance.
static final String	toField_BBOXDISPLAY	toField ROUTE name for SFBool field named bboxDisplay.
static final String	toField_CASTSHADOW	toField ROUTE name for SFBool field named castShadow.
static final String	toField_CREATEPARTICLES	toField ROUTE name for SFBool field named createParticles.
static final String	toField_ENABLED	toField ROUTE name for SFBool field named enabled.
static final String	toField_GEOMETRY	toField ROUTE name for SFNode field named geometry.
static final String	toField_LIFETIMEVARIATION	toField ROUTE name for SFFloat field named lifetimeVariation.
static final String	toField_MAXPARTICLES	toField ROUTE name for SFInt32 field named maxParticles.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_PARTICLELIFETIME	toField ROUTE name for SFFloat field named particleLifetime.
static final String	toField_PARTICLESIZE	toField ROUTE name for SFVec2f field named particleSize.
static final String	toField_VISIBLE	toField ROUTE name for SFBool field named visible.
static final boolean	VISIBLE_DEFAULT_VALUE	SFBool field named visible has default value true (Java syntax) or true (XML syntax).

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

containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

Constructor	Description
ParticleSystem()	Constructor for ParticleSystem to initialize member variables with default values.
ParticleSystem(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
ParticleSystem	addColorKey(float newValue)	Add singleton float value to MFFloat colorKey field.
ParticleSystem	addColorKey(SFFloat newValue)	Add singleton SFFloat value to MFFloat colorKey field.
ParticleSystem	addComments(String newComment)	Add comment as String to contained commentsList.
ParticleSystem	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
ParticleSystem	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
ParticleSystem	addPhysics(ProtoInstance newValue)	Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for physics field.
ParticleSystem	addPhysics(X3DNode newValue)	Add single child node to existing array of physics nodes (if any).
void	addPhysics(X3DNode[] newValue)	Add array of child physics nodes to array of existing nodes (if any).
ParticleSystem	addTexCoordKey(float newValue)	Add singleton float value to MFFloat texCoordKey field.
ParticleSystem	addTexCoordKey(SFFloat newValue)	Add singleton SFFloat value to MFFloat texCoordKey field.
ParticleSystem	clearAppearance()	Utility method to clear SFNode value of appearance field.
ParticleSystem	clearColor()	Utility method to clear SFNode value of color field.
ParticleSystem	clearColorKey()	Utility method to clear MFFloat value of colorKey field.
ParticleSystem	clearEmitter()	Utility method to clear SFNode value of emitter field.
ParticleSystem	clearGeometry()	Utility method to clear SFNode value of geometry field.
ParticleSystem	clearIS()	Utility method to clear SFNode value of IS field.
ParticleSystem	clearMetadata()	Utility method to clear SFNode value of metadata field.
ParticleSystem	clearPhysics()	Utility method to clear MFNode value of physics field.
ParticleSystem	clearTexCoord()	Utility method to clear SFNode value of texCoord field.
ParticleSystem	clearTexCoordKey()	Utility method to clear MFFloat value of texCoordKey field.
X3DConcreteElement	findElementByNameValue(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(String nameValue, 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(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
X3DAppearanceNode	getAppearance()	Provide org.web3d.x3d.sai.Shape.X3DAppearanceNode instance (using a properly typed node) from inputOutput SFNode field appearance.
float[]	getBboxCenter()	Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
boolean	getBboxDisplay()	Provide boolean value from inputOutput SFBool field named bboxDisplay.
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.
boolean	getCastShadow()	Provide boolean value from inputOutput SFBool field named castShadow.
X3DColorNode	getColor()	Provide org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) using RGB values [0..1] from initializeOnly SFNode field color.
float[]	getColorKey()	Provide array of Float results using RGB values [0..1] from initializeOnly MFFloat field named colorKey.
ArrayList<Float>	getColorKeyList()	Utility method to get ArrayList value of MFFloat colorKey field, similar to getColorKey().
String	getColorKeyString()	Utility method to get String value of MFFloat colorKey field, similar to getColorKey().
final String	getComponent()	Defines X3D component for the ParticleSystem element: ParticleSystems
final int	getComponentLevel()	Provides default X3D component level for this element: 2
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
boolean	getCreateParticles()	Provide boolean value from inputOutput SFBool field named createParticles.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
final String	getElementName()	Provides name of this element: ParticleSystem
X3DParticleEmitterNode	getEmitter()	Provide org.web3d.x3d.sai.ParticleSystems.X3DParticleEmitterNode instance (using a properly typed node) from initializeOnly SFNode field emitter.
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
X3DGeometryNode	getGeometry()	Provide org.web3d.x3d.sai.Rendering.X3DGeometryNode instance (using a properly typed node) from inputOutput SFNode field geometry.
String	getGeometryType()	Provide String enumeration value (baseType xs:NMTOKEN) ["LINE" | "POINT" | "QUAD" | "SPRITE" | "TRIANGLE" | "GEOMETRY" | 'etc.'] from initializeOnly SFString field named geometryType.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
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 org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
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 org.web3d.x3d.sai.ParticleSystems.X3DParticlePhysicsModelNode results (using an array consisting of properly typed nodes or ProtoInstances) from initializeOnly MFNode field physics.
ArrayList<X3DNode>	getPhysicsList()	Utility method to get ArrayList value of MFNode physics field, similar to getPhysics().
X3DNode	getTexCoord()	Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to TextureCoordinate|TextureCoordinateGenerator, from initializeOnly SFNode field texCoord.
float[]	getTexCoordKey()	Provide array of Float results within allowed range of [0,infinity) from initializeOnly MFFloat field named texCoordKey.
ArrayList<Float>	getTexCoordKeyList()	Utility method to get ArrayList value of MFFloat texCoordKey field, similar to getTexCoordKey().
String	getTexCoordKeyString()	Utility method to get String value of MFFloat texCoordKey field, similar to getTexCoordKey().
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	getVisible()	Provide boolean value from inputOutput SFBool field named visible.
boolean	hasAppearance()	Indicate whether an object is available for inputOutput SFNode field appearance.
boolean	hasColor()	Indicate whether an object is available for initializeOnly SFNode field color.
boolean	hasElementByNameValue(String nameValue, 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	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(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	hasTexCoord()	Indicate whether an object is available for initializeOnly SFNode field texCoord.
final void	initialize()	Initialize all member variables to default values.
ParticleSystem	setAppearance(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field appearance.
ParticleSystem	setAppearance(X3DAppearanceNode newValue)	Accessor method to assign org.web3d.x3d.sai.Shape.X3DAppearanceNode instance (using a properly typed node) to inputOutput SFNode field appearance.
ParticleSystem	setBboxCenter(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).
ParticleSystem	setBboxCenter(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).
ParticleSystem	setBboxCenter(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
ParticleSystem	setBboxCenter(float x, float y, float z)	Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
ParticleSystem	setBboxCenter(SFVec3f newValue)	Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
ParticleSystem	setBboxDisplay(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
ParticleSystem	setBboxDisplay(SFBool newValue)	Assign typed object value to SFBool bboxDisplay field, similar to setBboxDisplay(boolean).
ParticleSystem	setBboxSize(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).
ParticleSystem	setBboxSize(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).
ParticleSystem	setBboxSize(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
ParticleSystem	setBboxSize(float x, float y, float z)	Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
ParticleSystem	setBboxSize(SFVec3f newValue)	Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
ParticleSystem	setCastShadow(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named castShadow.
ParticleSystem	setCastShadow(SFBool newValue)	Assign typed object value to SFBool castShadow field, similar to setCastShadow(boolean).
ParticleSystem	setColor(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field color.
ParticleSystem	setColor(X3DColorNode newValue)	Accessor method to assign org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) to initializeOnly SFNode field color.
ParticleSystem	setColorKey(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setColorKey(float[]).
ParticleSystem	setColorKey(float[] newValue)	Accessor method to assign Float array to initializeOnly MFFloat field named colorKey.
ParticleSystem	setColorKey(int[] newValue)	Assign floating-point array value of MFFloat colorKey field, similar to setColorKey(float[]).
ParticleSystem	setColorKey(ArrayList<Float> newValue)	Assign ArrayList value of MFFloat colorKey field, similar to setColorKey(float[]).
ParticleSystem	setColorKey(MFFloat newValue)	Assign typed object value to MFFloat colorKey field, similar to setColorKey(float[]).
ParticleSystem	setCreateParticles(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named createParticles.
ParticleSystem	setCreateParticles(SFBool newValue)	Assign typed object value to SFBool createParticles field, similar to setCreateParticles(boolean).
final ParticleSystem	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
ParticleSystem	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final ParticleSystem	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
ParticleSystem	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final ParticleSystem	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
ParticleSystem	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
ParticleSystem	setEmitter(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field emitter.
ParticleSystem	setEmitter(X3DParticleEmitterNode newValue)	Accessor method to assign org.web3d.x3d.sai.ParticleSystems.X3DParticleEmitterNode instance (using a properly typed node) to initializeOnly SFNode field emitter.
ParticleSystem	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
ParticleSystem	setEnabled(SFBool newValue)	Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
ParticleSystem	setGeometry(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field geometry.
ParticleSystem	setGeometry(X3DGeometryNode newValue)	Accessor method to assign org.web3d.x3d.sai.Rendering.X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field geometry.
ParticleSystem	setGeometryType(String newValue)	Accessor method to assign String enumeration value ("LINE" | "POINT" | "QUAD" | "SPRITE" | "TRIANGLE" | "GEOMETRY") to initializeOnly SFString field named geometryType.
ParticleSystem	setGeometryType(SFString newValue)	Assign typed object value to SFString geometryType field, similar to setGeometryType(String).
final ParticleSystem	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
ParticleSystem	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
ParticleSystem	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
ParticleSystem	setLifetimeVariation(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setLifetimeVariation(float).
ParticleSystem	setLifetimeVariation(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named lifetimeVariation.
ParticleSystem	setLifetimeVariation(SFFloat newValue)	Assign typed object value to SFFloat lifetimeVariation field, similar to setLifetimeVariation(float).
ParticleSystem	setMaxParticles(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named maxParticles.
ParticleSystem	setMaxParticles(SFInt32 newValue)	Assign typed object value to SFInt32 maxParticles field, similar to setMaxParticles(int).
ParticleSystem	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
ParticleSystem	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
ParticleSystem	setParticleLifetime(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setParticleLifetime(float).
ParticleSystem	setParticleLifetime(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named particleLifetime.
ParticleSystem	setParticleLifetime(SFFloat newValue)	Assign typed object value to SFFloat particleLifetime field, similar to setParticleLifetime(float).
ParticleSystem	setParticleSize(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setParticleSize(float[]).
ParticleSystem	setParticleSize(double x, double y)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setParticleSize(float[]).
ParticleSystem	setParticleSize(float[] newValue)	Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named particleSize.
ParticleSystem	setParticleSize(float x, float y)	Assign values to SFVec2f particleSize field, similar to setParticleSize(float[]).
ParticleSystem	setParticleSize(SFVec2f newValue)	Assign typed object value to SFVec2f particleSize field, similar to setParticleSize(float[]).
ParticleSystem	setPhysics(ArrayList<X3DParticlePhysicsModelNode> newValue)	Assign ArrayList value of MFNode physics field, similar to setPhysics(org.web3d.x3d.sai.Core.X3DNode[]).
void	setPhysics(X3DNode newValue)	Set single child physics node, replacing prior array of existing nodes (if any).
ParticleSystem	setPhysics(X3DNode[] newValue)	Accessor method to assign org.web3d.x3d.sai.ParticleSystems.X3DParticlePhysicsModelNode array (using an array consisting of properly typed nodes or ProtoInstances) to initializeOnly MFNode field physics.
ParticleSystem	setTexCoord(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field texCoord.
ParticleSystem	setTexCoord(X3DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to initializeOnly SFNode field texCoord.
ParticleSystem	setTexCoordKey(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setTexCoordKey(float[]).
ParticleSystem	setTexCoordKey(float[] newValue)	Accessor method to assign Float array to initializeOnly MFFloat field named texCoordKey.
ParticleSystem	setTexCoordKey(int[] newValue)	Assign floating-point array value of MFFloat texCoordKey field, similar to setTexCoordKey(float[]).
ParticleSystem	setTexCoordKey(ArrayList<Float> newValue)	Assign ArrayList value of MFFloat texCoordKey field, similar to setTexCoordKey(float[]).
ParticleSystem	setTexCoordKey(MFFloat newValue)	Assign typed object value to MFFloat texCoordKey field, similar to setTexCoordKey(float[]).
final ParticleSystem	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
ParticleSystem	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
ParticleSystem	setUSE(ParticleSystem DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
ParticleSystem	setVisible(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named visible.
ParticleSystem	setVisible(SFBool newValue)	Assign typed object value to SFBool visible field, similar to setVisible(boolean).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
String	validate()	Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

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

getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

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

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

GEOMETRYTYPE_LINE

public static final String GEOMETRYTYPE_LINE

Tooltip: line is drawn along current velocity vector of particle. SFString field named geometryType with X3DUOM simpleType particleSystemGeometryTypeValues and with X3DUOM baseType xs:NMTOKEN can equal this value "LINE" (Java syntax) or LINE (XML syntax).

See Also:

• XML Schema: particleSystemGeometryTypeValues
• Constant Field Values

GEOMETRYTYPE_POINT

public static final String GEOMETRYTYPE_POINT

Tooltip: point geometry is rendered at particle position. SFString field named geometryType with X3DUOM simpleType particleSystemGeometryTypeValues and with X3DUOM baseType xs:NMTOKEN can equal this value "POINT" (Java syntax) or POINT (XML syntax).

See Also:

• XML Schema: particleSystemGeometryTypeValues
• Constant Field Values

GEOMETRYTYPE_QUAD

public static final String GEOMETRYTYPE_QUAD

Tooltip: quad geometry is rendered at particle position facing direction traveled. SFString field named geometryType with X3DUOM simpleType particleSystemGeometryTypeValues and with X3DUOM baseType xs:NMTOKEN can equal this value "QUAD" (Java syntax) or QUAD (XML syntax).

See Also:

• XML Schema: particleSystemGeometryTypeValues
• Constant Field Values

GEOMETRYTYPE_SPRITE

public static final String GEOMETRYTYPE_SPRITE

Tooltip: quad geometry is rendered at particle position facing screen. SFString field named geometryType with X3DUOM simpleType particleSystemGeometryTypeValues and with X3DUOM baseType xs:NMTOKEN can equal this value "SPRITE" (Java syntax) or SPRITE (XML syntax).

See Also:

• XML Schema: particleSystemGeometryTypeValues
• Constant Field Values

GEOMETRYTYPE_TRIANGLE

public static final String GEOMETRYTYPE_TRIANGLE

Tooltip: pair of triangles creating quad geometry is rendered at particle position facing direction traveled. SFString field named geometryType with X3DUOM simpleType particleSystemGeometryTypeValues and with X3DUOM baseType xs:NMTOKEN can equal this value "TRIANGLE" (Java syntax) or TRIANGLE (XML syntax).

See Also:

• XML Schema: particleSystemGeometryTypeValues
• Constant Field Values

GEOMETRYTYPE_GEOMETRY

public static final String GEOMETRYTYPE_GEOMETRY

Tooltip: geometry field is used for rendering each particle. SFString field named geometryType with X3DUOM simpleType particleSystemGeometryTypeValues and with X3DUOM baseType xs:NMTOKEN can equal this value "GEOMETRY" (Java syntax) or GEOMETRY (XML syntax).

See Also:

• XML Schema: particleSystemGeometryTypeValues
• Constant Field Values

NAME

public static final String NAME

String constant NAME provides name of this element: ParticleSystem.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the ParticleSystem element: ParticleSystems

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D ParticleSystems component level for this element: 2

See Also:

• Constant Field Values

APPEARANCE_DEFAULT_VALUE

public static final X3DAppearanceNode APPEARANCE_DEFAULT_VALUE

SFNode field named appearance has default value null (Java syntax) or NULL (XML syntax).

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

BBOXDISPLAY_DEFAULT_VALUE

public static final boolean BBOXDISPLAY_DEFAULT_VALUE

SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).

See Also:

• Constant Field Values

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

CASTSHADOW_DEFAULT_VALUE

public static final boolean CASTSHADOW_DEFAULT_VALUE

SFBool field named castShadow has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

COLOR_DEFAULT_VALUE

public static final X3DColorNode COLOR_DEFAULT_VALUE

SFNode field named color has default value null (Java syntax) or NULL (XML syntax).

COLORKEY_DEFAULT_VALUE

public static final ArrayList<Float> COLORKEY_DEFAULT_VALUE

MFFloat field named colorKey has default value equal to an empty list.

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

EMITTER_DEFAULT_VALUE

public static final X3DParticleEmitterNode EMITTER_DEFAULT_VALUE

SFNode field named emitter has default value null (Java syntax) or NULL (XML syntax).

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

GEOMETRY_DEFAULT_VALUE

public static final X3DGeometryNode GEOMETRY_DEFAULT_VALUE

SFNode field named geometry has default value null (Java syntax) or NULL (XML syntax).

GEOMETRYTYPE_DEFAULT_VALUE

public static final String GEOMETRYTYPE_DEFAULT_VALUE

SFString field named geometryType has default value "QUAD" (Java syntax) or QUAD (XML syntax).

See Also:

• Constant Field Values

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

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

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

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

TEXCOORD_DEFAULT_VALUE

public static final X3DNode TEXCOORD_DEFAULT_VALUE

SFNode field named texCoord has default value null (Java syntax) or NULL (XML syntax).

TEXCOORDKEY_DEFAULT_VALUE

public static final ArrayList<Float> TEXCOORDKEY_DEFAULT_VALUE

MFFloat field named texCoordKey has default value equal to an empty list.

VISIBLE_DEFAULT_VALUE

public static final boolean VISIBLE_DEFAULT_VALUE

SFBool field named visible has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "children";
containerField_ALLOWED_VALUES = {"children" }; type xs:NMTOKEN

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_APPEARANCE

public static final String fromField_APPEARANCE

fromField ROUTE name for SFNode field named appearance.

See Also:

• Constant Field Values

toField_APPEARANCE

public static final String toField_APPEARANCE

toField ROUTE name for SFNode field named appearance.

See Also:

• Constant Field Values

fromField_BBOXDISPLAY

public static final String fromField_BBOXDISPLAY

fromField ROUTE name for SFBool field named bboxDisplay.

See Also:

• Constant Field Values

toField_BBOXDISPLAY

public static final String toField_BBOXDISPLAY

toField ROUTE name for SFBool field named bboxDisplay.

See Also:

• Constant Field Values

fromField_CASTSHADOW

public static final String fromField_CASTSHADOW

fromField ROUTE name for SFBool field named castShadow.

See Also:

• Constant Field Values

toField_CASTSHADOW

public static final String toField_CASTSHADOW

toField ROUTE name for SFBool field named castShadow.

See Also:

• Constant Field Values

fromField_CREATEPARTICLES

public static final String fromField_CREATEPARTICLES

fromField ROUTE name for SFBool field named createParticles.

See Also:

• Constant Field Values

toField_CREATEPARTICLES

public static final String toField_CREATEPARTICLES

toField ROUTE name for SFBool field named createParticles.

See Also:

• Constant Field Values

fromField_ENABLED

public static final String fromField_ENABLED

fromField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

toField_ENABLED

public static final String toField_ENABLED

toField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

fromField_GEOMETRY

public static final String fromField_GEOMETRY

fromField ROUTE name for SFNode field named geometry.

See Also:

• Constant Field Values

toField_GEOMETRY

public static final String toField_GEOMETRY

toField ROUTE name for SFNode field named geometry.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_ISACTIVE

public static final String fromField_ISACTIVE

fromField ROUTE name for SFBool field named isActive.

See Also:

• Constant Field Values

fromField_LIFETIMEVARIATION

public static final String fromField_LIFETIMEVARIATION

fromField ROUTE name for SFFloat field named lifetimeVariation.

See Also:

• Constant Field Values

toField_LIFETIMEVARIATION

public static final String toField_LIFETIMEVARIATION

toField ROUTE name for SFFloat field named lifetimeVariation.

See Also:

• Constant Field Values

fromField_MAXPARTICLES

public static final String fromField_MAXPARTICLES

fromField ROUTE name for SFInt32 field named maxParticles.

See Also:

• Constant Field Values

toField_MAXPARTICLES

public static final String toField_MAXPARTICLES

toField ROUTE name for SFInt32 field named maxParticles.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_PARTICLELIFETIME

public static final String fromField_PARTICLELIFETIME

fromField ROUTE name for SFFloat field named particleLifetime.

See Also:

• Constant Field Values

toField_PARTICLELIFETIME

public static final String toField_PARTICLELIFETIME

toField ROUTE name for SFFloat field named particleLifetime.

See Also:

• Constant Field Values

fromField_PARTICLESIZE

public static final String fromField_PARTICLESIZE

fromField ROUTE name for SFVec2f field named particleSize.

See Also:

• Constant Field Values

toField_PARTICLESIZE

public static final String toField_PARTICLESIZE

toField ROUTE name for SFVec2f field named particleSize.

See Also:

• Constant Field Values

fromField_VISIBLE

public static final String fromField_VISIBLE

fromField ROUTE name for SFBool field named visible.

See Also:

• Constant Field Values

toField_VISIBLE

public static final String toField_VISIBLE

toField ROUTE name for SFBool field named visible.

See Also:

• Constant Field Values

Constructor Details

ParticleSystem

public ParticleSystem()

Constructor for ParticleSystem to initialize member variables with default values.

ParticleSystem

public ParticleSystem(String DEFlabel)

Utility constructor that assigns DEF label after initializing member variables with default values.

Parameters:

DEFlabel - unique DEF name for this X3D node

Method Details

getElementName

public final String getElementName()

Provides name of this element: ParticleSystem

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the ParticleSystem 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 String getFieldType(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 String getAccessType(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

getContainerFieldDefault

public final String getContainerFieldDefault()

containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getAppearance

public X3DAppearanceNode getAppearance()

Provide org.web3d.x3d.sai.Shape.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 colors 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 ParticleSystem setAppearance(X3DAppearanceNode newValue)

Accessor method to assign org.web3d.x3d.sai.Shape.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:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• 
  
  Tooltip: [X3DAppearanceNode] The appearance field holds an Appearance node that is used for the geometry. All effects, such as material colors 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 ParticleSystem clearAppearance()

Utility method to clear SFNode value of appearance field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setAppearance

public ParticleSystem setAppearance(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field appearance.

Parameters:

newValue - is new value for the appearance field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setAppearance(org.web3d.x3d.sai.Shape.X3DAppearanceNode)

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 accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.

• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject

Specified by:

getBboxCenter in interface ParticleSystem

Specified by:

getBboxCenter in interface X3DBoundedObject

Specified by:

getBboxCenter in interface X3DShapeNode

Returns:

value of bboxCenter field

setBboxCenter

public ParticleSystem setBboxCenter(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.

Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.

• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject

Specified by:

setBboxCenter in interface ParticleSystem

Specified by:

setBboxCenter in interface X3DBoundedObject

Specified by:

setBboxCenter in interface X3DShapeNode

Parameters:

newValue - is new value for the bboxCenter field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxCenter

public ParticleSystem setBboxCenter(SFVec3f newValue)

Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).

Parameters:

newValue - is new value for the bboxCenter field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxCenter

public ParticleSystem 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:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxCenter

public ParticleSystem setBboxCenter(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxCenter

public ParticleSystem setBboxCenter(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).

Parameters:

newArray - is new value for field

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getBboxDisplay

public boolean getBboxDisplay()

Provide boolean value from inputOutput SFBool field named bboxDisplay.

Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.

• Hint: the bounding box is displayed regardless of whether contained content is visible.

Specified by:

getBboxDisplay in interface ParticleSystem

Specified by:

getBboxDisplay in interface X3DBoundedObject

Specified by:

getBboxDisplay in interface X3DShapeNode

Returns:

value of bboxDisplay field

setBboxDisplay

public ParticleSystem setBboxDisplay(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.

Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.

• Hint: the bounding box is displayed regardless of whether contained content is visible.

Specified by:

setBboxDisplay in interface ParticleSystem

Specified by:

setBboxDisplay in interface X3DBoundedObject

Specified by:

setBboxDisplay in interface X3DShapeNode

Parameters:

newValue - is new value for the bboxDisplay field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxDisplay

public ParticleSystem setBboxDisplay(SFBool newValue)

Assign typed object value to SFBool bboxDisplay field, similar to setBboxDisplay(boolean).

Parameters:

newValue - is new value for the bboxDisplay field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same 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: or [0,+infinity) 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.
• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject

Specified by:

getBboxSize in interface ParticleSystem

Specified by:

getBboxSize in interface X3DBoundedObject

Specified by:

getBboxSize in interface X3DShapeNode

Returns:

value of bboxSize field

setBboxSize

public ParticleSystem setBboxSize(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.

Tooltip: or [0,+infinity) 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.
• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject

Specified by:

setBboxSize in interface ParticleSystem

Specified by:

setBboxSize in interface X3DBoundedObject

Specified by:

setBboxSize in interface X3DShapeNode

Parameters:

newValue - is new value for the bboxSize field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxSize

public ParticleSystem setBboxSize(SFVec3f newValue)

Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).

Parameters:

newValue - is new value for the bboxSize field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxSize

public ParticleSystem 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:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxSize

public ParticleSystem setBboxSize(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxSize

public ParticleSystem setBboxSize(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).

Parameters:

newArray - is new value for field

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCastShadow

public boolean getCastShadow()

Provide boolean value from inputOutput SFBool field named castShadow.

Tooltip: The castShadow field defines whether this Shape casts shadows as produced by lighting nodes.

• Hint: if the visible field is FALSE, then the Shape does not cast any shadows, regardless of the castShadow value.
• Hint: if prior X3D3 content is loaded into an X3D4 model, then legacy Shape nodes have shadows set to true.

Specified by:

getCastShadow in interface ParticleSystem

Specified by:

getCastShadow in interface X3DShapeNode

Returns:

value of castShadow field

setCastShadow

public ParticleSystem setCastShadow(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named castShadow.

Tooltip: The castShadow field defines whether this Shape casts shadows as produced by lighting nodes.

• Hint: if the visible field is FALSE, then the Shape does not cast any shadows, regardless of the castShadow value.
• Hint: if prior X3D3 content is loaded into an X3D4 model, then legacy Shape nodes have shadows set to true.

Specified by:

setCastShadow in interface ParticleSystem

Specified by:

setCastShadow in interface X3DShapeNode

Parameters:

newValue - is new value for the castShadow field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setCastShadow

public ParticleSystem setCastShadow(SFBool newValue)

Assign typed object value to SFBool castShadow field, similar to setCastShadow(boolean).

Parameters:

newValue - is new value for the castShadow field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getColor

public X3DColorNode getColor()

Provide org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) using RGB values [0..1] from initializeOnly SFNode field color.

Specified by:

getColor in interface ParticleSystem

Returns:

value of color field

See Also:

• 
  
  Tooltip: [X3DColorNode] The color field contains Color|ColorRGBA nodes as a series of color values to be used at the given colorKey points in time.
  • Warning: field originally named 'colorRamp' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges
  • Hint: color values are defined as per-vertex color values.
  • Warning: if an Appearance and Material nodes are provided, those material properties override color field interpolation.
  • Hint: number of colorKey values must match length of the per-vertex color field array values!
  • Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

setColor

public ParticleSystem setColor(X3DColorNode newValue)

Accessor method to assign org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) to initializeOnly SFNode field color.

Specified by:

setColor in interface ParticleSystem

Parameters:

newValue - is new value for the color field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• 
  
  Tooltip: [X3DColorNode] The color field contains Color|ColorRGBA nodes as a series of color values to be used at the given colorKey points in time.
  • Warning: field originally named 'colorRamp' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges
  • Hint: color values are defined as per-vertex color values.
  • Warning: if an Appearance and Material nodes are provided, those material properties override color field interpolation.
  • Hint: number of colorKey values must match length of the per-vertex color field array values!
  • Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

clearColor

public ParticleSystem clearColor()

Utility method to clear SFNode value of color field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setColor

public ParticleSystem setColor(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field color.

Parameters:

newValue - is new value for the color field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setColor(org.web3d.x3d.sai.Rendering.X3DColorNode)

hasColor

public boolean hasColor()

Indicate whether an object is available for initializeOnly SFNode field color.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getColor()
• getColorProtoInstance()

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 color 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 color values.
• Warning: if an Appearance and Material nodes are provided, those material properties override color field interpolation.
• Hint: number of colorKey values must match length of the per-vertex color field array values!
• Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

Specified by:

getColorKey in interface ParticleSystem

Returns:

value of colorKey field

getColorKeyList

public ArrayList<Float> getColorKeyList()

Utility method to get ArrayList value of MFFloat colorKey field, similar to getColorKey().

Returns:

value of colorKey field

getColorKeyString

public String getColorKeyString()

Utility method to get String value of MFFloat colorKey field, similar to getColorKey().

Returns:

value of colorKey field

setColorKey

public ParticleSystem setColorKey(float[] newValue)

Accessor method to assign Float array to initializeOnly MFFloat field named colorKey.

Tooltip: [0,+infinity) Array of time intervals in seconds, corresponding to particle lifetime, that are used to interpolate color 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 color values.
• Warning: if an Appearance and Material nodes are provided, those material properties override color field interpolation.
• Hint: number of colorKey values must match length of the per-vertex color field array values!
• Hint: X3D Scene Authoring Hints, Color https://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:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setColorKey

public ParticleSystem setColorKey(MFFloat newValue)

Assign typed object value to MFFloat colorKey field, similar to setColorKey(float[]).

Parameters:

newValue - is new value for the colorKey field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setColorKey

public ParticleSystem setColorKey(ArrayList<Float> newValue)

Assign ArrayList value of MFFloat colorKey field, similar to setColorKey(float[]).

Parameters:

newValue - is new value for the colorKey field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

clearColorKey

public ParticleSystem clearColorKey()

Utility method to clear MFFloat value of colorKey field. This method does not initialize withCOLORKEY_DEFAULT_VALUE.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setColorKey

public ParticleSystem 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:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addColorKey

public ParticleSystem addColorKey(float newValue)

Add singleton float value to MFFloat colorKey field.

Parameters:

newValue - is new value to add to the colorKey field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addColorKey

public ParticleSystem addColorKey(SFFloat newValue)

Add singleton SFFloat value to MFFloat colorKey field.

Parameters:

newValue - is new value to add to the colorKey field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setColorKey

public ParticleSystem setColorKey(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setColorKey(float[]).

Parameters:

newArray - is new value for field

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

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 ParticleSystem setCreateParticles(boolean newValue)

Accessor method to 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:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setCreateParticles

public ParticleSystem setCreateParticles(SFBool newValue)

Assign typed object value to SFBool createParticles field, similar to setCreateParticles(boolean).

Parameters:

newValue - is new value for the createParticles field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getEmitter

public X3DParticleEmitterNode getEmitter()

Provide org.web3d.x3d.sai.ParticleSystems.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 ParticleSystem setEmitter(X3DParticleEmitterNode newValue)

Accessor method to assign org.web3d.x3d.sai.ParticleSystems.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:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same 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 ParticleSystem clearEmitter()

Utility method to clear SFNode value of emitter field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setEmitter

public ParticleSystem setEmitter(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field emitter.

Parameters:

newValue - is new value for the emitter field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setEmitter(org.web3d.x3d.sai.ParticleSystems.X3DParticleEmitterNode)

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 ParticleSystem setEnabled(boolean newValue)

Accessor method to 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:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setEnabled

public ParticleSystem setEnabled(SFBool newValue)

Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).

Parameters:

newValue - is new value for the enabled field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getGeometry

public X3DGeometryNode getGeometry()

Provide org.web3d.x3d.sai.Rendering.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] Single contained geometry node provides geometry used for each particle when geometryType=GEOMETRY.
  • Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
  • Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>

setGeometry

public ParticleSystem setGeometry(X3DGeometryNode newValue)

Accessor method to assign org.web3d.x3d.sai.Rendering.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:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• 
  
  Tooltip: [X3DGeometryNode] Single contained geometry node provides geometry used for each particle when geometryType=GEOMETRY.
  • Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
  • Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>

clearGeometry

public ParticleSystem clearGeometry()

Utility method to clear SFNode value of geometry field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setGeometry

public ParticleSystem setGeometry(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field geometry.

Parameters:

newValue - is new value for the geometry field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setGeometry(org.web3d.x3d.sai.Rendering.X3DGeometryNode)

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 String getGeometryType()

Provide String enumeration value (baseType xs:NMTOKEN) ["LINE" | "POINT" | "QUAD" | "SPRITE" | "TRIANGLE" | "GEOMETRY" | 'etc.'] from initializeOnly SFString field named geometryType.

Tooltip: specifies type of geometry used to represent individual particles. Typically, a particle is calculated as point in space at which the geometry is placed. Changing the value of the geometry field or the definition of the geometry node shall be applied during current computation of the next frame to be rendered.

• Hint: LINE means that a line is drawn along the particle's current velocity vector, for this frame, centered about the particle's position. The length of the line is specified by the particle's height from the particleSize field value.
• Hint: POINT means that a point geometry is rendered at the particle's position.
• Hint: QUAD means that a 2D quad is rendered aligned in the local coordinate space of the particle system with the face normal pointing along the positive Z axis. Individual quads are not aligned to the user's eye position but are affected in depth by the physics model. The particle's position is at the center of the quad.
• Hint: SPRITE means that a point sprite that uses a 2D point position to locate a screen-aligned quad at the center of the particle's location is rendered.
• Hint: TRIANGLE means that a 2D quad is rendered using a pair of triangles aligned in the local coordinate space of the particle system with the face normal pointing along the positive Z axis. Individual triangles are not aligned to the user's eye position, but are affected in depth by the physics model. The particle's position is at the center of the triangle.
• Hint: GEOMETRY means that the geometry specified by the geometry field is rendered for each particle using the local coordinate system.
• Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
• Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
• Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>

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 ParticleSystem setGeometryType(String newValue)

Accessor method to assign String enumeration value ("LINE" | "POINT" | "QUAD" | "SPRITE" | "TRIANGLE" | "GEOMETRY") to initializeOnly SFString field named geometryType.

Hint: authors have option to choose from an extendible list of predefined enumeration values (LINE, POINT, QUAD, SPRITE, TRIANGLE, GEOMETRY).

Tooltip: specifies type of geometry used to represent individual particles. Typically, a particle is calculated as point in space at which the geometry is placed. Changing the value of the geometry field or the definition of the geometry node shall be applied during current computation of the next frame to be rendered.

• Hint: LINE means that a line is drawn along the particle's current velocity vector, for this frame, centered about the particle's position. The length of the line is specified by the particle's height from the particleSize field value.
• Hint: POINT means that a point geometry is rendered at the particle's position.
• Hint: QUAD means that a 2D quad is rendered aligned in the local coordinate space of the particle system with the face normal pointing along the positive Z axis. Individual quads are not aligned to the user's eye position but are affected in depth by the physics model. The particle's position is at the center of the quad.
• Hint: SPRITE means that a point sprite that uses a 2D point position to locate a screen-aligned quad at the center of the particle's location is rendered.
• Hint: TRIANGLE means that a 2D quad is rendered using a pair of triangles aligned in the local coordinate space of the particle system with the face normal pointing along the positive Z axis. Individual triangles are not aligned to the user's eye position, but are affected in depth by the physics model. The particle's position is at the center of the triangle.
• Hint: GEOMETRY means that the geometry specified by the geometry field is rendered for each particle using the local coordinate system.
• Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
• Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
• Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>

Specified by:

setGeometryType in interface ParticleSystem

Parameters:

newValue - is new value for the geometryType field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setGeometryType

public ParticleSystem setGeometryType(SFString newValue)

Assign typed object value to SFString geometryType field, similar to setGeometryType(String).

Parameters:

newValue - is new value for the geometryType field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getIS

public IS getIS()

Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.

Specified by:

getIS in class X3DConcreteNode

Returns:

value of IS field

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

setIS

public ParticleSystem setIS(IS newValue)

Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the IS field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

clearIS

public ParticleSystem clearIS()

Utility method to clear SFNode value of IS field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

hasIS

public boolean hasIS()

Indicate whether an object is available for inputOutput SFNode field IS.

Returns:

whether a concrete statement or CommentsBlock is available.

See Also:

• getIS()

getIsActive

public boolean getIsActive()

Provide boolean value from outputOnly SFBool field named isActive.

Tooltip: isActive true/false events are sent when playback starts/stops.

• Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

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 ParticleSystem setLifetimeVariation(float newValue)

Accessor method to assign float value 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:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setLifetimeVariation

public ParticleSystem setLifetimeVariation(SFFloat newValue)

Assign typed object value to SFFloat lifetimeVariation field, similar to setLifetimeVariation(float).

Parameters:

newValue - is new value for the lifetimeVariation field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setLifetimeVariation

public ParticleSystem setLifetimeVariation(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setLifetimeVariation(float).

Parameters:

newValue - is new value for field

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same 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 ParticleSystem setMaxParticles(int newValue)

Accessor method to assign int value 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:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setMaxParticles

public ParticleSystem setMaxParticles(SFInt32 newValue)

Assign typed object value to SFInt32 maxParticles field, similar to setMaxParticles(int).

Parameters:

newValue - is new value for the maxParticles field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getMetadata

public X3DMetadataObject getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface ParticleSystem

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DShapeNode

Returns:

value of metadata field

See Also:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public ParticleSystem setMetadata(X3DMetadataObject newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in interface ParticleSystem

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DShapeNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public ParticleSystem clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public ParticleSystem setMetadata(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setMetadata(org.web3d.x3d.sai.Core.X3DMetadataObject)

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 ParticleSystem setParticleLifetime(float newValue)

Accessor method to assign float value 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:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setParticleLifetime

public ParticleSystem setParticleLifetime(SFFloat newValue)

Assign typed object value to SFFloat particleLifetime field, similar to setParticleLifetime(float).

Parameters:

newValue - is new value for the particleLifetime field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setParticleLifetime

public ParticleSystem setParticleLifetime(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setParticleLifetime(float).

Parameters:

newValue - is new value for field

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same 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 ParticleSystem setParticleSize(float[] newValue)

Accessor method to assign 2-tuple float array 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:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setParticleSize

public ParticleSystem setParticleSize(SFVec2f newValue)

Assign typed object value to SFVec2f particleSize field, similar to setParticleSize(float[]).

Parameters:

newValue - is new value for the particleSize field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setParticleSize

public ParticleSystem setParticleSize(float x,
 float y)

Assign values to SFVec2f particleSize field, similar to setParticleSize(float[]).

Parameters:

x - first component

y - second component

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setParticleSize

public ParticleSystem setParticleSize(double x,
 double y)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setParticleSize(float[]).

Parameters:

x - first component

y - second component

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setParticleSize

public ParticleSystem setParticleSize(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setParticleSize(float[]).

Parameters:

newArray - is new value for field

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getPhysics

public X3DNode[] getPhysics()

Provide array of org.web3d.x3d.sai.ParticleSystems.X3DParticlePhysicsModelNode results (using an array consisting of properly typed nodes or ProtoInstances) 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 X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DParticlePhysicsModelNode.

Specified by:

getPhysics in interface ParticleSystem

Returns:

value of physics field

See Also:

• X3DParticlePhysicsModelNode

getPhysicsList

public ArrayList<X3DNode> getPhysicsList()

Utility method to get ArrayList value of MFNode physics field, similar to getPhysics().

Returns:

value of physics field

setPhysics

public ParticleSystem setPhysics(X3DNode[] newValue)

Accessor method to assign org.web3d.x3d.sai.ParticleSystems.X3DParticlePhysicsModelNode array (using an array consisting of properly typed nodes or ProtoInstances) 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 X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DParticlePhysicsModelNode.

Specified by:

setPhysics in interface ParticleSystem

Parameters:

newValue - is new value for the physics field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setPhysics

public ParticleSystem setPhysics(ArrayList<X3DParticlePhysicsModelNode> newValue)

Assign ArrayList value of MFNode physics field, similar to setPhysics(org.web3d.x3d.sai.Core.X3DNode[]).

Parameters:

newValue - is new value for the physics field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addPhysics

public ParticleSystem addPhysics(X3DNode newValue)

Add single child node to existing array of physics nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DParticlePhysicsModelNode and ProtoInstance.

Parameters:

newValue - is new value to be appended the physics field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addPhysics

public ParticleSystem addPhysics(ProtoInstance newValue)

Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for physics field.

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.

Parameters:

newValue - is new value to be appended the parts field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addPhysics

public void addPhysics(X3DNode[] newValue)

Add array of child physics nodes to array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), 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 X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DParticlePhysicsModelNode.

Specified by:

setPhysics in interface ParticleSystem

Parameters:

newValue - is new node for the physics field (restricted to X3DParticlePhysicsModelNode)

clearPhysics

public ParticleSystem clearPhysics()

Utility method to clear MFNode value of physics field. This method does not initialize withPHYSICS_DEFAULT_VALUE.

Returns:

ParticleSystem - 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()

getTexCoord

public X3DNode getTexCoord()

Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to TextureCoordinate|TextureCoordinateGenerator, from initializeOnly SFNode field texCoord.

Specified by:

getTexCoord in interface ParticleSystem

Returns:

value of texCoord field

See Also:

• 
  
  Tooltip: [TextureCoordinate|TextureCoordinateGenerator] 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.
  • Warning: field originally named 'texCoordRamp' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges
  • Hint: texture-coordinate values map textures to vertices in the geometry.
  • Hint: number of texCoordKey values must match length of the per-vertex texCoord arrays!

setTexCoord

public ParticleSystem setTexCoord(X3DNode newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to initializeOnly SFNode field texCoord.

Specified by:

setTexCoord in interface ParticleSystem

Parameters:

newValue - is new value for the texCoord field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• 
  
  Tooltip: [TextureCoordinate|TextureCoordinateGenerator] 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.
  • Warning: field originally named 'texCoordRamp' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges
  • Hint: texture-coordinate values map textures to vertices in the geometry.
  • Hint: number of texCoordKey values must match length of the per-vertex texCoord arrays!

clearTexCoord

public ParticleSystem clearTexCoord()

Utility method to clear SFNode value of texCoord field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setTexCoord

public ParticleSystem setTexCoord(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field texCoord.

Parameters:

newValue - is new value for the texCoord field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setTexCoord(org.web3d.x3d.sai.Core.X3DNode)

hasTexCoord

public boolean hasTexCoord()

Indicate whether an object is available for initializeOnly SFNode field texCoord.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getTexCoord()
• getTexCoordProtoInstance()

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 texCoord 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 texCoord arrays!.

Specified by:

getTexCoordKey in interface ParticleSystem

Returns:

value of texCoordKey field

getTexCoordKeyList

public ArrayList<Float> getTexCoordKeyList()

Utility method to get ArrayList value of MFFloat texCoordKey field, similar to getTexCoordKey().

Returns:

value of texCoordKey field

getTexCoordKeyString

public String getTexCoordKeyString()

Utility method to get String value of MFFloat texCoordKey field, similar to getTexCoordKey().

Returns:

value of texCoordKey field

setTexCoordKey

public ParticleSystem setTexCoordKey(float[] newValue)

Accessor method to assign Float array to initializeOnly MFFloat field named texCoordKey.

Tooltip: [0,+infinity) Array of time intervals in seconds, corresponding to particle lifetime, that are used to sequence texCoord 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 texCoord arrays!.

Specified by:

setTexCoordKey in interface ParticleSystem

Parameters:

newValue - is new value for the texCoordKey field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setTexCoordKey

public ParticleSystem setTexCoordKey(MFFloat newValue)

Assign typed object value to MFFloat texCoordKey field, similar to setTexCoordKey(float[]).

Parameters:

newValue - is new value for the texCoordKey field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setTexCoordKey

public ParticleSystem setTexCoordKey(ArrayList<Float> newValue)

Assign ArrayList value of MFFloat texCoordKey field, similar to setTexCoordKey(float[]).

Parameters:

newValue - is new value for the texCoordKey field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

clearTexCoordKey

public ParticleSystem clearTexCoordKey()

Utility method to clear MFFloat value of texCoordKey field. This method does not initialize withTEXCOORDKEY_DEFAULT_VALUE.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setTexCoordKey

public ParticleSystem 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:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addTexCoordKey

public ParticleSystem addTexCoordKey(float newValue)

Add singleton float value to MFFloat texCoordKey field.

Parameters:

newValue - is new value to add to the texCoordKey field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addTexCoordKey

public ParticleSystem addTexCoordKey(SFFloat newValue)

Add singleton SFFloat value to MFFloat texCoordKey field.

Parameters:

newValue - is new value to add to the texCoordKey field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setTexCoordKey

public ParticleSystem setTexCoordKey(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setTexCoordKey(float[]).

Parameters:

newArray - is new value for field

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getVisible

public boolean getVisible()

Provide boolean value from inputOutput SFBool field named visible.

Tooltip: Whether or not renderable content within this node is visually displayed.

• Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
• Hint: content must be visible to be collidable and to be pickable.

Specified by:

getVisible in interface ParticleSystem

Specified by:

getVisible in interface X3DBoundedObject

Specified by:

getVisible in interface X3DShapeNode

Returns:

value of visible field

setVisible

public ParticleSystem setVisible(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named visible.

Tooltip: Whether or not renderable content within this node is visually displayed.

• Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
• Hint: content must be visible to be collidable and to be pickable.

Specified by:

setVisible in interface ParticleSystem

Specified by:

setVisible in interface X3DBoundedObject

Specified by:

setVisible in interface X3DShapeNode

Parameters:

newValue - is new value for the visible field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setVisible

public ParticleSystem setVisible(SFBool newValue)

Assign typed object value to SFBool visible field, similar to setVisible(boolean).

Parameters:

newValue - is new value for the visible field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getDEF

public String getDEF()

Provide String value from 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final ParticleSystem setDEF(String newValue)

Accessor method to 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in class X3DConcreteNode

Parameters:

newValue - is new value for the DEF field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

public ParticleSystem setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

Parameters:

newValue - is new value for the DEF field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getUSE

public String getUSE()

Provide String value from 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.

Overrides:

getUSE in class X3DConcreteNode

Returns:

value of USE field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setUSE

public final ParticleSystem setUSE(String newValue)

Accessor method to 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 on this node resets all other fields to their default values (except for containerField) 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 class X3DConcreteNode

Parameters:

newValue - is new value for the USE field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public ParticleSystem setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

Parameters:

newValue - is new value for the USE field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final ParticleSystem setCssClass(String newValue)

Accessor method to assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public ParticleSystem setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

Parameters:

newValue - is new value for the class field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlID in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final ParticleSystem setHtmlID(String newValue)

Accessor method to assign String value to inputOutput SFString field named id.

Specified by:

setHtmlID in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public ParticleSystem setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).

Parameters:

newValue - is new value for the id field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final ParticleSystem setCssStyle(String newValue)

Accessor method to assign String value to inputOutput SFString field named style.

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public ParticleSystem setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public ParticleSystem setUSE(ParticleSystem DEFnode)

Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) 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:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addComments

public ParticleSystem addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public ParticleSystem addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public ParticleSystem addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

ParticleSystem - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

toStringX3D

public String toStringX3D(int indentLevel)

Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.

Specified by:

toStringX3D in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D.toStringXML()
• X3D.toFileXML(String)
• X3D.toFileX3D(String)
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringClassicVRML

public String toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

Specified by:

toStringClassicVRML in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

ClassicVRML string

See Also:

• X3D.FILE_EXTENSION_CLASSICVRML
• X3D Resources: Virtual Reality Modeling Language (VRML) 97
• Extensible 3D (X3D) encodings Part 2: Classic VRML encoding
• Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar

toStringVRML97

public String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

Specified by:

toStringVRML97 in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

VRML97 string

See Also:

• X3D.FILE_EXTENSION_VRML97
• X3D Resources: Virtual Reality Modeling Language (VRML) 97
• Virtual Reality Modeling Language (VRML) 97 specification
• VRML 97 v2.1 Amendment

findElementByNameValue

public X3DConcreteElement findElementByNameValue(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, CAD and HAnim nodes.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

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)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue,
 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, CAD and HAnim nodes.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

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)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasElementByNameValue

public boolean hasElementByNameValue(String nameValue,
 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(String DEFvalue)

Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

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)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasNodeByDEF

public boolean hasNodeByDEF(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 String validate()

Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)