diff options
Diffstat (limited to 'docs/doxygen/nel/classNLSOUND_1_1CEnvEffect.html')
| -rw-r--r-- | docs/doxygen/nel/classNLSOUND_1_1CEnvEffect.html | 728 |
1 files changed, 728 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLSOUND_1_1CEnvEffect.html b/docs/doxygen/nel/classNLSOUND_1_1CEnvEffect.html new file mode 100644 index 00000000..d4ae6f91 --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1CEnvEffect.html @@ -0,0 +1,728 @@ +<!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::CEnvEffect Class Reference</h1>Environmental effects and where they are applied. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="env__effect_8h-source.html">env_effect.h</a>></code> +<p> +<a href="classNLSOUND_1_1CEnvEffect-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_1CEnvEffect.html#a0">CEnvEffect</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_1CEnvEffect.html#a1">~CEnvEffect</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>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvEffect.html#a2">serial</a> (<a class="el" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> &<a class="el" href="driver__opengl__extension__def_8h.html#a383">s</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>Serialize.</em> <a href="#a2">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_1CEnvEffect.html#a3">include</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &pos)</td></tr> +<tr><td> </td><td><font size=-1><em>Return true if the environment includes the specified point.</em> <a href="#a3">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_1CEnvEffect.html#a4">selectEnv</a> (const std::string &tag)</td></tr> +<tr><td> </td><td><font size=-1><em>Select the current environment.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespaceNLSOUND.html#a87">TEnvEffectPreset</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvEffect.html#a5">getEnvNum</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the environment type.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>float </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvEffect.html#a6">getEnvSize</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the environment size.</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_1CEnvEffect.html#a7">addEnvNum</a> (<a class="el" href="namespaceNLSOUND.html#a87">TEnvEffectPreset</a> <a class="el" href="driver__opengl__extension__def_8h.html#a410">num</a>, const std::string &tag="", float customsize=-1.0f)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the environment type (EDIT).</em> <a href="#a7">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_1CEnvEffect.html#a8">getBoundingShape</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Access the bounding shape (EDIT).</em> <a href="#a8">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_1CEnvEffect.html#a9">setBoundingShape</a> (IBoundingShape *bs)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the bounding shape (EDIT).</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvEffect.html#d0">serialFileHeader</a> (<a class="el" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> &<a class="el" href="driver__opengl__extension__def_8h.html#a383">s</a>, <a class="el" href="memory__common_8h.html#a11">uint32</a> &nb)</td></tr> +<tr><td> </td><td><font size=-1><em>Serialize file header.</em> <a href="#d0">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_1CEnvEffect.html#d1">load</a> (std::vector< CEnvEffect * > &container, <a class="el" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> &<a class="el" href="driver__opengl__extension__def_8h.html#a383">s</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>Load several EnvEffects and return the number of effects loaded.</em> <a href="#d1">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_1CEnvEffect.html#d2">save</a> (const std::vector< CEnvEffect > &container, <a class="el" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> &<a class="el" href="driver__opengl__extension__def_8h.html#a383">s</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>Save (output stream only) (EDIT).</em> <a href="#d2">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="memory__common_8h.html#a7">uint8</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvEffect.html#o0">_Current</a></td></tr> +<tr><td nowrap align=right valign=top>std::vector< <a class="el" href="structNLSOUND_1_1TEnvEffectRoom.html">TEnvEffectRoom</a> > </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvEffect.html#o1">_EnvNums</a></td></tr> +<tr><td nowrap align=right valign=top>std::vector< std::string > </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvEffect.html#o2">_Tags</a></td></tr> +<tr><td nowrap align=right valign=top>IBoundingShape * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CEnvEffect.html#o3">_BoundingShape</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Environmental effects and where they are applied. +<p> +<dl compact><dt><b> +Deprecated: </b><dd> + </dl><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__effect_8h-source.html#l00098">98</a> of file <a class="el" href="env__effect_8h-source.html">env_effect.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NLSOUND::CEnvEffect::CEnvEffect"></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::CEnvEffect::CEnvEffect </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__effect_8cpp-source.html#l00039">39</a> of file <a class="el" href="env__effect_8cpp-source.html">env_effect.cpp</a>. +<p> +Referenced by <a class="el" href="env__effect_8cpp-source.html#l00062">load</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLSOUND::CEnvEffect::~CEnvEffect"></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 NLSOUND::CEnvEffect::~CEnvEffect </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Destructor. +<p> + +<p> +Definition at line <a class="el" href="env__effect_8h-source.html#l00105">105</a> of file <a class="el" href="env__effect_8h-source.html">env_effect.h</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a7" doxytag="NLSOUND::CEnvEffect::addEnvNum"></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::CEnvEffect::addEnvNum </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLSOUND.html#a87">TEnvEffectPreset</a> </td> + <td class="mdname" nowrap> <em>num</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></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>customsize</em> = -1.0f</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 the environment type (EDIT). +<p> +The size of the environment is computed with the bounding shape, unless the argument customshape is positive. +<p> +Definition at line <a class="el" href="env__effect_8cpp-source.html#l00087">87</a> of file <a class="el" href="env__effect_8cpp-source.html">env_effect.cpp</a>. +<p> +References <a class="el" href="env__effect_8h-source.html#l00148">_EnvNums</a>, <a class="el" href="env__effect_8h-source.html#l00151">_Tags</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00820">num</a>, and <a class="el" href="env__effect_8h-source.html#l00038">NLSOUND::TEnvEffectPreset</a>. </td> + </tr> +</table> +<a name="a8" doxytag="NLSOUND::CEnvEffect::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::CEnvEffect::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> +Access the bounding shape (EDIT). +<p> + +<p> +Definition at line <a class="el" href="env__effect_8h-source.html#l00135">135</a> of file <a class="el" href="env__effect_8h-source.html">env_effect.h</a>. +<p> +References <a class="el" href="env__effect_8h-source.html#l00154">_BoundingShape</a>. </td> + </tr> +</table> +<a name="a5" doxytag="NLSOUND::CEnvEffect::getEnvNum"></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#a87">TEnvEffectPreset</a> NLSOUND::CEnvEffect::getEnvNum </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 environment type. +<p> + +<p> +Definition at line <a class="el" href="env__effect_8h-source.html#l00124">124</a> of file <a class="el" href="env__effect_8h-source.html">env_effect.h</a>. +<p> +References <a class="el" href="env__effect_8h-source.html#l00145">_Current</a>, <a class="el" href="env__effect_8h-source.html#l00148">_EnvNums</a>, and <a class="el" href="env__effect_8h-source.html#l00038">NLSOUND::TEnvEffectPreset</a>. </td> + </tr> +</table> +<a name="a6" doxytag="NLSOUND::CEnvEffect::getEnvSize"></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::CEnvEffect::getEnvSize </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const</td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the environment size. +<p> + +<p> +Definition at line <a class="el" href="env__effect_8cpp-source.html#l00097">97</a> of file <a class="el" href="env__effect_8cpp-source.html">env_effect.cpp</a>. +<p> +References <a class="el" href="env__effect_8h-source.html#l00154">_BoundingShape</a>, <a class="el" href="env__effect_8h-source.html#l00145">_Current</a>, and <a class="el" href="env__effect_8h-source.html#l00148">_EnvNums</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NLSOUND::CEnvEffect::include"></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::CEnvEffect::include </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>pos</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return true if the environment includes the specified point. +<p> + +<p> +Definition at line <a class="el" href="env__effect_8h-source.html#l00120">120</a> of file <a class="el" href="env__effect_8h-source.html">env_effect.h</a>. +<p> +References <a class="el" href="env__effect_8h-source.html#l00154">_BoundingShape</a>. </td> + </tr> +</table> +<a name="d1" doxytag="NLSOUND::CEnvEffect::load"></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::CEnvEffect::load </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::vector< CEnvEffect * > & </td> + <td class="mdname" nowrap> <em>container</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> & </td> + <td class="mdname" nowrap> <em>s</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Load several EnvEffects and return the number of effects loaded. +<p> + +<p> +Definition at line <a class="el" href="env__effect_8cpp-source.html#l00062">62</a> of file <a class="el" href="env__effect_8cpp-source.html">env_effect.cpp</a>. +<p> +References <a class="el" href="env__effect_8cpp-source.html#l00039">CEnvEffect</a>, <a class="el" href="stream__inline_8h-source.html#l00062">NLMISC::IStream::isReading</a>, <a class="el" href="debug_8h-source.html#l00374">nlstop</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00673">s</a>, <a class="el" href="stream_8h-source.html#l00222">NLMISC::IStream::serial</a>, and <a class="el" href="env__effect_8cpp-source.html#l00047">serialFileHeader</a>. </td> + </tr> +</table> +<a name="d2" doxytag="NLSOUND::CEnvEffect::save"></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::CEnvEffect::save </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::vector< CEnvEffect > & </td> + <td class="mdname" nowrap> <em>container</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> & </td> + <td class="mdname" nowrap> <em>s</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Save (output stream only) (EDIT). +<p> + +<p> +Definition at line <a class="el" href="env__effect_8cpp-source.html#l00133">133</a> of file <a class="el" href="env__effect_8cpp-source.html">env_effect.cpp</a>. +<p> +References <a class="el" href="stream__inline_8h-source.html#l00062">NLMISC::IStream::isReading</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00673">s</a>, <a class="el" href="stream_8h-source.html#l00222">NLMISC::IStream::serial</a>, and <a class="el" href="env__effect_8cpp-source.html#l00047">serialFileHeader</a>. </td> + </tr> +</table> +<a name="a4" doxytag="NLSOUND::CEnvEffect::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::CEnvEffect::selectEnv </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>tag</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> +Select the current environment. +<p> + +<p> +Definition at line <a class="el" href="env__effect_8cpp-source.html#l00113">113</a> of file <a class="el" href="env__effect_8cpp-source.html">env_effect.cpp</a>. +<p> +References <a class="el" href="env__effect_8h-source.html#l00145">_Current</a>, <a class="el" href="env__effect_8h-source.html#l00151">_Tags</a>, and <a class="el" href="debug_8h-source.html#l00087">nldebug</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NLSOUND::CEnvEffect::serial"></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::CEnvEffect::serial </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>s</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Serialize. +<p> + +<p> +Definition at line <a class="el" href="env__effect_8h-source.html#l00107">107</a> of file <a class="el" href="env__effect_8h-source.html">env_effect.h</a>. +<p> +References <a class="el" href="env__effect_8h-source.html#l00154">_BoundingShape</a>, <a class="el" href="env__effect_8h-source.html#l00148">_EnvNums</a>, <a class="el" href="env__effect_8h-source.html#l00151">_Tags</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00673">s</a>, <a class="el" href="stream_8h-source.html#l00312">NLMISC::IStream::serialCont</a>, and <a class="el" href="stream_8h-source.html#l00460">NLMISC::IStream::serialPolyPtr</a>. </td> + </tr> +</table> +<a name="d0" doxytag="NLSOUND::CEnvEffect::serialFileHeader"></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::CEnvEffect::serialFileHeader </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> & </td> + <td class="mdname" nowrap> <em>s</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="memory__common_8h.html#a11">uint32</a> & </td> + <td class="mdname" nowrap> <em>nb</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Serialize file header. +<p> + +<p> +Definition at line <a class="el" href="env__effect_8cpp-source.html#l00047">47</a> of file <a class="el" href="env__effect_8cpp-source.html">env_effect.cpp</a>. +<p> +References <a class="el" href="driver__opengl__extension__def_8h-source.html#l00673">s</a>, <a class="el" href="stream_8h-source.html#l00222">NLMISC::IStream::serial</a>, <a class="el" href="stream_8h-source.html#l00488">NLMISC::IStream::serialCheck</a>, and <a class="el" href="stream_8cpp-source.html#l00253">NLMISC::IStream::serialVersion</a>. +<p> +Referenced by <a class="el" href="env__effect_8cpp-source.html#l00062">load</a>, and <a class="el" href="env__effect_8cpp-source.html#l00133">save</a>. </td> + </tr> +</table> +<a name="a9" doxytag="NLSOUND::CEnvEffect::setBoundingShape"></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::CEnvEffect::setBoundingShape </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">IBoundingShape * </td> + <td class="mdname1" valign="top" nowrap> <em>bs</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the bounding shape (EDIT). +<p> + +<p> +Definition at line <a class="el" href="env__effect_8h-source.html#l00137">137</a> of file <a class="el" href="env__effect_8h-source.html">env_effect.h</a>. +<p> +References <a class="el" href="env__effect_8h-source.html#l00154">_BoundingShape</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="o3" doxytag="NLSOUND::CEnvEffect::_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::CEnvEffect::_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__effect_8h-source.html#l00154">154</a> of file <a class="el" href="env__effect_8h-source.html">env_effect.h</a>. +<p> +Referenced by <a class="el" href="env__effect_8h-source.html#l00135">getBoundingShape</a>, <a class="el" href="env__effect_8cpp-source.html#l00097">getEnvSize</a>, <a class="el" href="env__effect_8h-source.html#l00120">include</a>, <a class="el" href="env__effect_8h-source.html#l00107">serial</a>, and <a class="el" href="env__effect_8h-source.html#l00137">setBoundingShape</a>. </td> + </tr> +</table> +<a name="o0" doxytag="NLSOUND::CEnvEffect::_Current"></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#a7">uint8</a> NLSOUND::CEnvEffect::_Current<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__effect_8h-source.html#l00145">145</a> of file <a class="el" href="env__effect_8h-source.html">env_effect.h</a>. +<p> +Referenced by <a class="el" href="env__effect_8h-source.html#l00124">getEnvNum</a>, <a class="el" href="env__effect_8cpp-source.html#l00097">getEnvSize</a>, and <a class="el" href="env__effect_8cpp-source.html#l00113">selectEnv</a>. </td> + </tr> +</table> +<a name="o1" doxytag="NLSOUND::CEnvEffect::_EnvNums"></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="structNLSOUND_1_1TEnvEffectRoom.html">TEnvEffectRoom</a>> NLSOUND::CEnvEffect::_EnvNums<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__effect_8h-source.html#l00148">148</a> of file <a class="el" href="env__effect_8h-source.html">env_effect.h</a>. +<p> +Referenced by <a class="el" href="env__effect_8cpp-source.html#l00087">addEnvNum</a>, <a class="el" href="env__effect_8h-source.html#l00124">getEnvNum</a>, <a class="el" href="env__effect_8cpp-source.html#l00097">getEnvSize</a>, and <a class="el" href="env__effect_8h-source.html#l00107">serial</a>. </td> + </tr> +</table> +<a name="o2" doxytag="NLSOUND::CEnvEffect::_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::CEnvEffect::_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__effect_8h-source.html#l00151">151</a> of file <a class="el" href="env__effect_8h-source.html">env_effect.h</a>. +<p> +Referenced by <a class="el" href="env__effect_8cpp-source.html#l00087">addEnvNum</a>, <a class="el" href="env__effect_8cpp-source.html#l00113">selectEnv</a>, and <a class="el" href="env__effect_8h-source.html#l00107">serial</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="env__effect_8h-source.html">env_effect.h</a><li><a class="el" href="env__effect_8cpp-source.html">env_effect.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> |