3D Listener

The flimListener is an object whose position and orientation must be specified by the user to correctly configure 3D sound. More...

Collaboration diagram for 3D Listener:

Classes
class	FlimListener
	A flim listener. More...

Functions
static const Vect &	FlimListener::GetPosition ()
	Gets the position. More...
static snd_err	FlimListener::SetPosition (float x, float y, float z)
	Sets a position. More...
static snd_err	FlimListener::SetPosition (const Vect &vect)
	Sets a position. More...
static snd_err	FlimListener::UpdateOrientation (float xF, float yF, float zF, float xU, float yU, float zU)
	Updates the orientation. More...
static snd_err	FlimListener::SetOrientation (const Vect &vectF, float x=0.0f, float y=1.0f, float z=0.0f)
	Sets an orientation. More...
static snd_err	FlimListener::SetOrientation (const Vect &vectF, const Vect &vectU)
	Sets an orientation. More...

Detailed Description

The flimListener is an object whose position and orientation must be specified by the user to correctly configure 3D sound.

Function Documentation

GetPosition()

static const Vect & FlimListener::GetPosition ( )

inlinestatic

Gets the position.

Author

Jack Campbell

Date

6/1/2017

Returns

The position.

SetOrientation() [1/2]

static snd_err FlimListener::SetOrientation ( const Vect &  vectF, float  x = 0.0f, float  y = 1.0f, float  z = 0.0f  )

inlinestatic

Sets an orientation.

Author

Jack Campbell

Date

6/1/2017

Parameters

vectF	The vect f.
x	(Optional) The x coordinate.
y	(Optional) The y coordinate.
z	(Optional) The z coordinate.

Returns

A snd_err.

SetOrientation() [2/2]

static snd_err FlimListener::SetOrientation ( const Vect &  vectF, const Vect &  vectU  )

inlinestatic

Sets an orientation.

Author

Jack Campbell

Date

6/1/2017

Parameters

vectF	The vect f.
vectU	The vect u.

Returns

A snd_err.

SetPosition() [1/2]

static snd_err FlimListener::SetPosition ( float  x, float  y, float  z  )

inlinestatic

Sets a position.

Author

Jack Campbell

Date

6/1/2017

Parameters

x	The x coordinate.
y	The y coordinate.
z	The z coordinate.

Returns

A snd_err.

SetPosition() [2/2]

static snd_err FlimListener::SetPosition ( const Vect &  vect )

inlinestatic

Sets a position.

Author

Jack Campbell

Date

6/1/2017

Parameters

vect

The vect.

Returns

A snd_err.

UpdateOrientation()

static snd_err FlimListener::UpdateOrientation ( float  xF, float  yF, float  zF, float  xU, float  yU, float  zU  )

inlinestatic

Updates the orientation.

Author

Jack Campbell

Date

6/1/2017

Parameters

xF	The x coordinate f.
yF	The y coordinate f.
zF	The z coordinate f.
xU	The x coordinate u.
yU	The y coordinate u.
zU	The z coordinate u.

Returns

A snd_err.