Aire::AudioListener Class Reference

AudioListener class to listen to sound effects. More...

#include <audioListener.h>

Public Member Functions
AudioListener *	setPosition (float x, float y, float z)
	Sets the position of the audio listener.
AudioListener *	setPosition (const glm::vec3 &pos)
	Sets the position of the audio listener.
glm::vec3	getPosition () const
	Gets the position of the audio listener.
AudioListener *	setOrientation (float atx, float aty, float atz, float upx, float upy, float upz)
	Sets the orientation of the audio listener.
AudioListener *	setOrientation (const glm::vec3 &at, const glm::vec3 &up)
	Sets the orientation of the audio listener.
glm::vec3	getOrientationAt () const
	Gets the "at" vector of the audio listener orientation.
glm::vec3	getOrientationUp () const
	Gets the "up" vector of the audio listener orientation.

Detailed Description

AudioListener class to listen to sound effects.

Normally, there is only one unique audio listener.

Member Function Documentation

getOrientationAt()

glm::vec3 Aire::AudioListener::getOrientationAt

(

)

const

Gets the "at" vector of the audio listener orientation.

Returns

The "at" vector.

getOrientationUp()

glm::vec3 Aire::AudioListener::getOrientationUp

(

)

const

Gets the "up" vector of the audio listener orientation.

Returns

The "up" vector.

getPosition()

glm::vec3 Aire::AudioListener::getPosition

(

)

const

Gets the position of the audio listener.

Returns

The position vector.

setOrientation() [1/2]

AudioListener * Aire::AudioListener::setOrientation	(	const glm::vec3 &	at,
		const glm::vec3 &	up )

Sets the orientation of the audio listener.

Parameters

at	The "at" vector.
up	The "up" vector.

Returns

Pointer to the current AudioListener object.

setOrientation() [2/2]

AudioListener * AudioListener::setOrientation	(	float	atx,
		float	aty,
		float	atz,
		float	upx,
		float	upy,
		float	upz )

Sets the orientation of the audio listener.

Parameters

atx	The x-coordinate of the "at" vector.
aty	The y-coordinate of the "at" vector.
atz	The z-coordinate of the "at" vector.
upx	The x-coordinate of the "up" vector.
upy	The y-coordinate of the "up" vector.
upz	The z-coordinate of the "up" vector.

Returns

Pointer to the current AudioListener object.

setPosition() [1/2]

AudioListener * Aire::AudioListener::setPosition

(

const glm::vec3 &

pos

)

Sets the position of the audio listener.

Parameters

pos	The position vector.

Returns

Pointer to the current AudioListener object.

setPosition() [2/2]

AudioListener * AudioListener::setPosition	(	float	x,
		float	y,
		float	z )

Sets the position of the audio listener.

Parameters

x	The x-coordinate of the position.
y	The y-coordinate of the position.
z	The z-coordinate of the position.

Returns

Pointer to the current AudioListener object.

---

The documentation for this class was generated from the following files:

• source/audio/audioListener.h
• source/audio/audioListener.cpp