diff options
Diffstat (limited to 'docs/doxygen/nel/water__pool__manager_8h-source.html')
| -rw-r--r-- | docs/doxygen/nel/water__pool__manager_8h-source.html | 178 |
1 files changed, 178 insertions, 0 deletions
diff --git a/docs/doxygen/nel/water__pool__manager_8h-source.html b/docs/doxygen/nel/water__pool__manager_8h-source.html new file mode 100644 index 00000000..ddbd0bea --- /dev/null +++ b/docs/doxygen/nel/water__pool__manager_8h-source.html @@ -0,0 +1,178 @@ +<!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>water_pool_manager.h</h1><a href="water__pool__manager_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 +00007 <font class="comment">/* Copyright, 2000, 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 +00026 <font class="preprocessor">#ifndef NL_WATER_POOL_MANAGER_H</font> +00027 <font class="preprocessor"></font><font class="preprocessor">#define NL_WATER_POOL_MANAGER_H</font> +00028 <font class="preprocessor"></font> +00029 <font class="preprocessor">#include "<a class="code" href="types__nl_8h.html">nel/misc/types_nl.h</a>"</font> +00030 <font class="preprocessor">#include "<a class="code" href="smart__ptr_8h.html">nel/misc/smart_ptr.h</a>"</font> +00031 <font class="preprocessor">#include "<a class="code" href="stream_8h.html">nel/misc/stream.h</a>"</font> +00032 +00033 <font class="preprocessor">#include <map></font> +00034 <font class="preprocessor">#include <vector></font> +00035 <font class="preprocessor">#include <string></font> +00036 +00037 <font class="keyword">namespace </font>NL3D { +00038 +00039 <font class="keyword">class </font>CWaterHeightMap; +00040 <font class="keyword">class </font>IDriver; +00041 +<a name="l00048"></a><a class="code" href="classNL3D_1_1CWaterPoolManager.html">00048</a> <font class="keyword">class </font>CWaterPoolManager +00049 { +00050 <font class="keyword">public</font>: +<a name="l00052"></a><a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html">00052</a> <font class="keyword">struct </font>CWaterHeightMapBuild +00053 { +<a name="l00054"></a><a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m0">00054</a> <a class="code" href="types__nl_8h.html#a9">uint32</a> <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m0">ID</a>; +<a name="l00055"></a><a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m1">00055</a> <a class="code" href="types__nl_8h.html#a9">uint32</a> <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m1">Size</a>; +<a name="l00056"></a><a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m2">00056</a> std::string <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m2">Name</a>; +<a name="l00057"></a><a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m3">00057</a> <font class="keywordtype">float</font> <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m3">Damping</a>; +<a name="l00058"></a><a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m4">00058</a> <font class="keywordtype">float</font> <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m4">FilterWeight</a>; +<a name="l00059"></a><a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m5">00059</a> <font class="keywordtype">float</font> <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m5">UnitSize</a>; +<a name="l00060"></a><a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m6">00060</a> <font class="keywordtype">bool</font> <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m6">WavesEnabled</a>; +<a name="l00061"></a><a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m7">00061</a> <font class="keywordtype">float</font> <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m7">WaveIntensity</a>; +<a name="l00062"></a><a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m8">00062</a> <a class="code" href="types__nl_8h.html#a9">uint32</a> <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m8">WaveRadius</a>; +<a name="l00063"></a><a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m9">00063</a> <font class="keywordtype">float</font> <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m9">WavePeriod</a>; +<a name="l00064"></a><a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m10">00064</a> <font class="keywordtype">bool</font> <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m10">BorderWaves</a>; +<a name="l00065"></a><a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#a0">00065</a> <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#a0">CWaterHeightMapBuild</a>() : <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m0">ID</a>(0), <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m1">Size</a>(256), <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m6">WavesEnabled</a>(false), <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m3">Damping</a>(0.99f), <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m4">FilterWeight</a>(3), <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m5">UnitSize</a>(0.30f), <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m7">WaveIntensity</a>(1.5), <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m9">WavePeriod</a>(0.05f), <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m8">WaveRadius</a>(3), <a class="code" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html#m10">BorderWaves</a>(true) {} +00066 }; +00068 CWaterHeightMap *<a class="code" href="classNL3D_1_1CWaterPoolManager.html#a0">createWaterPool</a>(<font class="keyword">const</font> CWaterHeightMapBuild &<a class="code" href="driver__opengl__extension__def_8h.html#a224">params</a> = CWaterHeightMapBuild()); +00069 +00071 CWaterHeightMap &<a class="code" href="classNL3D_1_1CWaterPoolManager.html#a1">getPoolByID</a>(<a class="code" href="types__nl_8h.html#a9">uint32</a> ID); +00072 +00074 <font class="keywordtype">bool</font> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#a2">hasPool</a>(<a class="code" href="types__nl_8h.html#a9">uint32</a> ID) <font class="keyword">const</font>; +00075 +00077 <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#a3">removePool</a>(<a class="code" href="types__nl_8h.html#a9">uint32</a> ID); +00078 +00080 <a class="code" href="types__nl_8h.html#a13">uint</a> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#a4">getNumPools</a>() <font class="keyword">const</font>; +00081 +00083 <a class="code" href="types__nl_8h.html#a13">uint</a> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#a5">getPoolID</a>(<a class="code" href="types__nl_8h.html#a13">uint</a> i) <font class="keyword">const</font>; +00084 +00085 +00086 +00087 +00089 <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#a6">reset</a>(); +00090 +00091 <font class="comment">// dtor</font> +<a name="l00092"></a><a class="code" href="classNL3D_1_1CWaterPoolManager.html#a7">00092</a> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#a7">~CWaterPoolManager</a>() { <a class="code" href="classNL3D_1_1CWaterPoolManager.html#a6">reset</a>(); } +00093 +00097 <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#a8">setBlendFactor</a>(IDriver *drv, <font class="keywordtype">float</font> factor); +00098 +00100 <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#a9">serial</a>(<a class="code" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> &f) <font class="keywordflow">throw</font>(NLMISC::EStream); +00101 +00102 <font class="keyword">private</font>: +<a name="l00103"></a><a class="code" href="classNL3D_1_1CWaterPoolManager.html#l0">00103</a> <font class="keyword">friend</font> <font class="keyword">class </font><a class="code" href="classNL3D_1_1CWaterPoolManager.html#l0">CWaterShape</a>; +00104 <font class="keyword">friend</font> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#c0">CWaterPoolManager</a> &<a class="code" href="classNL3D_1_1CWaterPoolManager.html#a456">GetWaterPoolManager</a>(); +<a name="l00105"></a><a class="code" href="classNL3D_1_1CWaterPoolManager.html#c0">00105</a> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#c0">CWaterPoolManager</a>() {} <font class="comment">// private ctor needed to use the singleton pattern</font> +<a name="l00106"></a><a class="code" href="classNL3D_1_1CWaterPoolManager.html#u0">00106</a> <font class="keyword">typedef</font> std::map<uint32, CWaterHeightMap *> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#u0">TPoolMap</a>; +<a name="l00107"></a><a class="code" href="classNL3D_1_1CWaterPoolManager.html#o0">00107</a> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#u0">TPoolMap</a> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#o0">_PoolMap</a>; +00108 +00110 <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#c1">registerWaterShape</a>(<a class="code" href="classNL3D_1_1CWaterPoolManager.html#l0">CWaterShape</a> *shape); +00111 <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#c2">unRegisterWaterShape</a>(<a class="code" href="classNL3D_1_1CWaterPoolManager.html#l0">CWaterShape</a> *shape); +00112 <font class="keywordtype">bool</font> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#c3">isWaterShapeObserver</a>(<font class="keyword">const</font> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#l0">CWaterShape</a> *shape) <font class="keyword">const</font>; +<a name="l00113"></a><a class="code" href="classNL3D_1_1CWaterPoolManager.html#u1">00113</a> <font class="keyword">typedef</font> std::vector<CWaterShape *> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#u1">TWaterShapeVect</a>; +<a name="l00114"></a><a class="code" href="classNL3D_1_1CWaterPoolManager.html#o1">00114</a> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#u1">TWaterShapeVect</a> <a class="code" href="classNL3D_1_1CWaterPoolManager.html#o1">_WaterShapes</a>; +00115 }; +00116 +00117 +00118 <font class="comment">// get the only water pool manager (caution : with several dll, there may be duplication however,</font> +00119 <font class="comment">// if NL3D is linked as a static lib with several of them, so you may need to pass the address of the manager being used to other dlls)</font> +00120 CWaterPoolManager &<a class="code" href="namespaceNL3D.html#a456">GetWaterPoolManager</a>(); +00121 +00122 +00123 } <font class="comment">// NL3D</font> +00124 +00125 +00126 <font class="preprocessor">#endif // NL_WATER_POOL_MANAGER_H</font> +00127 <font class="preprocessor"></font> +00128 <font class="comment">/* End of water_pool_manager.h */</font> +</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> |