diff options
Diffstat (limited to 'docs/doxygen/nel/a03415.html')
| -rw-r--r-- | docs/doxygen/nel/a03415.html | 436 |
1 files changed, 436 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03415.html b/docs/doxygen/nel/a03415.html new file mode 100644 index 00000000..dceb050a --- /dev/null +++ b/docs/doxygen/nel/a03415.html @@ -0,0 +1,436 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>NeL: NLSOUND::CSoundAnimMarker class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3.6 --> +<div class="qindex"> <form class="search" action="search.php" method="get"> +<a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NLSOUND::CSoundAnimMarker Class Reference</h1><code>#include <<a class="el" href="a06411.html">sound_anim_marker.h</a>></code> +<p> +<table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03415.html#NLSOUND_1_1CSoundAnimMarkera0">addSound</a> (const <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> &soundName)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a03415.html#NLSOUND_1_1CSoundAnimMarkera1">CSoundAnimMarker</a> (float time=0.0f)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03415.html#NLSOUND_1_1CSoundAnimMarkera2">getSounds</a> (std::vector< <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> > &sounds)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual float </td><td class="memItemRight" valign=bottom><a class="el" href="a03415.html#NLSOUND_1_1CSoundAnimMarkera3">getTime</a> () const </td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03415.html#NLSOUND_1_1CSoundAnimMarkera4">play</a> (<a class="el" href="a02236.html">UAudioMixer</a> *mixer, <a class="el" href="a02362.html">NL3D::CCluster</a> *cluster, <a class="el" href="a03417.html">CSoundContext</a> &context)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03415.html#NLSOUND_1_1CSoundAnimMarkera5">removeSound</a> (const <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> &soundName)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03415.html#NLSOUND_1_1CSoundAnimMarkera6">setTime</a> (float time)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="a03415.html#NLSOUND_1_1CSoundAnimMarkera7">~CSoundAnimMarker</a> ()</td></tr> + +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a05381.html#a59">TMarkerSoundSet</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03415.html#NLSOUND_1_1CSoundAnimMarkerp0">_Sounds</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a03415.html#NLSOUND_1_1CSoundAnimMarkerp1">_Time</a></td></tr> + +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NLSOUND_1_1CSoundAnimMarkera1" doxytag="NLSOUND::CSoundAnimMarker::CSoundAnimMarker" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NLSOUND::CSoundAnimMarker::CSoundAnimMarker </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname1" valign="top" nowrap> <em>time</em> = 0.0f </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06411.html#l00052">52</a> of file <a class="el" href="a06411.html">sound_anim_marker.h</a>. +<p> +<div class="fragment"><pre>00052 : <a class="code" href="a03415.html#NLSOUND_1_1CSoundAnimMarkerp1">_Time</a>(time) {} +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundAnimMarkera7" doxytag="NLSOUND::CSoundAnimMarker::~CSoundAnimMarker" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NLSOUND::CSoundAnimMarker::~<a class="el" href="a03415.html">CSoundAnimMarker</a> </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06410.html#l00041">41</a> of file <a class="el" href="a06410.html">sound_anim_marker.cpp</a>. +<p> +<div class="fragment"><pre>00042 { +00043 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLSOUND_1_1CSoundAnimMarkera0" doxytag="NLSOUND::CSoundAnimMarker::addSound" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSoundAnimMarker::addSound </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>soundName</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Add a new sound in the set of to-be-played sounds for this marker +<p> +Definition at line <a class="el" href="a06410.html#l00065">65</a> of file <a class="el" href="a06410.html">sound_anim_marker.cpp</a>. +<p> +References <a class="el" href="a05622.html#l00135">nlwarning</a>. +<p> +Referenced by <a class="el" href="a06412.html#l00159">NLSOUND::CSoundAnimation::load()</a>. +<p> +<div class="fragment"><pre>00066 { +00067 pair<TMarkerSoundSet::iterator, bool> inserted; +00068 inserted = <a class="code" href="a03415.html#NLSOUND_1_1CSoundAnimMarkerp0">_Sounds</a>.insert(soundName); +00069 <span class="keywordflow">if</span> (inserted.second == <span class="keyword">false</span>) +00070 { +00071 <a class="code" href="a04199.html#a2">nlwarning</a>(<span class="stringliteral">"Duplicate sound (%s)"</span>, CStringMapper::unmap(soundName).c_str()); +00072 } +00073 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundAnimMarkera2" doxytag="NLSOUND::CSoundAnimMarker::getSounds" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSoundAnimMarker::getSounds </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::vector< <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> > & </td> + <td class="mdname1" valign="top" nowrap> <em>sounds</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the set of sounds of this marker +<p> +Definition at line <a class="el" href="a06410.html#l00092">92</a> of file <a class="el" href="a06410.html">sound_anim_marker.cpp</a>. +<p> +Referenced by <a class="el" href="a06412.html#l00081">NLSOUND::CSoundAnimation::save()</a>. +<p> +<div class="fragment"><pre>00093 { +00094 sounds.insert(sounds.end(), <a class="code" href="a03415.html#NLSOUND_1_1CSoundAnimMarkerp0">_Sounds</a>.begin(), <a class="code" href="a03415.html#NLSOUND_1_1CSoundAnimMarkerp0">_Sounds</a>.end()); +00095 +00096 <span class="comment">/* TMarkerSoundSet::iterator first(_Sounds.begin()), last(_Sounds.end());</span> +00097 <span class="comment"> for (; first != last; ++first)</span> +00098 <span class="comment"> {</span> +00099 <span class="comment"> sounds.push_back((*first).c_str());</span> +00100 <span class="comment"> }</span> +00101 <span class="comment">*/</span> +00102 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundAnimMarkera3" doxytag="NLSOUND::CSoundAnimMarker::getTime" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual float NLSOUND::CSoundAnimMarker::getTime </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the time of this marker +<p> +Definition at line <a class="el" href="a06411.html#l00059">59</a> of file <a class="el" href="a06411.html">sound_anim_marker.h</a>. +<p> +Referenced by <a class="el" href="a06412.html#l00142">NLSOUND::CSoundAnimation::play()</a>, and <a class="el" href="a06412.html#l00081">NLSOUND::CSoundAnimation::save()</a>. +<p> +<div class="fragment"><pre>00059 { <span class="keywordflow">return</span> <a class="code" href="a03415.html#NLSOUND_1_1CSoundAnimMarkerp1">_Time</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundAnimMarkera4" doxytag="NLSOUND::CSoundAnimMarker::play" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSoundAnimMarker::play </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02236.html">UAudioMixer</a> * </td> + <td class="mdname" nowrap> <em>mixer</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a02362.html">NL3D::CCluster</a> * </td> + <td class="mdname" nowrap> <em>cluster</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a03417.html">CSoundContext</a> & </td> + <td class="mdname" nowrap> <em>context</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Play all the sounds of this marker +<p> +Definition at line <a class="el" href="a06410.html#l00047">47</a> of file <a class="el" href="a06410.html">sound_anim_marker.cpp</a>. +<p> +References <a class="el" href="a02236.html#NLSOUND_1_1UAudioMixera1">NLSOUND::UAudioMixer::createSource()</a>, <a class="el" href="a03429.html#NLSOUND_1_1USourcez2137_3">NLSOUND::USource::play()</a>, <a class="el" href="a06630.html#l00058">NLSOUND::CSoundContext::Position</a>, <a class="el" href="a06630.html#l00057">NLSOUND::CSoundContext::RelativeGain</a>, <a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_10">NLSOUND::USource::setPos()</a>, and <a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_11">NLSOUND::USource::setRelativeGain()</a>. +<p> +Referenced by <a class="el" href="a06412.html#l00142">NLSOUND::CSoundAnimation::play()</a>. +<p> +<div class="fragment"><pre>00048 { +00049 TMarkerSoundSet::iterator first(<a class="code" href="a03415.html#NLSOUND_1_1CSoundAnimMarkerp0">_Sounds</a>.begin()), last(<a class="code" href="a03415.html#NLSOUND_1_1CSoundAnimMarkerp0">_Sounds</a>.end()); +00050 +00051 <span class="keywordflow">for</span> (; first != last; ++first) +00052 { +00053 USource* source = mixer-><a class="code" href="a02236.html#NLSOUND_1_1UAudioMixera1">createSource</a>((*first), <span class="keyword">true</span>, NULL, NULL, cluster, &context); +00054 <span class="keywordflow">if</span> (source != NULL) +00055 { +00056 source->setRelativeGain(context.RelativeGain); +00057 source->setPos(context.Position); +00058 source->play(); +00059 } +00060 } +00061 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundAnimMarkera5" doxytag="NLSOUND::CSoundAnimMarker::removeSound" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSoundAnimMarker::removeSound </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>soundName</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Remove a sound +<p> +Definition at line <a class="el" href="a06410.html#l00077">77</a> of file <a class="el" href="a06410.html">sound_anim_marker.cpp</a>. +<p> +References <a class="el" href="a05622.html#l00135">nlwarning</a>. +<p> +<div class="fragment"><pre>00078 { +00079 TMarkerSoundSet::const_iterator iter = <a class="code" href="a03415.html#NLSOUND_1_1CSoundAnimMarkerp0">_Sounds</a>.find(soundName); +00080 <span class="keywordflow">if</span> (iter != <a class="code" href="a03415.html#NLSOUND_1_1CSoundAnimMarkerp0">_Sounds</a>.end()) +00081 { +00082 <a class="code" href="a03415.html#NLSOUND_1_1CSoundAnimMarkerp0">_Sounds</a>.erase(iter); +00083 } +00084 <span class="keywordflow">else</span> +00085 { +00086 <a class="code" href="a04199.html#a2">nlwarning</a>(<span class="stringliteral">"No sound was removed (%s)"</span>, CStringMapper::unmap(soundName).c_str()); +00087 } +00088 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundAnimMarkera6" doxytag="NLSOUND::CSoundAnimMarker::setTime" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::CSoundAnimMarker::setTime </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname1" valign="top" nowrap> <em>time</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the time of this marker +<p> +Definition at line <a class="el" href="a06411.html#l00056">56</a> of file <a class="el" href="a06411.html">sound_anim_marker.h</a>. +<p> +Referenced by <a class="el" href="a06412.html#l00159">NLSOUND::CSoundAnimation::load()</a>. +<p> +<div class="fragment"><pre>00056 { <a class="code" href="a03415.html#NLSOUND_1_1CSoundAnimMarkerp1">_Time</a> = time; } +</pre></div> </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NLSOUND_1_1CSoundAnimMarkerp0" doxytag="NLSOUND::CSoundAnimMarker::_Sounds" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a05381.html#a59">TMarkerSoundSet</a> <a class="el" href="a03415.html#NLSOUND_1_1CSoundAnimMarkerp0">NLSOUND::CSoundAnimMarker::_Sounds</a><code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The set of sounds to be played +<p> +Definition at line <a class="el" href="a06411.html#l00077">77</a> of file <a class="el" href="a06411.html">sound_anim_marker.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundAnimMarkerp1" doxytag="NLSOUND::CSoundAnimMarker::_Time" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> float <a class="el" href="a03415.html#NLSOUND_1_1CSoundAnimMarkerp1">NLSOUND::CSoundAnimMarker::_Time</a><code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The time position of this marker +<p> +Definition at line <a class="el" href="a06411.html#l00080">80</a> of file <a class="el" href="a06411.html">sound_anim_marker.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="a06411.html">sound_anim_marker.h</a><li><a class="el" href="a06410.html">sound_anim_marker.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 14:42:58 2004 for NeL by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.6 </small></address> +</body> +</html> |