PointEmitterObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.X3DConcreteElement
- - org.web3d.x3d.jsail.X3DConcreteNode
  - - org.web3d.x3d.jsail.ParticleSystems.PointEmitterObject

All Implemented Interfaces:

X3DNode, PointEmitter, X3DParticleEmitterNode
```
public class PointEmitterObject
extends X3DConcreteNode
implements PointEmitter
```
X3D node tooltip: (X3D version 3.2 or later) [X3DParticleEmitterNode] PointEmitter generates particles from a specific point in space using the specified direction and speed. *

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: PointEmitter, X3D Tooltips: PointEmitter, X3D Scene Authoring Hints

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENT` String constant COMPONENT defines X3D component for the PointEmitter element: ParticleSystems
`static java.lang.String`	`containerField_DEFAULT_VALUE` containerField describes typical field relationship of a node to its parent.
`static float[]`	`DIRECTION_DEFAULT_VALUE` SFVec3f field named direction has default value {0f,1f,0f} (Java syntax) or 0 1 0 (XML syntax).
`static java.lang.String`	`fromField_DIRECTION` fromField ROUTE name for SFVec3f field named direction.
`static java.lang.String`	`fromField_MASS` fromField ROUTE name for SFFloat field named mass.
`static java.lang.String`	`fromField_METADATA` fromField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`fromField_POSITION` fromField ROUTE name for SFVec3f field named position.
`static java.lang.String`	`fromField_SPEED` fromField ROUTE name for SFFloat field named speed.
`static java.lang.String`	`fromField_VARIATION` fromField ROUTE name for SFFloat field named variation.
`static int`	`LEVEL` Integer constant LEVEL provides default X3D ParticleSystems component level for this element: 1
`static float`	`MASS_DEFAULT_VALUE` SFFloat field named mass has default value 0f (Java syntax) or 0 (XML syntax).
`static java.lang.String`	`NAME` String constant NAME provides name of this element: PointEmitter.
`static float[]`	`POSITION_DEFAULT_VALUE` SFVec3f field named position has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
`static float`	`SPEED_DEFAULT_VALUE` SFFloat field named speed has default value 0f (Java syntax) or 0 (XML syntax).
`static float`	`SURFACEAREA_DEFAULT_VALUE` SFFloat field named surfaceArea has default value 0f (Java syntax) or 0 (XML syntax).
`static java.lang.String`	`toField_DIRECTION` toField ROUTE name for SFVec3f field named direction.
`static java.lang.String`	`toField_MASS` toField ROUTE name for SFFloat field named mass.
`static java.lang.String`	`toField_METADATA` toField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`toField_POSITION` toField ROUTE name for SFVec3f field named position.
`static java.lang.String`	`toField_SPEED` toField ROUTE name for SFFloat field named speed.
`static java.lang.String`	`toField_VARIATION` toField ROUTE name for SFFloat field named variation.
`static float`	`VARIATION_DEFAULT_VALUE` SFFloat field named variation has default value 0.25f (Java syntax) or 0.25 (XML syntax).

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

Constructor Summary

Constructors
Constructor and Description
`PointEmitterObject()` Constructor for PointEmitterObject to initialize member variables with default values.
`PointEmitterObject(java.lang.String DEFlabel)` Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PointEmitterObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to contained commentsList.
`PointEmitterObject`	`addComments(java.lang.String newComment)` Add comment as String to contained commentsList.
`PointEmitterObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to contained commentsList.
`PointEmitterObject`	`clearMetadata()` Utility method to clear SFNode value of metadata field.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteNode`	`findNodeByDEF(java.lang.String DEFvalue)` Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
`java.lang.String`	`getAccessType(java.lang.String fieldName)` Indicate accessType corresponding to given fieldName.
`java.lang.String`	`getComponent()` Defines X3D component for the PointEmitter element: ParticleSystems
`int`	`getComponentLevel()` Provides default X3D component level for this element: 1
`java.lang.String`	`getContainerFieldDefault()` containerField describes typical field relationship of a node to its parent.
`float[]`	`getDirection()` Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.
`java.lang.String`	`getElementName()` Provides name of this element: PointEmitter
`java.lang.String`	`getFieldType(java.lang.String fieldName)` Indicate type corresponding to given fieldName.
`ISObject`	`getIS()` Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`float`	`getMass()` Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named mass.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`float[]`	`getPosition()` Provide array of 3-tuple float results from inputOutput SFVec3f field named position.
`float`	`getSpeed()` Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named speed.
`float`	`getSurfaceArea()` Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named surfaceArea.
`float`	`getVariation()` Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named variation.
`boolean`	`hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
`boolean`	`hasMetadata()` Indicate whether an object is available for inputOutput SFNode field metadata.
`boolean`	`hasNodeByDEF(java.lang.String DEFvalue)` Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
`void`	`initialize()` Initialize all member variables to default values.
`PointEmitterObject`	`setCssClass(SFStringObject newValue)` Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`PointEmitterObject`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`PointEmitterObject`	`setDEF(SFStringObject newValue)` Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`PointEmitterObject`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`PointEmitterObject`	`setDirection(float[] newValue)` Assign 3-tuple float array to inputOutput SFVec3f field named direction.
`PointEmitterObject`	`setDirection(float x, float y, float z)` Assign values to SFVec3f direction field, similar to `setDirection(float[])`.
`PointEmitterObject`	`setDirection(SFVec3fObject newValue)` Assign typed object value to SFVec3f direction field, similar to `setDirection(float[])`.
`PointEmitterObject`	`setIS(ISObject newValue)` Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`PointEmitterObject`	`setMass(float newValue)` Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named mass.
`PointEmitterObject`	`setMass(SFFloatObject newValue)` Assign typed object value to SFFloat mass field, similar to `setMass(float)`.
`PointEmitterObject`	`setMetadata(ProtoInstanceObject newValue)` Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
`PointEmitterObject`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`PointEmitterObject`	`setPosition(float[] newValue)` Assign 3-tuple float array to inputOutput SFVec3f field named position.
`PointEmitterObject`	`setPosition(float x, float y, float z)` Assign values to SFVec3f position field, similar to `setPosition(float[])`.
`PointEmitterObject`	`setPosition(SFVec3fObject newValue)` Assign typed object value to SFVec3f position field, similar to `setPosition(float[])`.
`PointEmitterObject`	`setSpeed(float newValue)` Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named speed.
`PointEmitterObject`	`setSpeed(SFFloatObject newValue)` Assign typed object value to SFFloat speed field, similar to `setSpeed(float)`.
`PointEmitterObject`	`setSurfaceArea(float newValue)` Assign float value within allowed range of [0,infinity) to initializeOnly SFFloat field named surfaceArea.
`PointEmitterObject`	`setSurfaceArea(SFFloatObject newValue)` Assign typed object value to SFFloat surfaceArea field, similar to `setSurfaceArea(float)`.
`PointEmitterObject`	`setUSE(PointEmitterObject DEFnode)` Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`PointEmitterObject`	`setUSE(SFStringObject newValue)` Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`PointEmitterObject`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`PointEmitterObject`	`setVariation(float newValue)` Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named variation.
`PointEmitterObject`	`setVariation(SFFloatObject newValue)` Assign typed object value to SFFloat variation field, similar to `setVariation(float)`.
`java.lang.String`	`toStringClassicVRML(int indentLevel)` Recursive method to provide ClassicVRML string serialization.
`java.lang.String`	`toStringVRML97(int indentLevel)` Recursive method to provide VRML97 string serialization.
`java.lang.String`	`toStringX3D(int indentLevel)` Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
`java.lang.String`	`validate()` Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: PointEmitter.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT defines X3D component for the PointEmitter 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
  - DIRECTION_DEFAULT_VALUE
