Package org.web3d.x3d.sai.Sound
Interface ListenerPoint
- All Superinterfaces:
X3DBindableNode
,X3DChildNode
,X3DNode
,X3DSoundSourceNode
,X3DTimeDependentNode
- All Known Implementing Classes:
ListenerPoint
public interface ListenerPoint extends X3DSoundSourceNode, X3DBindableNode
Abstract node interface, defined by X3D Java Scene Access Interface (SAI) Specification to support X3D Java interoperability.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
-
Method Summary
Modifier and Type Method Description double
getBindTime()
Provide double value in seconds from outputOnly SFTime field named bindTime.java.lang.String
getDescription()
Provide String value from inputOutput SFString field named description.double
getDuration()
Provide double value in seconds within allowed range of [-1,infinity) from outputOnly SFTime field named duration_changed.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
getIsBound()
Provide boolean value from outputOnly SFBool field named isBound.boolean
getIsPaused()
Provide boolean value from outputOnly SFBool field named isPaused.boolean
getLoop()
Provide boolean value from inputOutput SFBool field named loop.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
getPitch()
Provide float value within allowed range of (0,infinity) from inputOutput SFFloat field named pitch.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
setLoop(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named loop.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
setPitch(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named pitch.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
-
getBindTime
double getBindTime()Provide double value in seconds from outputOnly SFTime field named bindTime.- Specified by:
getBindTime
in interfaceX3DBindableNode
- Returns:
- value of bindTime field
-
getDescription
java.lang.String getDescription()Provide String value from inputOutput SFString field named description.- Specified by:
getDescription
in interfaceX3DSoundSourceNode
- Specified by:
getDescription
in interfaceX3DTimeDependentNode
- Returns:
- value of description field
-
setDescription
Accessor method to assign String value to inputOutput SFString field named description.- Specified by:
setDescription
in interfaceX3DSoundSourceNode
- Specified by:
setDescription
in interfaceX3DTimeDependentNode
- 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).
-
getDuration
double getDuration()Provide double value in seconds within allowed range of [-1,infinity) from outputOnly SFTime field named duration_changed.- Specified by:
getDuration
in interfaceX3DSoundSourceNode
- Returns:
- value of duration_changed field
-
getElapsedTime
double getElapsedTime()Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.- Specified by:
getElapsedTime
in interfaceX3DSoundSourceNode
- Specified by:
getElapsedTime
in interfaceX3DTimeDependentNode
- Returns:
- value of elapsedTime field
-
getEnabled
boolean getEnabled()Provide boolean value from inputOutput SFBool field named enabled.- Specified by:
getEnabled
in interfaceX3DSoundSourceNode
- Returns:
- value of enabled field
-
setEnabled
Accessor method to assign boolean value to inputOutput SFBool field named enabled.- Specified by:
setEnabled
in interfaceX3DSoundSourceNode
- 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.- Specified by:
getGain
in interfaceX3DSoundSourceNode
- Returns:
- value of gain field
-
setGain
Accessor method to assign float value to inputOutput SFFloat field named gain.- Specified by:
setGain
in interfaceX3DSoundSourceNode
- 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.- Returns:
- value of interauralDistance field
-
setInterauralDistance
Accessor method to assign float value to inputOutput SFFloat field named interauralDistance.- 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.- Specified by:
getIsActive
in interfaceX3DSoundSourceNode
- Specified by:
getIsActive
in interfaceX3DTimeDependentNode
- Returns:
- value of isActive field
-
getIsBound
boolean getIsBound()Provide boolean value from outputOnly SFBool field named isBound.- Specified by:
getIsBound
in interfaceX3DBindableNode
- Returns:
- value of isBound field
-
getIsPaused
boolean getIsPaused()Provide boolean value from outputOnly SFBool field named isPaused.- Specified by:
getIsPaused
in interfaceX3DSoundSourceNode
- Specified by:
getIsPaused
in interfaceX3DTimeDependentNode
- Returns:
- value of isPaused field
-
getLoop
boolean getLoop()Provide boolean value from inputOutput SFBool field named loop.- Specified by:
getLoop
in interfaceX3DSoundSourceNode
- Specified by:
getLoop
in interfaceX3DTimeDependentNode
- Returns:
- value of loop field
-
setLoop
Accessor method to assign boolean value to inputOutput SFBool field named loop.- Specified by:
setLoop
in interfaceX3DSoundSourceNode
- Specified by:
setLoop
in interfaceX3DTimeDependentNode
- Parameters:
newValue
- is new value for the loop field.- Returns:
ListenerPoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
X3DMetadataObject getMetadata()Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceX3DBindableNode
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DSoundSourceNode
- Specified by:
getMetadata
in interfaceX3DTimeDependentNode
- Returns:
- value of metadata field
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
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 interfaceX3DBindableNode
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DSoundSourceNode
- Specified by:
setMetadata
in interfaceX3DTimeDependentNode
- 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.- Returns:
- value of orientation field
-
setOrientation
Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.- 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.- Specified by:
getPauseTime
in interfaceX3DSoundSourceNode
- Specified by:
getPauseTime
in interfaceX3DTimeDependentNode
- Returns:
- value of pauseTime field
-
setPauseTime
Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.- Specified by:
setPauseTime
in interfaceX3DSoundSourceNode
- Specified by:
setPauseTime
in interfaceX3DTimeDependentNode
- 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).
-
getPitch
float getPitch()Provide float value within allowed range of (0,infinity) from inputOutput SFFloat field named pitch.- Specified by:
getPitch
in interfaceX3DSoundSourceNode
- Returns:
- value of pitch field
-
setPitch
Accessor method to assign float value to inputOutput SFFloat field named pitch.- Specified by:
setPitch
in interfaceX3DSoundSourceNode
- Parameters:
newValue
- is new value for the pitch 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.- Returns:
- value of position field
-
setPosition
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named position.- 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.- Specified by:
getResumeTime
in interfaceX3DSoundSourceNode
- Specified by:
getResumeTime
in interfaceX3DTimeDependentNode
- Returns:
- value of resumeTime field
-
setResumeTime
Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.- Specified by:
setResumeTime
in interfaceX3DSoundSourceNode
- Specified by:
setResumeTime
in interfaceX3DTimeDependentNode
- 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.- Specified by:
getStartTime
in interfaceX3DSoundSourceNode
- Specified by:
getStartTime
in interfaceX3DTimeDependentNode
- Returns:
- value of startTime field
-
setStartTime
Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.- Specified by:
setStartTime
in interfaceX3DSoundSourceNode
- Specified by:
setStartTime
in interfaceX3DTimeDependentNode
- 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.- Specified by:
getStopTime
in interfaceX3DSoundSourceNode
- Specified by:
getStopTime
in interfaceX3DTimeDependentNode
- Returns:
- value of stopTime field
-
setStopTime
Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.- Specified by:
setStopTime
in interfaceX3DSoundSourceNode
- Specified by:
setStopTime
in interfaceX3DTimeDependentNode
- 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.- Returns:
- value of trackCurrentView field
-
setTrackCurrentView
Accessor method to assign boolean value to inputOutput SFBool field named trackCurrentView.- 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).
-