diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/env__effect_8h-source.html | 207 |
1 files changed, 207 insertions, 0 deletions
diff --git a/docs/doxygen/nel/env__effect_8h-source.html b/docs/doxygen/nel/env__effect_8h-source.html new file mode 100644 index 00000000..533bd280 --- /dev/null +++ b/docs/doxygen/nel/env__effect_8h-source.html @@ -0,0 +1,207 @@ +<!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>env_effect.h</h1><a href="env__effect_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 +00007 <font class="comment">/* Copyright, 2001 Nevrax Ltd.</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This file is part of NEVRAX NEL.</font> +00010 <font class="comment"> * NEVRAX NEL is free software; you can redistribute it and/or modify</font> +00011 <font class="comment"> * it under the terms of the GNU General Public License as published by</font> +00012 <font class="comment"> * the Free Software Foundation; either version 2, or (at your option)</font> +00013 <font class="comment"> * any later version.</font> +00014 <font class="comment"></font> +00015 <font class="comment"> * NEVRAX NEL is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"></font> +00020 <font class="comment"> * You should have received a copy of the GNU General Public License</font> +00021 <font class="comment"> * along with NEVRAX NEL; see the file COPYING. If not, write to the</font> +00022 <font class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</font> +00023 <font class="comment"> * MA 02111-1307, USA.</font> +00024 <font class="comment"> */</font> +00025 <font class="preprocessor">#error "Deprecated"</font> +00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#ifndef NL_ENV_EFFECT_H</font> +00028 <font class="preprocessor"></font><font class="preprocessor">#define NL_ENV_EFFECT_H</font> +00029 <font class="preprocessor"></font> +00030 <font class="preprocessor">#include "<a class="code" href="types__nl_8h.html">nel/misc/types_nl.h</a>"</font> +00031 <font class="preprocessor">#include "<a class="code" href="stream_8h.html">nel/misc/stream.h</a>"</font> +00032 <font class="preprocessor">#include "bounding_shape.h"</font> +00033 +00034 <font class="keyword">namespace </font>NLSOUND { +00035 +00036 +00038 <font class="keyword">enum</font> <a class="code" href="namespaceNLSOUND.html#a87">TEnvEffectPreset</a> +00039 { +00040 <a class="code" href="namespaceNLSOUND.html#a87a42">ENVEFFECT_GENERIC</a>, +00041 <a class="code" href="namespaceNLSOUND.html#a87a43">ENVEFFECT_PADDEDCELL</a>, +00042 <a class="code" href="namespaceNLSOUND.html#a87a44">ENVEFFECT_ROOM</a>, +00043 <a class="code" href="namespaceNLSOUND.html#a87a45">ENVEFFECT_BATHROOM</a>, +00044 <a class="code" href="namespaceNLSOUND.html#a87a46">ENVEFFECT_LIVINGROOM</a>, +00045 <a class="code" href="namespaceNLSOUND.html#a87a47">ENVEFFECT_STONEROOM</a>, +00046 <a class="code" href="namespaceNLSOUND.html#a87a48">ENVEFFECT_AUDITORIUM</a>, +00047 <a class="code" href="namespaceNLSOUND.html#a87a49">ENVEFFECT_CONCERTHALL</a>, +00048 <a class="code" href="namespaceNLSOUND.html#a87a50">ENVEFFECT_CAVE</a>, +00049 <a class="code" href="namespaceNLSOUND.html#a87a51">ENVEFFECT_ARENA</a>, +00050 <a class="code" href="namespaceNLSOUND.html#a87a52">ENVEFFECT_HANGAR</a>, +00051 <a class="code" href="namespaceNLSOUND.html#a87a53">ENVEFFECT_CARPETEDHALLWAY</a>, +00052 <a class="code" href="namespaceNLSOUND.html#a87a54">ENVEFFECT_HALLWAY</a>, +00053 <a class="code" href="namespaceNLSOUND.html#a87a55">ENVEFFECT_STONECORRIDOR</a>, +00054 <a class="code" href="namespaceNLSOUND.html#a87a56">ENVEFFECT_ALLEY</a>, +00055 <a class="code" href="namespaceNLSOUND.html#a87a57">ENVEFFECT_FOREST</a>, +00056 <a class="code" href="namespaceNLSOUND.html#a87a58">ENVEFFECT_CITY</a>, +00057 <a class="code" href="namespaceNLSOUND.html#a87a59">ENVEFFECT_MOUNTAINS</a>, +00058 <a class="code" href="namespaceNLSOUND.html#a87a60">ENVEFFECT_QUARRY</a>, +00059 <a class="code" href="namespaceNLSOUND.html#a87a61">ENVEFFECT_PLAIN</a>, +00060 <a class="code" href="namespaceNLSOUND.html#a87a62">ENVEFFECT_PARKINGLOT</a>, +00061 <a class="code" href="namespaceNLSOUND.html#a87a63">ENVEFFECT_SEWERPIPE</a>, +00062 <a class="code" href="namespaceNLSOUND.html#a87a64">ENVEFFECT_UNDERWATER</a>, +00063 <a class="code" href="namespaceNLSOUND.html#a87a65">ENVEFFECT_DRUGGED</a>, +00064 <a class="code" href="namespaceNLSOUND.html#a87a66">ENVEFFECT_DIZZY</a>, +00065 <a class="code" href="namespaceNLSOUND.html#a87a67">ENVEFFECT_PSYCHOTIC</a>, +00066 +00067 <a class="code" href="namespaceNLSOUND.html#a87a68">ENVEFFECT_COUNT</a> +00068 }; <font class="comment">// Note: must follow the EAX enum</font> +00069 +00070 +<a name="l00072"></a><a class="code" href="structNLSOUND_1_1TEnvEffectRoom.html">00072</a> <font class="keyword">struct </font>TEnvEffectRoom +00073 { +<a name="l00074"></a><a class="code" href="structNLSOUND_1_1TEnvEffectRoom.html#m0">00074</a> <a class="code" href="namespaceNLSOUND.html#a87">TEnvEffectPreset</a> <a class="code" href="structNLSOUND_1_1TEnvEffectRoom.html#m0">Preset</a>; +<a name="l00075"></a><a class="code" href="structNLSOUND_1_1TEnvEffectRoom.html#m1">00075</a> <font class="keywordtype">float</font> <a class="code" href="structNLSOUND_1_1TEnvEffectRoom.html#m1">Size</a>; +00076 +<a name="l00078"></a><a class="code" href="structNLSOUND_1_1TEnvEffectRoom.html#a0">00078</a> <a class="code" href="structNLSOUND_1_1TEnvEffectRoom.html#a0">TEnvEffectRoom</a>( <font class="keyword">const</font> <a class="code" href="namespaceNLSOUND.html#a87">TEnvEffectPreset</a>& preset=<a class="code" href="namespaceNLSOUND.html#a87a44">ENVEFFECT_ROOM</a>, <font class="keywordtype">float</font> size=7.5 ) : <a class="code" href="structNLSOUND_1_1TEnvEffectRoom.html#m0">Preset</a>(preset), <a class="code" href="structNLSOUND_1_1TEnvEffectRoom.html#m1">Size</a>(size) {} +00079 +<a name="l00081"></a><a class="code" href="structNLSOUND_1_1TEnvEffectRoom.html#a1">00081</a> <font class="keywordtype">void</font> <a class="code" href="structNLSOUND_1_1TEnvEffectRoom.html#a1">serial</a> ( <a class="code" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a>& <a class="code" href="driver__opengl__extension__def_8h.html#a383">s</a> ) +00082 { +00083 uint8 preset8 = (uint8)<a class="code" href="structNLSOUND_1_1TEnvEffectRoom.html#m0">Preset</a>; <font class="comment">// out</font> +00084 s.<a class="code" href="classNLMISC_1_1IStream.html#a5">serial</a>( preset8 ); +00085 <a class="code" href="structNLSOUND_1_1TEnvEffectRoom.html#m0">Preset</a> = (TEnvEffectPreset)preset8; <font class="comment">// in</font> +00086 s.<a class="code" href="classNLMISC_1_1IStream.html#a5">serial</a>( <a class="code" href="structNLSOUND_1_1TEnvEffectRoom.html#m1">Size</a> ); +00087 } +00088 }; +00089 +00090 +<a name="l00098"></a><a class="code" href="classNLSOUND_1_1CEnvEffect.html">00098</a> <font class="keyword">class </font>CEnvEffect +00099 { +00100 <font class="keyword">public</font>: +00101 +00103 <a class="code" href="classNLSOUND_1_1CEnvEffect.html#a0">CEnvEffect</a>(); +<a name="l00105"></a><a class="code" href="classNLSOUND_1_1CEnvEffect.html#a1">00105</a> <font class="keyword">virtual</font> <a class="code" href="classNLSOUND_1_1CEnvEffect.html#a1">~CEnvEffect</a>() {} +<a name="l00107"></a><a class="code" href="classNLSOUND_1_1CEnvEffect.html#a2">00107</a> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvEffect.html#a2">serial</a>( <a class="code" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a>& <a class="code" href="driver__opengl__extension__def_8h.html#a383">s</a> ) +00108 { +00109 <font class="comment">// If you change this, increment the version number in serialFileHeader()</font> +00110 s.<a class="code" href="classNLMISC_1_1IStream.html#a28">serialPolyPtr</a>( <a class="code" href="classNLSOUND_1_1CEnvEffect.html#o3">_BoundingShape</a> ); +00111 s.<a class="code" href="classNLMISC_1_1IStream.html#a7">serialCont</a>( <a class="code" href="classNLSOUND_1_1CEnvEffect.html#o1">_EnvNums</a> ); +00112 s.<a class="code" href="classNLMISC_1_1IStream.html#a7">serialCont</a>( <a class="code" href="classNLSOUND_1_1CEnvEffect.html#o2">_Tags</a> ); +00113 } +00115 <font class="keyword">static</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvEffect.html#d0">serialFileHeader</a>( <a class="code" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a>& <a class="code" href="driver__opengl__extension__def_8h.html#a383">s</a>, uint32& nb ); +00117 <font class="keyword">static</font> uint32 <a class="code" href="classNLSOUND_1_1CEnvEffect.html#d1">load</a>( std::vector<CEnvEffect*>& container, <a class="code" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a>& <a class="code" href="driver__opengl__extension__def_8h.html#a383">s</a> ); +00118 +<a name="l00120"></a><a class="code" href="classNLSOUND_1_1CEnvEffect.html#a3">00120</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CEnvEffect.html#a3">include</a>( <font class="keyword">const</font> <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>& pos ) { <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CEnvEffect.html#o3">_BoundingShape</a>->include( pos ); } +00122 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvEffect.html#a4">selectEnv</a>( <font class="keyword">const</font> std::string& tag ); +<a name="l00124"></a><a class="code" href="classNLSOUND_1_1CEnvEffect.html#a5">00124</a> <a class="code" href="namespaceNLSOUND.html#a87">TEnvEffectPreset</a> <a class="code" href="classNLSOUND_1_1CEnvEffect.html#a5">getEnvNum</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CEnvEffect.html#o1">_EnvNums</a>[<a class="code" href="classNLSOUND_1_1CEnvEffect.html#o0">_Current</a>].Preset; } +00126 <font class="keywordtype">float</font> <a class="code" href="classNLSOUND_1_1CEnvEffect.html#a6">getEnvSize</a>() <font class="keyword">const</font>; +00127 +00128 +00133 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvEffect.html#a7">addEnvNum</a>( <a class="code" href="namespaceNLSOUND.html#a87">TEnvEffectPreset</a> <a class="code" href="driver__opengl__extension__def_8h.html#a410">num</a>, <font class="keyword">const</font> std::string& tag=<font class="stringliteral">""</font>, <font class="keywordtype">float</font> customsize=-1.0f ); +<a name="l00135"></a><a class="code" href="classNLSOUND_1_1CEnvEffect.html#a8">00135</a> IBoundingShape *<a class="code" href="classNLSOUND_1_1CEnvEffect.html#a8">getBoundingShape</a>() { <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CEnvEffect.html#o3">_BoundingShape</a>; } +<a name="l00137"></a><a class="code" href="classNLSOUND_1_1CEnvEffect.html#a9">00137</a> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvEffect.html#a9">setBoundingShape</a>( IBoundingShape *bs ) { <a class="code" href="classNLSOUND_1_1CEnvEffect.html#o3">_BoundingShape</a> = bs; } +00139 <font class="keyword">static</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvEffect.html#d2">save</a>( <font class="keyword">const</font> std::vector<CEnvEffect>& container, <a class="code" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a>& <a class="code" href="driver__opengl__extension__def_8h.html#a383">s</a> ); +00140 +00141 +00142 <font class="keyword">private</font>: +00143 +00144 <font class="comment">// Index of the current environment type</font> +<a name="l00145"></a><a class="code" href="classNLSOUND_1_1CEnvEffect.html#o0">00145</a> uint8 <a class="code" href="classNLSOUND_1_1CEnvEffect.html#o0">_Current</a>; +00146 +00147 <font class="comment">// Types of environment</font> +<a name="l00148"></a><a class="code" href="classNLSOUND_1_1CEnvEffect.html#o1">00148</a> std::vector<TEnvEffectRoom> <a class="code" href="classNLSOUND_1_1CEnvEffect.html#o1">_EnvNums</a>; +00149 +00150 <font class="comment">// Environment tags (indicate which env to select)</font> +<a name="l00151"></a><a class="code" href="classNLSOUND_1_1CEnvEffect.html#o2">00151</a> std::vector<std::string> <a class="code" href="classNLSOUND_1_1CEnvEffect.html#o2">_Tags</a>; +00152 +00153 <font class="comment">// Bounding shape</font> +<a name="l00154"></a><a class="code" href="classNLSOUND_1_1CEnvEffect.html#o3">00154</a> IBoundingShape *<a class="code" href="classNLSOUND_1_1CEnvEffect.html#o3">_BoundingShape</a>; +00155 }; +00156 +00157 +00158 } <font class="comment">// NLSOUND</font> +00159 +00160 +00161 <font class="preprocessor">#endif // NL_ENV_EFFECT_H</font> +00162 <font class="preprocessor"></font> +00163 <font class="comment">/* End of env_effect.h */</font> +00164 +00165 +</pre></div> + +<!-- 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> |