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.
See Also:
X3D Abstract Specification: ParticleSystem, X3D Tooltips: ParticleSystem, X3D Scene Authoring Hints
  • Field Details

  • 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 class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the ParticleSystem element: ParticleSystems
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element
    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 2
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element
    • getFieldType

      public java.lang.String getFieldType​(java.lang.String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
    • getAccessType

      public java.lang.String getAccessType​(java.lang.String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
    • 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 class X3DConcreteNode
      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 class X3DConcreteNode
    • getAppearance

      public X3DAppearanceNode getAppearance()
      Provide X3DAppearanceNode instance (using a properly typed node) from inputOutput SFNode field appearance.
      Specified by:
      getAppearance in interface ParticleSystem
      Specified by:
      getAppearance in interface X3DShapeNode
      Returns:
      value of appearance field
      See Also:
      Tooltip: [X3DAppearanceNode] The appearance field holds an Appearance node that is used for the geometry. All effects, such as material colors and/or multi-textures, are applied to each particle. Hint: if a texture coordinate ramp and key is supplied with this geometry, it shall be used in preference to any automatic texture coordinate generation. Hint: if automatic texture coordinate generation is used, results shall be based on the entire volume that the particles consume, not locally applied to each particle.
    • setAppearance

      public ParticleSystemObject setAppearance​(X3DAppearanceNode newValue)
      Accessor method to assign X3DAppearanceNode instance (using a properly typed node) to inputOutput SFNode field appearance.
      Specified by:
      setAppearance in interface ParticleSystem
      Specified by:
      setAppearance in interface X3DShapeNode
      Parameters:
      newValue - is new value for the appearance field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DAppearanceNode] The appearance field holds an Appearance node that is used for the geometry. All effects, such as material colors and/or multi-textures, are applied to each particle. Hint: if a texture coordinate ramp and key is supplied with this geometry, it shall be used in preference to any automatic texture coordinate generation. Hint: if automatic texture coordinate generation is used, results shall be based on the entire volume that the particles consume, not locally applied to each particle.
    • clearAppearance

      public ParticleSystemObject clearAppearance()
      Utility method to clear SFNode value of appearance field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setAppearance

      public ParticleSystemObject setAppearance​(ProtoInstanceObject newValue)
      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.
      Specified by:
      getBboxCenter in interface ParticleSystem
      Specified by:
      getBboxCenter in interface X3DBoundedObject
      Specified by:
      getBboxCenter in interface X3DShapeNode
      Returns:
      value of bboxCenter field
    • setBboxCenter

      public ParticleSystemObject setBboxCenter​(float[] newValue)
      Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.

      Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.
      Specified by:
      setBboxCenter in interface ParticleSystem
      Specified by:
      setBboxCenter in interface X3DBoundedObject
      Specified by:
      setBboxCenter in interface X3DShapeNode
      Parameters:
      newValue - is new value for the bboxCenter field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public ParticleSystemObject setBboxCenter​(SFVec3fObject newValue)
      Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
      Parameters:
      newValue - is new value for the bboxCenter field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public ParticleSystemObject setBboxCenter​(float x, float y, float z)
      Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public ParticleSystemObject setBboxCenter​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public ParticleSystemObject setBboxCenter​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      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.
      Specified by:
      getBboxSize in interface ParticleSystem
      Specified by:
      getBboxSize in interface X3DBoundedObject
      Specified by:
      getBboxSize in interface X3DShapeNode
      Returns:
      value of bboxSize field
    • setBboxSize

      public ParticleSystemObject setBboxSize​(float[] newValue)
      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.
      Specified by:
      setBboxSize in interface ParticleSystem
      Specified by:
      setBboxSize in interface X3DBoundedObject
      Specified by:
      setBboxSize in interface X3DShapeNode
      Parameters:
      newValue - is new value for the bboxSize field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

      public ParticleSystemObject setBboxSize​(SFVec3fObject newValue)
      Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
      Parameters:
      newValue - is new value for the bboxSize field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

      public ParticleSystemObject setBboxSize​(float x, float y, float z)
      Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

      public ParticleSystemObject setBboxSize​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

      public ParticleSystemObject setBboxSize​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      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 interface ParticleSystem
      Returns:
      value of colorKey field
    • getColorKeyList

      public java.util.ArrayList<java.lang.Float> getColorKeyList()
      Utility method to get ArrayList value of MFFloat colorKey field, similar to getColorKey().
      Returns:
      value of colorKey field
    • getColorKeyString

      public java.lang.String getColorKeyString()
      Utility method to get String value of MFFloat colorKey field, similar to getColorKey().
      Returns:
      value of colorKey field
    • setColorKey

      public ParticleSystemObject setColorKey​(float[] newValue)
      Accessor method to assign Float array to initializeOnly MFFloat field named colorKey.

      Tooltip: [0,+infinity) Array of time intervals in seconds, corresponding to particle lifetime, that are used to interpolate 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 interface ParticleSystem
      Parameters:
      newValue - is new value for the colorKey field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setColorKey

      public ParticleSystemObject setColorKey​(MFFloatObject newValue)
      Assign typed object value to MFFloat colorKey field, similar to setColorKey(float[]).
      Parameters:
      newValue - is new value for the colorKey field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setColorKey

      public ParticleSystemObject setColorKey​(java.util.ArrayList<java.lang.Float> newValue)
      Assign ArrayList value of MFFloat colorKey field, similar to setColorKey(float[]).
      Parameters:
      newValue - is new value for the colorKey field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearColorKey

      public ParticleSystemObject clearColorKey()
      Utility method to clear MFFloat value of colorKey field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setColorKey

      public ParticleSystemObject setColorKey​(int[] newValue)
      Assign floating-point array value of MFFloat colorKey field, similar to setColorKey(float[]).
      Parameters:
      newValue - is new value for the colorKey field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addColorKey

      public ParticleSystemObject addColorKey​(float newValue)
      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

      public ParticleSystemObject addColorKey​(SFFloatObject newValue)
      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

      public ParticleSystemObject setColorKey​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setColorKey(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getColorRamp

      public X3DColorNode getColorRamp()
      Provide X3DColorNode instance (using a properly typed node) using RGB values [0..1] from initializeOnly SFNode field colorRamp.
      Specified by:
      getColorRamp in interface ParticleSystem
      Returns:
      value of colorRamp field
      See Also:
      Tooltip: [X3DColorNode] The colorRamp Color|ColorRGBA node holds a series of 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

      public ParticleSystemObject setColorRamp​(X3DColorNode newValue)
      Accessor method to assign X3DColorNode instance (using a properly typed node) to initializeOnly SFNode field colorRamp.
      Specified by:
      setColorRamp in interface ParticleSystem
      Parameters:
      newValue - is new value for the colorRamp field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same 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

      public ParticleSystemObject clearColorRamp()
      Utility method to clear SFNode value of colorRamp field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setColorRamp

      public ParticleSystemObject setColorRamp​(ProtoInstanceObject newValue)
      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 interface ParticleSystem
      Returns:
      value of createParticles field
    • setCreateParticles

      public ParticleSystemObject setCreateParticles​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named createParticles.

      Tooltip: Enables/disables creation of new particles, while any existing particles remain in existence and continue to animate until the end of their lifetimes.
      • Hint: if no particles are left in scene, system is considered both active and enabled.
      Specified by:
      setCreateParticles in interface ParticleSystem
      Parameters:
      newValue - is new value for the createParticles field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCreateParticles

      public ParticleSystemObject setCreateParticles​(SFBoolObject newValue)
      Assign typed object value to SFBool createParticles field, similar to setCreateParticles(boolean).
      Parameters:
      newValue - is new value for the createParticles field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getEmitter

      public X3DParticleEmitterNode getEmitter()
      Provide X3DParticleEmitterNode instance (using a properly typed node) from initializeOnly SFNode field emitter.
      Specified by:
      getEmitter in interface ParticleSystem
      Returns:
      value of emitter field
      See Also:
      Tooltip: [X3DParticleEmitterNode] The emitter field specifies the type of emitter geometry and properties that the particles are given for their initial positions. *
    • setEmitter

      public ParticleSystemObject setEmitter​(X3DParticleEmitterNode newValue)
      Accessor method to assign X3DParticleEmitterNode instance (using a properly typed node) to initializeOnly SFNode field emitter.
      Specified by:
      setEmitter in interface ParticleSystem
      Parameters:
      newValue - is new value for the emitter field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DParticleEmitterNode] The emitter field specifies the type of emitter geometry and properties that the particles are given for their initial positions. *
    • clearEmitter

      public ParticleSystemObject clearEmitter()
      Utility method to clear SFNode value of emitter field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setEmitter

      public ParticleSystemObject setEmitter​(ProtoInstanceObject newValue)
      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 interface ParticleSystem
      Returns:
      value of enabled field
    • setEnabled

      public ParticleSystemObject setEnabled​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Specified by:
      setEnabled in interface ParticleSystem
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setEnabled

      public ParticleSystemObject setEnabled​(SFBoolObject newValue)
      Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getGeometry

      public X3DGeometryNode getGeometry()
      Provide X3DGeometryNode instance (using a properly typed node) from inputOutput SFNode field geometry.
      Specified by:
      getGeometry in interface ParticleSystem
      Specified by:
      getGeometry in interface X3DShapeNode
      Returns:
      value of geometry field
      See Also:
      Tooltip: [X3DGeometryNode] 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

      public ParticleSystemObject setGeometry​(X3DGeometryNode newValue)
      Accessor method to assign X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field geometry.
      Specified by:
      setGeometry in interface ParticleSystem
      Specified by:
      setGeometry in interface X3DShapeNode
      Parameters:
      newValue - is new value for the geometry field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same 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

      public ParticleSystemObject clearGeometry()
      Utility method to clear SFNode value of geometry field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setGeometry

      public ParticleSystemObject setGeometry​(ProtoInstanceObject newValue)
      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 particleSystemGeometryTypeValues) ["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 &lt;component name='Geospatial' level='1'/&gt;


      Available enumeration values for string comparison: LINE, POINT, QUAD, SPRITE, TRIANGLE, GEOMETRY.
      Specified by:
      getGeometryType in interface ParticleSystem
      Returns:
      value of geometryType field
    • setGeometryType

      public ParticleSystemObject setGeometryType​(java.lang.String newValue)
      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 &lt;component name='Geospatial' level='1'/&gt;
      Specified by:
      setGeometryType in interface ParticleSystem
      Parameters:
      newValue - is new value for the geometryType field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGeometryType

      public ParticleSystemObject setGeometryType​(SFStringObject newValue)
      Assign typed object value to SFString geometryType field, similar to setGeometryType(String).
      Parameters:
      newValue - is new value for the geometryType field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getIS

      public ISObject getIS()
      Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • setIS

      public ParticleSystemObject setIS​(ISObject newValue)
      Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      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

      public ParticleSystemObject 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 interface ParticleSystem
      Returns:
      value of isActive field
    • getLifetimeVariation

      public float getLifetimeVariation()
      Provide float value within allowed range of [0,1] from inputOutput SFFloat field named lifetimeVariation.

      Tooltip: [0,1) TODO not properly defined in X3D spedification. Multiplier for the randomness used to control the range of possible output values. The bigger the value, the more random the output and the bigger the range of initial values possible.
      • Hint: variation of zero does not allow any randomness.
      Specified by:
      getLifetimeVariation in interface ParticleSystem
      Returns:
      value of lifetimeVariation field
    • setLifetimeVariation

      public ParticleSystemObject setLifetimeVariation​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named lifetimeVariation.

      Tooltip: [0,1) TODO not properly defined in X3D spedification. Multiplier for the randomness used to control the range of possible output values. The bigger the value, the more random the output and the bigger the range of initial values possible.
      • Hint: variation of zero does not allow any randomness.
      Specified by:
      setLifetimeVariation in interface ParticleSystem
      Parameters:
      newValue - is new value for the lifetimeVariation field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setLifetimeVariation

      public ParticleSystemObject setLifetimeVariation​(SFFloatObject newValue)
      Assign typed object value to SFFloat lifetimeVariation field, similar to setLifetimeVariation(float).
      Parameters:
      newValue - is new value for the lifetimeVariation field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setLifetimeVariation

      public ParticleSystemObject setLifetimeVariation​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setLifetimeVariation(float).
      Parameters:
      newValue - is new value for field
      Returns:
      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 interface ParticleSystem
      Returns:
      value of maxParticles field
    • setMaxParticles

      public ParticleSystemObject setMaxParticles​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named maxParticles.

      Tooltip: [0,+infinity) Maximum number of particles to be generated at one time (subject to player limitations). *
      Specified by:
      setMaxParticles in interface ParticleSystem
      Parameters:
      newValue - is new value for the maxParticles field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMaxParticles

      public ParticleSystemObject setMaxParticles​(SFInt32Object newValue)
      Assign typed object value to SFInt32 maxParticles field, similar to setMaxParticles(int).
      Parameters:
      newValue - is new value for the maxParticles field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface ParticleSystem
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DShapeNode
      Returns:
      value of metadata field
      See Also:
      getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public ParticleSystemObject setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface ParticleSystem
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DShapeNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

      public ParticleSystemObject clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMetadata

      public ParticleSystemObject setMetadata​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      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 interface ParticleSystem
      Returns:
      value of particleLifetime field
    • setParticleLifetime

      public ParticleSystemObject setParticleLifetime​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named particleLifetime.

      Tooltip: [0,+infinity) TODO not properly defined in X3D spedification. Particle animation lifetime in base time units (default is seconds). *
      Specified by:
      setParticleLifetime in interface ParticleSystem
      Parameters:
      newValue - is new value for the particleLifetime field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setParticleLifetime

      public ParticleSystemObject setParticleLifetime​(SFFloatObject newValue)
      Assign typed object value to SFFloat particleLifetime field, similar to setParticleLifetime(float).
      Parameters:
      newValue - is new value for the particleLifetime field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setParticleLifetime

      public ParticleSystemObject setParticleLifetime​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setParticleLifetime(float).
      Parameters:
      newValue - is new value for field
      Returns:
      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 interface ParticleSystem
      Returns:
      value of particleSize field
    • setParticleSize

      public ParticleSystemObject setParticleSize​(float[] newValue)
      Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named particleSize.

      Tooltip: [0,+infinity) particleSize describes width and height dimensions for each particle in length base units (default is meters). Changing this value dynamically will only change new particles created after the change.
      • Hint: particles created before this timestamp will remain at the old size.
      • Hint: his field only effects particles using LINE, QUAD, SPRITE, and TRIANGLE geometry types.
      Specified by:
      setParticleSize in interface ParticleSystem
      Parameters:
      newValue - is new value for the particleSize field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setParticleSize

      public ParticleSystemObject setParticleSize​(SFVec2fObject newValue)
      Assign typed object value to SFVec2f particleSize field, similar to setParticleSize(float[]).
      Parameters:
      newValue - is new value for the particleSize field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setParticleSize

      public ParticleSystemObject setParticleSize​(float x, float y)
      Assign values to SFVec2f particleSize field, similar to setParticleSize(float[]).
      Parameters:
      x - first component
      y - second component
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setParticleSize

      public ParticleSystemObject setParticleSize​(double x, double y)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setParticleSize(float[]).
      Parameters:
      x - first component
      y - second component
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setParticleSize

      public ParticleSystemObject setParticleSize​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setParticleSize(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getPhysics

      public X3DNode[] getPhysics()
      Provide array of 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 interface ParticleSystem
      Returns:
      value of physics field
      See Also:
      X3DParticlePhysicsModelNode
    • getPhysicsList

      public java.util.ArrayList<X3DNode> getPhysicsList()
      Utility method to get ArrayList value of MFNode physics field, similar to getPhysics().
      Returns:
      value of physics field
    • setPhysics

      public ParticleSystemObject setPhysics​(X3DNode[] newValue)
      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 interface ParticleSystem
      Parameters:
      newValue - is new value for the physics field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPhysics

      public ParticleSystemObject setPhysics​(java.util.ArrayList<X3DParticlePhysicsModelNode> newValue)
      Assign ArrayList value of MFNode physics field, similar to setPhysics(X3DNode[]).
      Parameters:
      newValue - is new value for the physics field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addPhysics

      public ParticleSystemObject addPhysics​(X3DNode newValue)
      Add single child node to existing array of physics nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DParticlePhysicsModelNode and ProtoInstance.
      Parameters:
      newValue - is new value to be appended the physics field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addPhysics

      public ParticleSystemObject addPhysics​(ProtoInstanceObject newValue)
      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

      public void addPhysics​(X3DNode[] newValue)
      Add array of child physics nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DParticlePhysicsModelNode.
      Specified by:
      addPhysics in interface ParticleSystem
      Parameters:
      newValue - is new value array to be appended the physics field.
    • setPhysics

      public void setPhysics​(X3DNode newValue)
      Set single child physics node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DParticlePhysicsModelNode.
      Specified by:
      setPhysics in interface ParticleSystem
      Parameters:
      newValue - is new node for the physics field (restricted to X3DParticlePhysicsModelNode)
    • clearPhysics

      public ParticleSystemObject clearPhysics()
      Utility method to clear MFNode value of physics field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasPhysics

      public boolean hasPhysics()
      Indicate whether an object is available for initializeOnly MFNode field physics.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:
      getPhysics()
    • getTexCoordKey

      public float[] getTexCoordKey()
      Provide array of Float results within allowed range of [0,infinity) from initializeOnly MFFloat field named texCoordKey.

      Tooltip: [0,+infinity) Array of time intervals in seconds, corresponding to particle lifetime, that are used to sequence texCoordRamp array values.
      • Hint: no interpolation is performed, texture coordinates are simply sequenced in order.
      • Hint: texture-coordinate values map textures to vertices in the geometry.
      • Hint: number of texCoordKey values must match length of the per-vertex texCoordRamp arrays!.
      Specified by:
      getTexCoordKey in interface ParticleSystem
      Returns:
      value of texCoordKey field
    • getTexCoordKeyList

      public java.util.ArrayList<java.lang.Float> getTexCoordKeyList()
      Utility method to get ArrayList value of MFFloat texCoordKey field, similar to getTexCoordKey().
      Returns:
      value of texCoordKey field
    • getTexCoordKeyString

      public java.lang.String getTexCoordKeyString()
      Utility method to get String value of MFFloat texCoordKey field, similar to getTexCoordKey().
      Returns:
      value of texCoordKey field
    • setTexCoordKey

      public ParticleSystemObject setTexCoordKey​(float[] newValue)
      Accessor method to assign Float array to initializeOnly MFFloat field named texCoordKey.

      Tooltip: [0,+infinity) Array of time intervals in seconds, corresponding to particle lifetime, that are used to sequence texCoordRamp array values.
      • Hint: no interpolation is performed, texture coordinates are simply sequenced in order.
      • Hint: texture-coordinate values map textures to vertices in the geometry.
      • Hint: number of texCoordKey values must match length of the per-vertex texCoordRamp arrays!.
      Specified by:
      setTexCoordKey in interface ParticleSystem
      Parameters:
      newValue - is new value for the texCoordKey field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTexCoordKey

      public ParticleSystemObject setTexCoordKey​(MFFloatObject newValue)
      Assign typed object value to MFFloat texCoordKey field, similar to setTexCoordKey(float[]).
      Parameters:
      newValue - is new value for the texCoordKey field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTexCoordKey

      public ParticleSystemObject setTexCoordKey​(java.util.ArrayList<java.lang.Float> newValue)
      Assign ArrayList value of MFFloat texCoordKey field, similar to setTexCoordKey(float[]).
      Parameters:
      newValue - is new value for the texCoordKey field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearTexCoordKey

      public ParticleSystemObject clearTexCoordKey()
      Utility method to clear MFFloat value of texCoordKey field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setTexCoordKey

      public ParticleSystemObject setTexCoordKey​(int[] newValue)
      Assign floating-point array value of MFFloat texCoordKey field, similar to setTexCoordKey(float[]).
      Parameters:
      newValue - is new value for the texCoordKey field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addTexCoordKey

      public ParticleSystemObject addTexCoordKey​(float newValue)
      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

      public ParticleSystemObject addTexCoordKey​(SFFloatObject newValue)
      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

      public ParticleSystemObject setTexCoordKey​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setTexCoordKey(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getTexCoordRamp

      public TextureCoordinate getTexCoordRamp()
      Provide TextureCoordinateObject instance (using a properly typed node) from initializeOnly SFNode field texCoordRamp.
      Specified by:
      getTexCoordRamp in interface ParticleSystem
      Returns:
      value of texCoordRamp field
      See Also:
      Tooltip: [TextureCoordinate] texture coordinates of the provided texture(s) in the Appearance node, over time. Particle systems frequently like to change the texture on a particle as it ages, yet there is no good way of accomplishing this through standard interpolators because interpolators have no concept of particle time. This pair of fields hold time-dependent values for the texture coordinates to be applied to the particle. When a particle reaches the next time stamp it moves to the next set of texture coordinates. Hint: texture-coordinate values map textures to vertices in the geometry. Hint: number of texCoordKey values must match length of the per-vertex texCoordRamp arrays!.
    • setTexCoordRamp

      public ParticleSystemObject setTexCoordRamp​(TextureCoordinate newValue)
      Accessor method to assign TextureCoordinateObject instance (using a properly typed node) to initializeOnly SFNode field texCoordRamp.
      Specified by:
      setTexCoordRamp in interface ParticleSystem
      Parameters:
      newValue - is new value for the texCoordRamp field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [TextureCoordinate] texture coordinates of the provided texture(s) in the Appearance node, over time. Particle systems frequently like to change the texture on a particle as it ages, yet there is no good way of accomplishing this through standard interpolators because interpolators have no concept of particle time. This pair of fields hold time-dependent values for the texture coordinates to be applied to the particle. When a particle reaches the next time stamp it moves to the next set of texture coordinates. Hint: texture-coordinate values map textures to vertices in the geometry. Hint: number of texCoordKey values must match length of the per-vertex texCoordRamp arrays!.
    • clearTexCoordRamp

      public ParticleSystemObject clearTexCoordRamp()
      Utility method to clear SFNode value of texCoordRamp field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setTexCoordRamp

      public ParticleSystemObject setTexCoordRamp​(ProtoInstanceObject newValue)
      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()
    • 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.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

      public final ParticleSystemObject setDEF​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

      public ParticleSystemObject setDEF​(SFStringObject newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same 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 class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setUSE

      public final ParticleSystemObject setUSE​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.


      Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

      Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Specified by:
      setUSE in class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public ParticleSystemObject setUSE​(SFStringObject newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same 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 class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final ParticleSystemObject setCssClass​(java.lang.String newValue)
      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 class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public ParticleSystemObject setCssClass​(SFStringObject newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

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

      Warning: note that the setUSE() method 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

      public ParticleSystemObject addComments​(java.lang.String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public ParticleSystemObject addComments​(java.lang.String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public ParticleSystemObject addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      ParticleSystemObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • toStringX3D

      public java.lang.String toStringX3D​(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
      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 class X3DConcreteElement
      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 class X3DConcreteElement
      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

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, 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 class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.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 class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.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

      public X3DConcreteNode findNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      Warning: 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 class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:
      findElementByNameValue(String), X3DConcreteElement.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 class X3DConcreteElement
      Returns:
      validation results (if any)