```
public static final float[] DIRECTION_DEFAULT_VALUE
```
    SFVec3f field named direction has default value {0f,1f,0f} (Java syntax) or 0 1 0 (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
  - 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
  - containerField_DEFAULT_VALUE
```
public static final java.lang.String containerField_DEFAULT_VALUE
```
    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.
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
  - fromField_DIRECTION
```
public static final java.lang.String fromField_DIRECTION
```
    fromField ROUTE name for SFVec3f field named direction.
    
    See Also:
    
    Constant Field Values
  - toField_DIRECTION
```
public static final java.lang.String toField_DIRECTION
```
    toField ROUTE name for SFVec3f field named direction.
    
    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
  - PointEmitterObject
```
public PointEmitterObject()
```
    Constructor for PointEmitterObject to initialize member variables with default values.
  - PointEmitterObject
```
public PointEmitterObject(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: PointEmitter
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Defines X3D component for the PointEmitter 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
  - 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
  - getDirection
```
public float[] getDirection()
```
    Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.
    
    Tooltip: Initial direction from which particles emanate. *
    
    Specified by:
    
    getDirection in interface PointEmitter
    
    Returns:
    
    value of direction field
  - setDirection
```
public PointEmitterObject setDirection(float[] newValue)
```
    Assign 3-tuple float array to inputOutput SFVec3f field named direction.
    
    Tooltip: Initial direction from which particles emanate.
    
    Specified by:
    
    setDirection in interface PointEmitter
    
    Parameters:
    
    newValue - is new value for the direction field.
    
    Returns:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDirection
```
public PointEmitterObject 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:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDirection
```
public PointEmitterObject 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:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - 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).
    - Hint: mass is needed if gravity or other force-related calculations are performed on a per-particle basis.
    - Hint:
      https://en.wikipedia.org/wiki/Kilogram
    - Hint: X3D Architecture 4.3.6 Standard units and coordinate system
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/concepts.html#Standardunitscoordinates
    Specified by:
    
    getMass in interface PointEmitter
    
    Specified by:
    
    getMass in interface X3DParticleEmitterNode
    
    Returns:
    
    value of mass field
  - setMass
```
public PointEmitterObject setMass(float newValue)
```
    Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named mass.
    
    Tooltip: [0,+infinity) Basic mass of each particle, defined in mass base units (default is kilograms). Hint: mass is needed if gravity or other force-related calculations are performed on a per-particle basis. Hint: https://en.wikipedia.org/wiki/Kilogram Hint: X3D Architecture 4.3.6 Standard units and coordinate system http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/concepts.html#Standardunitscoordinates
    
    Specified by:
    
    setMass in interface PointEmitter
    
    Specified by:
    
    setMass in interface X3DParticleEmitterNode
    
    Parameters:
    
    newValue - is new value for the mass field.
    
    Returns:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setMass
```
public PointEmitterObject 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:
    
    PointEmitterObject - 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 X3DNode
    
    Specified by:
    
    getMetadata in interface PointEmitter
    
    Specified by:
    
    getMetadata in interface X3DParticleEmitterNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
public PointEmitterObject setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface PointEmitter
    
    Specified by:
    
    setMetadata in interface X3DParticleEmitterNode
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    PointEmitterObject - 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 PointEmitterObject clearMetadata()
```
    Utility method to clear SFNode value of metadata field.
    
    Returns:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setMetadata
```
public PointEmitterObject 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:
    
    PointEmitterObject - 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
  - 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 PointEmitter
    
    Returns:
    
    value of position field
  - setPosition
```
public PointEmitterObject setPosition(float[] newValue)
```
    Assign 3-tuple float array to inputOutput SFVec3f field named position.
    
    Tooltip: Point from which particles emanate.
    
    Specified by:
    
    setPosition in interface PointEmitter
    
    Parameters:
    
    newValue - is new value for the position field.
    
    Returns:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setPosition
```
public PointEmitterObject 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:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setPosition
```
public PointEmitterObject 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:
    
    PointEmitterObject - 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 PointEmitter
    
    Specified by:
    
    getSpeed in interface X3DParticleEmitterNode
    
    Returns:
    
    value of speed field
  - setSpeed
```
public PointEmitterObject setSpeed(float newValue)
```
    Assign float value within allowed range of [0,infinity) 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 PointEmitter
    
    Specified by:
    
    setSpeed in interface X3DParticleEmitterNode
    
    Parameters:
    
    newValue - is new value for the speed field.
    
    Returns:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setSpeed
```
public PointEmitterObject 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:
    
    PointEmitterObject - 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 PointEmitter
    
    Specified by:
    
    getSurfaceArea in interface X3DParticleEmitterNode
    
    Returns:
    
    value of surfaceArea field
  - setSurfaceArea
```
public PointEmitterObject setSurfaceArea(float newValue)
```
    Assign float value within allowed range of [0,infinity) 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 PointEmitter
    
    Specified by:
    
    setSurfaceArea in interface X3DParticleEmitterNode
    
    Parameters:
    
    newValue - is new value for the surfaceArea field.
    
    Returns:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setSurfaceArea
```
public PointEmitterObject 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:
    
    PointEmitterObject - 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 PointEmitter
    
    Specified by:
    
    getVariation in interface X3DParticleEmitterNode
    
    Returns:
    
    value of variation field
  - setVariation
```
public PointEmitterObject setVariation(float newValue)
```
    Assign float value within allowed range of [0,infinity) 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 PointEmitter
    
    Specified by:
    
    setVariation in interface X3DParticleEmitterNode
    
    Parameters:
    
    newValue - is new value for the variation field.
    
    Returns:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setVariation
```
public PointEmitterObject 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:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public final PointEmitterObject setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface PointEmitter
    
    Specified by:
    
    setDEF in interface X3DParticleEmitterNode
    
    Specified by:
    
    setDEF in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public PointEmitterObject 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:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public final PointEmitterObject setUSE(java.lang.String newValue)
```
    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 interface X3DNode
    
    Specified by:
    
    setUSE in interface PointEmitter
    
    Specified by:
    
    setUSE in interface X3DParticleEmitterNode
    
    Specified by:
    
    setUSE in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public PointEmitterObject 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:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
public final PointEmitterObject setCssClass(java.lang.String newValue)
```
    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 interface X3DNode
    
    Specified by:
    
    setCssClass in interface PointEmitter
    
    Specified by:
    
    setCssClass in interface X3DParticleEmitterNode
    
    Specified by:
    
    setCssClass in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    PointEmitterObject - 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 PointEmitterObject 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:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setIS
```
public PointEmitterObject setIS(ISObject newValue)
```
    Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    setIS in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the description field.
    
    Returns:
    
    PointEmitterObject - 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
  - getIS
```
public ISObject getIS()
```
    Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    getIS in class X3DConcreteNode
    
    Returns:
    
    current ISObject, if any.
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - setUSE
```
public PointEmitterObject setUSE(PointEmitterObject 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:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addComments
```
public PointEmitterObject addComments(java.lang.String newComment)
```
    Add comment as String to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public PointEmitterObject 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:
    
    PointEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public PointEmitterObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    PointEmitterObject - 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
  - 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)

Class PointEmitterObject

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

NAME

COMPONENT

LEVEL

DIRECTION_DEFAULT_VALUE

MASS_DEFAULT_VALUE

POSITION_DEFAULT_VALUE

SPEED_DEFAULT_VALUE

SURFACEAREA_DEFAULT_VALUE

VARIATION_DEFAULT_VALUE

containerField_DEFAULT_VALUE

fromField_DIRECTION

toField_DIRECTION

fromField_MASS

toField_MASS

fromField_METADATA

toField_METADATA

fromField_POSITION

toField_POSITION

fromField_SPEED

toField_SPEED

fromField_VARIATION

toField_VARIATION

Constructor Detail

PointEmitterObject

PointEmitterObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

getContainerFieldDefault

initialize

getDirection

setDirection

setDirection

setDirection

getMass

setMass

setMass

getMetadata

setMetadata

clearMetadata

setMetadata

hasMetadata

getPosition

setPosition

setPosition

setPosition

getSpeed

setSpeed

setSpeed

getSurfaceArea

setSurfaceArea

setSurfaceArea

getVariation

setVariation

setVariation

setDEF

setDEF

setUSE

setUSE

setCssClass

setCssClass

setIS

getIS

setUSE

addComments

addComments

addComments