diff options
Diffstat (limited to 'docs/doxygen/nel/classNL3D_1_1CWaterPoolManager.html')
| -rw-r--r-- | docs/doxygen/nel/classNL3D_1_1CWaterPoolManager.html | 788 |
1 files changed, 788 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNL3D_1_1CWaterPoolManager.html b/docs/doxygen/nel/classNL3D_1_1CWaterPoolManager.html new file mode 100644 index 00000000..21287b67 --- /dev/null +++ b/docs/doxygen/nel/classNL3D_1_1CWaterPoolManager.html @@ -0,0 +1,788 @@ +<!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>NL3D::CWaterPoolManager Class Reference</h1>This class helps managing various waters pools. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="water__pool__manager_8h-source.html">water_pool_manager.h</a>></code> +<p> +<a href="classNL3D_1_1CWaterPoolManager-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><a class="el" href="classNL3D_1_1CWaterHeightMap.html">CWaterHeightMap</a> * </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterPoolManager.html#a0">createWaterPool</a> (const <a class="el" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html">CWaterHeightMapBuild</a> &<a class="el" href="driver__opengl__extension__def_8h.html#a357">params</a>=<a class="el" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html">CWaterHeightMapBuild</a>())</td></tr> +<tr><td> </td><td><font size=-1><em>create a water pool with the given id and the given parameters. If the pool existed before, its parameter are reset.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNL3D_1_1CWaterHeightMap.html">CWaterHeightMap</a> & </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterPoolManager.html#a1">getPoolByID</a> (<a class="el" href="memory__common_8h.html#a11">uint32</a> ID)</td></tr> +<tr><td> </td><td><font size=-1><em>Get a water pool by its ID. If the ID doesn't exist, a new pool is created with default parameters.</em> <a href="#a1">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="classNL3D_1_1CWaterPoolManager.html#a2">hasPool</a> (<a class="el" href="memory__common_8h.html#a11">uint32</a> ID) const</td></tr> +<tr><td> </td><td><font size=-1><em>test wether a pool of the given ID exists.</em> <a href="#a2">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="classNL3D_1_1CWaterPoolManager.html#a3">removePool</a> (<a class="el" href="memory__common_8h.html#a11">uint32</a> ID)</td></tr> +<tr><td> </td><td><font size=-1><em>remove the pool of the given ID.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a15">uint</a> </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterPoolManager.html#a4">getNumPools</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the number of pools.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a15">uint</a> </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterPoolManager.html#a5">getPoolID</a> (<a class="el" href="memory__common_8h.html#a15">uint</a> i) const</td></tr> +<tr><td> </td><td><font size=-1><em>get the id of the i-th pool (O(n) lookup).</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterPoolManager.html#a6">reset</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>delete all heightmaps.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterPoolManager.html#a7">~CWaterPoolManager</a> ()</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterPoolManager.html#a8">setBlendFactor</a> (<a class="el" href="classNL3D_1_1IDriver.html">IDriver</a> *drv, float factor)</td></tr> +<tr><td> </td><td><font size=-1><em>Set a blend factor for all pool (more precisely, all models based on a water shape) that have a blend texture for their envmap (to have cycle between night and day for example).</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="classNL3D_1_1CWaterPoolManager.html#a9">serial</a> (<a class="el" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> &f) throw (NLMISC::EStream)</td></tr> +<tr><td> </td><td><font size=-1><em>serial the pools data's.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Types</h2></td></tr> +<tr><td nowrap align=right valign=top>typedef std::map< <a class="el" href="memory__common_8h.html#a11">uint32</a>,<br> + <a class="el" href="classNL3D_1_1CWaterHeightMap.html">CWaterHeightMap</a> * > </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterPoolManager.html#u0">TPoolMap</a></td></tr> +<tr><td nowrap align=right valign=top>typedef std::vector< <a class="el" href="classNL3D_1_1CWaterShape.html">CWaterShape</a> * > </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterPoolManager.html#u1">TWaterShapeVect</a></td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterPoolManager.html#c0">CWaterPoolManager</a> ()</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterPoolManager.html#c1">registerWaterShape</a> (<a class="el" href="classNL3D_1_1CWaterShape.html">CWaterShape</a> *shape)</td></tr> +<tr><td> </td><td><font size=-1><em>register a water height map. The water height map will be notified when a setBlend is applied.</em> <a href="#c1">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="classNL3D_1_1CWaterPoolManager.html#c2">unRegisterWaterShape</a> (<a class="el" href="classNL3D_1_1CWaterShape.html">CWaterShape</a> *shape)</td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterPoolManager.html#c3">isWaterShapeObserver</a> (const <a class="el" href="classNL3D_1_1CWaterShape.html">CWaterShape</a> *shape) const</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNL3D_1_1CWaterPoolManager.html#u0">TPoolMap</a> </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterPoolManager.html#o0">_PoolMap</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNL3D_1_1CWaterPoolManager.html#u1">TWaterShapeVect</a> </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterPoolManager.html#o1">_WaterShapes</a></td></tr> +<tr><td colspan=2><br><h2>Friends</h2></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterPoolManager.html#l0">CWaterShape</a></td></tr> +<tr><td nowrap align=right valign=top>CWaterPoolManager & </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterPoolManager.html#l1">GetWaterPoolManager</a> ()</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This class helps managing various waters pools. +<p> +<dl compact><dt><b> +Author: </b><dd> +Nicolas Vizerie , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2001 </dl> +<p> + +<p> +Definition at line <a class="el" href="water__pool__manager_8h-source.html#l00048">48</a> of file <a class="el" href="water__pool__manager_8h-source.html">water_pool_manager.h</a>.<hr><h2>Member Typedef Documentation</h2> +<a name="u0" doxytag="NL3D::CWaterPoolManager::TPoolMap"></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"> typedef std::map<<a class="el" href="memory__common_8h.html#a11">uint32</a>, <a class="el" href="classNL3D_1_1CWaterHeightMap.html">CWaterHeightMap</a> *> NL3D::CWaterPoolManager::TPoolMap<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="water__pool__manager_8h-source.html#l00106">106</a> of file <a class="el" href="water__pool__manager_8h-source.html">water_pool_manager.h</a>. </td> + </tr> +</table> +<a name="u1" doxytag="NL3D::CWaterPoolManager::TWaterShapeVect"></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"> typedef std::vector<<a class="el" href="classNL3D_1_1CWaterShape.html">CWaterShape</a> *> NL3D::CWaterPoolManager::TWaterShapeVect<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="water__pool__manager_8h-source.html#l00113">113</a> of file <a class="el" href="water__pool__manager_8h-source.html">water_pool_manager.h</a>. </td> + </tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a7" doxytag="NL3D::CWaterPoolManager::~CWaterPoolManager"></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"> NL3D::CWaterPoolManager::~CWaterPoolManager </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> + +<p> +Definition at line <a class="el" href="water__pool__manager_8h-source.html#l00092">92</a> of file <a class="el" href="water__pool__manager_8h-source.html">water_pool_manager.h</a>. +<p> +References <a class="el" href="water__pool__manager_8cpp-source.html#l00123">reset</a>. </td> + </tr> +</table> +<a name="c0" doxytag="NL3D::CWaterPoolManager::CWaterPoolManager"></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"> NL3D::CWaterPoolManager::CWaterPoolManager </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, private]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="water__pool__manager_8h-source.html#l00105">105</a> of file <a class="el" href="water__pool__manager_8h-source.html">water_pool_manager.h</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a0" doxytag="NL3D::CWaterPoolManager::createWaterPool"></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="classNL3D_1_1CWaterHeightMap.html">CWaterHeightMap</a> * NL3D::CWaterPoolManager::createWaterPool </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html">CWaterHeightMapBuild</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>params</em> = <a class="el" href="structNL3D_1_1CWaterPoolManager_1_1CWaterHeightMapBuild.html">CWaterHeightMapBuild</a>() </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> +create a water pool with the given id and the given parameters. If the pool existed before, its parameter are reset. +<p> + +<p> +Definition at line <a class="el" href="water__pool__manager_8cpp-source.html#l00093">93</a> of file <a class="el" href="water__pool__manager_8cpp-source.html">water_pool_manager.cpp</a>. +<p> +References <a class="el" href="water__pool__manager_8h-source.html#l00107">_PoolMap</a>, and <a class="el" href="driver__opengl__extension__def_8h-source.html#l00220">params</a>. +<p> +Referenced by <a class="el" href="water__pool__manager_8cpp-source.html#l00109">getPoolByID</a>. </td> + </tr> +</table> +<a name="a4" doxytag="NL3D::CWaterPoolManager::getNumPools"></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#a15">uint</a> NL3D::CWaterPoolManager::getNumPools </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> +Get the number of pools. +<p> + +<p> +Definition at line <a class="el" href="water__pool__manager_8cpp-source.html#l00178">178</a> of file <a class="el" href="water__pool__manager_8cpp-source.html">water_pool_manager.cpp</a>. +<p> +References <a class="el" href="water__pool__manager_8h-source.html#l00107">_PoolMap</a>. +<p> +Referenced by <a class="el" href="water__pool__manager_8cpp-source.html#l00185">getPoolID</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NL3D::CWaterPoolManager::getPoolByID"></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="classNL3D_1_1CWaterHeightMap.html">CWaterHeightMap</a> & NL3D::CWaterPoolManager::getPoolByID </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a11">uint32</a> </td> + <td class="mdname1" valign="top" nowrap> <em>ID</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> +Get a water pool by its ID. If the ID doesn't exist, a new pool is created with default parameters. +<p> + +<p> +Definition at line <a class="el" href="water__pool__manager_8cpp-source.html#l00109">109</a> of file <a class="el" href="water__pool__manager_8cpp-source.html">water_pool_manager.cpp</a>. +<p> +References <a class="el" href="water__pool__manager_8h-source.html#l00107">_PoolMap</a>, and <a class="el" href="water__pool__manager_8cpp-source.html#l00093">createWaterPool</a>. </td> + </tr> +</table> +<a name="a5" doxytag="NL3D::CWaterPoolManager::getPoolID"></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#a15">uint</a> NL3D::CWaterPoolManager::getPoolID </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a15">uint</a> </td> + <td class="mdname1" valign="top" nowrap> <em>i</em> </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> +get the id of the i-th pool (O(n) lookup). +<p> + +<p> +Definition at line <a class="el" href="water__pool__manager_8cpp-source.html#l00185">185</a> of file <a class="el" href="water__pool__manager_8cpp-source.html">water_pool_manager.cpp</a>. +<p> +References <a class="el" href="water__pool__manager_8h-source.html#l00107">_PoolMap</a>, <a class="el" href="water__pool__manager_8cpp-source.html#l00178">getNumPools</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NL3D::CWaterPoolManager::hasPool"></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 NL3D::CWaterPoolManager::hasPool </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a11">uint32</a> </td> + <td class="mdname1" valign="top" nowrap> <em>ID</em> </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> +test wether a pool of the given ID exists. +<p> + +<p> +Definition at line <a class="el" href="water__pool__manager_8cpp-source.html#l00086">86</a> of file <a class="el" href="water__pool__manager_8cpp-source.html">water_pool_manager.cpp</a>. +<p> +References <a class="el" href="water__pool__manager_8h-source.html#l00107">_PoolMap</a>. +<p> +Referenced by <a class="el" href="water__pool__manager_8cpp-source.html#l00195">removePool</a>. </td> + </tr> +</table> +<a name="c3" doxytag="NL3D::CWaterPoolManager::isWaterShapeObserver"></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 NL3D::CWaterPoolManager::isWaterShapeObserver </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNL3D_1_1CWaterShape.html">CWaterShape</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>shape</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [private]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="water__pool__manager_8cpp-source.html#l00171">171</a> of file <a class="el" href="water__pool__manager_8cpp-source.html">water_pool_manager.cpp</a>. +<p> +References <a class="el" href="water__pool__manager_8h-source.html#l00114">_WaterShapes</a>. </td> + </tr> +</table> +<a name="c1" doxytag="NL3D::CWaterPoolManager::registerWaterShape"></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 NL3D::CWaterPoolManager::registerWaterShape </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNL3D_1_1CWaterShape.html">CWaterShape</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>shape</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [private]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +register a water height map. The water height map will be notified when a setBlend is applied. +<p> + +<p> +Definition at line <a class="el" href="water__pool__manager_8cpp-source.html#l00134">134</a> of file <a class="el" href="water__pool__manager_8cpp-source.html">water_pool_manager.cpp</a>. +<p> +References <a class="el" href="water__pool__manager_8h-source.html#l00114">_WaterShapes</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NL3D::CWaterPoolManager::removePool"></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 NL3D::CWaterPoolManager::removePool </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a11">uint32</a> </td> + <td class="mdname1" valign="top" nowrap> <em>ID</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> +remove the pool of the given ID. +<p> + +<p> +Definition at line <a class="el" href="water__pool__manager_8cpp-source.html#l00195">195</a> of file <a class="el" href="water__pool__manager_8cpp-source.html">water_pool_manager.cpp</a>. +<p> +References <a class="el" href="water__pool__manager_8h-source.html#l00107">_PoolMap</a>, <a class="el" href="water__pool__manager_8cpp-source.html#l00086">hasPool</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. </td> + </tr> +</table> +<a name="a6" doxytag="NL3D::CWaterPoolManager::reset"></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 NL3D::CWaterPoolManager::reset </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> +delete all heightmaps. +<p> + +<p> +Definition at line <a class="el" href="water__pool__manager_8cpp-source.html#l00123">123</a> of file <a class="el" href="water__pool__manager_8cpp-source.html">water_pool_manager.cpp</a>. +<p> +References <a class="el" href="water__pool__manager_8h-source.html#l00107">_PoolMap</a>. +<p> +Referenced by <a class="el" href="water__pool__manager_8h-source.html#l00092">~CWaterPoolManager</a>. </td> + </tr> +</table> +<a name="a9" doxytag="NL3D::CWaterPoolManager::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 NL3D::CWaterPoolManager::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>f</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> throw (<a class="el" href="structNLMISC_1_1EStream.html">NLMISC::EStream</a>)</td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +serial the pools data's. +<p> + +<p> +Definition at line <a class="el" href="water__pool__manager_8cpp-source.html#l00204">204</a> of file <a class="el" href="water__pool__manager_8cpp-source.html">water_pool_manager.cpp</a>. +<p> +References <a class="el" href="driver__opengl__extension__def_8h-source.html#l00218">id</a>. </td> + </tr> +</table> +<a name="a8" doxytag="NL3D::CWaterPoolManager::setBlendFactor"></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 NL3D::CWaterPoolManager::setBlendFactor </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNL3D_1_1IDriver.html">IDriver</a> * </td> + <td class="mdname" nowrap> <em>drv</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>factor</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set a blend factor for all pool (more precisely, all models based on a water shape) that have a blend texture for their envmap (to have cycle between night and day for example). +<p> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>factor</em> </td><td> +The blend factor which range from 0 to 1 </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="water__pool__manager_8cpp-source.html#l00152">152</a> of file <a class="el" href="water__pool__manager_8cpp-source.html">water_pool_manager.cpp</a>. +<p> +References <a class="el" href="water__pool__manager_8h-source.html#l00114">_WaterShapes</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. </td> + </tr> +</table> +<a name="c2" doxytag="NL3D::CWaterPoolManager::unRegisterWaterShape"></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 NL3D::CWaterPoolManager::unRegisterWaterShape </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNL3D_1_1CWaterShape.html">CWaterShape</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>shape</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [private]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="water__pool__manager_8cpp-source.html#l00142">142</a> of file <a class="el" href="water__pool__manager_8cpp-source.html">water_pool_manager.cpp</a>. +<p> +References <a class="el" href="water__pool__manager_8h-source.html#l00114">_WaterShapes</a>. </td> + </tr> +</table> +<hr><h2>Friends And Related Function Documentation</h2> +<a name="l0" doxytag="NL3D::CWaterPoolManager::CWaterShape"></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"> friend class CWaterShape<code> [friend]</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="water__pool__manager_8h-source.html#l00103">103</a> of file <a class="el" href="water__pool__manager_8h-source.html">water_pool_manager.h</a>. </td> + </tr> +</table> +<a name="l1" doxytag="NL3D::CWaterPoolManager::GetWaterPoolManager"></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"> CWaterPoolManager& GetWaterPoolManager </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> [friend]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="water__pool__manager_8cpp-source.html#l00078">78</a> of file <a class="el" href="water__pool__manager_8cpp-source.html">water_pool_manager.cpp</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="o0" doxytag="NL3D::CWaterPoolManager::_PoolMap"></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="classNL3D_1_1CWaterPoolManager.html#u0">TPoolMap</a> NL3D::CWaterPoolManager::_PoolMap<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="water__pool__manager_8h-source.html#l00107">107</a> of file <a class="el" href="water__pool__manager_8h-source.html">water_pool_manager.h</a>. +<p> +Referenced by <a class="el" href="water__pool__manager_8cpp-source.html#l00093">createWaterPool</a>, <a class="el" href="water__pool__manager_8cpp-source.html#l00178">getNumPools</a>, <a class="el" href="water__pool__manager_8cpp-source.html#l00109">getPoolByID</a>, <a class="el" href="water__pool__manager_8cpp-source.html#l00185">getPoolID</a>, <a class="el" href="water__pool__manager_8cpp-source.html#l00086">hasPool</a>, <a class="el" href="water__pool__manager_8cpp-source.html#l00195">removePool</a>, and <a class="el" href="water__pool__manager_8cpp-source.html#l00123">reset</a>. </td> + </tr> +</table> +<a name="o1" doxytag="NL3D::CWaterPoolManager::_WaterShapes"></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="classNL3D_1_1CWaterPoolManager.html#u1">TWaterShapeVect</a> NL3D::CWaterPoolManager::_WaterShapes<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="water__pool__manager_8h-source.html#l00114">114</a> of file <a class="el" href="water__pool__manager_8h-source.html">water_pool_manager.h</a>. +<p> +Referenced by <a class="el" href="water__pool__manager_8cpp-source.html#l00171">isWaterShapeObserver</a>, <a class="el" href="water__pool__manager_8cpp-source.html#l00134">registerWaterShape</a>, <a class="el" href="water__pool__manager_8cpp-source.html#l00152">setBlendFactor</a>, and <a class="el" href="water__pool__manager_8cpp-source.html#l00142">unRegisterWaterShape</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="water__pool__manager_8h-source.html">water_pool_manager.h</a><li><a class="el" href="water__pool__manager_8cpp-source.html">water_pool_manager.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> |