From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/classNLSOUND_1_1UListener.html | 474 ++++++++++++++++++++++++ 1 file changed, 474 insertions(+) create mode 100644 docs/doxygen/nel/classNLSOUND_1_1UListener.html (limited to 'docs/doxygen/nel/classNLSOUND_1_1UListener.html') diff --git a/docs/doxygen/nel/classNLSOUND_1_1UListener.html b/docs/doxygen/nel/classNLSOUND_1_1UListener.html new file mode 100644 index 00000000..6d54ecf7 --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1UListener.html @@ -0,0 +1,474 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +
# Home   # nevrax.com   
+ + + + +
Nevrax
+ + + + + + + + + + +
+ + +
+ Nevrax.org
+ + + + + + + +
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
+
+ + + 		+ + +
+Docs + +
+  + + + + + +
Documentation 
+ +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  
+

NLSOUND::UListener Class Reference

Game interface for listener control. +More... +

+#include <u_listener.h> +

+

Inheritance diagram for NLSOUND::UListener: +

+ +NLSOUND::CListenerUser + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods

virtual ~UListener ()
 Destructor. More...

Listener properties
virtual void setPos (const NLMISC::CVector &pos)=0
 Set the position vector (default: (0,0,0)) (3D mode only). More...

virtual const NLMISC::CVector & getPos () const=0
 Get the position vector. More...

virtual void setVelocity (const NLMISC::CVector &vel)=0
 Set the velocity vector (3D mode only, ignored in stereo mode) (default: (0,0,0)). More...

virtual void getVelocity (NLMISC::CVector &vel) const=0
 Get the velocity vector. More...

virtual void setOrientation (const NLMISC::CVector &front, const NLMISC::CVector &up)=0
 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=0
 Get the orientation vectors. More...

virtual void setGain (float gain)=0
 Set the gain (volume value inside [0 , 1]). More...

virtual float getGain () const=0
 Get the gain. More...


Protected Methods

 UListener ()
 Constructor. More...

+

Detailed Description

+Game interface for listener control. +

+For arguments as 3D vectors, use the NeL vector coordinate system: 

+ *     (top)
+ *       z    
+ *       |  y (front)
+ *       | /
+ *       -----x (right)
+ *
+Author:
+Olivier Cado , Nevrax France
+Date:
+2001
+

+ +

+Definition at line 55 of file u_listener.h.

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
virtual NLSOUND::UListener::~UListener (   )  [inline, virtual]
+
+ + + + + +
+   + + +

+Destructor. +

+ +

+Definition at line 87 of file u_listener.h.

+

+ + + + +
+ + + + + + + + + +
NLSOUND::UListener::UListener (   )  [inline, protected]
+
+ + + + + +
+   + + +

+Constructor. +

+ +

+Definition at line 92 of file u_listener.h.

+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + +
virtual float NLSOUND::UListener::getGain (   )  const [pure virtual]
+
+ + + + + +
+   + + +

+Get the gain. +

+ +

+Implemented in NLSOUND::CListenerUser.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NLSOUND::UListener::getOrientation ( NLMISC::CVector &   front,
NLMISC::CVector &   up
)  const [pure virtual]
+
+ + + + + +
+   + + +

+Get the orientation vectors. +

+ +

+Implemented in NLSOUND::CListenerUser.

+

+ + + + +
+ + + + + + + + + +
virtual const NLMISC::CVector& NLSOUND::UListener::getPos (   )  const [pure virtual]
+
+ + + + + +
+   + + +

+Get the position vector. +

+See setPos() for details. +

+Implemented in NLSOUND::CListenerUser.

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::UListener::getVelocity ( NLMISC::CVector &   vel )  const [pure virtual]
+
+ + + + + +
+   + + +

+Get the velocity vector. +

+ +

+Implemented in NLSOUND::CListenerUser.

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::UListener::setGain ( float   gain )  [pure 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 +

+Implemented in NLSOUND::CListenerUser.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NLSOUND::UListener::setOrientation ( const NLMISC::CVector &   front,
const NLMISC::CVector &   up
)  [pure virtual]
+
+ + + + + +
+   + + +

+Set the orientation vectors (3D mode only, ignored in stereo mode) (default: (0,1,0), (0,0,1)). +

+ +

+Implemented in NLSOUND::CListenerUser.

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::UListener::setPos ( const NLMISC::CVector &   pos )  [pure virtual]
+
+ + + + + +
+   + + +

+Set the position vector (default: (0,0,0)) (3D mode only). +

+ +

+Implemented in NLSOUND::CListenerUser.

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::UListener::setVelocity ( const NLMISC::CVector &   vel )  [pure virtual]
+
+ + + + + +
+   + + +

+Set the velocity vector (3D mode only, ignored in stereo mode) (default: (0,0,0)). +

+ +

+Implemented in NLSOUND::CListenerUser.

+

The documentation for this class was generated from the following file: + + + +
                                                                                                                                                                    +
+ + -- cgit v1.2.1