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/classNLSOUND_1_1CSourceCommon.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/classNLSOUND_1_1CSourceCommon.html | 1687 |
1 files changed, 1687 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLSOUND_1_1CSourceCommon.html b/docs/doxygen/nel/classNLSOUND_1_1CSourceCommon.html new file mode 100644 index 00000000..92f5f873 --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1CSourceCommon.html @@ -0,0 +1,1687 @@ +<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> +<HTML> +<HEAD> + <TITLE>nevrax.org : docs</TITLE> + <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</HEAD> +<BODY MARGINHEIGHT="0" MARGINWIDTH="0"> + +<!-- uplinks --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD> + </TR> +</TABLE> + +<!-- banner Nevrax --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%> + <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR> +</TABLE> + +<!-- main table --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + + <!------ Begin Box ------> + <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black> + <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF> + <TABLE cellspacing=0 cellpadding=1 border=0> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT=""> +</td></tr></table> + + +<!-- block --> +<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD> + <TD><B>Documentation</B></TD> + <TD ALIGN=RIGHT> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<a class="qindex" href="index.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">Compound List</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">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>NLSOUND::CSourceCommon Class Reference</h1><code>#include <<a class="el" href="source__common_8h-source.html">source_common.h</a>></code> +<p> +<p>Inheritance diagram for NLSOUND::CSourceCommon: +<p><center><img src="classNLSOUND_1_1CSourceCommon.gif" usemap="#NLSOUND::CSourceCommon_map" border="0"></center> +<map name="NLSOUND::CSourceCommon_map"> +<area href="classNLSOUND_1_1USource.html" alt="NLSOUND::USource" shape="rect" coords="206,0,402,24"> +<area href="classNLSOUND_1_1CBackgroundSource.html" alt="NLSOUND::CBackgroundSource" shape="rect" coords="0,112,196,136"> +<area href="classNLSOUND_1_1CComplexSource.html" alt="NLSOUND::CComplexSource" shape="rect" coords="206,112,402,136"> +<area href="classNLSOUND_1_1CSimpleSource.html" alt="NLSOUND::CSimpleSource" shape="rect" coords="412,112,608,136"> +</map> +<a href="classNLSOUND_1_1CSourceCommon-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Types</h2></td></tr> +<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#s3">TSOURCE_TYPE</a> { <a class="el" href="classNLSOUND_1_1CSourceCommon.html#s3s0">SOURCE_SIMPLE</a>, +<a class="el" href="classNLSOUND_1_1CSourceCommon.html#s3s1">SOURCE_COMPLEX</a>, +<a class="el" href="classNLSOUND_1_1CSourceCommon.html#s3s2">SOURCE_BACKGROUND</a> + }</td></tr> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a0">CSourceCommon</a> (<a class="el" href="namespaceNLSOUND.html#a8">TSoundId</a> <a class="el" href="driver__opengl__extension__def_8h.html#a356">id</a>, bool spawn, <a class="el" href="namespaceNLSOUND.html#a9">TSpawnEndCallback</a> cb, void *cbUserParam)</td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a1">~CSourceCommon</a> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classNLSOUND_1_1CSourceCommon.html#s3">TSOURCE_TYPE</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a2">getType</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the type the the source.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a3">setPriority</a> (<a class="el" href="namespaceNLSOUND.html#a82">TSoundPriority</a> pr)</td></tr> +<tr><td> </td><td><font size=-1><em>Change the priority of the source.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespaceNLSOUND.html#a82">TSoundPriority</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a4">getPriority</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the priority.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a5">setLooping</a> (bool loop)</td></tr> +<tr><td> </td><td><font size=-1><em>Set looping on/off for future playbacks (default: off).</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a6">getLooping</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the looping state.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a7">play</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Play.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a8">stop</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Stop playing.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a9">isPlaying</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Get playing state. Return false even if the source has stopped on its own.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a10">setPos</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &pos)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the position vector (default: (0,0,0)).</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a11">getPos</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the position vector (3D mode only).</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a12">setVelocity</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &vel)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the velocity vector (3D mode only, ignored in stereo mode) (default: (0,0,0)).</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a13">setDirection</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &dir)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the direction vector (3D mode only, ignored in stereo mode) (default: (0,0,0) as non-directional).</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a14">setGain</a> (float gain)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the gain (volume value inside [0 , 1]).</em> <a href="#a14">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a15">setRelativeGain</a> (float gain)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the gain amount (value inside [0, 1]) to map between 0 and the nominal gain (which is getSource()-><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a22">getGain</a>()).</em> <a href="#a15">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>float </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a16">getRelativeGain</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the relative gain (see <a class="el" href="classNLSOUND_1_1CSourceCommon.html#a15">setRelativeGain</a>()), or the absolute gain if getSource() is null.</em> <a href="#a16">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a17">setSourceRelativeMode</a> (bool mode)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the source relative mode. If true, positions are interpreted relative to the listener position (default: false).</em> <a href="#a17">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a18">getCallbackUserParam</a> (void) const</td></tr> +<tr><td> </td><td><font size=-1><em>return the user param for the user callback.</em> <a href="#a18">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a19">unregisterSpawnCallBack</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Tells this source not to call its callbacks when it ends. This is valid for spawned sources only.</em> <a href="#a19">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a20">getVelocity</a> (<a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &vel) const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the velocity vector.</em> <a href="#a20">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a21">getDirection</a> (<a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &dir) const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the direction vector.</em> <a href="#a21">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a22">getGain</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the gain.</em> <a href="#a22">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a23">getPitch</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the pitch.</em> <a href="#a23">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a24">getSourceRelativeMode</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the source relative mode.</em> <a href="#a24">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a25">set3DPositionVector</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> *pos)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the position vector to return for a stereo source (default: NULL).</em> <a href="#a25">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a26">isSpawn</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the spawn state.</em> <a href="#a26">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a27">setPitch</a> (float pitch)</td></tr> +<tr><td> </td><td><font size=-1><em>Shift the frequency.</em> <a href="#a27">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="memory__common_8h.html#a11">uint32</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#a28">getTime</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the number of milliseconds the source has been playing.</em> <a href="#a28">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespaceNLSOUND.html#a82">TSoundPriority</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#n0">_Priority</a></td></tr> +<tr><td> </td><td><font size=-1><em>Shift the frequency.</em> <a href="#n0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#n1">_Playing</a></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#n2">_Looping</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#n3">_Position</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#n4">_Velocity</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#n5">_Direction</a></td></tr> +<tr><td nowrap align=right valign=top>float </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#n6">_Gain</a></td></tr> +<tr><td nowrap align=right valign=top>float </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#n7">_Pitch</a></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#n8">_RelativeMode</a></td></tr> +<tr><td nowrap align=right valign=top>float </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#n9">_InitialGain</a></td></tr> +<tr><td> </td><td><font size=-1><em>Gain not affected by setRelativeGain and used to compute _Gain.</em> <a href="#n9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespaceNLMISC.html#a183">NLMISC::TTime</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#n10">_PlayStart</a></td></tr> +<tr><td nowrap align=right valign=top>const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#n11">_3DPosition</a></td></tr> +<tr><td nowrap align=right valign=top>const bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#n12">_Spawn</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespaceNLSOUND.html#a9">TSpawnEndCallback</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#n13">_SpawnEndCb</a></td></tr> +<tr><td nowrap align=right valign=top>void * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceCommon.html#n14">_CbUserParam</a></td></tr> +</table> +<hr><h2>Member Enumeration Documentation</h2> +<a name="s3" doxytag="NLSOUND::CSourceCommon::TSOURCE_TYPE"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> enum NLSOUND::CSourceCommon::TSOURCE_TYPE + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<dl compact><dt><b> +Enumeration values:</b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em><a name="s3s0" doxytag="SOURCE_SIMPLE"></a><em>SOURCE_SIMPLE</em></em> </td><td> +</td></tr> +<tr><td valign=top><em><a name="s3s1" doxytag="SOURCE_COMPLEX"></a><em>SOURCE_COMPLEX</em></em> </td><td> +</td></tr> +<tr><td valign=top><em><a name="s3s2" doxytag="SOURCE_BACKGROUND"></a><em>SOURCE_BACKGROUND</em></em> </td><td> +</td></tr> +</table> +</dl> + +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00040">40</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="simple__source_8h-source.html#l00136">NLSOUND::CSimpleSource::getType</a>, <a class="el" href="complex__source_8h-source.html#l00119">NLSOUND::CComplexSource::getType</a>, and <a class="el" href="background__source_8h-source.html#l00061">NLSOUND::CBackgroundSource::getType</a>. </td> + </tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NLSOUND::CSourceCommon::CSourceCommon"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NLSOUND::CSourceCommon::CSourceCommon </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLSOUND.html#a8">TSoundId</a> </td> + <td class="mdname" nowrap> <em>id</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>spawn</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="namespaceNLSOUND.html#a9">TSpawnEndCallback</a> </td> + <td class="mdname" nowrap> <em>cb</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>cbUserParam</em></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> + +<p> +Definition at line <a class="el" href="source__common_8cpp-source.html#l00036">36</a> of file <a class="el" href="source__common_8cpp-source.html">source_common.cpp</a>. +<p> +References <a class="el" href="driver__opengl__extension__def_8h-source.html#l00218">id</a>, <a class="el" href="namespaceNLSOUND.html#a82a12">NLSOUND::MidPri</a>, <a class="el" href="u__source_8h-source.html#l00069">NLSOUND::TSoundId</a>, and <a class="el" href="u__source_8h-source.html#l00076">NLSOUND::TSpawnEndCallback</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLSOUND::CSourceCommon::~CSourceCommon"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NLSOUND::CSourceCommon::~CSourceCommon </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> + +<p> +Definition at line <a class="el" href="source__common_8cpp-source.html#l00056">56</a> of file <a class="el" href="source__common_8cpp-source.html">source_common.cpp</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a18" doxytag="NLSOUND::CSourceCommon::getCallbackUserParam"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void* 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]</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="source__common_8h-source.html#l00072">72</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00176">_CbUserParam</a>. </td> + </tr> +</table> +<a name="a21" doxytag="NLSOUND::CSourceCommon::getDirection"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::CSourceCommon::getDirection </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1CVector.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]</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="classNLSOUND_1_1USource.html#z365_5">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00078">78</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00159">_Direction</a>. </td> + </tr> +</table> +<a name="a22" doxytag="NLSOUND::CSourceCommon::getGain"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual 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]</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="classNLSOUND_1_1USource.html#z365_7">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00080">80</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00160">_Gain</a>. </td> + </tr> +</table> +<a name="a6" doxytag="NLSOUND::CSourceCommon::getLooping"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool 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]</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="classNLSOUND_1_1USource.html#z364_1">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="source__common_8cpp-source.html#l00088">88</a> of file <a class="el" href="source__common_8cpp-source.html">source_common.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00155">_Looping</a>. </td> + </tr> +</table> +<a name="a23" doxytag="NLSOUND::CSourceCommon::getPitch"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual 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]</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="classNLSOUND_1_1USource.html#z365_11">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00082">82</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00161">_Pitch</a>. </td> + </tr> +</table> +<a name="a11" doxytag="NLSOUND::CSourceCommon::getPos"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> const <a class="el" href="classNLMISC_1_1CVector.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]</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="classNLSOUND_1_1USource.html#z365_1">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="source__common_8cpp-source.html#l00122">122</a> of file <a class="el" href="source__common_8cpp-source.html">source_common.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00171">_3DPosition</a>, and <a class="el" href="source__common_8h-source.html#l00157">_Position</a>. </td> + </tr> +</table> +<a name="a4" doxytag="NLSOUND::CSourceCommon::getPriority"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="namespaceNLSOUND.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]</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="source__common_8h-source.html#l00057">57</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00153">_Priority</a>, and <a class="el" href="u__source_8h-source.html#l00072">NLSOUND::TSoundPriority</a>. </td> + </tr> +</table> +<a name="a16" doxytag="NLSOUND::CSourceCommon::getRelativeGain"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> 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]</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="classNLSOUND_1_1CSourceCommon.html#a15">setRelativeGain</a>()), or the absolute gain if getSource() is null. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1USource.html#z365_9">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="source__common_8cpp-source.html#l00186">186</a> of file <a class="el" href="source__common_8cpp-source.html">source_common.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00160">_Gain</a>, and <a class="el" href="source__common_8h-source.html#l00165">_InitialGain</a>. </td> + </tr> +</table> +<a name="a24" doxytag="NLSOUND::CSourceCommon::getSourceRelativeMode"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual bool 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]</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="classNLSOUND_1_1USource.html#z365_13">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00084">84</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00162">_RelativeMode</a>. </td> + </tr> +</table> +<a name="a28" doxytag="NLSOUND::CSourceCommon::getTime"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="memory__common_8h.html#a11">uint32</a> NLSOUND::CSourceCommon::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> +Implements <a class="el" href="classNLSOUND_1_1USource.html#z364_6">NLSOUND::USource</a>. +<p> +Reimplemented in <a class="el" href="classNLSOUND_1_1CComplexSource.html#z964_3">NLSOUND::CComplexSource</a>. +<p> +Definition at line <a class="el" href="source__common_8cpp-source.html#l00203">203</a> of file <a class="el" href="source__common_8cpp-source.html">source_common.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00168">_PlayStart</a>, and <a class="el" href="memory__common_8h-source.html#l00100">uint32</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NLSOUND::CSourceCommon::getType"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="classNLSOUND_1_1CSourceCommon.html#s3">TSOURCE_TYPE</a> NLSOUND::CSourceCommon::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> [pure 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> +Implemented in <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a6">NLSOUND::CBackgroundSource</a>. </td> + </tr> +</table> +<a name="a20" doxytag="NLSOUND::CSourceCommon::getVelocity"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::CSourceCommon::getVelocity </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1CVector.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]</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="classNLSOUND_1_1USource.html#z365_3">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00076">76</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00158">_Velocity</a>. </td> + </tr> +</table> +<a name="a9" doxytag="NLSOUND::CSourceCommon::isPlaying"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLSOUND::CSourceCommon::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> [inline, 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> +Implements <a class="el" href="classNLSOUND_1_1USource.html#z364_4">NLSOUND::USource</a>. +<p> +Reimplemented in <a class="el" href="classNLSOUND_1_1CComplexSource.html#z964_2">NLSOUND::CComplexSource</a>. +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00062">62</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00154">_Playing</a>. </td> + </tr> +</table> +<a name="a26" doxytag="NLSOUND::CSourceCommon::isSpawn"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool 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]</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="source__common_8h-source.html#l00088">88</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00174">_Spawn</a>. </td> + </tr> +</table> +<a name="a7" doxytag="NLSOUND::CSourceCommon::play"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSourceCommon::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> +Implements <a class="el" href="classNLSOUND_1_1USource.html#z364_2">NLSOUND::USource</a>. +<p> +Reimplemented in <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a4">NLSOUND::CBackgroundSource</a>. +<p> +Definition at line <a class="el" href="source__common_8cpp-source.html#l00096">96</a> of file <a class="el" href="source__common_8cpp-source.html">source_common.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00154">_Playing</a>, and <a class="el" href="source__common_8h-source.html#l00168">_PlayStart</a>. </td> + </tr> +</table> +<a name="a25" doxytag="NLSOUND::CSourceCommon::set3DPositionVector"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSourceCommon::set3DPositionVector </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.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]</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="source__common_8h-source.html#l00086">86</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00171">_3DPosition</a>. </td> + </tr> +</table> +<a name="a13" doxytag="NLSOUND::CSourceCommon::setDirection"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSourceCommon::setDirection </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.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> +Implements <a class="el" href="classNLSOUND_1_1USource.html#z365_4">NLSOUND::USource</a>. +<p> +Reimplemented in <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a11">NLSOUND::CBackgroundSource</a>. +<p> +Definition at line <a class="el" href="source__common_8cpp-source.html#l00156">156</a> of file <a class="el" href="source__common_8cpp-source.html">source_common.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00159">_Direction</a>. </td> + </tr> +</table> +<a name="a14" doxytag="NLSOUND::CSourceCommon::setGain"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSourceCommon::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]). +<p> +(default: 1) 0.0 -> silence 0.5 -> -6dB 1.0 -> no attenuation values > 1 (amplification) not supported by most drivers +<p> +Implements <a class="el" href="classNLSOUND_1_1USource.html#z365_6">NLSOUND::USource</a>. +<p> +Reimplemented in <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a7">NLSOUND::CBackgroundSource</a>. +<p> +Definition at line <a class="el" href="source__common_8cpp-source.html#l00167">167</a> of file <a class="el" href="source__common_8cpp-source.html">source_common.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00160">_Gain</a>, <a class="el" href="source__common_8h-source.html#l00165">_InitialGain</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. </td> + </tr> +</table> +<a name="a5" doxytag="NLSOUND::CSourceCommon::setLooping"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSourceCommon::setLooping </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>loop</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> +Implements <a class="el" href="classNLSOUND_1_1USource.html#z364_0">NLSOUND::USource</a>. +<p> +Reimplemented in <a class="el" href="classNLSOUND_1_1CSimpleSource.html#z982_0">NLSOUND::CSimpleSource</a>. +<p> +Definition at line <a class="el" href="source__common_8cpp-source.html#l00080">80</a> of file <a class="el" href="source__common_8cpp-source.html">source_common.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00155">_Looping</a>, and <a class="el" href="opcode__register_8cpp-source.html#l00036">NLAISCRIPT::l</a>. </td> + </tr> +</table> +<a name="a27" doxytag="NLSOUND::CSourceCommon::setPitch"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSourceCommon::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. +<p> +1.0f equals identity, each reduction of 50% equals a pitch shift of one octave. 0 is not a legal value. +<p> +Implements <a class="el" href="classNLSOUND_1_1USource.html#z365_10">NLSOUND::USource</a>. +<p> +Reimplemented in <a class="el" href="classNLSOUND_1_1CSimpleSource.html#a9">NLSOUND::CSimpleSource</a>. +<p> +Definition at line <a class="el" href="source__common_8cpp-source.html#l00138">138</a> of file <a class="el" href="source__common_8cpp-source.html">source_common.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00161">_Pitch</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. </td> + </tr> +</table> +<a name="a10" doxytag="NLSOUND::CSourceCommon::setPos"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSourceCommon::setPos </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.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)). +<p> +3D mode -> 3D position st mode -> x is the pan value (from left (-1) to right (1)), set y and z to 0 +<p> +Implements <a class="el" href="classNLSOUND_1_1USource.html#z365_0">NLSOUND::USource</a>. +<p> +Reimplemented in <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a9">NLSOUND::CBackgroundSource</a>. +<p> +Definition at line <a class="el" href="source__common_8cpp-source.html#l00114">114</a> of file <a class="el" href="source__common_8cpp-source.html">source_common.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00157">_Position</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NLSOUND::CSourceCommon::setPriority"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSourceCommon::setPriority </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLSOUND.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]</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="classNLSOUND_1_1USource.html#a1">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="source__common_8cpp-source.html#l00065">65</a> of file <a class="el" href="source__common_8cpp-source.html">source_common.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00153">_Priority</a>, and <a class="el" href="u__source_8h-source.html#l00072">NLSOUND::TSoundPriority</a>. </td> + </tr> +</table> +<a name="a15" doxytag="NLSOUND::CSourceCommon::setRelativeGain"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSourceCommon::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="classNLSOUND_1_1CSourceCommon.html#a22">getGain</a>()). +<p> +Does nothing if getSource() is null. +<p> +Implements <a class="el" href="classNLSOUND_1_1USource.html#z365_8">NLSOUND::USource</a>. +<p> +Reimplemented in <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a8">NLSOUND::CBackgroundSource</a>. +<p> +Definition at line <a class="el" href="source__common_8cpp-source.html#l00176">176</a> of file <a class="el" href="source__common_8cpp-source.html">source_common.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00160">_Gain</a>, <a class="el" href="source__common_8h-source.html#l00165">_InitialGain</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. </td> + </tr> +</table> +<a name="a17" doxytag="NLSOUND::CSourceCommon::setSourceRelativeMode"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSourceCommon::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> +Implements <a class="el" href="classNLSOUND_1_1USource.html#z365_12">NLSOUND::USource</a>. +<p> +Reimplemented in <a class="el" href="classNLSOUND_1_1CSimpleSource.html#a10">NLSOUND::CSimpleSource</a>. +<p> +Definition at line <a class="el" href="source__common_8cpp-source.html#l00197">197</a> of file <a class="el" href="source__common_8cpp-source.html">source_common.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00162">_RelativeMode</a>. </td> + </tr> +</table> +<a name="a12" doxytag="NLSOUND::CSourceCommon::setVelocity"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSourceCommon::setVelocity </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.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> +Implements <a class="el" href="classNLSOUND_1_1USource.html#z365_2">NLSOUND::USource</a>. +<p> +Reimplemented in <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a10">NLSOUND::CBackgroundSource</a>. +<p> +Definition at line <a class="el" href="source__common_8cpp-source.html#l00148">148</a> of file <a class="el" href="source__common_8cpp-source.html">source_common.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00158">_Velocity</a>. </td> + </tr> +</table> +<a name="a8" doxytag="NLSOUND::CSourceCommon::stop"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSourceCommon::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> +Implements <a class="el" href="classNLSOUND_1_1USource.html#z364_3">NLSOUND::USource</a>. +<p> +Reimplemented in <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a5">NLSOUND::CBackgroundSource</a>. +<p> +Definition at line <a class="el" href="source__common_8cpp-source.html#l00105">105</a> of file <a class="el" href="source__common_8cpp-source.html">source_common.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00154">_Playing</a>. </td> + </tr> +</table> +<a name="a19" doxytag="NLSOUND::CSourceCommon::unregisterSpawnCallBack"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void 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]</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="classNLSOUND_1_1USource.html#z364_5">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00074">74</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00175">_SpawnEndCb</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="n11" doxytag="NLSOUND::CSourceCommon::_3DPosition"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>* NLSOUND::CSourceCommon::_3DPosition<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00171">171</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="source__common_8cpp-source.html#l00122">getPos</a>, and <a class="el" href="source__common_8h-source.html#l00086">set3DPositionVector</a>. </td> + </tr> +</table> +<a name="n14" doxytag="NLSOUND::CSourceCommon::_CbUserParam"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void* NLSOUND::CSourceCommon::_CbUserParam<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00176">176</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="source__common_8h-source.html#l00072">getCallbackUserParam</a>, <a class="el" href="simple__source_8cpp-source.html#l00110">NLSOUND::CSimpleSource::play</a>, and <a class="el" href="simple__source_8cpp-source.html#l00195">NLSOUND::CSimpleSource::stop</a>. </td> + </tr> +</table> +<a name="n5" doxytag="NLSOUND::CSourceCommon::_Direction"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> NLSOUND::CSourceCommon::_Direction<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00159">159</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="simple__source_8cpp-source.html#l00044">NLSOUND::CSimpleSource::CSimpleSource</a>, <a class="el" href="source__common_8h-source.html#l00078">getDirection</a>, <a class="el" href="simple__source_8cpp-source.html#l00110">NLSOUND::CSimpleSource::play</a>, and <a class="el" href="source__common_8cpp-source.html#l00156">setDirection</a>. </td> + </tr> +</table> +<a name="n6" doxytag="NLSOUND::CSourceCommon::_Gain"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> float NLSOUND::CSourceCommon::_Gain<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00160">160</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="complex__source_8cpp-source.html#l00037">NLSOUND::CComplexSource::CComplexSource</a>, <a class="el" href="simple__source_8cpp-source.html#l00044">NLSOUND::CSimpleSource::CSimpleSource</a>, <a class="el" href="source__common_8h-source.html#l00080">getGain</a>, <a class="el" href="source__common_8cpp-source.html#l00186">getRelativeGain</a>, <a class="el" href="complex__source_8cpp-source.html#l00493">NLSOUND::CComplexSource::onEvent</a>, <a class="el" href="complex__source_8cpp-source.html#l00380">NLSOUND::CComplexSource::onUpdate</a>, <a class="el" href="background__source_8cpp-source.html#l00189">NLSOUND::CBackgroundSource::onUpdate</a>, <a class="el" href="simple__source_8cpp-source.html#l00110">NLSOUND::CSimpleSource::play</a>, <a class="el" href="complex__source_8cpp-source.html#l00096">NLSOUND::CComplexSource::play</a>, <a class="el" href="background__source_8cpp-source.html#l00122">NLSOUND::CBackgroundSource::play</a>, <a class="el" href="source__common_8cpp-source.html#l00167">setGain</a>, <a class="el" href="complex__source_8cpp-source.html#l00314">NLSOUND::CComplexSource::setGain</a>, <a class="el" href="background__source_8cpp-source.html#l00062">NLSOUND::CBackgroundSource::setGain</a>, <a class="el" href="source__common_8cpp-source.html#l00176">setRelativeGain</a>, <a class="el" href="simple__source_8cpp-source.html#l00311">NLSOUND::CSimpleSource::setRelativeGain</a>, <a class="el" href="complex__source_8cpp-source.html#l00330">NLSOUND::CComplexSource::setRelativeGain</a>, and <a class="el" href="background__source_8cpp-source.html#l00073">NLSOUND::CBackgroundSource::setRelativeGain</a>. </td> + </tr> +</table> +<a name="n9" doxytag="NLSOUND::CSourceCommon::_InitialGain"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> float NLSOUND::CSourceCommon::_InitialGain<code> [protected]</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="source__common_8h-source.html#l00165">165</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="simple__source_8cpp-source.html#l00044">NLSOUND::CSimpleSource::CSimpleSource</a>, <a class="el" href="source__common_8cpp-source.html#l00186">getRelativeGain</a>, <a class="el" href="source__common_8cpp-source.html#l00167">setGain</a>, and <a class="el" href="source__common_8cpp-source.html#l00176">setRelativeGain</a>. </td> + </tr> +</table> +<a name="n2" doxytag="NLSOUND::CSourceCommon::_Looping"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLSOUND::CSourceCommon::_Looping<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00155">155</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="complex__source_8cpp-source.html#l00037">NLSOUND::CComplexSource::CComplexSource</a>, <a class="el" href="simple__source_8cpp-source.html#l00044">NLSOUND::CSimpleSource::CSimpleSource</a>, <a class="el" href="source__common_8cpp-source.html#l00088">getLooping</a>, <a class="el" href="complex__source_8cpp-source.html#l00493">NLSOUND::CComplexSource::onEvent</a>, <a class="el" href="simple__source_8cpp-source.html#l00110">NLSOUND::CSimpleSource::play</a>, and <a class="el" href="source__common_8cpp-source.html#l00080">setLooping</a>. </td> + </tr> +</table> +<a name="n7" doxytag="NLSOUND::CSourceCommon::_Pitch"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> float NLSOUND::CSourceCommon::_Pitch<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00161">161</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="complex__source_8cpp-source.html#l00037">NLSOUND::CComplexSource::CComplexSource</a>, <a class="el" href="simple__source_8cpp-source.html#l00044">NLSOUND::CSimpleSource::CSimpleSource</a>, <a class="el" href="source__common_8h-source.html#l00082">getPitch</a>, <a class="el" href="simple__source_8cpp-source.html#l00110">NLSOUND::CSimpleSource::play</a>, and <a class="el" href="source__common_8cpp-source.html#l00138">setPitch</a>. </td> + </tr> +</table> +<a name="n1" doxytag="NLSOUND::CSourceCommon::_Playing"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLSOUND::CSourceCommon::_Playing<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00154">154</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="complex__source_8cpp-source.html#l00365">NLSOUND::CComplexSource::getTime</a>, <a class="el" href="source__common_8h-source.html#l00062">isPlaying</a>, <a class="el" href="simple__source_8cpp-source.html#l00355">NLSOUND::CSimpleSource::isPlaying</a>, <a class="el" href="complex__source_8cpp-source.html#l00091">NLSOUND::CComplexSource::isPlaying</a>, <a class="el" href="simple__source_8cpp-source.html#l00182">NLSOUND::CSimpleSource::onEvent</a>, <a class="el" href="complex__source_8cpp-source.html#l00493">NLSOUND::CComplexSource::onEvent</a>, <a class="el" href="complex__source_8cpp-source.html#l00380">NLSOUND::CComplexSource::onUpdate</a>, <a class="el" href="source__common_8cpp-source.html#l00096">play</a>, <a class="el" href="source__common_8cpp-source.html#l00105">stop</a>, and <a class="el" href="simple__source_8cpp-source.html#l00195">NLSOUND::CSimpleSource::stop</a>. </td> + </tr> +</table> +<a name="n10" doxytag="NLSOUND::CSourceCommon::_PlayStart"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="namespaceNLMISC.html#a183">NLMISC::TTime</a> NLSOUND::CSourceCommon::_PlayStart<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00168">168</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="simple__source_8h-source.html#l00083">NLSOUND::CSimpleSource::getPlayTime</a>, <a class="el" href="source__common_8cpp-source.html#l00203">getTime</a>, <a class="el" href="complex__source_8cpp-source.html#l00365">NLSOUND::CComplexSource::getTime</a>, and <a class="el" href="source__common_8cpp-source.html#l00096">play</a>. </td> + </tr> +</table> +<a name="n3" doxytag="NLSOUND::CSourceCommon::_Position"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> NLSOUND::CSourceCommon::_Position<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00157">157</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="source__common_8cpp-source.html#l00122">getPos</a>, <a class="el" href="complex__source_8cpp-source.html#l00493">NLSOUND::CComplexSource::onEvent</a>, <a class="el" href="background__source_8cpp-source.html#l00246">NLSOUND::CBackgroundSource::onEvent</a>, <a class="el" href="simple__source_8cpp-source.html#l00110">NLSOUND::CSimpleSource::play</a>, <a class="el" href="complex__source_8cpp-source.html#l00096">NLSOUND::CComplexSource::play</a>, <a class="el" href="background__source_8cpp-source.html#l00122">NLSOUND::CBackgroundSource::play</a>, and <a class="el" href="source__common_8cpp-source.html#l00114">setPos</a>. </td> + </tr> +</table> +<a name="n0" doxytag="NLSOUND::CSourceCommon::_Priority"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="namespaceNLSOUND.html#a82">TSoundPriority</a> NLSOUND::CSourceCommon::_Priority<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Shift the frequency. +<p> +1.0f equals identity, each reduction of 50% equals a pitch shift of one octave. 0 is not a legal value. +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00153">153</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="complex__source_8cpp-source.html#l00037">NLSOUND::CComplexSource::CComplexSource</a>, <a class="el" href="simple__source_8cpp-source.html#l00044">NLSOUND::CSimpleSource::CSimpleSource</a>, <a class="el" href="source__common_8h-source.html#l00057">getPriority</a>, <a class="el" href="simple__source_8cpp-source.html#l00110">NLSOUND::CSimpleSource::play</a>, and <a class="el" href="source__common_8cpp-source.html#l00065">setPriority</a>. </td> + </tr> +</table> +<a name="n8" doxytag="NLSOUND::CSourceCommon::_RelativeMode"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLSOUND::CSourceCommon::_RelativeMode<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00162">162</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="source__common_8h-source.html#l00084">getSourceRelativeMode</a>, <a class="el" href="simple__source_8cpp-source.html#l00110">NLSOUND::CSimpleSource::play</a>, and <a class="el" href="source__common_8cpp-source.html#l00197">setSourceRelativeMode</a>. </td> + </tr> +</table> +<a name="n12" doxytag="NLSOUND::CSourceCommon::_Spawn"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> const bool NLSOUND::CSourceCommon::_Spawn<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00174">174</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="source__common_8h-source.html#l00088">isSpawn</a>. </td> + </tr> +</table> +<a name="n13" doxytag="NLSOUND::CSourceCommon::_SpawnEndCb"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="namespaceNLSOUND.html#a9">TSpawnEndCallback</a> NLSOUND::CSourceCommon::_SpawnEndCb<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00175">175</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="simple__source_8h-source.html#l00126">NLSOUND::CSimpleSource::getSpawnEndCallback</a>, <a class="el" href="simple__source_8cpp-source.html#l00110">NLSOUND::CSimpleSource::play</a>, <a class="el" href="simple__source_8cpp-source.html#l00195">NLSOUND::CSimpleSource::stop</a>, and <a class="el" href="source__common_8h-source.html#l00074">unregisterSpawnCallBack</a>. </td> + </tr> +</table> +<a name="n4" doxytag="NLSOUND::CSourceCommon::_Velocity"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> NLSOUND::CSourceCommon::_Velocity<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="source__common_8h-source.html#l00158">158</a> of file <a class="el" href="source__common_8h-source.html">source_common.h</a>. +<p> +Referenced by <a class="el" href="source__common_8h-source.html#l00076">getVelocity</a>, <a class="el" href="simple__source_8cpp-source.html#l00110">NLSOUND::CSimpleSource::play</a>, and <a class="el" href="source__common_8cpp-source.html#l00148">setVelocity</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="source__common_8h-source.html">source_common.h</a><li><a class="el" href="source__common_8cpp-source.html">source_common.cpp</a></ul> + + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |