aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/classNL3D_1_1CPSSoundInstanceImpl.html
diff options
context:
space:
mode:
authorneodarz <neodarz@neodarz.net>2018-08-11 20:21:34 +0200
committerneodarz <neodarz@neodarz.net>2018-08-11 20:21:34 +0200
commit0ea5fc66924303d1bf73ba283a383e2aadee02f2 (patch)
tree2568e71a7ccc44ec23b8bb3f0ff97fb6bf2ed709 /docs/doxygen/nel/classNL3D_1_1CPSSoundInstanceImpl.html
downloadnevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.tar.xz
nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.zip
Initial commit
Diffstat (limited to 'docs/doxygen/nel/classNL3D_1_1CPSSoundInstanceImpl.html')
-rw-r--r--docs/doxygen/nel/classNL3D_1_1CPSSoundInstanceImpl.html529
1 files changed, 529 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNL3D_1_1CPSSoundInstanceImpl.html b/docs/doxygen/nel/classNL3D_1_1CPSSoundInstanceImpl.html
new file mode 100644
index 00000000..916954af
--- /dev/null
+++ b/docs/doxygen/nel/classNL3D_1_1CPSSoundInstanceImpl.html
@@ -0,0 +1,529 @@
+<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
+<HTML>
+<HEAD>
+ <TITLE>nevrax.org : docs</TITLE>
+ <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css">
+ <link href="doxygen.css" rel="stylesheet" type="text/css">
+</HEAD>
+<BODY MARGINHEIGHT="0" MARGINWIDTH="0">
+
+<!-- uplinks -->
+<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
+ <TR>
+ <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
+ <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD>
+ <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
+ <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
+ <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
+ </TR>
+</TABLE>
+
+<!-- banner Nevrax -->
+<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%>
+ <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR>
+</TABLE>
+
+<!-- main table -->
+<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%>
+ <TR>
+ <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD>
+ <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">
+
+ <!------ Begin Box ------>
+ <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black>
+ <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF>
+ <TABLE cellspacing=0 cellpadding=1 border=0>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr>
+ </TABLE>
+ </TD></TR></TABLE></TD></TR></TABLE>
+ <!------ End Box ------>
+
+ </TD>
+ <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
+ <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">
+
+<!-- title -->
+<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td>
+<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A>
+</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT="">
+</td></tr></table>
+&nbsp;
+
+<!-- block -->
+<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD>
+ <TD><B>Documentation</B></TD>
+ <TD ALIGN=RIGHT>&nbsp;</td>
+</tr></table>
+<!-- Generated by Doxygen 1.2.14 -->
+<center>
+<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> &nbsp; </center>
+<hr><h1>NL3D::CPSSoundInstanceImpl Class Reference</h1>This class implement a sound instance (a sound source).
+<a href="#_details">More...</a>
+<p>
+<code>#include &lt;<a class="el" href="u__ps__sound__impl_8h-source.html">u_ps_sound_impl.h</a>&gt;</code>
+<p>
+<p>Inheritance diagram for NL3D::CPSSoundInstanceImpl:
+<p><center><img src="classNL3D_1_1CPSSoundInstanceImpl.gif" usemap="#NL3D::CPSSoundInstanceImpl_map" border="0"></center>
+<map name="NL3D::CPSSoundInstanceImpl_map">
+<area href="structNL3D_1_1UPSSoundInstance.html" alt="NL3D::UPSSoundInstance" shape="rect" coords="0,0,180,24">
+</map>
+<a href="classNL3D_1_1CPSSoundInstanceImpl-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
+<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
+<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CPSSoundInstanceImpl.html#a0">CPSSoundInstanceImpl</a> ()</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>The system will call this method to set the parameters of the sound.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CPSSoundInstanceImpl.html#a1">init</a> (<a class="el" href="classNLSOUND_1_1USource.html">NLSOUND::USource</a> *source, <a class="el" href="classNL3D_1_1CPSSoundServImpl.html">CPSSoundServImpl</a> *soundServImp, bool spawned)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>init this sound instance parameters.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CPSSoundInstanceImpl.html#a2">setSoundParams</a> (float gain, const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &amp;pos, const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &amp;velocity, float pitch)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>change this sound source paramerters.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CPSSoundInstanceImpl.html#a3">play</a> (void)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>start to play the sound.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CPSSoundInstanceImpl.html#a4">isPlaying</a> (void) const</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>tells wether the sound is playing.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CPSSoundInstanceImpl.html#a5">stop</a> (void)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>stop the sound.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CPSSoundInstanceImpl.html#a6">release</a> (void)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>release the sound source.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
+<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
+<tr><td nowrap align=right valign=top><a class="el" href="classNLSOUND_1_1USource.html">NLSOUND::USource</a> *&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CPSSoundInstanceImpl.html#n0">_Source</a></td></tr>
+<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CPSSoundInstanceImpl.html#n1">_Spawned</a></td></tr>
+<tr><td nowrap align=right valign=top><a class="el" href="classNL3D_1_1CPSSoundServImpl.html">CPSSoundServImpl</a> *&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CPSSoundInstanceImpl.html#n2">_SoundServImpl</a></td></tr>
+<tr><td colspan=2><br><h2>Friends</h2></td></tr>
+<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CPSSoundInstanceImpl.html#l0">SpawnedSourceEndedCallback</a> (<a class="el" href="classNLSOUND_1_1USource.html">NLSOUND::USource</a> *source, void *userParam)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>this callback is called when a spawned source has ended, so that we know that the pointer to it is invalid...</em> <a href="#l0">More...</a><em></em></font><br><br></td></tr>
+</table>
+<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="u__ps__sound__impl_8h-source.html#l00053">53</a> of file <a class="el" href="u__ps__sound__impl_8h-source.html">u_ps_sound_impl.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a name="a0" doxytag="NL3D::CPSSoundInstanceImpl::CPSSoundInstanceImpl"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> NL3D::CPSSoundInstanceImpl::CPSSoundInstanceImpl </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [inline]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+The system will call this method to set the parameters of the sound.
+<p>
+
+<p>
+Definition at line <a class="el" href="u__ps__sound__impl_8h-source.html#l00059">59</a> of file <a class="el" href="u__ps__sound__impl_8h-source.html">u_ps_sound_impl.h</a>.
+<p>
+References <a class="el" href="u__ps__sound__impl_8h-source.html#l00125">_SoundServImpl</a>, <a class="el" href="u__ps__sound__impl_8h-source.html#l00123">_Source</a>, <a class="el" href="u__ps__sound__impl_8h-source.html#l00124">_Spawned</a>, and <a class="el" href="u__ps__sound__impl_8h-source.html#l00040">NL3D_MEM_PS_SOUND</a>. </td>
+ </tr>
+</table>
+<hr><h2>Member Function Documentation</h2>
+<a name="a1" doxytag="NL3D::CPSSoundInstanceImpl::init"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void NL3D::CPSSoundInstanceImpl::init </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="classNLSOUND_1_1USource.html">NLSOUND::USource</a> *&nbsp;</td>
+ <td class="mdname" nowrap>&nbsp; <em>source</em>, </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap><a class="el" href="classNL3D_1_1CPSSoundServImpl.html">CPSSoundServImpl</a> *&nbsp;</td>
+ <td class="mdname" nowrap>&nbsp; <em>soundServImp</em>, </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>bool&nbsp;</td>
+ <td class="mdname" nowrap>&nbsp; <em>spawned</em></td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">)&nbsp;</td>
+ <td class="md" colspan="2"><code> [inline]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+init this sound instance parameters.
+<p>
+
+<p>
+Definition at line <a class="el" href="u__ps__sound__impl_8h-source.html#l00066">66</a> of file <a class="el" href="u__ps__sound__impl_8h-source.html">u_ps_sound_impl.h</a>.
+<p>
+References <a class="el" href="u__ps__sound__impl_8h-source.html#l00125">_SoundServImpl</a>, <a class="el" href="u__ps__sound__impl_8h-source.html#l00123">_Source</a>, <a class="el" href="u__ps__sound__impl_8h-source.html#l00124">_Spawned</a>, <a class="el" href="u__ps__sound__impl_8h-source.html#l00040">NL3D_MEM_PS_SOUND</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. </td>
+ </tr>
+</table>
+<a name="a4" doxytag="NL3D::CPSSoundInstanceImpl::isPlaying"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <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">(&nbsp;</td>
+ <td class="md" nowrap valign="top">void&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</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>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+tells wether the sound is playing.
+<p>
+
+<p>
+Implements <a class="el" href="structNL3D_1_1UPSSoundInstance.html#a2">NL3D::UPSSoundInstance</a>.
+<p>
+Definition at line <a class="el" href="u__ps__sound__impl_8h-source.html#l00103">103</a> of file <a class="el" href="u__ps__sound__impl_8h-source.html">u_ps_sound_impl.h</a>.
+<p>
+References <a class="el" href="u__ps__sound__impl_8h-source.html#l00123">_Source</a>, <a class="el" href="classNLSOUND_1_1USource.html#z364_4">NLSOUND::USource::isPlaying</a>, and <a class="el" href="u__ps__sound__impl_8h-source.html#l00040">NL3D_MEM_PS_SOUND</a>. </td>
+ </tr>
+</table>
+<a name="a3" doxytag="NL3D::CPSSoundInstanceImpl::play"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <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">(&nbsp;</td>
+ <td class="md" nowrap valign="top">void&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [inline, virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+start to play the sound.
+<p>
+
+<p>
+Implements <a class="el" href="structNL3D_1_1UPSSoundInstance.html#a1">NL3D::UPSSoundInstance</a>.
+<p>
+Definition at line <a class="el" href="u__ps__sound__impl_8h-source.html#l00095">95</a> of file <a class="el" href="u__ps__sound__impl_8h-source.html">u_ps_sound_impl.h</a>.
+<p>
+References <a class="el" href="u__ps__sound__impl_8h-source.html#l00123">_Source</a>, <a class="el" href="u__ps__sound__impl_8h-source.html#l00040">NL3D_MEM_PS_SOUND</a>, and <a class="el" href="classNLSOUND_1_1USource.html#z364_2">NLSOUND::USource::play</a>. </td>
+ </tr>
+</table>
+<a name="a6" doxytag="NL3D::CPSSoundInstanceImpl::release"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void NL3D::CPSSoundInstanceImpl::release </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">void&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+release the sound source.
+<p>
+
+<p>
+Implements <a class="el" href="structNL3D_1_1UPSSoundInstance.html#a4">NL3D::UPSSoundInstance</a>.
+<p>
+Definition at line <a class="el" href="u__ps__sound__impl_8h-source.html#l00201">201</a> of file <a class="el" href="u__ps__sound__impl_8h-source.html">u_ps_sound_impl.h</a>.
+<p>
+References <a class="el" href="u__ps__sound__impl_8h-source.html#l00125">_SoundServImpl</a>, <a class="el" href="u__ps__sound__impl_8h-source.html#l00123">_Source</a>, <a class="el" href="u__ps__sound__impl_8h-source.html#l00124">_Spawned</a>, and <a class="el" href="classNLSOUND_1_1USource.html#z364_5">NLSOUND::USource::unregisterSpawnCallBack</a>. </td>
+ </tr>
+</table>
+<a name="a2" doxytag="NL3D::CPSSoundInstanceImpl::setSoundParams"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <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">(&nbsp;</td>
+ <td class="md" nowrap valign="top">float&nbsp;</td>
+ <td class="mdname" nowrap>&nbsp; <em>gain</em>, </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &amp;&nbsp;</td>
+ <td class="mdname" nowrap>&nbsp; <em>pos</em>, </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &amp;&nbsp;</td>
+ <td class="mdname" nowrap>&nbsp; <em>velocity</em>, </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>float&nbsp;</td>
+ <td class="mdname" nowrap>&nbsp; <em>pitch</em></td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">)&nbsp;</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>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+change this sound source paramerters.
+<p>
+
+<p>
+Implements <a class="el" href="structNL3D_1_1UPSSoundInstance.html#a0">NL3D::UPSSoundInstance</a>.
+<p>
+Definition at line <a class="el" href="u__ps__sound__impl_8h-source.html#l00076">76</a> of file <a class="el" href="u__ps__sound__impl_8h-source.html">u_ps_sound_impl.h</a>.
+<p>
+References <a class="el" href="u__ps__sound__impl_8h-source.html#l00123">_Source</a>, <a class="el" href="u__ps__sound__impl_8h-source.html#l00040">NL3D_MEM_PS_SOUND</a>, <a class="el" href="classNLSOUND_1_1USource.html#z365_10">NLSOUND::USource::setPitch</a>, <a class="el" href="classNLSOUND_1_1USource.html#z365_0">NLSOUND::USource::setPos</a>, <a class="el" href="classNLSOUND_1_1USource.html#z365_8">NLSOUND::USource::setRelativeGain</a>, and <a class="el" href="classNLSOUND_1_1USource.html#z365_2">NLSOUND::USource::setVelocity</a>. </td>
+ </tr>
+</table>
+<a name="a5" doxytag="NL3D::CPSSoundInstanceImpl::stop"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <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">(&nbsp;</td>
+ <td class="md" nowrap valign="top">void&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [inline, virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+stop the sound.
+<p>
+
+<p>
+Implements <a class="el" href="structNL3D_1_1UPSSoundInstance.html#a3">NL3D::UPSSoundInstance</a>.
+<p>
+Definition at line <a class="el" href="u__ps__sound__impl_8h-source.html#l00111">111</a> of file <a class="el" href="u__ps__sound__impl_8h-source.html">u_ps_sound_impl.h</a>.
+<p>
+References <a class="el" href="u__ps__sound__impl_8h-source.html#l00123">_Source</a>, <a class="el" href="u__ps__sound__impl_8h-source.html#l00040">NL3D_MEM_PS_SOUND</a>, and <a class="el" href="classNLSOUND_1_1USource.html#z364_3">NLSOUND::USource::stop</a>. </td>
+ </tr>
+</table>
+<hr><h2>Friends And Related Function Documentation</h2>
+<a name="l0" doxytag="NL3D::CPSSoundInstanceImpl::SpawnedSourceEndedCallback"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void SpawnedSourceEndedCallback </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="classNLSOUND_1_1USource.html">NLSOUND::USource</a> *&nbsp;</td>
+ <td class="mdname" nowrap>&nbsp; <em>source</em>, </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>void *&nbsp;</td>
+ <td class="mdname" nowrap>&nbsp; <em>userParam</em></td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">)&nbsp;</td>
+ <td class="md" colspan="2"><code> [friend]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </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>
+
+<p>
+Definition at line <a class="el" href="u__ps__sound__impl_8h-source.html#l00193">193</a> of file <a class="el" href="u__ps__sound__impl_8h-source.html">u_ps_sound_impl.h</a>. </td>
+ </tr>
+</table>
+<hr><h2>Member Data Documentation</h2>
+<a name="n2" doxytag="NL3D::CPSSoundInstanceImpl::_SoundServImpl"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> <a class="el" href="classNL3D_1_1CPSSoundServImpl.html">CPSSoundServImpl</a>* NL3D::CPSSoundInstanceImpl::_SoundServImpl<code> [protected]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="u__ps__sound__impl_8h-source.html#l00125">125</a> of file <a class="el" href="u__ps__sound__impl_8h-source.html">u_ps_sound_impl.h</a>.
+<p>
+Referenced by <a class="el" href="u__ps__sound__impl_8h-source.html#l00059">CPSSoundInstanceImpl</a>, <a class="el" href="u__ps__sound__impl_8h-source.html#l00066">init</a>, and <a class="el" href="u__ps__sound__impl_8h-source.html#l00201">release</a>. </td>
+ </tr>
+</table>
+<a name="n0" doxytag="NL3D::CPSSoundInstanceImpl::_Source"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> <a class="el" href="classNLSOUND_1_1USource.html">NLSOUND::USource</a>* NL3D::CPSSoundInstanceImpl::_Source<code> [protected]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="u__ps__sound__impl_8h-source.html#l00123">123</a> of file <a class="el" href="u__ps__sound__impl_8h-source.html">u_ps_sound_impl.h</a>.
+<p>
+Referenced by <a class="el" href="u__ps__sound__impl_8h-source.html#l00059">CPSSoundInstanceImpl</a>, <a class="el" href="u__ps__sound__impl_8h-source.html#l00066">init</a>, <a class="el" href="u__ps__sound__impl_8h-source.html#l00103">isPlaying</a>, <a class="el" href="u__ps__sound__impl_8h-source.html#l00095">play</a>, <a class="el" href="u__ps__sound__impl_8h-source.html#l00201">release</a>, <a class="el" href="u__ps__sound__impl_8h-source.html#l00076">setSoundParams</a>, and <a class="el" href="u__ps__sound__impl_8h-source.html#l00111">stop</a>. </td>
+ </tr>
+</table>
+<a name="n1" doxytag="NL3D::CPSSoundInstanceImpl::_Spawned"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> bool NL3D::CPSSoundInstanceImpl::_Spawned<code> [protected]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="u__ps__sound__impl_8h-source.html#l00124">124</a> of file <a class="el" href="u__ps__sound__impl_8h-source.html">u_ps_sound_impl.h</a>.
+<p>
+Referenced by <a class="el" href="u__ps__sound__impl_8h-source.html#l00059">CPSSoundInstanceImpl</a>, <a class="el" href="u__ps__sound__impl_8h-source.html#l00066">init</a>, and <a class="el" href="u__ps__sound__impl_8h-source.html#l00201">release</a>. </td>
+ </tr>
+</table>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li><a class="el" href="u__ps__sound__impl_8h-source.html">u_ps_sound_impl.h</a></ul>
+
+
+<!-- footer -->
+<BR><FONT Size=+5>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </FONT>
+</TD>
+<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD>
+</TR>
+</TABLE>
+</BODY>
+</HTML>