|
|
|
|
Documentation |
|
Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages Search
NLSOUND::CListenerUser Class ReferenceImplementation of UListener.
More...
#include <listener_user.h>
Inheritance diagram for NLSOUND::CListenerUser:
List of all members.
Public Methods |
| CListenerUser () |
| Constructor. More...
|
void | init (ISoundDriver *sd) |
| Init. More...
|
virtual | ~CListenerUser () |
| Destructor. More...
|
IListener * | getListener () |
| Direct access granted to the audio mixer. 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, ignored in stereo mode) (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, ignored in stereo mode) (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...
|
Private Attributes |
IListener * | _DrvListener |
| Listener property. More...
|
Detailed Description
Implementation of UListener.
This implementation does not check if the properties have changed or not. Therefore it is suggested to test them and not to call the set methods if there is no change.
-
Author:
-
Olivier Cado , Nevrax France
-
Date:
-
2001
Definition at line 49 of file listener_user.h.
Constructor & Destructor Documentation
NLSOUND::CListenerUser::CListenerUser |
( |
|
) |
[inline] |
|
virtual NLSOUND::CListenerUser::~CListenerUser |
( |
|
) |
[inline, virtual] |
|
Member Function Documentation
virtual float NLSOUND::CListenerUser::getGain |
( |
void |
|
) |
const [inline, virtual] |
|
IListener* NLSOUND::CListenerUser::getListener |
( |
|
) |
[inline] |
|
virtual const NLMISC::CVector& NLSOUND::CListenerUser::getPos |
( |
void |
|
) |
const [inline, virtual] |
|
virtual void NLSOUND::CListenerUser::getVelocity |
( |
NLMISC::CVector & |
vel |
) |
const [inline, virtual] |
|
void NLSOUND::CListenerUser::init |
( |
ISoundDriver * |
sd |
) |
[inline] |
|
virtual void NLSOUND::CListenerUser::setGain |
( |
float |
gain |
) |
[inline, 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::UListener.
Definition at line 85 of file listener_user.h.
References _DrvListener. |
void NLSOUND::CListenerUser::setPos |
( |
const NLMISC::CVector & |
pos |
) |
[virtual] |
|
virtual void NLSOUND::CListenerUser::setVelocity |
( |
const NLMISC::CVector & |
vel |
) |
[inline, virtual] |
|
Member Data Documentation
IListener* NLSOUND::CListenerUser::_DrvListener [private]
|
|
|
Listener property.
Definition at line 97 of file listener_user.h.
Referenced by CListenerUser, getGain, getListener, getOrientation, getPos, getVelocity, init, setGain, setOrientation, setPos, setVelocity, and ~CListenerUser. |
The documentation for this class was generated from the following files:
|
|