aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/classNLSOUND_1_1CBackgroundSource.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/doxygen/nel/classNLSOUND_1_1CBackgroundSource.html')
-rw-r--r--docs/doxygen/nel/classNLSOUND_1_1CBackgroundSource.html845
1 files changed, 845 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLSOUND_1_1CBackgroundSource.html b/docs/doxygen/nel/classNLSOUND_1_1CBackgroundSource.html
new file mode 100644
index 00000000..f51d4918
--- /dev/null
+++ b/docs/doxygen/nel/classNLSOUND_1_1CBackgroundSource.html
@@ -0,0 +1,845 @@
+<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
+<HTML>
+<HEAD>
+ <TITLE>nevrax.org : docs</TITLE>
+ <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css">
+ <link href="doxygen.css" rel="stylesheet" type="text/css">
+</HEAD>
+<BODY MARGINHEIGHT="0" MARGINWIDTH="0">
+
+<!-- uplinks -->
+<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
+ <TR>
+ <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
+ <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD>
+ <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
+ <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
+ <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
+ </TR>
+</TABLE>
+
+<!-- banner Nevrax -->
+<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%>
+ <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR>
+</TABLE>
+
+<!-- main table -->
+<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%>
+ <TR>
+ <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD>
+ <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">
+
+ <!------ Begin Box ------>
+ <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black>
+ <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF>
+ <TABLE cellspacing=0 cellpadding=1 border=0>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr>
+ </TABLE>
+ </TD></TR></TABLE></TD></TR></TABLE>
+ <!------ End Box ------>
+
+ </TD>
+ <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
+ <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">
+
+<!-- title -->
+<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td>
+<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A>
+</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT="">
+</td></tr></table>
+&nbsp;
+
+<!-- block -->
+<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD>
+ <TD><B>Documentation</B></TD>
+ <TD ALIGN=RIGHT>&nbsp;</td>
+</tr></table>
+<!-- Generated by Doxygen 1.2.14 -->
+<center>
+<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> &nbsp; </center>
+<hr><h1>NLSOUND::CBackgroundSource Class Reference</h1>Implemetation class for background source.
+<a href="#_details">More...</a>
+<p>
+<code>#include &lt;<a class="el" href="background__source_8h-source.html">background_source.h</a>&gt;</code>
+<p>
+<p>Inheritance diagram for NLSOUND::CBackgroundSource:
+<p><center><img src="classNLSOUND_1_1CBackgroundSource.gif" usemap="#NLSOUND::CBackgroundSource_map" border="0"></center>
+<map name="NLSOUND::CBackgroundSource_map">
+<area href="classNLSOUND_1_1CSourceCommon.html" alt="NLSOUND::CSourceCommon" shape="rect" coords="0,56,258,80">
+<area href="classNLSOUND_1_1CAudioMixerUser_1_1IMixerEvent.html" alt="NLSOUND::CAudioMixerUser::IMixerEvent" shape="rect" coords="268,56,526,80">
+<area href="classNLSOUND_1_1CAudioMixerUser_1_1IMixerUpdate.html" alt="NLSOUND::CAudioMixerUser::IMixerUpdate" shape="rect" coords="536,56,794,80">
+<area href="classNLSOUND_1_1USource.html" alt="NLSOUND::USource" shape="rect" coords="0,0,258,24">
+</map>
+<a href="classNLSOUND_1_1CBackgroundSource-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
+<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
+<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a0">CBackgroundSource</a> (<a class="el" href="classNLSOUND_1_1CBackgroundSound.html">CBackgroundSound</a> *backgroundSource=NULL, bool spawn=false, <a class="el" href="namespaceNLSOUND.html#a9">TSpawnEndCallback</a> cb=0, void *cbUserParam=0)</td></tr>
+<tr><td>&nbsp;</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>&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a1">~CBackgroundSource</a> ()</td></tr>
+<tr><td>&nbsp;</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>void&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a2">setSound</a> (<a class="el" href="namespaceNLSOUND.html#a8">TSoundId</a> <a class="el" href="driver__opengl__extension__def_8h.html#a356">id</a>, <a class="el" href="structNLSOUND_1_1CSoundContext.html">CSoundContext</a> *context=0)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Change the sound binded to the source.</em> <a href="#a2">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>&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a3">getSound</a> ()</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Return the sound binded to the source (or NULL if there is no sound).</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a4">play</a> ()</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Play.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a5">stop</a> ()</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Stop playing.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top><a class="el" href="classNLSOUND_1_1CSourceCommon.html#s3">TSOURCE_TYPE</a>&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a6">getType</a> () const</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Get the type the the source.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a7">setGain</a> (float gain)</td></tr>
+<tr><td>&nbsp;</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>void&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a8">setRelativeGain</a> (float gain)</td></tr>
+<tr><td>&nbsp;</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()-&gt;<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>void&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a9">setPos</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &amp;pos)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Set the position vector (default: (0,0,0)).</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a10">setVelocity</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &amp;vel)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Set the velocity vector (3D mode only, ignored in stereo mode) (default: (0,0,0)).</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a11">setDirection</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &amp;dir)</td></tr>
+<tr><td>&nbsp;</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="#a11">More...</a><em></em></font><br><br></td></tr>
+<tr><td colspan=2><br><h2>Private Types</h2></td></tr>
+<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#u4">TSubSourceStatus</a> { <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#u4u0">SUB_STATUS_PLAY</a>,
+<a class="el" href="classNLSOUND_1_1CBackgroundSource.html#u4u1">SUB_STATUS_STOP</a>,
+<a class="el" href="classNLSOUND_1_1CBackgroundSource.html#u4u2">SUB_STATUS_FADEOUT</a>,
+<a class="el" href="classNLSOUND_1_1CBackgroundSource.html#u4u3">SUB_STATUS_FADEIN</a>
+ }</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Sub source possible status.</em> <a href="#u4">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>bool&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#c0">checkFilter</a> (const <a class="el" href="structNLSOUND_1_1UAudioMixer_1_1TBackgroundFlags.html">UAudioMixer::TBackgroundFlags</a> &amp;filter)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Check the given filter agains current environnment status, return false is masking.</em> <a href="#c0">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#c1">onUpdate</a> ()</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Mixer update implementation (for fade in/out).</em> <a href="#c1">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#c2">onEvent</a> ()</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Mixer event for env checking.</em> <a href="#c2">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_1CBackgroundSound.html">CBackgroundSound</a> *&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#o0">_BackgroundSound</a></td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>The sound static data.</em> <a href="#o0">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>std::vector&lt; <a class="el" href="structNLSOUND_1_1CBackgroundSource_1_1TSubSource.html">TSubSource</a> &gt;&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#o1">_Sources</a></td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>The sub sources container.</em> <a href="#o1">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>&nbsp;</td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBackgroundSource.html#o2">_LastCheck</a></td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Last time we check env variable.</em> <a href="#o2">More...</a><em></em></font><br><br></td></tr>
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Implemetation class for background source.
+<p>
+Complex source are source that use a CPatternSound object. <dl compact><dt><b>
+Author: </b><dd>
+Boris Boucher. , Nevrax </dl>
+<p>
+
+<p>
+Definition at line <a class="el" href="background__source_8h-source.html#l00044">44</a> of file <a class="el" href="background__source_8h-source.html">background_source.h</a>.<hr><h2>Member Enumeration Documentation</h2>
+<a name="u4" doxytag="NLSOUND::CBackgroundSource::TSubSourceStatus"></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::CBackgroundSource::TSubSourceStatus<code> [private]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Sub source possible status.
+<p>
+<dl compact><dt><b>
+Enumeration values:</b><dd>
+<table border=0 cellspacing=2 cellpadding=0>
+<tr><td valign=top><em><a name="u4u0" doxytag="SUB_STATUS_PLAY"></a><em>SUB_STATUS_PLAY</em></em>&nbsp;</td><td>
+The sub source is playing.</td></tr>
+<tr><td valign=top><em><a name="u4u1" doxytag="SUB_STATUS_STOP"></a><em>SUB_STATUS_STOP</em></em>&nbsp;</td><td>
+The sub source is stopped : it is mask by environnemt status.</td></tr>
+<tr><td valign=top><em><a name="u4u2" doxytag="SUB_STATUS_FADEOUT"></a><em>SUB_STATUS_FADEOUT</em></em>&nbsp;</td><td>
+the sub source is being faded out then stop (masked by filter).</td></tr>
+<tr><td valign=top><em><a name="u4u3" doxytag="SUB_STATUS_FADEIN"></a><em>SUB_STATUS_FADEIN</em></em>&nbsp;</td><td>
+The sub source is being faded in, then play (unmasked by filter).</td></tr>
+</table>
+</dl>
+
+<p>
+Definition at line <a class="el" href="background__source_8h-source.html#l00082">82</a> of file <a class="el" href="background__source_8h-source.html">background_source.h</a>. </td>
+ </tr>
+</table>
+<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a name="a0" doxytag="NLSOUND::CBackgroundSource::CBackgroundSource"></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::CBackgroundSource::CBackgroundSource </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="classNLSOUND_1_1CBackgroundSound.html">CBackgroundSound</a> *&nbsp;</td>
+ <td class="mdname" nowrap>&nbsp; <em>backgroundSource</em> = NULL, </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>bool&nbsp;</td>
+ <td class="mdname" nowrap>&nbsp; <em>spawn</em> = false, </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap><a class="el" href="namespaceNLSOUND.html#a9">TSpawnEndCallback</a>&nbsp;</td>
+ <td class="mdname" nowrap>&nbsp; <em>cb</em> = 0, </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>void *&nbsp;</td>
+ <td class="mdname" nowrap>&nbsp; <em>cbUserParam</em> = 0</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">)&nbsp;</td>
+ <td class="md" colspan="2"></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Constructor.
+<p>
+
+<p>
+Definition at line <a class="el" href="background__source_8cpp-source.html#l00040">40</a> of file <a class="el" href="background__source_8cpp-source.html">background_source.cpp</a>.
+<p>
+References <a class="el" href="background__source_8h-source.html#l00112">_BackgroundSound</a>, and <a class="el" href="u__source_8h-source.html#l00076">NLSOUND::TSpawnEndCallback</a>. </td>
+ </tr>
+</table>
+<a name="a1" doxytag="NLSOUND::CBackgroundSource::~CBackgroundSource"></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::CBackgroundSource::~CBackgroundSource </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Destructor.
+<p>
+
+<p>
+Definition at line <a class="el" href="background__source_8cpp-source.html#l00046">46</a> of file <a class="el" href="background__source_8cpp-source.html">background_source.cpp</a>.
+<p>
+References <a class="el" href="background__source_8cpp-source.html#l00164">stop</a>. </td>
+ </tr>
+</table>
+<hr><h2>Member Function Documentation</h2>
+<a name="c0" doxytag="NLSOUND::CBackgroundSource::checkFilter"></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::CBackgroundSource::checkFilter </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const <a class="el" href="structNLSOUND_1_1UAudioMixer_1_1TBackgroundFlags.html">UAudioMixer::TBackgroundFlags</a> &amp;&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; <em>filter</em> </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [private]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Check the given filter agains current environnment status, return false is masking.
+<p>
+
+<p>
+Definition at line <a class="el" href="background__source_8cpp-source.html#l00312">312</a> of file <a class="el" href="background__source_8cpp-source.html">background_source.cpp</a>.
+<p>
+Referenced by <a class="el" href="background__source_8cpp-source.html#l00246">onEvent</a>, and <a class="el" href="background__source_8cpp-source.html#l00122">play</a>. </td>
+ </tr>
+</table>
+<a name="a3" doxytag="NLSOUND::CBackgroundSource::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"> <a class="el" href="namespaceNLSOUND.html#a8">TSoundId</a> NLSOUND::CBackgroundSource::getSound </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </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="background__source_8cpp-source.html#l00057">57</a> of file <a class="el" href="background__source_8cpp-source.html">background_source.cpp</a>.
+<p>
+References <a class="el" href="u__source_8h-source.html#l00069">NLSOUND::TSoundId</a>. </td>
+ </tr>
+</table>
+<a name="a6" doxytag="NLSOUND::CBackgroundSource::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::CBackgroundSource::getType </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap> const<code> [inline, virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </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="background__source_8h-source.html#l00061">61</a> of file <a class="el" href="background__source_8h-source.html">background_source.h</a>.
+<p>
+References <a class="el" href="classNLSOUND_1_1CSourceCommon.html#s3s2">NLSOUND::CSourceCommon::SOURCE_BACKGROUND</a>, and <a class="el" href="source__common_8h-source.html#l00040">NLSOUND::CSourceCommon::TSOURCE_TYPE</a>. </td>
+ </tr>
+</table>
+<a name="c2" doxytag="NLSOUND::CBackgroundSource::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::CBackgroundSource::onEvent </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [private, virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Mixer event for env checking.
+<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="background__source_8cpp-source.html#l00246">246</a> of file <a class="el" href="background__source_8cpp-source.html">background_source.cpp</a>.
+<p>
+References <a class="el" href="background__source_8h-source.html#l00118">_LastCheck</a>, <a class="el" href="source__common_8h-source.html#l00157">NLSOUND::CSourceCommon::_Position</a>, <a class="el" href="background__source_8h-source.html#l00115">_Sources</a>, <a class="el" href="background__source_8cpp-source.html#l00312">checkFilter</a>, <a class="el" href="background__source_8cpp-source.html#l00037">NLSOUND::ENV_CHK_INTERVAL</a>, <a class="el" href="time__nl_8cpp-source.html#l00055">NLMISC::CTime::getLocalTime</a>, <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#u4u3">SUB_STATUS_FADEIN</a>, <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#u4u2">SUB_STATUS_FADEOUT</a>, <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#u4u0">SUB_STATUS_PLAY</a>, <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#u4u1">SUB_STATUS_STOP</a>, and <a class="el" href="time__nl_8h-source.html#l00047">NLMISC::TTime</a>. </td>
+ </tr>
+</table>
+<a name="c1" doxytag="NLSOUND::CBackgroundSource::onUpdate"></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::CBackgroundSource::onUpdate </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [private, virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Mixer update implementation (for fade in/out).
+<p>
+
+<p>
+Implements <a class="el" href="classNLSOUND_1_1CAudioMixerUser_1_1IMixerUpdate.html#a0">NLSOUND::CAudioMixerUser::IMixerUpdate</a>.
+<p>
+Definition at line <a class="el" href="background__source_8cpp-source.html#l00189">189</a> of file <a class="el" href="background__source_8cpp-source.html">background_source.cpp</a>.
+<p>
+References <a class="el" href="source__common_8h-source.html#l00160">NLSOUND::CSourceCommon::_Gain</a>, <a class="el" href="background__source_8h-source.html#l00115">_Sources</a>, <a class="el" href="time__nl_8cpp-source.html#l00055">NLMISC::CTime::getLocalTime</a>, <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#u4u3">SUB_STATUS_FADEIN</a>, <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#u4u2">SUB_STATUS_FADEOUT</a>, <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#u4u0">SUB_STATUS_PLAY</a>, <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#u4u1">SUB_STATUS_STOP</a>, and <a class="el" href="time__nl_8h-source.html#l00047">NLMISC::TTime</a>. </td>
+ </tr>
+</table>
+<a name="a4" doxytag="NLSOUND::CBackgroundSource::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::CBackgroundSource::play </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </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="background__source_8cpp-source.html#l00122">122</a> of file <a class="el" href="background__source_8cpp-source.html">background_source.cpp</a>.
+<p>
+References <a class="el" href="background__source_8h-source.html#l00112">_BackgroundSound</a>, <a class="el" href="source__common_8h-source.html#l00160">NLSOUND::CSourceCommon::_Gain</a>, <a class="el" href="background__source_8h-source.html#l00118">_LastCheck</a>, <a class="el" href="source__common_8h-source.html#l00157">NLSOUND::CSourceCommon::_Position</a>, <a class="el" href="background__source_8h-source.html#l00115">_Sources</a>, <a class="el" href="background__source_8cpp-source.html#l00312">checkFilter</a>, <a class="el" href="background__source_8cpp-source.html#l00037">NLSOUND::ENV_CHK_INTERVAL</a>, <a class="el" href="time__nl_8cpp-source.html#l00055">NLMISC::CTime::getLocalTime</a>, <a class="el" href="background__source_8cpp-source.html#l00164">stop</a>, <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#u4u0">SUB_STATUS_PLAY</a>, and <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#u4u1">SUB_STATUS_STOP</a>. </td>
+ </tr>
+</table>
+<a name="a11" doxytag="NLSOUND::CBackgroundSource::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::CBackgroundSource::setDirection </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &amp;&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; <em>dir</em> </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+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="background__source_8cpp-source.html#l00108">108</a> of file <a class="el" href="background__source_8cpp-source.html">background_source.cpp</a>.
+<p>
+References <a class="el" href="background__source_8h-source.html#l00115">_Sources</a>. </td>
+ </tr>
+</table>
+<a name="a7" doxytag="NLSOUND::CBackgroundSource::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::CBackgroundSource::setGain </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">float&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; <em>gain</em> </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Set the gain (volume value inside [0 , 1]).
+<p>
+(default: 1) 0.0 -&gt; silence 0.5 -&gt; -6dB 1.0 -&gt; no attenuation values &gt; 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="background__source_8cpp-source.html#l00062">62</a> of file <a class="el" href="background__source_8cpp-source.html">background_source.cpp</a>.
+<p>
+References <a class="el" href="source__common_8h-source.html#l00160">NLSOUND::CSourceCommon::_Gain</a>, and <a class="el" href="background__source_8h-source.html#l00115">_Sources</a>. </td>
+ </tr>
+</table>
+<a name="a9" doxytag="NLSOUND::CBackgroundSource::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::CBackgroundSource::setPos </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &amp;&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; <em>pos</em> </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Set the position vector (default: (0,0,0)).
+<p>
+3D mode -&gt; 3D position st mode -&gt; 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="background__source_8cpp-source.html#l00085">85</a> of file <a class="el" href="background__source_8cpp-source.html">background_source.cpp</a>.
+<p>
+References <a class="el" href="background__source_8h-source.html#l00115">_Sources</a>. </td>
+ </tr>
+</table>
+<a name="a8" doxytag="NLSOUND::CBackgroundSource::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::CBackgroundSource::setRelativeGain </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">float&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; <em>gain</em> </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Set the gain amount (value inside [0, 1]) to map between 0 and the nominal gain (which is getSource()-&gt;<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="background__source_8cpp-source.html#l00073">73</a> of file <a class="el" href="background__source_8cpp-source.html">background_source.cpp</a>.
+<p>
+References <a class="el" href="source__common_8h-source.html#l00160">NLSOUND::CSourceCommon::_Gain</a>, and <a class="el" href="background__source_8h-source.html#l00115">_Sources</a>. </td>
+ </tr>
+</table>
+<a name="a2" doxytag="NLSOUND::CBackgroundSource::setSound"></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::CBackgroundSource::setSound </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="namespaceNLSOUND.html#a8">TSoundId</a>&nbsp;</td>
+ <td class="mdname" nowrap>&nbsp; <em>id</em>, </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap><a class="el" href="structNLSOUND_1_1CSoundContext.html">CSoundContext</a> *&nbsp;</td>
+ <td class="mdname" nowrap>&nbsp; <em>context</em> = 0</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">)&nbsp;</td>
+ <td class="md" colspan="2"></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Change the sound binded to the source.
+<p>
+
+<p>
+Definition at line <a class="el" href="background__source_8cpp-source.html#l00052">52</a> of file <a class="el" href="background__source_8cpp-source.html">background_source.cpp</a>.
+<p>
+References <a class="el" href="driver__opengl__extension__def_8h-source.html#l00218">id</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, and <a class="el" href="u__source_8h-source.html#l00069">NLSOUND::TSoundId</a>. </td>
+ </tr>
+</table>
+<a name="a10" doxytag="NLSOUND::CBackgroundSource::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::CBackgroundSource::setVelocity </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &amp;&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; <em>vel</em> </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Set the velocity vector (3D mode only, ignored in stereo mode) (default: (0,0,0)).
+<p>
+
+<p>
+Reimplemented from <a class="el" href="classNLSOUND_1_1CSourceCommon.html#a12">NLSOUND::CSourceCommon</a>.
+<p>
+Definition at line <a class="el" href="background__source_8cpp-source.html#l00097">97</a> of file <a class="el" href="background__source_8cpp-source.html">background_source.cpp</a>.
+<p>
+References <a class="el" href="background__source_8h-source.html#l00115">_Sources</a>. </td>
+ </tr>
+</table>
+<a name="a5" doxytag="NLSOUND::CBackgroundSource::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::CBackgroundSource::stop </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </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="background__source_8cpp-source.html#l00164">164</a> of file <a class="el" href="background__source_8cpp-source.html">background_source.cpp</a>.
+<p>
+References <a class="el" href="background__source_8h-source.html#l00115">_Sources</a>.
+<p>
+Referenced by <a class="el" href="background__source_8cpp-source.html#l00122">play</a>, and <a class="el" href="background__source_8cpp-source.html#l00046">~CBackgroundSource</a>. </td>
+ </tr>
+</table>
+<hr><h2>Member Data Documentation</h2>
+<a name="o0" doxytag="NLSOUND::CBackgroundSource::_BackgroundSound"></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_1CBackgroundSound.html">CBackgroundSound</a>* NLSOUND::CBackgroundSource::_BackgroundSound<code> [private]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+The sound static data.
+<p>
+
+<p>
+Definition at line <a class="el" href="background__source_8h-source.html#l00112">112</a> of file <a class="el" href="background__source_8h-source.html">background_source.h</a>.
+<p>
+Referenced by <a class="el" href="background__source_8cpp-source.html#l00040">CBackgroundSource</a>, and <a class="el" href="background__source_8cpp-source.html#l00122">play</a>. </td>
+ </tr>
+</table>
+<a name="o2" doxytag="NLSOUND::CBackgroundSource::_LastCheck"></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::CBackgroundSource::_LastCheck<code> [private]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Last time we check env variable.
+<p>
+
+<p>
+Definition at line <a class="el" href="background__source_8h-source.html#l00118">118</a> of file <a class="el" href="background__source_8h-source.html">background_source.h</a>.
+<p>
+Referenced by <a class="el" href="background__source_8cpp-source.html#l00246">onEvent</a>, and <a class="el" href="background__source_8cpp-source.html#l00122">play</a>. </td>
+ </tr>
+</table>
+<a name="o1" doxytag="NLSOUND::CBackgroundSource::_Sources"></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"> std::vector&lt;<a class="el" href="structNLSOUND_1_1CBackgroundSource_1_1TSubSource.html">TSubSource</a>&gt; NLSOUND::CBackgroundSource::_Sources<code> [private]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+The sub sources container.
+<p>
+
+<p>
+Definition at line <a class="el" href="background__source_8h-source.html#l00115">115</a> of file <a class="el" href="background__source_8h-source.html">background_source.h</a>.
+<p>
+Referenced by <a class="el" href="background__source_8cpp-source.html#l00246">onEvent</a>, <a class="el" href="background__source_8cpp-source.html#l00189">onUpdate</a>, <a class="el" href="background__source_8cpp-source.html#l00122">play</a>, <a class="el" href="background__source_8cpp-source.html#l00108">setDirection</a>, <a class="el" href="background__source_8cpp-source.html#l00062">setGain</a>, <a class="el" href="background__source_8cpp-source.html#l00085">setPos</a>, <a class="el" href="background__source_8cpp-source.html#l00073">setRelativeGain</a>, <a class="el" href="background__source_8cpp-source.html#l00097">setVelocity</a>, and <a class="el" href="background__source_8cpp-source.html#l00164">stop</a>. </td>
+ </tr>
+</table>
+<hr>The documentation for this class was generated from the following files:<ul>
+<li><a class="el" href="background__source_8h-source.html">background_source.h</a><li><a class="el" href="background__source_8cpp-source.html">background_source.cpp</a></ul>
+
+
+<!-- footer -->
+<BR><FONT Size=+5>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </FONT>
+</TD>
+<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD>
+</TR>
+</TABLE>
+</BODY>
+</HTML>