org.web3d.x3d.jsail.Sound.ListenerPointSource

All Implemented Interfaces:: X3DChildNode, X3DNode, ListenerPointSource, X3DSoundNode, X3DSoundSourceNode, X3DTimeDependentNode

public class ListenerPointSource extends X3DConcreteNode implements ListenerPointSource

ListenerPointSource node represents position and orientation of a person listening to virtual sound in the audio scene, and provides single or multiple sound channels as output.

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. X3D node tooltip: (X3D version 4.0 draft) [X3DSoundSourceNode] ListenerPointSource node represents position and orientation of a person listening to virtual sound in the audio scene, and provides single or multiple sound channels as output. Multiple ListenerPointSource nodes can be active for sound processing. Hint: W3C Web Audio API <a href="https://www.w3.org/TR/webaudio/#audiolistener" target="_blank">https://www.w3.org/TR/webaudio/#audiolistener</a> *

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:

Field Summary

Fields

Modifier and Type

Field

Description

static final String

COMPONENT

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

static final String

containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent.

static final String

DESCRIPTION_DEFAULT_VALUE

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

static final 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 String

fromField_DESCRIPTION

fromField ROUTE name for SFString field named description.

static final String

fromField_DOPPLERENABLED

fromField ROUTE name for SFBool field named dopplerEnabled.

static final String

fromField_ELAPSEDTIME

fromField ROUTE name for SFTime field named elapsedTime.

static final String

fromField_ENABLED

fromField ROUTE name for SFBool field named enabled.

static final String

fromField_GAIN

fromField ROUTE name for SFFloat field named gain.

static final String

fromField_INTERAURALDISTANCE

fromField ROUTE name for SFFloat field named interauralDistance.

static final String

fromField_IS

fromField ROUTE name for SFNode field named IS.

static final String

fromField_ISACTIVE

fromField ROUTE name for SFBool field named isActive.

static final String

fromField_ISPAUSED

fromField ROUTE name for SFBool field named isPaused.

static final String

fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

static final String

fromField_ORIENTATION

fromField ROUTE name for SFRotation field named orientation.

static final String

fromField_PAUSETIME

fromField ROUTE name for SFTime field named pauseTime.

static final String

fromField_POSITION

fromField ROUTE name for SFVec3f field named position.

static final String

fromField_RESUMETIME

fromField ROUTE name for SFTime field named resumeTime.

static final String

fromField_STARTTIME

fromField ROUTE name for SFTime field named startTime.

static final String

fromField_STOPTIME

fromField ROUTE name for SFTime field named stopTime.

static final String

fromField_TRACKCURRENTVIEW

fromField ROUTE name for SFBool field named trackCurrentView.

static final float

GAIN_DEFAULT_VALUE

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

static final float

INTERAURALDISTANCE_DEFAULT_VALUE

SFFloat field named interauralDistance has default value 0f (Java syntax) or 0 (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 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: ListenerPointSource.

static final float[]

ORIENTATION_DEFAULT_VALUE

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

static final double

PAUSETIME_DEFAULT_VALUE

SFTime field named pauseTime has default value 0 (Java syntax) or 0 (XML syntax).

static final float[]

POSITION_DEFAULT_VALUE

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

static final double

RESUMETIME_DEFAULT_VALUE

SFTime field named resumeTime has default value 0 (Java syntax) or 0 (XML syntax).

static final double

STARTTIME_DEFAULT_VALUE

SFTime field named startTime has default value 0 (Java syntax) or 0 (XML syntax).

static final double

STOPTIME_DEFAULT_VALUE

SFTime field named stopTime has default value 0 (Java syntax) or 0 (XML syntax).

static final String

toField_DESCRIPTION

toField ROUTE name for SFString field named description.

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_GAIN

toField ROUTE name for SFFloat field named gain.

static final String

toField_INTERAURALDISTANCE

toField ROUTE name for SFFloat field named interauralDistance.

static final String

toField_METADATA

toField ROUTE name for SFNode field named metadata.

static final String

toField_ORIENTATION

toField ROUTE name for SFRotation field named orientation.

static final String

toField_PAUSETIME

toField ROUTE name for SFTime field named pauseTime.

static final String

toField_POSITION

toField ROUTE name for SFVec3f field named position.

static final String

toField_RESUMETIME

toField ROUTE name for SFTime field named resumeTime.

static final String

toField_STARTTIME

toField ROUTE name for SFTime field named startTime.

static final String

toField_STOPTIME

toField ROUTE name for SFTime field named stopTime.

static final String

toField_TRACKCURRENTVIEW

toField ROUTE name for SFBool field named trackCurrentView.

static final boolean

TRACKCURRENTVIEW_DEFAULT_VALUE

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

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult
Constructor Summary

Constructors

Constructor

Description

ListenerPointSource()

Constructor for ListenerPointSource to initialize member variables with default values.

ListenerPointSource(String DEFlabel)

Utility constructor that assigns DEF label after initializing member variables with default values.
Method Summary

Modifier and Type

Method

Description

ListenerPointSource

addComments(String newComment)

Add comment as String to contained commentsList.

ListenerPointSource

addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

ListenerPointSource

addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

ListenerPointSource

clearIS()

Utility method to clear SFNode value of IS field.

ListenerPointSource

clearMetadata()

Utility method to clear SFNode value of metadata field.

X3DConcreteElement

findElementByNameValue(String nameValue)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.

X3DConcreteElement

findElementByNameValue(String nameValue, String elementName)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.

X3DConcreteNode

findNodeByDEF(String DEFvalue)

Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

String

getAccessType(String fieldName)

Indicate accessType corresponding to given fieldName.

final String

getComponent()

Defines X3D component for the ListenerPointSource element: Sound

final int

getComponentLevel()

Provides default X3D component level for this element: 2

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.

boolean

getDopplerEnabled()

Provide boolean value from inputOutput SFBool field named dopplerEnabled.

double

getElapsedTime()

Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.

final String

getElementName()

Provides name of this element: ListenerPointSource

boolean

getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

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

getInterauralDistance()

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

IS

getIS()

Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.

boolean

getIsActive()

Provide boolean value from outputOnly SFBool field named isActive.

boolean

getIsPaused()

Provide boolean value from outputOnly SFBool field named isPaused.

X3DMetadataObject

getMetadata()

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

float[]

getOrientation()

Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.

double

getPauseTime()

Provide double value in seconds from inputOutput SFTime field named pauseTime.

float[]

getPosition()

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

double

getResumeTime()

Provide double value in seconds from inputOutput SFTime field named resumeTime.

double

getStartTime()

Provide double value in seconds from inputOutput SFTime field named startTime.

double

getStopTime()

Provide double value in seconds from inputOutput SFTime field named stopTime.

boolean

getTrackCurrentView()

Provide boolean value from inputOutput SFBool field named trackCurrentView.

String

getUSE()

Provide String value from inputOutput SFString field named USE.

boolean

hasElementByNameValue(String nameValue, String elementName)

Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.

boolean

hasIS()

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

boolean

hasMetadata()

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

boolean

hasNodeByDEF(String DEFvalue)

Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.

final void

initialize()

Initialize all member variables to default values.

final ListenerPointSource

setCssClass(String newValue)

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

ListenerPointSource

setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String). // #0.e

