Class VolumeEmitterObject

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.ParticleSystems.VolumeEmitterObject
All Implemented Interfaces:
X3DNode, VolumeEmitter, X3DParticleEmitterNode

public class VolumeEmitterObject
extends X3DConcreteNode
implements VolumeEmitter
VolumeEmitter emits particles from a random position confined within the given closed geometry volume.

X3D node tooltip: (X3D version 3.2 or later) [X3DParticleEmitterNode] VolumeEmitter emits particles from a random position confined within the given closed geometry volume.
  • Hint: otherwise, a VolumeEmitter node acts like a PolylineEmitter node.

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: VolumeEmitter, X3D Tooltips: VolumeEmitter, X3D Scene Authoring Hints: Volume
  • Field Details

  • Constructor Details

    • VolumeEmitterObject

      public VolumeEmitterObject()
      Constructor for VolumeEmitterObject to initialize member variables with default values.
    • VolumeEmitterObject

      public VolumeEmitterObject​(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: VolumeEmitter
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the VolumeEmitter 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
    • getCoord

      public X3DCoordinateNode getCoord()
      Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.
      Specified by:
      getCoord in interface VolumeEmitter
      Returns:
      value of coord field
      See Also:
      Tooltip: [X3DCoordinateNode] Coordinates for the geometry used as the emitting volume. *
    • setCoord

      public VolumeEmitterObject setCoord​(X3DCoordinateNode newValue)
      Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.
      Specified by:
      setCoord in interface VolumeEmitter
      Parameters:
      newValue - is new value for the coord field.
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DCoordinateNode] Coordinates for the geometry used as the emitting volume. *
    • clearCoord

      public VolumeEmitterObject clearCoord()
      Utility method to clear SFNode value of coord field.
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setCoord

      public VolumeEmitterObject setCoord​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field coord.
      Parameters:
      newValue - is new value for the coord field.
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setCoord(X3DCoordinateNode)
    • hasCoord

      public boolean hasCoord()
      Indicate whether an object is available for inputOutput SFNode field coord.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getCoord(), getCoordProtoInstance()
    • getCoordIndex

      public int[] getCoordIndex()
      Provide array of Integer results within allowed range of [-1,infinity) from initializeOnly MFInt32 field named coordIndex.

      Tooltip: [-1,+infinity) coordIndex indices are applied to contained Coordinate values in order to define randomly generated initial geometry of the particles.
      • Warning: coordIndex is required in order to connect contained coordinate point values.
      Specified by:
      getCoordIndex in interface VolumeEmitter
      Returns:
      value of coordIndex field
    • getCoordIndexList

      public java.util.ArrayList<java.lang.Integer> getCoordIndexList()
      Utility method to get ArrayList value of MFInt32 coordIndex field, similar to getCoordIndex().
      Returns:
      value of coordIndex field
    • setCoordIndex

      public VolumeEmitterObject setCoordIndex​(int[] newValue)
      Accessor method to assign Integer array to initializeOnly MFInt32 field named coordIndex.

      Tooltip: [-1,+infinity) coordIndex indices are applied to contained Coordinate values in order to define randomly generated initial geometry of the particles.
      • Warning: coordIndex is required in order to connect contained coordinate point values.
      Specified by:
      setCoordIndex in interface VolumeEmitter
      Parameters:
      newValue - is new value for the coordIndex field.
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCoordIndex

      public VolumeEmitterObject setCoordIndex​(MFInt32Object newValue)
      Assign typed object value to MFInt32 coordIndex field, similar to setCoordIndex(int[]).
      Parameters:
      newValue - is new value for the coordIndex field.
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCoordIndex

      public VolumeEmitterObject setCoordIndex​(java.util.ArrayList<java.lang.Integer> newValue)
      Assign ArrayList value of MFInt32 coordIndex field, similar to setCoordIndex(int[]).
      Parameters:
      newValue - is new value for the coordIndex field.
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearCoordIndex

      public VolumeEmitterObject clearCoordIndex()
      Utility method to clear MFInt32 value of coordIndex field.
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addCoordIndex

      public VolumeEmitterObject addCoordIndex​(int newValue)
      Add singleton int value to MFInt32 coordIndex field.
      Parameters:
      newValue - is new value to add to the coordIndex field.
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addCoordIndex

      public VolumeEmitterObject addCoordIndex​(SFInt32Object newValue)
      Add singleton SFInt32Object value to MFInt32 coordIndex field.
      Parameters:
      newValue - is new value to add to the coordIndex field.
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDirection

      public float[] getDirection()
      Provide array of 3-tuple float results within allowed range of [-1,1] from inputOutput SFVec3f field named direction.

      Tooltip: Initial direction from which particles emanate. *
      Specified by:
      getDirection in interface VolumeEmitter
      Returns:
      value of direction field
    • setDirection

      public VolumeEmitterObject setDirection​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.

      Tooltip: Initial direction from which particles emanate. *
      Specified by:
      setDirection in interface VolumeEmitter
      Parameters:
      newValue - is new value for the direction field.
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDirection

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

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

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

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

      public boolean getInternal()
      Provide boolean value from initializeOnly SFBool field named internal.

      Tooltip: TODO, X3D specification is undefined. *
      Specified by:
      getInternal in interface VolumeEmitter
      Returns:
      value of internal field
    • setInternal

      public VolumeEmitterObject setInternal​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named internal.

      Tooltip: TODO, X3D specification is undefined. *
      Specified by:
      setInternal in interface VolumeEmitter
      Parameters:
      newValue - is new value for the internal field.
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setInternal

      public VolumeEmitterObject setInternal​(SFBoolObject newValue)
      Assign typed object value to SFBool internal field, similar to setInternal(boolean).
      Parameters:
      newValue - is new value for the internal field.
      Returns:
      VolumeEmitterObject - 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 VolumeEmitterObject 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:
      VolumeEmitterObject - 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 VolumeEmitterObject clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      VolumeEmitterObject - 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()
    • getMass

      public float getMass()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named mass.

      Tooltip: [0,+infinity) Basic mass of each particle, defined in mass base units (default is kilograms).
      Specified by:
      getMass in interface VolumeEmitter
      Specified by:
      getMass in interface X3DParticleEmitterNode
      Returns:
      value of mass field
    • setMass

      public VolumeEmitterObject setMass​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named mass.

      Tooltip: [0,+infinity) Basic mass of each particle, defined in mass base units (default is kilograms).
      Specified by:
      setMass in interface VolumeEmitter
      Specified by:
      setMass in interface X3DParticleEmitterNode
      Parameters:
      newValue - is new value for the mass field.
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMass

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

      public VolumeEmitterObject setMass​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMass(float).
      Parameters:
      newValue - is new value for field
      Returns:
      VolumeEmitterObject - 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 VolumeEmitter
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DParticleEmitterNode
      Returns:
      value of metadata field
      See Also:
      getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public VolumeEmitterObject setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface VolumeEmitter
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DParticleEmitterNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      VolumeEmitterObject - 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 VolumeEmitterObject clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMetadata

      public VolumeEmitterObject 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:
      VolumeEmitterObject - 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
    • getSpeed

      public float getSpeed()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named speed.

      Tooltip: [0,+infinity) Initial linear speed (default is m/s) imparted to all particles along their direction of movement. *
      Specified by:
      getSpeed in interface VolumeEmitter
      Specified by:
      getSpeed in interface X3DParticleEmitterNode
      Returns:
      value of speed field
    • setSpeed

      public VolumeEmitterObject setSpeed​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named speed.

      Tooltip: [0,+infinity) Initial linear speed (default is m/s) imparted to all particles along their direction of movement. *
      Specified by:
      setSpeed in interface VolumeEmitter
      Specified by:
      setSpeed in interface X3DParticleEmitterNode
      Parameters:
      newValue - is new value for the speed field.
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSpeed

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

      public VolumeEmitterObject setSpeed​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSpeed(float).
      Parameters:
      newValue - is new value for field
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSurfaceArea

      public float getSurfaceArea()
      Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named surfaceArea.

      Tooltip: [0,+infinity) Particle surface area in area base units (default is meters squared). Surface area is used for calculations such as wind effects per particle.
      • Hint: surfaceArea value represents average frontal area presented to the wind.
      • Hint: assumes spherical model for each particle (i.e., surface area is the same regardless of direction).
      Specified by:
      getSurfaceArea in interface VolumeEmitter
      Specified by:
      getSurfaceArea in interface X3DParticleEmitterNode
      Returns:
      value of surfaceArea field
    • setSurfaceArea

      public VolumeEmitterObject setSurfaceArea​(float newValue)
      Accessor method to assign float value to initializeOnly SFFloat field named surfaceArea.

      Tooltip: [0,+infinity) Particle surface area in area base units (default is meters squared). Surface area is used for calculations such as wind effects per particle.
      • Hint: surfaceArea value represents average frontal area presented to the wind.
      • Hint: assumes spherical model for each particle (i.e., surface area is the same regardless of direction).
      Specified by:
      setSurfaceArea in interface VolumeEmitter
      Specified by:
      setSurfaceArea in interface X3DParticleEmitterNode
      Parameters:
      newValue - is new value for the surfaceArea field.
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSurfaceArea

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

      public VolumeEmitterObject setSurfaceArea​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSurfaceArea(float).
      Parameters:
      newValue - is new value for field
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getVariation

      public float getVariation()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named variation.

      Tooltip: [0,+infinity) 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 possible initial values possible.
      • Hint: variation of zero does not allow any randomness.
      Specified by:
      getVariation in interface VolumeEmitter
      Specified by:
      getVariation in interface X3DParticleEmitterNode
      Returns:
      value of variation field
    • setVariation

      public VolumeEmitterObject setVariation​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named variation.

      Tooltip: [0,+infinity) 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 possible initial values possible.
      • Hint: variation of zero does not allow any randomness.
      Specified by:
      setVariation in interface VolumeEmitter
      Specified by:
      setVariation in interface X3DParticleEmitterNode
      Parameters:
      newValue - is new value for the variation field.
      Returns:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setVariation

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

      public VolumeEmitterObject setVariation​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setVariation(float).
      Parameters:
      newValue - is new value for field
      Returns:
      VolumeEmitterObject - 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.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

      public final VolumeEmitterObject 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:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

      public VolumeEmitterObject 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:
      VolumeEmitterObject - 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 VolumeEmitterObject 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:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public VolumeEmitterObject 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:
      VolumeEmitterObject - 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 VolumeEmitterObject 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:
      VolumeEmitterObject - 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 VolumeEmitterObject 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:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public VolumeEmitterObject setUSE​(VolumeEmitterObject 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:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

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

      public VolumeEmitterObject 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:
      VolumeEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public VolumeEmitterObject addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      VolumeEmitterObject - 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)