cAudio  2.3.0
3d Audio Engine
Public Member Functions | Protected Attributes | List of all members
cAudio::cListener Class Reference
Inheritance diagram for cAudio::cListener:
Inheritance graph
[legend]
Collaboration diagram for cAudio::cListener:
Collaboration graph
[legend]

Public Member Functions

virtual void setPosition (const cVector3 &pos)
 Sets the position of the listener. More...
 
virtual void setDirection (const cVector3 &dir)
 Sets the direction the listener is facing. More...
 
virtual void setUpVector (const cVector3 &up)
 Sets the up vector to use for the listener. More...
 
virtual void setVelocity (const cVector3 &vel)
 Sets the current velocity of the listener for doppler effects. More...
 
virtual void setMasterVolume (const float &volume)
 Sets the global volume modifier (will effect all sources) More...
 
virtual void move (const cVector3 &pos)
 Convenience function to automatically set the velocity and position for you in a single call. More...
 
virtual cVector3 getPosition (void) const
 Returns the current position of the listener.
 
virtual cVector3 getDirection (void) const
 Returns the current direction of the listener.
 
virtual cVector3 getUpVector (void) const
 Returns the current up vector of the listener.
 
virtual cVector3 getVelocity (void) const
 Returns the current velocity of the listener.
 
virtual float getMasterVolume (void) const
 Returns the global volume modifier for all sources.
 

Protected Attributes

cAudioMutex Mutex
 
cVector3 Position
 
cVector3 Direction
 
cVector3 UpVector
 
cVector3 Velocity
 
float MasterGain
 

Detailed Description

Definition at line 12 of file cListener.h.

Member Function Documentation

◆ move()

void cAudio::cListener::move ( const cVector3 pos)
virtual

Convenience function to automatically set the velocity and position for you in a single call.

Velocity will be set to new position - last position

Parameters
posNew position to move the listener to.

Implements cAudio::IListener.

Definition at line 48 of file cListener.cpp.

◆ setDirection()

void cAudio::cListener::setDirection ( const cVector3 dir)
virtual

Sets the direction the listener is facing.

Parameters
dirNew direction vector for the listener.

Implements cAudio::IListener.

Definition at line 18 of file cListener.cpp.

◆ setMasterVolume()

void cAudio::cListener::setMasterVolume ( const float &  volume)
virtual

Sets the global volume modifier (will effect all sources)

Parameters
volumeVolume to scale all sources by. Range: 0.0 to +inf.

Implements cAudio::IListener.

Definition at line 41 of file cListener.cpp.

◆ setPosition()

void cAudio::cListener::setPosition ( const cVector3 pos)
virtual

Sets the position of the listener.

Note that you will still have to set velocity after this call for proper doppler effects. Use move() if you'd like to have cAudio automatically handle velocity for you.

Parameters
posNew position for the listener.

Implements cAudio::IListener.

Definition at line 11 of file cListener.cpp.

◆ setUpVector()

void cAudio::cListener::setUpVector ( const cVector3 up)
virtual

Sets the up vector to use for the listener.

Default up vector is Y+, same as OpenGL.

Parameters
upNew up vector for the listener.

Implements cAudio::IListener.

Definition at line 26 of file cListener.cpp.

◆ setVelocity()

void cAudio::cListener::setVelocity ( const cVector3 vel)
virtual

Sets the current velocity of the listener for doppler effects.

Parameters
velNew velocity for the listener.

Implements cAudio::IListener.

Definition at line 34 of file cListener.cpp.


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