Class ExplosionEmitterObject

    • Field Detail

      • NAME

        public static final java.lang.String NAME
        String constant NAME provides name of this element: ExplosionEmitter.
        See Also:
        Constant Field Values
      • COMPONENT

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the ExplosionEmitter element: ParticleSystems
        See Also:
        Constant Field Values
      • LEVEL

        public static final int LEVEL
        Integer constant LEVEL provides default X3D ParticleSystems component level for this element: 1
        See Also:
        Constant Field Values
      • IS_DEFAULT_VALUE

        public static final ISObject IS_DEFAULT_VALUE
        SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
      • MASS_DEFAULT_VALUE

        public static final float MASS_DEFAULT_VALUE
        SFFloat field named mass has default value 0f (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • METADATA_DEFAULT_VALUE

        public static final X3DMetadataObject METADATA_DEFAULT_VALUE
        SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
      • POSITION_DEFAULT_VALUE

        public static final float[] POSITION_DEFAULT_VALUE
        SFVec3f field named position has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
      • SPEED_DEFAULT_VALUE

        public static final float SPEED_DEFAULT_VALUE
        SFFloat field named speed has default value 0f (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • SURFACEAREA_DEFAULT_VALUE

        public static final float SURFACEAREA_DEFAULT_VALUE
        SFFloat field named surfaceArea has default value 0f (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • VARIATION_DEFAULT_VALUE

        public static final float VARIATION_DEFAULT_VALUE
        SFFloat field named variation has default value 0.25f (Java syntax) or 0.25 (XML syntax).
        See Also:
        Constant Field Values
      • fromField_IS

        public static final java.lang.String fromField_IS
        fromField ROUTE name for SFNode field named IS.
        See Also:
        Constant Field Values
      • fromField_MASS

        public static final java.lang.String fromField_MASS
        fromField ROUTE name for SFFloat field named mass.
        See Also:
        Constant Field Values
      • toField_MASS

        public static final java.lang.String toField_MASS
        toField ROUTE name for SFFloat field named mass.
        See Also:
        Constant Field Values
      • fromField_METADATA

        public static final java.lang.String fromField_METADATA
        fromField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • toField_METADATA

        public static final java.lang.String toField_METADATA
        toField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • fromField_POSITION

        public static final java.lang.String fromField_POSITION
        fromField ROUTE name for SFVec3f field named position.
        See Also:
        Constant Field Values
      • toField_POSITION

        public static final java.lang.String toField_POSITION
        toField ROUTE name for SFVec3f field named position.
        See Also:
        Constant Field Values
      • fromField_SPEED

        public static final java.lang.String fromField_SPEED
        fromField ROUTE name for SFFloat field named speed.
        See Also:
        Constant Field Values
      • toField_SPEED

        public static final java.lang.String toField_SPEED
        toField ROUTE name for SFFloat field named speed.
        See Also:
        Constant Field Values
      • fromField_VARIATION

        public static final java.lang.String fromField_VARIATION
        fromField ROUTE name for SFFloat field named variation.
        See Also:
        Constant Field Values
      • toField_VARIATION

        public static final java.lang.String toField_VARIATION
        toField ROUTE name for SFFloat field named variation.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ExplosionEmitterObject

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

        public ExplosionEmitterObject​(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 Detail

      • getElementName

        public final java.lang.String getElementName()
        Provides name of this element: ExplosionEmitter
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.String getComponent()
        Defines X3D component for the ExplosionEmitter 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: 1
        Specified by:
        getComponentLevel in class X3DConcreteElement
        Returns:
        default X3D component level for this element
      • getFieldType

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

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

        public final void initialize()
        Initialize all member variables to default values.
        Overrides:
        initialize in class X3DConcreteNode
      • clearIS

        public ExplosionEmitterObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        ExplosionEmitterObject - 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()
      • setMass

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

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

        public ExplosionEmitterObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        ExplosionEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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
      • getPosition

        public float[] getPosition()
        Provide array of 3-tuple float results from inputOutput SFVec3f field named position.

        Tooltip: Point from which particles emanate. *
        Specified by:
        getPosition in interface ExplosionEmitter
        Returns:
        value of position field
      • setPosition

        public ExplosionEmitterObject setPosition​(float[] newValue)
        Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named position.

        Tooltip: Point from which particles emanate. *
        Specified by:
        setPosition in interface ExplosionEmitter
        Parameters:
        newValue - is new value for the position field.
        Returns:
        ExplosionEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setPosition

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

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

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

        public ExplosionEmitterObject setPosition​(double[] newArray)
        Utility method: double-precision set-array accessor for X3D floating-point type, similar to setPosition(float[]).
        Parameters:
        newArray - is new value for field
        Returns:
        ExplosionEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • 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 ExplosionEmitter
        Specified by:
        getSpeed in interface X3DParticleEmitterNode
        Returns:
        value of speed field
      • setSpeed

        public ExplosionEmitterObject 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 ExplosionEmitter
        Specified by:
        setSpeed in interface X3DParticleEmitterNode
        Parameters:
        newValue - is new value for the speed field.
        Returns:
        ExplosionEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSpeed

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

        public ExplosionEmitterObject 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:
        ExplosionEmitterObject - 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 ExplosionEmitter
        Specified by:
        getSurfaceArea in interface X3DParticleEmitterNode
        Returns:
        value of surfaceArea field
      • setSurfaceArea

        public ExplosionEmitterObject 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 ExplosionEmitter
        Specified by:
        setSurfaceArea in interface X3DParticleEmitterNode
        Parameters:
        newValue - is new value for the surfaceArea field.
        Returns:
        ExplosionEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSurfaceArea

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

        public ExplosionEmitterObject 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:
        ExplosionEmitterObject - 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 initial values possible.
        • Hint: variation of zero does not allow any randomness.
        Specified by:
        getVariation in interface ExplosionEmitter
        Specified by:
        getVariation in interface X3DParticleEmitterNode
        Returns:
        value of variation field
      • setVariation

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

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

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

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

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

        public ExplosionEmitterObject 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:
        ExplosionEmitterObject - 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 ExplosionEmitterObject 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:
        ExplosionEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        W3C Cascading Style Sheets
      • setUSE

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

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

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