Package org.web3d.x3d.jsail.ParticleSystems

Class PointEmitter

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.ParticleSystems.PointEmitter

All Implemented Interfaces:

X3DNode, PointEmitter, X3DParticleEmitterNode

public class PointEmitter
extends X3DConcreteNode
implements PointEmitter

PointEmitter generates particles from a specific point in space using the specified direction and speed.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. PointEmitter node tooltip: (X3D version 3.2 or later) [X3DParticleEmitterNode] PointEmitter generates particles from a specific point in space using the specified direction and speed. *


Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.

See Also:

• X3D Abstract Specification: PointEmitter
• X3D Tooltips: PointEmitter
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the PointEmitter element: ParticleSystems
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final float[]	DIRECTION_DEFAULT_VALUE	SFVec3f field named direction has default value {0f,1f,0f} (Java syntax) or 0 1 0 (XML syntax).
static final String	fromField_DIRECTION	fromField ROUTE name for SFVec3f field named direction.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_MASS	fromField ROUTE name for SFFloat field named mass.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_ON	fromField ROUTE name for SFBool field named on.
static final String	fromField_POSITION	fromField ROUTE name for SFVec3f field named position.
static final String	fromField_SPEED	fromField ROUTE name for SFFloat field named speed.
static final String	fromField_SURFACEAREA	fromField ROUTE name for SFFloat field named surfaceArea.
static final String	fromField_VARIATION	fromField ROUTE name for SFFloat field named variation.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D ParticleSystems component level for this element: 1
static final float	MASS_DEFAULT_VALUE	SFFloat field named mass has default value 0f (Java syntax) or 0 (XML syntax).
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: PointEmitter.
static final boolean	ON_DEFAULT_VALUE	SFBool field named on has default value true (Java syntax) or true (XML syntax).
static final float[]	POSITION_DEFAULT_VALUE	SFVec3f field named position has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
static final float	SPEED_DEFAULT_VALUE	SFFloat field named speed has default value 0f (Java syntax) or 0 (XML syntax).
static final float	SURFACEAREA_DEFAULT_VALUE	SFFloat field named surfaceArea has default value 0f (Java syntax) or 0 (XML syntax).
static final String	toField_DIRECTION	toField ROUTE name for SFVec3f field named direction.
static final String	toField_MASS	toField ROUTE name for SFFloat field named mass.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_ON	toField ROUTE name for SFBool field named on.
static final String	toField_POSITION	toField ROUTE name for SFVec3f field named position.
static final String	toField_SPEED	toField ROUTE name for SFFloat field named speed.
static final String	toField_SURFACEAREA	toField ROUTE name for SFFloat field named surfaceArea.
static final String	toField_VARIATION	toField ROUTE name for SFFloat field named variation.
static final 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

containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

