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/a03422.html | 1350 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1350 insertions(+) create mode 100644 docs/doxygen/nel/a03422.html (limited to 'docs/doxygen/nel/a03422.html') diff --git a/docs/doxygen/nel/a03422.html b/docs/doxygen/nel/a03422.html new file mode 100644 index 00000000..68b95e82 --- /dev/null +++ b/docs/doxygen/nel/a03422.html @@ -0,0 +1,1350 @@ + + +NeL: NLSOUND::CSoundPattern class Reference + + + +
+Main Page | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages | Search for 
+

NLSOUND::CSoundPattern Class Reference

#include <sound_pattern.h> +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 CSoundPattern ()
virtual ~CSoundPattern ()
Sounds list management
virtual void addSound (std::string &name)
virtual void getSounds (std::vector< std::string > &sounds)
virtual void removeSound (const NLMISC::TStringId &name)
Iterating through the sound pattern
virtual IntervalIterator beginIntervalPattern ()
virtual uint16 getInterval (IntervalIterator *iterator)
Iterating through the sound pattern
virtual PatternIterator beginSoundPattern ()
virtual std::string & getSound (PatternIterator *iterator)
Interval pattern editing and generation
virtual void generateRandomIntervals (uint length, uint16 min, uint16 max)
virtual void generateRandomMin1Intervals (uint length, uint16 min, uint16 max)
virtual void getIntervals (std::string &list)
virtual void setIntervals (std::string &list)
Sound pattern editing and generation
virtual void generateRandomMin1Pattern (uint length)
virtual void generateRandomPattern (uint length)
virtual void getSoundPattern (std::string &list)
virtual void setSoundPattern (std::string &list)
Continuous controllers
virtual ISoundController * getFreqModulation ()
virtual ISoundController * getVolumeEnvelope ()
virtual void setFreqModulation (ISoundController *mod)
virtual void setVolumeEnvelope (ISoundController *env)
Spawning
virtual bool getSpawn ()
virtual void setSpawn (bool v)
Tempo
virtual float getTicksPerSecond ()
virtual void setTicksPerSecond (float ticks)

Private Member Functions

virtual void concatenatePattern (std::string &list, uint16_string &pattern)
virtual void expandString (std::string &s, std::string &buffer)
virtual void generateRandomMin1Pattern (uint16_string &pattern, uint length, uint16 min, uint16 max)
virtual void generateRandomPattern (uint16_string &pattern, uint length, uint16 min, uint16 max)
virtual void parsePattern (std::string &list, uint16_string &pattern)

Private Attributes

ISoundController * _FreqModulation
uint16_string _Intervals
uint16_string _SoundPattern
std::vector< std::string > _Sounds
bool _Spawn
std::string _StringBuffer
float _TicksPerSeconds
ISoundController * _VolumeEnvelope
+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
NLSOUND::CSoundPattern::CSoundPattern (   ) 
+
+ + + + + +
+   + + +

+Constructor

+

+ + + + +
+ + + + + + + + + +
virtual NLSOUND::CSoundPattern::~CSoundPattern (   )  [virtual]
+
+ + + + + +
+   + + +

+Destructor

