java.lang.Object

org.web3d.x3d.jsail.ParticleSystems.SurfaceEmitterObject

All Implemented Interfaces:: X3DNode, SurfaceEmitter, X3DParticleEmitterNode

public class SurfaceEmitterObject
extends X3DConcreteNode
implements SurfaceEmitter

SurfaceEmitter generates particles from the surface of an object.

X3D node tooltip: (X3D version 3.2 or later) [X3DParticleEmitterNode] 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 separate code using only 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	Description
`static java.lang.String`	`COMPONENT`	String constant COMPONENT defines X3D component for the SurfaceEmitter element: ParticleSystems
`static java.lang.String`	`containerField_DEFAULT_VALUE`	containerField describes typical field relationship of a node to its parent.
`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_IS`	fromField ROUTE name for SFNode field named IS.
`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 ISObject`	`IS_DEFAULT_VALUE`	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
`static int`	`LEVEL`	Integer constant LEVEL provides default X3D ParticleSystems 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 X3DMetadataObject`	`METADATA_DEFAULT_VALUE`	SFNode field named metadata has default value null (Java syntax) or NULL (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 X3DGeometryNode`	`SURFACE_DEFAULT_VALUE`	SFNode field named surface has default value null (Java syntax) or NULL (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	Description
`SurfaceEmitterObject()`	Constructor for SurfaceEmitterObject to initialize member variables with default values.
`SurfaceEmitterObject(java.lang.String DEFlabel)`	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
`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`	`addComments(CommentsBlock newCommentsBlock)`	Add CommentsBlock to contained commentsList.
`SurfaceEmitterObject`	`addCoordIndex(int newValue)`	Add singleton int value to MFInt32 coordIndex field.
`SurfaceEmitterObject`	`addCoordIndex(SFInt32Object newValue)`	Add singleton SFInt32Object value to MFInt32 coordIndex field.
`SurfaceEmitterObject`	`clearCoordIndex()`	Utility method to clear MFInt32 value of coordIndex field.
`SurfaceEmitterObject`	`clearIS()`	Utility method to clear SFNode value of IS 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()`	Defines X3D component for the SurfaceEmitter element: ParticleSystems
`int`	`getComponentLevel()`	Provides default X3D component level for this element: 2
`java.lang.String`	`getContainerFieldDefault()`	containerField describes typical field relationship of a node to its parent.
`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`	`getCoordIndexString()`	Utility method to get String value of MFInt32 coordIndex field, similar to `getCoordIndex()`.
`java.lang.String`	`getCssClass()`	Provide String value from inputOutput SFString field named class.
`java.lang.String`	`getDEF()`	Provide String value from inputOutput SFString field named DEF.
`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 ISObject instance (using a properly typed node) from inputOutput SFNode field IS.
`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`	`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.
`java.lang.String`	`getUSE()`	Provide String value from inputOutput SFString field named USE.
`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`	`hasIS()`	Indicate whether an object is available for inputOutput SFNode field IS.
`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(int[] newValue)`	Accessor method to assign Integer array to initializeOnly MFInt32 field named coordIndex.
`SurfaceEmitterObject`	`setCoordIndex(java.util.ArrayList<java.lang.Integer> newValue)`	Assign ArrayList value of MFInt32 coordIndex field, similar to `setCoordIndex(int[])`.
`SurfaceEmitterObject`	`setCoordIndex(MFInt32Object newValue)`	Assign typed object value to MFInt32 coordIndex field, similar to `setCoordIndex(int[])`.
`SurfaceEmitterObject`	`setCssClass(java.lang.String newValue)`	Accessor method to assign String value to inputOutput SFString field named class.
`SurfaceEmitterObject`	`setCssClass(SFStringObject newValue)`	Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`SurfaceEmitterObject`	`setDEF(java.lang.String newValue)`	Accessor method to assign String value to inputOutput SFString field named DEF.
`SurfaceEmitterObject`	`setDEF(SFStringObject newValue)`	Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`SurfaceEmitterObject`	`setIS(ISObject newValue)`	Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.
`SurfaceEmitterObject`	`setMass(double newValue)`	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to `setMass(float)`.
`SurfaceEmitterObject`	`setMass(float newValue)`	Accessor method to assign float value 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 newValue)`	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
`SurfaceEmitterObject`	`setMetadata(X3DMetadataObject newValue)`	Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`SurfaceEmitterObject`	`setSpeed(double newValue)`	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to `setSpeed(float)`.
`SurfaceEmitterObject`	`setSpeed(float newValue)`	Accessor method to assign float value 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 newValue)`	Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field surface.
`SurfaceEmitterObject`	`setSurface(X3DGeometryNode newValue)`	Accessor method to assign X3DGeometryNode instance (using a properly typed node) to initializeOnly SFNode field surface.
`SurfaceEmitterObject`	`setSurfaceArea(double newValue)`	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to `setSurfaceArea(float)`.
`SurfaceEmitterObject`	`setSurfaceArea(float newValue)`	Accessor method to assign float value to initializeOnly SFFloat field named surfaceArea.
`SurfaceEmitterObject`	`setSurfaceArea(SFFloatObject newValue)`	Assign typed object value to SFFloat surfaceArea field, similar to `setSurfaceArea(float)`.
`SurfaceEmitterObject`	`setUSE(java.lang.String newValue)`	Accessor method to assign String value to inputOutput SFString field named USE.
`SurfaceEmitterObject`	`setUSE(SFStringObject newValue)`	Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`SurfaceEmitterObject`	`setUSE(SurfaceEmitterObject DEFnode)`	Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`SurfaceEmitterObject`	`setVariation(double newValue)`	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to `setVariation(float)`.
`SurfaceEmitterObject`	`setVariation(float newValue)`	Accessor method to assign float value 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 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, 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, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- 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 defines X3D component for the SurfaceEmitter 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: 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).
- IS_DEFAULT_VALUE
  
  public static final ISObject IS_DEFAULT_VALUE
  
  SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
- MASS_DEFAULT_VALUE
  
  public static final float MASS_DEFAULT_VALUE
  
  SFFloat field named mass has default value 0f (Java syntax) or 0 (XML syntax).
  
  See Also:
  
  Constant Field Values
- METADATA_DEFAULT_VALUE
  
  public static final X3DMetadataObject METADATA_DEFAULT_VALUE
  
  SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
- 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
- SURFACE_DEFAULT_VALUE
  
  public static final X3DGeometryNode SURFACE_DEFAULT_VALUE
  
  SFNode field named surface has default value null (Java syntax) or NULL (XML syntax).
- 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_IS
  
  public static final java.lang.String fromField_IS
  
  fromField ROUTE name for SFNode field named IS.
  
  See Also:
  
  Constant Field Values
- fromField_MASS
  
  public static final java.lang.String fromField_MASS
  
  fromField ROUTE name for SFFloat field named mass.
  
  See Also:
  
  Constant Field Values
- toField_MASS
  
  public static final java.lang.String toField_MASS
  
  toField ROUTE name for SFFloat field named mass.
  
  See Also:
  
  Constant Field Values
- fromField_METADATA
  
  public static final java.lang.String fromField_METADATA
  
  fromField ROUTE name for SFNode field named metadata.
  
  See Also:
  
  Constant Field Values
- toField_METADATA
  
  public static final java.lang.String toField_METADATA
  
  toField ROUTE name for SFNode field named metadata.
  
  See Also:
  
  Constant Field Values
- 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 Details
- SurfaceEmitterObject
  
  public SurfaceEmitterObject()
  
  Constructor for SurfaceEmitterObject to initialize member variables with default values.
- SurfaceEmitterObject
  
  public SurfaceEmitterObject(java.lang.String DEFlabel)
  
  Utility constructor that assigns DEF label after initializing member variables with default values.
  
  Parameters:
  
  DEFlabel - unique DEF name for this X3D node
Method Details
- getElementName
  
  public final java.lang.String getElementName()
  
  Provides name of this element: SurfaceEmitter
  
  Specified by:
  
  getElementName in class X3DConcreteElement
  
  Returns:
  
  name of this element
- getComponent
  
  public final java.lang.String getComponent()
  
  Defines X3D component for the SurfaceEmitter element: ParticleSystems
  
  Specified by:
  
  getComponent in class X3DConcreteElement
  
  Returns:
  
  X3D component for this element
- getComponentLevel
  
  public final int getComponentLevel()
  
  Provides default X3D component level for this element: 2
  
  Specified by:
  
  getComponentLevel in class X3DConcreteElement
  
  Returns:
  
  default X3D component level for this element
- getFieldType
  
  public java.lang.String getFieldType(java.lang.String fieldName)
  
  Indicate type corresponding to given fieldName.
  
  Specified by:
  
  getFieldType in class X3DConcreteElement
  
  Parameters:
  
  fieldName - name of field in this X3D node
  
  Returns:
  
  X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
  
  See Also:
  
  ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
- getAccessType
  
  public java.lang.String getAccessType(java.lang.String fieldName)
  
  Indicate accessType corresponding to given fieldName.
  
  Specified by:
  
  getAccessType in class X3DConcreteElement
  
  Parameters:
  
  fieldName - name of field in this X3D node
  
  Returns:
  
  X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
  
  See Also:
  
  ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
- getContainerFieldDefault
  
  public final java.lang.String getContainerFieldDefault()
  
  containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
  
  Specified by:
  
  getContainerFieldDefault in class X3DConcreteNode
  
  Returns:
  
  default containerField value
  
  See Also:
  
  X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
- initialize
  
  public final void initialize()
  
  Initialize all member variables to default values.
  
  Overrides:
  
  initialize in class X3DConcreteNode
- getCoordIndex
  
  public int[] getCoordIndex()
  Provide array of Integer results within allowed range of [-1,infinity) from initializeOnly MFInt32 field named coordIndex.
  
  Tooltip: [-1,+infinity) coordIndex indices are applied to contained Coordinate values in order to define randomly generated initial geometry of the particles.
  
  Warning: coordIndex is required in order to connect contained coordinate point values.
  Specified by:
  
  getCoordIndex in interface 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
- getCoordIndexString
  
  public java.lang.String getCoordIndexString()
  
  Utility method to get String value of MFInt32 coordIndex field, similar to getCoordIndex().
  
  Returns:
  
  value of coordIndex field
- setCoordIndex
  
  public SurfaceEmitterObject setCoordIndex(int[] newValue)
  Accessor method to assign Integer array to initializeOnly MFInt32 field named coordIndex.
  
  Tooltip: [-1,+infinity) coordIndex indices are applied to contained Coordinate values in order to define randomly generated initial geometry of the particles.
  
  Warning: coordIndex is required in order to connect contained coordinate point values.
  Specified by:
  
  setCoordIndex in interface 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 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 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 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).
- addCoordIndex
  
  public SurfaceEmitterObject addCoordIndex(int newValue)
  
  Add singleton int value to MFInt32 coordIndex field.
  
  Parameters:
  
  newValue - is new value to add to the coordIndex field.
  
  Returns:
  
  SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- addCoordIndex
  
  public SurfaceEmitterObject addCoordIndex(SFInt32Object newValue)
  
  Add singleton SFInt32Object value to MFInt32 coordIndex field.
  
  Parameters:
  
  newValue - is new value to add to the coordIndex field.
  
  Returns:
  
  SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getIS
  
  public ISObject getIS()
  
  Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.
  
  Specified by:
  
  getIS in class X3DConcreteNode
  
  Returns:
  
  value of IS field
  
  See Also:
  
  X3D Tooltips: IS, X3D Tooltips: connect
- setIS
  
  public SurfaceEmitterObject setIS(ISObject newValue)
  
  Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.
  
  Specified by:
  
  setIS in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the IS field.
  
  Returns:
  
  SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  X3D Tooltips: IS, X3D Tooltips: connect
- clearIS
  
  public SurfaceEmitterObject clearIS()
  
  Utility method to clear SFNode value of IS field.
  
  Returns:
  
  SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- hasIS
  
  public boolean hasIS()
  
  Indicate whether an object is available for inputOutput SFNode field IS.
  
  Returns:
  
  whether a concrete statement or CommentsBlock is available.
  
  See Also:
  
  getIS()
- getMass
  
  public float getMass()
  Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named mass.
  
  Tooltip: [0,+infinity) Basic mass of each particle, defined in mass base units (default is kilograms).
  
  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 https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/concepts.html#Standardunitscoordinates
  Specified by:
  
  getMass in interface SurfaceEmitter
  
  Specified by:
  
  getMass in interface X3DParticleEmitterNode
  
  Returns:
  
  value of mass field
- setMass
  
  public SurfaceEmitterObject setMass(float newValue)
  Accessor method to assign float value to inputOutput SFFloat field named mass.
  
  Tooltip: [0,+infinity) Basic mass of each particle, defined in mass base units (default is kilograms).
  
  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 https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/concepts.html#Standardunitscoordinates
  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 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 object).
- setMass
  
  public SurfaceEmitterObject setMass(double newValue)
  
  Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMass(float).
  
  Parameters:
  
  newValue - is new value for field
  
  Returns:
  
  SurfaceEmitterObject - 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 SurfaceEmitter
  
  Specified by:
  
  getMetadata in interface X3DNode
  
  Specified by:
  
  getMetadata in interface X3DParticleEmitterNode
  
  Returns:
  
  value of metadata field
  
  See Also:
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata, X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  
  public SurfaceEmitterObject setMetadata(X3DMetadataObject newValue)
  
  Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
  
  Specified by:
  
  setMetadata in interface SurfaceEmitter
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Specified by:
  
  setMetadata in interface X3DParticleEmitterNode
  
  Specified by:
  
  setMetadata in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata, 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 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:
  
  SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  setMetadata(X3DMetadataObject)
- hasMetadata
  
  public boolean hasMetadata()
  
  Indicate whether an object is available for inputOutput SFNode field metadata.
  
  Returns:
  
  whether a properly typed node or ProtoInstance or CommentsBlock is available.
  
  See Also:
  
  getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
- getSpeed
  
  public float getSpeed()
  
  Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named speed.
  
  Tooltip: [0,+infinity) Initial linear speed (default is m/s) imparted to all particles along their direction of movement. *
  
  Specified by:
  
  getSpeed in interface SurfaceEmitter
  
  Specified by:
  
  getSpeed in interface X3DParticleEmitterNode
  
  Returns:
  
  value of speed field
- setSpeed
  
  public SurfaceEmitterObject setSpeed(float newValue)
  
  Accessor method to assign float value to inputOutput SFFloat field named speed.
  
  Tooltip: [0,+infinity) Initial linear speed (default is m/s) imparted to all particles along their direction of movement. *
  
  Specified by:
  
  setSpeed in interface 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 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 object).
- setSpeed
  
  public SurfaceEmitterObject setSpeed(double newValue)
  
  Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSpeed(float).
  
  Parameters:
  
  newValue - is new value for field
  
  Returns:
  
  SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same 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)
  
  Accessor method to 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 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 newValue)
  
  Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field surface.
  
  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 object).
  
  See Also:
  
  setSurface(X3DGeometryNode)
- 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)
  Accessor method to assign float value to initializeOnly SFFloat field named surfaceArea.
  
  Tooltip: [0,+infinity) Particle surface area in area base units (default is meters squared). Surface area is used for calculations such as wind effects per particle.
  
  Hint: surfaceArea value represents average frontal area presented to the wind.
  
  Hint: assumes spherical model for each particle (i.e., surface area is the same regardless of direction).
  Specified by:
  
  setSurfaceArea in interface 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 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 object).
- setSurfaceArea
  
  public SurfaceEmitterObject setSurfaceArea(double newValue)
  
  Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSurfaceArea(float).
  
  Parameters:
  
  newValue - is new value for field
  
  Returns:
  
  SurfaceEmitterObject - 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 SurfaceEmitter
  
  Specified by:
  
  getVariation in interface X3DParticleEmitterNode
  
  Returns:
  
  value of variation field
- setVariation
  
  public SurfaceEmitterObject setVariation(float newValue)
  Accessor method to assign float value to inputOutput SFFloat field named variation.
  
  Tooltip: [0,+infinity) Multiplier for the randomness used to control the range of possible output values. The bigger the value, the more random the output and the bigger the range of possible initial values possible.
  
  Hint: variation of zero does not allow any randomness.
  Specified by:
  
  setVariation in interface 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 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 object).
- setVariation
  
  public SurfaceEmitterObject setVariation(double newValue)
  
  Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setVariation(float).
  
  Parameters:
  
  newValue - is new value for field
  
  Returns:
  
  SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getDEF
  
  public java.lang.String getDEF()
  Provide String value from inputOutput SFString field named DEF.
  
  Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
  
  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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
  Overrides:
  
  getDEF in class X3DConcreteNode
  
  Returns:
  
  value of DEF field
  
  See Also:
  
  X3D Scene Authoring Hints: Naming Conventions
- setDEF
  
  public final SurfaceEmitterObject setDEF(java.lang.String newValue)
  Accessor method to assign String value to inputOutput SFString field named DEF.
  
  Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
  
  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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
  
  Note that setting the DEF value clears the USE value.
  Specified by:
  
  setDEF in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the DEF field.
  
  Returns:
  
  SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same 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 object).
- getUSE
  
  public java.lang.String getUSE()
  Provide String value from inputOutput SFString field named USE.
  
  Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
  
  Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
  
  Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
  
  Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
  Overrides:
  
  getUSE in class X3DConcreteNode
  
  Returns:
  
  value of USE field
  
  See Also:
  
  X3D Scene Authoring Hints: Naming Conventions
- setUSE
  
  public final SurfaceEmitterObject setUSE(java.lang.String newValue)
  Accessor method to assign String value to inputOutput SFString field named USE.
  
  Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
  
  Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
  
  Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
  
  Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
  
  Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
  
  Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
  
  Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
  Specified by:
  
  setUSE in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the USE field.
  
  Returns:
  
  SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same 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 object).
- getCssClass
  
  public java.lang.String getCssClass()
  Provide String value from inputOutput SFString field named class.
  
  Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
  
  Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
  
  Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
  Overrides:
  
  getCssClass in class X3DConcreteNode
  
  Returns:
  
  value of class field
  
  See Also:
  
  W3C Cascading Style Sheets
- setCssClass
  
  public final SurfaceEmitterObject setCssClass(java.lang.String newValue)
  Accessor method to assign String value to inputOutput SFString field named class.
  
  Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
  
  Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
  
  Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
  Specified by:
  
  setCssClass in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the class field.
  
  Returns:
  
  SurfaceEmitterObject - 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 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 object).
- 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 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:
  
  SurfaceEmitterObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same 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 indentLevel)
  
  Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
  
  Specified by:
  
  toStringX3D in class X3DConcreteElement
  
  Parameters:
  
  indentLevel - number of levels of indentation for this element
  
  Returns:
  
  X3D string
  
  See Also:
  
  X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
- toStringClassicVRML
  
  public java.lang.String toStringClassicVRML(int indentLevel)
  
  Recursive method to provide ClassicVRML string serialization.
  
  Specified by:
  
  toStringClassicVRML in class X3DConcreteElement
  
  Parameters:
  
  indentLevel - number of levels of indentation for this element
  
  Returns:
  
  ClassicVRML string
  
  See Also:
  
  X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
- toStringVRML97
  
  public java.lang.String toStringVRML97(int indentLevel)
  
  Recursive method to provide VRML97 string serialization.
  
  Specified by:
  
  toStringVRML97 in class X3DConcreteElement
  
  Parameters:
  
  indentLevel - number of levels of indentation for this element
  
  Returns:
  
  VRML97 string
  
  See Also:
  
  X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
- findElementByNameValue
  
  public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
  
  Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
  
  Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
  
  Warning: more than one element may be found that has the same name, this method does not handle that case.
  
  Specified by:
  
  findElementByNameValue in class X3DConcreteElement
  
  Parameters:
  
  nameValue - is value of the name field being searched for in this element and child elements(if any)
  
  Returns:
  
  object reference to found element, null otherwise
  
  See Also:
  
  findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
- findElementByNameValue
  
  public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
  
  Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
  
  Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
  
  Warning: more than one element may be found that has the same name, this method does not handle that case.
  
  Specified by:
  
  findElementByNameValue in class X3DConcreteElement
  
  Parameters:
  
  nameValue - is value of the name field being searched for in this element and child elements(if any)
  
  elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
  
  Returns:
  
  object reference to found element, null otherwise
  
  See Also:
  
  findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
- hasElementByNameValue
  
  public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
  
  Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
  
  Parameters:
  
  nameValue - is value of the name field being searched for in this element and child elements(if any)
  
  elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
  
  Returns:
  
  whether node is found
  
  See Also:
  
  findElementByNameValue(String, String)
- findNodeByDEF
  
  public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
  
  Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
  
  Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
  
  Warning: more than one element may be found that has the same DEF, this method does not handle that case.
  
  Specified by:
  
  findNodeByDEF in class X3DConcreteElement
  
  Parameters:
  
  DEFvalue - is value of the name field being searched for in this element and child elements(if any)
  
  Returns:
  
  object reference to found node, null otherwise
  
  See Also:
  
  findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
- hasNodeByDEF
  
  public boolean hasNodeByDEF(java.lang.String DEFvalue)
  
  Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
  
  Parameters:
  
  DEFvalue - is value of the name field being searched for in this element and child elements(if any)
  
  Returns:
  
  whether node is found
  
  See Also:
  
  findNodeByDEF(String)
- validate
  
  public java.lang.String validate()
  
  Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
  
  Specified by:
  
  validate in class X3DConcreteElement
  
  Returns:
  
  validation results (if any)

Class SurfaceEmitterObject