org.achtern.AchternEngine.core.audio.openal

Class AudioListener

java.lang.Object

org.achtern.AchternEngine.core.scenegraph.entity.QuickEntity

org.achtern.AchternEngine.core.audio.openal.AudioListener

All Implemented Interfaces:

Audio, EngineHolder<CoreEngine>, Entity, Updatable

public class AudioListener
extends QuickEntity
implements Audio

The AudioListener represents the 'ears' of the 'camera'. There can only be one tied to the OpenAL engine at all times.

Field Summary

Fields

Modifier and Type	Field and Description
protected AudioPlayer	audioPlayer
protected Vector3f	velocity The velocity of the listener, for doppler effects etc.

Fields inherited from class org.achtern.AchternEngine.core.scenegraph.entity.QuickEntity

destroy, engine, name, NAME_UNTITLED_ENTITY, parent

Constructor Summary

Constructors

Constructor and Description
AudioListener() Creates an AudioListener with no velocity
AudioListener(Vector3f velocity, AudioPlayer audioPlayer)

Method Summary

Modifier and Type	Method and Description
void	attached() Called when an Entity gets attached to an scenegraph
protected boolean	canEqual(Object other)
boolean	equals(Object o)
AudioPlayer	getAudioPlayer()
Vector3f	getForward()
Vector3f	getPosition()
Vector3f	getUp()
Vector3f	getVelocity() The velocity of the listener, for doppler effects etc.
int	hashCode()
void	setAudioPlayer(AudioPlayer audioPlayer)
void	setVelocity(Vector3f velocity) The velocity of the listener, for doppler effects etc.
String	toString()
void	update(float delta) Trigger an update.

Methods inherited from class org.achtern.AchternEngine.core.scenegraph.entity.QuickEntity

boxed, destroy, destroy, getEngine, getName, getParent, getTransform, isDestroy, removed, render, setDestroy, setEngine, setName, setParent, shouldBeDestroyed

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

velocity

protected Vector3f velocity

The velocity of the listener, for doppler effects etc. Not needed in most cases.

audioPlayer

protected AudioPlayer audioPlayer

Constructor Detail

AudioListener

public AudioListener()

Creates an AudioListener with no velocity

AudioListener

@ConstructorProperties(value={"velocity","audioPlayer"})
 @Generated(value="lombok")
public AudioListener(Vector3f velocity,
                                                                                                          AudioPlayer audioPlayer)

Method Detail

update

public void update(float delta)

Description copied from interface: Updatable

Trigger an update. Do you regular updating of nodes/entities in here.

Specified by:

update in interface Updatable

Overrides:

update in class QuickEntity

Parameters:

delta - The delta time

See Also:

Updatable.update(float)

attached

public void attached()

Description copied from interface: Entity

Called when an Entity gets attached to an scenegraph

Specified by:

attached in interface Entity

Overrides:

attached in class QuickEntity

See Also:

()

getUp

public Vector3f getUp()

getForward

public Vector3f getForward()

getPosition

public Vector3f getPosition()

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class QuickEntity

canEqual

@Generated(value="lombok")
protected boolean canEqual(Object other)

Overrides:

canEqual in class QuickEntity

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class QuickEntity

getVelocity

@Generated(value="lombok")
public Vector3f getVelocity()

The velocity of the listener, for doppler effects etc. Not needed in most cases.

Returns:

current velocity

getAudioPlayer

@Generated(value="lombok")
public AudioPlayer getAudioPlayer()

Specified by:

getAudioPlayer in interface Audio

setVelocity

@Generated(value="lombok")
public void setVelocity(Vector3f velocity)

The velocity of the listener, for doppler effects etc. Not needed in most cases.

Parameters:

velocity - new velocity

setAudioPlayer

@Generated(value="lombok")
public void setAudioPlayer(AudioPlayer audioPlayer)

Specified by:

setAudioPlayer in interface Audio

toString

@Generated(value="lombok")
public String toString()

Overrides:

toString in class QuickEntity