diff options
Diffstat (limited to 'docs/doxygen/nel/a03237.html')
| -rw-r--r-- | docs/doxygen/nel/a03237.html | 307 |
1 files changed, 307 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03237.html b/docs/doxygen/nel/a03237.html new file mode 100644 index 00000000..c4edbdbc --- /dev/null +++ b/docs/doxygen/nel/a03237.html @@ -0,0 +1,307 @@ +<!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: NL3D::CPSSoundServImpl 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>NL3D::CPSSoundServImpl Class Reference</h1><code>#include <<a class="el" href="a06622.html">u_ps_sound_impl.h</a>></code> +<p> +<p>Inheritance diagram for NL3D::CPSSoundServImpl: +<p><center><img src="a03237.png" usemap="#NL3D::CPSSoundServImpl_map" border="0" alt=""></center> +<map name="NL3D::CPSSoundServImpl_map"> +<area href="a03940.html" alt="NL3D::UPSSoundServer" shape="rect" coords="0,0,160,24"> +</map> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This class implements PS sound server. It warps the calls to NEL sound. Everything is in a .h file to avoid dependency <dl compact><dt><b>Author:</b></dt><dd>Nicolas Vizerie <p> +Nevrax France </dd></dl> +<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl> + +<p> + +<p> +Definition at line <a class="el" href="a06622.html#l00155">155</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>.<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> </td><td class="memItemRight" valign=bottom><a class="el" href="a03237.html#NL3D_1_1CPSSoundServImpla0">CPSSoundServImpl</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">construct this sound server; You must init it then <a href="#NL3D_1_1CPSSoundServImpla0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03939.html">UPSSoundInstance</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03237.html#NL3D_1_1CPSSoundServImpla1">createSound</a> (const <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> &soundName, bool spawned=true)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">inherited from IPSSoundServer <a href="#NL3D_1_1CPSSoundServImpla1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="a02236.html">NLSOUND::UAudioMixer</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03237.html#NL3D_1_1CPSSoundServImpla2">getAudioMixer</a> (void) const </td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02236.html">NLSOUND::UAudioMixer</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03237.html#NL3D_1_1CPSSoundServImpla3">getAudioMixer</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get the audio mixer associated with that server <a href="#NL3D_1_1CPSSoundServImpla3"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03237.html#NL3D_1_1CPSSoundServImpla4">init</a> (<a class="el" href="a02236.html">NLSOUND::UAudioMixer</a> *audioMixer)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">init this particle system sound server, using the given audio mixer <a href="#NL3D_1_1CPSSoundServImpla4"></a><br><br></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="a02236.html">NLSOUND::UAudioMixer</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03237.html#NL3D_1_1CPSSoundServImplp0">_AudioMixer</a></td></tr> + +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NL3D_1_1CPSSoundServImpla0" doxytag="NL3D::CPSSoundServImpl::CPSSoundServImpl" ></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"> NL3D::CPSSoundServImpl::CPSSoundServImpl </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> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +construct this sound server; You must init it then +<p> + +<p> +Definition at line <a class="el" href="a06622.html#l00159">159</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. +<p> +References <a class="el" href="a06622.html#l00203">_AudioMixer</a>. +<p> +<div class="fragment"><pre>00159 : <a class="code" href="a03237.html#NL3D_1_1CPSSoundServImplp0">_AudioMixer</a>(NULL) +00160 { +00161 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NL3D_1_1CPSSoundServImpla1" doxytag="NL3D::CPSSoundServImpl::createSound" ></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="a03939.html">UPSSoundInstance</a>* NL3D::CPSSoundServImpl::createSound </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="mdname" nowrap> <em>soundName</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>spawned</em> = true</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +inherited from IPSSoundServer +<p> + +<p> +Implements <a class="el" href="a03940.html#NL3D_1_1UPSSoundServera0">NL3D::UPSSoundServer</a>. +<p> +Definition at line <a class="el" href="a06622.html#l00178">178</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. +<p> +References <a class="el" href="a06622.html#l00203">_AudioMixer</a>, <a class="el" href="a02236.html#NLSOUND_1_1UAudioMixera1">NLSOUND::UAudioMixer::createSource()</a>, <a class="el" href="a06622.html#l00066">NL3D::CPSSoundInstanceImpl::init()</a>, <a class="el" href="a03429.html#NLSOUND_1_1USourcez2137_4">NLSOUND::USource::setLooping()</a>, and <a class="el" href="a06622.html#l00209">NL3D::SpawnedSourceEndedCallback()</a>. +<p> +<div class="fragment"><pre>00179 { +00180 <span class="keywordflow">if</span> (!<a class="code" href="a03237.html#NL3D_1_1CPSSoundServImplp0">_AudioMixer</a>) +00181 <span class="keywordflow">return</span> NULL; +00182 CPSSoundInstanceImpl *sound = <span class="keyword">new</span> CPSSoundInstanceImpl; +00183 <a class="code" href="a03429.html">NLSOUND::USource</a> *source = <a class="code" href="a03237.html#NL3D_1_1CPSSoundServImplp0">_AudioMixer</a>-><a class="code" href="a02236.html#NLSOUND_1_1UAudioMixera1">createSource</a>(soundName, spawned, SpawnedSourceEndedCallback, sound ); +00184 <span class="keywordflow">if</span> (source) +00185 { +00186 <span class="keywordflow">if</span> (spawned) +00187 { +00188 source-><a class="code" href="a03429.html#NLSOUND_1_1USourcez2137_4">setLooping</a>(<span class="keyword">false</span>); +00189 } +00190 sound->init(source, <span class="keyword">this</span>, spawned); +00191 <span class="keywordflow">return</span> sound; +00192 } +00193 <span class="keywordflow">else</span> +00194 { +00195 <span class="comment">// should usually not happen</span> +00196 <span class="keyword">delete</span> sound; +00197 <span class="keywordflow">return</span> NULL; +00198 } +00199 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPSSoundServImpla2" doxytag="NL3D::CPSSoundServImpl::getAudioMixer" ></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"> const <a class="el" href="a02236.html">NLSOUND::UAudioMixer</a>* NL3D::CPSSoundServImpl::getAudioMixer </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]</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="a06622.html#l00174">174</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. +<p> +References <a class="el" href="a06622.html#l00203">_AudioMixer</a>. +<p> +<div class="fragment"><pre>00174 { <span class="keywordflow">return</span> <a class="code" href="a03237.html#NL3D_1_1CPSSoundServImplp0">_AudioMixer</a>;} +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPSSoundServImpla3" doxytag="NL3D::CPSSoundServImpl::getAudioMixer" ></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="a02236.html">NLSOUND::UAudioMixer</a>* NL3D::CPSSoundServImpl::getAudioMixer </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><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +get the audio mixer associated with that server +<p> + +<p> +Definition at line <a class="el" href="a06622.html#l00173">173</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. +<p> +References <a class="el" href="a06622.html#l00203">_AudioMixer</a>. +<p> +Referenced by <a class="el" href="a06622.html#l00217">NL3D::CPSSoundInstanceImpl::release()</a>. +<p> +<div class="fragment"><pre>00173 { <span class="keywordflow">return</span> <a class="code" href="a03237.html#NL3D_1_1CPSSoundServImplp0">_AudioMixer</a>;} +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPSSoundServImpla4" doxytag="NL3D::CPSSoundServImpl::init" ></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 NL3D::CPSSoundServImpl::init </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02236.html">NLSOUND::UAudioMixer</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>audioMixer</em> </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> +init this particle system sound server, using the given audio mixer +<p> + +<p> +Definition at line <a class="el" href="a06622.html#l00166">166</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. +<p> +References <a class="el" href="a06622.html#l00203">_AudioMixer</a>. +<p> +Referenced by <a class="el" href="a06617.html#l00063">NL3D::UParticleSystemSound::setPSSound()</a>. +<p> +<div class="fragment"><pre>00167 { +00168 <a class="code" href="a03237.html#NL3D_1_1CPSSoundServImplp0">_AudioMixer</a> = audioMixer; +00169 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NL3D_1_1CPSSoundServImplp0" doxytag="NL3D::CPSSoundServImpl::_AudioMixer" ></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="a02236.html">NLSOUND::UAudioMixer</a>* <a class="el" href="a03237.html#NL3D_1_1CPSSoundServImplp0">NL3D::CPSSoundServImpl::_AudioMixer</a><code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06622.html#l00203">203</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. +<p> +Referenced by <a class="el" href="a06622.html#l00159">CPSSoundServImpl()</a>, <a class="el" href="a06622.html#l00178">createSound()</a>, <a class="el" href="a06622.html#l00173">getAudioMixer()</a>, and <a class="el" href="a06622.html#l00166">init()</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="a06622.html">u_ps_sound_impl.h</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 07:25:53 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> |