From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- .../doxygen/nel/classNLSOUND_1_1CContextSound.html | 582 +++++++++++++++++++++ 1 file changed, 582 insertions(+) create mode 100644 docs/doxygen/nel/classNLSOUND_1_1CContextSound.html (limited to 'docs/doxygen/nel/classNLSOUND_1_1CContextSound.html') diff --git a/docs/doxygen/nel/classNLSOUND_1_1CContextSound.html b/docs/doxygen/nel/classNLSOUND_1_1CContextSound.html new file mode 100644 index 00000000..bdb65b9e --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1CContextSound.html @@ -0,0 +1,582 @@ + + + + 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::CContextSound Class Reference

#include <context_sound.h> +

+

Inheritance diagram for NLSOUND::CContextSound: +

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

Public Methods

 CContextSound ()
 Constructor. More...

 ~CContextSound ()
 Destructor. More...

TSOUND_TYPE getSoundType ()
 Get the type of the sound. More...

virtual void importForm (const std::string &filename, NLGEORGES::UFormElm &formRoot)
 Load the sound parameters from georges' form. More...

virtual bool isDetailed () const
 Return true if cone is meaningful. More...

virtual uint32 getDuration ()
 Return the length of the sound in ms. More...

virtual void getSubSoundList (std::vector< std::pair< std::string, CSound * > > &subsounds) const
 Used by the george sound plugin to check sound recursion (ie sound 'toto' use sound 'titi' witch also use sound 'toto' ...). More...

CSound * getContextSound (CSoundContext &context)
void init ()
void serial (NLMISC::IStream &s)

Private Attributes

std::string _PatternName
 The context sound pattern name. More...

std::string _BaseName
 The base name, that is the constante part of the name (before the first joker). More...

uint32 _Random
 The random lenght (0 mean no random). More...

IContextSoundContainer * _ContextSounds
 container for all the candidate sounds. More...

+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
NLSOUND::CContextSound::CContextSound (   ) 
+
+ + + + + +
+   + + +

+Constructor. +

+ +

+Definition at line 42 of file context_sound.cpp.

+

+ + + + +
+ + + + + + + + + +
NLSOUND::CContextSound::~CContextSound (   ) 
+
+ + + + + +
+   + + +

+Destructor. +

+ +

+Definition at line 47 of file context_sound.cpp. +

+References _ContextSounds.

+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + +
CSound * NLSOUND::CContextSound::getContextSound ( CSoundContext &   context ) 
+
+ + + + + +
+   + + +

+ +

+Definition at line 109 of file context_sound.cpp. +

+References _ContextSounds, _Random, init, and r.

+

+ + + + +
+ + + + + + + + + +
uint32 NLSOUND::CContextSound::getDuration (   )  [virtual]
+
+ + + + + +
+   + + +

+Return the length of the sound in ms. +

+ +

+Implements NLSOUND::CSound. +

+Definition at line 91 of file context_sound.cpp.

+

+ + + + +
+ + + + + + + + + +
TSOUND_TYPE NLSOUND::CContextSound::getSoundType (   )  [inline, virtual]
+
+ + + + + +
+   + + +

+Get the type of the sound. +

+ +

+Implements NLSOUND::CSound. +

+Definition at line 262 of file context_sound.h. +

+References NLSOUND::CSound::TSOUND_TYPE.

+

+ + + + +
+ + + + + + + + + + +
void NLSOUND::CContextSound::getSubSoundList ( std::vector< std::pair< std::string, CSound * > > &   subsounds )  const [virtual]
+
+ + + + + +
+   + + +

+Used by the george sound plugin to check sound recursion (ie sound 'toto' use sound 'titi' witch also use sound 'toto' ...). +

+ +

+Implements NLSOUND::CSound. +

+Definition at line 96 of file context_sound.cpp. +

+References _ContextSounds.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NLSOUND::CContextSound::importForm ( const std::string &   filename,
NLGEORGES::UFormElm &   formRoot
)  [virtual]
+
+ + + + + +
+   + + +

+Load the sound parameters from georges' form. +

+ +

+Reimplemented from NLSOUND::CSound. +

+Definition at line 67 of file context_sound.cpp. +

+References _PatternName, NLGEORGES::UFormElm::getDfnName, NLGEORGES::UFormElm::getNodeByName, NLGEORGES::UFormElm::getValueByName, and nlassert.

+

+ + + + +
+ + + + + + + + + +
void NLSOUND::CContextSound::init (   ) 
+
+ + + + + +
+   + + +

+ +

+Definition at line 139 of file context_sound.cpp. +

+References _BaseName, _ContextSounds, _PatternName, _Random, index, nlassert, nldebug, and nlwarning. +

+Referenced by getContextSound.

+

+ + + + +
+ + + + + + + + + +
bool NLSOUND::CContextSound::isDetailed (   )  const [virtual]
+
+ + + + + +
+   + + +

+Return true if cone is meaningful. +

+ +

+Implements NLSOUND::CSound. +

+Definition at line 86 of file context_sound.cpp.

+

+ + + + +
+ + + + + + + + + + +
void NLSOUND::CContextSound::serial ( NLMISC::IStream &   s )  [virtual]
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLSOUND::CSound. +

+Definition at line 53 of file context_sound.cpp. +

+References _ContextSounds, _PatternName, NLMISC::IStream::isReading, s, and NLMISC::IStream::serial.

+

Member Data Documentation

+

+ + + + +
+ + +
std::string NLSOUND::CContextSound::_BaseName [private] +
+
+ + + + + +
+   + + +

+The base name, that is the constante part of the name (before the first joker). +

+ +

+Definition at line 287 of file context_sound.h. +

+Referenced by init.

+

+ + + + +
+ + +
IContextSoundContainer* NLSOUND::CContextSound::_ContextSounds [private] +
+
+ + + + + +
+   + + +

+container for all the candidate sounds. +

+ +

+Definition at line 295 of file context_sound.h. +

+Referenced by getContextSound, getSubSoundList, init, serial, and ~CContextSound.

+

+ + + + +
+ + +
std::string NLSOUND::CContextSound::_PatternName [private] +
+
+ + + + + +
+   + + +

+The context sound pattern name. +

+ +

+Definition at line 285 of file context_sound.h. +

+Referenced by importForm, init, and serial.

+

+ + + + +
+ + +
uint32 NLSOUND::CContextSound::_Random [private] +
+
+ + + + + +
+   + + +

+The random lenght (0 mean no random). +

+ +

+Definition at line 290 of file context_sound.h. +

+Referenced by getContextSound, and init.

+

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