Package org.web3d.x3d.jsail.Sound

Class Sound

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Sound.Sound

All Implemented Interfaces:

X3DChildNode, X3DNode, Sound, X3DSoundNode

public class Sound
extends X3DConcreteNode
implements Sound

The Sound node controls the 3D spatialization of sound playback by a child AudioClip or MovieTexture node.

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. Sound node tooltip: [X3DSoundNode] The Sound node controls the 3D spatialization of sound playback by a child AudioClip or MovieTexture node. Sound intensity includes stereo support, varying according to user location and view direction in the scene.

• Hint: if the audio source is stereo or multi-channel, channel separation is retained during playback.
• Warning: while providing sounds on the ground plane, ensure that the audible auralization volume is sufficiently elevated to match avatar height.
• Hint: X3D Sound component Figure 16.2 Sound Node Geometry, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/sound.html#f-Soundnodegeometry
• Hint: X3D Scene Authoring Hints:Audio https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Audio
• Hint: Wikipedia 3D sound localization https://en.wikipedia.org/wiki/3D_sound_localization

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: Sound
• X3D Tooltips: Sound
• X3D Scene Authoring Hints: Audio

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the Sound element: Sound
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	DESCRIPTION_DEFAULT_VALUE	SFString field named description has default value equal to an empty string.
static final float[]	DIRECTION_DEFAULT_VALUE	SFVec3f field named direction has default value {0f,0f,1f} (Java syntax) or 0 0 1 (XML syntax).
static final boolean	ENABLED_DEFAULT_VALUE	SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
static final String	fromField_DESCRIPTION	fromField ROUTE name for SFString field named description.
static final String	fromField_DIRECTION	fromField ROUTE name for SFVec3f field named direction.
static final String	fromField_ENABLED	fromField ROUTE name for SFBool field named enabled.
static final String	fromField_INTENSITY	fromField ROUTE name for SFFloat field named intensity.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_LOCATION	fromField ROUTE name for SFVec3f field named location.
static final String	fromField_MAXBACK	fromField ROUTE name for SFFloat field named maxBack.
static final String	fromField_MAXFRONT	fromField ROUTE name for SFFloat field named maxFront.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_MINBACK	fromField ROUTE name for SFFloat field named minBack.
static final String	fromField_MINFRONT	fromField ROUTE name for SFFloat field named minFront.
static final String	fromField_PRIORITY	fromField ROUTE name for SFFloat field named priority.
static final String	fromField_SOURCE	fromField ROUTE name for SFNode field named source.
static final float	INTENSITY_DEFAULT_VALUE	SFFloat field named intensity has default value 1f (Java syntax) or 1 (XML syntax).
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 Sound component level for this element: 1
static final float[]	LOCATION_DEFAULT_VALUE	SFVec3f field named location has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
static final float	MAXBACK_DEFAULT_VALUE	SFFloat field named maxBack has default value 10f (Java syntax) or 10 (XML syntax).
static final float	MAXFRONT_DEFAULT_VALUE	SFFloat field named maxFront has default value 10f (Java syntax) or 10 (XML syntax).
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final float	MINBACK_DEFAULT_VALUE	SFFloat field named minBack has default value 1f (Java syntax) or 1 (XML syntax).
static final float	MINFRONT_DEFAULT_VALUE	SFFloat field named minFront has default value 1f (Java syntax) or 1 (XML syntax).
static final String	NAME	String constant NAME provides name of this element: Sound.
static final float	PRIORITY_DEFAULT_VALUE	SFFloat field named priority has default value 0f (Java syntax) or 0 (XML syntax).
static final X3DSoundSourceNode	SOURCE_DEFAULT_VALUE	SFNode field named source has default value null (Java syntax) or NULL (XML syntax).
static final boolean	SPATIALIZE_DEFAULT_VALUE	SFBool field named spatialize has default value true (Java syntax) or true (XML syntax).
static final String	toField_DESCRIPTION	toField ROUTE name for SFString field named description.
static final String	toField_DIRECTION	toField ROUTE name for SFVec3f field named direction.
static final String	toField_ENABLED	toField ROUTE name for SFBool field named enabled.
static final String	toField_INTENSITY	toField ROUTE name for SFFloat field named intensity.
static final String	toField_LOCATION	toField ROUTE name for SFVec3f field named location.
static final String	toField_MAXBACK	toField ROUTE name for SFFloat field named maxBack.
static final String	toField_MAXFRONT	toField ROUTE name for SFFloat field named maxFront.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_MINBACK	toField ROUTE name for SFFloat field named minBack.
static final String	toField_MINFRONT	toField ROUTE name for SFFloat field named minFront.
static final String	toField_PRIORITY	toField ROUTE name for SFFloat field named priority.
static final String	toField_SOURCE	toField ROUTE name for SFNode field named source.

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

