Class ParticleSystemObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.ParticleSystems.ParticleSystemObject
- All Implemented Interfaces:
X3DChildNode
,X3DNode
,X3DBoundedObject
,ParticleSystem
,X3DShapeNode
public class ParticleSystemObject extends X3DConcreteNode implements ParticleSystem
ParticleSystem specifies a complete particle system.
X3D 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 colorRamp Color|ColorRGBA node for changing base color over each particle's lifetime, a texcoordRamp TextureCoordinate node to control texture coordinates of provided texture(s) in the Appearance node over time, a single emitter X3DParticleEmitterNode, and an array of physics X3DParticlePhysicsModelNode nodes.
Note that SFColorObject 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.
X3D 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 colorRamp Color|ColorRGBA node for changing base color over each particle's lifetime, a texcoordRamp TextureCoordinate node to control texture coordinates of provided texture(s) in the Appearance node over time, a single emitter X3DParticleEmitterNode, and an array of physics X3DParticlePhysicsModelNode nodes.
- Hint: event timing details are explained in X3D Specification 4.4.8.3 Execution model https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/concepts.html#ExecutionModelHint: Wikipedia, particle system https://en.wikipedia.org/wiki/Particle_system
Note that SFColorObject 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.
-
Field Summary
Fields Modifier and Type Field Description static X3DAppearanceNode
APPEARANCE_DEFAULT_VALUE
SFNode field named appearance has default value null (Java syntax) or NULL (XML syntax).static float[]
BBOXCENTER_DEFAULT_VALUE
SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static boolean
BBOXDISPLAY_DEFAULT_VALUE
SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).static float[]
BBOXSIZE_DEFAULT_VALUE
SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).static java.util.ArrayList<java.lang.Float>
COLORKEY_DEFAULT_VALUE
MFFloat field named colorKey has default value equal to an empty list.static X3DColorNode
COLORRAMP_DEFAULT_VALUE
SFNode field named colorRamp has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the ParticleSystem element: ParticleSystemsstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static boolean
CREATEPARTICLES_DEFAULT_VALUE
SFBool field named createParticles has default value true (Java syntax) or true (XML syntax).static X3DParticleEmitterNode
EMITTER_DEFAULT_VALUE
SFNode field named emitter has default value null (Java syntax) or NULL (XML syntax).static boolean
ENABLED_DEFAULT_VALUE
SFBool field named enabled has default value true (Java syntax) or true (XML syntax).static java.lang.String
fromField_APPEARANCE
fromField ROUTE name for SFNode field named appearance.static java.lang.String
fromField_BBOXDISPLAY
fromField ROUTE name for SFBool field named bboxDisplay.static java.lang.String
fromField_CREATEPARTICLES
fromField ROUTE name for SFBool field named createParticles.static java.lang.String
fromField_ENABLED
fromField ROUTE name for SFBool field named enabled.static java.lang.String
fromField_GEOMETRY
fromField ROUTE name for SFNode field named geometry.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_ISACTIVE
fromField ROUTE name for SFBool field named isActive.static java.lang.String
fromField_LIFETIMEVARIATION
fromField ROUTE name for SFFloat field named lifetimeVariation.static java.lang.String
fromField_MAXPARTICLES
fromField ROUTE name for SFInt32 field named maxParticles.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_PARTICLELIFETIME
fromField ROUTE name for SFFloat field named particleLifetime.static java.lang.String
fromField_PARTICLESIZE
fromField ROUTE name for SFVec2f field named particleSize.static java.lang.String
fromField_VISIBLE
fromField ROUTE name for SFBool field named visible.static X3DGeometryNode
GEOMETRY_DEFAULT_VALUE
SFNode field named geometry has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
GEOMETRYTYPE_DEFAULT_VALUE
SFString field named geometryType has default value "QUAD" (Java syntax) or QUAD (XML syntax).static java.lang.String
GEOMETRYTYPE_GEOMETRY
Tooltip: geometry field is used for rendering each particle.static java.lang.String
GEOMETRYTYPE_LINE
Tooltip: line is drawn along current velocity vector of particle.static java.lang.String
GEOMETRYTYPE_POINT
Tooltip: point geometry is rendered at particle position.static java.lang.String
GEOMETRYTYPE_QUAD
Tooltip: quad geometry is rendered at particle position facing direction traveled.static java.lang.String
GEOMETRYTYPE_SPRITE
Tooltip: quad geometry is rendered at particle position facing screen.static java.lang.String
GEOMETRYTYPE_TRIANGLE
Tooltip: pair of triangles creating quad geometry is rendered at particle position facing direction traveled.static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D ParticleSystems component level for this element: 2static float
LIFETIMEVARIATION_DEFAULT_VALUE
SFFloat field named lifetimeVariation has default value 0.25f (Java syntax) or 0.25 (XML syntax).static int
MAXPARTICLES_DEFAULT_VALUE
SFInt32 field named maxParticles has default value 200 (Java syntax) or 200 (XML syntax).static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: ParticleSystem.static float
PARTICLELIFETIME_DEFAULT_VALUE
SFFloat field named particleLifetime has default value 5f (Java syntax) or 5 (XML syntax).static float[]
PARTICLESIZE_DEFAULT_VALUE
SFVec2f field named particleSize has default value {0.02f,0.02f} (Java syntax) or 0.02 0.02 (XML syntax).static java.util.ArrayList<java.lang.Float>
TEXCOORDKEY_DEFAULT_VALUE
MFFloat field named texCoordKey has default value equal to an empty list.static TextureCoordinateObject
TEXCOORDRAMP_DEFAULT_VALUE
SFNode field named texCoordRamp has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
toField_APPEARANCE
toField ROUTE name for SFNode field named appearance.static java.lang.String
toField_BBOXDISPLAY
toField ROUTE name for SFBool field named bboxDisplay.static java.lang.String
toField_CREATEPARTICLES
toField ROUTE name for SFBool field named createParticles.static java.lang.String
toField_ENABLED
toField ROUTE name for SFBool field named enabled.static java.lang.String
toField_GEOMETRY
toField ROUTE name for SFNode field named geometry.static java.lang.String
toField_LIFETIMEVARIATION
toField ROUTE name for SFFloat field named lifetimeVariation.static java.lang.String
toField_MAXPARTICLES
toField ROUTE name for SFInt32 field named maxParticles.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_PARTICLELIFETIME
toField ROUTE name for SFFloat field named particleLifetime.static java.lang.String
toField_PARTICLESIZE
toField ROUTE name for SFVec2f field named particleSize.static java.lang.String
toField_VISIBLE
toField ROUTE name for SFBool field named visible.static 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
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description ParticleSystemObject()
Constructor for ParticleSystemObject to initialize member variables with default values.ParticleSystemObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description ParticleSystemObject
addColorKey(float newValue)
Add singleton float value to MFFloat colorKey field.ParticleSystemObject
addColorKey(SFFloatObject newValue)
Add singleton SFFloatObject value to MFFloat colorKey field.ParticleSystemObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.ParticleSystemObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.ParticleSystemObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.ParticleSystemObject
addPhysics(ProtoInstanceObject newValue)
Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for physics field.ParticleSystemObject
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).ParticleSystemObject
addTexCoordKey(float newValue)
Add singleton float value to MFFloat texCoordKey field.ParticleSystemObject
addTexCoordKey(SFFloatObject newValue)
Add singleton SFFloatObject value to MFFloat texCoordKey field.ParticleSystemObject
clearAppearance()
Utility method to clear SFNode value of appearance field.ParticleSystemObject
clearColorKey()
Utility method to clear MFFloat value of colorKey field.ParticleSystemObject
clearColorRamp()
Utility method to clear SFNode value of colorRamp field.ParticleSystemObject
clearEmitter()
Utility method to clear SFNode value of emitter field.ParticleSystemObject
clearGeometry()
Utility method to clear SFNode value of geometry field.ParticleSystemObject
clearIS()
Utility method to clear SFNode value of IS field.ParticleSystemObject
clearMetadata()
Utility method to clear SFNode value of metadata field.ParticleSystemObject
clearPhysics()
Utility method to clear MFNode value of physics field.ParticleSystemObject
clearTexCoordKey()
Utility method to clear MFFloat value of texCoordKey field.ParticleSystemObject
clearTexCoordRamp()
Utility method to clear SFNode value of texCoordRamp field.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteNode
findNodeByDEF(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.java.lang.String
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.X3DAppearanceNode
getAppearance()
Provide X3DAppearanceNode instance (using a properly typed node) from inputOutput SFNode field appearance.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.float[]
getColorKey()
Provide array of Float results using RGB values [0..1] from initializeOnly MFFloat field named colorKey.java.util.ArrayList<java.lang.Float>
getColorKeyList()
Utility method to get ArrayList value of MFFloat colorKey field, similar togetColorKey()
.java.lang.String
getColorKeyString()
Utility method to get String value of MFFloat colorKey field, similar togetColorKey()
.X3DColorNode
getColorRamp()
Provide X3DColorNode instance (using a properly typed node) using RGB values [0..1] from initializeOnly SFNode field colorRamp.java.lang.String
getComponent()
Defines X3D component for the ParticleSystem element: ParticleSystemsint
getComponentLevel()
Provides default X3D component level for this element: 2java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.boolean
getCreateParticles()
Provide boolean value from inputOutput SFBool field named createParticles.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.java.lang.String
getElementName()
Provides name of this element: ParticleSystemX3DParticleEmitterNode
getEmitter()
Provide X3DParticleEmitterNode instance (using a properly typed node) from initializeOnly SFNode field emitter.boolean
getEnabled()
Provide boolean value from inputOutput SFBool field named enabled.java.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.X3DGeometryNode
getGeometry()
Provide X3DGeometryNode instance (using a properly typed node) from inputOutput SFNode field geometry.java.lang.String
getGeometryType()
Provide String enumeration value (baseType xs:NMTOKEN) ["LINE" | "POINT" | "QUAD" | "SPRITE" | "TRIANGLE" | "GEOMETRY" | 'etc.'] from initializeOnly SFString field named geometryType.ISObject
getIS()
Provide ISObject 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 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 X3DParticlePhysicsModelNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from initializeOnly MFNode field physics.java.util.ArrayList<X3DNode>
getPhysicsList()
Utility method to get ArrayList value of MFNode physics field, similar togetPhysics()
.float[]
getTexCoordKey()
Provide array of Float results within allowed range of [0,infinity) from initializeOnly MFFloat field named texCoordKey.java.util.ArrayList<java.lang.Float>
getTexCoordKeyList()
Utility method to get ArrayList value of MFFloat texCoordKey field, similar togetTexCoordKey()
.java.lang.String
getTexCoordKeyString()
Utility method to get String value of MFFloat texCoordKey field, similar togetTexCoordKey()
.TextureCoordinate
getTexCoordRamp()
Provide TextureCoordinateObject instance (using a properly typed node) from initializeOnly SFNode field texCoordRamp.java.lang.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
hasColorRamp()
Indicate whether an object is available for initializeOnly SFNode field colorRamp.boolean
hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.boolean
hasEmitter()
Indicate whether an object is available for initializeOnly SFNode field emitter.boolean
hasGeometry()
Indicate whether an object is available for inputOutput SFNode field geometry.boolean
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(java.lang.String DEFvalue)
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.boolean
hasPhysics()
Indicate whether an object is available for initializeOnly MFNode field physics.boolean
hasTexCoordRamp()
Indicate whether an object is available for initializeOnly SFNode field texCoordRamp.void
initialize()
Initialize all member variables to default values.ParticleSystemObject
setAppearance(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field appearance.ParticleSystemObject
setAppearance(X3DAppearanceNode newValue)
Accessor method to assign X3DAppearanceNode instance (using a properly typed node) to inputOutput SFNode field appearance.ParticleSystemObject
setBboxCenter(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.ParticleSystemObject
setBboxCenter(double x, double y, double z)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.ParticleSystemObject
setBboxCenter(float[] newValue)
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.ParticleSystemObject
setBboxCenter(float x, float y, float z)
Assign values to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.ParticleSystemObject
setBboxCenter(SFVec3fObject newValue)
Assign typed object value to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.ParticleSystemObject
setBboxDisplay(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.ParticleSystemObject
setBboxDisplay(SFBoolObject newValue)
Assign typed object value to SFBool bboxDisplay field, similar tosetBboxDisplay(boolean)
.ParticleSystemObject
setBboxSize(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxSize(float[])
.ParticleSystemObject
setBboxSize(double x, double y, double z)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxSize(float[])
.ParticleSystemObject
setBboxSize(float[] newValue)
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.ParticleSystemObject
setBboxSize(float x, float y, float z)
Assign values to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.ParticleSystemObject
setBboxSize(SFVec3fObject newValue)
Assign typed object value to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.ParticleSystemObject
setColorKey(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetColorKey(float[])
.ParticleSystemObject
setColorKey(float[] newValue)
Accessor method to assign Float array to initializeOnly MFFloat field named colorKey.ParticleSystemObject
setColorKey(int[] newValue)
Assign floating-point array value of MFFloat colorKey field, similar tosetColorKey(float[])
.ParticleSystemObject
setColorKey(java.util.ArrayList<java.lang.Float> newValue)
Assign ArrayList value of MFFloat colorKey field, similar tosetColorKey(float[])
.ParticleSystemObject
setColorKey(MFFloatObject newValue)
Assign typed object value to MFFloat colorKey field, similar tosetColorKey(float[])
.ParticleSystemObject
setColorRamp(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field colorRamp.ParticleSystemObject
setColorRamp(X3DColorNode newValue)
Accessor method to assign X3DColorNode instance (using a properly typed node) to initializeOnly SFNode field colorRamp.ParticleSystemObject
setCreateParticles(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named createParticles.ParticleSystemObject
setCreateParticles(SFBoolObject newValue)
Assign typed object value to SFBool createParticles field, similar tosetCreateParticles(boolean)
.ParticleSystemObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.ParticleSystemObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.ParticleSystemObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.ParticleSystemObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.ParticleSystemObject
setEmitter(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field emitter.ParticleSystemObject
setEmitter(X3DParticleEmitterNode newValue)
Accessor method to assign X3DParticleEmitterNode instance (using a properly typed node) to initializeOnly SFNode field emitter.ParticleSystemObject
setEnabled(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named enabled.ParticleSystemObject
setEnabled(SFBoolObject newValue)
Assign typed object value to SFBool enabled field, similar tosetEnabled(boolean)
.ParticleSystemObject
setGeometry(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field geometry.ParticleSystemObject
setGeometry(X3DGeometryNode newValue)
Accessor method to assign X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field geometry.ParticleSystemObject
setGeometryType(java.lang.String newValue)
Accessor method to assign String enumeration value ("LINE" | "POINT" | "QUAD" | "SPRITE" | "TRIANGLE" | "GEOMETRY") to initializeOnly SFString field named geometryType.ParticleSystemObject
setGeometryType(SFStringObject newValue)
Assign typed object value to SFString geometryType field, similar tosetGeometryType(String)
.ParticleSystemObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.ParticleSystemObject
setLifetimeVariation(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetLifetimeVariation(float)
.ParticleSystemObject
setLifetimeVariation(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named lifetimeVariation.ParticleSystemObject
setLifetimeVariation(SFFloatObject newValue)
Assign typed object value to SFFloat lifetimeVariation field, similar tosetLifetimeVariation(float)
.ParticleSystemObject
setMaxParticles(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named maxParticles.ParticleSystemObject
setMaxParticles(SFInt32Object newValue)
Assign typed object value to SFInt32 maxParticles field, similar tosetMaxParticles(int)
.ParticleSystemObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.ParticleSystemObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.ParticleSystemObject
setParticleLifetime(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetParticleLifetime(float)
.ParticleSystemObject
setParticleLifetime(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named particleLifetime.ParticleSystemObject
setParticleLifetime(SFFloatObject newValue)
Assign typed object value to SFFloat particleLifetime field, similar tosetParticleLifetime(float)
.ParticleSystemObject
setParticleSize(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetParticleSize(float[])
.ParticleSystemObject
setParticleSize(double x, double y)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetParticleSize(float[])
.ParticleSystemObject
setParticleSize(float[] newValue)
Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named particleSize.ParticleSystemObject
setParticleSize(float x, float y)
Assign values to SFVec2f particleSize field, similar tosetParticleSize(float[])
.ParticleSystemObject
setParticleSize(SFVec2fObject newValue)
Assign typed object value to SFVec2f particleSize field, similar tosetParticleSize(float[])
.ParticleSystemObject
setPhysics(java.util.ArrayList<X3DParticlePhysicsModelNode> newValue)
Assign ArrayList value of MFNode physics field, similar tosetPhysics(X3DNode[])
.void
setPhysics(X3DNode newValue)
Set single child physics node, replacing prior array of existing nodes (if any).ParticleSystemObject
setPhysics(X3DNode[] newValue)
Accessor method to assign X3DParticlePhysicsModelNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to initializeOnly MFNode field physics.ParticleSystemObject
setTexCoordKey(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetTexCoordKey(float[])
.ParticleSystemObject
setTexCoordKey(float[] newValue)
Accessor method to assign Float array to initializeOnly MFFloat field named texCoordKey.ParticleSystemObject
setTexCoordKey(int[] newValue)
Assign floating-point array value of MFFloat texCoordKey field, similar tosetTexCoordKey(float[])
.ParticleSystemObject
setTexCoordKey(java.util.ArrayList<java.lang.Float> newValue)
Assign ArrayList value of MFFloat texCoordKey field, similar tosetTexCoordKey(float[])
.ParticleSystemObject
setTexCoordKey(MFFloatObject newValue)
Assign typed object value to MFFloat texCoordKey field, similar tosetTexCoordKey(float[])
.ParticleSystemObject
setTexCoordRamp(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field texCoordRamp.ParticleSystemObject
setTexCoordRamp(TextureCoordinate newValue)
Accessor method to assign TextureCoordinateObject instance (using a properly typed node) to initializeOnly SFNode field texCoordRamp.ParticleSystemObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.ParticleSystemObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.ParticleSystemObject
setUSE(ParticleSystemObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.ParticleSystemObject
setVisible(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named visible.ParticleSystemObject
setVisible(SFBoolObject newValue)
Assign typed object value to SFBool visible field, similar tosetVisible(boolean)
.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.java.lang.String
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.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
getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
GEOMETRYTYPE_LINE
public static final java.lang.String GEOMETRYTYPE_LINETooltip: 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). -
GEOMETRYTYPE_POINT
public static final java.lang.String GEOMETRYTYPE_POINTTooltip: 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). -
GEOMETRYTYPE_QUAD
public static final java.lang.String GEOMETRYTYPE_QUADTooltip: 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). -
GEOMETRYTYPE_SPRITE
public static final java.lang.String GEOMETRYTYPE_SPRITETooltip: 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). -
GEOMETRYTYPE_TRIANGLE
public static final java.lang.String GEOMETRYTYPE_TRIANGLETooltip: 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). -
GEOMETRYTYPE_GEOMETRY
public static final java.lang.String GEOMETRYTYPE_GEOMETRYTooltip: 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). -
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: ParticleSystem.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the ParticleSystem element: ParticleSystems- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D ParticleSystems component level for this element: 2- See Also:
- Constant Field Values
-
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_VALUESFVec3f 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_VALUESFBool 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_VALUESFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax). -
COLORKEY_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.Float> COLORKEY_DEFAULT_VALUEMFFloat field named colorKey has default value equal to an empty list. -
COLORRAMP_DEFAULT_VALUE
SFNode field named colorRamp has default value null (Java syntax) or NULL (XML syntax). -
CREATEPARTICLES_DEFAULT_VALUE
public static final boolean CREATEPARTICLES_DEFAULT_VALUESFBool field named createParticles has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
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_VALUESFBool field named enabled has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
GEOMETRY_DEFAULT_VALUE
SFNode field named geometry has default value null (Java syntax) or NULL (XML syntax). -
GEOMETRYTYPE_DEFAULT_VALUE
public static final java.lang.String GEOMETRYTYPE_DEFAULT_VALUESFString field named geometryType has default value "QUAD" (Java syntax) or QUAD (XML syntax).- See Also:
- Constant Field Values
-
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_VALUESFFloat 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_VALUESFInt32 field named maxParticles has default value 200 (Java syntax) or 200 (XML syntax).- See Also:
- Constant Field Values
-
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_VALUESFFloat 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_VALUESFVec2f field named particleSize has default value {0.02f,0.02f} (Java syntax) or 0.02 0.02 (XML syntax). -
TEXCOORDKEY_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.Float> TEXCOORDKEY_DEFAULT_VALUEMFFloat field named texCoordKey has default value equal to an empty list. -
TEXCOORDRAMP_DEFAULT_VALUE
SFNode field named texCoordRamp has default value null (Java syntax) or NULL (XML syntax). -
VISIBLE_DEFAULT_VALUE
public static final boolean VISIBLE_DEFAULT_VALUESFBool field named visible has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes. -
fromField_APPEARANCE
public static final java.lang.String fromField_APPEARANCEfromField ROUTE name for SFNode field named appearance.- See Also:
- Constant Field Values
-
toField_APPEARANCE
public static final java.lang.String toField_APPEARANCEtoField ROUTE name for SFNode field named appearance.- See Also:
- Constant Field Values
-
fromField_BBOXDISPLAY
public static final java.lang.String fromField_BBOXDISPLAYfromField ROUTE name for SFBool field named bboxDisplay.- See Also:
- Constant Field Values
-
toField_BBOXDISPLAY
public static final java.lang.String toField_BBOXDISPLAYtoField ROUTE name for SFBool field named bboxDisplay.- See Also:
- Constant Field Values
-
fromField_CREATEPARTICLES
public static final java.lang.String fromField_CREATEPARTICLESfromField ROUTE name for SFBool field named createParticles.- See Also:
- Constant Field Values
-
toField_CREATEPARTICLES
public static final java.lang.String toField_CREATEPARTICLEStoField ROUTE name for SFBool field named createParticles.- See Also:
- Constant Field Values
-
fromField_ENABLED
public static final java.lang.String fromField_ENABLEDfromField ROUTE name for SFBool field named enabled.- See Also:
- Constant Field Values
-
toField_ENABLED
public static final java.lang.String toField_ENABLEDtoField ROUTE name for SFBool field named enabled.- See Also:
- Constant Field Values
-
fromField_GEOMETRY
public static final java.lang.String fromField_GEOMETRYfromField ROUTE name for SFNode field named geometry.- See Also:
- Constant Field Values
-
toField_GEOMETRY
public static final java.lang.String toField_GEOMETRYtoField ROUTE name for SFNode field named geometry.- See Also:
- Constant Field Values
-
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_ISACTIVE
public static final java.lang.String fromField_ISACTIVEfromField ROUTE name for SFBool field named isActive.- See Also:
- Constant Field Values
-
fromField_LIFETIMEVARIATION
public static final java.lang.String fromField_LIFETIMEVARIATIONfromField ROUTE name for SFFloat field named lifetimeVariation.- See Also:
- Constant Field Values
-
toField_LIFETIMEVARIATION
public static final java.lang.String toField_LIFETIMEVARIATIONtoField ROUTE name for SFFloat field named lifetimeVariation.- See Also:
- Constant Field Values
-
fromField_MAXPARTICLES
public static final java.lang.String fromField_MAXPARTICLESfromField ROUTE name for SFInt32 field named maxParticles.- See Also:
- Constant Field Values
-
toField_MAXPARTICLES
public static final java.lang.String toField_MAXPARTICLEStoField ROUTE name for SFInt32 field named maxParticles.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
fromField_PARTICLELIFETIME
public static final java.lang.String fromField_PARTICLELIFETIMEfromField ROUTE name for SFFloat field named particleLifetime.- See Also:
- Constant Field Values
-
toField_PARTICLELIFETIME
public static final java.lang.String toField_PARTICLELIFETIMEtoField ROUTE name for SFFloat field named particleLifetime.- See Also:
- Constant Field Values
-
fromField_PARTICLESIZE
public static final java.lang.String fromField_PARTICLESIZEfromField ROUTE name for SFVec2f field named particleSize.- See Also:
- Constant Field Values
-
toField_PARTICLESIZE
public static final java.lang.String toField_PARTICLESIZEtoField ROUTE name for SFVec2f field named particleSize.- See Also:
- Constant Field Values
-
fromField_VISIBLE
public static final java.lang.String fromField_VISIBLEfromField ROUTE name for SFBool field named visible.- See Also:
- Constant Field Values
-
toField_VISIBLE
public static final java.lang.String toField_VISIBLEtoField ROUTE name for SFBool field named visible.- See Also:
- Constant Field Values
-
-
Constructor Details
-
ParticleSystemObject
public ParticleSystemObject()Constructor for ParticleSystemObject to initialize member variables with default values. -
ParticleSystemObject
public ParticleSystemObject(java.lang.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 java.lang.String getElementName()Provides name of this element: ParticleSystem- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the ParticleSystem element: ParticleSystems- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 2- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
public java.lang.String getFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
-
getAccessType
public java.lang.String getAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- 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 java.lang.String getContainerFieldDefault()containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
- X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getAppearance
Provide X3DAppearanceNode instance (using a properly typed node) from inputOutput SFNode field appearance.- Specified by:
getAppearance
in interfaceParticleSystem
- Specified by:
getAppearance
in interfaceX3DShapeNode
- 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
Accessor method to assign X3DAppearanceNode instance (using a properly typed node) to inputOutput SFNode field appearance.- Specified by:
setAppearance
in interfaceParticleSystem
- Specified by:
setAppearance
in interfaceX3DShapeNode
- Parameters:
newValue
- is new value for the appearance field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same 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
Utility method to clear SFNode value of appearance field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setAppearance
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field appearance.- Parameters:
newValue
- is new value for the appearance field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setAppearance(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/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
getBboxCenter
in interfaceParticleSystem
- Specified by:
getBboxCenter
in interfaceX3DBoundedObject
- Specified by:
getBboxCenter
in interfaceX3DShapeNode
- Returns:
- value of bboxCenter field
-
setBboxCenter
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/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
setBboxCenter
in interfaceParticleSystem
- Specified by:
setBboxCenter
in interfaceX3DBoundedObject
- Specified by:
setBboxCenter
in interfaceX3DShapeNode
- Parameters:
newValue
- is new value for the bboxCenter field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Assign typed object value to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.- Parameters:
newValue
- is new value for the bboxCenter field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Assign values to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.- Parameters:
newArray
- is new value for field- Returns:
ParticleSystemObject
- 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 interfaceParticleSystem
- Specified by:
getBboxDisplay
in interfaceX3DBoundedObject
- Specified by:
getBboxDisplay
in interfaceX3DShapeNode
- Returns:
- value of bboxDisplay field
-
setBboxDisplay
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 interfaceParticleSystem
- Specified by:
setBboxDisplay
in interfaceX3DBoundedObject
- Specified by:
setBboxDisplay
in interfaceX3DShapeNode
- Parameters:
newValue
- is new value for the bboxDisplay field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxDisplay
Assign typed object value to SFBool bboxDisplay field, similar tosetBboxDisplay(boolean)
.- Parameters:
newValue
- is new value for the bboxDisplay field.- Returns:
ParticleSystemObject
- 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: 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/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
getBboxSize
in interfaceParticleSystem
- Specified by:
getBboxSize
in interfaceX3DBoundedObject
- Specified by:
getBboxSize
in interfaceX3DShapeNode
- Returns:
- value of bboxSize field
-
setBboxSize
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.- Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
- 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/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
setBboxSize
in interfaceParticleSystem
- Specified by:
setBboxSize
in interfaceX3DBoundedObject
- Specified by:
setBboxSize
in interfaceX3DShapeNode
- Parameters:
newValue
- is new value for the bboxSize field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Assign typed object value to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.- Parameters:
newValue
- is new value for the bboxSize field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Assign values to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxSize(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxSize(float[])
.- Parameters:
newArray
- is new value for field- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getColorKey
public float[] getColorKey()Provide array of Float results using RGB values [0..1] from initializeOnly MFFloat field named colorKey.
Tooltip: [0,+infinity) Array of time intervals in seconds, corresponding to particle lifetime, that are used to interpolate colorRamp array values.- Hint: color values are interpolated in linear Hue Saturation Value (HSV) space, similar to ColorInterpolator node.
- Hint: color values are defined as per-vertex color values.
- Warning: if an Appearance and Material nodes are provided, those material properties override colorRamp interpolation.
- Hint: number of colorKey values must match length of the per-vertex colorRamp arrays!
- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Specified by:
getColorKey
in interfaceParticleSystem
- Returns:
- value of colorKey field
-
getColorKeyList
public java.util.ArrayList<java.lang.Float> getColorKeyList()Utility method to get ArrayList value of MFFloat colorKey field, similar togetColorKey()
.- Returns:
- value of colorKey field
-
getColorKeyString
public java.lang.String getColorKeyString()Utility method to get String value of MFFloat colorKey field, similar togetColorKey()
.- Returns:
- value of colorKey field
-
setColorKey
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 colorRamp array values.- Hint: color values are interpolated in linear Hue Saturation Value (HSV) space, similar to ColorInterpolator node.
- Hint: color values are defined as per-vertex color values.
- Warning: if an Appearance and Material nodes are provided, those material properties override colorRamp interpolation.
- Hint: number of colorKey values must match length of the per-vertex colorRamp arrays!
- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Specified by:
setColorKey
in interfaceParticleSystem
- Parameters:
newValue
- is new value for the colorKey field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setColorKey
Assign typed object value to MFFloat colorKey field, similar tosetColorKey(float[])
.- Parameters:
newValue
- is new value for the colorKey field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setColorKey
Assign ArrayList value of MFFloat colorKey field, similar tosetColorKey(float[])
.- Parameters:
newValue
- is new value for the colorKey field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearColorKey
Utility method to clear MFFloat value of colorKey field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setColorKey
Assign floating-point array value of MFFloat colorKey field, similar tosetColorKey(float[])
.- Parameters:
newValue
- is new value for the colorKey field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addColorKey
Add singleton float value to MFFloat colorKey field.- Parameters:
newValue
- is new value to add to the colorKey field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addColorKey
Add singleton SFFloatObject value to MFFloat colorKey field.- Parameters:
newValue
- is new value to add to the colorKey field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setColorKey
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetColorKey(float[])
.- Parameters:
newArray
- is new value for field- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getColorRamp
Provide X3DColorNode instance (using a properly typed node) using RGB values [0..1] from initializeOnly SFNode field colorRamp.- Specified by:
getColorRamp
in interfaceParticleSystem
- Returns:
- value of colorRamp field
- See Also:
Tooltip: [X3DColorNode] The colorRamp Color|ColorRGBA node holds a series of color values to be used at the given colorKey points in time. Hint: color values are defined as per-vertex color values. Warning: if an Appearance and Material nodes are provided, those material properties override colorRamp interpolation. Hint: number of colorKey values must match length of the per-vertex colorRamp arrays! Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
-
setColorRamp
Accessor method to assign X3DColorNode instance (using a properly typed node) to initializeOnly SFNode field colorRamp.- Specified by:
setColorRamp
in interfaceParticleSystem
- Parameters:
newValue
- is new value for the colorRamp field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DColorNode] The colorRamp Color|ColorRGBA node holds a series of color values to be used at the given colorKey points in time. Hint: color values are defined as per-vertex color values. Warning: if an Appearance and Material nodes are provided, those material properties override colorRamp interpolation. Hint: number of colorKey values must match length of the per-vertex colorRamp arrays! Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
-
clearColorRamp
Utility method to clear SFNode value of colorRamp field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setColorRamp
Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field colorRamp.- Parameters:
newValue
- is new value for the colorRamp field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setColorRamp(X3DColorNode)
-
hasColorRamp
public boolean hasColorRamp()Indicate whether an object is available for initializeOnly SFNode field colorRamp.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getColorRamp()
,getColorRampProtoInstance()
-
getCreateParticles
public boolean getCreateParticles()Provide boolean value from inputOutput SFBool field named createParticles.
Tooltip: Enables/disables creation of new particles, while any existing particles remain in existence and continue to animate until the end of their lifetimes.- Hint: if no particles are left in scene, system is considered both active and enabled.
- Specified by:
getCreateParticles
in interfaceParticleSystem
- Returns:
- value of createParticles field
-
setCreateParticles
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 interfaceParticleSystem
- Parameters:
newValue
- is new value for the createParticles field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCreateParticles
Assign typed object value to SFBool createParticles field, similar tosetCreateParticles(boolean)
.- Parameters:
newValue
- is new value for the createParticles field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getEmitter
Provide X3DParticleEmitterNode instance (using a properly typed node) from initializeOnly SFNode field emitter.- Specified by:
getEmitter
in interfaceParticleSystem
- 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
Accessor method to assign X3DParticleEmitterNode instance (using a properly typed node) to initializeOnly SFNode field emitter.- Specified by:
setEmitter
in interfaceParticleSystem
- Parameters:
newValue
- is new value for the emitter field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same 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
Utility method to clear SFNode value of emitter field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setEmitter
Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field emitter.- Parameters:
newValue
- is new value for the emitter field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setEmitter(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 interfaceParticleSystem
- Returns:
- value of enabled field
-
setEnabled
Accessor method to assign boolean value to inputOutput SFBool field named enabled.
Tooltip: Enables/disables node operation. *- Specified by:
setEnabled
in interfaceParticleSystem
- Parameters:
newValue
- is new value for the enabled field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setEnabled
Assign typed object value to SFBool enabled field, similar tosetEnabled(boolean)
.- Parameters:
newValue
- is new value for the enabled field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getGeometry
Provide X3DGeometryNode instance (using a properly typed node) from inputOutput SFNode field geometry.- Specified by:
getGeometry
in interfaceParticleSystem
- Specified by:
getGeometry
in interfaceX3DShapeNode
- 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 http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf Warning: requires X3D profile='Full' or else include lt;component name='Geospatial' level='1'/gt;
-
setGeometry
Accessor method to assign X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field geometry.- Specified by:
setGeometry
in interfaceParticleSystem
- Specified by:
setGeometry
in interfaceX3DShapeNode
- Parameters:
newValue
- is new value for the geometry field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same 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 http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf Warning: requires X3D profile='Full' or else include lt;component name='Geospatial' level='1'/gt;
-
clearGeometry
Utility method to clear SFNode value of geometry field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setGeometry
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field geometry.- Parameters:
newValue
- is new value for the geometry field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setGeometry(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 java.lang.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 http://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 interfaceParticleSystem
- Returns:
- value of geometryType field
-
setGeometryType
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 http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
- Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>
- Specified by:
setGeometryType
in interfaceParticleSystem
- Parameters:
newValue
- is new value for the geometryType field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGeometryType
Assign typed object value to SFString geometryType field, similar tosetGeometryType(String)
.- Parameters:
newValue
- is new value for the geometryType field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
ParticleSystemObject
- 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
Utility method to clear SFNode value of IS field.- Returns:
ParticleSystemObject
- 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 interfaceParticleSystem
- 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 interfaceParticleSystem
- Returns:
- value of lifetimeVariation field
-
setLifetimeVariation
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 interfaceParticleSystem
- Parameters:
newValue
- is new value for the lifetimeVariation field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setLifetimeVariation
Assign typed object value to SFFloat lifetimeVariation field, similar tosetLifetimeVariation(float)
.- Parameters:
newValue
- is new value for the lifetimeVariation field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setLifetimeVariation
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetLifetimeVariation(float)
.- Parameters:
newValue
- is new value for field- Returns:
ParticleSystemObject
- 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 interfaceParticleSystem
- Returns:
- value of maxParticles field
-
setMaxParticles
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 interfaceParticleSystem
- Parameters:
newValue
- is new value for the maxParticles field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMaxParticles
Assign typed object value to SFInt32 maxParticles field, similar tosetMaxParticles(int)
.- Parameters:
newValue
- is new value for the maxParticles field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceParticleSystem
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DShapeNode
- 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceParticleSystem
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DShapeNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setMetadata(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 interfaceParticleSystem
- Returns:
- value of particleLifetime field
-
setParticleLifetime
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 interfaceParticleSystem
- Parameters:
newValue
- is new value for the particleLifetime field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setParticleLifetime
Assign typed object value to SFFloat particleLifetime field, similar tosetParticleLifetime(float)
.- Parameters:
newValue
- is new value for the particleLifetime field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setParticleLifetime
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetParticleLifetime(float)
.- Parameters:
newValue
- is new value for field- Returns:
ParticleSystemObject
- 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 interfaceParticleSystem
- Returns:
- value of particleSize field
-
setParticleSize
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 interfaceParticleSystem
- Parameters:
newValue
- is new value for the particleSize field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setParticleSize
Assign typed object value to SFVec2f particleSize field, similar tosetParticleSize(float[])
.- Parameters:
newValue
- is new value for the particleSize field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setParticleSize
Assign values to SFVec2f particleSize field, similar tosetParticleSize(float[])
.- Parameters:
x
- first componenty
- second component- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setParticleSize
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetParticleSize(float[])
.- Parameters:
x
- first componenty
- second component- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setParticleSize
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetParticleSize(float[])
.- Parameters:
newArray
- is new value for field- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getPhysics
Provide array of X3DParticlePhysicsModelNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) 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 interfaceParticleSystem
- Returns:
- value of physics field
- See Also:
X3DParticlePhysicsModelNode
-
getPhysicsList
Utility method to get ArrayList value of MFNode physics field, similar togetPhysics()
.- Returns:
- value of physics field
-
setPhysics
Accessor method to assign X3DParticlePhysicsModelNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) 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 interfaceParticleSystem
- Parameters:
newValue
- is new value for the physics field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setPhysics
Assign ArrayList value of MFNode physics field, similar tosetPhysics(X3DNode[])
.- Parameters:
newValue
- is new value for the physics field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addPhysics
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:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addPhysics
Add single ProtoInstanceObject (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:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addPhysics
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 interfaceParticleSystem
- Parameters:
newValue
- is new value array to be appended the physics field.
-
setPhysics
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 interfaceParticleSystem
- Parameters:
newValue
- is new node for the physics field (restricted to X3DParticlePhysicsModelNode)
-
clearPhysics
Utility method to clear MFNode value of physics field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasPhysics
public boolean hasPhysics()Indicate whether an object is available for initializeOnly MFNode field physics.- Returns:
- whether a properly typed node or ProtoInstance array or CommentsBlock is available.
- See Also:
getPhysics()
-
getTexCoordKey
public float[] getTexCoordKey()Provide array of Float results within allowed range of [0,infinity) from initializeOnly MFFloat field named texCoordKey.
Tooltip: [0,+infinity) Array of time intervals in seconds, corresponding to particle lifetime, that are used to sequence texCoordRamp array values.- Hint: no interpolation is performed, texture coordinates are simply sequenced in order.
- Hint: texture-coordinate values map textures to vertices in the geometry.
- Hint: number of texCoordKey values must match length of the per-vertex texCoordRamp arrays!.
- Specified by:
getTexCoordKey
in interfaceParticleSystem
- Returns:
- value of texCoordKey field
-
getTexCoordKeyList
public java.util.ArrayList<java.lang.Float> getTexCoordKeyList()Utility method to get ArrayList value of MFFloat texCoordKey field, similar togetTexCoordKey()
.- Returns:
- value of texCoordKey field
-
getTexCoordKeyString
public java.lang.String getTexCoordKeyString()Utility method to get String value of MFFloat texCoordKey field, similar togetTexCoordKey()
.- Returns:
- value of texCoordKey field
-
setTexCoordKey
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 texCoordRamp array values.- Hint: no interpolation is performed, texture coordinates are simply sequenced in order.
- Hint: texture-coordinate values map textures to vertices in the geometry.
- Hint: number of texCoordKey values must match length of the per-vertex texCoordRamp arrays!.
- Specified by:
setTexCoordKey
in interfaceParticleSystem
- Parameters:
newValue
- is new value for the texCoordKey field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTexCoordKey
Assign typed object value to MFFloat texCoordKey field, similar tosetTexCoordKey(float[])
.- Parameters:
newValue
- is new value for the texCoordKey field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTexCoordKey
Assign ArrayList value of MFFloat texCoordKey field, similar tosetTexCoordKey(float[])
.- Parameters:
newValue
- is new value for the texCoordKey field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearTexCoordKey
Utility method to clear MFFloat value of texCoordKey field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setTexCoordKey
Assign floating-point array value of MFFloat texCoordKey field, similar tosetTexCoordKey(float[])
.- Parameters:
newValue
- is new value for the texCoordKey field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addTexCoordKey
Add singleton float value to MFFloat texCoordKey field.- Parameters:
newValue
- is new value to add to the texCoordKey field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addTexCoordKey
Add singleton SFFloatObject value to MFFloat texCoordKey field.- Parameters:
newValue
- is new value to add to the texCoordKey field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTexCoordKey
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetTexCoordKey(float[])
.- Parameters:
newArray
- is new value for field- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getTexCoordRamp
Provide TextureCoordinateObject instance (using a properly typed node) from initializeOnly SFNode field texCoordRamp.- Specified by:
getTexCoordRamp
in interfaceParticleSystem
- Returns:
- value of texCoordRamp field
- See Also:
Tooltip: [TextureCoordinate] texture coordinates of the provided texture(s) in the Appearance node, over time. Particle systems frequently like to change the texture on a particle as it ages, yet there is no good way of accomplishing this through standard interpolators because interpolators have no concept of particle time. This pair of fields hold time-dependent values for the texture coordinates to be applied to the particle. When a particle reaches the next time stamp it moves to the next set of texture coordinates. Hint: texture-coordinate values map textures to vertices in the geometry. Hint: number of texCoordKey values must match length of the per-vertex texCoordRamp arrays!.
-
setTexCoordRamp
Accessor method to assign TextureCoordinateObject instance (using a properly typed node) to initializeOnly SFNode field texCoordRamp.- Specified by:
setTexCoordRamp
in interfaceParticleSystem
- Parameters:
newValue
- is new value for the texCoordRamp field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [TextureCoordinate] texture coordinates of the provided texture(s) in the Appearance node, over time. Particle systems frequently like to change the texture on a particle as it ages, yet there is no good way of accomplishing this through standard interpolators because interpolators have no concept of particle time. This pair of fields hold time-dependent values for the texture coordinates to be applied to the particle. When a particle reaches the next time stamp it moves to the next set of texture coordinates. Hint: texture-coordinate values map textures to vertices in the geometry. Hint: number of texCoordKey values must match length of the per-vertex texCoordRamp arrays!.
-
clearTexCoordRamp
Utility method to clear SFNode value of texCoordRamp field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setTexCoordRamp
Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field texCoordRamp.- Parameters:
newValue
- is new value for the texCoordRamp field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setTexCoordRamp(TextureCoordinate)
-
hasTexCoordRamp
public boolean hasTexCoordRamp()Indicate whether an object is available for initializeOnly SFNode field texCoordRamp.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getTexCoordRamp()
,getTexCoordRampProtoInstance()
-
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 interfaceParticleSystem
- Specified by:
getVisible
in interfaceX3DBoundedObject
- Specified by:
getVisible
in interfaceX3DShapeNode
- Returns:
- value of visible field
-
setVisible
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 interfaceParticleSystem
- Specified by:
setVisible
in interfaceX3DBoundedObject
- Specified by:
setVisible
in interfaceX3DShapeNode
- Parameters:
newValue
- is new value for the visible field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setVisible
Assign typed object value to SFBool visible field, similar tosetVisible(boolean)
.- Parameters:
newValue
- is new value for the visible field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDEF
public java.lang.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 classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.- Parameters:
newValue
- is new value for the DEF field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
public java.lang.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 classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
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: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String)
.- Parameters:
newValue
- is new value for the USE field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
public java.lang.String getCssClass()Provide String value from inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Overrides:
getCssClass
in classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
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:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
ParticleSystemObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
public java.lang.String toStringX3D(int 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 classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
X3DObject.FILE_EXTENSION_X3D
,X3DObject.FILE_EXTENSION_XML
,X3DObject.toStringXML()
,X3DObject.toFileXML(String)
,X3DObject.toFileX3D(String)
, X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
public java.lang.String toStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
X3DObject.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 java.lang.String toStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
X3DObject.FILE_EXTENSION_VRML97
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
-
findElementByNameValue
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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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 classX3DConcreteElement
- 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.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
findElementByNameValue
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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 classX3DConcreteElement
- 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.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasElementByNameValue
public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
findElementByNameValue(String, String)
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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 classX3DConcreteElement
- 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.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasNodeByDEF
public boolean hasNodeByDEF(java.lang.String DEFvalue)Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
findNodeByDEF(String)
-
validate
public java.lang.String validate()Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-