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

A background sound static properties. +More... +

+#include <background_sound.h> +

+

Inheritance diagram for NLSOUND::CBackgroundSound: +

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

Public Methods

 CBackgroundSound ()
 Constructor. More...

 ~CBackgroundSound ()
 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...

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
 Return the name (must be unique) Used by the george sound plugin to check sound recursion (ie sound 'toto' use sound 'titi' witch also use sound 'toto' ...). More...

virtual float getMaxDistance () const
 Return the max distance (if detailed()). More...

void serial (NLMISC::IStream &s)
const std::vector< TSoundInfo > & getSounds () const

Private Attributes

std::vector< TSoundInfo > _Sounds
 The list of sound composing the background sound with there repective filter. More...

uint32 _Duration
bool _DurationValid
+

Detailed Description

+A background sound static properties. +

+

+Author:
+Boris Boucher , Nevrax France
+Date:
+2002
+

+ +

+Definition at line 44 of file background_sound.h.

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
NLSOUND::CBackgroundSound::CBackgroundSound (   ) 
+
+ + + + + +
+   + + +

+Constructor. +

+ +

+Definition at line 42 of file background_sound.cpp.

+

+ + + + +
+ + + + + + + + + +
NLSOUND::CBackgroundSound::~CBackgroundSound (   ) 
+
+ + + + + +
+   + + +

+Destructor. +

+ +

+Definition at line 47 of file background_sound.cpp.

+

Member Function Documentation

+

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

+Return the length of the sound in ms. +

+ +

+Implements NLSOUND::CSound. +

+Definition at line 122 of file background_sound.cpp. +

+References _Duration, _DurationValid, _Sounds, and NLSOUND::CSound::CSound.

+

+ + + + +
+ + + + + + + + + +
float NLSOUND::CBackgroundSound::getMaxDistance (   )  const [virtual]
+
+ + + + + +
+   + + +

+Return the max distance (if detailed()). +

+ +

+Reimplemented from NLSOUND::CSound. +

+Definition at line 155 of file background_sound.cpp. +

+References _Sounds, and NLSOUND::CSound::CSound.

+

+ + + + +
+ + + + + + + + + +
const std::vector<TSoundInfo>& NLSOUND::CBackgroundSound::getSounds (   )  const [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 114 of file background_sound.h. +

+References _Sounds.

+

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

+Get the type of the sound. +

+ +

+Implements NLSOUND::CSound. +

+Definition at line 52 of file background_sound.h. +

+References NLSOUND::CSound::SOUND_BACKGROUND, and NLSOUND::CSound::TSOUND_TYPE.

+

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

+Return the name (must be unique) 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 144 of file background_sound.cpp. +

+References _Sounds, and NLSOUND::CSound::CSound.

+

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

+Load the sound parameters from georges' form. +

+ +

+Reimplemented from NLSOUND::CSound. +

+Definition at line 61 of file background_sound.cpp. +

+References _DurationValid, _Sounds, NLGEORGES::UFormElm::getArrayNode, NLGEORGES::UFormElm::getArraySize, NLGEORGES::UFormElm::getDfnName, NLGEORGES::UFormElm::getNodeByName, NLGEORGES::UFormElm::getValueByName, NLGEORGES::UFormElm::isArray, and nlassert.

+

+ + + + +
+ + + + + + + + + +
bool NLSOUND::CBackgroundSound::isDetailed (   )  const [inline, virtual]
+
+ + + + + +
+   + + +

+Return true if cone is meaningful. +

+ +

+Implements NLSOUND::CSound. +

+Definition at line 58 of file background_sound.h.

+

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

+ +

+Reimplemented from NLSOUND::CSound. +

+Definition at line 51 of file background_sound.cpp. +

+References _DurationValid, _Sounds, NLMISC::IStream::isReading, s, and NLMISC::IStream::serialCont.

+

Member Data Documentation

+

+ + + + +
+ + +
uint32 NLSOUND::CBackgroundSound::_Duration [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 124 of file background_sound.h. +

+Referenced by getDuration.

+

+ + + + +
+ + +
bool NLSOUND::CBackgroundSound::_DurationValid [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 126 of file background_sound.h. +

+Referenced by getDuration, importForm, and serial.

+

+ + + + +
+ + +
std::vector<TSoundInfo> NLSOUND::CBackgroundSound::_Sounds [private] +
+
+ + + + + +
+   + + +

+The list of sound composing the background sound with there repective filter. +

+ +

+Definition at line 120 of file background_sound.h. +

+Referenced by getDuration, getMaxDistance, getSounds, getSubSoundList, importForm, and serial.

+

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