Class SpatialSound

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Sound.SpatialSound

All Implemented Interfaces:

X3DChildNode, X3DNode, SpatialSound, X3DSoundNode

public class SpatialSound
extends X3DConcreteNode
implements SpatialSound

The SpatialSound 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. SpatialSound node tooltip: [X3DSoundNode] The SpatialSound 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: W3C Web Audio API, PannerNode Interface https://www.w3.org/TR/webaudio/#pannernode
• 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: SpatialSound
• X3D Tooltips: SpatialSound
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the SpatialSound element: Sound
static final float	CONEINNERANGLE_DEFAULT_VALUE	SFFloat field named coneInnerAngle has default value 6.2832f (Java syntax) or 6.2832 (XML syntax).
static final float	CONEOUTERANGLE_DEFAULT_VALUE	SFFloat field named coneOuterAngle has default value 6.2832f (Java syntax) or 6.2832 (XML syntax).
static final float	CONEOUTERGAIN_DEFAULT_VALUE	SFFloat field named coneOuterGain has default value 0f (Java syntax) or 0 (XML syntax).
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 String	DISTANCEMODEL_DEFAULT_VALUE	SFString field named distanceModel has default value "INVERSE" (Java syntax) or INVERSE (XML syntax).
static final String	DISTANCEMODEL_EXPONENTIAL	Tooltip: X3D version of "exponential" in Web Audio API.
static final String	DISTANCEMODEL_EXPONENTIAL_ALIAS	SFString SFString enumeration value "EXPONENTIAL" has alias "exponential"
static final String	DISTANCEMODEL_INVERSE	Tooltip: X3D version of "inverse" in Web Audio API.
static final String	DISTANCEMODEL_INVERSE_ALIAS	SFString SFString enumeration value "INVERSE" has alias "inverse"
static final String	DISTANCEMODEL_LINEAR	Tooltip: X3D version of "linear" in Web Audio API.
static final String	DISTANCEMODEL_LINEAR_ALIAS	SFString SFString enumeration value "LINEAR" has alias "linear"
static final boolean	DOPPLERENABLED_DEFAULT_VALUE	SFBool field named dopplerEnabled has default value false (Java syntax) or false (XML syntax).
static final boolean	ENABLED_DEFAULT_VALUE	SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
static final boolean	ENABLEHRTF_DEFAULT_VALUE	SFBool field named enableHRTF has default value false (Java syntax) or false (XML syntax).
static final String	fromField_CHILDREN	fromField ROUTE name for MFNode field named children.
static final String	fromField_CONEINNERANGLE	fromField ROUTE name for SFFloat field named coneInnerAngle.
static final String	fromField_CONEOUTERANGLE	fromField ROUTE name for SFFloat field named coneOuterAngle.
static final String	fromField_CONEOUTERGAIN	fromField ROUTE name for SFFloat field named coneOuterGain.
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_DISTANCEMODEL	fromField ROUTE name for SFString field named distanceModel.
static final String	fromField_DOPPLERENABLED	fromField ROUTE name for SFBool field named dopplerEnabled.
static final String	fromField_ENABLED	fromField ROUTE name for SFBool field named enabled.
static final String	fromField_ENABLEHRTF	fromField ROUTE name for SFBool field named enableHRTF.
static final String	fromField_GAIN	fromField ROUTE name for SFFloat field named gain.
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_MAXDISTANCE	fromField ROUTE name for SFFloat field named maxDistance.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_PRIORITY	fromField ROUTE name for SFFloat field named priority.
static final String	fromField_REFERENCEDISTANCE	fromField ROUTE name for SFFloat field named referenceDistance.
static final String	fromField_ROLLOFFFACTOR	fromField ROUTE name for SFFloat field named rolloffFactor.
static final float	GAIN_DEFAULT_VALUE	SFFloat field named gain has default value 1f (Java syntax) or 1 (XML syntax).
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: 2
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	MAXDISTANCE_DEFAULT_VALUE	SFFloat field named maxDistance has default value 10000f (Java syntax) or 10000 (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: SpatialSound.
static final float	PRIORITY_DEFAULT_VALUE	SFFloat field named priority has default value 0f (Java syntax) or 0 (XML syntax).
static final float	REFERENCEDISTANCE_DEFAULT_VALUE	SFFloat field named referenceDistance has default value 1f (Java syntax) or 1 (XML syntax).
static final float	ROLLOFFFACTOR_DEFAULT_VALUE	SFFloat field named rolloffFactor has default value 1f (Java syntax) or 1 (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_CHILDREN	toField ROUTE name for MFNode field named children.
static final String	toField_CONEINNERANGLE	toField ROUTE name for SFFloat field named coneInnerAngle.
static final String	toField_CONEOUTERANGLE	toField ROUTE name for SFFloat field named coneOuterAngle.
static final String	toField_CONEOUTERGAIN	toField ROUTE name for SFFloat field named coneOuterGain.
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_DISTANCEMODEL	toField ROUTE name for SFString field named distanceModel.
static final String	toField_DOPPLERENABLED	toField ROUTE name for SFBool field named dopplerEnabled.
static final String	toField_ENABLED	toField ROUTE name for SFBool field named enabled.
static final String	toField_ENABLEHRTF	toField ROUTE name for SFBool field named enableHRTF.
static final String	toField_GAIN	toField ROUTE name for SFFloat field named gain.
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_MAXDISTANCE	toField ROUTE name for SFFloat field named maxDistance.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_PRIORITY	toField ROUTE name for SFFloat field named priority.
static final String	toField_REFERENCEDISTANCE	toField ROUTE name for SFFloat field named referenceDistance.
static final String	toField_ROLLOFFFACTOR	toField ROUTE name for SFFloat field named rolloffFactor.

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

Method Summary

Modifier and Type	Method	Description
SpatialSound	addChild(X3DChildNode newValue)	Utility method to add single child element to contained list of existing children nodes (if any).
SpatialSound	addChildren(ProtoInstance newValue)	Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for children field.
void	addChildren(X3DNode newValue)	Add single node to existing array of children nodes (if any).
void	addChildren(X3DNode[] newValue)	Add array of children nodes to array of existing nodes (if any).
SpatialSound	addComments(String newComment)	Add comment as CommentsBlock to children field
SpatialSound	addComments(String[] newComments)	Add comments as String[] array to children field
SpatialSound	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to children field
SpatialSound	clearChildren()	Utility method to clear MFNode value of children field.
SpatialSound	clearIS()	Utility method to clear SFNode value of IS field.
SpatialSound	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.
X3DNode[]	getChildren()	Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper, from inputOutput MFNode field children.
ArrayList<X3DNode>	getChildrenList()	Utility method to get ArrayList value of MFNode children field, similar to getChildren().
final String	getComponent()	Defines X3D component for the SpatialSound element: Sound
final int	getComponentLevel()	Provides default X3D component level for this element: 2
float	getConeInnerAngle()	Provide float value unit axis, angle (in radians) within allowed range of [0,6.2832] from inputOutput SFFloat field named coneInnerAngle.
float	getConeOuterAngle()	Provide float value unit axis, angle (in radians) within allowed range of [0,6.2832] from inputOutput SFFloat field named coneOuterAngle.
float	getConeOuterGain()	Provide float value from inputOutput SFFloat field named coneOuterGain.
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.
String	getDistanceModel()	Provide String enumeration value (baseType SFString) ["LINEAR" | "INVERSE" | "EXPONENTIAL"] from inputOutput SFString field named distanceModel.
static String	getDistanceModelAlias(String distanceModelValue)	Get alias for this distanceModel
boolean	getDopplerEnabled()	Provide boolean value from inputOutput SFBool field named dopplerEnabled.
final String	getElementName()	Provides name of this element: SpatialSound
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
boolean	getEnableHRTF()	Provide boolean value from inputOutput SFBool field named enableHRTF.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
float	getGain()	Provide float value from inputOutput SFFloat field named gain.
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	getMaxDistance()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named maxDistance.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float	getPriority()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named priority.
float	getReferenceDistance()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named referenceDistance.
float	getRolloffFactor()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named rolloffFactor.
boolean	getSpatialize()	Provide boolean value from initializeOnly SFBool field named spatialize.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	hasChildren()	Indicate whether an object is available for inputOutput MFNode field children.
static boolean	hasDistanceModelAlias(String distanceModel)	Whether a alias exists for this distanceModel
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.
SpatialSound	setChildren(ArrayList<X3DNode> newValue)	Assign ArrayList value of MFNode children field, similar to setChildren(org.web3d.x3d.sai.Core.X3DNode[]).
void	setChildren(X3DNode newValue)	Set single children node, replacing prior array of existing nodes (if any).
SpatialSound	setChildren(X3DNode[] newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.
SpatialSound	setConeInnerAngle(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setConeInnerAngle(float).
SpatialSound	setConeInnerAngle(float newValue)	Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named coneInnerAngle.
SpatialSound	setConeInnerAngle(SFFloat newValue)	Assign typed object value to SFFloat coneInnerAngle field, similar to setConeInnerAngle(float).
SpatialSound	setConeOuterAngle(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setConeOuterAngle(float).
SpatialSound	setConeOuterAngle(float newValue)	Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named coneOuterAngle.
SpatialSound	setConeOuterAngle(SFFloat newValue)	Assign typed object value to SFFloat coneOuterAngle field, similar to setConeOuterAngle(float).
SpatialSound	setConeOuterGain(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setConeOuterGain(float).
SpatialSound	setConeOuterGain(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named coneOuterGain.
SpatialSound	setConeOuterGain(SFFloat newValue)	Assign typed object value to SFFloat coneOuterGain field, similar to setConeOuterGain(float).
final SpatialSound	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
SpatialSound	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final SpatialSound	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
SpatialSound	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final SpatialSound	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
SpatialSound	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
SpatialSound	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
SpatialSound	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
SpatialSound	setDirection(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setDirection(float[]).
SpatialSound	setDirection(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setDirection(float[]).
SpatialSound	setDirection(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.
SpatialSound	setDirection(float x, float y, float z)	Assign values to SFVec3f direction field, similar to setDirection(float[]).
SpatialSound	setDirection(SFVec3f newValue)	Assign typed object value to SFVec3f direction field, similar to setDirection(float[]).
SpatialSound	setDistanceModel(String newValue)	Accessor method to assign String enumeration value ("LINEAR" | "INVERSE" | "EXPONENTIAL") to inputOutput SFString field named distanceModel.
SpatialSound	setDistanceModel(SFString newValue)	Assign typed object value to SFString distanceModel field, similar to setDistanceModel(String).
SpatialSound	setDopplerEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named dopplerEnabled.
SpatialSound	setDopplerEnabled(SFBool newValue)	Assign typed object value to SFBool dopplerEnabled field, similar to setDopplerEnabled(boolean).
SpatialSound	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
SpatialSound	setEnabled(SFBool newValue)	Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
SpatialSound	setEnableHRTF(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enableHRTF.
SpatialSound	setEnableHRTF(SFBool newValue)	Assign typed object value to SFBool enableHRTF field, similar to setEnableHRTF(boolean).
SpatialSound	setGain(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setGain(float).
SpatialSound	setGain(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named gain.
SpatialSound	setGain(SFFloat newValue)	Assign typed object value to SFFloat gain field, similar to setGain(float).
final SpatialSound	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
SpatialSound	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
SpatialSound	setIntensity(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setIntensity(float).
SpatialSound	setIntensity(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named intensity.
SpatialSound	setIntensity(SFFloat newValue)	Assign typed object value to SFFloat intensity field, similar to setIntensity(float).
SpatialSound	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
SpatialSound	setLocation(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setLocation(float[]).
SpatialSound	setLocation(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setLocation(float[]).
SpatialSound	setLocation(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named location.
SpatialSound	setLocation(float x, float y, float z)	Assign values to SFVec3f location field, similar to setLocation(float[]).
SpatialSound	setLocation(SFVec3f newValue)	Assign typed object value to SFVec3f location field, similar to setLocation(float[]).
SpatialSound	setMaxDistance(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMaxDistance(float).
SpatialSound	setMaxDistance(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named maxDistance.
SpatialSound	setMaxDistance(SFFloat newValue)	Assign typed object value to SFFloat maxDistance field, similar to setMaxDistance(float).
SpatialSound	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
SpatialSound	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
SpatialSound	setPriority(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setPriority(float).
SpatialSound	setPriority(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named priority.
SpatialSound	setPriority(SFFloat newValue)	Assign typed object value to SFFloat priority field, similar to setPriority(float).
SpatialSound	setReferenceDistance(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setReferenceDistance(float).
SpatialSound	setReferenceDistance(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named referenceDistance.
SpatialSound	setReferenceDistance(SFFloat newValue)	Assign typed object value to SFFloat referenceDistance field, similar to setReferenceDistance(float).
SpatialSound	setRolloffFactor(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setRolloffFactor(float).
SpatialSound	setRolloffFactor(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named rolloffFactor.
SpatialSound	setRolloffFactor(SFFloat newValue)	Assign typed object value to SFFloat rolloffFactor field, similar to setRolloffFactor(float).
SpatialSound	setSpatialize(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named spatialize.
SpatialSound	setSpatialize(SFBool newValue)	Assign typed object value to SFBool spatialize field, similar to setSpatialize(boolean).
final SpatialSound	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
SpatialSound	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
SpatialSound	setUSE(SpatialSound 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

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

DISTANCEMODEL_LINEAR

public static final String DISTANCEMODEL_LINEAR

Tooltip: X3D version of "linear" in Web Audio API. SFString field named distanceModel with X3DUOM simpleType distanceModelChoices and with X3DUOM baseType SFString can equal this value "LINEAR" (Java syntax) or LINEAR (XML syntax).

See Also:

• DISTANCEMODEL_LINEAR_ALIAS
• XML Schema: distanceModelChoices
• https://www.w3.org/TR/webaudio/#enumdef-distancemodeltype
• Constant Field Values

DISTANCEMODEL_LINEAR_ALIAS

public static final String DISTANCEMODEL_LINEAR_ALIAS

SFString SFString enumeration value "LINEAR" has alias "linear"

See Also:

• DISTANCEMODEL_LINEAR
• Constant Field Values

DISTANCEMODEL_INVERSE

public static final String DISTANCEMODEL_INVERSE

Tooltip: X3D version of "inverse" in Web Audio API. SFString field named distanceModel with X3DUOM simpleType distanceModelChoices and with X3DUOM baseType SFString can equal this value "INVERSE" (Java syntax) or INVERSE (XML syntax).

See Also:

• DISTANCEMODEL_INVERSE_ALIAS
• XML Schema: distanceModelChoices
• https://www.w3.org/TR/webaudio/#enumdef-distancemodeltype
• Constant Field Values

DISTANCEMODEL_INVERSE_ALIAS

public static final String DISTANCEMODEL_INVERSE_ALIAS

SFString SFString enumeration value "INVERSE" has alias "inverse"

See Also:

• DISTANCEMODEL_INVERSE
• Constant Field Values

DISTANCEMODEL_EXPONENTIAL

public static final String DISTANCEMODEL_EXPONENTIAL

Tooltip: X3D version of "exponential" in Web Audio API. SFString field named distanceModel with X3DUOM simpleType distanceModelChoices and with X3DUOM baseType SFString can equal this value "EXPONENTIAL" (Java syntax) or EXPONENTIAL (XML syntax).

See Also:

• DISTANCEMODEL_EXPONENTIAL_ALIAS
• XML Schema: distanceModelChoices
• https://www.w3.org/TR/webaudio/#enumdef-distancemodeltype
• Constant Field Values

DISTANCEMODEL_EXPONENTIAL_ALIAS

public static final String DISTANCEMODEL_EXPONENTIAL_ALIAS

SFString SFString enumeration value "EXPONENTIAL" has alias "exponential"

See Also:

• DISTANCEMODEL_EXPONENTIAL
• Constant Field Values

NAME

public static final String NAME

String constant NAME provides name of this element: SpatialSound.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the SpatialSound 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: 2

See Also:

• Constant Field Values

CONEINNERANGLE_DEFAULT_VALUE

public static final float CONEINNERANGLE_DEFAULT_VALUE

SFFloat field named coneInnerAngle has default value 6.2832f (Java syntax) or 6.2832 (XML syntax).

See Also:

• Constant Field Values

CONEOUTERANGLE_DEFAULT_VALUE

public static final float CONEOUTERANGLE_DEFAULT_VALUE

SFFloat field named coneOuterAngle has default value 6.2832f (Java syntax) or 6.2832 (XML syntax).

See Also:

• Constant Field Values

CONEOUTERGAIN_DEFAULT_VALUE

public static final float CONEOUTERGAIN_DEFAULT_VALUE

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

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

DISTANCEMODEL_DEFAULT_VALUE

public static final String DISTANCEMODEL_DEFAULT_VALUE

SFString field named distanceModel has default value "INVERSE" (Java syntax) or INVERSE (XML syntax).

See Also:

• Constant Field Values

DOPPLERENABLED_DEFAULT_VALUE

public static final boolean DOPPLERENABLED_DEFAULT_VALUE

SFBool field named dopplerEnabled has default value false (Java syntax) or false (XML syntax).

See Also:

• Constant Field Values

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

ENABLEHRTF_DEFAULT_VALUE

public static final boolean ENABLEHRTF_DEFAULT_VALUE

SFBool field named enableHRTF has default value false (Java syntax) or false (XML syntax).

See Also:

• Constant Field Values

GAIN_DEFAULT_VALUE

public static final float GAIN_DEFAULT_VALUE

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

MAXDISTANCE_DEFAULT_VALUE

public static final float MAXDISTANCE_DEFAULT_VALUE

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

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

REFERENCEDISTANCE_DEFAULT_VALUE

public static final float REFERENCEDISTANCE_DEFAULT_VALUE

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

See Also:

• Constant Field Values

ROLLOFFFACTOR_DEFAULT_VALUE

public static final float ROLLOFFFACTOR_DEFAULT_VALUE

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

See Also:

• Constant Field Values

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, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "children";
containerField_ALLOWED_VALUES = {"children" }; 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_CHILDREN

public static final String fromField_CHILDREN

fromField ROUTE name for MFNode field named children.

See Also:

• Constant Field Values

toField_CHILDREN

public static final String toField_CHILDREN

toField ROUTE name for MFNode field named children.

See Also:

• Constant Field Values

fromField_CONEINNERANGLE

public static final String fromField_CONEINNERANGLE

fromField ROUTE name for SFFloat field named coneInnerAngle.

See Also:

• Constant Field Values

toField_CONEINNERANGLE

public static final String toField_CONEINNERANGLE

toField ROUTE name for SFFloat field named coneInnerAngle.

See Also:

• Constant Field Values

fromField_CONEOUTERANGLE

public static final String fromField_CONEOUTERANGLE

fromField ROUTE name for SFFloat field named coneOuterAngle.

See Also:

• Constant Field Values

toField_CONEOUTERANGLE

public static final String toField_CONEOUTERANGLE

toField ROUTE name for SFFloat field named coneOuterAngle.

See Also:

• Constant Field Values

fromField_CONEOUTERGAIN

public static final String fromField_CONEOUTERGAIN

fromField ROUTE name for SFFloat field named coneOuterGain.

See Also:

• Constant Field Values

toField_CONEOUTERGAIN

public static final String toField_CONEOUTERGAIN

toField ROUTE name for SFFloat field named coneOuterGain.

See Also:

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

public static final String fromField_DISTANCEMODEL

fromField ROUTE name for SFString field named distanceModel.

See Also:

• Constant Field Values

toField_DISTANCEMODEL

public static final String toField_DISTANCEMODEL

toField ROUTE name for SFString field named distanceModel.

See Also:

• Constant Field Values

fromField_DOPPLERENABLED

public static final String fromField_DOPPLERENABLED

fromField ROUTE name for SFBool field named dopplerEnabled.

See Also:

• Constant Field Values

toField_DOPPLERENABLED

public static final String toField_DOPPLERENABLED

toField ROUTE name for SFBool field named dopplerEnabled.

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_ENABLEHRTF

public static final String fromField_ENABLEHRTF

fromField ROUTE name for SFBool field named enableHRTF.

See Also:

• Constant Field Values

toField_ENABLEHRTF

public static final String toField_ENABLEHRTF

toField ROUTE name for SFBool field named enableHRTF.

See Also:

• Constant Field Values

fromField_GAIN

public static final String fromField_GAIN

fromField ROUTE name for SFFloat field named gain.

See Also:

• Constant Field Values

toField_GAIN

public static final String toField_GAIN

toField ROUTE name for SFFloat field named gain.

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_MAXDISTANCE

public static final String fromField_MAXDISTANCE

fromField ROUTE name for SFFloat field named maxDistance.

See Also:

• Constant Field Values

toField_MAXDISTANCE

public static final String toField_MAXDISTANCE

toField ROUTE name for SFFloat field named maxDistance.

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_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_REFERENCEDISTANCE

public static final String fromField_REFERENCEDISTANCE

fromField ROUTE name for SFFloat field named referenceDistance.

See Also:

• Constant Field Values

toField_REFERENCEDISTANCE

public static final String toField_REFERENCEDISTANCE

toField ROUTE name for SFFloat field named referenceDistance.

See Also:

• Constant Field Values

fromField_ROLLOFFFACTOR

public static final String fromField_ROLLOFFFACTOR

fromField ROUTE name for SFFloat field named rolloffFactor.

See Also:

• Constant Field Values

toField_ROLLOFFFACTOR

public static final String toField_ROLLOFFFACTOR

toField ROUTE name for SFFloat field named rolloffFactor.

See Also:

• Constant Field Values

Constructor Details

SpatialSound

public SpatialSound()

Constructor for SpatialSound to initialize member variables with default values.

SpatialSound

public SpatialSound(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

getDistanceModelAlias

public static String getDistanceModelAlias(String distanceModelValue)

Get alias for this distanceModel

Parameters:

distanceModelValue - of interest

Returns:

alias value, otherwise empty string if not found

hasDistanceModelAlias

public static boolean hasDistanceModelAlias(String distanceModel)

Whether a alias exists for this distanceModel

Parameters:

distanceModel - of interest

Returns:

true if found

getElementName

public final String getElementName()

Provides name of this element: SpatialSound

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the SpatialSound 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: 2

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

getChildren

public X3DNode[] getChildren()

Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper, from inputOutput MFNode field children.

Tooltip: [X3DSoundChannelNode|X3DSoundProcessingNode|X3DSoundSourceNode] The children field specifies audio-graph sound sources providing input signals for this node. If multiple input signals are provided by the inputs children field, all channels are mixed together and merged prior to presentation.

• Warning: contained AudioClip or MovieTexture nodes must have containerField='children' to override otherwise-incorrect defaults.
• Hint: can be original (DEF) or referenced (USE) nodes.

Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.

Specified by:

getChildren in interface SpatialSound

Returns:

value of children field

See Also:

• Analyser
• AudioClip
• AudioDestination
• BiquadFilter
• BufferAudioSource
• ChannelMerger
• ChannelSelector
• ChannelSplitter
• Convolver
• Delay
• DynamicsCompressor
• Gain
• ListenerPointSource
• MicrophoneSource
• MovieTexture
• OscillatorSource
• Sound
• SpatialSound
• StreamAudioDestination
• StreamAudioSource
• WaveShaper

getChildrenList

public ArrayList<X3DNode> getChildrenList()

Utility method to get ArrayList value of MFNode children field, similar to getChildren().

Returns:

value of children field

setChildren

public SpatialSound setChildren(X3DNode[] newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.

Tooltip: [X3DSoundChannelNode|X3DSoundProcessingNode|X3DSoundSourceNode] The children field specifies audio-graph sound sources providing input signals for this node. If multiple input signals are provided by the inputs children field, all channels are mixed together and merged prior to presentation.

• Warning: contained AudioClip or MovieTexture nodes must have containerField='children' to override otherwise-incorrect defaults.
• Hint: can be original (DEF) or referenced (USE) nodes.

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.

Specified by:

setChildren in interface SpatialSound

Parameters:

newValue - is new value for the children field.

Returns:

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

setChildren

public SpatialSound setChildren(ArrayList<X3DNode> newValue)

Assign ArrayList value of MFNode children field, similar to setChildren(org.web3d.x3d.sai.Core.X3DNode[]).

Parameters:

newValue - is new value for the children field.

Returns:

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

addChildren

public void addChildren(X3DNode newValue)

Add single node to existing array of children nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper and ProtoInstance.

Parameters:

newValue - is new value to be appended the children field.

addChildren

public SpatialSound addChildren(ProtoInstance newValue)

Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for children field.

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.

Parameters:

newValue - is new value to be appended the parts field.

Returns:

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

addChild

public SpatialSound addChild(X3DChildNode newValue)

Utility method to add single child element to contained list of existing children nodes (if any).

Parameters:

newValue - is new node value to be appended the children field.

Returns:

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

addChildren

public void addChildren(X3DNode[] newValue)

Add array of children nodes to array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.

Specified by:

addChildren in interface SpatialSound

Parameters:

newValue - is new value array to be appended the children field.

setChildren

public void setChildren(X3DNode newValue)

Set single children node, replacing prior array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.

Specified by:

setChildren in interface SpatialSound

Parameters:

newValue - is new node for the children field (restricted to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper)

clearChildren

public SpatialSound clearChildren()

Utility method to clear MFNode value of children field. This method does not initialize withCHILDREN_DEFAULT_VALUE.

Returns:

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

hasChildren

public boolean hasChildren()

Indicate whether an object is available for inputOutput MFNode field children.

Returns:

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

See Also:

• getChildren()

addComments

public SpatialSound addComments(String newComment)

Add comment as CommentsBlock to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

addComments

public SpatialSound addComments(String[] newComments)

Add comments as String[] array to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public SpatialSound addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

getConeInnerAngle

public float getConeInnerAngle()

Provide float value unit axis, angle (in radians) within allowed range of [0,6.2832] from inputOutput SFFloat field named coneInnerAngle.

Tooltip: [0,2pi] coneInnerAngle is centered along direction and defines the inner conical volume, inside of which no source gain reduction occurs.

• Hint: coneOuterAngle value is greater than or equal to coneInnerAngle.
• Hint: X3D4 Architecture Figure 16.3, SpatialSound Panning Gain Relationships https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/sound.html#f-AudioPannerListenerRelationships

Specified by:

getConeInnerAngle in interface SpatialSound

Returns:

value of coneInnerAngle field

setConeInnerAngle

public SpatialSound setConeInnerAngle(float newValue)

Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named coneInnerAngle.

Tooltip: [0,2pi] coneInnerAngle is centered along direction and defines the inner conical volume, inside of which no source gain reduction occurs.

• Hint: coneOuterAngle value is greater than or equal to coneInnerAngle.
• Hint: X3D4 Architecture Figure 16.3, SpatialSound Panning Gain Relationships https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/sound.html#f-AudioPannerListenerRelationships

Specified by:

setConeInnerAngle in interface SpatialSound

Parameters:

newValue - is new value for the coneInnerAngle field.

Returns:

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

setConeInnerAngle

public SpatialSound setConeInnerAngle(SFFloat newValue)

Assign typed object value to SFFloat coneInnerAngle field, similar to setConeInnerAngle(float).

Parameters:

newValue - is new value for the coneInnerAngle field.

Returns:

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

setConeInnerAngle

public SpatialSound setConeInnerAngle(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

getConeOuterAngle

public float getConeOuterAngle()

Provide float value unit axis, angle (in radians) within allowed range of [0,6.2832] from inputOutput SFFloat field named coneOuterAngle.

Tooltip: [0,2pi] coneOuterAngle is centered along direction and defines an outer conical volume, within which the sound gain decreases linearly from full gain to coneOuterGain. Outside of coneOuterAngle, gain equals coneOuterGain.

• Hint: coneOuterAngle value is greater than or equal to coneInnerAngle.
• Hint: X3D4 Architecture Figure 16.3, SpatialSound Panning Gain Relationships https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/sound.html#f-AudioPannerListenerRelationships

Specified by:

getConeOuterAngle in interface SpatialSound

Returns:

value of coneOuterAngle field

setConeOuterAngle

public SpatialSound setConeOuterAngle(float newValue)

Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named coneOuterAngle.

Tooltip: [0,2pi] coneOuterAngle is centered along direction and defines an outer conical volume, within which the sound gain decreases linearly from full gain to coneOuterGain. Outside of coneOuterAngle, gain equals coneOuterGain.

• Hint: coneOuterAngle value is greater than or equal to coneInnerAngle.
• Hint: X3D4 Architecture Figure 16.3, SpatialSound Panning Gain Relationships https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/sound.html#f-AudioPannerListenerRelationships

Specified by:

setConeOuterAngle in interface SpatialSound

Parameters:

newValue - is new value for the coneOuterAngle field.

Returns:

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

setConeOuterAngle

public SpatialSound setConeOuterAngle(SFFloat newValue)

Assign typed object value to SFFloat coneOuterAngle field, similar to setConeOuterAngle(float).

Parameters:

newValue - is new value for the coneOuterAngle field.

Returns:

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

setConeOuterAngle

public SpatialSound setConeOuterAngle(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

getConeOuterGain

public float getConeOuterGain()

Provide float value from inputOutput SFFloat field named coneOuterGain.

Tooltip: (-infinity,+infinity) coneOuterGain is minimum gain value found outside coneOuterAngle. *

Specified by:

getConeOuterGain in interface SpatialSound

Returns:

value of coneOuterGain field

setConeOuterGain

public SpatialSound setConeOuterGain(float newValue)

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

Tooltip: (-infinity,+infinity) coneOuterGain is minimum gain value found outside coneOuterAngle. *

Specified by:

setConeOuterGain in interface SpatialSound

Parameters:

newValue - is new value for the coneOuterGain field.

Returns:

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

setConeOuterGain

public SpatialSound setConeOuterGain(SFFloat newValue)

Assign typed object value to SFFloat coneOuterGain field, similar to setConeOuterGain(float).

Parameters:

newValue - is new value for the coneOuterGain field.

Returns:

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

setConeOuterGain

public SpatialSound setConeOuterGain(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

getDescription

public String getDescription()

Provide String value from inputOutput SFString field named description.

Tooltip: Author-provided prose that describes intended purpose of the url asset.

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

Specified by:

getDescription in interface X3DSoundNode

Returns:

value of description field

setDescription

public SpatialSound setDescription(String newValue)

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

Tooltip: Author-provided prose that describes intended purpose of the url asset.

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

Specified by:

setDescription in interface X3DSoundNode

Parameters:

newValue - is new value for the description field.

Returns:

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

setDescription

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

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

Returns:

value of direction field

setDirection

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

Parameters:

newValue - is new value for the direction field.

Returns:

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

setDirection

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

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

setDirection

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

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

setDirection

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

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

setDirection

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

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

getDistanceModel

public String getDistanceModel()

Provide String enumeration value (baseType SFString) ["LINEAR" | "INVERSE" | "EXPONENTIAL"] from inputOutput SFString field named distanceModel.

Tooltip: distanceModel determines how field specifies which algorithm to use for sound attenuation, corresponding to distance between an audio source and a listener, as it moves away from the listener.

• Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#enumdef-distancemodeltype

Available enumeration values for string comparison: LINEAR, INVERSE, EXPONENTIAL.

Specified by:

getDistanceModel in interface SpatialSound

Returns:

value of distanceModel field

setDistanceModel

public SpatialSound setDistanceModel(String newValue)

Accessor method to assign String enumeration value ("LINEAR" | "INVERSE" | "EXPONENTIAL") to inputOutput SFString field named distanceModel.

Warning: authors can only choose from a strict list of enumeration values (LINEAR, INVERSE, EXPONENTIAL).

Tooltip: distanceModel determines how field specifies which algorithm to use for sound attenuation, corresponding to distance between an audio source and a listener, as it moves away from the listener.

• Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#enumdef-distancemodeltype

Specified by:

setDistanceModel in interface SpatialSound

Parameters:

newValue - is new value for the distanceModel field.

Returns:

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

setDistanceModel

public SpatialSound setDistanceModel(SFString newValue)

Assign typed object value to SFString distanceModel field, similar to setDistanceModel(String).

Parameters:

newValue - is new value for the distanceModel field.

Returns:

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

getDopplerEnabled

public boolean getDopplerEnabled()

Provide boolean value from inputOutput SFBool field named dopplerEnabled.

Tooltip: dopplerEnabled enables/disables whether real-time Doppler effects (due to relation motion between sources and listeners) are computed by browser between virtual sound sources and active listening locations, then applied to received frequency at active listening locations.

• Hint: functional support requires player support for Sound component level 3.
• Hint: Wikipedia Doppler effect https://en.wikipedia.org/wiki/Doppler_effect

Specified by:

getDopplerEnabled in interface SpatialSound

Returns:

value of dopplerEnabled field

setDopplerEnabled

public SpatialSound setDopplerEnabled(boolean newValue)

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

Tooltip: dopplerEnabled enables/disables whether real-time Doppler effects (due to relation motion between sources and listeners) are computed by browser between virtual sound sources and active listening locations, then applied to received frequency at active listening locations.

• Hint: functional support requires player support for Sound component level 3.
• Hint: Wikipedia Doppler effect https://en.wikipedia.org/wiki/Doppler_effect

Specified by:

setDopplerEnabled in interface SpatialSound

Parameters:

newValue - is new value for the dopplerEnabled field.

Returns:

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

setDopplerEnabled

public SpatialSound setDopplerEnabled(SFBool newValue)

Assign typed object value to SFBool dopplerEnabled field, similar to setDopplerEnabled(boolean).

Parameters:

newValue - is new value for the dopplerEnabled field.

Returns:

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

Specified by:

getEnabled in interface X3DSoundNode

Returns:

value of enabled field

setEnabled

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

Specified by:

setEnabled in interface X3DSoundNode

Parameters:

newValue - is new value for the enabled field.

Returns:

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

setEnabled

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

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

getEnableHRTF

public boolean getEnableHRTF()

Provide boolean value from inputOutput SFBool field named enableHRTF.

Tooltip: enableHRTF enables/disables Head Related Transfer Function (HRTF) auralization, if available. SpatialSound enabledHRTF=true corresponds to panningModelType HRTF, enabledHRTF=false corresponds to panningModelType equalpower.

• Hint: W3C Audio API https://www.w3.org/TR/webaudio/#enumdef-panningmodeltype
• Hint: Wikipedia HRTF https://en.wikipedia.org/wiki/3D_sound_localization#Head-related_Transfer_Function_(HRTF)

Specified by:

getEnableHRTF in interface SpatialSound

Returns:

value of enableHRTF field

setEnableHRTF

public SpatialSound setEnableHRTF(boolean newValue)

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

Tooltip: enableHRTF enables/disables Head Related Transfer Function (HRTF) auralization, if available. SpatialSound enabledHRTF=true corresponds to panningModelType HRTF, enabledHRTF=false corresponds to panningModelType equalpower.

• Hint: W3C Audio API https://www.w3.org/TR/webaudio/#enumdef-panningmodeltype
• Hint: Wikipedia HRTF https://en.wikipedia.org/wiki/3D_sound_localization#Head-related_Transfer_Function_(HRTF)

Specified by:

setEnableHRTF in interface SpatialSound

Parameters:

newValue - is new value for the enableHRTF field.

Returns:

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

setEnableHRTF

public SpatialSound setEnableHRTF(SFBool newValue)

Assign typed object value to SFBool enableHRTF field, similar to setEnableHRTF(boolean).

Parameters:

newValue - is new value for the enableHRTF field.

Returns:

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

getGain

public float getGain()

Provide float value from inputOutput SFFloat field named gain.

Tooltip: (-infinity,+infinity) The gain field is a factor that represents the amount of linear amplification to apply to the output of the node.

• Warning: Decibel values shall not be used.
• Hint: Negative gain factors negate the input signal.

Specified by:

getGain in interface SpatialSound

Returns:

value of gain field

setGain

public SpatialSound setGain(float newValue)

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

Tooltip: (-infinity,+infinity) The gain field is a factor that represents the amount of linear amplification to apply to the output of the node.

• Warning: Decibel values shall not be used.
• Hint: Negative gain factors negate the input signal.

Specified by:

setGain in interface SpatialSound

Parameters:

newValue - is new value for the gain field.

Returns:

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

setGain

public SpatialSound setGain(SFFloat newValue)

Assign typed object value to SFFloat gain field, similar to setGain(float).

Parameters:

newValue - is new value for the gain field.

Returns:

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

setGain

public SpatialSound setGain(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

Returns:

value of intensity field

setIntensity

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

Parameters:

newValue - is new value for the intensity field.

Returns:

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

setIntensity

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

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

setIntensity

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

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

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

Utility method to clear SFNode value of IS field.

Returns:

SpatialSound - 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: [0,+infinity) 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 SpatialSound

Returns:

value of location field

setLocation

public SpatialSound setLocation(float[] newValue)

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

Tooltip: [0,+infinity) 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 SpatialSound

Parameters:

newValue - is new value for the location field.

Returns:

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

setLocation

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

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

setLocation

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

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

setLocation

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

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

setLocation

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

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

getMaxDistance

public float getMaxDistance()

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

Tooltip: [0,+infinity) maxDistance is the maximum distance where sound is renderable between source and listener, after which no reduction in sound volume occurs. *

Specified by:

getMaxDistance in interface SpatialSound

Returns:

value of maxDistance field

setMaxDistance

public SpatialSound setMaxDistance(float newValue)

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

Tooltip: [0,+infinity) maxDistance is the maximum distance where sound is renderable between source and listener, after which no reduction in sound volume occurs. *

Specified by:

setMaxDistance in interface SpatialSound

Parameters:

newValue - is new value for the maxDistance field.

Returns:

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

setMaxDistance

public SpatialSound setMaxDistance(SFFloat newValue)

Assign typed object value to SFFloat maxDistance field, similar to setMaxDistance(float).

Parameters:

newValue - is new value for the maxDistance field.

Returns:

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

setMaxDistance

public SpatialSound setMaxDistance(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

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

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:

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

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

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 SpatialSound

Returns:

value of priority field

setPriority

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

Parameters:

newValue - is new value for the priority field.

Returns:

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

setPriority

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

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

setPriority

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

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

getReferenceDistance

public float getReferenceDistance()

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

Tooltip: [0,+infinity) referenceDistance for reducing volume as source moves further from the listener. For distances less than this value, volume is not reduced.

• Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-pannernode-refdistance

Specified by:

getReferenceDistance in interface SpatialSound

Returns:

value of referenceDistance field

setReferenceDistance

public SpatialSound setReferenceDistance(float newValue)

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

Tooltip: [0,+infinity) referenceDistance for reducing volume as source moves further from the listener. For distances less than this value, volume is not reduced.

• Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-pannernode-refdistance

Specified by:

setReferenceDistance in interface SpatialSound

Parameters:

newValue - is new value for the referenceDistance field.

Returns:

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

setReferenceDistance

public SpatialSound setReferenceDistance(SFFloat newValue)

Assign typed object value to SFFloat referenceDistance field, similar to setReferenceDistance(float).

Parameters:

newValue - is new value for the referenceDistance field.

Returns:

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

setReferenceDistance

public SpatialSound setReferenceDistance(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

getRolloffFactor

public float getRolloffFactor()

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

Tooltip: [0,+infinity) rolloffFactor indicates how quickly volume is reduced as source moves further from listener.

• Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-pannernode-rollofffactor

Specified by:

getRolloffFactor in interface SpatialSound

Returns:

value of rolloffFactor field

setRolloffFactor

public SpatialSound setRolloffFactor(float newValue)

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

Tooltip: [0,+infinity) rolloffFactor indicates how quickly volume is reduced as source moves further from listener.

• Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-pannernode-rollofffactor

Specified by:

setRolloffFactor in interface SpatialSound

Parameters:

newValue - is new value for the rolloffFactor field.

Returns:

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

setRolloffFactor

public SpatialSound setRolloffFactor(SFFloat newValue)

Assign typed object value to SFFloat rolloffFactor field, similar to setRolloffFactor(float).

Parameters:

newValue - is new value for the rolloffFactor field.

Returns:

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

setRolloffFactor

public SpatialSound setRolloffFactor(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

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 SpatialSound

Returns:

value of spatialize field

setSpatialize

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

Parameters:

newValue - is new value for the spatialize field.

Returns:

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

setSpatialize

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

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

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

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)