+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::addSound ( std::string &  name  )  [inline, virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 108 of file sound_pattern.h. +

+

00108 { _Sounds.push_back(name); }
+
+

+ + + + +
+ + + + + + + + + +
virtual IntervalIterator NLSOUND::CSoundPattern::beginIntervalPattern (   )  [inline, virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 157 of file sound_pattern.h. +

+References _Intervals. +

+

00157 { return IntervalIterator(this, _Intervals.size()); }
+
+

+ + + + +
+ + + + + + + + + +
virtual PatternIterator NLSOUND::CSoundPattern::beginSoundPattern (   )  [inline, virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 138 of file sound_pattern.h. +

+References _SoundPattern. +

+

00138 { return PatternIterator(this, _SoundPattern.size()); }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::concatenatePattern ( std::string &  list,
uint16_string &  pattern
)  [private, virtual]
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::expandString ( std::string &  s,
std::string &  buffer
)  [private, virtual]
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::generateRandomIntervals ( uint  length,
uint16  min,
uint16  max
)  [virtual]
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::generateRandomMin1Intervals ( uint  length,
uint16  min,
uint16  max
)  [virtual]
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::generateRandomMin1Pattern ( uint16_string &  pattern,
uint  length,
uint16  min,
uint16  max
)  [private, virtual]
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::generateRandomMin1Pattern ( uint  length  )  [virtual]
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::generateRandomPattern ( uint16_string &  pattern,
uint  length,
uint16  min,
uint16  max
)  [private, virtual]
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::generateRandomPattern ( uint  length  )  [virtual]
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + +
virtual ISoundController* NLSOUND::CSoundPattern::getFreqModulation (   )  [inline, virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 217 of file sound_pattern.h. +

+References _FreqModulation. +

+

00217 { return _FreqModulation; }
+
+

+ + + + +
+ + + + + + + + + + +
virtual uint16 NLSOUND::CSoundPattern::getInterval ( IntervalIterator *  iterator  )  [virtual]
+
+ + + + + +
+   + + +

+ +

+Referenced by NLSOUND::CSoundPattern::IntervalIterator::operator *().

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::getIntervals ( std::string &  list  )  [virtual]
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + + +
virtual std::string& NLSOUND::CSoundPattern::getSound ( PatternIterator *  iterator  )  [virtual]
+
+ + + + + +
+   + + +

+ +

+Referenced by NLSOUND::CSoundPattern::PatternIterator::operator *().

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::getSoundPattern ( std::string &  list  )  [virtual]
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::getSounds ( std::vector< std::string > &  sounds  )  [virtual]
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + + +
virtual bool NLSOUND::CSoundPattern::getSpawn ( void   )  [inline, virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 209 of file sound_pattern.h. +

+References _Spawn. +

+

00209 { return _Spawn; }
+
+

+ + + + +
+ + + + + + + + + +
virtual float NLSOUND::CSoundPattern::getTicksPerSecond (   )  [inline, virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 202 of file sound_pattern.h. +

+

00202 { return _TicksPerSeconds; }
+
+

+ + + + +
+ + + + + + + + + +
virtual ISoundController* NLSOUND::CSoundPattern::getVolumeEnvelope (   )  [inline, virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 215 of file sound_pattern.h. +

+References _VolumeEnvelope. +

+

00215 { return _VolumeEnvelope; }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::parsePattern ( std::string &  list,
uint16_string &  pattern
)  [private, virtual]
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::removeSound ( const NLMISC::TStringId &  name  )  [virtual]
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::setFreqModulation ( ISoundController *  mod  )  [inline, virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 216 of file sound_pattern.h. +

+References _FreqModulation. +

+

00216 { _FreqModulation = mod; }
+
+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::setIntervals ( std::string &  list  )  [virtual]
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::setSoundPattern ( std::string &  list  )  [virtual]
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::setSpawn ( bool  v  )  [inline, virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 208 of file sound_pattern.h. +

+References _Spawn, and v. +

+

00208 { _Spawn = v; }
+
+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::setTicksPerSecond ( float  ticks  )  [inline, virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 203 of file sound_pattern.h. +

+

00203 { _TicksPerSeconds = ticks; }
+
+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::CSoundPattern::setVolumeEnvelope ( ISoundController *  env  )  [inline, virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 214 of file sound_pattern.h. +

+References _VolumeEnvelope. +

+

00214 { _VolumeEnvelope = env; }
+
+

Field Documentation

+

+ + + + +
+ + +
ISoundController* NLSOUND::CSoundPattern::_FreqModulation [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 236 of file sound_pattern.h. +

+Referenced by getFreqModulation(), and setFreqModulation().

+

+ + + + +
+ + +
uint16_string NLSOUND::CSoundPattern::_Intervals [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 233 of file sound_pattern.h. +

+Referenced by beginIntervalPattern().

+

+ + + + +
+ + +
uint16_string NLSOUND::CSoundPattern::_SoundPattern [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 232 of file sound_pattern.h. +

+Referenced by beginSoundPattern().

+

+ + + + +
+ + +
std::vector<std::string> NLSOUND::CSoundPattern::_Sounds [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 230 of file sound_pattern.h.

+

+ + + + +
+ + +
bool NLSOUND::CSoundPattern::_Spawn [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 234 of file sound_pattern.h. +

+Referenced by getSpawn(), and setSpawn().

+

+ + + + +
+ + +
std::string NLSOUND::CSoundPattern::_StringBuffer [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 237 of file sound_pattern.h.

+

+ + + + +
+ + +
float NLSOUND::CSoundPattern::_TicksPerSeconds [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 231 of file sound_pattern.h.

+

+ + + + +
+ + +
ISoundController* NLSOUND::CSoundPattern::_VolumeEnvelope [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 235 of file sound_pattern.h. +

+Referenced by getVolumeEnvelope(), and setVolumeEnvelope().

+

The documentation for this class was generated from the following file: +
Generated on Tue Mar 16 14:45:12 2004 for NeL by + +doxygen +1.3.6
+ + -- cgit v1.2.1