SurfaceEmitterObject (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.SurfaceEmitterObject

All Implemented Interfaces:

X3DNode, SurfaceEmitter, X3DParticleEmitterNode
```
public class SurfaceEmitterObject
extends X3DConcreteNode
implements SurfaceEmitter
```
X3D node tooltip: (X3D version 3.2 or later) SurfaceEmitter generates particles from the surface of an object. New particles are generated by first randomly choosing a face on the tessellated geometry and then a random position on that face. Particles are generated with an initial direction of the normal to that point (including any normal averaging due to normalPerVertex and creaseAngle field settings).
- Hint: ff surface is not solid (solid=false), randomly choose from which side of the surface to emit, negating the normal direction when generating from the back side.
- Warning: only valid geometry shall be used.
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 using the org.web3d.x3d.sai package instead.
See Also:

X3D Abstract Specification: SurfaceEmitter, X3D Tooltips: SurfaceEmitter, X3D Scene Authoring Hints

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENT` String constant COMPONENT provides X3D component for this element: ParticleSystems.
`static java.util.ArrayList<java.lang.Integer>`	`COORDINDEX_DEFAULT_VALUE` MFInt32 field named coordIndex has default value {-1} (Java syntax) or -1 (XML syntax).
`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_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 component level for this element: 2.
`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: SurfaceEmitter.
`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_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_SET_COORDINDEX` toField ROUTE name for MFInt32 field named set_coordIndex.
`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
`SurfaceEmitterObject()` Constructor for SurfaceEmitterObject to initialize member variables with default values.
`SurfaceEmitterObject(java.lang.String DEFname)` Utility constructor that assigns DEF name after initializing member variables with default values

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SurfaceEmitterObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to contained commentsList.
`SurfaceEmitterObject`	`addComments(java.lang.String newComment)` Add comment as String to contained commentsList.
`SurfaceEmitterObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to contained commentsList.
`SurfaceEmitterObject`	`clearCoordIndex()` Utility method to clear MFInt32 value of coordIndex field.
`SurfaceEmitterObject`	`clearMetadata()` Utility method to clear SFNode value of metadata field.
`SurfaceEmitterObject`	`clearSurface()` Utility method to clear SFNode value of surface 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()` Provides X3D component for this element: ParticleSystems.
`int`	`getComponentLevel()` Provides default X3D component level for this element: 2.
`int[]`	`getCoordIndex()` Provide array of Integer results within allowed range of [-1,infinity) from initializeOnly MFInt32 field named coordIndex.
`java.util.ArrayList<java.lang.Integer>`	`getCoordIndexList()` Utility method to get ArrayList value of MFInt32 coordIndex field, similar to `getCoordIndex()`.
`java.lang.String`	`getElementName()` Provides name of this element: SurfaceEmitter.
`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.
`ProtoInstanceObject`	`getMetadataProtoInstance()` Provide properly typed ProtoInstance for inputOutput SFNode field metadata, if available.
`X3DConcreteNode`	`getNodeByDEF(java.lang.String DEFname)` Recursive method to provide object reference to node by DEF name, if found as this node or in a contained node.
`float`	`getSpeed()` Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named speed.
`X3DGeometryNode`	`getSurface()` Provide X3DGeometryNode instance (using a properly typed node) from initializeOnly SFNode field surface.
`float`	`getSurfaceArea()` Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named surfaceArea.
`ProtoInstanceObject`	`getSurfaceProtoInstance()` Provide properly typed ProtoInstance for initializeOnly SFNode field surface, if available.
`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.
`boolean`	`hasSurface()` Indicate whether an object is available for initializeOnly SFNode field surface.
`void`	`initialize()` Initialize all member variables to default values.
`SurfaceEmitterObject`	`setCoordIndex(java.util.ArrayList<java.lang.Integer> newValue)` Assign ArrayList value of MFInt32 coordIndex field, similar to `setCoordIndex(int[])`.
`SurfaceEmitterObject`	`setCoordIndex(int[] newValue)` Assign Integer array within allowed range of [-1,infinity) to initializeOnly MFInt32 field named coordIndex.
`SurfaceEmitterObject`	`setCoordIndex(MFInt32Object newValue)` Assign typed object value to MFInt32 coordIndex field, similar to `setCoordIndex(int[])`.
`SurfaceEmitterObject`	`setCssClass(SFStringObject newValue)` Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`SurfaceEmitterObject`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`SurfaceEmitterObject`	`setDEF(SFStringObject newValue)` Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`SurfaceEmitterObject`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`SurfaceEmitterObject`	`setIS(ISObject newValue)` Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`SurfaceEmitterObject`	`setMass(float newValue)` Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named mass.
`SurfaceEmitterObject`	`setMass(SFFloatObject newValue)` Assign typed object value to SFFloat mass field, similar to `setMass(float)`.
`SurfaceEmitterObject`	`setMetadata(ProtoInstanceObject newProtoInstanceNode)` Assign ProtoInstance to metadata field; WARNING: ProtoInstance must match acceptable node type X3DMetadataObject.
`SurfaceEmitterObject`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`SurfaceEmitterObject`	`setSpeed(float newValue)` Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named speed.
`SurfaceEmitterObject`	`setSpeed(SFFloatObject newValue)` Assign typed object value to SFFloat speed field, similar to `setSpeed(float)`.
`SurfaceEmitterObject`	`setSurface(ProtoInstanceObject newProtoInstanceNode)` Assign ProtoInstance to surface field; WARNING: ProtoInstance must match acceptable node type X3DGeometryNode.
`SurfaceEmitterObject`	`setSurface(X3DGeometryNode newValue)` Assign X3DGeometryNode instance (using a properly typed node) to initializeOnly SFNode field surface.
`SurfaceEmitterObject`	`setSurfaceArea(float newValue)` Assign float value within allowed range of [0,infinity) to initializeOnly SFFloat field named surfaceArea.
`SurfaceEmitterObject`	`setSurfaceArea(SFFloatObject newValue)` Assign typed object value to SFFloat surfaceArea field, similar to `setSurfaceArea(float)`.
`SurfaceEmitterObject`	`setUSE(SFStringObject newValue)` Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`SurfaceEmitterObject`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`SurfaceEmitterObject`	`setUSE(SurfaceEmitterObject DEFnode)` Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`SurfaceEmitterObject`	`setVariation(float newValue)` Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named variation.
`SurfaceEmitterObject`	`setVariation(SFFloatObject newValue)` Assign typed object value to SFFloat variation field, similar to `setVariation(float)`.
`java.lang.String`	`toStringClassicVRML(int level)` Recursive method to provide ClassicVRML string serialization.
`java.lang.String`	`toStringVRML97(int level)` Recursive method to provide VRML97 string serialization.
`java.lang.String`	`toStringX3D(int level)` Recursive method to provide X3D string serialization of this model subgraph.
`java.lang.String`	`validate()` Recursive method to validate this element plus all contained nodes and statements.

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: SurfaceEmitter.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT provides X3D component for this element: ParticleSystems.
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final int LEVEL
```
    Integer constant LEVEL provides default X3D component level for this element: 2.
    
    See Also:
    
    Constant Field Values
  - COORDINDEX_DEFAULT_VALUE
```
public static final java.util.ArrayList<java.lang.Integer> COORDINDEX_DEFAULT_VALUE
```
    MFInt32 field named coordIndex has default value {-1} (Java syntax) or -1 (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
  - 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_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
  - toField_SET_COORDINDEX
```
public static final java.lang.String toField_SET_COORDINDEX
```
    toField ROUTE name for MFInt32 field named set_coordIndex.
    
    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
  - SurfaceEmitterObject
```
public SurfaceEmitterObject()
```
    Constructor for SurfaceEmitterObject to initialize member variables with default values.
  - SurfaceEmitterObject
```
public SurfaceEmitterObject(java.lang.String DEFname)
```
    Utility constructor that assigns DEF name after initializing member variables with default values
    
    Parameters:
    
    DEFname - unique DEF name for this X3D node
- Method Detail
  - getElementName
```
public final java.lang.String getElementName()
```
    Provides name of this element: SurfaceEmitter.
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Provides X3D component for this 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
  - initialize
```
public final void initialize()
```
    Initialize all member variables to default values.
    
    Overrides:
    
    initialize in class X3DConcreteNode
  - 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.
    
    Specified by:
    
    getCoordIndex in interface SurfaceEmitter
    
    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 SurfaceEmitterObject setCoordIndex(int[] newValue)
```
    Assign Integer array within allowed range of [-1,infinity) 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.
    
    Specified by:
    
    setCoordIndex in interface SurfaceEmitter
    
    Parameters:
    
    newValue - is new value for the coordIndex field.
    
    Returns:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setCoordIndex
```
public SurfaceEmitterObject 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:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setCoordIndex
```
public SurfaceEmitterObject 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:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - clearCoordIndex
```
public SurfaceEmitterObject clearCoordIndex()
```
    Utility method to clear MFInt32 value of coordIndex field.
    
    Returns:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - 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 in mass base units (default is grams). Hint: mass is needed if gravity or other force-related calculations are performed per-particle.
    
    Specified by:
    
    getMass in interface SurfaceEmitter
    
    Specified by:
    
    getMass in interface X3DParticleEmitterNode
    
    Returns:
    
    value of mass field
  - setMass
```
public SurfaceEmitterObject 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 in mass base units (default is grams). Hint: mass is needed if gravity or other force-related calculations are performed per-particle.
    
    Specified by:
    
    setMass in interface SurfaceEmitter
    
    Specified by:
    
    setMass in interface X3DParticleEmitterNode
    
    Parameters:
    
    newValue - is new value for the mass field.
    
    Returns:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setMass
```
public SurfaceEmitterObject 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:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node 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 SurfaceEmitter
    
    Specified by:
    
    getMetadata in interface X3DParticleEmitterNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
public SurfaceEmitterObject 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 SurfaceEmitter
    
    Specified by:
    
    setMetadata in interface X3DParticleEmitterNode
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    See Also:
    
    setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
  - clearMetadata
```
public SurfaceEmitterObject clearMetadata()
```
    Utility method to clear SFNode value of metadata field.
    
    Returns:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setMetadata
```
public SurfaceEmitterObject setMetadata(ProtoInstanceObject newProtoInstanceNode)
```
    Assign ProtoInstance to metadata field; WARNING: ProtoInstance must match acceptable node type X3DMetadataObject.
    
    Parameters:
    
    newProtoInstanceNode - is the new ProtoInstance node for the metadata field
    
    Returns:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    
    See Also:
    
    setMetadata(X3DMetadataObject), X3D Scene Authoring Hints: Metadata Nodes
  - getMetadataProtoInstance
```
public ProtoInstanceObject getMetadataProtoInstance()
```
    Provide properly typed ProtoInstance for inputOutput SFNode field metadata, if available.
    
    Returns:
    
    ProtoInstance value of geometry field
    
    See Also:
    
    getMetadata(), X3D Scene Authoring Hints: Metadata Nodes
  - 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 SurfaceEmitter
    
    Specified by:
    
    getSpeed in interface X3DParticleEmitterNode
    
    Returns:
    
    value of speed field
  - setSpeed
```
public SurfaceEmitterObject 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 SurfaceEmitter
    
    Specified by:
    
    setSpeed in interface X3DParticleEmitterNode
    
    Parameters:
    
    newValue - is new value for the speed field.
    
    Returns:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setSpeed
```
public SurfaceEmitterObject 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:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getSurface
```
public X3DGeometryNode getSurface()
```
    Provide X3DGeometryNode instance (using a properly typed node) from initializeOnly SFNode field surface.
    
    Specified by:
    
    getSurface in interface SurfaceEmitter
    
    Returns:
    
    value of surface field
    
    See Also:
    
    Tooltip: [X3DGeometryNode] The geometry node provides geometry used as the emitting surface. Hint: If the surface is indicated as not being solid (solid field set to false), randomly choose from which side of the surface to emit, negating the normal direction when generating from the back side. Warning: only valid geometry shall be used.
  - setSurface
```
public SurfaceEmitterObject setSurface(X3DGeometryNode newValue)
```
    Assign X3DGeometryNode instance (using a properly typed node) to initializeOnly SFNode field surface.
    
    Specified by:
    
    setSurface in interface SurfaceEmitter
    
    Parameters:
    
    newValue - is new value for the surface field.
    
    Returns:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    See Also:
    
    Tooltip: [X3DGeometryNode] The geometry node provides geometry used as the emitting surface. Hint: If the surface is indicated as not being solid (solid field set to false), randomly choose from which side of the surface to emit, negating the normal direction when generating from the back side. Warning: only valid geometry shall be used.
  - clearSurface
```
public SurfaceEmitterObject clearSurface()
```
    Utility method to clear SFNode value of surface field.
    
    Returns:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setSurface
```
public SurfaceEmitterObject setSurface(ProtoInstanceObject newProtoInstanceNode)
```
    Assign ProtoInstance to surface field; WARNING: ProtoInstance must match acceptable node type X3DGeometryNode.
    
    Parameters:
    
    newProtoInstanceNode - is the new ProtoInstance node for the surface field
    
    Returns:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    
    See Also:
    
    setSurface(X3DGeometryNode)
  - getSurfaceProtoInstance
```
public ProtoInstanceObject getSurfaceProtoInstance()
```
    Provide properly typed ProtoInstance for initializeOnly SFNode field surface, if available.
    
    Returns:
    
    ProtoInstance value of geometry field
    
    See Also:
    
    getSurface()
  - hasSurface
```
public boolean hasSurface()
```
    Indicate whether an object is available for initializeOnly SFNode field surface.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getSurface(), getSurfaceProtoInstance()
  - 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 SurfaceEmitter
    
    Specified by:
    
    getSurfaceArea in interface X3DParticleEmitterNode
    
    Returns:
    
    value of surfaceArea field
  - setSurfaceArea
```
public SurfaceEmitterObject 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 SurfaceEmitter
    
    Specified by:
    
    setSurfaceArea in interface X3DParticleEmitterNode
    
    Parameters:
    
    newValue - is new value for the surfaceArea field.
    
    Returns:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setSurfaceArea
```
public SurfaceEmitterObject 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:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node 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 SurfaceEmitter
    
    Specified by:
    
    getVariation in interface X3DParticleEmitterNode
    
    Returns:
    
    value of variation field
  - setVariation
```
public SurfaceEmitterObject 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 SurfaceEmitter
    
    Specified by:
    
    setVariation in interface X3DParticleEmitterNode
    
    Parameters:
    
    newValue - is new value for the variation field.
    
    Returns:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setVariation
```
public SurfaceEmitterObject 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:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setDEF
```
public final SurfaceEmitterObject 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 SurfaceEmitter
    
    Specified by:
    
    setDEF in interface X3DParticleEmitterNode
    
    Specified by:
    
    setDEF in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setDEF
```
public SurfaceEmitterObject 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:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setUSE
```
public final SurfaceEmitterObject 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 resets all other fields to their default values 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 SurfaceEmitter
    
    Specified by:
    
    setUSE in interface X3DParticleEmitterNode
    
    Specified by:
    
    setUSE in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setUSE
```
public SurfaceEmitterObject 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:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setCssClass
```
public final SurfaceEmitterObject 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 SurfaceEmitter
    
    Specified by:
    
    setCssClass in interface X3DParticleEmitterNode
    
    Specified by:
    
    setCssClass in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    See Also:
    
    W3C Cascading Style Sheets
  - setCssClass
```
public SurfaceEmitterObject 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:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setIS
```
public SurfaceEmitterObject 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:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node 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 SurfaceEmitterObject setUSE(SurfaceEmitterObject DEFnode)
```
    Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
    
    WARNING: note that the setUSE() method resets all other fields to their default values 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:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - addComments
```
public SurfaceEmitterObject addComments(java.lang.String newComment)
```
    Add comment as String to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public SurfaceEmitterObject 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:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public SurfaceEmitterObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - toStringX3D
```
public java.lang.String toStringX3D(int level)
```
    Recursive method to provide X3D string serialization of this model subgraph.
    
    Specified by:
    
    toStringX3D in class X3DConcreteElement
    
    Parameters:
    
    level - number of levels of indentation for this element
    
    Returns:
    
    X3D string
  - toStringClassicVRML
```
public java.lang.String toStringClassicVRML(int level)
```
    Recursive method to provide ClassicVRML string serialization.
    
    Specified by:
    
    toStringClassicVRML in class X3DConcreteElement
    
    Parameters:
    
    level - number of levels of indentation for this element
    
    Returns:
    
    ClassicVRML string
    
    See Also:
    
    X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
  - toStringVRML97
```
public java.lang.String toStringVRML97(int level)
```
    Recursive method to provide VRML97 string serialization.
    
    Specified by:
    
    toStringVRML97 in class X3DConcreteElement
    
    Parameters:
    
    level - number of levels of indentation for this element
    
    Returns:
    
    VRML97 string
    
    See Also:
    
    X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
  - getNodeByDEF
```
public X3DConcreteNode getNodeByDEF(java.lang.String DEFname)
```
    Recursive method to provide object reference to node by DEF name, if found as this node or in a contained node.
    
    Specified by:
    
    getNodeByDEF in class X3DConcreteNode
    
    Parameters:
    
    DEFname - DEF name of node to find
    
    Returns:
    
    object reference to node
  - 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, HAnim nodes.
    
    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)
  - 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, HAnim nodes.
    
    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)
  - 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: 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)
  - 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.
    
    Specified by:
    
    validate in class X3DConcreteElement
    
    Returns:
    
    validation results (if any)

Class SurfaceEmitterObject

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

COORDINDEX_DEFAULT_VALUE

MASS_DEFAULT_VALUE

SPEED_DEFAULT_VALUE

SURFACEAREA_DEFAULT_VALUE

VARIATION_DEFAULT_VALUE

fromField_MASS

toField_MASS

fromField_METADATA

toField_METADATA

toField_SET_COORDINDEX

fromField_SPEED

toField_SPEED

fromField_VARIATION

toField_VARIATION

Constructor Detail

SurfaceEmitterObject

SurfaceEmitterObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

initialize

getCoordIndex

getCoordIndexList

setCoordIndex

setCoordIndex

setCoordIndex

clearCoordIndex

getMass

setMass

setMass

getMetadata

setMetadata

clearMetadata

setMetadata

getMetadataProtoInstance

hasMetadata

getSpeed

setSpeed

setSpeed

getSurface

setSurface

clearSurface

setSurface

getSurfaceProtoInstance

hasSurface

getSurfaceArea

setSurfaceArea

setSurfaceArea

getVariation

setVariation

setVariation

setDEF

setDEF

setUSE

setUSE

setCssClass

setCssClass

setIS

getIS

setUSE

addComments

addComments

addComments

toStringX3D