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

NLSOUND::UEnvSound Class Reference

#include <u_env_sound.h> +

Inheritance diagram for NLSOUND::UEnvSound: +

+ + + +

Detailed Description

+Game interface for localized environment sounds

Deprecated:

+An envsound object is a node of an envsound tree, the root of which is returned by UAudioMixer::loadEnvSounds(). The root is the world envsound: it has no bounds. The areas of children envsounds have bounds and they must be totally included in the area of their parent envsound.

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


+ *     (top)
+ *       z    
+ *       |  y (front)
+ *       | /
+ *       -----x (right)
+ *

+An envsound source plays with the priority HighPri, and has the priority LowPri when not playing.

Author:: Olivier Cado
+Nevrax France

Date:: 2001

+ +

+Definition at line 79 of file u_env_sound.h. + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions
virtual std::vector< UEnvSound * > & getChildren ()=0
Return the children envsounds.

virtual void getPos (NLMISC::CVector &pos) const=0
Return the position.

virtual void play (bool children_too=false)=0
Play this node, and all descendants if children_too is true.

virtual void selectEnv (const char *tag, bool children_too=false)=0
Select the current env for this node, and for all descendants if children_too is true.

virtual void setPos (const NLMISC::CVector &pos)=0
Moves the envsound (and its transition envsound if it has one).

virtual void stop (bool children_too=false)=0
Stop playing this node, and all descendants if children_too is true.

virtual ~UEnvSound ()
Destructor.

Protected Member Functions
UEnvSound ()
Constructor.

+

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + +
virtual NLSOUND::UEnvSound::~UEnvSound ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+Destructor. +
+ +
+Definition at line 100 of file u_env_sound.h. +
+
00100 {} +

+

+ + + + +
+ + + + + + + + + +
NLSOUND::UEnvSound::UEnvSound ( ) [inline, protected]
+
+ + + + + +
+ + + +
+Constructor. +
+ +
+Definition at line 105 of file u_env_sound.h. +
+
00105 {} +

+

Member Function Documentation

+ + + + +
+ + + + + + + + + +
virtual std::vector<UEnvSound*>& NLSOUND::UEnvSound::getChildren ( ) [pure virtual]
+
+ + + + + +
+ + + +
+Return the children envsounds. +
+ +
+Implemented in NLSOUND::CEnvSoundUser.
+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::UEnvSound::getPos ( NLMISC::CVector & pos ) const [pure virtual]
+
+ + + + + +
+ + + +
+Return the position. +
+
+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::UEnvSound::play ( bool children_too = false ) [pure virtual]
+
+ + + + + +
+ + + +
+Play this node, and all descendants if children_too is true. +
+ +
+Implemented in NLSOUND::CEnvSoundUser.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NLSOUND::UEnvSound::selectEnv ( const char * tag,
bool children_too = false
) [pure virtual]
+
+ + + + + +
+ + + +
+Select the current env for this node, and for all descendants if children_too is true. +
+ +
+Implemented in NLSOUND::CEnvSoundUser.
+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::UEnvSound::setPos ( const NLMISC::CVector & pos ) [pure virtual]
+
+ + + + + +
+ + + +
+Moves the envsound (and its transition envsound if it has one). +
+ +
+Implemented in NLSOUND::CEnvSoundUser.
+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::UEnvSound::stop ( bool children_too = false ) [pure virtual]
+
+ + + + + +
+ + + +
+Stop playing this node, and all descendants if children_too is true. +
+ +
+Implemented in NLSOUND::CEnvSoundUser.
+

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

u_env_sound.h

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

+1.3.6

+ + -- cgit v1.2.1


Public Member Functions
virtual std::vector< UEnvSound * > &	getChildren ()=0
	Return the children envsounds.
virtual void	getPos (NLMISC::CVector &pos) const=0
	Return the position.
virtual void	play (bool children_too=false)=0
	Play this node, and all descendants if children_too is true.
virtual void	selectEnv (const char *tag, bool children_too=false)=0
	Select the current env for this node, and for all descendants if children_too is true.
virtual void	setPos (const NLMISC::CVector &pos)=0
	Moves the envsound (and its transition envsound if it has one).
virtual void	stop (bool children_too=false)=0
	Stop playing this node, and all descendants if children_too is true.
virtual	~UEnvSound ()
	Destructor.
Protected Member Functions
	UEnvSound ()
	Constructor.