Package org.web3d.x3d.sai.Sound

Interface ListenerPoint

All Superinterfaces:
X3DChildNode, X3DNode, X3DSoundSourceNode, X3DTimeDependentNode
All Known Implementing Classes:
ListenerPoint
public interface ListenerPoint
extends X3DSoundSourceNode
ListenerPoint 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.

X3D node tooltip: (X3D version 4.0 draft) [X3DSoundSourceNode] ListenerPoint 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 ListenerPoint nodes can be active for sound processing.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification, X3D Abstract Specification: ListenerPoint, X3D Tooltips: ListenerPoint, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getDescription()
    Provide String value from inputOutput SFString field named description.
    double getElapsedTime()
    Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.
    boolean getEnabled()
    Provide boolean value from inputOutput SFBool field named enabled.
    float getGain()
    Provide float value from inputOutput SFFloat field named gain.
    float getInterauralDistance()
    Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named interauralDistance.
    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.
    ListenerPoint setDescription​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    ListenerPoint setEnabled​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    ListenerPoint setGain​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named gain.
    ListenerPoint setInterauralDistance​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named interauralDistance.
    ListenerPoint setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    ListenerPoint setOrientation​(float[] newValue)
    Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.
    ListenerPoint setPauseTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.
    ListenerPoint setPosition​(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named position.
    ListenerPoint setResumeTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.
    ListenerPoint setStartTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.
    ListenerPoint setStopTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.
    ListenerPoint setTrackCurrentView​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named trackCurrentView.

  • Method Details

    • getDescription

      java.lang.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 X3DSoundSourceNode
      Specified by:
      getDescription in interface X3DTimeDependentNode
      Returns:
      value of description field

    • setDescription

      ListenerPoint setDescription​(java.lang.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 X3DSoundSourceNode
      Specified by:
      setDescription in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      ListenerPoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getElapsedTime

      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 X3DSoundSourceNode
      Specified by:
      getElapsedTime in interface X3DTimeDependentNode
      Returns:
      value of elapsedTime field

    • getEnabled

      boolean getEnabled()
      Provide boolean value from inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Specified by:
      getEnabled in interface X3DSoundSourceNode
      Returns:
      value of enabled field

    • setEnabled

      ListenerPoint 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 X3DSoundSourceNode
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      ListenerPoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getGain

      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 X3DSoundSourceNode
      Returns:
      value of gain field

    • setGain

      ListenerPoint 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 X3DSoundSourceNode
      Parameters:
      newValue - is new value for the gain field.
      Returns:
      ListenerPoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getInterauralDistance

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

      Tooltip: [0,+infinity) The interauralDistance field is . *
      Returns:
      value of interauralDistance field

    • setInterauralDistance

      ListenerPoint setInterauralDistance​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named interauralDistance.

      Tooltip: [0,+infinity) The interauralDistance field is . *
      Parameters:
      newValue - is new value for the interauralDistance field.
      Returns:
      ListenerPoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getIsActive

      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 X3DSoundSourceNode
      Specified by:
      getIsActive in interface X3DTimeDependentNode
      Returns:
      value of isActive field

    • getIsPaused

      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 X3DSoundSourceNode
      Specified by:
      getIsPaused in interface X3DTimeDependentNode
      Returns:
      value of isPaused field

    • getMetadata

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

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DSoundSourceNode
      Specified by:
      getMetadata in interface X3DTimeDependentNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

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

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DSoundSourceNode
      Specified by:
      setMetadata in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ListenerPoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • getOrientation

      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.
      Returns:
      value of orientation field

    • setOrientation

      ListenerPoint 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.
      Parameters:
      newValue - is new value for the orientation field.
      Returns:
      ListenerPoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getPauseTime

      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 X3DSoundSourceNode
      Specified by:
      getPauseTime in interface X3DTimeDependentNode
      Returns:
      value of pauseTime field

    • setPauseTime

      ListenerPoint 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 X3DSoundSourceNode
      Specified by:
      setPauseTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the pauseTime field.
      Returns:
      ListenerPoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getPosition

      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. *
      Returns:
      value of position field

    • setPosition

      ListenerPoint 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. *
      Parameters:
      newValue - is new value for the position field.
      Returns:
      ListenerPoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getResumeTime

      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 X3DSoundSourceNode
      Specified by:
      getResumeTime in interface X3DTimeDependentNode
      Returns:
      value of resumeTime field

    • setResumeTime

      ListenerPoint 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 X3DSoundSourceNode
      Specified by:
      setResumeTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the resumeTime field.
      Returns:
      ListenerPoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getStartTime

      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 X3DSoundSourceNode
      Specified by:
      getStartTime in interface X3DTimeDependentNode
      Returns:
      value of startTime field

    • setStartTime

      ListenerPoint 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 X3DSoundSourceNode
      Specified by:
      setStartTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the startTime field.
      Returns:
      ListenerPoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getStopTime

      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 X3DSoundSourceNode
      Specified by:
      getStopTime in interface X3DTimeDependentNode
      Returns:
      value of stopTime field

    • setStopTime

      ListenerPoint 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 X3DSoundSourceNode
      Specified by:
      setStopTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the stopTime field.
      Returns:
      ListenerPoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getTrackCurrentView

      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. *
      Returns:
      value of trackCurrentView field

    • setTrackCurrentView

      ListenerPoint 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. *
      Parameters:
      newValue - is new value for the trackCurrentView field.
      Returns:
      ListenerPoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).