diff options
Diffstat (limited to 'docs/doxygen/nel/a03429.html')
| -rw-r--r-- | docs/doxygen/nel/a03429.html | 967 |
1 files changed, 967 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03429.html b/docs/doxygen/nel/a03429.html new file mode 100644 index 00000000..d5e9e7f0 --- /dev/null +++ b/docs/doxygen/nel/a03429.html @@ -0,0 +1,967 @@ +<!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::USource 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::USource Class Reference</h1><code>#include <<a class="el" href="a06630.html">u_source.h</a>></code> +<p> +<p>Inheritance diagram for NLSOUND::USource: +<p><center><img src="a03429.png" usemap="#NLSOUND::USource_map" border="0" alt=""></center> +<map name="NLSOUND::USource_map"> +<area href="a02254.html" alt="NLSOUND::CSourceCommon" shape="rect" coords="206,56,402,80"> +<area href="a02253.html" alt="NLSOUND::CBackgroundSource" shape="rect" coords="0,112,196,136"> +<area href="a02394.html" alt="NLSOUND::CComplexSource" shape="rect" coords="206,112,402,136"> +<area href="a03395.html" alt="NLSOUND::CSimpleSource" shape="rect" coords="412,112,608,136"> +</map> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Game interface for sound sources (stereo or 3D sound instances).<p> +The mode is 3D if the sound buffer (specified by its Sound Id) is mono, otherwise it is stereo.<p> +For arguments as 3D vectors, use the NeL vector coordinate system: <pre class="fragment"><div> + * (top) + * z + * | y (front) + * | / + * -----x (right) + * + * The default priority is MidPri. + * Some properties are assigned at initialization's time, from the + * specified sound id (use NeL Sources Sound Builder to set these + * initial values). + * + * </div></pre><dl compact><dt><b>Author:</b></dt><dd>Olivier Cado <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="a06630.html#l00103">103</a> of file <a class="el" href="a06630.html">u_source.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>virtual <a class="el" href="a02246.html">TSoundId</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03429.html#NLSOUND_1_1USourcea0">getSound</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the sound binded to the source (or NULL if there is no sound). <a href="#NLSOUND_1_1USourcea0"></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="a03429.html#NLSOUND_1_1USourcea1">setPriority</a> (<a class="el" href="a05381.html#a82">TSoundPriority</a> pr)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the priority of the source. <a href="#NLSOUND_1_1USourcea1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="a03429.html#NLSOUND_1_1USourcea2">~USource</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#NLSOUND_1_1USourcea2"></a><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Source properties</div></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_0">getDirection</a> (<a class="el" href="a03128.html">NLMISC::CVector</a> &dir) const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the direction vector. <a href="#NLSOUND_1_1USourcez2139_0"></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="a03429.html#NLSOUND_1_1USourcez2139_1">getGain</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the gain. <a href="#NLSOUND_1_1USourcez2139_1"></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="a03429.html#NLSOUND_1_1USourcez2139_2">getPitch</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the pitch. <a href="#NLSOUND_1_1USourcez2139_2"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_3">getPos</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the position vector (3D mode only). <a href="#NLSOUND_1_1USourcez2139_3"></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="a03429.html#NLSOUND_1_1USourcez2139_4">getRelativeGain</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the relative gain (see <a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_11">setRelativeGain()</a>), or the absolute gain if getSource() is null. <a href="#NLSOUND_1_1USourcez2139_4"></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="a03429.html#NLSOUND_1_1USourcez2139_5">getSourceRelativeMode</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the source relative mode. <a href="#NLSOUND_1_1USourcez2139_5"></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="a03429.html#NLSOUND_1_1USourcez2139_6">getVelocity</a> (<a class="el" href="a03128.html">NLMISC::CVector</a> &vel) const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the velocity vector. <a href="#NLSOUND_1_1USourcez2139_6"></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="a03429.html#NLSOUND_1_1USourcez2139_7">setDirection</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> &dir)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the direction vector (3D mode only, ignored in stereo mode) (default: (0,0,0) as non-directional). <a href="#NLSOUND_1_1USourcez2139_7"></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="a03429.html#NLSOUND_1_1USourcez2139_8">setGain</a> (float gain)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_9">setPitch</a> (float pitch)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_10">setPos</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> &pos)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_11">setRelativeGain</a> (float gain)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_12">setSourceRelativeMode</a> (bool mode)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the source relative mode. If true, positions are interpreted relative to the listener position (default: false). <a href="#NLSOUND_1_1USourcez2139_12"></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="a03429.html#NLSOUND_1_1USourcez2139_13">setVelocity</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> &vel)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the velocity vector (3D mode only, ignored in stereo mode) (default: (0,0,0)). <a href="#NLSOUND_1_1USourcez2139_13"></a><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Playback control</div></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="a03429.html#NLSOUND_1_1USourcez2137_0">getLooping</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the looping state. <a href="#NLSOUND_1_1USourcez2137_0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a11">uint32</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03429.html#NLSOUND_1_1USourcez2137_1">getTime</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of milliseconds the source has been playing. <a href="#NLSOUND_1_1USourcez2137_1"></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="a03429.html#NLSOUND_1_1USourcez2137_2">isPlaying</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get playing state. Return false even if the source has stopped on its own. <a href="#NLSOUND_1_1USourcez2137_2"></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="a03429.html#NLSOUND_1_1USourcez2137_3">play</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Play. <a href="#NLSOUND_1_1USourcez2137_3"></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="a03429.html#NLSOUND_1_1USourcez2137_4">setLooping</a> (bool l)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set looping on/off for future playbacks (default: off). <a href="#NLSOUND_1_1USourcez2137_4"></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="a03429.html#NLSOUND_1_1USourcez2137_5">stop</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop playing. <a href="#NLSOUND_1_1USourcez2137_5"></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="a03429.html#NLSOUND_1_1USourcez2137_6">unregisterSpawnCallBack</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tells this source not to call its callbacks when it ends. This is valid for spawned sources only. <a href="#NLSOUND_1_1USourcez2137_6"></a><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a03429.html#NLSOUND_1_1USourceb0">USource</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#NLSOUND_1_1USourceb0"></a><br><br></td></tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NLSOUND_1_1USourcea2" doxytag="NLSOUND::USource::~USource" ></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 NLSOUND::USource::~<a class="el" href="a03429.html">USource</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> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Destructor. +<p> + +<p> +Definition at line <a class="el" href="a06630.html#l00177">177</a> of file <a class="el" href="a06630.html">u_source.h</a>. +<p> +<div class="fragment"><pre>00177 {} +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourceb0" doxytag="NLSOUND::USource::USource" ></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::USource::USource </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, protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> + +<p> +Definition at line <a class="el" href="a06630.html#l00182">182</a> of file <a class="el" href="a06630.html">u_source.h</a>. +<p> +<div class="fragment"><pre>00182 {} +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLSOUND_1_1USourcez2139_0" doxytag="NLSOUND::USource::getDirection" ></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::USource::getDirection </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>dir</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the direction vector. +<p> + +<p> +Implemented in <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona4">NLSOUND::CSourceCommon</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2139_1" doxytag="NLSOUND::USource::getGain" ></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::USource::getGain </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> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the gain. +<p> + +<p> +Implemented in <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona5">NLSOUND::CSourceCommon</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01576">NLSOUND::CAudioMixerUser::createSource()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2137_0" doxytag="NLSOUND::USource::getLooping" ></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 NLSOUND::USource::getLooping </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> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the looping state. +<p> + +<p> +Implemented in <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona6">NLSOUND::CSourceCommon</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2139_2" doxytag="NLSOUND::USource::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 NLSOUND::USource::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> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the pitch. +<p> + +<p> +Implemented in <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona7">NLSOUND::CSourceCommon</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01576">NLSOUND::CAudioMixerUser::createSource()</a>, and <a class="el" href="a06622.html#l00118">NL3D::CPSSoundInstanceImpl::getPitch()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2139_3" doxytag="NLSOUND::USource::getPos" ></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 const <a class="el" href="a03128.html">NLMISC::CVector</a>& NLSOUND::USource::getPos </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> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the position vector (3D mode only). +<p> + +<p> +Implemented in <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona8">NLSOUND::CSourceCommon</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2139_4" doxytag="NLSOUND::USource::getRelativeGain" ></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::USource::getRelativeGain </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> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the relative gain (see <a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_11">setRelativeGain()</a>), or the absolute gain if getSource() is null. +<p> + +<p> +Implemented in <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona10">NLSOUND::CSourceCommon</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcea0" doxytag="NLSOUND::USource::getSound" ></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 <a class="el" href="a02246.html">TSoundId</a> NLSOUND::USource::getSound </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> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the sound binded to the source (or NULL if there is no sound). +<p> + +<p> +Implemented in <a class="el" href="a02253.html#NLSOUND_1_1CBackgroundSourcea11">NLSOUND::CBackgroundSource</a>, <a class="el" href="a02394.html#NLSOUND_1_1CComplexSourcea10">NLSOUND::CComplexSource</a>, and <a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcea12">NLSOUND::CSimpleSource</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01017">NLSOUND::CAudioMixerUser::addUserControledSource()</a>, <a class="el" href="a05593.html#l00698">NLSOUND::CComplexSource::checkup()</a>, <a class="el" href="a05593.html#l00577">NLSOUND::CComplexSource::onEvent()</a>, <a class="el" href="a05593.html#l00456">NLSOUND::CComplexSource::onUpdate()</a>, <a class="el" href="a05593.html#l00105">NLSOUND::CComplexSource::playStuf()</a>, and <a class="el" href="a05473.html#l00165">NLSOUND::CBackgroundSource::updateFilterValues()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2139_5" doxytag="NLSOUND::USource::getSourceRelativeMode" ></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 NLSOUND::USource::getSourceRelativeMode </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> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the source relative mode. +<p> + +<p> +Implemented in <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona12">NLSOUND::CSourceCommon</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2137_1" doxytag="NLSOUND::USource::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 <a class="el" href="a04558.html#a11">uint32</a> NLSOUND::USource::getTime </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> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the number of milliseconds the source has been playing. +<p> + +<p> +Implemented in <a class="el" href="a02394.html#NLSOUND_1_1CComplexSourcez1301_0">NLSOUND::CComplexSource</a>, <a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1338_1">NLSOUND::CSimpleSource</a>, and <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona13">NLSOUND::CSourceCommon</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2139_6" doxytag="NLSOUND::USource::getVelocity" ></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::USource::getVelocity </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>vel</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the velocity vector. +<p> + +<p> +Implemented in <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona15">NLSOUND::CSourceCommon</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2137_2" doxytag="NLSOUND::USource::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 NLSOUND::USource::isPlaying </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> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get playing state. Return false even if the source has stopped on its own. +<p> + +<p> +Implemented in <a class="el" href="a02394.html#NLSOUND_1_1CComplexSourcez1301_1">NLSOUND::CComplexSource</a>, <a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1338_2">NLSOUND::CSimpleSource</a>, and <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona16">NLSOUND::CSourceCommon</a>. +<p> +Referenced by <a class="el" href="a05593.html#l00698">NLSOUND::CComplexSource::checkup()</a>, <a class="el" href="a06622.html#l00102">NL3D::CPSSoundInstanceImpl::isPlaying()</a>, <a class="el" href="a05473.html#l00222">NLSOUND::CBackgroundSource::onUpdate()</a>, and <a class="el" href="a05473.html#l00165">NLSOUND::CBackgroundSource::updateFilterValues()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2137_3" doxytag="NLSOUND::USource::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 NLSOUND::USource::play </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> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Play. +<p> + +<p> +Implemented in <a class="el" href="a02253.html#NLSOUND_1_1CBackgroundSourcea18">NLSOUND::CBackgroundSource</a>, <a class="el" href="a02394.html#NLSOUND_1_1CComplexSourcez1301_2">NLSOUND::CComplexSource</a>, <a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1338_3">NLSOUND::CSimpleSource</a>, and <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona18">NLSOUND::CSourceCommon</a>. +<p> +Referenced by <a class="el" href="a05593.html#l00698">NLSOUND::CComplexSource::checkup()</a>, <a class="el" href="a05593.html#l00577">NLSOUND::CComplexSource::onEvent()</a>, <a class="el" href="a05473.html#l00222">NLSOUND::CBackgroundSource::onUpdate()</a>, <a class="el" href="a06622.html#l00094">NL3D::CPSSoundInstanceImpl::play()</a>, <a class="el" href="a06410.html#l00047">NLSOUND::CSoundAnimMarker::play()</a>, <a class="el" href="a05593.html#l00105">NLSOUND::CComplexSource::playStuf()</a>, and <a class="el" href="a05473.html#l00165">NLSOUND::CBackgroundSource::updateFilterValues()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2139_7" doxytag="NLSOUND::USource::setDirection" ></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::USource::setDirection </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>dir</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the direction vector (3D mode only, ignored in stereo mode) (default: (0,0,0) as non-directional). +<p> + +<p> +Implemented in <a class="el" href="a02253.html#NLSOUND_1_1CBackgroundSourcea20">NLSOUND::CBackgroundSource</a>, <a class="el" href="a02394.html#NLSOUND_1_1CComplexSourcez1303_1">NLSOUND::CComplexSource</a>, <a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_4">NLSOUND::CSimpleSource</a>, and <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona20">NLSOUND::CSourceCommon</a>. +<p> +Referenced by <a class="el" href="a05593.html#l00338">NLSOUND::CComplexSource::setDirection()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2139_8" doxytag="NLSOUND::USource::setGain" ></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::USource::setGain </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname1" valign="top" nowrap> <em>gain</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the gain (volume value inside [0 , 1]). (default: 1) 0.0 -> silence 0.5 -> -6dB 1.0 -> no attenuation values > 1 (amplification) not supported by most drivers +<p> +Implemented in <a class="el" href="a02253.html#NLSOUND_1_1CBackgroundSourcea21">NLSOUND::CBackgroundSource</a>, <a class="el" href="a02394.html#NLSOUND_1_1CComplexSourcez1303_2">NLSOUND::CComplexSource</a>, <a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_5">NLSOUND::CSimpleSource</a>, and <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona21">NLSOUND::CSourceCommon</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01576">NLSOUND::CAudioMixerUser::createSource()</a>, and <a class="el" href="a05473.html#l00165">NLSOUND::CBackgroundSource::updateFilterValues()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2137_4" doxytag="NLSOUND::USource::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 NLSOUND::USource::setLooping </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>l</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set looping on/off for future playbacks (default: off). +<p> + +<p> +Implemented in <a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1338_4">NLSOUND::CSimpleSource</a>, and <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona22">NLSOUND::CSourceCommon</a>. +<p> +Referenced by <a class="el" href="a06622.html#l00178">NL3D::CPSSoundServImpl::createSound()</a>, <a class="el" href="a06622.html#l00126">NL3D::CPSSoundInstanceImpl::setLooping()</a>, and <a class="el" href="a05565.html#l00270">NLSOUND::CClusteredSound::update()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2139_9" doxytag="NLSOUND::USource::setPitch" ></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::USource::setPitch </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname1" valign="top" nowrap> <em>pitch</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Shift the frequency. 1.0f equals identity, each reduction of 50% equals a pitch shift of one octave. 0 is not a legal value. +<p> +Implemented in <a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_6">NLSOUND::CSimpleSource</a>, and <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona23">NLSOUND::CSourceCommon</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01576">NLSOUND::CAudioMixerUser::createSource()</a>, <a class="el" href="a05593.html#l00577">NLSOUND::CComplexSource::onEvent()</a>, <a class="el" href="a05593.html#l00105">NLSOUND::CComplexSource::playStuf()</a>, <a class="el" href="a06622.html#l00076">NL3D::CPSSoundInstanceImpl::setSoundParams()</a>, and <a class="el" href="a05473.html#l00165">NLSOUND::CBackgroundSource::updateFilterValues()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2139_10" doxytag="NLSOUND::USource::setPos" ></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::USource::setPos </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>pos</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the position vector (default: (0,0,0)). 3D mode -> 3D position st mode -> x is the pan value (from left (-1) to right (1)), set y and z to 0 +<p> +Implemented in <a class="el" href="a02253.html#NLSOUND_1_1CBackgroundSourcea24">NLSOUND::CBackgroundSource</a>, <a class="el" href="a02394.html#NLSOUND_1_1CComplexSourcez1303_3">NLSOUND::CComplexSource</a>, <a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_7">NLSOUND::CSimpleSource</a>, and <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona24">NLSOUND::CSourceCommon</a>. +<p> +Referenced by <a class="el" href="a05593.html#l00577">NLSOUND::CComplexSource::onEvent()</a>, <a class="el" href="a06410.html#l00047">NLSOUND::CSoundAnimMarker::play()</a>, <a class="el" href="a05593.html#l00105">NLSOUND::CComplexSource::playStuf()</a>, <a class="el" href="a05593.html#l00303">NLSOUND::CComplexSource::setPos()</a>, <a class="el" href="a06622.html#l00076">NL3D::CPSSoundInstanceImpl::setSoundParams()</a>, <a class="el" href="a05565.html#l00270">NLSOUND::CClusteredSound::update()</a>, and <a class="el" href="a05473.html#l00165">NLSOUND::CBackgroundSource::updateFilterValues()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcea1" doxytag="NLSOUND::USource::setPriority" ></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::USource::setPriority </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a05381.html#a82">TSoundPriority</a> </td> + <td class="mdname1" valign="top" nowrap> <em>pr</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Change the priority of the source. +<p> + +<p> +Implemented in <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona25">NLSOUND::CSourceCommon</a>. +<p> +Referenced by <a class="el" href="a05593.html#l00577">NLSOUND::CComplexSource::onEvent()</a>, <a class="el" href="a05473.html#l00119">NLSOUND::CBackgroundSource::play()</a>, and <a class="el" href="a05593.html#l00105">NLSOUND::CComplexSource::playStuf()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2139_11" doxytag="NLSOUND::USource::setRelativeGain" ></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::USource::setRelativeGain </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname1" valign="top" nowrap> <em>gain</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the gain amount (value inside [0, 1]) to map between 0 and the nominal gain (which is getSource()-><a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_1">getGain()</a>). Does nothing if getSource() is null. +<p> +Implemented in <a class="el" href="a02253.html#NLSOUND_1_1CBackgroundSourcea26">NLSOUND::CBackgroundSource</a>, <a class="el" href="a02394.html#NLSOUND_1_1CComplexSourcez1303_4">NLSOUND::CComplexSource</a>, <a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_8">NLSOUND::CSimpleSource</a>, and <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona26">NLSOUND::CSourceCommon</a>. +<p> +Referenced by <a class="el" href="a05593.html#l00577">NLSOUND::CComplexSource::onEvent()</a>, <a class="el" href="a05593.html#l00456">NLSOUND::CComplexSource::onUpdate()</a>, <a class="el" href="a06410.html#l00047">NLSOUND::CSoundAnimMarker::play()</a>, <a class="el" href="a05593.html#l00105">NLSOUND::CComplexSource::playStuf()</a>, <a class="el" href="a05593.html#l00358">NLSOUND::CComplexSource::setGain()</a>, <a class="el" href="a05593.html#l00390">NLSOUND::CComplexSource::setRelativeGain()</a>, <a class="el" href="a06622.html#l00076">NL3D::CPSSoundInstanceImpl::setSoundParams()</a>, <a class="el" href="a05565.html#l00270">NLSOUND::CClusteredSound::update()</a>, and <a class="el" href="a05473.html#l00165">NLSOUND::CBackgroundSource::updateFilterValues()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2139_12" doxytag="NLSOUND::USource::setSourceRelativeMode" ></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::USource::setSourceRelativeMode </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>mode</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the source relative mode. If true, positions are interpreted relative to the listener position (default: false). +<p> + +<p> +Implemented in <a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_9">NLSOUND::CSimpleSource</a>, and <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona27">NLSOUND::CSourceCommon</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2139_13" doxytag="NLSOUND::USource::setVelocity" ></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::USource::setVelocity </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>vel</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the velocity vector (3D mode only, ignored in stereo mode) (default: (0,0,0)). +<p> + +<p> +Implemented in <a class="el" href="a02253.html#NLSOUND_1_1CBackgroundSourcea28">NLSOUND::CBackgroundSource</a>, <a class="el" href="a02394.html#NLSOUND_1_1CComplexSourcez1303_5">NLSOUND::CComplexSource</a>, <a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_10">NLSOUND::CSimpleSource</a>, and <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona28">NLSOUND::CSourceCommon</a>. +<p> +Referenced by <a class="el" href="a06622.html#l00076">NL3D::CPSSoundInstanceImpl::setSoundParams()</a>, and <a class="el" href="a05593.html#l00319">NLSOUND::CComplexSource::setVelocity()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2137_5" doxytag="NLSOUND::USource::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 NLSOUND::USource::stop </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> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Stop playing. +<p> + +<p> +Implemented in <a class="el" href="a02253.html#NLSOUND_1_1CBackgroundSourcea29">NLSOUND::CBackgroundSource</a>, <a class="el" href="a02394.html#NLSOUND_1_1CComplexSourcez1301_3">NLSOUND::CComplexSource</a>, <a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1338_5">NLSOUND::CSimpleSource</a>, and <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona29">NLSOUND::CSourceCommon</a>. +<p> +Referenced by <a class="el" href="a06622.html#l00110">NL3D::CPSSoundInstanceImpl::stop()</a>, <a class="el" href="a05593.html#l00255">NLSOUND::CComplexSource::stop()</a>, and <a class="el" href="a05473.html#l00165">NLSOUND::CBackgroundSource::updateFilterValues()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1USourcez2137_6" doxytag="NLSOUND::USource::unregisterSpawnCallBack" ></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::USource::unregisterSpawnCallBack </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> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Tells this source not to call its callbacks when it ends. This is valid for spawned sources only. +<p> + +<p> +Implemented in <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona30">NLSOUND::CSourceCommon</a>. +<p> +Referenced by <a class="el" href="a06622.html#l00217">NL3D::CPSSoundInstanceImpl::release()</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="a06630.html">u_source.h</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 14:54:00 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> |