containerField_ALTERNATE_VALUES, 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
Sound()	Constructor for Sound to initialize member variables with default values.
Sound(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
Sound	addComments(String newComment)	Add comment as String to contained commentsList.
Sound	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
Sound	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
Sound	clearIS()	Utility method to clear SFNode value of IS field.
Sound	clearMetadata()	Utility method to clear SFNode value of metadata field.
Sound	clearSource()	Utility method to clear SFNode value of source 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 Sound element: Sound
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.
String	getDescription()	Provide String value from inputOutput SFString field named description.
float[]	getDirection()	Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.
final String	getElementName()	Provides name of this element: Sound
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
float	getIntensity()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named intensity.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
float[]	getLocation()	Provide array of 3-tuple float results from inputOutput SFVec3f field named location.
float	getMaxBack()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named maxBack.
float	getMaxFront()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named maxFront.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float	getMinBack()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named minBack.
float	getMinFront()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named minFront.
float	getPriority()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named priority.
X3DSoundSourceNode	getSource()	Provide org.web3d.x3d.sai.Sound.X3DSoundSourceNode instance (using a properly typed node) from inputOutput SFNode field source.
boolean	getSpatialize()	Provide boolean value from initializeOnly SFBool field named spatialize.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
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.
boolean	hasSource()	Indicate whether an object is available for inputOutput SFNode field source.
final void	initialize()	Initialize all member variables to default values.
final Sound	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
Sound	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final Sound	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
Sound	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final Sound	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
Sound	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
Sound	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
Sound	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
Sound	setDirection(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setDirection(float[]).
Sound	setDirection(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setDirection(float[]).
Sound	setDirection(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.
Sound	setDirection(float x, float y, float z)	Assign values to SFVec3f direction field, similar to setDirection(float[]).
Sound	setDirection(SFVec3f newValue)	Assign typed object value to SFVec3f direction field, similar to setDirection(float[]).
Sound	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
Sound	setEnabled(SFBool newValue)	Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
final Sound	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
Sound	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
Sound	setIntensity(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setIntensity(float).
Sound	setIntensity(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named intensity.
Sound	setIntensity(SFFloat newValue)	Assign typed object value to SFFloat intensity field, similar to setIntensity(float).
Sound	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
Sound	setLocation(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setLocation(float[]).
Sound	setLocation(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setLocation(float[]).
Sound	setLocation(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named location.
Sound	setLocation(float x, float y, float z)	Assign values to SFVec3f location field, similar to setLocation(float[]).
Sound	setLocation(SFVec3f newValue)	Assign typed object value to SFVec3f location field, similar to setLocation(float[]).
Sound	setMaxBack(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMaxBack(float).
Sound	setMaxBack(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named maxBack.
Sound	setMaxBack(SFFloat newValue)	Assign typed object value to SFFloat maxBack field, similar to setMaxBack(float).
Sound	setMaxFront(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMaxFront(float).
Sound	setMaxFront(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named maxFront.
Sound	setMaxFront(SFFloat newValue)	Assign typed object value to SFFloat maxFront field, similar to setMaxFront(float).
Sound	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
Sound	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Sound	setMinBack(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMinBack(float).
Sound	setMinBack(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named minBack.
Sound	setMinBack(SFFloat newValue)	Assign typed object value to SFFloat minBack field, similar to setMinBack(float).
Sound	setMinFront(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMinFront(float).
Sound	setMinFront(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named minFront.
Sound	setMinFront(SFFloat newValue)	Assign typed object value to SFFloat minFront field, similar to setMinFront(float).
Sound	setPriority(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setPriority(float).
Sound	setPriority(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named priority.
Sound	setPriority(SFFloat newValue)	Assign typed object value to SFFloat priority field, similar to setPriority(float).
Sound	setSource(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field source.
Sound	setSource(X3DSoundSourceNode newValue)	Accessor method to assign org.web3d.x3d.sai.Sound.X3DSoundSourceNode instance (using a properly typed node) to inputOutput SFNode field source.
Sound	setSpatialize(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named spatialize.
Sound	setSpatialize(SFBool newValue)	Assign typed object value to SFBool spatialize field, similar to setSpatialize(boolean).
final Sound	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
Sound	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
Sound	setUSE(Sound DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
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

getContainerFieldAlternateValues, 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: Sound.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the Sound element: Sound

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

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

See Also:

• Constant Field Values

DESCRIPTION_DEFAULT_VALUE

public static final String DESCRIPTION_DEFAULT_VALUE

SFString field named description has default value equal to an empty string.

See Also:

• Constant Field Values

DIRECTION_DEFAULT_VALUE

public static final float[] DIRECTION_DEFAULT_VALUE

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

ENABLED_DEFAULT_VALUE

public static final boolean ENABLED_DEFAULT_VALUE

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

See Also:

• Constant Field Values

INTENSITY_DEFAULT_VALUE

public static final float INTENSITY_DEFAULT_VALUE

SFFloat field named intensity has default value 1f (Java syntax) or 1 (XML syntax).

See Also:

• Constant Field Values

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

LOCATION_DEFAULT_VALUE

public static final float[] LOCATION_DEFAULT_VALUE

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

MAXBACK_DEFAULT_VALUE

public static final float MAXBACK_DEFAULT_VALUE

SFFloat field named maxBack has default value 10f (Java syntax) or 10 (XML syntax).

See Also:

• Constant Field Values

MAXFRONT_DEFAULT_VALUE

public static final float MAXFRONT_DEFAULT_VALUE

SFFloat field named maxFront has default value 10f (Java syntax) or 10 (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).

MINBACK_DEFAULT_VALUE

public static final float MINBACK_DEFAULT_VALUE

SFFloat field named minBack has default value 1f (Java syntax) or 1 (XML syntax).

See Also:

• Constant Field Values

MINFRONT_DEFAULT_VALUE

public static final float MINFRONT_DEFAULT_VALUE

SFFloat field named minFront has default value 1f (Java syntax) or 1 (XML syntax).

See Also:

• Constant Field Values

PRIORITY_DEFAULT_VALUE

public static final float PRIORITY_DEFAULT_VALUE

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

See Also:

• Constant Field Values

SOURCE_DEFAULT_VALUE

public static final X3DSoundSourceNode SOURCE_DEFAULT_VALUE

SFNode field named source has default value null (Java syntax) or NULL (XML syntax).

SPATIALIZE_DEFAULT_VALUE

public static final boolean SPATIALIZE_DEFAULT_VALUE

SFBool field named spatialize has default value true (Java syntax) or true (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, default value is provided for informational purposes.

See Also:

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

fromField_DESCRIPTION

public static final String fromField_DESCRIPTION

fromField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

toField_DESCRIPTION

public static final String toField_DESCRIPTION

toField ROUTE name for SFString field named description.

See Also:

• 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_ENABLED

public static final String fromField_ENABLED

fromField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

toField_ENABLED

public static final String toField_ENABLED

toField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

fromField_INTENSITY

public static final String fromField_INTENSITY

fromField ROUTE name for SFFloat field named intensity.

See Also:

• Constant Field Values

toField_INTENSITY

public static final String toField_INTENSITY

toField ROUTE name for SFFloat field named intensity.

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_LOCATION

public static final String fromField_LOCATION

fromField ROUTE name for SFVec3f field named location.

See Also:

• Constant Field Values

toField_LOCATION

public static final String toField_LOCATION

toField ROUTE name for SFVec3f field named location.

See Also:

• Constant Field Values

fromField_MAXBACK

public static final String fromField_MAXBACK

fromField ROUTE name for SFFloat field named maxBack.

See Also:

• Constant Field Values

toField_MAXBACK

public static final String toField_MAXBACK

toField ROUTE name for SFFloat field named maxBack.

See Also:

• Constant Field Values

fromField_MAXFRONT

public static final String fromField_MAXFRONT

fromField ROUTE name for SFFloat field named maxFront.

See Also:

• Constant Field Values

toField_MAXFRONT

public static final String toField_MAXFRONT

toField ROUTE name for SFFloat field named maxFront.

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_MINBACK

public static final String fromField_MINBACK

fromField ROUTE name for SFFloat field named minBack.

See Also:

• Constant Field Values

toField_MINBACK

public static final String toField_MINBACK

toField ROUTE name for SFFloat field named minBack.

See Also:

• Constant Field Values

fromField_MINFRONT

public static final String fromField_MINFRONT

fromField ROUTE name for SFFloat field named minFront.

See Also:

• Constant Field Values

toField_MINFRONT

public static final String toField_MINFRONT

toField ROUTE name for SFFloat field named minFront.

See Also:

• Constant Field Values

fromField_PRIORITY

public static final String fromField_PRIORITY

fromField ROUTE name for SFFloat field named priority.

See Also:

• Constant Field Values

toField_PRIORITY

public static final String toField_PRIORITY

toField ROUTE name for SFFloat field named priority.

See Also:

• Constant Field Values

fromField_SOURCE

public static final String fromField_SOURCE

fromField ROUTE name for SFNode field named source.

See Also:

• Constant Field Values

toField_SOURCE

public static final String toField_SOURCE

toField ROUTE name for SFNode field named source.

See Also:

• Constant Field Values

Constructor Details

Sound

public Sound()

Constructor for Sound to initialize member variables with default values.

Sound

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the Sound element: Sound

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

getDescription

public String getDescription()

Provide String value from inputOutput SFString field named description.

Tooltip: Author-provided prose that describes intended purpose of this node.

• Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable.
• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

getDescription in interface Sound

Specified by:

getDescription in interface X3DSoundNode

Returns:

value of description field

setDescription

public Sound setDescription(String newValue)

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

Tooltip: Author-provided prose that describes intended purpose of this node.

• Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable.
• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

setDescription in interface Sound

Specified by:

setDescription in interface X3DSoundNode

Parameters:

newValue - is new value for the description field.

Returns:

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

setDescription

public Sound setDescription(SFString newValue)

Assign typed object value to SFString description field, similar to setDescription(String).

Parameters:

newValue - is new value for the description field.

Returns:

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

getDirection

public float[] getDirection()

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

Tooltip: direction of sound axis, relative to local coordinate system. *

Specified by:

getDirection in interface Sound

Returns:

value of direction field

setDirection

public Sound setDirection(float[] newValue)

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

Tooltip: direction of sound axis, relative to local coordinate system. *

Specified by:

setDirection in interface Sound

Parameters:

newValue - is new value for the direction field.

Returns:

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

setDirection

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

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

setDirection

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

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

setDirection

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

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

setDirection

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

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

getEnabled

public boolean getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Specified by:

getEnabled in interface Sound

Specified by:

getEnabled in interface X3DSoundNode

Returns:

value of enabled field

setEnabled

public Sound setEnabled(boolean newValue)

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

Tooltip: Enables/disables node operation. *

Specified by:

setEnabled in interface Sound

Specified by:

setEnabled in interface X3DSoundNode

Parameters:

newValue - is new value for the enabled field.

Returns:

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

setEnabled

public Sound setEnabled(SFBool newValue)

Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).

Parameters:

newValue - is new value for the enabled field.

Returns:

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

getIntensity

public float getIntensity()

Provide float value within allowed range of [0,1] from inputOutput SFFloat field named intensity.

Tooltip: Factor [0,1] adjusting loudness (decibels) of emitted sound. *

Specified by:

getIntensity in interface Sound

Returns:

value of intensity field

setIntensity

public Sound setIntensity(float newValue)

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

Tooltip: Factor [0,1] adjusting loudness (decibels) of emitted sound. *

Specified by:

setIntensity in interface Sound

Parameters:

newValue - is new value for the intensity field.

Returns:

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

setIntensity

public Sound setIntensity(SFFloat newValue)

Assign typed object value to SFFloat intensity field, similar to setIntensity(float).

Parameters:

newValue - is new value for the intensity field.

Returns:

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

setIntensity

public Sound setIntensity(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setIntensity(float).

Parameters:

newValue - is new value for field

Returns:

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

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

Utility method to clear SFNode value of IS field.

Returns:

Sound - 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()

getLocation

public float[] getLocation()

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

Tooltip: Position of sound ellipsoid center, relative to local coordinate system.

• Hint: improve audibility by setting location='0 1.6 0' so that center height of sound ellipsoid matches typical NavigationInfo avatarSize height.

Specified by:

getLocation in interface Sound

Returns:

value of location field

setLocation

public Sound setLocation(float[] newValue)

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

Tooltip: Position of sound ellipsoid center, relative to local coordinate system.

• Hint: improve audibility by setting location='0 1.6 0' so that center height of sound ellipsoid matches typical NavigationInfo avatarSize height.

Specified by:

setLocation in interface Sound

Parameters:

newValue - is new value for the location field.

Returns:

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

setLocation

public Sound setLocation(SFVec3f newValue)

Assign typed object value to SFVec3f location field, similar to setLocation(float[]).

Parameters:

newValue - is new value for the location field.

Returns:

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

setLocation

public Sound setLocation(float x,
 float y,
 float z)

Assign values to SFVec3f location field, similar to setLocation(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setLocation

public Sound setLocation(double x,
 double y,
 double z)

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

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setLocation

public Sound setLocation(double[] newArray)

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

Parameters:

newArray - is new value for field

Returns:

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

getMaxBack

public float getMaxBack()

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

Tooltip: Outer (zero loudness)ellipsoid distance along back direction.

• Warning: ensure minBack <= maxBack.

Specified by:

getMaxBack in interface Sound

Returns:

value of maxBack field

setMaxBack

public Sound setMaxBack(float newValue)

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

Tooltip: Outer (zero loudness)ellipsoid distance along back direction.

• Warning: ensure minBack <= maxBack.

Specified by:

setMaxBack in interface Sound

Parameters:

newValue - is new value for the maxBack field.

Returns:

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

setMaxBack

public Sound setMaxBack(SFFloat newValue)

Assign typed object value to SFFloat maxBack field, similar to setMaxBack(float).

Parameters:

newValue - is new value for the maxBack field.

Returns:

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

setMaxBack

public Sound setMaxBack(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMaxBack(float).

Parameters:

newValue - is new value for field

Returns:

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

getMaxFront

public float getMaxFront()

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

Tooltip: Outer (zero loudness)ellipsoid distance along front direction.

• Warning: ensure minFront <= maxFront.

Specified by:

getMaxFront in interface Sound

Returns:

value of maxFront field

setMaxFront

public Sound setMaxFront(float newValue)

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

Tooltip: Outer (zero loudness)ellipsoid distance along front direction.

• Warning: ensure minFront <= maxFront.

Specified by:

setMaxFront in interface Sound

Parameters:

newValue - is new value for the maxFront field.

Returns:

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

setMaxFront

public Sound setMaxFront(SFFloat newValue)

Assign typed object value to SFFloat maxFront field, similar to setMaxFront(float).

Parameters:

newValue - is new value for the maxFront field.

Returns:

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

setMaxFront

public Sound setMaxFront(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMaxFront(float).

Parameters:

newValue - is new value for field

Returns:

Sound - 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 Sound

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DSoundNode

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 Sound 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 Sound

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DSoundNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

Sound - 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 Sound clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

Sound - 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

getMinBack

public float getMinBack()

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

Tooltip: Inner (full loudness) ellipsoid distance along back direction.

• Warning: ensure minBack <= maxBack.

Specified by:

getMinBack in interface Sound

Returns:

value of minBack field

setMinBack

public Sound setMinBack(float newValue)

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

Tooltip: Inner (full loudness) ellipsoid distance along back direction.

• Warning: ensure minBack <= maxBack.

Specified by:

setMinBack in interface Sound

Parameters:

newValue - is new value for the minBack field.

Returns:

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

setMinBack

public Sound setMinBack(SFFloat newValue)

Assign typed object value to SFFloat minBack field, similar to setMinBack(float).

Parameters:

newValue - is new value for the minBack field.

Returns:

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

setMinBack

public Sound setMinBack(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMinBack(float).

Parameters:

newValue - is new value for field

Returns:

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

getMinFront

public float getMinFront()

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

Tooltip: Inner (full loudness) ellipsoid distance along front direction.

• Warning: ensure minFront <= maxFront.

Specified by:

getMinFront in interface Sound

Returns:

value of minFront field

setMinFront

public Sound setMinFront(float newValue)

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

Tooltip: Inner (full loudness) ellipsoid distance along front direction.

• Warning: ensure minFront <= maxFront.

Specified by:

setMinFront in interface Sound

Parameters:

newValue - is new value for the minFront field.

Returns:

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

setMinFront

public Sound setMinFront(SFFloat newValue)

Assign typed object value to SFFloat minFront field, similar to setMinFront(float).

Parameters:

newValue - is new value for the minFront field.

Returns:

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

setMinFront

public Sound setMinFront(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMinFront(float).

Parameters:

newValue - is new value for field

Returns:

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

getPriority

public float getPriority()

Provide float value within allowed range of [0,1] from inputOutput SFFloat field named priority.

Tooltip: Player hint [0,1] if needed to choose which sounds to play. *

Specified by:

getPriority in interface Sound

Returns:

value of priority field

setPriority

public Sound setPriority(float newValue)

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

Tooltip: Player hint [0,1] if needed to choose which sounds to play. *

Specified by:

setPriority in interface Sound

Parameters:

newValue - is new value for the priority field.

Returns:

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

setPriority

public Sound setPriority(SFFloat newValue)

Assign typed object value to SFFloat priority field, similar to setPriority(float).

Parameters:

newValue - is new value for the priority field.

Returns:

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

setPriority

public Sound setPriority(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setPriority(float).

Parameters:

newValue - is new value for field

Returns:

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

getSource

public X3DSoundSourceNode getSource()

Provide org.web3d.x3d.sai.Sound.X3DSoundSourceNode instance (using a properly typed node) from inputOutput SFNode field source.

Specified by:

getSource in interface Sound

Returns:

value of source field

See Also:

• 
  
  Tooltip: [X3DSoundSourceNode] sound source for the Sound node, either an AudioClip node or a MovieTexture node.
  • Warning: if source field is not specified, the Sound node does not emit audio.

setSource

public Sound setSource(X3DSoundSourceNode newValue)

Accessor method to assign org.web3d.x3d.sai.Sound.X3DSoundSourceNode instance (using a properly typed node) to inputOutput SFNode field source.

Specified by:

setSource in interface Sound

Parameters:

newValue - is new value for the source field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DSoundSourceNode] sound source for the Sound node, either an AudioClip node or a MovieTexture node.
  • Warning: if source field is not specified, the Sound node does not emit audio.

clearSource

public Sound clearSource()

Utility method to clear SFNode value of source field.

Returns:

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

setSource

public Sound setSource(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field source.

Parameters:

newValue - is new value for the source field.

Returns:

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

See Also:

• setSource(org.web3d.x3d.sai.Sound.X3DSoundSourceNode)

hasSource

public boolean hasSource()

Indicate whether an object is available for inputOutput SFNode field source.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getSource()
• getSourceProtoInstance()

getSpatialize

public boolean getSpatialize()

Provide boolean value from initializeOnly SFBool field named spatialize.

Tooltip: Whether to spatialize sound playback relative to viewer.

• Hint: only effective within the auralization volume.

Specified by:

getSpatialize in interface Sound

Returns:

value of spatialize field

setSpatialize

public Sound setSpatialize(boolean newValue)

Accessor method to assign boolean value to initializeOnly SFBool field named spatialize.

Tooltip: Whether to spatialize sound playback relative to viewer.

• Hint: only effective within the auralization volume.

Specified by:

setSpatialize in interface Sound

Parameters:

newValue - is new value for the spatialize field.

Returns:

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

setSpatialize

public Sound setSpatialize(SFBool newValue)

Assign typed object value to SFBool spatialize field, similar to setSpatialize(boolean).

Parameters:

newValue - is new value for the spatialize field.

Returns:

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

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

addComments

public Sound addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

Sound - 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 Sound addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public Sound addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

Sound - 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)