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_1UEnvSound.html | 399 ++++++++++++++++++++++++ 1 file changed, 399 insertions(+) create mode 100644 docs/doxygen/nel/classNLSOUND_1_1UEnvSound.html (limited to 'docs/doxygen/nel/classNLSOUND_1_1UEnvSound.html') diff --git a/docs/doxygen/nel/classNLSOUND_1_1UEnvSound.html b/docs/doxygen/nel/classNLSOUND_1_1UEnvSound.html new file mode 100644 index 00000000..45c40a35 --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1UEnvSound.html @@ -0,0 +1,399 @@ + + + + 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::UEnvSound Class Reference

Game interface for localized environment sounds. +More... +

+#include <u_env_sound.h> +

+

Inheritance diagram for NLSOUND::UEnvSound: +

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

Public Methods

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

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

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

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

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

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

virtual ~UEnvSound ()
 Destructor. More...


Protected Methods

 UEnvSound ()
 Constructor. More...

+

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.

Constructor & Destructor Documentation

+

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

+Destructor. +

+ +

+Definition at line 100 of file u_env_sound.h.

+

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

+Constructor. +

+ +

+Definition at line 105 of file u_env_sound.h.

+

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: + + + +
                                                                                                                                                                    +
+ + -- cgit v1.2.1