Package rosequartz.afx

Class AudioListener

java.lang.Object

rosequartz.afx.AudioListener

All Implemented Interfaces:

CameraConfiguration.CameraConfigurationHolder

public final class AudioListener
extends Object
implements CameraConfiguration.CameraConfigurationHolder

Represents the audio listener. This is (in most cases) the player.

Constructor Summary

Constructors

Constructor	Description
AudioListener(NativesFX.AudioListener nativeAudioListener)

Method Summary

Modifier and Type	Method	Description
void	_configure()	Configures the audio listener based on the current configuration.
static AudioListener	get()	Gets the audio listener.
CameraConfiguration	getConfiguration()	Gets the used camera configuration.
void	setConfiguration(CameraConfiguration configuration)	Sets the used camera configuration.
AudioListener	setVelocity(float x, float y, float z)	Sets the velocity of the AudioListener.
AudioListener	setVelocity(Vec3 xyz)	Sets the velocity of the AudioListener.
AudioListener	setVolume(float volume)	Sets the volume of what the AudioListener receives.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AudioListener

public AudioListener(NativesFX.AudioListener nativeAudioListener)

Method Details

get

public static AudioListener get()

Gets the audio listener.

Returns:

AudioListener-object

See Also:

AudioListener

setVelocity

public AudioListener setVelocity(float x,
 float y,
 float z)

Sets the velocity of the AudioListener. Note that velocity may not be implemented by every build target.

Parameters:

x - new velocity on the x-axis

y - new velocity on the y-axis

z - new velocity on the z-axis

Returns:

this

setVelocity

public AudioListener setVelocity(Vec3 xyz)

Sets the velocity of the AudioListener.

Parameters:

xyz - new velocity

Returns:

this

setVolume

public AudioListener setVolume(float volume)

Sets the volume of what the AudioListener receives.

Parameters:

volume - the volume

Returns:

this

_configure

public void _configure()

Configures the audio listener based on the current configuration. This method is called automatically called by the AudioListenerConfigurationPipeline.

setConfiguration

public void setConfiguration(CameraConfiguration configuration)

Description copied from interface: CameraConfiguration.CameraConfigurationHolder

Sets the used camera configuration.

Specified by:

setConfiguration in interface CameraConfiguration.CameraConfigurationHolder

Parameters:

configuration - camera configuration

getConfiguration

public CameraConfiguration getConfiguration()

Description copied from interface: CameraConfiguration.CameraConfigurationHolder

Gets the used camera configuration.

Specified by:

getConfiguration in interface CameraConfiguration.CameraConfigurationHolder

Returns:

camera configuration

toString

public String toString()

Overrides:

toString in class Object