Constructor	Description
PointEmitter()	Constructor for PointEmitter to initialize member variables with default values.
PointEmitter(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
PointEmitter	addComments(String newComment)	Add comment as String to contained commentsList.
PointEmitter	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
PointEmitter	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
PointEmitter	clearIS()	Utility method to clear SFNode value of IS field.
PointEmitter	clearMetadata()	Utility method to clear SFNode value of metadata field.
X3DConcreteElement	findElementByNameValue(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(String nameValue, 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(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
final String	getComponent()	Defines X3D component for the PointEmitter element: ParticleSystems
final int	getComponentLevel()	Provides default X3D component level for this element: 1
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
float[]	getDirection()	Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.
final String	getElementName()	Provides name of this element: PointEmitter
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS 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 org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
boolean	getOn()	Provide boolean value from inputOutput SFBool field named on.
float[]	getPosition()	Provide array of 3-tuple float results from inputOutput SFVec3f field named position.
float	getSpeed()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named speed.
float	getSurfaceArea()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named surfaceArea.
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(String nameValue, 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(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
final void	initialize()	Initialize all member variables to default values.
final PointEmitter	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
PointEmitter	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final PointEmitter	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
PointEmitter	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final PointEmitter	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
PointEmitter	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
PointEmitter	setDirection(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setDirection(float[]).
PointEmitter	setDirection(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setDirection(float[]).
PointEmitter	setDirection(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.
PointEmitter	setDirection(float x, float y, float z)	Assign values to SFVec3f direction field, similar to setDirection(float[]).
PointEmitter	setDirection(SFVec3f newValue)	Assign typed object value to SFVec3f direction field, similar to setDirection(float[]).
final PointEmitter	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
PointEmitter	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
PointEmitter	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
PointEmitter	setMass(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMass(float).
PointEmitter	setMass(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named mass.
PointEmitter	setMass(SFFloat newValue)	Assign typed object value to SFFloat mass field, similar to setMass(float).
PointEmitter	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
PointEmitter	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
PointEmitter	setOn(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named on.
PointEmitter	setOn(SFBool newValue)	Assign typed object value to SFBool on field, similar to setOn(boolean).
PointEmitter	setPosition(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setPosition(float[]).
PointEmitter	setPosition(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setPosition(float[]).
PointEmitter	setPosition(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named position.
PointEmitter	setPosition(float x, float y, float z)	Assign values to SFVec3f position field, similar to setPosition(float[]).
PointEmitter	setPosition(SFVec3f newValue)	Assign typed object value to SFVec3f position field, similar to setPosition(float[]).
PointEmitter	setSpeed(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSpeed(float).
PointEmitter	setSpeed(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named speed.
PointEmitter	setSpeed(SFFloat newValue)	Assign typed object value to SFFloat speed field, similar to setSpeed(float).
PointEmitter	setSurfaceArea(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSurfaceArea(float).
PointEmitter	setSurfaceArea(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named surfaceArea.
PointEmitter	setSurfaceArea(SFFloat newValue)	Assign typed object value to SFFloat surfaceArea field, similar to setSurfaceArea(float).
final PointEmitter	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
PointEmitter	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
PointEmitter	setUSE(PointEmitter DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
PointEmitter	setVariation(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setVariation(float).
PointEmitter	setVariation(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named variation.
PointEmitter	setVariation(SFFloat newValue)	Assign typed object value to SFFloat variation field, similar to setVariation(float).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
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

getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

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

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, 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 String NAME

String constant NAME provides name of this element: PointEmitter.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the PointEmitter element: ParticleSystems

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D ParticleSystems component level for this element: 1

See Also:

• Constant Field Values

DIRECTION_DEFAULT_VALUE

public static final float[] DIRECTION_DEFAULT_VALUE

SFVec3f field named direction has default value {0f,1f,0f} (Java syntax) or 0 1 0 (XML syntax).

IS_DEFAULT_VALUE

public static final IS 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).

ON_DEFAULT_VALUE

public static final boolean ON_DEFAULT_VALUE

SFBool field named on has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

POSITION_DEFAULT_VALUE

public static final float[] POSITION_DEFAULT_VALUE

SFVec3f field named position has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).

SPEED_DEFAULT_VALUE

public static final float SPEED_DEFAULT_VALUE

SFFloat field named speed has default value 0f (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

SURFACEAREA_DEFAULT_VALUE

public static final float SURFACEAREA_DEFAULT_VALUE

SFFloat field named surfaceArea has default value 0f (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

VARIATION_DEFAULT_VALUE

public static final float VARIATION_DEFAULT_VALUE

SFFloat field named variation has default value 0.25f (Java syntax) or 0.25 (XML syntax).

See Also:

• Constant Field Values

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "emitter";
containerField_ALLOWED_VALUES = {"emitter" }; type xs:NMTOKEN

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_DIRECTION

public static final String fromField_DIRECTION

fromField ROUTE name for SFVec3f field named direction.

See Also:

• Constant Field Values

toField_DIRECTION

public static final String toField_DIRECTION

toField ROUTE name for SFVec3f field named direction.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_MASS

public static final String fromField_MASS

fromField ROUTE name for SFFloat field named mass.

See Also:

• Constant Field Values

toField_MASS

public static final String toField_MASS

toField ROUTE name for SFFloat field named mass.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_ON

public static final String fromField_ON

fromField ROUTE name for SFBool field named on.

See Also:

• Constant Field Values

toField_ON

public static final String toField_ON

toField ROUTE name for SFBool field named on.

See Also:

• Constant Field Values

fromField_POSITION

public static final String fromField_POSITION

fromField ROUTE name for SFVec3f field named position.

See Also:

• Constant Field Values

toField_POSITION

public static final String toField_POSITION

toField ROUTE name for SFVec3f field named position.

See Also:

• Constant Field Values

fromField_SPEED

public static final String fromField_SPEED

fromField ROUTE name for SFFloat field named speed.

See Also:

• Constant Field Values

toField_SPEED

public static final String toField_SPEED

toField ROUTE name for SFFloat field named speed.

See Also:

• Constant Field Values

fromField_SURFACEAREA

public static final String fromField_SURFACEAREA

fromField ROUTE name for SFFloat field named surfaceArea.

See Also:

• Constant Field Values

toField_SURFACEAREA

public static final String toField_SURFACEAREA

toField ROUTE name for SFFloat field named surfaceArea.

See Also:

• Constant Field Values

fromField_VARIATION

public static final String fromField_VARIATION

fromField ROUTE name for SFFloat field named variation.

See Also:

• Constant Field Values

toField_VARIATION

public static final String toField_VARIATION

toField ROUTE name for SFFloat field named variation.

See Also:

• Constant Field Values

Constructor Details

PointEmitter

public PointEmitter()

Constructor for PointEmitter to initialize member variables with default values.

PointEmitter

public PointEmitter(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 String getElementName()

Provides name of this element: PointEmitter

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the PointEmitter element: ParticleSystems

Specified by:

getComponent in class X3DConcreteElement

Returns:

X3D component for this element

getComponentLevel

public final int getComponentLevel()

Provides default X3D component level for this element: 1

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public String getFieldType(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 String getAccessType(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 String getContainerFieldDefault()

containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getDirection

public float[] getDirection()

Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.

Tooltip: Initial direction from which particles emanate. *

Specified by:

getDirection in interface PointEmitter

Returns:

value of direction field

setDirection

public PointEmitter setDirection(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.

Tooltip: Initial direction from which particles emanate. *

Specified by:

setDirection in interface PointEmitter

Parameters:

newValue - is new value for the direction field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDirection

public PointEmitter setDirection(SFVec3f newValue)

Assign typed object value to SFVec3f direction field, similar to setDirection(float[]).

Parameters:

newValue - is new value for the direction field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDirection

public PointEmitter setDirection(float x,
 float y,
 float z)

Assign values to SFVec3f direction field, similar to setDirection(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDirection

public PointEmitter setDirection(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setDirection(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDirection

public PointEmitter setDirection(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setDirection(float[]).

Parameters:

newArray - is new value for field

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getIS

public IS getIS()

Provide IS 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 PointEmitter setIS(IS newValue)

Accessor method to assign IS 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:

PointEmitter - 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 PointEmitter clearIS()

Utility method to clear SFNode value of IS field.

Returns:

PointEmitter - 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/concepts.html#Standardunitscoordinates

Specified by:

getMass in interface PointEmitter

Specified by:

getMass in interface X3DParticleEmitterNode

Returns:

value of mass field

setMass

public PointEmitter 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/concepts.html#Standardunitscoordinates

Specified by:

setMass in interface PointEmitter

Specified by:

setMass in interface X3DParticleEmitterNode

Parameters:

newValue - is new value for the mass field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setMass

public PointEmitter setMass(SFFloat newValue)

Assign typed object value to SFFloat mass field, similar to setMass(float).

Parameters:

newValue - is new value for the mass field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setMass

public PointEmitter 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:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getMetadata

public X3DMetadataObject getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface PointEmitter

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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public PointEmitter setMetadata(X3DMetadataObject newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in interface PointEmitter

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:

PointEmitter - 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public PointEmitter clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public PointEmitter setMetadata(ProtoInstance 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:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setMetadata(org.web3d.x3d.sai.Core.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

getOn

public boolean getOn()

Provide boolean value from inputOutput SFBool field named on.

Tooltip: Enables/disables production of particles from this emitter node. If operating when turned off, existing particles complete their rendering process. *

Specified by:

getOn in interface PointEmitter

Specified by:

getOn in interface X3DParticleEmitterNode

Returns:

value of on field

setOn

public PointEmitter setOn(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named on.

Tooltip: Enables/disables production of particles from this emitter node. If operating when turned off, existing particles complete their rendering process. *

Specified by:

setOn in interface PointEmitter

Specified by:

setOn in interface X3DParticleEmitterNode

Parameters:

newValue - is new value for the on field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setOn

public PointEmitter setOn(SFBool newValue)

Assign typed object value to SFBool on field, similar to setOn(boolean).

Parameters:

newValue - is new value for the on field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getPosition

public float[] getPosition()

Provide array of 3-tuple float results from inputOutput SFVec3f field named position.

Tooltip: Point from which particles emanate. *

Specified by:

getPosition in interface PointEmitter

Returns:

value of position field

setPosition

public PointEmitter setPosition(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named position.

Tooltip: Point from which particles emanate. *

Specified by:

setPosition in interface PointEmitter

Parameters:

newValue - is new value for the position field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setPosition

public PointEmitter setPosition(SFVec3f newValue)

Assign typed object value to SFVec3f position field, similar to setPosition(float[]).

Parameters:

newValue - is new value for the position field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setPosition

public PointEmitter setPosition(float x,
 float y,
 float z)

Assign values to SFVec3f position field, similar to setPosition(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setPosition

public PointEmitter setPosition(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setPosition(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setPosition

public PointEmitter setPosition(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setPosition(float[]).

Parameters:

newArray - is new value for field

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getSpeed

public float getSpeed()

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

Tooltip: [0,+infinity) Initial linear speed (default is m/s) imparted to all particles along their direction of movement. *

Specified by:

getSpeed in interface PointEmitter

Specified by:

getSpeed in interface X3DParticleEmitterNode

Returns:

value of speed field

setSpeed

public PointEmitter 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 PointEmitter

Specified by:

setSpeed in interface X3DParticleEmitterNode

Parameters:

newValue - is new value for the speed field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setSpeed

public PointEmitter setSpeed(SFFloat newValue)

Assign typed object value to SFFloat speed field, similar to setSpeed(float).

Parameters:

newValue - is new value for the speed field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setSpeed

public PointEmitter 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:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getSurfaceArea

public float getSurfaceArea()

Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named surfaceArea.

Tooltip: [0,+infinity) Particle surface area in area base units (default is meters squared). Surface area is used for calculations such as wind effects per particle.

• Hint: surfaceArea value represents average frontal area presented to the wind.
• Hint: assumes spherical model for each particle (i.e., surface area is the same regardless of direction).

Specified by:

getSurfaceArea in interface PointEmitter

Specified by:

getSurfaceArea in interface X3DParticleEmitterNode

Returns:

value of surfaceArea field

setSurfaceArea

public PointEmitter setSurfaceArea(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named surfaceArea.

Tooltip: [0,+infinity) Particle surface area in area base units (default is meters squared). Surface area is used for calculations such as wind effects per particle.

• Hint: surfaceArea value represents average frontal area presented to the wind.
• Hint: assumes spherical model for each particle (i.e., surface area is the same regardless of direction).

Specified by:

setSurfaceArea in interface PointEmitter

Specified by:

setSurfaceArea in interface X3DParticleEmitterNode

Parameters:

newValue - is new value for the surfaceArea field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setSurfaceArea

public PointEmitter setSurfaceArea(SFFloat newValue)

Assign typed object value to SFFloat surfaceArea field, similar to setSurfaceArea(float).

Parameters:

newValue - is new value for the surfaceArea field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setSurfaceArea

public PointEmitter 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:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getVariation

public float getVariation()

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

Tooltip: [0,+infinity) Multiplier for the randomness used to control the range of possible output values. The bigger the value, the more random the output and the bigger the range of possible initial values possible.

• Hint: variation of zero does not allow any randomness.

Specified by:

getVariation in interface PointEmitter

Specified by:

getVariation in interface X3DParticleEmitterNode

Returns:

value of variation field

setVariation

public PointEmitter 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 PointEmitter

Specified by:

setVariation in interface X3DParticleEmitterNode

Parameters:

newValue - is new value for the variation field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setVariation

public PointEmitter setVariation(SFFloat newValue)

Assign typed object value to SFFloat variation field, similar to setVariation(float).

Parameters:

newValue - is new value for the variation field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setVariation

public PointEmitter 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:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getDEF

public 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 PointEmitter setDEF(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:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

public PointEmitter setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

Parameters:

newValue - is new value for the DEF field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getUSE

public 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 PointEmitter setUSE(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:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public PointEmitter setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

Parameters:

newValue - is new value for the USE field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final PointEmitter setCssClass(String newValue)

Accessor method to assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public PointEmitter setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

Parameters:

newValue - is new value for the class field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlID in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final PointEmitter setHtmlID(String newValue)

Accessor method to assign String value to inputOutput SFString field named id.

Specified by:

setHtmlID in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public PointEmitter setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).

Parameters:

newValue - is new value for the id field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final PointEmitter setCssStyle(String newValue)

Accessor method to assign String value to inputOutput SFString field named style.

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public PointEmitter setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public PointEmitter setUSE(PointEmitter 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:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addComments

public PointEmitter addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public PointEmitter addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public PointEmitter addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

toStringX3D

public 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:

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D.toStringXML()
• X3D.toFileXML(String)
• X3D.toFileX3D(String)
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringClassicVRML

public 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:

• X3D.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 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:

• X3D.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(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue,
 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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasElementByNameValue

public boolean hasElementByNameValue(String nameValue,
 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(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasNodeByDEF

public boolean hasNodeByDEF(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 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. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)