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_1CSimpleSource.html | |
| download | nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.tar.xz nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.zip | |
Initial commit
Diffstat (limited to 'docs/doxygen/nel/classNLSOUND_1_1CSimpleSource.html')
| -rw-r--r-- | docs/doxygen/nel/classNLSOUND_1_1CSimpleSource.html | 1065 |
1 files changed, 1065 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLSOUND_1_1CSimpleSource.html b/docs/doxygen/nel/classNLSOUND_1_1CSimpleSource.html new file mode 100644 index 00000000..03053dcf --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1CSimpleSource.html @@ -0,0 +1,1065 @@ +<!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::CSimpleSource Class Reference</h1>Implementation of <a class="el" href="classNLSOUND_1_1USource.html">USource</a>. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="simple__source_8h-source.html">simple_source.h</a>></code> +<p> +<p>Inheritance diagram for NLSOUND::CSimpleSource: +<p><center><img src="classNLSOUND_1_1CSimpleSource.gif" usemap="#NLSOUND::CSimpleSource_map" border="0"></center> +<map name="NLSOUND::CSimpleSource_map"> +<area href="classNLSOUND_1_1CSourceCommon.html" alt="NLSOUND::CSourceCommon" shape="rect" coords="0,56,251,80"> +<area href="classNLSOUND_1_1CAudioMixerUser_1_1IMixerEvent.html" alt="NLSOUND::CAudioMixerUser::IMixerEvent" shape="rect" coords="261,56,512,80"> +<area href="classNLSOUND_1_1USource.html" alt="NLSOUND::USource" shape="rect" coords="0,0,251,24"> +</map> +<a href="classNLSOUND_1_1CSimpleSource-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSource.html#a0">CSimpleSource</a> (<a class="el" href="classNLSOUND_1_1CSimpleSound.html">CSimpleSound</a> *simpleSound=NULL, bool spawn=false, <a class="el" href="namespaceNLSOUND.html#a9">TSpawnEndCallback</a> cb=0, void *cbUserParam=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSource.html#a1">~CSimpleSource</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Destructor.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespaceNLSOUND.html#a8">TSoundId</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSource.html#a2">getSound</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the sound binded to the source (or NULL if there is no sound).</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLSOUND_1_1CSimpleSound.html">CSimpleSound</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSource.html#a3">getSimpleSound</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the simple sound bound to the source (or NULL).</em> <a href="#a3">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_1CSimpleSource.html#a4">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="#a4">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_1CSimpleSource.html#a5">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="#a5">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_1CSimpleSource.html#a6">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="#a6">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_1CSimpleSource.html#a7">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="#a7">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_1CSimpleSource.html#a8">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="#a8">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_1CSimpleSource.html#a9">setPitch</a> (float pitch)</td></tr> +<tr><td> </td><td><font size=-1><em>Shift the frequency.</em> <a href="#a9">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_1CSimpleSource.html#a10">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="#a10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLSOUND_1_1CTrack.html">CTrack</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSource.html#a11">getTrack</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the track.</em> <a href="#a11">More...</a><em></em></font><br><br></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_1CSimpleSource.html#a12">getSpawnEndCallback</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the spawn end callback.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSource.html#a13">getBuffer</a> ()</td></tr> +<tr><td colspan="2"><div class="groupHeader">Playback control</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSource.html#z982_0">setLooping</a> (bool l)</td></tr> +<tr><td> </td><td><font size=-1><em>Set looping on/off for future playbacks (default: off).</em> <a href="#z982_0">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_1CSimpleSource.html#z982_1">play</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Play.</em> <a href="#z982_1">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_1CSimpleSource.html#z982_2">stop</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Stop playing.</em> <a href="#z982_2">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_1CSimpleSource.html#z982_3">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="#z982_3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespaceNLMISC.html#a184">NLMISC::TTicks</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSource.html#z982_4">getPlayTime</a> ()</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_1CSimpleSource.html#z982_5">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="#z982_5">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSource.html#c0">onEvent</a> ()</td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLSOUND_1_1CSourceCommon.html#s3">TSOURCE_TYPE</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSource.html#c1">getType</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the type the the source.</em> <a href="#c1">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLSOUND_1_1CSimpleSound.html">CSimpleSound</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSource.html#o0">_Sound</a></td></tr> +<tr><td nowrap align=right valign=top>float </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSource.html#o1">_Alpha</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLSOUND_1_1CTrack.html">CTrack</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSource.html#o2">_Track</a></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSource.html#o3">_PlayMuted</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Implementation of <a class="el" href="classNLSOUND_1_1USource.html">USource</a>. +<p> +<dl compact><dt><b> +Author: </b><dd> +Olivier Cado , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2001 </dl> +<p> + +<p> +Definition at line <a class="el" href="simple__source_8h-source.html#l00051">51</a> of file <a class="el" href="simple__source_8h-source.html">simple_source.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NLSOUND::CSimpleSource::CSimpleSource"></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::CSimpleSource::CSimpleSource </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLSOUND_1_1CSimpleSound.html">CSimpleSound</a> * </td> + <td class="mdname" nowrap> <em>simpleSound</em> = NULL, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>spawn</em> = false, </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> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>cbUserParam</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="simple__source_8cpp-source.html#l00044">44</a> of file <a class="el" href="simple__source_8cpp-source.html">simple_source.cpp</a>. +<p> +References <a class="el" href="simple__source_8h-source.html#l00142">_Alpha</a>, <a class="el" href="source__common_8h-source.html#l00159">NLSOUND::CSourceCommon::_Direction</a>, <a class="el" href="source__common_8h-source.html#l00160">NLSOUND::CSourceCommon::_Gain</a>, <a class="el" href="source__common_8h-source.html#l00165">NLSOUND::CSourceCommon::_InitialGain</a>, <a class="el" href="source__common_8h-source.html#l00155">NLSOUND::CSourceCommon::_Looping</a>, <a class="el" href="source__common_8h-source.html#l00161">NLSOUND::CSourceCommon::_Pitch</a>, <a class="el" href="source__common_8h-source.html#l00153">NLSOUND::CSourceCommon::_Priority</a>, <a class="el" href="simple__source_8h-source.html#l00139">_Sound</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, and <a class="el" href="u__source_8h-source.html#l00076">NLSOUND::TSpawnEndCallback</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLSOUND::CSimpleSource::~CSimpleSource"></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::CSimpleSource::~CSimpleSource </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="simple__source_8cpp-source.html#l00064">64</a> of file <a class="el" href="simple__source_8cpp-source.html">simple_source.cpp</a>. +<p> +References <a class="el" href="simple__source_8cpp-source.html#l00195">stop</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a13" doxytag="NLSOUND::CSimpleSource::getBuffer"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLSOUND_1_1IBuffer.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="simple__source_8cpp-source.html#l00086">86</a> of file <a class="el" href="simple__source_8cpp-source.html">simple_source.cpp</a>. +<p> +References <a class="el" href="simple__source_8h-source.html#l00139">_Sound</a>. </td> + </tr> +</table> +<a name="z982_4" doxytag="NLSOUND::CSimpleSource::getPlayTime"></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="namespaceNLMISC.html#a184">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="simple__source_8h-source.html#l00083">83</a> of file <a class="el" href="simple__source_8h-source.html">simple_source.h</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00168">NLSOUND::CSourceCommon::_PlayStart</a>, and <a class="el" href="time__nl_8cpp-source.html#l00055">NLMISC::CTime::getLocalTime</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NLSOUND::CSimpleSource::getSimpleSound"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLSOUND_1_1CSimpleSound.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="simple__source_8cpp-source.html#l00070">70</a> of file <a class="el" href="simple__source_8cpp-source.html">simple_source.cpp</a>. +<p> +References <a class="el" href="simple__source_8h-source.html#l00139">_Sound</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NLSOUND::CSimpleSource::getSound"></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="namespaceNLSOUND.html#a8">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="classNLSOUND_1_1USource.html#a0">NLSOUND::USource</a>. +<p> +Definition at line <a class="el" href="simple__source_8h-source.html#l00068">68</a> of file <a class="el" href="simple__source_8h-source.html">simple_source.h</a>. +<p> +References <a class="el" href="simple__source_8h-source.html#l00139">_Sound</a>, and <a class="el" href="u__source_8h-source.html#l00069">NLSOUND::TSoundId</a>. </td> + </tr> +</table> +<a name="a12" doxytag="NLSOUND::CSimpleSource::getSpawnEndCallback"></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::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="simple__source_8h-source.html#l00126">126</a> of file <a class="el" href="simple__source_8h-source.html">simple_source.h</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00175">NLSOUND::CSourceCommon::_SpawnEndCb</a>, and <a class="el" href="u__source_8h-source.html#l00076">NLSOUND::TSpawnEndCallback</a>. </td> + </tr> +</table> +<a name="z982_5" doxytag="NLSOUND::CSimpleSource::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::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="classNLSOUND_1_1CSourceCommon.html#a28">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="simple__source_8cpp-source.html#l00075">75</a> of file <a class="el" href="simple__source_8cpp-source.html">simple_source.cpp</a>. +<p> +References <a class="el" href="simple__source_8h-source.html#l00145">_Track</a>. </td> + </tr> +</table> +<a name="a11" doxytag="NLSOUND::CSimpleSource::getTrack"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLSOUND_1_1CTrack.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="simple__source_8h-source.html#l00124">124</a> of file <a class="el" href="simple__source_8h-source.html">simple_source.h</a>. +<p> +References <a class="el" href="simple__source_8h-source.html#l00145">_Track</a>. </td> + </tr> +</table> +<a name="c1" doxytag="NLSOUND::CSimpleSource::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"> <a class="el" href="classNLSOUND_1_1CSourceCommon.html#s3">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="classNLSOUND_1_1CSourceCommon.html#a2">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="simple__source_8h-source.html#l00136">136</a> of file <a class="el" href="simple__source_8h-source.html">simple_source.h</a>. +<p> +References <a class="el" href="classNLSOUND_1_1CSourceCommon.html#s3s0">NLSOUND::CSourceCommon::SOURCE_SIMPLE</a>, and <a class="el" href="source__common_8h-source.html#l00040">NLSOUND::CSourceCommon::TSOURCE_TYPE</a>. </td> + </tr> +</table> +<a name="z982_3" doxytag="NLSOUND::CSimpleSource::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::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="classNLSOUND_1_1CSourceCommon.html#a9">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="simple__source_8cpp-source.html#l00355">355</a> of file <a class="el" href="simple__source_8cpp-source.html">simple_source.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00154">NLSOUND::CSourceCommon::_Playing</a>. </td> + </tr> +</table> +<a name="c0" doxytag="NLSOUND::CSimpleSource::onEvent"></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::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="classNLSOUND_1_1CAudioMixerUser_1_1IMixerEvent.html#a0">NLSOUND::CAudioMixerUser::IMixerEvent</a>. +<p> +Definition at line <a class="el" href="simple__source_8cpp-source.html#l00182">182</a> of file <a class="el" href="simple__source_8cpp-source.html">simple_source.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00154">NLSOUND::CSourceCommon::_Playing</a>, <a class="el" href="simple__source_8h-source.html#l00147">_PlayMuted</a>, <a class="el" href="simple__source_8h-source.html#l00145">_Track</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, and <a class="el" href="simple__source_8cpp-source.html#l00195">stop</a>. </td> + </tr> +</table> +<a name="z982_1" doxytag="NLSOUND::CSimpleSource::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::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="classNLSOUND_1_1CSourceCommon.html#a7">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="simple__source_8cpp-source.html#l00110">110</a> of file <a class="el" href="simple__source_8cpp-source.html">simple_source.cpp</a>. +<p> +References <a class="el" href="simple__source_8h-source.html#l00142">_Alpha</a>, <a class="el" href="source__common_8h-source.html#l00176">NLSOUND::CSourceCommon::_CbUserParam</a>, <a class="el" href="source__common_8h-source.html#l00159">NLSOUND::CSourceCommon::_Direction</a>, <a class="el" href="source__common_8h-source.html#l00160">NLSOUND::CSourceCommon::_Gain</a>, <a class="el" href="source__common_8h-source.html#l00155">NLSOUND::CSourceCommon::_Looping</a>, <a class="el" href="source__common_8h-source.html#l00161">NLSOUND::CSourceCommon::_Pitch</a>, <a class="el" href="simple__source_8h-source.html#l00147">_PlayMuted</a>, <a class="el" href="source__common_8h-source.html#l00157">NLSOUND::CSourceCommon::_Position</a>, <a class="el" href="source__common_8h-source.html#l00153">NLSOUND::CSourceCommon::_Priority</a>, <a class="el" href="source__common_8h-source.html#l00162">NLSOUND::CSourceCommon::_RelativeMode</a>, <a class="el" href="simple__source_8h-source.html#l00139">_Sound</a>, <a class="el" href="source__common_8h-source.html#l00175">NLSOUND::CSourceCommon::_SpawnEndCb</a>, <a class="el" href="simple__source_8h-source.html#l00145">_Track</a>, <a class="el" href="source__common_8h-source.html#l00158">NLSOUND::CSourceCommon::_Velocity</a>, <a class="el" href="namespaceNLSOUND.html#a82a10">NLSOUND::HighestPri</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, <a class="el" href="simple__source_8cpp-source.html#l00110">play</a>, and <a class="el" href="simple__source_8cpp-source.html#l00264">setDirection</a>. +<p> +Referenced by <a class="el" href="simple__source_8cpp-source.html#l00110">play</a>. </td> + </tr> +</table> +<a name="a6" doxytag="NLSOUND::CSimpleSource::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::CSimpleSource::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> +Reimplemented from <a class="el" href="classNLSOUND_1_1CSourceCommon.html#a13">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="simple__source_8cpp-source.html#l00264">264</a> of file <a class="el" href="simple__source_8cpp-source.html">simple_source.cpp</a>. +<p> +References <a class="el" href="simple__source_8h-source.html#l00139">_Sound</a>, <a class="el" href="simple__source_8h-source.html#l00145">_Track</a>, <a class="el" href="vector__inline_8h-source.html#l00148">NLMISC::CVector::isNull</a>, and <a class="el" href="common_8h-source.html#l00071">NLMISC::Pi</a>. +<p> +Referenced by <a class="el" href="simple__source_8cpp-source.html#l00110">play</a>. </td> + </tr> +</table> +<a name="a7" doxytag="NLSOUND::CSimpleSource::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::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]). +<p> +(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="classNLSOUND_1_1CSourceCommon.html#a14">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="simple__source_8cpp-source.html#l00300">300</a> of file <a class="el" href="simple__source_8cpp-source.html">simple_source.cpp</a>. +<p> +References <a class="el" href="simple__source_8h-source.html#l00145">_Track</a>. </td> + </tr> +</table> +<a name="z982_0" doxytag="NLSOUND::CSimpleSource::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::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="classNLSOUND_1_1CSourceCommon.html#a5">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="simple__source_8cpp-source.html#l00097">97</a> of file <a class="el" href="simple__source_8cpp-source.html">simple_source.cpp</a>. +<p> +References <a class="el" href="simple__source_8h-source.html#l00145">_Track</a>, and <a class="el" href="opcode__register_8cpp-source.html#l00036">NLAISCRIPT::l</a>. </td> + </tr> +</table> +<a name="a9" doxytag="NLSOUND::CSimpleSource::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::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. +<p> +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="classNLSOUND_1_1CSourceCommon.html#a27">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="simple__source_8cpp-source.html#l00326">326</a> of file <a class="el" href="simple__source_8cpp-source.html">simple_source.cpp</a>. +<p> +References <a class="el" href="simple__source_8h-source.html#l00145">_Track</a>. </td> + </tr> +</table> +<a name="a4" doxytag="NLSOUND::CSimpleSource::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::CSimpleSource::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> +Reimplemented from <a class="el" href="classNLSOUND_1_1CSourceCommon.html#a10">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="simple__source_8cpp-source.html#l00233">233</a> of file <a class="el" href="simple__source_8cpp-source.html">simple_source.cpp</a>. +<p> +References <a class="el" href="simple__source_8h-source.html#l00145">_Track</a>. </td> + </tr> +</table> +<a name="a8" doxytag="NLSOUND::CSimpleSource::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::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="classNLSOUND_1_1CSourceCommon.html#a22">getGain</a>()). +<p> +Does nothing if getSource() is null. +<p> +Reimplemented from <a class="el" href="classNLSOUND_1_1CSourceCommon.html#a15">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="simple__source_8cpp-source.html#l00311">311</a> of file <a class="el" href="simple__source_8cpp-source.html">simple_source.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00160">NLSOUND::CSourceCommon::_Gain</a>, and <a class="el" href="simple__source_8h-source.html#l00145">_Track</a>. </td> + </tr> +</table> +<a name="a10" doxytag="NLSOUND::CSimpleSource::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::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="classNLSOUND_1_1CSourceCommon.html#a17">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="simple__source_8cpp-source.html#l00341">341</a> of file <a class="el" href="simple__source_8cpp-source.html">simple_source.cpp</a>. +<p> +References <a class="el" href="simple__source_8h-source.html#l00145">_Track</a>. </td> + </tr> +</table> +<a name="a5" doxytag="NLSOUND::CSimpleSource::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::CSimpleSource::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> +If the source is stereo, return the position vector which reference was passed to <a class="el" href="classNLSOUND_1_1CSourceCommon.html#a25">set3DPositionVector</a>() +<p> +Reimplemented from <a class="el" href="classNLSOUND_1_1CSourceCommon.html#a12">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="simple__source_8cpp-source.html#l00248">248</a> of file <a class="el" href="simple__source_8cpp-source.html">simple_source.cpp</a>. +<p> +References <a class="el" href="simple__source_8h-source.html#l00145">_Track</a>. </td> + </tr> +</table> +<a name="z982_2" doxytag="NLSOUND::CSimpleSource::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::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="classNLSOUND_1_1CSourceCommon.html#a8">NLSOUND::CSourceCommon</a>. +<p> +Definition at line <a class="el" href="simple__source_8cpp-source.html#l00195">195</a> of file <a class="el" href="simple__source_8cpp-source.html">simple_source.cpp</a>. +<p> +References <a class="el" href="source__common_8h-source.html#l00176">NLSOUND::CSourceCommon::_CbUserParam</a>, <a class="el" href="source__common_8h-source.html#l00154">NLSOUND::CSourceCommon::_Playing</a>, <a class="el" href="source__common_8h-source.html#l00175">NLSOUND::CSourceCommon::_SpawnEndCb</a>, <a class="el" href="simple__source_8h-source.html#l00145">_Track</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. +<p> +Referenced by <a class="el" href="simple__source_8cpp-source.html#l00182">onEvent</a>, and <a class="el" href="simple__source_8cpp-source.html#l00064">~CSimpleSource</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="o1" doxytag="NLSOUND::CSimpleSource::_Alpha"></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::CSimpleSource::_Alpha<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="simple__source_8h-source.html#l00142">142</a> of file <a class="el" href="simple__source_8h-source.html">simple_source.h</a>. +<p> +Referenced by <a class="el" href="simple__source_8cpp-source.html#l00044">CSimpleSource</a>, and <a class="el" href="simple__source_8cpp-source.html#l00110">play</a>. </td> + </tr> +</table> +<a name="o3" doxytag="NLSOUND::CSimpleSource::_PlayMuted"></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::CSimpleSource::_PlayMuted<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="simple__source_8h-source.html#l00147">147</a> of file <a class="el" href="simple__source_8h-source.html">simple_source.h</a>. +<p> +Referenced by <a class="el" href="simple__source_8cpp-source.html#l00182">onEvent</a>, and <a class="el" href="simple__source_8cpp-source.html#l00110">play</a>. </td> + </tr> +</table> +<a name="o0" doxytag="NLSOUND::CSimpleSource::_Sound"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLSOUND_1_1CSimpleSound.html">CSimpleSound</a>* NLSOUND::CSimpleSource::_Sound<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="simple__source_8h-source.html#l00139">139</a> of file <a class="el" href="simple__source_8h-source.html">simple_source.h</a>. +<p> +Referenced by <a class="el" href="simple__source_8cpp-source.html#l00044">CSimpleSource</a>, <a class="el" href="simple__source_8cpp-source.html#l00086">getBuffer</a>, <a class="el" href="simple__source_8cpp-source.html#l00070">getSimpleSound</a>, <a class="el" href="simple__source_8h-source.html#l00068">getSound</a>, <a class="el" href="simple__source_8cpp-source.html#l00110">play</a>, and <a class="el" href="simple__source_8cpp-source.html#l00264">setDirection</a>. </td> + </tr> +</table> +<a name="o2" doxytag="NLSOUND::CSimpleSource::_Track"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLSOUND_1_1CTrack.html">CTrack</a>* NLSOUND::CSimpleSource::_Track<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="simple__source_8h-source.html#l00145">145</a> of file <a class="el" href="simple__source_8h-source.html">simple_source.h</a>. +<p> +Referenced by <a class="el" href="simple__source_8cpp-source.html#l00075">getTime</a>, <a class="el" href="simple__source_8h-source.html#l00124">getTrack</a>, <a class="el" href="simple__source_8cpp-source.html#l00182">onEvent</a>, <a class="el" href="simple__source_8cpp-source.html#l00110">play</a>, <a class="el" href="simple__source_8cpp-source.html#l00264">setDirection</a>, <a class="el" href="simple__source_8cpp-source.html#l00300">setGain</a>, <a class="el" href="simple__source_8cpp-source.html#l00097">setLooping</a>, <a class="el" href="simple__source_8cpp-source.html#l00326">setPitch</a>, <a class="el" href="simple__source_8cpp-source.html#l00233">setPos</a>, <a class="el" href="simple__source_8cpp-source.html#l00311">setRelativeGain</a>, <a class="el" href="simple__source_8cpp-source.html#l00341">setSourceRelativeMode</a>, <a class="el" href="simple__source_8cpp-source.html#l00248">setVelocity</a>, and <a class="el" href="simple__source_8cpp-source.html#l00195">stop</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="simple__source_8h-source.html">simple_source.h</a><li><a class="el" href="simple__source_8cpp-source.html">simple_source.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> |