final ListenerPointSource

setCssStyle(String newValue)

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

ListenerPointSource

setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String). // #0.e

final ListenerPointSource

setDEF(String newValue)

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

ListenerPointSource

setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String). // #0.e

ListenerPointSource

setDescription(String newValue)

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

ListenerPointSource

setDescription(SFString newValue)

Assign typed object value to SFString description field, similar to setDescription(String). // #0.e

ListenerPointSource

setDopplerEnabled(boolean newValue)

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

ListenerPointSource

setDopplerEnabled(SFBool newValue)

Assign typed object value to SFBool dopplerEnabled field, similar to setDopplerEnabled(boolean). // #0.e

ListenerPointSource

setEnabled(boolean newValue)

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

ListenerPointSource

setEnabled(SFBool newValue)

Assign typed object value to SFBool enabled field, similar to setEnabled(boolean). // #0.e

ListenerPointSource

setGain(double newValue)

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

ListenerPointSource

setGain(float newValue)

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

ListenerPointSource

setGain(SFFloat newValue)

Assign typed object value to SFFloat gain field, similar to setGain(float). // #0.e

final ListenerPointSource

setHtmlID(String newValue)

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

ListenerPointSource

setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String). // #0.e

ListenerPointSource

setInterauralDistance(double newValue)

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

ListenerPointSource

setInterauralDistance(float newValue)

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

ListenerPointSource

setInterauralDistance(SFFloat newValue)

Assign typed object value to SFFloat interauralDistance field, similar to setInterauralDistance(float). // #0.e

ListenerPointSource

setIS(IS newValue)

Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.

ListenerPointSource

setMetadata(ProtoInstance newValue)

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

ListenerPointSource

setMetadata(X3DMetadataObject newValue)

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

ListenerPointSource

setOrientation(double[] newArray)

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

ListenerPointSource

setOrientation(double x, double y, double z, double angleRadians)

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

ListenerPointSource

setOrientation(float[] newValue)

Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.

ListenerPointSource

setOrientation(float x, float y, float z, float angleRadians)

Assign values to SFRotation orientation field, similar to setOrientation(float[]).

ListenerPointSource

setOrientation(SFRotation newValue)

Assign typed object value to SFRotation orientation field, similar to setOrientation(float[]). // #0.e

ListenerPointSource

