diff options
| author | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
|---|---|---|
| committer | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
| commit | 0ea5fc66924303d1bf73ba283a383e2aadee02f2 (patch) | |
| tree | 2568e71a7ccc44ec23b8bb3f0ff97fb6bf2ed709 /docs/doxygen/nel/a03395.html | |
| download | nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.tar.xz nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.zip | |
Initial commit
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/a03395.html | 2581 |
1 files changed, 2581 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03395.html b/docs/doxygen/nel/a03395.html new file mode 100644 index 00000000..28c31f3f --- /dev/null +++ b/docs/doxygen/nel/a03395.html @@ -0,0 +1,2581 @@ +<!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::CSimpleSource 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::CSimpleSource Class Reference</h1><code>#include <<a class="el" href="a06391.html">simple_source.h</a>></code> +<p> +<p>Inheritance diagram for NLSOUND::CSimpleSource: +<p><center><img src="a03395.png" usemap="#NLSOUND::CSimpleSource_map" border="0" alt=""></center> +<map name="NLSOUND::CSimpleSource_map"> +<area href="a02254.html" alt="NLSOUND::CSourceCommon" shape="rect" coords="0,56,251,80"> +<area href="a02238.html" alt="NLSOUND::CAudioMixerUser::IMixerEvent" shape="rect" coords="261,56,512,80"> +<area href="a03429.html" alt="NLSOUND::USource" shape="rect" coords="0,0,251,24"> +<area href="a02425.html" alt="NLMISC::CDbgRefCount< IMixerEvent >" shape="rect" coords="261,0,512,24"> +</map> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Implementation of <a class="el" href="a03429.html">USource</a> <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="a06391.html#l00052">52</a> of file <a class="el" href="a06391.html">simple_source.h</a>.<table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Source properties</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a02298.html">IBuffer</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_0">getBuffer</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a05381.html#a63">TSpawnEndCallback</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_1">getSpawnEndCallback</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the spawn end callback. <a href="#NLSOUND_1_1CSimpleSourcez1340_1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03540.html">CTrack</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_2">getTrack</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the track. <a href="#NLSOUND_1_1CSimpleSourcez1340_2"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03128.html">NLMISC::CVector</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_3">getVirtualPos</a> () const </td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_4">setDirection</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> &dir)</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_1CSimpleSourcez1340_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="a03395.html#NLSOUND_1_1CSimpleSourcez1340_5">setGain</a> (float gain)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_6">setPitch</a> (float pitch)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_7">setPos</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> &pos)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_8">setRelativeGain</a> (float gain)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_9">setSourceRelativeMode</a> (bool mode)</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_1CSimpleSourcez1340_9"></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="a03395.html#NLSOUND_1_1CSimpleSourcez1340_10">setVelocity</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> &vel)</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_1CSimpleSourcez1340_10"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonw3">TSOURCE_TYPE</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_11">getType</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the type the the source. <a href="#NLSOUND_1_1CSimpleSourcez1340_11"></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="a03395.html#NLSOUND_1_1CSimpleSourcez1340_12">onEvent</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_13">_Alpha</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_14">_PlayMuted</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03394.html">CSimpleSound</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03540.html">CTrack</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a></td></tr> + +<tr><td colspan=2><br><h2>Public Types</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonw3">TSOURCE_TYPE</a> { <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonw3NLSOUND_1_1CSourceCommonw2">SOURCE_SIMPLE</a>, +<a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonw3NLSOUND_1_1CSourceCommonw1">SOURCE_COMPLEX</a>, +<a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonw3NLSOUND_1_1CSourceCommonw0">SOURCE_BACKGROUND</a> + }</td></tr> + +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona0">checkup</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcea1">CSimpleSource</a> (<a class="el" href="a03394.html">CSimpleSound</a> *simpleSound=NULL, bool spawn=false, <a class="el" href="a05381.html#a63">TSpawnEndCallback</a> cb=0, void *cbUserParam=0, <a class="el" href="a02362.html">NL3D::CCluster</a> *cluster=0)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#NLSOUND_1_1CSimpleSourcea1"></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="a02254.html#NLSOUND_1_1CSourceCommona2">getCallbackUserParam</a> (void) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">return the user param for the user callback <a href="#NLSOUND_1_1CSourceCommona2"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02362.html">NL3D::CCluster</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona3">getCluster</a> () const </td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona4">getDirection</a> (<a class="el" href="a03128.html">NLMISC::CVector</a> &dir) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the direction vector. <a href="#NLSOUND_1_1CSourceCommona4"></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="a02254.html#NLSOUND_1_1CSourceCommona5">getGain</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the gain. <a href="#NLSOUND_1_1CSourceCommona5"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona6">getLooping</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the looping state. <a href="#NLSOUND_1_1CSourceCommona6"></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="a02254.html#NLSOUND_1_1CSourceCommona7">getPitch</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the pitch. <a href="#NLSOUND_1_1CSourceCommona7"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona8">getPos</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the position vector (3D mode only). <a href="#NLSOUND_1_1CSourceCommona8"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a05381.html#a82">TSoundPriority</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona9">getPriority</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the priority. <a href="#NLSOUND_1_1CSourceCommona9"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona10">getRelativeGain</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the relative gain (see <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona26">setRelativeGain()</a>), or the absolute gain if getSource() is null. <a href="#NLSOUND_1_1CSourceCommona10"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03394.html">CSimpleSound</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcea11">getSimpleSound</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the simple sound bound to the source (or NULL). <a href="#NLSOUND_1_1CSimpleSourcea11"></a><br><br></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="a03395.html#NLSOUND_1_1CSimpleSourcea12">getSound</a> ()</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_1CSimpleSourcea12"></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="a02254.html#NLSOUND_1_1CSourceCommona12">getSourceRelativeMode</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the source relative mode. <a href="#NLSOUND_1_1CSourceCommona12"></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="a02254.html#NLSOUND_1_1CSourceCommona15">getVelocity</a> (<a class="el" href="a03128.html">NLMISC::CVector</a> &vel) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the velocity vector. <a href="#NLSOUND_1_1CSourceCommona15"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona17">isSpawn</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the spawn state. <a href="#NLSOUND_1_1CSourceCommona17"></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="a02254.html#NLSOUND_1_1CSourceCommona19">set3DPositionVector</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> *pos)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the position vector to return for a stereo source (default: NULL). <a href="#NLSOUND_1_1CSourceCommona19"></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="a02254.html#NLSOUND_1_1CSourceCommona25">setPriority</a> (<a class="el" href="a05381.html#a82">TSoundPriority</a> pr)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the priority of the source. <a href="#NLSOUND_1_1CSourceCommona25"></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="a02254.html#NLSOUND_1_1CSourceCommona30">unregisterSpawnCallBack</a> ()</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_1CSourceCommona30"></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="a03395.html#NLSOUND_1_1CSimpleSourcea19">~CSimpleSource</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#NLSOUND_1_1CSimpleSourcea19"></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 <a class="el" href="a05378.html#a243">NLMISC::TTicks</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1338_0">getPlayTime</a> ()</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="a03395.html#NLSOUND_1_1CSimpleSourcez1338_1">getTime</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of milliseconds the source has been playing. <a href="#NLSOUND_1_1CSimpleSourcez1338_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="a03395.html#NLSOUND_1_1CSimpleSourcez1338_2">isPlaying</a> ()</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_1CSimpleSourcez1338_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="a03395.html#NLSOUND_1_1CSimpleSourcez1338_3">play</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Play. <a href="#NLSOUND_1_1CSimpleSourcez1338_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="a03395.html#NLSOUND_1_1CSimpleSourcez1338_4">setLooping</a> (bool l)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set looping on/off for future playbacks (default: off). <a href="#NLSOUND_1_1CSimpleSourcez1338_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="a03395.html#NLSOUND_1_1CSimpleSourcez1338_5">stop</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop playing. <a href="#NLSOUND_1_1CSimpleSourcez1338_5"></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>const <a class="el" href="a03128.html">NLMISC::CVector</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp0">_3DPosition</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void * </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp1">_CbUserParam</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02362.html">NL3D::CCluster</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp2">_Cluster</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03128.html">NLMISC::CVector</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp3">_Direction</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp4">_Gain</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp5">_InitialGain</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Gain not affected by setRelativeGain and used to compute _Gain. <a href="#NLSOUND_1_1CSourceCommonp5"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp6">_Looping</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp7">_Pitch</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp8">_Playing</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a05378.html#a242">NLMISC::TTime</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp9">_PlayStart</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03128.html">NLMISC::CVector</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp10">_Position</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a05381.html#a82">TSoundPriority</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp11">_Priority</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp12">_RelativeMode</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>const bool </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp13">_Spawn</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a05381.html#a63">TSpawnEndCallback</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp14">_SpawnEndCb</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a05378.html#a236">NLMISC::TStringId</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp15">_UserVarControler</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">An optional user var controler. <a href="#NLSOUND_1_1CSourceCommonp15"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03128.html">NLMISC::CVector</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp16">_Velocity</a></td></tr> + +</table> +<hr><h2>Member Enumeration Documentation</h2> +<a class="anchor" name="NLSOUND_1_1CSourceCommonw3" doxytag="NLSOUND::CSimpleSource::TSOURCE_TYPE" ></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"> enum <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonw3">NLSOUND::CSourceCommon::TSOURCE_TYPE</a><code> [inherited]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<dl compact><dt><b>Enumeration values: </b></dt><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em><a class="anchor" name="NLSOUND_1_1CSourceCommonw3NLSOUND_1_1CSourceCommonw2" doxytag="SOURCE_SIMPLE" ></a>SOURCE_SIMPLE</em> </td><td> +</td></tr> +<tr><td valign=top><em><a class="anchor" name="NLSOUND_1_1CSourceCommonw3NLSOUND_1_1CSourceCommonw1" doxytag="SOURCE_COMPLEX" ></a>SOURCE_COMPLEX</em> </td><td> +</td></tr> +<tr><td valign=top><em><a class="anchor" name="NLSOUND_1_1CSourceCommonw3NLSOUND_1_1CSourceCommonw0" doxytag="SOURCE_BACKGROUND" ></a>SOURCE_BACKGROUND</em> </td><td> +</td></tr> +</table> +</dl> + +<p> +Definition at line <a class="el" href="a06428.html#l00042">42</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +<div class="fragment"><pre>00043 { +00044 <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonw3NLSOUND_1_1CSourceCommonw2">SOURCE_SIMPLE</a>, +00045 <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonw3NLSOUND_1_1CSourceCommonw1">SOURCE_COMPLEX</a>, +00046 <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonw3NLSOUND_1_1CSourceCommonw0">SOURCE_BACKGROUND</a> +00047 }; +</pre></div> </td> + </tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcea1" doxytag="NLSOUND::CSimpleSource::CSimpleSource" ></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::CSimpleSource::CSimpleSource </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a03394.html">CSimpleSound</a> * </td> + <td class="mdname" nowrap> <em>simpleSound</em> = NULL, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>spawn</em> = false, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a05381.html#a63">TSpawnEndCallback</a> </td> + <td class="mdname" nowrap> <em>cb</em> = 0, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>cbUserParam</em> = 0, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a02362.html">NL3D::CCluster</a> * </td> + <td class="mdname" nowrap> <em>cluster</em> = 0</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></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="a06390.html#l00045">45</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +References <a class="el" href="a06391.html#l00144">_Sound</a>, <a class="el" href="a06389.html#l00069">NLSOUND::CSimpleSound::getAlpha()</a>, <a class="el" href="a05622.html#l00290">nlassert</a>, and <a class="el" href="a06630.html#l00076">NLSOUND::TSpawnEndCallback</a>. +<p> +<div class="fragment"><pre>00046 : <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommona1">CSourceCommon</a>(simpleSound, spawn, cb, cbUserParam, cluster), +00047 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>(NULL), <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_14">_PlayMuted</a>(<span class="keyword">false</span>) +00048 { +00049 <a class="code" href="a04199.html#a6">nlassert</a>(simpleSound != 0); +00050 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a> = simpleSound; +00051 +00052 <span class="comment">// get a local copy of the simple sound parameter</span> +00053 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_13">_Alpha</a> = <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a>->getAlpha(); +00054 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcea19" doxytag="NLSOUND::CSimpleSource::~CSimpleSource" ></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::CSimpleSource::~<a class="el" href="a03395.html">CSimpleSource</a> </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Destructor. +<p> + +<p> +Definition at line <a class="el" href="a06390.html#l00060">60</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +References <a class="el" href="a06390.html#l00217">stop()</a>. +<p> +<div class="fragment"><pre>00061 { +00062 <span class="keywordflow">if</span> (<a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp8">_Playing</a>) +00063 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1338_5">stop</a>(); +00064 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLSOUND_1_1CSourceCommona0" doxytag="NLSOUND::CSimpleSource::checkup" ></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::CSourceCommon::checkup </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, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This method is called from backgroup sound to check if subsound need to be restarted (ie subsound in loop mode). +<p> +Reimplemented in <a class="el" href="a02394.html#NLSOUND_1_1CComplexSourcez1303_0">NLSOUND::CComplexSource</a>. +<p> +Definition at line <a class="el" href="a06428.html#l00103">103</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="a05471.html#l00861">NLSOUND::CBackgroundSoundManager::updateBackgroundStatus()</a>. +<p> +<div class="fragment"><pre>00103 {}; +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1340_0" doxytag="NLSOUND::CSimpleSource::getBuffer" ></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="a02298.html">IBuffer</a> * NLSOUND::CSimpleSource::getBuffer </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06390.html#l00082">82</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +References <a class="el" href="a06391.html#l00144">_Sound</a>, and <a class="el" href="a06388.html#l00093">NLSOUND::CSimpleSound::getBuffer()</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01052">NLSOUND::CAudioMixerUser::bufferUnloaded()</a>, and <a class="el" href="a05465.html#l01576">NLSOUND::CAudioMixerUser::createSource()</a>. +<p> +<div class="fragment"><pre>00083 { +00084 <span class="keywordflow">return</span> <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a>->getBuffer(); +00085 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommona2" doxytag="NLSOUND::CSimpleSource::getCallbackUserParam" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void* NLSOUND::CSourceCommon::getCallbackUserParam </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, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +return the user param for the user callback +<p> + +<p> +Definition at line <a class="el" href="a06428.html#l00074">74</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +References <a class="el" href="a06428.html#l00130">NLSOUND::CSourceCommon::_CbUserParam</a>. +<p> +<div class="fragment"><pre>00074 { <span class="keywordflow">return</span> <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp1">_CbUserParam</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommona3" doxytag="NLSOUND::CSimpleSource::getCluster" ></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="a02362.html">NL3D::CCluster</a>* NLSOUND::CSourceCommon::getCluster </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, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06428.html#l00098">98</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +References <a class="el" href="a06428.html#l00131">NLSOUND::CSourceCommon::_Cluster</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00103">getVirtualPos()</a>, and <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>. +<p> +<div class="fragment"><pre>00098 { <span class="keywordflow">return</span> <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp2">_Cluster</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommona4" doxytag="NLSOUND::CSimpleSource::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::CSourceCommon::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> [inline, virtual, inherited]</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> +Implements <a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_0">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="a06428.html#l00080">80</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +<div class="fragment"><pre>00080 { dir = <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp3">_Direction</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommona5" doxytag="NLSOUND::CSimpleSource::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::CSourceCommon::getGain </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, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the gain. +<p> + +<p> +Implements <a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_1">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="a06428.html#l00082">82</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>. +<p> +<div class="fragment"><pre>00082 { <span class="keywordflow">return</span> <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp4">_Gain</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommona6" doxytag="NLSOUND::CSimpleSource::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"> bool NLSOUND::CSourceCommon::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> [virtual, inherited]</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> +Implements <a class="el" href="a03429.html#NLSOUND_1_1USourcez2137_0">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="a06427.html#l00099">99</a> of file <a class="el" href="a06427.html">source_common.cpp</a>. +<p> +<div class="fragment"><pre>00100 { +00101 <span class="keywordflow">return</span> <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp6">_Looping</a>; +00102 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommona7" doxytag="NLSOUND::CSimpleSource::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::CSourceCommon::getPitch </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, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the pitch. +<p> + +<p> +Implements <a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_2">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="a06428.html#l00084">84</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +<div class="fragment"><pre>00084 { <span class="keywordflow">return</span> <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp7">_Pitch</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1338_0" doxytag="NLSOUND::CSimpleSource::getPlayTime" ></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="a05378.html#a243">NLMISC::TTicks</a> NLSOUND::CSimpleSource::getPlayTime </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> + +<p> +Definition at line <a class="el" href="a06391.html#l00084">84</a> of file <a class="el" href="a06391.html">simple_source.h</a>. +<p> +References <a class="el" href="a06390.html#l00071">getTime()</a>, and <a class="el" href="a06553.html#l00048">NLMISC::TTicks</a>. +<p> +<div class="fragment"><pre>00084 { <span class="keywordflow">return</span> <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1338_1">getTime</a>(); } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommona8" doxytag="NLSOUND::CSimpleSource::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"> const <a class="el" href="a03128.html">NLMISC::CVector</a> & NLSOUND::CSourceCommon::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> [virtual, inherited]</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> +Implements <a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_3">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="a06427.html#l00141">141</a> of file <a class="el" href="a06427.html">source_common.cpp</a>. +<p> +References <a class="el" href="a06428.html#l00125">NLSOUND::CSourceCommon::_3DPosition</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01152">NLSOUND::CAudioMixerUser::getFreeTrack()</a>, <a class="el" href="a05465.html#l01230">NLSOUND::CAudioMixerUser::getPlayingSoundsPos()</a>, <a class="el" href="a06390.html#l00103">getVirtualPos()</a>, <a class="el" href="a05465.html#l01946">NLSOUND::CompareSources::operator()()</a>, and <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>. +<p> +<div class="fragment"><pre>00142 { +00143 <span class="keywordflow">if</span> ( <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp0">_3DPosition</a> == NULL ) +00144 { +00145 <span class="keywordflow">return</span> <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp10">_Position</a>; +00146 } +00147 <span class="keywordflow">else</span> +00148 { +00149 <span class="keywordflow">return</span> *<a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp0">_3DPosition</a>; +00150 } +00151 +00152 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommona9" doxytag="NLSOUND::CSimpleSource::getPriority" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a05381.html#a82">TSoundPriority</a> NLSOUND::CSourceCommon::getPriority </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, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the priority. +<p> + +<p> +Definition at line <a class="el" href="a06428.html#l00059">59</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +References <a class="el" href="a06630.html#l00072">NLSOUND::TSoundPriority</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01217">NLSOUND::CAudioMixerUser::freeTrack()</a>, <a class="el" href="a05465.html#l01152">NLSOUND::CAudioMixerUser::getFreeTrack()</a>, and <a class="el" href="a05465.html#l01946">NLSOUND::CompareSources::operator()()</a>. +<p> +<div class="fragment"><pre>00059 { <span class="keywordflow">return</span> <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp11">_Priority</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommona10" doxytag="NLSOUND::CSimpleSource::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"> float NLSOUND::CSourceCommon::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> [virtual, inherited]</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="a02254.html#NLSOUND_1_1CSourceCommona26">setRelativeGain()</a>), or the absolute gain if getSource() is null. +<p> + +<p> +Implements <a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_4">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="a06427.html#l00205">205</a> of file <a class="el" href="a06427.html">source_common.cpp</a>. +<p> +References <a class="el" href="a06428.html#l00119">NLSOUND::CSourceCommon::_InitialGain</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01017">NLSOUND::CAudioMixerUser::addUserControledSource()</a>, and <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>. +<p> +<div class="fragment"><pre>00206 { +00207 <span class="keywordflow">if</span> (<a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp5">_InitialGain</a> == 0.0f) +00208 <span class="keywordflow">return</span> 0.0f; +00209 <span class="keywordflow">else</span> +00210 <span class="keywordflow">return</span> <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp4">_Gain</a> / <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp5">_InitialGain</a>; +00211 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcea11" doxytag="NLSOUND::CSimpleSource::getSimpleSound" ></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="a03394.html">CSimpleSound</a> * NLSOUND::CSimpleSource::getSimpleSound </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the simple sound bound to the source (or NULL). +<p> + +<p> +Definition at line <a class="el" href="a06390.html#l00066">66</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +References <a class="el" href="a06391.html#l00144">_Sound</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01152">NLSOUND::CAudioMixerUser::getFreeTrack()</a>. +<p> +<div class="fragment"><pre>00067 { +00068 <span class="keywordflow">return</span> <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a>; +00069 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcea12" doxytag="NLSOUND::CSimpleSource::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::CSimpleSource::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> [inline, 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> +Implements <a class="el" href="a03429.html#NLSOUND_1_1USourcea0">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="a06391.html#l00069">69</a> of file <a class="el" href="a06391.html">simple_source.h</a>. +<p> +References <a class="el" href="a06391.html#l00144">_Sound</a>, and <a class="el" href="a06630.html#l00069">NLSOUND::TSoundId</a>. +<p> +Referenced by <a class="el" href="a05427.html#l00130">NLSOUND::CAmbiantSource::enable()</a>, and <a class="el" href="a05427.html#l00239">NLSOUND::CAmbiantSource::update()</a>. +<p> +<div class="fragment"><pre>00069 { <span class="keywordflow">return</span> <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommona12" doxytag="NLSOUND::CSimpleSource::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::CSourceCommon::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> [inline, virtual, inherited]</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> +Implements <a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_5">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="a06428.html#l00086">86</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +References <a class="el" href="a06428.html#l00116">NLSOUND::CSourceCommon::_RelativeMode</a>. +<p> +<div class="fragment"><pre>00086 { <span class="keywordflow">return</span> <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp12">_RelativeMode</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1340_1" doxytag="NLSOUND::CSimpleSource::getSpawnEndCallback" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a05381.html#a63">TSpawnEndCallback</a> NLSOUND::CSimpleSource::getSpawnEndCallback </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]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the spawn end callback. +<p> + +<p> +Definition at line <a class="el" href="a06391.html#l00131">131</a> of file <a class="el" href="a06391.html">simple_source.h</a>. +<p> +References <a class="el" href="a06630.html#l00076">NLSOUND::TSpawnEndCallback</a>. +<p> +<div class="fragment"><pre>00131 { <span class="keywordflow">return</span> <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp14">_SpawnEndCb</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1338_1" doxytag="NLSOUND::CSimpleSource::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"> <a class="el" href="a04558.html#a11">uint32</a> NLSOUND::CSimpleSource::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> [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> +Reimplemented from <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona13">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="a06390.html#l00071">71</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +References <a class="el" href="a06391.html#l00150">_Track</a>, <a class="el" href="a06037.html#l00071">NLSOUND::CTrack::DrvSource</a>, <a class="el" href="a06424.html#l00101">NLSOUND::ISource::getTime()</a>, and <a class="el" href="a05981.html#l00100">uint32</a>. +<p> +Referenced by <a class="el" href="a06391.html#l00084">getPlayTime()</a>. +<p> +<div class="fragment"><pre>00072 { +00073 <span class="keywordflow">if</span> (<a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a> && <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource) +00074 { +00075 <span class="keywordflow">return</span> <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->getTime(); +00076 } +00077 <span class="keywordflow">else</span> +00078 <span class="keywordflow">return</span> 0; +00079 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1340_2" doxytag="NLSOUND::CSimpleSource::getTrack" ></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="a03540.html">CTrack</a>* NLSOUND::CSimpleSource::getTrack </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> +Return the track. +<p> + +<p> +Definition at line <a class="el" href="a06391.html#l00129">129</a> of file <a class="el" href="a06391.html">simple_source.h</a>. +<p> +References <a class="el" href="a06391.html#l00150">_Track</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01230">NLSOUND::CAudioMixerUser::getPlayingSoundsPos()</a>, and <a class="el" href="a05427.html#l00239">NLSOUND::CAmbiantSource::update()</a>. +<p> +<div class="fragment"><pre>00129 { <span class="keywordflow">return</span> <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1340_11" doxytag="NLSOUND::CSimpleSource::getType" ></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="a02254.html#NLSOUND_1_1CSourceCommonw3">TSOURCE_TYPE</a> NLSOUND::CSimpleSource::getType </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, private, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the type the the source. +<p> + +<p> +Implements <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona14">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="a06391.html#l00141">141</a> of file <a class="el" href="a06391.html">simple_source.h</a>. +<p> +<div class="fragment"><pre>00141 {<span class="keywordflow">return</span> <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonw3NLSOUND_1_1CSourceCommonw2">SOURCE_SIMPLE</a>;} +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommona15" doxytag="NLSOUND::CSimpleSource::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::CSourceCommon::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> [inline, virtual, inherited]</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> +Implements <a class="el" href="a03429.html#NLSOUND_1_1USourcez2139_6">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="a06428.html#l00078">78</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +References <a class="el" href="a06428.html#l00112">NLSOUND::CSourceCommon::_Velocity</a>. +<p> +<div class="fragment"><pre>00078 { vel = <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp16">_Velocity</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1340_3" doxytag="NLSOUND::CSimpleSource::getVirtualPos" ></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"> CVector NLSOUND::CSimpleSource::getVirtualPos </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</td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the virtual source position. This method compute the virtual source position with cluster system. +<p> +Definition at line <a class="el" href="a06390.html#l00103">103</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +References <a class="el" href="a05566.html#l00075">NLSOUND::CClusteredSound::CClusterSoundStatus::Direction</a>, <a class="el" href="a05566.html#l00067">NLSOUND::CClusteredSound::CClusterSoundStatus::Dist</a>, <a class="el" href="a06428.html#l00098">NLSOUND::CSourceCommon::getCluster()</a>, <a class="el" href="a06427.html#l00141">NLSOUND::CSourceCommon::getPos()</a>, <a class="el" href="a05566.html#l00073">NLSOUND::CClusteredSound::CClusterSoundStatus::PosAlpha</a>, and <a class="el" href="a05566.html#l00071">NLSOUND::CClusteredSound::CClusterSoundStatus::Position</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01230">NLSOUND::CAudioMixerUser::getPlayingSoundsPos()</a>, <a class="el" href="a06390.html#l00126">play()</a>, and <a class="el" href="a06390.html#l00258">setPos()</a>. +<p> +<div class="fragment"><pre>00104 { +00105 <span class="keywordflow">if</span> (<a class="code" href="a02254.html#NLSOUND_1_1CSourceCommona3">getCluster</a>() != 0) +00106 { +00107 <span class="comment">// need to check the cluster status</span> +00108 <span class="keyword">const</span> CClusteredSound::CClusterSoundStatus *css = CAudioMixerUser::instance()->getClusteredSound()->getClusterSoundStatus(<a class="code" href="a02254.html#NLSOUND_1_1CSourceCommona3">getCluster</a>()); +00109 <span class="keywordflow">if</span> (css != 0) +00110 { +00111 <span class="comment">// there is some data here, update the virtual position of the sound.</span> +00112 <span class="keywordtype">float</span> dist = (css->Position - <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommona8">getPos</a>()).norm(); +00113 CVector vpos(CAudioMixerUser::instance()->getListenPosVector() + css->Direction * (css->Dist + dist)); +00114 vpos = <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp10">_Position</a> * (1-css->PosAlpha) + vpos*(css->PosAlpha); +00115 <span class="keywordflow">return</span> vpos; +00116 } +00117 } +00118 +00119 <span class="keywordflow">return</span> <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp10">_Position</a>; +00120 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1338_2" doxytag="NLSOUND::CSimpleSource::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"> bool NLSOUND::CSimpleSource::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> [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> +Reimplemented from <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona16">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="a06390.html#l00381">381</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01230">NLSOUND::CAudioMixerUser::getPlayingSoundsPos()</a>. +<p> +<div class="fragment"><pre>00382 { +00383 <span class="keywordflow">return</span> <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp8">_Playing</a>; +00384 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommona17" doxytag="NLSOUND::CSimpleSource::isSpawn" ></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 NLSOUND::CSourceCommon::isSpawn </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, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the spawn state. +<p> + +<p> +Definition at line <a class="el" href="a06428.html#l00090">90</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +<div class="fragment"><pre>00090 { <span class="keywordflow">return</span> <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp13">_Spawn</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1340_12" doxytag="NLSOUND::CSimpleSource::onEvent" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSimpleSource::onEvent </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> [private, 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="a02238.html#NLSOUND_1_1CAudioMixerUser_1_1IMixerEventa0">NLSOUND::CAudioMixerUser::IMixerEvent</a>. +<p> +Definition at line <a class="el" href="a06390.html#l00200">200</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +References <a class="el" href="a06391.html#l00152">_PlayMuted</a>, and <a class="el" href="a06390.html#l00217">stop()</a>. +<p> +<div class="fragment"><pre>00201 { +00202 <span class="comment">// nldebug("CSimpleSource %p : stop EVENT", (CAudioMixerUser::IMixerEvent*)this);</span> +00203 <span class="comment">// A muted play is terminated.</span> +00204 <span class="keywordflow">if</span> (!<a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp8">_Playing</a>) +00205 <span class="keywordflow">return</span>; +00206 <span class="comment">// nlassert(_Playing);</span> +00207 <span class="comment">// nlassert(_Track == 0);</span> +00208 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_14">_PlayMuted</a> = <span class="keyword">false</span>; +00209 CAudioMixerUser::instance()->decPlayingSourceMuted(); +00210 +00211 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1338_5">stop</a>(); +00212 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1338_3" doxytag="NLSOUND::CSimpleSource::play" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSimpleSource::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> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Play. +<p> + +<p> +Reimplemented from <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona18">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="a06390.html#l00126">126</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +References <a class="el" href="a06391.html#l00152">_PlayMuted</a>, <a class="el" href="a06391.html#l00144">_Sound</a>, <a class="el" href="a06428.html#l00129">NLSOUND::CSourceCommon::_SpawnEndCb</a>, <a class="el" href="a06391.html#l00150">_Track</a>, <a class="el" href="a05465.html#l02068">NLSOUND::CAudioMixerUser::addEvent()</a>, <a class="el" href="a05465.html#l00280">NLSOUND::CAudioMixerUser::addSourceWaitingForPlay()</a>, <a class="el" href="a06037.html#l00071">NLSOUND::CTrack::DrvSource</a>, <a class="el" href="a06388.html#l00093">NLSOUND::CSimpleSound::getBuffer()</a>, <a class="el" href="a06388.html#l00109">NLSOUND::CSimpleSound::getDuration()</a>, <a class="el" href="a05465.html#l01152">NLSOUND::CAudioMixerUser::getFreeTrack()</a>, <a class="el" href="a05466.html#l00262">NLSOUND::CAudioMixerUser::getListenPosVector()</a>, <a class="el" href="a06407.html#l00110">NLSOUND::CSound::getMaxDistance()</a>, <a class="el" href="a06389.html#l00067">NLSOUND::CSimpleSound::getMinDistance()</a>, <a class="el" href="a06390.html#l00103">getVirtualPos()</a>, <a class="el" href="a05381.html#a82a64">NLSOUND::HighestPri</a>, <a class="el" href="a05466.html#l00321">NLSOUND::CAudioMixerUser::incPlayingSourceMuted()</a>, <a class="el" href="a02298.html#NLSOUND_1_1IBuffera6">NLSOUND::IBuffer::isBufferLoaded()</a>, <a class="el" href="a02298.html#NLSOUND_1_1IBuffera8">NLSOUND::IBuffer::isStereo()</a>, <a class="el" href="a05622.html#l00290">nlassert</a>, <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_5">NLSOUND::ISource::play()</a>, <a class="el" href="a06424.html#l00154">NLSOUND::ISource::setAlpha()</a>, <a class="el" href="a06390.html#l00290">setDirection()</a>, <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_12">NLSOUND::ISource::setGain()</a>, <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_6">NLSOUND::ISource::setLooping()</a>, <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_13">NLSOUND::ISource::setMinMaxDistances()</a>, <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_14">NLSOUND::ISource::setPitch()</a>, <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_15">NLSOUND::ISource::setPos()</a>, <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_16">NLSOUND::ISource::setSourceRelativeMode()</a>, <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1330_1">NLSOUND::ISource::setStaticBuffer()</a>, and <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_17">NLSOUND::ISource::setVelocity()</a>. +<p> +Referenced by <a class="el" href="a05427.html#l00130">NLSOUND::CAmbiantSource::enable()</a>, and <a class="el" href="a05427.html#l00239">NLSOUND::CAmbiantSource::update()</a>. +<p> +<div class="fragment"><pre>00127 { +00128 <span class="comment">// nldebug("CSimpleSource %p : play", this);</span> +00129 +00130 CAudioMixerUser *mixer = CAudioMixerUser::instance(); +00131 +00132 <span class="comment">// -- Some test to scheck if we can play the source</span> +00133 +00134 <span class="comment">// Check if sample buffer is available and if the sound source is not too far</span> +00135 <span class="keywordflow">if</span> (<a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a>->getBuffer() == 0 +00136 || !<a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a>->getBuffer()->isBufferLoaded() +00137 || (mixer->getListenPosVector() - <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp10">_Position</a>).sqrnorm() > <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a>->getMaxDistance()*<a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a>->getMaxDistance()) +00138 { +00139 <span class="comment">// The sample buffer is not available, don't play (we don't know the lenght)</span> +00140 <span class="keywordflow">if</span> (<a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp13">_Spawn</a>) +00141 { +00142 <span class="keywordflow">if</span> (<a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp14">_SpawnEndCb</a> != 0) +00143 <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp14">_SpawnEndCb</a>(<span class="keyword">this</span>, _CbUserParam); +00144 +00145 <span class="keyword">delete</span> <span class="keyword">this</span>; +00146 } +00147 <span class="comment">// nldebug("CSimpleSource %p : play FAILED !", (CAudioMixerUser::IMixerEvent*)this);</span> +00148 <span class="keywordflow">return</span>; +00149 } +00150 +00151 <span class="comment">// -- Here we can play the source, either in a real track or as a muted source.</span> +00152 +00153 <span class="comment">// Try to obtain a track</span> +00154 <span class="keywordflow">if</span> (<a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a> == 0) +00155 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a> = mixer->getFreeTrack(<span class="keyword">this</span>); +00156 <span class="keywordflow">if</span> (<a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a> != 0) +00157 { +00158 <span class="comment">// ok, we have a track to realy play, fill the data into the track</span> +00159 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setStaticBuffer(<a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a>->getBuffer()); +00160 +00161 <span class="comment">// _Track->DrvSource->setPos( _Position, false);</span> +00162 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setPos( <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_3">getVirtualPos</a>(), <span class="keyword">false</span>); +00163 <span class="keywordflow">if</span> ( ! <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a>->getBuffer()->isStereo() ) +00164 { +00165 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setMinMaxDistances( <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a>->getMinDistance(), <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a>->getMaxDistance(), <span class="keyword">false</span> ); +00166 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_4">setDirection</a>( _Direction ); <span class="comment">// because there is a workaround inside</span> +00167 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setVelocity( _Velocity ); +00168 } +00169 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setGain( _Gain ); +00170 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setSourceRelativeMode( _RelativeMode ); +00171 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setLooping( _Looping ); +00172 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setPitch( _Pitch ); +00173 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setAlpha( _Alpha ); +00174 +00175 <span class="comment">// and play the sound </span> +00176 <span class="keywordtype">bool</span> <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1338_3">play</a> = <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->play(); +00177 +00178 <a class="code" href="a04199.html#a6">nlassert</a>(play); +00179 <span class="comment">// nldebug("CSimpleSource %p : REAL play done", (CAudioMixerUser::IMixerEvent*)this);</span> +00180 } +00181 <span class="keywordflow">else</span> +00182 { +00183 <span class="keywordflow">if</span> (<a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp11">_Priority</a> == <a class="code" href="a05381.html#a82a64">HighestPri</a>) +00184 { +00185 <span class="comment">// This sound is not discardable, add it in waiting playlist</span> +00186 mixer->addSourceWaitingForPlay(<span class="keyword">this</span>); +00187 <span class="keywordflow">return</span>; +00188 } +00189 <span class="comment">// there is no available track, just do a 'muted' play</span> +00190 mixer->addEvent(<span class="keyword">this</span>, CTime::getLocalTime()+<a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a>->getDuration()); +00191 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_14">_PlayMuted</a> = <span class="keyword">true</span>; +00192 mixer->incPlayingSourceMuted(); +00193 <span class="comment">// nldebug("CSimpleSource %p : MUTED play done", (CAudioMixerUser::IMixerEvent*)this);</span> +00194 } +00195 +00196 CSourceCommon::play(); +00197 +00198 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommona19" doxytag="NLSOUND::CSimpleSource::set3DPositionVector" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSourceCommon::set3DPositionVector </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> [inline, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the position vector to return for a stereo source (default: NULL). +<p> + +<p> +Definition at line <a class="el" href="a06428.html#l00088">88</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +References <a class="el" href="a06428.html#l00125">NLSOUND::CSourceCommon::_3DPosition</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01576">NLSOUND::CAudioMixerUser::createSource()</a>, and <a class="el" href="a05427.html#l00092">NLSOUND::CAmbiantSource::initPos()</a>. +<p> +<div class="fragment"><pre>00088 { <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp0">_3DPosition</a> = pos; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1340_4" doxytag="NLSOUND::CSimpleSource::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"> void NLSOUND::CSimpleSource::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> [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> +Reimplemented from <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona20">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="a06390.html#l00290">290</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +References <a class="el" href="a06391.html#l00144">_Sound</a>, <a class="el" href="a06391.html#l00150">_Track</a>, <a class="el" href="a06037.html#l00071">NLSOUND::CTrack::DrvSource</a>, <a class="el" href="a06388.html#l00093">NLSOUND::CSimpleSound::getBuffer()</a>, <a class="el" href="a06407.html#l00098">NLSOUND::CSound::getConeInnerAngle()</a>, <a class="el" href="a06407.html#l00100">NLSOUND::CSound::getConeOuterAngle()</a>, <a class="el" href="a06407.html#l00102">NLSOUND::CSound::getConeOuterGain()</a>, <a class="el" href="a06682.html#l00148">NLMISC::CVector::isNull()</a>, <a class="el" href="a02298.html#NLSOUND_1_1IBuffera8">NLSOUND::IBuffer::isStereo()</a>, <a class="el" href="a05587.html#l00079">NLMISC::Pi</a>, <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_9">NLSOUND::ISource::setCone()</a>, and <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_10">NLSOUND::ISource::setDirection()</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00126">play()</a>. +<p> +<div class="fragment"><pre>00291 { +00292 CSourceCommon::setDirection(dir); +00293 +00294 <span class="comment">// Set the direction</span> +00295 <span class="keywordflow">if</span> ( <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a> != NULL ) +00296 { +00297 <span class="keywordflow">if</span> ( ! <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a>->getBuffer()->isStereo() ) +00298 { +00299 <span class="keyword">static</span> <span class="keywordtype">bool</span> coneset = <span class="keyword">false</span>; +00300 <span class="keywordflow">if</span> ( dir.<a class="code" href="a03128.html#NLMISC_1_1CVectorz2051_1">isNull</a>() ) <span class="comment">// workaround</span> +00301 { +00302 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setCone( <span class="keywordtype">float</span>(Pi*2), <span class="keywordtype">float</span>(Pi*2), 1.0f ); <span class="comment">// because the direction with 0 is not enough for a non-directional source!</span> +00303 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setDirection( CVector::I ); <span class="comment">// Don't send a 0 vector, DSound will complain. Send (1,0,0), it's omnidirectional anyway.</span> +00304 coneset = <span class="keyword">false</span>; +00305 } +00306 <span class="keywordflow">else</span> +00307 { +00308 <span class="comment">// if ( ! coneset )</span> +00309 { +00310 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setCone( <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a>->getConeInnerAngle(), <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a>->getConeOuterAngle(), <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">_Sound</a>->getConeOuterGain() ); +00311 coneset = <span class="keyword">true</span>; +00312 } +00313 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setDirection( dir ); +00314 } +00315 } +00316 } +00317 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1340_5" doxytag="NLSOUND::CSimpleSource::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"> void NLSOUND::CSimpleSource::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> [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> +Reimplemented from <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona21">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="a06390.html#l00326">326</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +References <a class="el" href="a06391.html#l00150">_Track</a>, <a class="el" href="a06037.html#l00071">NLSOUND::CTrack::DrvSource</a>, and <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_12">NLSOUND::ISource::setGain()</a>. +<p> +Referenced by <a class="el" href="a05427.html#l00092">NLSOUND::CAmbiantSource::initPos()</a>, and <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>. +<p> +<div class="fragment"><pre>00327 { +00328 CSourceCommon::setGain(gain); +00329 +00330 <span class="comment">// Set the gain</span> +00331 <span class="keywordflow">if</span> ( <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a> != NULL ) +00332 { +00333 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setGain( gain ); +00334 } +00335 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1338_4" doxytag="NLSOUND::CSimpleSource::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"> void NLSOUND::CSimpleSource::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> [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> +Reimplemented from <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona22">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="a06390.html#l00093">93</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +References <a class="el" href="a06391.html#l00150">_Track</a>, <a class="el" href="a06037.html#l00071">NLSOUND::CTrack::DrvSource</a>, and <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_6">NLSOUND::ISource::setLooping()</a>. +<p> +Referenced by <a class="el" href="a05427.html#l00047">NLSOUND::CAmbiantSource::CAmbiantSource()</a>. +<p> +<div class="fragment"><pre>00094 { +00095 CSourceCommon::setLooping(l); +00096 <span class="keywordflow">if</span> ( <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a> != NULL ) +00097 { +00098 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setLooping( l ); +00099 } +00100 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1340_6" doxytag="NLSOUND::CSimpleSource::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"> void NLSOUND::CSimpleSource::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> [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> +Reimplemented from <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona23">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="a06390.html#l00352">352</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +References <a class="el" href="a06391.html#l00150">_Track</a>, <a class="el" href="a06037.html#l00071">NLSOUND::CTrack::DrvSource</a>, and <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_14">NLSOUND::ISource::setPitch()</a>. +<p> +<div class="fragment"><pre>00353 { +00354 CSourceCommon::setPitch(pitch); +00355 +00356 <span class="comment">// Set the pitch</span> +00357 <span class="keywordflow">if</span> ( <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a> != NULL ) +00358 { +00359 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setPitch( pitch ); +00360 } +00361 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1340_7" doxytag="NLSOUND::CSimpleSource::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"> void NLSOUND::CSimpleSource::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> [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> +Reimplemented from <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona24">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="a06390.html#l00258">258</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +References <a class="el" href="a06391.html#l00150">_Track</a>, <a class="el" href="a06037.html#l00071">NLSOUND::CTrack::DrvSource</a>, <a class="el" href="a06390.html#l00103">getVirtualPos()</a>, and <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_15">NLSOUND::ISource::setPos()</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>. +<p> +<div class="fragment"><pre>00259 { +00260 CSourceCommon::setPos(pos); +00261 +00262 <span class="comment">// Set the position</span> +00263 <span class="keywordflow">if</span> ( <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a> != NULL ) +00264 { +00265 <span class="comment">// _Track->DrvSource->setPos( pos );</span> +00266 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setPos( <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_3">getVirtualPos</a>() ); +00267 } +00268 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommona25" doxytag="NLSOUND::CSimpleSource::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"> void NLSOUND::CSourceCommon::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> [virtual, inherited]</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> +Implements <a class="el" href="a03429.html#NLSOUND_1_1USourcea1">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="a06427.html#l00076">76</a> of file <a class="el" href="a06427.html">source_common.cpp</a>. +<p> +Referenced by <a class="el" href="a05427.html#l00130">NLSOUND::CAmbiantSource::enable()</a>, <a class="el" href="a05427.html#l00092">NLSOUND::CAmbiantSource::initPos()</a>, and <a class="el" href="a05427.html#l00239">NLSOUND::CAmbiantSource::update()</a>. +<p> +<div class="fragment"><pre>00077 { +00078 <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp11">_Priority</a> = pr; +00079 +00080 <span class="comment">// The AudioMixer redispatches as necessary in the update() function [PH]</span> +00081 <span class="comment">// Redispatch the tracks if needed</span> +00082 <span class="comment">//if ( redispatch )</span> +00083 <span class="comment">//{</span> +00084 <span class="comment">// CAudioMixerUser::instance()->balanceSources();</span> +00085 <span class="comment">//}</span> +00086 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1340_8" doxytag="NLSOUND::CSimpleSource::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"> void NLSOUND::CSimpleSource::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> [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="a02254.html#NLSOUND_1_1CSourceCommona5">getGain()</a>). Does nothing if getSource() is null. +<p> +Reimplemented from <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona26">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="a06390.html#l00337">337</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +References <a class="el" href="a06391.html#l00150">_Track</a>, <a class="el" href="a06037.html#l00071">NLSOUND::CTrack::DrvSource</a>, and <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_12">NLSOUND::ISource::setGain()</a>. +<p> +Referenced by <a class="el" href="a05427.html#l00239">NLSOUND::CAmbiantSource::update()</a>. +<p> +<div class="fragment"><pre>00338 { +00339 CSourceCommon::setRelativeGain(gain); +00340 +00341 <span class="comment">// Set the gain</span> +00342 <span class="keywordflow">if</span> ( <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a> != NULL ) +00343 { +00344 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setGain( _Gain ); +00345 } +00346 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1340_9" doxytag="NLSOUND::CSimpleSource::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"> void NLSOUND::CSimpleSource::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> [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> +Reimplemented from <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona27">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="a06390.html#l00367">367</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +References <a class="el" href="a06391.html#l00150">_Track</a>, <a class="el" href="a06037.html#l00071">NLSOUND::CTrack::DrvSource</a>, and <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_16">NLSOUND::ISource::setSourceRelativeMode()</a>. +<p> +<div class="fragment"><pre>00368 { +00369 CSourceCommon::setSourceRelativeMode(mode); +00370 +00371 <span class="comment">// Set the relative mode</span> +00372 <span class="keywordflow">if</span> ( <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a> != NULL ) +00373 { +00374 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setSourceRelativeMode( mode ); +00375 } +00376 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1340_10" doxytag="NLSOUND::CSimpleSource::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"> void NLSOUND::CSimpleSource::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> [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> +Reimplemented from <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona28">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="a06390.html#l00274">274</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +References <a class="el" href="a06391.html#l00150">_Track</a>, <a class="el" href="a06037.html#l00071">NLSOUND::CTrack::DrvSource</a>, and <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_17">NLSOUND::ISource::setVelocity()</a>. +<p> +<div class="fragment"><pre>00275 { +00276 CSourceCommon::setVelocity(vel); +00277 +00278 <span class="comment">// Set the velocity</span> +00279 <span class="keywordflow">if</span> ( <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a> != NULL ) +00280 { +00281 <span class="comment">// TODO : uncoment, test only </span> +00282 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setVelocity( vel ); +00283 } +00284 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1338_5" doxytag="NLSOUND::CSimpleSource::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"> void NLSOUND::CSimpleSource::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> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Stop playing. +<p> + +<p> +Reimplemented from <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommona29">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="a06390.html#l00217">217</a> of file <a class="el" href="a06390.html">simple_source.cpp</a>. +<p> +References <a class="el" href="a06391.html#l00152">_PlayMuted</a>, <a class="el" href="a06428.html#l00129">NLSOUND::CSourceCommon::_SpawnEndCb</a>, <a class="el" href="a06391.html#l00150">_Track</a>, <a class="el" href="a06037.html#l00071">NLSOUND::CTrack::DrvSource</a>, <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1330_1">NLSOUND::ISource::setStaticBuffer()</a>, and <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_7">NLSOUND::ISource::stop()</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01052">NLSOUND::CAudioMixerUser::bufferUnloaded()</a>, <a class="el" href="a05427.html#l00130">NLSOUND::CAmbiantSource::enable()</a>, <a class="el" href="a05465.html#l01152">NLSOUND::CAudioMixerUser::getFreeTrack()</a>, <a class="el" href="a06390.html#l00200">onEvent()</a>, <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>, <a class="el" href="a05427.html#l00239">NLSOUND::CAmbiantSource::update()</a>, and <a class="el" href="a06390.html#l00060">~CSimpleSource()</a>. +<p> +<div class="fragment"><pre>00218 { +00219 <span class="comment">// nldebug("CSimpleSource %p : stop", (CAudioMixerUser::IMixerEvent*)this);</span> +00220 <span class="comment">// nlassert(_Playing);</span> +00221 <span class="keywordflow">if</span> (!<a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp8">_Playing</a>) +00222 <span class="keywordflow">return</span>; +00223 +00224 <span class="keywordflow">if</span> (<a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a> != 0) +00225 { +00226 <span class="comment">// free the track</span> +00227 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->stop(); +00228 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a>->DrvSource->setStaticBuffer(0); +00229 CAudioMixerUser::instance()->freeTrack(_Track); +00230 <a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">_Track</a> = 0; +00231 } +00232 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (<a class="code" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_14">_PlayMuted</a>) +00233 { +00234 <span class="comment">// clear the registered event because of a stop before normal end of play</span> +00235 CAudioMixerUser::instance()->decPlayingSourceMuted(); +00236 CAudioMixerUser::instance()->removeEvents(<span class="keyword">this</span>); +00237 } +00238 +00239 <span class="comment">// CAudioMixerUser::instance()->decPlayingSource();</span> +00240 CSourceCommon::stop(); +00241 +00242 <span class="keywordflow">if</span> (<a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp13">_Spawn</a>) +00243 { +00244 <span class="keywordflow">if</span> ( <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp14">_SpawnEndCb</a> != 0 ) +00245 { +00246 <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp14">_SpawnEndCb</a>( <span class="keyword">this</span>, _CbUserParam); +00247 } +00248 +00249 <span class="keyword">delete</span> <span class="keyword">this</span>; +00250 } +00251 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommona30" doxytag="NLSOUND::CSimpleSource::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::CSourceCommon::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> [inline, virtual, inherited]</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> +Implements <a class="el" href="a03429.html#NLSOUND_1_1USourcez2137_6">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="a06428.html#l00076">76</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +References <a class="el" href="a06428.html#l00129">NLSOUND::CSourceCommon::_SpawnEndCb</a>. +<p> +<div class="fragment"><pre>00076 { <a class="code" href="a02254.html#NLSOUND_1_1CSourceCommonp14">_SpawnEndCb</a> = NULL; } +</pre></div> </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NLSOUND_1_1CSourceCommonp0" doxytag="NLSOUND::CSimpleSource::_3DPosition" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> const <a class="el" href="a03128.html">NLMISC::CVector</a>* <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp0">NLSOUND::CSourceCommon::_3DPosition</a><code> [protected, inherited]</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="a06428.html#l00125">125</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="a06427.html#l00141">NLSOUND::CSourceCommon::getPos()</a>, and <a class="el" href="a06428.html#l00088">NLSOUND::CSourceCommon::set3DPositionVector()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1340_13" doxytag="NLSOUND::CSimpleSource::_Alpha" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> float <a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_13">NLSOUND::CSimpleSource::_Alpha</a><code> [private]</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="a06391.html#l00147">147</a> of file <a class="el" href="a06391.html">simple_source.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommonp1" doxytag="NLSOUND::CSimpleSource::_CbUserParam" ></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* <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp1">NLSOUND::CSourceCommon::_CbUserParam</a><code> [protected, inherited]</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="a06428.html#l00130">130</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="a06428.html#l00074">NLSOUND::CSourceCommon::getCallbackUserParam()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommonp2" doxytag="NLSOUND::CSimpleSource::_Cluster" ></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="a02362.html">NL3D::CCluster</a>* <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp2">NLSOUND::CSourceCommon::_Cluster</a><code> [protected, inherited]</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="a06428.html#l00131">131</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="a06428.html#l00098">NLSOUND::CSourceCommon::getCluster()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommonp3" doxytag="NLSOUND::CSimpleSource::_Direction" ></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="a03128.html">NLMISC::CVector</a> <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp3">NLSOUND::CSourceCommon::_Direction</a><code> [protected, inherited]</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="a06428.html#l00113">113</a> of file <a class="el" href="a06428.html">source_common.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommonp4" doxytag="NLSOUND::CSimpleSource::_Gain" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> float <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp4">NLSOUND::CSourceCommon::_Gain</a><code> [protected, inherited]</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="a06428.html#l00114">114</a> of file <a class="el" href="a06428.html">source_common.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommonp5" doxytag="NLSOUND::CSimpleSource::_InitialGain" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> float <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp5">NLSOUND::CSourceCommon::_InitialGain</a><code> [protected, inherited]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gain not affected by setRelativeGain and used to compute _Gain. +<p> + +<p> +Definition at line <a class="el" href="a06428.html#l00119">119</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="a06427.html#l00037">NLSOUND::CSourceCommon::CSourceCommon()</a>, <a class="el" href="a06427.html#l00205">NLSOUND::CSourceCommon::getRelativeGain()</a>, <a class="el" href="a06427.html#l00186">NLSOUND::CSourceCommon::setGain()</a>, and <a class="el" href="a06427.html#l00195">NLSOUND::CSourceCommon::setRelativeGain()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommonp6" doxytag="NLSOUND::CSimpleSource::_Looping" ></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="a02254.html#NLSOUND_1_1CSourceCommonp6">NLSOUND::CSourceCommon::_Looping</a><code> [protected, inherited]</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="a06428.html#l00109">109</a> of file <a class="el" href="a06428.html">source_common.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommonp7" doxytag="NLSOUND::CSimpleSource::_Pitch" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> float <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp7">NLSOUND::CSourceCommon::_Pitch</a><code> [protected, inherited]</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="a06428.html#l00115">115</a> of file <a class="el" href="a06428.html">source_common.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommonp8" doxytag="NLSOUND::CSimpleSource::_Playing" ></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="a02254.html#NLSOUND_1_1CSourceCommonp8">NLSOUND::CSourceCommon::_Playing</a><code> [protected, inherited]</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="a06428.html#l00108">108</a> of file <a class="el" href="a06428.html">source_common.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1340_14" doxytag="NLSOUND::CSimpleSource::_PlayMuted" ></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="a03395.html#NLSOUND_1_1CSimpleSourcez1340_14">NLSOUND::CSimpleSource::_PlayMuted</a><code> [private]</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="a06391.html#l00152">152</a> of file <a class="el" href="a06391.html">simple_source.h</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00200">onEvent()</a>, <a class="el" href="a06390.html#l00126">play()</a>, and <a class="el" href="a06390.html#l00217">stop()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommonp9" doxytag="NLSOUND::CSimpleSource::_PlayStart" ></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="a05378.html#a242">NLMISC::TTime</a> <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp9">NLSOUND::CSourceCommon::_PlayStart</a><code> [protected, inherited]</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="a06428.html#l00122">122</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="a06427.html#l00222">NLSOUND::CSourceCommon::getTime()</a>, and <a class="el" href="a06427.html#l00107">NLSOUND::CSourceCommon::play()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommonp10" doxytag="NLSOUND::CSimpleSource::_Position" ></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="a03128.html">NLMISC::CVector</a> <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp10">NLSOUND::CSourceCommon::_Position</a><code> [protected, inherited]</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="a06428.html#l00111">111</a> of file <a class="el" href="a06428.html">source_common.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommonp11" doxytag="NLSOUND::CSimpleSource::_Priority" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a05381.html#a82">TSoundPriority</a> <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp11">NLSOUND::CSourceCommon::_Priority</a><code> [protected, inherited]</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="a06428.html#l00107">107</a> of file <a class="el" href="a06428.html">source_common.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommonp12" doxytag="NLSOUND::CSimpleSource::_RelativeMode" ></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="a02254.html#NLSOUND_1_1CSourceCommonp12">NLSOUND::CSourceCommon::_RelativeMode</a><code> [protected, inherited]</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="a06428.html#l00116">116</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="a06428.html#l00086">NLSOUND::CSourceCommon::getSourceRelativeMode()</a>, and <a class="el" href="a06427.html#l00216">NLSOUND::CSourceCommon::setSourceRelativeMode()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1340_15" doxytag="NLSOUND::CSimpleSource::_Sound" ></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="a03394.html">CSimpleSound</a>* <a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_15">NLSOUND::CSimpleSource::_Sound</a><code> [private]</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="a06391.html#l00144">144</a> of file <a class="el" href="a06391.html">simple_source.h</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00045">CSimpleSource()</a>, <a class="el" href="a06390.html#l00082">getBuffer()</a>, <a class="el" href="a06390.html#l00066">getSimpleSound()</a>, <a class="el" href="a06391.html#l00069">getSound()</a>, <a class="el" href="a06390.html#l00126">play()</a>, and <a class="el" href="a06390.html#l00290">setDirection()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommonp13" doxytag="NLSOUND::CSimpleSource::_Spawn" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> const bool <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp13">NLSOUND::CSourceCommon::_Spawn</a><code> [protected, inherited]</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="a06428.html#l00128">128</a> of file <a class="el" href="a06428.html">source_common.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommonp14" doxytag="NLSOUND::CSimpleSource::_SpawnEndCb" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a05381.html#a63">TSpawnEndCallback</a> <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp14">NLSOUND::CSourceCommon::_SpawnEndCb</a><code> [protected, inherited]</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="a06428.html#l00129">129</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00126">play()</a>, <a class="el" href="a06390.html#l00217">stop()</a>, and <a class="el" href="a06428.html#l00076">NLSOUND::CSourceCommon::unregisterSpawnCallBack()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSimpleSourcez1340_16" doxytag="NLSOUND::CSimpleSource::_Track" ></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="a03540.html">CTrack</a>* <a class="el" href="a03395.html#NLSOUND_1_1CSimpleSourcez1340_16">NLSOUND::CSimpleSource::_Track</a><code> [private]</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="a06391.html#l00150">150</a> of file <a class="el" href="a06391.html">simple_source.h</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00071">getTime()</a>, <a class="el" href="a06391.html#l00129">getTrack()</a>, <a class="el" href="a06390.html#l00126">play()</a>, <a class="el" href="a06390.html#l00290">setDirection()</a>, <a class="el" href="a06390.html#l00326">setGain()</a>, <a class="el" href="a06390.html#l00093">setLooping()</a>, <a class="el" href="a06390.html#l00352">setPitch()</a>, <a class="el" href="a06390.html#l00258">setPos()</a>, <a class="el" href="a06390.html#l00337">setRelativeGain()</a>, <a class="el" href="a06390.html#l00367">setSourceRelativeMode()</a>, <a class="el" href="a06390.html#l00274">setVelocity()</a>, and <a class="el" href="a06390.html#l00217">stop()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommonp15" doxytag="NLSOUND::CSimpleSource::_UserVarControler" ></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="a05378.html#a236">NLMISC::TStringId</a> <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp15">NLSOUND::CSourceCommon::_UserVarControler</a><code> [protected, inherited]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +An optional user var controler. +<p> + +<p> +Definition at line <a class="el" href="a06428.html#l00134">134</a> of file <a class="el" href="a06428.html">source_common.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSourceCommonp16" doxytag="NLSOUND::CSimpleSource::_Velocity" ></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="a03128.html">NLMISC::CVector</a> <a class="el" href="a02254.html#NLSOUND_1_1CSourceCommonp16">NLSOUND::CSourceCommon::_Velocity</a><code> [protected, inherited]</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="a06428.html#l00112">112</a> of file <a class="el" href="a06428.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="a06428.html#l00078">NLSOUND::CSourceCommon::getVelocity()</a>, and <a class="el" href="a06427.html#l00167">NLSOUND::CSourceCommon::setVelocity()</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="a06391.html">simple_source.h</a><li><a class="el" href="a06390.html">simple_source.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 14:41:32 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> |