diff options
Diffstat (limited to 'docs/doxygen/nel/a03236.html')
| -rw-r--r-- | docs/doxygen/nel/a03236.html | 634 |
1 files changed, 634 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03236.html b/docs/doxygen/nel/a03236.html new file mode 100644 index 00000000..304dbc77 --- /dev/null +++ b/docs/doxygen/nel/a03236.html @@ -0,0 +1,634 @@ +<!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::CPSSoundInstanceImpl 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::CPSSoundInstanceImpl Class Reference</h1><code>#include <<a class="el" href="a06622.html">u_ps_sound_impl.h</a>></code> +<p> +<p>Inheritance diagram for NL3D::CPSSoundInstanceImpl: +<p><center><img src="a03236.png" usemap="#NL3D::CPSSoundInstanceImpl_map" border="0" alt=""></center> +<map name="NL3D::CPSSoundInstanceImpl_map"> +<area href="a03939.html" alt="NL3D::UPSSoundInstance" shape="rect" coords="0,0,180,24"> +</map> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This class implement a sound instance (a sound source). +<p> + +<p> +Definition at line <a class="el" href="a06622.html#l00053">53</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="a03236.html#NL3D_1_1CPSSoundInstanceImpla0">CPSSoundInstanceImpl</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">construct this object from a nel sound source <a href="#NL3D_1_1CPSSoundInstanceImpla0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual float </td><td class="memItemRight" valign=bottom><a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImpla1">getPitch</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get pitch <a href="#NL3D_1_1CPSSoundInstanceImpla1"></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="a03236.html#NL3D_1_1CPSSoundInstanceImpla2">init</a> (<a class="el" href="a03429.html">NLSOUND::USource</a> *source, <a class="el" href="a03237.html">CPSSoundServImpl</a> *soundServImp, bool spawned)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">init this sound instance parameters <a href="#NL3D_1_1CPSSoundInstanceImpla2"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImpla3">isPlaying</a> (void) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">tells wether the sound is playing <a href="#NL3D_1_1CPSSoundInstanceImpla3"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImpla4">play</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">start to play the sound <a href="#NL3D_1_1CPSSoundInstanceImpla4"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImpla5">release</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">release the sound source <a href="#NL3D_1_1CPSSoundInstanceImpla5"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImpla6">setLooping</a> (bool looping)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImpla7">setSoundParams</a> (float gain, const <a class="el" href="a03128.html">NLMISC::CVector</a> &pos, const <a class="el" href="a03128.html">NLMISC::CVector</a> &velocity, float pitch)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">change this sound source paramerters <a href="#NL3D_1_1CPSSoundInstanceImpla7"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImpla8">stop</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">stop the sound <a href="#NL3D_1_1CPSSoundInstanceImpla8"></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="a03237.html">CPSSoundServImpl</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp0">_SoundServImpl</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03429.html">NLSOUND::USource</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp2">_Spawned</a></td></tr> + +<tr><td colspan=2><br><h2>Friends</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImpln0">SpawnedSourceEndedCallback</a> (<a class="el" href="a03429.html">NLSOUND::USource</a> *source, void *userParam)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">this callback is called when a spawned source has ended, so that we know that the pointer to it is invalid... <a href="#NL3D_1_1CPSSoundInstanceImpln0"></a><br><br></td></tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NL3D_1_1CPSSoundInstanceImpla0" doxytag="NL3D::CPSSoundInstanceImpl::CPSSoundInstanceImpl" ></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::CPSSoundInstanceImpl::CPSSoundInstanceImpl </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 object from a nel sound source +<p> +The system will call this method to set the parameters of the sound +<p> +Definition at line <a class="el" href="a06622.html#l00059">59</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. +<p> +References <a class="el" href="a06622.html#l00140">_SoundServImpl</a>, <a class="el" href="a06622.html#l00139">_Spawned</a>, and <a class="el" href="a06154.html#l00034">NL3D_MEM_PS_SOUND</a>. +<p> +<div class="fragment"><pre>00060 : <a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>(NULL), <a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp0">_SoundServImpl</a>(NULL), <a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp2">_Spawned</a>(<span class="keyword">false</span>) +00061 { +00062 <a class="code" href="a04731.html#a0">NL3D_MEM_PS_SOUND</a> +00063 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NL3D_1_1CPSSoundInstanceImpla1" doxytag="NL3D::CPSSoundInstanceImpl::getPitch" ></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 NL3D::CPSSoundInstanceImpl::getPitch </td> + <td class="md" valign="top">( </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> +get pitch +<p> + +<p> +Implements <a class="el" href="a03939.html#NL3D_1_1UPSSoundInstancea0">NL3D::UPSSoundInstance</a>. +<p> +Definition at line <a class="el" href="a06622.html#l00118">118</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. +<p> +References <a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_2">NLSOUND::USource::getPitch()</a>, and <a class="el" href="a06154.html#l00034">NL3D_MEM_PS_SOUND</a>. +<p> +<div class="fragment"><pre>00119 { +00120 <a class="code" href="a04731.html#a0">NL3D_MEM_PS_SOUND</a> +00121 <span class="keywordflow">if</span> (!<a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>) <span class="keywordflow">return</span> 0.f; +00122 <span class="keywordflow">return</span> <a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>-><a class="code" href="a03429.html#NLSOUND_1_1USourcez2139_2">getPitch</a>(); +00123 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPSSoundInstanceImpla2" doxytag="NL3D::CPSSoundInstanceImpl::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::CPSSoundInstanceImpl::init </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a03429.html">NLSOUND::USource</a> * </td> + <td class="mdname" nowrap> <em>source</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a03237.html">CPSSoundServImpl</a> * </td> + <td class="mdname" nowrap> <em>soundServImp</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></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +init this sound instance parameters +<p> + +<p> +Definition at line <a class="el" href="a06622.html#l00066">66</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. +<p> +References <a class="el" href="a06622.html#l00140">_SoundServImpl</a>, <a class="el" href="a06622.html#l00139">_Spawned</a>, <a class="el" href="a06154.html#l00034">NL3D_MEM_PS_SOUND</a>, and <a class="el" href="a05622.html#l00290">nlassert</a>. +<p> +Referenced by <a class="el" href="a06622.html#l00178">NL3D::CPSSoundServImpl::createSound()</a>. +<p> +<div class="fragment"><pre>00067 { +00068 <a class="code" href="a04731.html#a0">NL3D_MEM_PS_SOUND</a> +00069 <a class="code" href="a04199.html#a6">nlassert</a>(source); +00070 <a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a> = source; +00071 <a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp2">_Spawned</a> = spawned; +00072 <a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp0">_SoundServImpl</a> = soundServImp; +00073 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPSSoundInstanceImpla3" doxytag="NL3D::CPSSoundInstanceImpl::isPlaying" ></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 bool NL3D::CPSSoundInstanceImpl::isPlaying </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> +tells wether the sound is playing +<p> + +<p> +Implements <a class="el" href="a03939.html#NL3D_1_1UPSSoundInstancea1">NL3D::UPSSoundInstance</a>. +<p> +Definition at line <a class="el" href="a06622.html#l00102">102</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. +<p> +References <a class="el" href="a03429.html#NLSOUND_1_1USourcez2137_2">NLSOUND::USource::isPlaying()</a>, and <a class="el" href="a06154.html#l00034">NL3D_MEM_PS_SOUND</a>. +<p> +<div class="fragment"><pre>00103 { +00104 <a class="code" href="a04731.html#a0">NL3D_MEM_PS_SOUND</a> +00105 <span class="keywordflow">if</span> (!<a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>) <span class="keywordflow">return</span> <span class="keyword">false</span>; +00106 <span class="keywordflow">return</span> <a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>-><a class="code" href="a03429.html#NLSOUND_1_1USourcez2137_2">isPlaying</a>(); +00107 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPSSoundInstanceImpla4" doxytag="NL3D::CPSSoundInstanceImpl::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"> virtual void NL3D::CPSSoundInstanceImpl::play </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, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +start to play the sound +<p> + +<p> +Implements <a class="el" href="a03939.html#NL3D_1_1UPSSoundInstancea2">NL3D::UPSSoundInstance</a>. +<p> +Definition at line <a class="el" href="a06622.html#l00094">94</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. +<p> +References <a class="el" href="a06154.html#l00034">NL3D_MEM_PS_SOUND</a>, and <a class="el" href="a03429.html#NLSOUND_1_1USourcez2137_3">NLSOUND::USource::play()</a>. +<p> +<div class="fragment"><pre>00095 { +00096 <a class="code" href="a04731.html#a0">NL3D_MEM_PS_SOUND</a> +00097 <span class="keywordflow">if</span> (!<a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>) <span class="keywordflow">return</span>; +00098 <a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>-><a class="code" href="a03429.html#NLSOUND_1_1USourcez2137_3">play</a>(); +00099 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPSSoundInstanceImpla5" doxytag="NL3D::CPSSoundInstanceImpl::release" ></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::CPSSoundInstanceImpl::release </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> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +release the sound source +<p> + +<p> +Implements <a class="el" href="a03939.html#NL3D_1_1UPSSoundInstancea3">NL3D::UPSSoundInstance</a>. +<p> +Definition at line <a class="el" href="a06622.html#l00217">217</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. +<p> +References <a class="el" href="a06622.html#l00140">_SoundServImpl</a>, <a class="el" href="a06622.html#l00139">_Spawned</a>, <a class="el" href="a06622.html#l00173">NL3D::CPSSoundServImpl::getAudioMixer()</a>, and <a class="el" href="a03429.html#NLSOUND_1_1USourcez2137_6">NLSOUND::USource::unregisterSpawnCallBack()</a>. +<p> +<div class="fragment"><pre>00218 { +00219 <span class="keywordflow">if</span> (!<a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp2">_Spawned</a>) <span class="comment">// remove this source from the audio mixer if it hasn't been spawned</span> +00220 { +00221 <span class="keywordflow">if</span> (<a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp0">_SoundServImpl</a>->getAudioMixer()) +00222 { +00223 <span class="comment">// _SoundServImpl->getAudioMixer()->removeSource(_Source);</span> +00224 <span class="keyword">delete</span> <a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>; +00225 } +00226 } +00227 <span class="keywordflow">else</span> +00228 { +00229 <span class="keywordflow">if</span> (<a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>) <span class="comment">// tells this spawned source not to notify us when it ends</span> +00230 { +00231 <a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>-><a class="code" href="a03429.html#NLSOUND_1_1USourcez2137_6">unregisterSpawnCallBack</a>(); +00232 } +00233 } +00234 <span class="keyword">delete</span> <span class="keyword">this</span>; +00235 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPSSoundInstanceImpla6" doxytag="NL3D::CPSSoundInstanceImpl::setLooping" ></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 NL3D::CPSSoundInstanceImpl::setLooping </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>looping</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> + +<p> +Implements <a class="el" href="a03939.html#NL3D_1_1UPSSoundInstancea4">NL3D::UPSSoundInstance</a>. +<p> +Definition at line <a class="el" href="a06622.html#l00126">126</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. +<p> +References <a class="el" href="a06154.html#l00034">NL3D_MEM_PS_SOUND</a>, and <a class="el" href="a03429.html#NLSOUND_1_1USourcez2137_4">NLSOUND::USource::setLooping()</a>. +<p> +<div class="fragment"><pre>00127 { +00128 <a class="code" href="a04731.html#a0">NL3D_MEM_PS_SOUND</a> +00129 <span class="keywordflow">if</span> (<a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>) <a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>-><a class="code" href="a03429.html#NLSOUND_1_1USourcez2137_4">setLooping</a>(looping); +00130 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPSSoundInstanceImpla7" doxytag="NL3D::CPSSoundInstanceImpl::setSoundParams" ></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 NL3D::CPSSoundInstanceImpl::setSoundParams </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname" nowrap> <em>gain</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname" nowrap> <em>pos</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname" nowrap> <em>velocity</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>pitch</em></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> +change this sound source paramerters +<p> + +<p> +Implements <a class="el" href="a03939.html#NL3D_1_1UPSSoundInstancea5">NL3D::UPSSoundInstance</a>. +<p> +Definition at line <a class="el" href="a06622.html#l00076">76</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. +<p> +References <a class="el" href="a06154.html#l00034">NL3D_MEM_PS_SOUND</a>, <a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_9">NLSOUND::USource::setPitch()</a>, <a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_10">NLSOUND::USource::setPos()</a>, <a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_11">NLSOUND::USource::setRelativeGain()</a>, and <a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_13">NLSOUND::USource::setVelocity()</a>. +<p> +<div class="fragment"><pre>00081 { +00082 <a class="code" href="a04731.html#a0">NL3D_MEM_PS_SOUND</a> +00083 <span class="keywordflow">if</span> (!<a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>) <span class="keywordflow">return</span>; +00084 <span class="keywordflow">if</span> (gain < 0) gain = 0; +00085 <span class="keywordflow">if</span> (gain > 1) gain = 1; +00086 <span class="keywordflow">if</span> (pitch < 0.0001f) pitch = 0.0001f; +00087 <a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>-><a class="code" href="a03429.html#NLSOUND_1_1USourcez2139_10">setPos</a>(pos); +00088 <a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>-><a class="code" href="a03429.html#NLSOUND_1_1USourcez2139_13">setVelocity</a>(velocity); +00089 <a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>-><a class="code" href="a03429.html#NLSOUND_1_1USourcez2139_11">setRelativeGain</a>(gain); +00090 <a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>-><a class="code" href="a03429.html#NLSOUND_1_1USourcez2139_9">setPitch</a>(pitch); +00091 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPSSoundInstanceImpla8" doxytag="NL3D::CPSSoundInstanceImpl::stop" ></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 NL3D::CPSSoundInstanceImpl::stop </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, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +stop the sound +<p> + +<p> +Implements <a class="el" href="a03939.html#NL3D_1_1UPSSoundInstancea6">NL3D::UPSSoundInstance</a>. +<p> +Definition at line <a class="el" href="a06622.html#l00110">110</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. +<p> +References <a class="el" href="a06154.html#l00034">NL3D_MEM_PS_SOUND</a>, and <a class="el" href="a03429.html#NLSOUND_1_1USourcez2137_5">NLSOUND::USource::stop()</a>. +<p> +<div class="fragment"><pre>00111 { +00112 <a class="code" href="a04731.html#a0">NL3D_MEM_PS_SOUND</a> +00113 <span class="keywordflow">if</span> (!<a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>) <span class="keywordflow">return</span>; +00114 <a class="code" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">_Source</a>-><a class="code" href="a03429.html#NLSOUND_1_1USourcez2137_5">stop</a>(); +00115 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Friends And Related Function Documentation</h2> +<a class="anchor" name="NL3D_1_1CPSSoundInstanceImpln0" doxytag="NL3D::CPSSoundInstanceImpl::SpawnedSourceEndedCallback" ></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 SpawnedSourceEndedCallback </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a03429.html">NLSOUND::USource</a> * </td> + <td class="mdname" nowrap> <em>source</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>userParam</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [friend]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +this callback is called when a spawned source has ended, so that we know that the pointer to it is invalid... +<p> + </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NL3D_1_1CPSSoundInstanceImplp0" doxytag="NL3D::CPSSoundInstanceImpl::_SoundServImpl" ></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="a03237.html">CPSSoundServImpl</a>* <a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp0">NL3D::CPSSoundInstanceImpl::_SoundServImpl</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#l00140">140</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. +<p> +Referenced by <a class="el" href="a06622.html#l00059">CPSSoundInstanceImpl()</a>, <a class="el" href="a06622.html#l00066">init()</a>, and <a class="el" href="a06622.html#l00217">release()</a>. </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPSSoundInstanceImplp1" doxytag="NL3D::CPSSoundInstanceImpl::_Source" ></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="a03429.html">NLSOUND::USource</a>* <a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp1">NL3D::CPSSoundInstanceImpl::_Source</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#l00138">138</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPSSoundInstanceImplp2" doxytag="NL3D::CPSSoundInstanceImpl::_Spawned" ></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"> bool <a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImplp2">NL3D::CPSSoundInstanceImpl::_Spawned</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#l00139">139</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>. +<p> +Referenced by <a class="el" href="a06622.html#l00059">CPSSoundInstanceImpl()</a>, <a class="el" href="a06622.html#l00066">init()</a>, and <a class="el" href="a06622.html#l00217">release()</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:51 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> |