aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a02456.html
diff options
context:
space:
mode:
authorneodarz <neodarz@neodarz.net>2018-08-11 20:21:34 +0200
committerneodarz <neodarz@neodarz.net>2018-08-11 20:21:34 +0200
commit0ea5fc66924303d1bf73ba283a383e2aadee02f2 (patch)
tree2568e71a7ccc44ec23b8bb3f0ff97fb6bf2ed709 /docs/doxygen/nel/a02456.html
downloadnevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.tar.xz
nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.zip
Initial commit
Diffstat (limited to '')
-rw-r--r--docs/doxygen/nel/a02456.html783
1 files changed, 783 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a02456.html b/docs/doxygen/nel/a02456.html
new file mode 100644
index 00000000..e67b7e66
--- /dev/null
+++ b/docs/doxygen/nel/a02456.html
@@ -0,0 +1,783 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>NeL: NLSOUND::CEnvEffect class Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.3.6 -->
+<div class="qindex"> <form class="search" action="search.php" method="get">
+<a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
+<h1>NLSOUND::CEnvEffect Class Reference</h1><code>#include &lt;<a class="el" href="a05675.html">env_effect.h</a>&gt;</code>
+<p>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Environmental effects and where they are applied <p>
+<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd></dd></dl>
+<dl compact><dt><b>Author:</b></dt><dd>Olivier Cado <p>
+Nevrax France </dd></dl>
+<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a05675.html#l00098">98</a> of file <a class="el" href="a05675.html">env_effect.h</a>.<table border=0 cellpadding=0 cellspacing=0>
+<tr><td></td></tr>
+<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02456.html#NLSOUND_1_1CEnvEffecta0">addEnvNum</a> (<a class="el" href="a05381.html#a81">TEnvEffectPreset</a> <a class="el" href="a04223.html#a653">num</a>, const std::string &amp;tag="", float customsize=-1.0f)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02456.html#NLSOUND_1_1CEnvEffecta1">CEnvEffect</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#NLSOUND_1_1CEnvEffecta1"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>IBoundingShape *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02456.html#NLSOUND_1_1CEnvEffecta2">getBoundingShape</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access the bounding shape (EDIT). <a href="#NLSOUND_1_1CEnvEffecta2"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a05381.html#a81">TEnvEffectPreset</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02456.html#NLSOUND_1_1CEnvEffecta3">getEnvNum</a> () const </td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the environment type. <a href="#NLSOUND_1_1CEnvEffecta3"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>float&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02456.html#NLSOUND_1_1CEnvEffecta4">getEnvSize</a> () const </td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the environment size. <a href="#NLSOUND_1_1CEnvEffecta4"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02456.html#NLSOUND_1_1CEnvEffecta5">include</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> &amp;pos)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return true if the environment includes the specified point. <a href="#NLSOUND_1_1CEnvEffecta5"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02456.html#NLSOUND_1_1CEnvEffecta6">selectEnv</a> (const std::string &amp;tag)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select the current environment. <a href="#NLSOUND_1_1CEnvEffecta6"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02456.html#NLSOUND_1_1CEnvEffecta7">serial</a> (<a class="el" href="a02270.html">NLMISC::IStream</a> &amp;<a class="el" href="a04223.html#a626">s</a>)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Serialize. <a href="#NLSOUND_1_1CEnvEffecta7"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02456.html#NLSOUND_1_1CEnvEffecta8">setBoundingShape</a> (IBoundingShape *bs)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the bounding shape (EDIT). <a href="#NLSOUND_1_1CEnvEffecta8"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02456.html#NLSOUND_1_1CEnvEffecta9">~CEnvEffect</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#NLSOUND_1_1CEnvEffecta9"></a><br><br></td></tr>
+<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a04558.html#a11">uint32</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02456.html#NLSOUND_1_1CEnvEffecte0">load</a> (std::vector&lt; <a class="el" href="a02456.html">CEnvEffect</a> * &gt; &amp;container, <a class="el" href="a02270.html">NLMISC::IStream</a> &amp;<a class="el" href="a04223.html#a626">s</a>)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Load several EnvEffects and return the number of effects loaded. <a href="#NLSOUND_1_1CEnvEffecte0"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02456.html#NLSOUND_1_1CEnvEffecte1">save</a> (const std::vector&lt; <a class="el" href="a02456.html">CEnvEffect</a> &gt; &amp;container, <a class="el" href="a02270.html">NLMISC::IStream</a> &amp;<a class="el" href="a04223.html#a626">s</a>)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save (output stream only) (EDIT). <a href="#NLSOUND_1_1CEnvEffecte1"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02456.html#NLSOUND_1_1CEnvEffecte2">serialFileHeader</a> (<a class="el" href="a02270.html">NLMISC::IStream</a> &amp;<a class="el" href="a04223.html#a626">s</a>, <a class="el" href="a04558.html#a11">uint32</a> &amp;nb)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Serialize file header. <a href="#NLSOUND_1_1CEnvEffecte2"></a><br><br></td></tr>
+<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>IBoundingShape *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02456.html#NLSOUND_1_1CEnvEffectr0">_BoundingShape</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a04558.html#a7">uint8</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02456.html#NLSOUND_1_1CEnvEffectr1">_Current</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>std::vector&lt; <a class="el" href="a03902.html">TEnvEffectRoom</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02456.html#NLSOUND_1_1CEnvEffectr2">_EnvNums</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02456.html#NLSOUND_1_1CEnvEffectr3">_Tags</a></td></tr>
+
+</table>
+<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" name="NLSOUND_1_1CEnvEffecta1" doxytag="NLSOUND::CEnvEffect::CEnvEffect" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> NLSOUND::CEnvEffect::CEnvEffect </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&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>
+Constructor.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05674.html#l00039">39</a> of file <a class="el" href="a05674.html">env_effect.cpp</a>.
+<p>
+Referenced by <a class="el" href="a05674.html#l00062">load()</a>.
+<p>
+<div class="fragment"><pre>00039 : <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffectr1">_Current</a>(0), <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffectr0">_BoundingShape</a>(NULL)
+00040 {
+00041 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CEnvEffecta9" doxytag="NLSOUND::CEnvEffect::~CEnvEffect" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual NLSOUND::CEnvEffect::~<a class="el" href="a02456.html">CEnvEffect</a> </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [inline, virtual]</code></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="a05675.html#l00105">105</a> of file <a class="el" href="a05675.html">env_effect.h</a>.
+<p>
+<div class="fragment"><pre>00105 {}
+</pre></div> </td>
+ </tr>
+</table>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="NLSOUND_1_1CEnvEffecta0" doxytag="NLSOUND::CEnvEffect::addEnvNum" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> IKsPropertySet_QuerySupport void NLSOUND::CEnvEffect::addEnvNum </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="a05381.html#a81">TEnvEffectPreset</a>&nbsp;</td>
+ <td class="mdname" nowrap> <em>num</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>const std::string &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>tag</em> = "", </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>float&nbsp;</td>
+ <td class="mdname" nowrap> <em>customsize</em> = -1.0f</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>
+Set the environment type (EDIT). 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="a05674.html#l00087">87</a> of file <a class="el" href="a05674.html">env_effect.cpp</a>.
+<p>
+References <a class="el" href="a05675.html#l00148">_EnvNums</a>, <a class="el" href="a05675.html#l00151">_Tags</a>, and <a class="el" href="a05646.html#l01124">num</a>.
+<p>
+<div class="fragment"><pre>00088 {
+00089 <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffectr2">_EnvNums</a>.push_back( TEnvEffectRoom(num,customsize) );
+00090 <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffectr3">_Tags</a>.push_back( tag );
+00091 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CEnvEffecta2" doxytag="NLSOUND::CEnvEffect::getBoundingShape" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> IBoundingShape* NLSOUND::CEnvEffect::getBoundingShape </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [inline]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Access the bounding shape (EDIT).
+<p>
+
+<p>
+Definition at line <a class="el" href="a05675.html#l00135">135</a> of file <a class="el" href="a05675.html">env_effect.h</a>.
+<p>
+References <a class="el" href="a05675.html#l00154">_BoundingShape</a>.
+<p>
+<div class="fragment"><pre>00135 { <span class="keywordflow">return</span> <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffectr0">_BoundingShape</a>; }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CEnvEffecta3" doxytag="NLSOUND::CEnvEffect::getEnvNum" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> <a class="el" href="a05381.html#a81">TEnvEffectPreset</a> NLSOUND::CEnvEffect::getEnvNum </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap> const<code> [inline]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Return the environment type.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05675.html#l00124">124</a> of file <a class="el" href="a05675.html">env_effect.h</a>.
+<p>
+References <a class="el" href="a05675.html#l00145">_Current</a>, <a class="el" href="a05675.html#l00148">_EnvNums</a>, and <a class="el" href="a05675.html#l00038">NLSOUND::TEnvEffectPreset</a>.
+<p>
+<div class="fragment"><pre>00124 { <span class="keywordflow">return</span> <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffectr2">_EnvNums</a>[<a class="code" href="a02456.html#NLSOUND_1_1CEnvEffectr1">_Current</a>].Preset; }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CEnvEffecta4" doxytag="NLSOUND::CEnvEffect::getEnvSize" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> float NLSOUND::CEnvEffect::getEnvSize </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap> const</td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Return the environment size.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05674.html#l00097">97</a> of file <a class="el" href="a05674.html">env_effect.cpp</a>.
+<p>
+References <a class="el" href="a05675.html#l00154">_BoundingShape</a>, <a class="el" href="a05675.html#l00145">_Current</a>, and <a class="el" href="a05675.html#l00148">_EnvNums</a>.
+<p>
+<div class="fragment"><pre>00098 {
+00099 <span class="keywordflow">if</span> ( <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffectr2">_EnvNums</a>[<a class="code" href="a02456.html#NLSOUND_1_1CEnvEffectr1">_Current</a>].Size &gt; 0 )
+00100 {
+00101 <span class="keywordflow">return</span> <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffectr2">_EnvNums</a>[<a class="code" href="a02456.html#NLSOUND_1_1CEnvEffectr1">_Current</a>].Size;
+00102 }
+00103 <span class="keywordflow">else</span>
+00104 {
+00105 <span class="keywordflow">return</span> <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffectr0">_BoundingShape</a>-&gt;getDiameter();
+00106 }
+00107 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CEnvEffecta5" doxytag="NLSOUND::CEnvEffect::include" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> bool NLSOUND::CEnvEffect::include </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const <a class="el" href="a03128.html">NLMISC::CVector</a> &amp;&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>pos</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [inline]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Return true if the environment includes the specified point.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05675.html#l00120">120</a> of file <a class="el" href="a05675.html">env_effect.h</a>.
+<p>
+References <a class="el" href="a05675.html#l00154">_BoundingShape</a>.
+<p>
+<div class="fragment"><pre>00120 { <span class="keywordflow">return</span> <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffectr0">_BoundingShape</a>-&gt;include( pos ); }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CEnvEffecte0" doxytag="NLSOUND::CEnvEffect::load" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> <a class="el" href="a04558.html#a11">uint32</a> NLSOUND::CEnvEffect::load </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">std::vector&lt; <a class="el" href="a02456.html">CEnvEffect</a> * &gt; &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>container</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap><a class="el" href="a02270.html">NLMISC::IStream</a> &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>s</em></td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">)&nbsp;</td>
+ <td class="md" colspan="2"><code> [static]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Load several EnvEffects and return the number of effects loaded.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05674.html#l00062">62</a> of file <a class="el" href="a05674.html">env_effect.cpp</a>.
+<p>
+References <a class="el" href="a05674.html#l00039">CEnvEffect()</a>, <a class="el" href="a05622.html#l00416">nlstop</a>, <a class="el" href="a05646.html#l00977">s</a>, <a class="el" href="a05674.html#l00047">serialFileHeader()</a>, and <a class="el" href="a05981.html#l00100">uint32</a>.
+<p>
+<div class="fragment"><pre>00063 {
+00064 <span class="keywordflow">if</span> ( <a class="code" href="a04223.html#a626">s</a>.isReading() )
+00065 {
+00066 <a class="code" href="a04558.html#a11">uint32</a> i, nb;
+00067 <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffecte2">serialFileHeader</a>( s, nb );
+00068 <span class="keywordflow">for</span> ( i=0; i!=nb; i++ )
+00069 {
+00070 <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffecta1">CEnvEffect</a> *enveffect = <span class="keyword">new</span> <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffecta1">CEnvEffect</a>();
+00071 <a class="code" href="a04223.html#a626">s</a>.serial( *enveffect );
+00072 container.push_back( enveffect );
+00073 }
+00074 <span class="keywordflow">return</span> nb;
+00075 }
+00076 <span class="keywordflow">else</span>
+00077 {
+00078 <a class="code" href="a04199.html#a12">nlstop</a>;
+00079 <span class="keywordflow">return</span> 0;
+00080 }
+00081 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CEnvEffecte1" doxytag="NLSOUND::CEnvEffect::save" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void NLSOUND::CEnvEffect::save </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const std::vector&lt; <a class="el" href="a02456.html">CEnvEffect</a> &gt; &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>container</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap><a class="el" href="a02270.html">NLMISC::IStream</a> &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>s</em></td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">)&nbsp;</td>
+ <td class="md" colspan="2"><code> [static]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Save (output stream only) (EDIT).
+<p>
+
+<p>
+Definition at line <a class="el" href="a05674.html#l00133">133</a> of file <a class="el" href="a05674.html">env_effect.cpp</a>.
+<p>
+References <a class="el" href="a05622.html#l00290">nlassert</a>, <a class="el" href="a05646.html#l00977">s</a>, <a class="el" href="a05674.html#l00047">serialFileHeader()</a>, and <a class="el" href="a05981.html#l00100">uint32</a>.
+<p>
+<div class="fragment"><pre>00134 {
+00135 <a class="code" href="a04199.html#a6">nlassert</a>( ! <a class="code" href="a04223.html#a626">s</a>.isReading() );
+00136
+00137 <a class="code" href="a04558.html#a11">uint32</a> nb=container.size(), i;
+00138 <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffecte2">serialFileHeader</a>( s, nb );
+00139 <span class="keywordflow">for</span> ( i=0; i!=nb; i++ )
+00140 {
+00141 <a class="code" href="a04223.html#a626">s</a>.serial( const_cast&lt;CEnvEffect&amp;&gt;(container[i]) );
+00142 }
+00143 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CEnvEffecta6" doxytag="NLSOUND::CEnvEffect::selectEnv" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void NLSOUND::CEnvEffect::selectEnv </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const std::string &amp;&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>tag</em> </td>
+ <td class="md" valign="top">&nbsp;)&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>
+Select the current environment.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05674.html#l00113">113</a> of file <a class="el" href="a05674.html">env_effect.cpp</a>.
+<p>
+References <a class="el" href="a05675.html#l00145">_Current</a>, <a class="el" href="a05675.html#l00151">_Tags</a>, <a class="el" href="a05622.html#l00101">nldebug</a>, and <a class="el" href="a05981.html#l00105">uint</a>.
+<p>
+<div class="fragment"><pre>00114 {
+00115 <a class="code" href="a04558.html#a15">uint</a> i;
+00116 <span class="keywordflow">for</span> ( i=0; i!= <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffectr3">_Tags</a>.size(); i++ )
+00117 {
+00118 <span class="keywordflow">if</span> ( <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffectr3">_Tags</a>[i] == tag )
+00119 {
+00120 <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffectr1">_Current</a> = i;
+00121 <a class="code" href="a04199.html#a0">nldebug</a>( <span class="stringliteral">"AM: EnvEffect: Environment changed to %s"</span>, tag.c_str() );
+00122 <span class="keywordflow">return</span>;
+00123 }
+00124 }
+00125 <a class="code" href="a04199.html#a0">nldebug</a>( <span class="stringliteral">"AM: EnvEffect: Environment %s not found"</span>, tag.c_str() );
+00126 <span class="comment">// Don't change _Current if not found</span>
+00127 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CEnvEffecta7" doxytag="NLSOUND::CEnvEffect::serial" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void NLSOUND::CEnvEffect::serial </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="a02270.html">NLMISC::IStream</a> &amp;&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>s</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [inline]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Serialize.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05675.html#l00107">107</a> of file <a class="el" href="a05675.html">env_effect.h</a>.
+<p>
+References <a class="el" href="a05675.html#l00154">_BoundingShape</a>, <a class="el" href="a05675.html#l00148">_EnvNums</a>, <a class="el" href="a05675.html#l00151">_Tags</a>, and <a class="el" href="a05646.html#l00977">s</a>.
+<p>
+<div class="fragment"><pre>00108 {
+00109 <span class="comment">// If you change this, increment the version number in serialFileHeader()</span>
+00110 <a class="code" href="a04223.html#a626">s</a>.serialPolyPtr( _BoundingShape );
+00111 <a class="code" href="a04223.html#a626">s</a>.serialCont( _EnvNums );
+00112 <a class="code" href="a04223.html#a626">s</a>.serialCont( _Tags );
+00113 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CEnvEffecte2" doxytag="NLSOUND::CEnvEffect::serialFileHeader" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void NLSOUND::CEnvEffect::serialFileHeader </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="a02270.html">NLMISC::IStream</a> &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>s</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap><a class="el" href="a04558.html#a11">uint32</a> &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>nb</em></td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">)&nbsp;</td>
+ <td class="md" colspan="2"><code> [static]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Serialize file header.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05674.html#l00047">47</a> of file <a class="el" href="a05674.html">env_effect.cpp</a>.
+<p>
+References <a class="el" href="a05646.html#l00977">s</a>, and <a class="el" href="a05981.html#l00100">uint32</a>.
+<p>
+Referenced by <a class="el" href="a05674.html#l00062">load()</a>, and <a class="el" href="a05674.html#l00133">save()</a>.
+<p>
+<div class="fragment"><pre>00048 {
+00049 <a class="code" href="a04223.html#a626">s</a>.serialCheck( (<a class="code" href="a04558.html#a11">uint32</a>)'FEN' ); <span class="comment">// NeL Environment FX</span>
+00050 <span class="keywordflow">if</span> ( <a class="code" href="a04223.html#a626">s</a>.serialVersion( 2 ) &lt; 2 )
+00051 {
+00052 <span class="keywordflow">throw</span> EOlderStream(s);
+00053 }
+00054
+00055 <a class="code" href="a04223.html#a626">s</a>.serial( nb );
+00056 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CEnvEffecta8" doxytag="NLSOUND::CEnvEffect::setBoundingShape" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void NLSOUND::CEnvEffect::setBoundingShape </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">IBoundingShape *&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>bs</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [inline]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Set the bounding shape (EDIT).
+<p>
+
+<p>
+Definition at line <a class="el" href="a05675.html#l00137">137</a> of file <a class="el" href="a05675.html">env_effect.h</a>.
+<p>
+References <a class="el" href="a05675.html#l00154">_BoundingShape</a>.
+<p>
+<div class="fragment"><pre>00137 { <a class="code" href="a02456.html#NLSOUND_1_1CEnvEffectr0">_BoundingShape</a> = bs; }
+</pre></div> </td>
+ </tr>
+</table>
+<hr><h2>Field Documentation</h2>
+<a class="anchor" name="NLSOUND_1_1CEnvEffectr0" doxytag="NLSOUND::CEnvEffect::_BoundingShape" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> IBoundingShape* <a class="el" href="a02456.html#NLSOUND_1_1CEnvEffectr0">NLSOUND::CEnvEffect::_BoundingShape</a><code> [private]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a05675.html#l00154">154</a> of file <a class="el" href="a05675.html">env_effect.h</a>.
+<p>
+Referenced by <a class="el" href="a05675.html#l00135">getBoundingShape()</a>, <a class="el" href="a05674.html#l00097">getEnvSize()</a>, <a class="el" href="a05675.html#l00120">include()</a>, <a class="el" href="a05675.html#l00107">serial()</a>, and <a class="el" href="a05675.html#l00137">setBoundingShape()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CEnvEffectr1" doxytag="NLSOUND::CEnvEffect::_Current" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> <a class="el" href="a04558.html#a7">uint8</a> <a class="el" href="a02456.html#NLSOUND_1_1CEnvEffectr1">NLSOUND::CEnvEffect::_Current</a><code> [private]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a05675.html#l00145">145</a> of file <a class="el" href="a05675.html">env_effect.h</a>.
+<p>
+Referenced by <a class="el" href="a05675.html#l00124">getEnvNum()</a>, <a class="el" href="a05674.html#l00097">getEnvSize()</a>, and <a class="el" href="a05674.html#l00113">selectEnv()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CEnvEffectr2" doxytag="NLSOUND::CEnvEffect::_EnvNums" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> std::vector&lt;<a class="el" href="a03902.html">TEnvEffectRoom</a>&gt; <a class="el" href="a02456.html#NLSOUND_1_1CEnvEffectr2">NLSOUND::CEnvEffect::_EnvNums</a><code> [private]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a05675.html#l00148">148</a> of file <a class="el" href="a05675.html">env_effect.h</a>.
+<p>
+Referenced by <a class="el" href="a05674.html#l00087">addEnvNum()</a>, <a class="el" href="a05675.html#l00124">getEnvNum()</a>, <a class="el" href="a05674.html#l00097">getEnvSize()</a>, and <a class="el" href="a05675.html#l00107">serial()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CEnvEffectr3" doxytag="NLSOUND::CEnvEffect::_Tags" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> std::vector&lt;std::string&gt; <a class="el" href="a02456.html#NLSOUND_1_1CEnvEffectr3">NLSOUND::CEnvEffect::_Tags</a><code> [private]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a05675.html#l00151">151</a> of file <a class="el" href="a05675.html">env_effect.h</a>.
+<p>
+Referenced by <a class="el" href="a05674.html#l00087">addEnvNum()</a>, <a class="el" href="a05674.html#l00113">selectEnv()</a>, and <a class="el" href="a05675.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="a05675.html">env_effect.h</a><li><a class="el" href="a05674.html">env_effect.cpp</a></ul>
+<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 14:38:15 2004 for NeL by
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
+</a>1.3.6 </small></address>
+</body>
+</html>