setPauseTime(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.

ListenerPointSource

setPauseTime(SFTime newValue)

Assign typed object value to SFTime pauseTime field, similar to setPauseTime(double). // #0.e

ListenerPointSource

setPosition(double[] newArray)

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

ListenerPointSource

setPosition(double x, double y, double z)

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

ListenerPointSource

setPosition(float[] newValue)

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

ListenerPointSource

setPosition(float x, float y, float z)

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

ListenerPointSource

setPosition(SFVec3f newValue)

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

ListenerPointSource

setResumeTime(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.

ListenerPointSource

setResumeTime(SFTime newValue)

Assign typed object value to SFTime resumeTime field, similar to setResumeTime(double). // #0.e

ListenerPointSource

setStartTime(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.

ListenerPointSource

setStartTime(SFTime newValue)

Assign typed object value to SFTime startTime field, similar to setStartTime(double). // #0.e

ListenerPointSource

setStopTime(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.

ListenerPointSource

setStopTime(SFTime newValue)

Assign typed object value to SFTime stopTime field, similar to setStopTime(double). // #0.e

ListenerPointSource

setTrackCurrentView(boolean newValue)

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

ListenerPointSource

setTrackCurrentView(SFBool newValue)

Assign typed object value to SFBool trackCurrentView field, similar to setTrackCurrentView(boolean). // #0.e

final ListenerPointSource

setUSE(String newValue)

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

ListenerPointSource

setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String). // #0.e

ListenerPointSource

setUSE(ListenerPointSource DEFnode)

Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

String

toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

String

toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

String

toStringX3D(int indentLevel)

Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.

String

validate()

Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- NAME
  public static final String NAME
  
  String constant NAME provides name of this element: ListenerPointSource.
  
  See Also:
  
  Constant Field Values
- COMPONENT
  public static final String COMPONENT
  
  String constant COMPONENT defines X3D component for the ListenerPointSource 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
- 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
- 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
- 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
- INTERAURALDISTANCE_DEFAULT_VALUE
  public static final float INTERAURALDISTANCE_DEFAULT_VALUE
  
  SFFloat field named interauralDistance has default value 0f (Java syntax) or 0 (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).
- METADATA_DEFAULT_VALUE
  
  public static final X3DMetadataObject METADATA_DEFAULT_VALUE
  
  SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
- ORIENTATION_DEFAULT_VALUE
  
  public static final float[] ORIENTATION_DEFAULT_VALUE
  
  SFRotation field named orientation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax).
- PAUSETIME_DEFAULT_VALUE
  public static final double PAUSETIME_DEFAULT_VALUE
  
  SFTime field named pauseTime has default value 0 (Java syntax) or 0 (XML syntax).
  
  See Also:
  
  Constant Field Values
- POSITION_DEFAULT_VALUE
  
  public static final float[] POSITION_DEFAULT_VALUE
  
  SFVec3f field named position has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
- RESUMETIME_DEFAULT_VALUE
  public static final double RESUMETIME_DEFAULT_VALUE
  
  SFTime field named resumeTime has default value 0 (Java syntax) or 0 (XML syntax).
  
  See Also:
  
  Constant Field Values
- STARTTIME_DEFAULT_VALUE
  public static final double STARTTIME_DEFAULT_VALUE
  
  SFTime field named startTime has default value 0 (Java syntax) or 0 (XML syntax).
  
  See Also:
  
  Constant Field Values
- STOPTIME_DEFAULT_VALUE
  public static final double STOPTIME_DEFAULT_VALUE
  
  SFTime field named stopTime has default value 0 (Java syntax) or 0 (XML syntax).
  
  See Also:
  
  Constant Field Values
- TRACKCURRENTVIEW_DEFAULT_VALUE
  public static final boolean TRACKCURRENTVIEW_DEFAULT_VALUE
  
  SFBool field named trackCurrentView has default value false (Java syntax) or false (XML syntax).
  
  See Also:
  
  Constant Field Values
- containerField_DEFAULT_VALUE
  public static final String containerField_DEFAULT_VALUE
  
  containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
  
  See Also:
  
  X3D Scene Authoring Hints: containerField
  
  X3D Unified Object Model (X3DUOM)
  
  Constant Field Values
- fromField_DESCRIPTION
  public static final String fromField_DESCRIPTION
  
  fromField ROUTE name for SFString field named description.
  
  See Also:
  
  Constant Field Values
- toField_DESCRIPTION
  public static final String toField_DESCRIPTION
  
  toField ROUTE name for SFString field named description.
  
  See Also:
  
  Constant Field Values
- fromField_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_ELAPSEDTIME
  public static final String fromField_ELAPSEDTIME
  
  fromField ROUTE name for SFTime field named elapsedTime.
  
  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_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_INTERAURALDISTANCE
  public static final String fromField_INTERAURALDISTANCE
  
  fromField ROUTE name for SFFloat field named interauralDistance.
  
  See Also:
  
  Constant Field Values
- toField_INTERAURALDISTANCE
  public static final String toField_INTERAURALDISTANCE
  
  toField ROUTE name for SFFloat field named interauralDistance.
  
  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_ISACTIVE
  public static final String fromField_ISACTIVE
  
  fromField ROUTE name for SFBool field named isActive.
  
  See Also:
  
  Constant Field Values
- fromField_ISPAUSED
  public static final String fromField_ISPAUSED
  
  fromField ROUTE name for SFBool field named isPaused.
  
  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_ORIENTATION
  public static final String fromField_ORIENTATION
  
  fromField ROUTE name for SFRotation field named orientation.
  
  See Also:
  
  Constant Field Values
- toField_ORIENTATION
  public static final String toField_ORIENTATION
  
  toField ROUTE name for SFRotation field named orientation.
  
  See Also:
  
  Constant Field Values
- fromField_PAUSETIME
  public static final String fromField_PAUSETIME
  
  fromField ROUTE name for SFTime field named pauseTime.
  
  See Also:
  
  Constant Field Values
- toField_PAUSETIME
  public static final String toField_PAUSETIME
  
  toField ROUTE name for SFTime field named pauseTime.
  
  See Also:
  
  Constant Field Values
- fromField_POSITION
  public static final String fromField_POSITION
  
  fromField ROUTE name for SFVec3f field named position.
  
  See Also:
  
  Constant Field Values
- toField_POSITION
  public static final String toField_POSITION
  
  toField ROUTE name for SFVec3f field named position.
  
  See Also:
  
  Constant Field Values
- fromField_RESUMETIME
  public static final String fromField_RESUMETIME
  
  fromField ROUTE name for SFTime field named resumeTime.
  
  See Also:
  
  Constant Field Values
- toField_RESUMETIME
  public static final String toField_RESUMETIME
  
  toField ROUTE name for SFTime field named resumeTime.
  
  See Also:
  
  Constant Field Values
- fromField_STARTTIME
  public static final String fromField_STARTTIME
  
  fromField ROUTE name for SFTime field named startTime.
  
  See Also:
  
  Constant Field Values
- toField_STARTTIME
  public static final String toField_STARTTIME
  
  toField ROUTE name for SFTime field named startTime.
  
  See Also:
  
  Constant Field Values
- fromField_STOPTIME
  public static final String fromField_STOPTIME
  
  fromField ROUTE name for SFTime field named stopTime.
  
  See Also:
  
  Constant Field Values
- toField_STOPTIME
  public static final String toField_STOPTIME
  
  toField ROUTE name for SFTime field named stopTime.
  
  See Also:
  
  Constant Field Values
- fromField_TRACKCURRENTVIEW
  public static final String fromField_TRACKCURRENTVIEW
  
  fromField ROUTE name for SFBool field named trackCurrentView.
  
  See Also:
  
  Constant Field Values
- toField_TRACKCURRENTVIEW
  public static final String toField_TRACKCURRENTVIEW
  
  toField ROUTE name for SFBool field named trackCurrentView.
  
  See Also:
  
  Constant Field Values
Constructor Details
- ListenerPointSource
  
  public ListenerPointSource()
  
  Constructor for ListenerPointSource to initialize member variables with default values.
- ListenerPointSource
  
  public ListenerPointSource(String DEFlabel)
  
  Utility constructor that assigns DEF label after initializing member variables with default values.
  
  Parameters:
  
  DEFlabel - unique DEF name for this X3D node
Method Details
- getElementName
  
  public final String getElementName()
  
  Provides name of this element: ListenerPointSource
  
  Specified by:
  
  getElementName in class X3DConcreteElement
  
  Returns:
  
  name of this element
- getComponent
  
  public final String getComponent()
  
  Defines X3D component for the ListenerPointSource 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. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
  
  Specified by:
  
  getContainerFieldDefault in class X3DConcreteNode
  
  Returns:
  
  default containerField value
  
  See Also:
  
  X3D Scene Authoring Hints: containerField
  
  X3D Unified Object Model (X3DUOM)
- initialize
  
  public final void initialize()
  
  Initialize all member variables to default values.
  
  Overrides:
  
  initialize in class X3DConcreteNode
- getDescription
  
  public String getDescription()
  
  Provide String value from inputOutput SFString field named description.
  
  Tooltip: Author-provided prose that describes intended purpose of 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 ListenerPointSource
  
  Specified by:
  
  getDescription in interface X3DSoundNode
  
  Specified by:
  
  getDescription in interface X3DSoundSourceNode
  
  Specified by:
  
  getDescription in interface X3DTimeDependentNode
  
  Returns:
  
  value of description field
- setDescription
  
  public ListenerPointSource 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 ListenerPointSource
  
  Specified by:
  
  setDescription in interface X3DSoundNode
  
  Specified by:
  
  setDescription in interface X3DSoundSourceNode
  
  Specified by:
  
  setDescription in interface X3DTimeDependentNode
  
  Parameters:
  
  newValue - is new value for the description field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setDescription
  
  public ListenerPointSource setDescription(SFString newValue)
  
  Assign typed object value to SFString description field, similar to setDescription(String). // #0.e
  
  Parameters:
  
  newValue - is new value for the description field.
  
  Returns:
  
  ListenerPointSource - 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 <a href="https://en.wikipedia.org/wiki/Doppler_effect" target="_blank">https://en.wikipedia.org/wiki/Doppler_effect</a> *
  
  Specified by:
  
  getDopplerEnabled in interface ListenerPointSource
  
  Returns:
  
  value of dopplerEnabled field
- setDopplerEnabled
  
  public ListenerPointSource 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 <a href="https://en.wikipedia.org/wiki/Doppler_effect" target="_blank">https://en.wikipedia.org/wiki/Doppler_effect</a> *
  
  Specified by:
  
  setDopplerEnabled in interface ListenerPointSource
  
  Parameters:
  
  newValue - is new value for the dopplerEnabled field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setDopplerEnabled
  
  public ListenerPointSource setDopplerEnabled(SFBool newValue)
  
  Assign typed object value to SFBool dopplerEnabled field, similar to setDopplerEnabled(boolean). // #0.e
  
  Parameters:
  
  newValue - is new value for the dopplerEnabled field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getElapsedTime
  
  public double getElapsedTime()
  
  Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.
  
  Tooltip: [0,+infinity) Current elapsed time since AudioClip activated/running, cumulative in seconds, and not counting any paused time. Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events. Hint: elapsedTime is a nonnegative SFTime duration interval, not an absolute clock time. *
  
  Specified by:
  
  getElapsedTime in interface ListenerPointSource
  
  Specified by:
  
  getElapsedTime in interface X3DSoundSourceNode
  
  Specified by:
  
  getElapsedTime in interface X3DTimeDependentNode
  
  Returns:
  
  value of elapsedTime field
- getEnabled
  
  public boolean getEnabled()
  
  Provide boolean value from inputOutput SFBool field named enabled.
  
  Tooltip: Enables/disables node operation. *
  
  Specified by:
  
  getEnabled in interface ListenerPointSource
  
  Specified by:
  
  getEnabled in interface X3DSoundNode
  
  Specified by:
  
  getEnabled in interface X3DSoundSourceNode
  
  Returns:
  
  value of enabled field
- setEnabled
  
  public ListenerPointSource 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 ListenerPointSource
  
  Specified by:
  
  setEnabled in interface X3DSoundNode
  
  Specified by:
  
  setEnabled in interface X3DSoundSourceNode
  
  Parameters:
  
  newValue - is new value for the enabled field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setEnabled
  
  public ListenerPointSource setEnabled(SFBool newValue)
  
  Assign typed object value to SFBool enabled field, similar to setEnabled(boolean). // #0.e
  
  Parameters:
  
  newValue - is new value for the enabled field.
  
  Returns:
  
  ListenerPointSource - 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 ListenerPointSource
  
  Specified by:
  
  getGain in interface X3DSoundSourceNode
  
  Returns:
  
  value of gain field
- setGain
  
  public ListenerPointSource 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 ListenerPointSource
  
  Specified by:
  
  setGain in interface X3DSoundSourceNode
  
  Parameters:
  
  newValue - is new value for the gain field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setGain
  
  public ListenerPointSource setGain(SFFloat newValue)
  
  Assign typed object value to SFFloat gain field, similar to setGain(float). // #0.e
  
  Parameters:
  
  newValue - is new value for the gain field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setGain
  
  public ListenerPointSource 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:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getInterauralDistance
  
  public float getInterauralDistance()
  
  Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named interauralDistance.
  
  Tooltip: [0,+infinity) The interauralDistance field is . *
  
  Specified by:
  
  getInterauralDistance in interface ListenerPointSource
  
  Returns:
  
  value of interauralDistance field
- setInterauralDistance
  
  public ListenerPointSource setInterauralDistance(float newValue)
  
  Accessor method to assign float value to inputOutput SFFloat field named interauralDistance.
  
  Tooltip: [0,+infinity) The interauralDistance field is . *
  
  Specified by:
  
  setInterauralDistance in interface ListenerPointSource
  
  Parameters:
  
  newValue - is new value for the interauralDistance field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setInterauralDistance
  
  public ListenerPointSource setInterauralDistance(SFFloat newValue)
  
  Assign typed object value to SFFloat interauralDistance field, similar to setInterauralDistance(float). // #0.e
  
  Parameters:
  
  newValue - is new value for the interauralDistance field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setInterauralDistance
  
  public ListenerPointSource setInterauralDistance(double newValue)
  
  Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setInterauralDistance(float).
  
  Parameters:
  
  newValue - is new value for field
  
  Returns:
  
  ListenerPointSource - 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 ListenerPointSource 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:
  
  ListenerPointSource - 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 ListenerPointSource clearIS()
  
  Utility method to clear SFNode value of IS field.
  
  Returns:
  
  ListenerPointSource - 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()
- getIsActive
  
  public boolean getIsActive()
  
  Provide boolean value from outputOnly SFBool field named isActive.
  
  Tooltip: isActive true/false events are sent when playback starts/stops. Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events. *
  
  Specified by:
  
  getIsActive in interface ListenerPointSource
  
  Specified by:
  
  getIsActive in interface X3DSoundSourceNode
  
  Specified by:
  
  getIsActive in interface X3DTimeDependentNode
  
  Returns:
  
  value of isActive field
- getIsPaused
  
  public boolean getIsPaused()
  
  Provide boolean value from outputOnly SFBool field named isPaused.
  
  Tooltip: isPaused true/false events are sent when AudioClip is paused/resumed. Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events. *
  
  Specified by:
  
  getIsPaused in interface ListenerPointSource
  
  Specified by:
  
  getIsPaused in interface X3DSoundSourceNode
  
  Specified by:
  
  getIsPaused in interface X3DTimeDependentNode
  
  Returns:
  
  value of isPaused field
- 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 ListenerPointSource
  
  Specified by:
  
  getMetadata in interface X3DChildNode
  
  Specified by:
  
  getMetadata in interface X3DNode
  
  Specified by:
  
  getMetadata in interface X3DSoundNode
  
  Specified by:
  
  getMetadata in interface X3DSoundSourceNode
  
  Specified by:
  
  getMetadata in interface X3DTimeDependentNode
  
  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 <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata</a> *
  
  X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  public ListenerPointSource 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 ListenerPointSource
  
  Specified by:
  
  setMetadata in interface X3DChildNode
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Specified by:
  
  setMetadata in interface X3DSoundNode
  
  Specified by:
  
  setMetadata in interface X3DSoundSourceNode
  
  Specified by:
  
  setMetadata in interface X3DTimeDependentNode
  
  Specified by:
  
  setMetadata in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  ListenerPointSource - 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 <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata</a> *
  
  X3D Scene Authoring Hints: Metadata Nodes
- clearMetadata
  
  public ListenerPointSource clearMetadata()
  
  Utility method to clear SFNode value of metadata field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- setMetadata
  public ListenerPointSource 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:
  
  ListenerPointSource - 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
- getOrientation
  
  public float[] getOrientation()
  
  Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.
  
  Tooltip: Rotation (axis, angle in radians) of listening point direction relative to default -Z axis direction in local coordinate system. Warning: for VR/AR/MAR users wearing a head-mounted display (HMD), animating this field may induce motion sickness. Hint: this is orientation _change_ from default direction (0 0 -1). Hint: complex rotations can be accomplished axis-by-axis using parent Transforms. *
  
  Specified by:
  
  getOrientation in interface ListenerPointSource
  
  Returns:
  
  value of orientation field
- setOrientation
  
  public ListenerPointSource setOrientation(float[] newValue)
  
  Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.
  
  Tooltip: Rotation (axis, angle in radians) of listening point direction relative to default -Z axis direction in local coordinate system. Warning: for VR/AR/MAR users wearing a head-mounted display (HMD), animating this field may induce motion sickness. Hint: this is orientation _change_ from default direction (0 0 -1). Hint: complex rotations can be accomplished axis-by-axis using parent Transforms. *
  
  Specified by:
  
  setOrientation in interface ListenerPointSource
  
  Parameters:
  
  newValue - is new value for the orientation field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setOrientation
  
  public ListenerPointSource setOrientation(SFRotation newValue)
  
  Assign typed object value to SFRotation orientation field, similar to setOrientation(float[]). // #0.e
  
  Parameters:
  
  newValue - is new value for the orientation field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setOrientation
  
  public ListenerPointSource setOrientation(float x, float y, float z, float angleRadians)
  
  Assign values to SFRotation orientation field, similar to setOrientation(float[]).
  
  Parameters:
  
  x - first component of axis
  
  y - second component of axis
  
  z - third component of axis
  
  angleRadians - fourth component of rotation around axis
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setOrientation
  
  public ListenerPointSource setOrientation(double x, double y, double z, double angleRadians)
  
  Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setOrientation(float[]).
  
  Parameters:
  
  x - first component
  
  y - second component
  
  z - third component
  
  angleRadians - fourth component
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setOrientation
  
  public ListenerPointSource setOrientation(double[] newArray)
  
  Utility method: double-precision set-array accessor for X3D floating-point type, similar to setOrientation(float[]).
  
  Parameters:
  
  newArray - is new value for field
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getPauseTime
  
  public double getPauseTime()
  
  Provide double value in seconds from inputOutput SFTime field named pauseTime.
  
  Tooltip: When time now >= pauseTime, isPaused becomes true and AudioClip becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT. Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime. *
  
  Specified by:
  
  getPauseTime in interface ListenerPointSource
  
  Specified by:
  
  getPauseTime in interface X3DSoundSourceNode
  
  Specified by:
  
  getPauseTime in interface X3DTimeDependentNode
  
  Returns:
  
  value of pauseTime field
- setPauseTime
  
  public ListenerPointSource setPauseTime(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.
  
  Tooltip: When time now >= pauseTime, isPaused becomes true and AudioClip becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT. Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime. *
  
  Specified by:
  
  setPauseTime in interface ListenerPointSource
  
  Specified by:
  
  setPauseTime in interface X3DSoundSourceNode
  
  Specified by:
  
  setPauseTime in interface X3DTimeDependentNode
  
  Parameters:
  
  newValue - is new value for the pauseTime field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setPauseTime
  
  public ListenerPointSource setPauseTime(SFTime newValue)
  
  Assign typed object value to SFTime pauseTime field, similar to setPauseTime(double). // #0.e
  
  Parameters:
  
  newValue - is new value for the pauseTime field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getPosition
  
  public float[] getPosition()
  
  Provide array of 3-tuple float results from inputOutput SFVec3f field named position.
  
  Tooltip: position (x, y, z in meters) relative to local coordinate system. *
  
  Specified by:
  
  getPosition in interface ListenerPointSource
  
  Returns:
  
  value of position field
- setPosition
  
  public ListenerPointSource setPosition(float[] newValue)
  
  Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named position.
  
  Tooltip: position (x, y, z in meters) relative to local coordinate system. *
  
  Specified by:
  
  setPosition in interface ListenerPointSource
  
  Parameters:
  
  newValue - is new value for the position field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setPosition
  
  public ListenerPointSource setPosition(SFVec3f newValue)
  
  Assign typed object value to SFVec3f position field, similar to setPosition(float[]). // #0.e
  
  Parameters:
  
  newValue - is new value for the position field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setPosition
  
  public ListenerPointSource setPosition(float x, float y, float z)
  
  Assign values to SFVec3f position field, similar to setPosition(float[]).
  
  Parameters:
  
  x - first component
  
  y - second component
  
  z - third component
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setPosition
  
  public ListenerPointSource setPosition(double x, double y, double z)
  
  Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setPosition(float[]).
  
  Parameters:
  
  x - first component
  
  y - second component
  
  z - third component
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setPosition
  
  public ListenerPointSource setPosition(double[] newArray)
  
  Utility method: double-precision set-array accessor for X3D floating-point type, similar to setPosition(float[]).
  
  Parameters:
  
  newArray - is new value for field
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getResumeTime
  
  public double getResumeTime()
  
  Provide double value in seconds from inputOutput SFTime field named resumeTime.
  
  Tooltip: When resumeTime becomes <= time now, isPaused becomes false and AudioClip becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT. Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime. *
  
  Specified by:
  
  getResumeTime in interface ListenerPointSource
  
  Specified by:
  
  getResumeTime in interface X3DSoundSourceNode
  
  Specified by:
  
  getResumeTime in interface X3DTimeDependentNode
  
  Returns:
  
  value of resumeTime field
- setResumeTime
  
  public ListenerPointSource setResumeTime(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.
  
  Tooltip: When resumeTime becomes <= time now, isPaused becomes false and AudioClip becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT. Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime. *
  
  Specified by:
  
  setResumeTime in interface ListenerPointSource
  
  Specified by:
  
  setResumeTime in interface X3DSoundSourceNode
  
  Specified by:
  
  setResumeTime in interface X3DTimeDependentNode
  
  Parameters:
  
  newValue - is new value for the resumeTime field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setResumeTime
  
  public ListenerPointSource setResumeTime(SFTime newValue)
  
  Assign typed object value to SFTime resumeTime field, similar to setResumeTime(double). // #0.e
  
  Parameters:
  
  newValue - is new value for the resumeTime field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getStartTime
  
  public double getStartTime()
  
  Provide double value in seconds from inputOutput SFTime field named startTime.
  
  Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT. Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime. *
  
  Specified by:
  
  getStartTime in interface ListenerPointSource
  
  Specified by:
  
  getStartTime in interface X3DSoundSourceNode
  
  Specified by:
  
  getStartTime in interface X3DTimeDependentNode
  
  Returns:
  
  value of startTime field
- setStartTime
  
  public ListenerPointSource setStartTime(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.
  
  Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT. Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime. *
  
  Specified by:
  
  setStartTime in interface ListenerPointSource
  
  Specified by:
  
  setStartTime in interface X3DSoundSourceNode
  
  Specified by:
  
  setStartTime in interface X3DTimeDependentNode
  
  Parameters:
  
  newValue - is new value for the startTime field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setStartTime
  
  public ListenerPointSource setStartTime(SFTime newValue)
  
  Assign typed object value to SFTime startTime field, similar to setStartTime(double). // #0.e
  
  Parameters:
  
  newValue - is new value for the startTime field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getStopTime
  
  public double getStopTime()
  
  Provide double value in seconds from inputOutput SFTime field named stopTime.
  
  Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT. Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime. Warning: An active TimeSensor node ignores set_cycleInterval and set_startTime events. Warning:An active TimeSensor node ignores set_stopTime event values less than or equal to startTime. *
  
  Specified by:
  
  getStopTime in interface ListenerPointSource
  
  Specified by:
  
  getStopTime in interface X3DSoundSourceNode
  
  Specified by:
  
  getStopTime in interface X3DTimeDependentNode
  
  Returns:
  
  value of stopTime field
- setStopTime
  
  public ListenerPointSource setStopTime(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.
  
  Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT. Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime. Warning: An active TimeSensor node ignores set_cycleInterval and set_startTime events. Warning:An active TimeSensor node ignores set_stopTime event values less than or equal to startTime. *
  
  Specified by:
  
  setStopTime in interface ListenerPointSource
  
  Specified by:
  
  setStopTime in interface X3DSoundSourceNode
  
  Specified by:
  
  setStopTime in interface X3DTimeDependentNode
  
  Parameters:
  
  newValue - is new value for the stopTime field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setStopTime
  
  public ListenerPointSource setStopTime(SFTime newValue)
  
  Assign typed object value to SFTime stopTime field, similar to setStopTime(double). // #0.e
  
  Parameters:
  
  newValue - is new value for the stopTime field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getTrackCurrentView
  
  public boolean getTrackCurrentView()
  
  Provide boolean value from inputOutput SFBool field named trackCurrentView.
  
  Tooltip: If trackCurrentView field is true then position and orientation match avatar's (user's) current view. *
  
  Specified by:
  
  getTrackCurrentView in interface ListenerPointSource
  
  Returns:
  
  value of trackCurrentView field
- setTrackCurrentView
  
  public ListenerPointSource setTrackCurrentView(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named trackCurrentView.
  
  Tooltip: If trackCurrentView field is true then position and orientation match avatar's (user's) current view. *
  
  Specified by:
  
  setTrackCurrentView in interface ListenerPointSource
  
  Parameters:
  
  newValue - is new value for the trackCurrentView field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setTrackCurrentView
  
  public ListenerPointSource setTrackCurrentView(SFBool newValue)
  
  Assign typed object value to SFBool trackCurrentView field, similar to setTrackCurrentView(boolean). // #0.e
  
  Parameters:
  
  newValue - is new value for the trackCurrentView field.
  
  Returns:
  
  ListenerPointSource - 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 <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *
  
  Overrides:
  
  getDEF in class X3DConcreteNode
  
  Returns:
  
  value of DEF field
  
  See Also:
  
  X3D Scene Authoring Hints: Naming Conventions
- setDEF
  
  public final ListenerPointSource 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 <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *
  
  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:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setDEF
  
  public ListenerPointSource setDEF(SFString newValue)
  
  Assign typed object value to SFString DEF field, similar to setDEF(String). // #0.e
  
  Parameters:
  
  newValue - is new value for the DEF field.
  
  Returns:
  
  ListenerPointSource - 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 ListenerPointSource 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:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setUSE
  
  public ListenerPointSource setUSE(SFString newValue)
  
  Assign typed object value to SFString USE field, similar to setUSE(String). // #0.e
  
  Parameters:
  
  newValue - is new value for the USE field.
  
  Returns:
  
  ListenerPointSource - 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 ListenerPointSource 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:
  
  ListenerPointSource - 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 ListenerPointSource setCssClass(SFString newValue)
  
  Assign typed object value to SFString cssClass field, similar to setCssClass(String). // #0.e
  
  Parameters:
  
  newValue - is new value for the class field.
  
  Returns:
  
  ListenerPointSource - 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 ListenerPointSource 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:
  
  ListenerPointSource - 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 ListenerPointSource setHtmlID(SFString newValue)
  
  Assign typed object value to SFString HtmlID field, similar to setHtmlID(String). // #0.e
  
  Parameters:
  
  newValue - is new value for the id field.
  
  Returns:
  
  ListenerPointSource - 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 ListenerPointSource 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:
  
  ListenerPointSource - 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 ListenerPointSource setCssStyle(SFString newValue)
  
  Assign typed object value to SFString cssClass field, similar to setCssStyle(String). // #0.e
  
  Parameters:
  
  newValue - is new value for the style field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setUSE
  
  public ListenerPointSource setUSE(ListenerPointSource 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:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- addComments
  public ListenerPointSource addComments(String newComment)
  
  Add comment as String to contained commentsList.
  
  Specified by:
  
  addComments in class X3DConcreteElement
  
  Parameters:
  
  newComment - initial value
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  X3D Architecture, clause 7.2.5.1 Organization
- addComments
  
  public ListenerPointSource addComments(String[] newComments)
  
  Add comments as String[] array to contained commentsList.
  
  Specified by:
  
  addComments in class X3DConcreteElement
  
  Parameters:
  
  newComments - array of comments
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- addComments
  
  public ListenerPointSource addComments(CommentsBlock newCommentsBlock)
  
  Add CommentsBlock to contained commentsList.
  
  Specified by:
  
  addComments in class X3DConcreteElement
  
  Parameters:
  
  newCommentsBlock - block of comments to add
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- toStringX3D
  public String toStringX3D(int indentLevel)
  
  Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
  
  Specified by:
  
  toStringX3D in class X3DConcreteElement
  
  Parameters:
  
  indentLevel - number of levels of indentation for this element
  
  Returns:
  
  X3D string
  
  See Also:
  
  X3D.FILE_EXTENSION_X3D
  
  X3D.FILE_EXTENSION_XML
  
  X3D.toStringXML()
  
  X3D.toFileXML(String)
  
  X3D.toFileX3D(String)
  
  X3D XML Encoding
  
  X3D Compressed Binary Encoding: X3D Canonical Form
  
  X3D Canonicalization (C14N) Tool
- toStringClassicVRML
  public String toStringClassicVRML(int indentLevel)
  
  Recursive method to provide ClassicVRML string serialization.
  
  Specified by:
  
  toStringClassicVRML in class X3DConcreteElement
  
  Parameters:
  
  indentLevel - number of levels of indentation for this element
  
  Returns:
  
  ClassicVRML string
  
  See Also:
  
  X3D.FILE_EXTENSION_CLASSICVRML
  
  X3D Resources: Virtual Reality Modeling Language (VRML) 97
  
  Extensible 3D (X3D) encodings Part 2: Classic VRML encoding
  
  Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
- toStringVRML97
  public String toStringVRML97(int indentLevel)
  
  Recursive method to provide VRML97 string serialization.
  
  Specified by:
  
  toStringVRML97 in class X3DConcreteElement
  
  Parameters:
  
  indentLevel - number of levels of indentation for this element
  
  Returns:
  
  VRML97 string
  
  See Also:
  
  X3D.FILE_EXTENSION_VRML97
  
  X3D Resources: Virtual Reality Modeling Language (VRML) 97
  
  Virtual Reality Modeling Language (VRML) 97 specification
  
  VRML 97 v2.1 Amendment
- findElementByNameValue
  public X3DConcreteElement findElementByNameValue(String nameValue)
  
  Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
  
  Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
  
  Warning: more than one element may be found that has the same name, this method does not handle that case.
  
  Specified by:
  
  findElementByNameValue in class X3DConcreteElement
  
  Parameters:
  
  nameValue - is value of the name field being searched for in this element and child elements(if any)
  
  Returns:
  
  object reference to found element, null otherwise
  
  See Also:
  
  findNodeByDEF(String)
  
  X3DConcreteElement.hasAncestorScene()
  
  X3DConcreteElement.findAncestorX3D()
- findElementByNameValue
  public X3DConcreteElement findElementByNameValue(String nameValue, String elementName)
  
  Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
  
  Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
  
  Warning: more than one element may be found that has the same name, this method does not handle that case.
  
  Specified by:
  
  findElementByNameValue in class X3DConcreteElement
  
  Parameters:
  
  nameValue - is value of the name field being searched for in this element and child elements(if any)
  
  elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
  
  Returns:
  
  object reference to found element, null otherwise
  
  See Also:
  
  findNodeByDEF(String)
  
  X3DConcreteElement.hasAncestorScene()
  
  X3DConcreteElement.findAncestorX3D()
- hasElementByNameValue
  public boolean hasElementByNameValue(String nameValue, String elementName)
  
  Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
  
  Parameters:
  
  nameValue - is value of the name field being searched for in this element and child elements(if any)
  
  elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
  
  Returns:
  
  whether node is found
  
  See Also:
  
  findElementByNameValue(String, String)
- findNodeByDEF
  public X3DConcreteNode findNodeByDEF(String DEFvalue)
  
  Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
  
  Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
  
  Warning: more than one element may be found that has the same DEF, this method does not handle that case.
  
  Specified by:
  
  findNodeByDEF in class X3DConcreteElement
  
  Parameters:
  
  DEFvalue - is value of the name field being searched for in this element and child elements(if any)
  
  Returns:
  
  object reference to found node, null otherwise
  
  See Also:
  
  findElementByNameValue(String)
  
  X3DConcreteElement.hasAncestorScene()
  
  X3DConcreteElement.findAncestorX3D()
- hasNodeByDEF
  public boolean hasNodeByDEF(String DEFvalue)
  
  Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
  
  Parameters:
  
  DEFvalue - is value of the name field being searched for in this element and child elements(if any)
  
  Returns:
  
  whether node is found
  
  See Also:
  
  findNodeByDEF(String)
- validate
  
  public String validate()
  
  Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.
  
  Specified by:
  
  validate in class X3DConcreteElement
  
  Returns:
  
  validation results (if any)

Class ListenerPointSource

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Details

NAME

COMPONENT

LEVEL

DESCRIPTION_DEFAULT_VALUE

DOPPLERENABLED_DEFAULT_VALUE

ENABLED_DEFAULT_VALUE

GAIN_DEFAULT_VALUE

INTERAURALDISTANCE_DEFAULT_VALUE

IS_DEFAULT_VALUE

METADATA_DEFAULT_VALUE

ORIENTATION_DEFAULT_VALUE

PAUSETIME_DEFAULT_VALUE

POSITION_DEFAULT_VALUE

RESUMETIME_DEFAULT_VALUE

STARTTIME_DEFAULT_VALUE

STOPTIME_DEFAULT_VALUE

TRACKCURRENTVIEW_DEFAULT_VALUE

containerField_DEFAULT_VALUE

fromField_DESCRIPTION

toField_DESCRIPTION

fromField_DOPPLERENABLED

toField_DOPPLERENABLED

fromField_ELAPSEDTIME

fromField_ENABLED

toField_ENABLED

fromField_GAIN

toField_GAIN

fromField_INTERAURALDISTANCE

toField_INTERAURALDISTANCE

fromField_IS

fromField_ISACTIVE

fromField_ISPAUSED

fromField_METADATA

toField_METADATA

fromField_ORIENTATION

toField_ORIENTATION

fromField_PAUSETIME

toField_PAUSETIME

fromField_POSITION

toField_POSITION

fromField_RESUMETIME

toField_RESUMETIME

fromField_STARTTIME

toField_STARTTIME

fromField_STOPTIME

toField_STOPTIME

fromField_TRACKCURRENTVIEW

toField_TRACKCURRENTVIEW

Constructor Details

ListenerPointSource

ListenerPointSource

Method Details

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

getContainerFieldDefault

initialize

getDescription

setDescription

setDescription

getDopplerEnabled

setDopplerEnabled

setDopplerEnabled

getElapsedTime

getEnabled

setEnabled

setEnabled

getGain