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/a03933.html | 420 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 420 insertions(+) create mode 100644 docs/doxygen/nel/a03933.html (limited to 'docs/doxygen/nel/a03933.html') diff --git a/docs/doxygen/nel/a03933.html b/docs/doxygen/nel/a03933.html new file mode 100644 index 00000000..c28b91b0 --- /dev/null +++ b/docs/doxygen/nel/a03933.html @@ -0,0 +1,420 @@ + + +NeL: NLSOUND::UListener class Reference + + + +

NLSOUND::UListener Class Reference

#include <u_listener.h> +

Inheritance diagram for NLSOUND::UListener: +

+ + + +

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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions
virtual ~UListener ()
Destructor.

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

virtual void getOrientation (NLMISC::CVector &front, NLMISC::CVector &up) const=0
Get the orientation vectors.

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

virtual void setGain (float gain)=0
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)).

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

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

Protected Member Functions
UListener ()
Constructor.

+

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + +
virtual NLSOUND::UListener::~UListener ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+Destructor. +
+ +
+Definition at line 87 of file u_listener.h. +
+
00087 {} +

+

+ + + + +
+ + + + + + + + + +
NLSOUND::UListener::UListener ( ) [inline, protected]
+
+ + + + + +
+ + + +
+Constructor. +
+ +
+Definition at line 92 of file u_listener.h. +
+
00092 {} +

+

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:

u_listener.h

Generated on Tue Mar 16 14:53:36 2004 for NeL by + +

+1.3.6

+ + -- cgit v1.2.1


Public Member Functions
virtual	~UListener ()
	Destructor.
Listener properties
virtual float	getGain () const=0
	Get the gain.
virtual void	getOrientation (NLMISC::CVector &front, NLMISC::CVector &up) const=0
	Get the orientation vectors.
virtual const NLMISC::CVector &	getPos () const=0
virtual void	getVelocity (NLMISC::CVector &vel) const=0
	Get the velocity vector.
virtual void	setGain (float gain)=0
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)).
virtual void	setPos (const NLMISC::CVector &pos)=0
	Set the position vector (default: (0,0,0)) (3D mode only).
virtual void	setVelocity (const NLMISC::CVector &vel)=0
	Set the velocity vector (3D mode only, ignored in stereo mode) (default: (0,0,0)).
Protected Member Functions
	UListener ()
	Constructor.