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_1CEnvSoundUser.html | |
| download | nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.tar.xz nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.zip | |
Initial commit
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/classNLSOUND_1_1CEnvSoundUser.html | 1309 |
1 files changed, 1309 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLSOUND_1_1CEnvSoundUser.html b/docs/doxygen/nel/classNLSOUND_1_1CEnvSoundUser.html new file mode 100644 index 00000000..e46dfeab --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1CEnvSoundUser.html @@ -0,0 +1,1309 @@ +<!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::CEnvSoundUser Class Reference</h1>Implementation of <a class="el" href="classNLSOUND_1_1UEnvSound.html">UEnvSound</a>. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a>></code> +<p> +<p>Inheritance diagram for NLSOUND::CEnvSoundUser: +<p><center><img src="classNLSOUND_1_1CEnvSoundUser.gif" usemap="#NLSOUND::CEnvSoundUser_map" border="0"></center> +<map name="NLSOUND::CEnvSoundUser_map"> +<area href="classNLSOUND_1_1UEnvSound.html" alt="NLSOUND::UEnvSound" shape="rect" coords="0,0,171,24"> +</map> +<a href="classNLSOUND_1_1CEnvSoundUser-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_1CEnvSoundUser.html#a0">CEnvSoundUser</a> ()</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_1CEnvSoundUser.html#a1">~CEnvSoundUser</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 const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#a2">getPos</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the position.</em> <a href="#a2">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_1CEnvSoundUser.html#a3">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>Moves the envsound (and its transition envsound if it has one).</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_1CEnvSoundUser.html#a4">selectEnv</a> (const char *tag, bool children_too=false)</td></tr> +<tr><td> </td><td><font size=-1><em>Select the current env for this node, and for all descendants if children_too is true.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual std::vector< <a class="el" href="classNLSOUND_1_1UEnvSound.html">UEnvSound</a> * > & </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#a5">getChildren</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the children envsounds.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#a6">recompute</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Recompute the EnvSound. Call this method after having moved the 3D source (call only on the root env).</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#a7">update</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Update the stereo mixes (call evenly on the root) (recursive).</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_1CEnvSoundUser.html#a8">play</a> (bool children_too=false)</td></tr> +<tr><td> </td><td><font size=-1><em>Play this node, and all descendants if children_too is true.</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_1CEnvSoundUser.html#a9">stop</a> (bool children_too=false)</td></tr> +<tr><td> </td><td><font size=-1><em>Stop playing this node, and all descendants if children_too is true.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#a10">mustPlay</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the play flag.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#a11">setProperties</a> (bool transition, IBoundingShape *bshape)</td></tr> +<tr><td> </td><td><font size=-1><em>Set properties (EDIT) (set a NULL shape for all world).</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#a12">addChild</a> (CEnvSoundUser *child)</td></tr> +<tr><td> </td><td><font size=-1><em>Add a child (EDIT).</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#a13">addEnvTag</a> (IPlayable *source, const std::string &tag="")</td></tr> +<tr><td> </td><td><font size=-1><em>Add an environment source/tag (EDIT) (set a NULL source for no source at all).</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>IBoundingShape * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#a14">getBoundingShape</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the bounding shape (EDIT).</em> <a href="#a14">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>IPlayable * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#a15">getSource</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the source (EDIT).</em> <a href="#a15">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>CEnvSoundUser * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#a16">getParent</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the parent (EDIT).</em> <a href="#a16">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#b0">isRoot</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return true if the envsound is the root of the hierarchy tree.</em> <a href="#b0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#b1">applySourcesMarks</a> ()</td></tr> +<tr><td nowrap align=right valign=top>CEnvSoundUser * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#b2">findCurrentEnv</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &listenerpos)</td></tr> +<tr><td> </td><td><font size=-1><em>Find the area where the listener is located (recursive).</em> <a href="#b2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#b3">markSources</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &listenerpos, float gain)</td></tr> +<tr><td> </td><td><font size=-1><em>Prepare the related sources to play (recursive).</em> <a href="#b3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a11">uint32</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#b4">getCount</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Count the envs in the tree (call on the root).</em> <a href="#b4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#b5">playSub</a> (bool children_too=false)</td></tr> +<tr><td> </td><td><font size=-1><em>Play this node, and all descendants if children_too is true, but do not recompute.</em> <a href="#b5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#b6">stopSub</a> (bool children_too=false)</td></tr> +<tr><td> </td><td><font size=-1><em>Stop playing this node, and all descendants if children_too is true, but do not recompute.</em> <a href="#b6">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>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#o0">_Play</a></td></tr> +<tr><td nowrap align=right valign=top>IPlayable * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#o1">_Source</a></td></tr> +<tr><td nowrap align=right valign=top>std::vector< IPlayable * > </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#o2">_SrcBank</a></td></tr> +<tr><td nowrap align=right valign=top>std::vector< std::string > </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#o3">_Tags</a></td></tr> +<tr><td nowrap align=right valign=top>IBoundingShape * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#o4">_BoundingShape</a></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#o5">_Transition</a></td></tr> +<tr><td nowrap align=right valign=top>CEnvSoundUser * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#o6">_Parent</a></td></tr> +<tr><td nowrap align=right valign=top>std::vector< CEnvSoundUser * > </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#o7">_Children</a></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#o8">_Mark</a></td></tr> +<tr><td nowrap align=right valign=top>float </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvSoundUser.html#o9">_Gain</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Implementation of <a class="el" href="classNLSOUND_1_1UEnvSound.html">UEnvSound</a>. +<p> +An envsound object is a node of an envsound tree, the root of which is returned by CAudioMixerUser::loadEnvSounds() and getEnvSounds(). The root is the world envsound: it has no bounds. The areas of children envsounds have bounds and they must be totally included in the area of their parent envsound. +<p> +Here is an example of an envsound tree: +<p> +<div class="fragment"><pre> + * Root (world envsound) + * / \ + * Transition Transition + * | | + * Cave1 City + * / \ + * Transition Transition + * | | + * Building1 Building2 + * </pre></div> +<p> +In a transition, the _Source object is the center source played when the listener not in the child area (<a class="el" href="classNLSOUND_1_1CSimpleSource.html">CSimpleSource</a>). In a non-transition envsound, the _Source object is the ambiant source (<a class="el" href="classNLSOUND_1_1CAmbiantSource.html">CAmbiantSource</a>) which plays a stereo mix. +<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="env__sound__user_8h-source.html#l00082">82</a> of file <a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NLSOUND::CEnvSoundUser::CEnvSoundUser"></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::CEnvSoundUser::CEnvSoundUser </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> +Constructor. +<p> + +<p> +Definition at line <a class="el" href="env__sound__user_8cpp-source.html#l00043">43</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. +<p> +Referenced by <a class="el" href="env__sound__user_8cpp-source.html#l00303">findCurrentEnv</a>, and <a class="el" href="env__sound__user_8cpp-source.html#l00385">recompute</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLSOUND::CEnvSoundUser::~CEnvSoundUser"></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::CEnvSoundUser::~CEnvSoundUser </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="env__sound__user_8cpp-source.html#l00051">51</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. +<p> +References <a class="el" href="env__sound__user_8h-source.html#l00182">_BoundingShape</a>, <a class="el" href="env__sound__user_8h-source.html#l00189">_Children</a>, and <a class="el" href="env__sound__user_8h-source.html#l00178">_SrcBank</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a12" doxytag="NLSOUND::CEnvSoundUser::addChild"></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::CEnvSoundUser::addChild </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">CEnvSoundUser * </td> + <td class="mdname1" valign="top" nowrap> <em>child</em> </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> +Add a child (EDIT). +<p> + +<p> +Definition at line <a class="el" href="env__sound__user_8cpp-source.html#l00588">588</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. +<p> +References <a class="el" href="env__sound__user_8h-source.html#l00189">_Children</a>. </td> + </tr> +</table> +<a name="a13" doxytag="NLSOUND::CEnvSoundUser::addEnvTag"></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::CEnvSoundUser::addEnvTag </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">IPlayable * </td> + <td class="mdname" nowrap> <em>source</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const std::string & </td> + <td class="mdname" nowrap> <em>tag</em> = ""</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Add an environment source/tag (EDIT) (set a NULL source for no source at all). +<p> +The current source always becomes the first one. +<p> +Definition at line <a class="el" href="env__sound__user_8cpp-source.html#l00487">487</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. +<p> +References <a class="el" href="env__sound__user_8h-source.html#l00177">_Source</a>, <a class="el" href="env__sound__user_8h-source.html#l00178">_SrcBank</a>, and <a class="el" href="env__sound__user_8h-source.html#l00179">_Tags</a>. </td> + </tr> +</table> +<a name="b1" doxytag="NLSOUND::CEnvSoundUser::applySourcesMarks"></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::CEnvSoundUser::applySourcesMarks </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> [protected]</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="env__sound__user_8cpp-source.html#l00452">452</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. +<p> +References <a class="el" href="env__sound__user_8h-source.html#l00189">_Children</a>, <a class="el" href="env__sound__user_8h-source.html#l00193">_Gain</a>, <a class="el" href="env__sound__user_8h-source.html#l00192">_Mark</a>, <a class="el" href="env__sound__user_8h-source.html#l00174">_Play</a>, and <a class="el" href="env__sound__user_8h-source.html#l00177">_Source</a>. +<p> +Referenced by <a class="el" href="env__sound__user_8cpp-source.html#l00385">recompute</a>. </td> + </tr> +</table> +<a name="b2" doxytag="NLSOUND::CEnvSoundUser::findCurrentEnv"></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"> CEnvSoundUser * NLSOUND::CEnvSoundUser::findCurrentEnv </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>listenerpos</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Find the area where the listener is located (recursive). +<p> + +<p> +Definition at line <a class="el" href="env__sound__user_8cpp-source.html#l00303">303</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. +<p> +References <a class="el" href="env__sound__user_8h-source.html#l00182">_BoundingShape</a>, <a class="el" href="env__sound__user_8h-source.html#l00189">_Children</a>, and <a class="el" href="env__sound__user_8cpp-source.html#l00043">CEnvSoundUser</a>. +<p> +Referenced by <a class="el" href="env__sound__user_8cpp-source.html#l00385">recompute</a>. </td> + </tr> +</table> +<a name="a14" doxytag="NLSOUND::CEnvSoundUser::getBoundingShape"></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"> IBoundingShape* NLSOUND::CEnvSoundUser::getBoundingShape </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 bounding shape (EDIT). +<p> + +<p> +Definition at line <a class="el" href="env__sound__user_8h-source.html#l00136">136</a> of file <a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a>. </td> + </tr> +</table> +<a name="a5" doxytag="NLSOUND::CEnvSoundUser::getChildren"></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< <a class="el" href="classNLSOUND_1_1UEnvSound.html">UEnvSound</a> * > & NLSOUND::CEnvSoundUser::getChildren </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> +Return the children envsounds. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1UEnvSound.html#a3">NLSOUND::UEnvSound</a>. +<p> +Definition at line <a class="el" href="env__sound__user_8cpp-source.html#l00376">376</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. </td> + </tr> +</table> +<a name="b4" doxytag="NLSOUND::CEnvSoundUser::getCount"></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::CEnvSoundUser::getCount </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> [protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Count the envs in the tree (call on the root). +<p> + +<p> +Definition at line <a class="el" href="env__sound__user_8cpp-source.html#l00248">248</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. +<p> +References <a class="el" href="env__sound__user_8h-source.html#l00189">_Children</a>. </td> + </tr> +</table> +<a name="a16" doxytag="NLSOUND::CEnvSoundUser::getParent"></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"> CEnvSoundUser* NLSOUND::CEnvSoundUser::getParent </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 parent (EDIT). +<p> + +<p> +Definition at line <a class="el" href="env__sound__user_8h-source.html#l00140">140</a> of file <a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NLSOUND::CEnvSoundUser::getPos"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>& NLSOUND::CEnvSoundUser::getPos </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the position. +<p> + </td> + </tr> +</table> +<a name="a15" doxytag="NLSOUND::CEnvSoundUser::getSource"></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"> IPlayable* NLSOUND::CEnvSoundUser::getSource </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 source (EDIT). +<p> + +<p> +Definition at line <a class="el" href="env__sound__user_8h-source.html#l00138">138</a> of file <a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a>. </td> + </tr> +</table> +<a name="b0" doxytag="NLSOUND::CEnvSoundUser::isRoot"></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::CEnvSoundUser::isRoot </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, protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return true if the envsound is the root of the hierarchy tree. +<p> + +<p> +Definition at line <a class="el" href="env__sound__user_8h-source.html#l00148">148</a> of file <a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a>. +<p> +References <a class="el" href="env__sound__user_8h-source.html#l00188">_Parent</a>. +<p> +Referenced by <a class="el" href="env__sound__user_8cpp-source.html#l00385">recompute</a>. </td> + </tr> +</table> +<a name="b3" doxytag="NLSOUND::CEnvSoundUser::markSources"></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::CEnvSoundUser::markSources </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="mdname" nowrap> <em>listenerpos</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>gain</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Prepare the related sources to play (recursive). +<p> +In each children branch, there must be an env which is not a transition, for the recursion to stop +<p> +Definition at line <a class="el" href="env__sound__user_8cpp-source.html#l00408">408</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. +<p> +References <a class="el" href="env__sound__user_8h-source.html#l00182">_BoundingShape</a>, <a class="el" href="env__sound__user_8h-source.html#l00189">_Children</a>, <a class="el" href="env__sound__user_8h-source.html#l00193">_Gain</a>, <a class="el" href="env__sound__user_8h-source.html#l00192">_Mark</a>, <a class="el" href="env__sound__user_8h-source.html#l00188">_Parent</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. </td> + </tr> +</table> +<a name="a10" doxytag="NLSOUND::CEnvSoundUser::mustPlay"></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::CEnvSoundUser::mustPlay </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 play flag. +<p> + +<p> +Definition at line <a class="el" href="env__sound__user_8h-source.html#l00122">122</a> of file <a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a>. +<p> +References <a class="el" href="env__sound__user_8h-source.html#l00174">_Play</a>. </td> + </tr> +</table> +<a name="a8" doxytag="NLSOUND::CEnvSoundUser::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::CEnvSoundUser::play </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>children_too</em> = false </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 this node, and all descendants if children_too is true. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1UEnvSound.html#a4">NLSOUND::UEnvSound</a>. +<p> +Definition at line <a class="el" href="env__sound__user_8cpp-source.html#l00516">516</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. +<p> +References <a class="el" href="env__sound__user_8cpp-source.html#l00538">playSub</a>. </td> + </tr> +</table> +<a name="b5" doxytag="NLSOUND::CEnvSoundUser::playSub"></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::CEnvSoundUser::playSub </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>children_too</em> = false </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Play this node, and all descendants if children_too is true, but do not recompute. +<p> + +<p> +Definition at line <a class="el" href="env__sound__user_8cpp-source.html#l00538">538</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. +<p> +References <a class="el" href="env__sound__user_8h-source.html#l00189">_Children</a>, <a class="el" href="env__sound__user_8h-source.html#l00188">_Parent</a>, and <a class="el" href="env__sound__user_8h-source.html#l00174">_Play</a>. +<p> +Referenced by <a class="el" href="env__sound__user_8cpp-source.html#l00516">play</a>. </td> + </tr> +</table> +<a name="a6" doxytag="NLSOUND::CEnvSoundUser::recompute"></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::CEnvSoundUser::recompute </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> +Recompute the EnvSound. Call this method after having moved the 3D source (call only on the root env). +<p> + +<p> +Definition at line <a class="el" href="env__sound__user_8cpp-source.html#l00385">385</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. +<p> +References <a class="el" href="env__sound__user_8cpp-source.html#l00452">applySourcesMarks</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00043">CEnvSoundUser</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00303">findCurrentEnv</a>, <a class="el" href="env__sound__user_8h-source.html#l00148">isRoot</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. </td> + </tr> +</table> +<a name="a4" doxytag="NLSOUND::CEnvSoundUser::selectEnv"></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::CEnvSoundUser::selectEnv </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const char * </td> + <td class="mdname" nowrap> <em>tag</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>children_too</em> = false</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Select the current env for this node, and for all descendants if children_too is true. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1UEnvSound.html#a2">NLSOUND::UEnvSound</a>. +<p> +Definition at line <a class="el" href="env__sound__user_8cpp-source.html#l00190">190</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. +<p> +References <a class="el" href="env__sound__user_8h-source.html#l00189">_Children</a>, <a class="el" href="env__sound__user_8h-source.html#l00177">_Source</a>, <a class="el" href="env__sound__user_8h-source.html#l00178">_SrcBank</a>, <a class="el" href="env__sound__user_8h-source.html#l00179">_Tags</a>, and <a class="el" href="debug_8h-source.html#l00087">nldebug</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NLSOUND::CEnvSoundUser::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::CEnvSoundUser::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> +Moves the envsound (and its transition envsound if it has one). +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1UEnvSound.html#a1">NLSOUND::UEnvSound</a>. +<p> +Definition at line <a class="el" href="env__sound__user_8cpp-source.html#l00341">341</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. +<p> +References <a class="el" href="env__sound__user_8h-source.html#l00182">_BoundingShape</a>, and <a class="el" href="env__sound__user_8h-source.html#l00188">_Parent</a>. </td> + </tr> +</table> +<a name="a11" doxytag="NLSOUND::CEnvSoundUser::setProperties"></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::CEnvSoundUser::setProperties </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname" nowrap> <em>transition</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>IBoundingShape * </td> + <td class="mdname" nowrap> <em>bshape</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set properties (EDIT) (set a NULL shape for all world). +<p> + +<p> +Definition at line <a class="el" href="env__sound__user_8cpp-source.html#l00476">476</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. +<p> +References <a class="el" href="env__sound__user_8h-source.html#l00182">_BoundingShape</a>, and <a class="el" href="env__sound__user_8h-source.html#l00185">_Transition</a>. </td> + </tr> +</table> +<a name="a9" doxytag="NLSOUND::CEnvSoundUser::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::CEnvSoundUser::stop </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>children_too</em> = false </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 this node, and all descendants if children_too is true. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1UEnvSound.html#a5">NLSOUND::UEnvSound</a>. +<p> +Definition at line <a class="el" href="env__sound__user_8cpp-source.html#l00527">527</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. +<p> +References <a class="el" href="env__sound__user_8cpp-source.html#l00563">stopSub</a>. </td> + </tr> +</table> +<a name="b6" doxytag="NLSOUND::CEnvSoundUser::stopSub"></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::CEnvSoundUser::stopSub </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>children_too</em> = false </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Stop playing this node, and all descendants if children_too is true, but do not recompute. +<p> + +<p> +Definition at line <a class="el" href="env__sound__user_8cpp-source.html#l00563">563</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. +<p> +References <a class="el" href="env__sound__user_8h-source.html#l00189">_Children</a>, <a class="el" href="env__sound__user_8h-source.html#l00188">_Parent</a>, and <a class="el" href="env__sound__user_8h-source.html#l00174">_Play</a>. +<p> +Referenced by <a class="el" href="env__sound__user_8cpp-source.html#l00527">stop</a>. </td> + </tr> +</table> +<a name="a7" doxytag="NLSOUND::CEnvSoundUser::update"></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::CEnvSoundUser::update </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> +Update the stereo mixes (call evenly on the root) (recursive). +<p> + +<p> +Definition at line <a class="el" href="env__sound__user_8cpp-source.html#l00286">286</a> of file <a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.cpp</a>. +<p> +References <a class="el" href="env__sound__user_8h-source.html#l00189">_Children</a>, and <a class="el" href="env__sound__user_8h-source.html#l00177">_Source</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="o4" doxytag="NLSOUND::CEnvSoundUser::_BoundingShape"></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"> IBoundingShape* NLSOUND::CEnvSoundUser::_BoundingShape<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="env__sound__user_8h-source.html#l00182">182</a> of file <a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a>. +<p> +Referenced by <a class="el" href="env__sound__user_8cpp-source.html#l00303">findCurrentEnv</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00408">markSources</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00341">setPos</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00476">setProperties</a>, and <a class="el" href="env__sound__user_8cpp-source.html#l00051">~CEnvSoundUser</a>. </td> + </tr> +</table> +<a name="o7" doxytag="NLSOUND::CEnvSoundUser::_Children"></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<CEnvSoundUser*> NLSOUND::CEnvSoundUser::_Children<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="env__sound__user_8h-source.html#l00189">189</a> of file <a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a>. +<p> +Referenced by <a class="el" href="env__sound__user_8cpp-source.html#l00588">addChild</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00452">applySourcesMarks</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00303">findCurrentEnv</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00248">getCount</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00408">markSources</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00538">playSub</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00190">selectEnv</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00563">stopSub</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00286">update</a>, and <a class="el" href="env__sound__user_8cpp-source.html#l00051">~CEnvSoundUser</a>. </td> + </tr> +</table> +<a name="o9" doxytag="NLSOUND::CEnvSoundUser::_Gain"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> float NLSOUND::CEnvSoundUser::_Gain<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="env__sound__user_8h-source.html#l00193">193</a> of file <a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a>. +<p> +Referenced by <a class="el" href="env__sound__user_8cpp-source.html#l00452">applySourcesMarks</a>, and <a class="el" href="env__sound__user_8cpp-source.html#l00408">markSources</a>. </td> + </tr> +</table> +<a name="o8" doxytag="NLSOUND::CEnvSoundUser::_Mark"></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::CEnvSoundUser::_Mark<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="env__sound__user_8h-source.html#l00192">192</a> of file <a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a>. +<p> +Referenced by <a class="el" href="env__sound__user_8cpp-source.html#l00452">applySourcesMarks</a>, and <a class="el" href="env__sound__user_8cpp-source.html#l00408">markSources</a>. </td> + </tr> +</table> +<a name="o6" doxytag="NLSOUND::CEnvSoundUser::_Parent"></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"> CEnvSoundUser* NLSOUND::CEnvSoundUser::_Parent<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="env__sound__user_8h-source.html#l00188">188</a> of file <a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a>. +<p> +Referenced by <a class="el" href="env__sound__user_8h-source.html#l00148">isRoot</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00408">markSources</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00538">playSub</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00341">setPos</a>, and <a class="el" href="env__sound__user_8cpp-source.html#l00563">stopSub</a>. </td> + </tr> +</table> +<a name="o0" doxytag="NLSOUND::CEnvSoundUser::_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"> bool NLSOUND::CEnvSoundUser::_Play<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="env__sound__user_8h-source.html#l00174">174</a> of file <a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a>. +<p> +Referenced by <a class="el" href="env__sound__user_8cpp-source.html#l00452">applySourcesMarks</a>, <a class="el" href="env__sound__user_8h-source.html#l00122">mustPlay</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00538">playSub</a>, and <a class="el" href="env__sound__user_8cpp-source.html#l00563">stopSub</a>. </td> + </tr> +</table> +<a name="o1" doxytag="NLSOUND::CEnvSoundUser::_Source"></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"> IPlayable* NLSOUND::CEnvSoundUser::_Source<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="env__sound__user_8h-source.html#l00177">177</a> of file <a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a>. +<p> +Referenced by <a class="el" href="env__sound__user_8cpp-source.html#l00487">addEnvTag</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00452">applySourcesMarks</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00190">selectEnv</a>, and <a class="el" href="env__sound__user_8cpp-source.html#l00286">update</a>. </td> + </tr> +</table> +<a name="o2" doxytag="NLSOUND::CEnvSoundUser::_SrcBank"></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<IPlayable*> NLSOUND::CEnvSoundUser::_SrcBank<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="env__sound__user_8h-source.html#l00178">178</a> of file <a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a>. +<p> +Referenced by <a class="el" href="env__sound__user_8cpp-source.html#l00487">addEnvTag</a>, <a class="el" href="env__sound__user_8cpp-source.html#l00190">selectEnv</a>, and <a class="el" href="env__sound__user_8cpp-source.html#l00051">~CEnvSoundUser</a>. </td> + </tr> +</table> +<a name="o3" doxytag="NLSOUND::CEnvSoundUser::_Tags"></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<std::string> NLSOUND::CEnvSoundUser::_Tags<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="env__sound__user_8h-source.html#l00179">179</a> of file <a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a>. +<p> +Referenced by <a class="el" href="env__sound__user_8cpp-source.html#l00487">addEnvTag</a>, and <a class="el" href="env__sound__user_8cpp-source.html#l00190">selectEnv</a>. </td> + </tr> +</table> +<a name="o5" doxytag="NLSOUND::CEnvSoundUser::_Transition"></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::CEnvSoundUser::_Transition<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="env__sound__user_8h-source.html#l00185">185</a> of file <a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a>. +<p> +Referenced by <a class="el" href="env__sound__user_8cpp-source.html#l00476">setProperties</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="env__sound__user_8h-source.html">env_sound_user.h</a><li><a class="el" href="env__sound__user_8cpp-source.html">env_sound_user.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> |