|
|
|
|
Documentation |
|
Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages Search
NLSOUND::CListenerAL Class ReferenceOpenAL sound listener.
More...
#include <listener_al.h>
Inheritance diagram for NLSOUND::CListenerAL:
List of all members.
Public Methods |
| CListenerAL () |
| Constructor. More...
|
virtual | ~CListenerAL () |
| Destructor. More...
|
|
virtual void | setPos (const NLMISC::CVector &pos) |
| Set the position vector (default: (0,0,0)) (3D mode only). More...
|
virtual const NLMISC::CVector & | getPos () const |
| Get the position vector. More...
|
virtual void | setVelocity (const NLMISC::CVector &vel) |
| Set the velocity vector (3D mode only) (default: (0,0,0)). More...
|
virtual void | getVelocity (NLMISC::CVector &vel) const |
| Get the velocity vector. More...
|
virtual void | setOrientation (const NLMISC::CVector &front, const NLMISC::CVector &up) |
| Set the orientation vectors (3D mode only) (default: (0,1,0), (0,0,1)). More...
|
virtual void | getOrientation (NLMISC::CVector &front, NLMISC::CVector &up) const |
| Get the orientation vectors. More...
|
virtual void | setGain (float gain) |
| Set the gain (volume value inside [0 , 1]). More...
|
virtual float | getGain () const |
| Get the gain. More...
|
|
virtual void | setDopplerFactor (float f) |
| Set the doppler factor (default: 1) to exaggerate or not the doppler effect. More...
|
virtual void | setRolloffFactor (float f) |
| Set the rolloff factor (default: 1) to scale the distance attenuation effect. More...
|
virtual void | setEnvironment (uint env, float size=7.5f) |
| Set DSPROPERTY_EAXLISTENER_ENVIRONMENT and DSPROPERTY_EAXLISTENER_ENVIRONMENTSIZE if EAX available (see EAX listener properties). More...
|
virtual void | setEAXProperty (uint prop, void *value, uint valuesize) |
| Set any EAX listener property if EAX available. More...
|
Static Public Methods |
CListenerAL * | instance () |
| Return the instance of the singleton. More...
|
Private Attributes |
NLMISC::CVector | _Pos |
Static Private Attributes |
CListenerAL * | _Instance = NULL |
Detailed Description
OpenAL sound listener.
For arguments as 3D vectors, use the NeL vector coordinate system (not OpenAL/OpenGL's one).
-
Author:
-
Olivier Cado , Nevrax France
-
Date:
-
2001
Definition at line 46 of file listener_al.h.
Constructor & Destructor Documentation
NLSOUND::CListenerAL::CListenerAL |
( |
|
) |
|
|
virtual NLSOUND::CListenerAL::~CListenerAL |
( |
|
) |
[inline, virtual] |
|
Member Function Documentation
float NLSOUND::CListenerAL::getGain |
( |
|
) |
const [virtual] |
|
void NLSOUND::CListenerAL::getVelocity |
( |
NLMISC::CVector & |
vel |
) |
const [virtual] |
|
CListenerAL* NLSOUND::CListenerAL::instance |
( |
|
) |
[inline, static] |
|
void NLSOUND::CListenerAL::setDopplerFactor |
( |
float |
f |
) |
[virtual] |
|
void NLSOUND::CListenerAL::setEAXProperty |
( |
uint |
prop, |
|
|
void * |
value, |
|
|
uint |
valuesize |
|
) |
[virtual] |
|
void NLSOUND::CListenerAL::setEnvironment |
( |
uint |
env, |
|
|
float |
size = 7.5f |
|
) |
[virtual] |
|
|
Set DSPROPERTY_EAXLISTENER_ENVIRONMENT and DSPROPERTY_EAXLISTENER_ENVIRONMENTSIZE if EAX available (see EAX listener properties).
Implements NLSOUND::IListener.
Definition at line 212 of file listener_al.cpp. |
void NLSOUND::CListenerAL::setGain |
( |
float |
gain |
) |
[virtual] |
|
|
Set the gain (volume value inside [0 , 1]).
(default: 1) 0.0 -> silence 0.5 -> -6dB 1.0 -> no attenuation values > 1 (amplification) not supported by most drivers
Implements NLSOUND::IListener.
Definition at line 166 of file listener_al.cpp.
References TestALError. |
void NLSOUND::CListenerAL::setPos |
( |
const NLMISC::CVector & |
pos |
) |
[virtual] |
|
void NLSOUND::CListenerAL::setRolloffFactor |
( |
float |
f |
) |
[virtual] |
|
void NLSOUND::CListenerAL::setVelocity |
( |
const NLMISC::CVector & |
vel |
) |
[virtual] |
|
Member Data Documentation
CListenerAL * NLSOUND::CListenerAL::_Instance = NULL [static, private]
|
|
The documentation for this class was generated from the following files:
|
|