diff options
Diffstat (limited to 'docs/doxygen/nel/a03956.html')
| -rw-r--r-- | docs/doxygen/nel/a03956.html | 163 |
1 files changed, 163 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03956.html b/docs/doxygen/nel/a03956.html new file mode 100644 index 00000000..efe0da0d --- /dev/null +++ b/docs/doxygen/nel/a03956.html @@ -0,0 +1,163 @@ +<!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: NL3D::UWaterHeightMapManager 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 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">Data Structures</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">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NL3D::UWaterHeightMapManager Class Reference</h1><code>#include <<a class="el" href="a06639.html">u_water.h</a>></code> +<p> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Interface to the water height map manager. +<p> + +<p> +Definition at line <a class="el" href="a06639.html#l00080">80</a> of file <a class="el" href="a06639.html">u_water.h</a>.<table border=0 cellpadding=0 cellspacing=0> +<tr><td></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="a03955.html">UWaterHeightMap</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="a03956.html#NL3D_1_1UWaterHeightMapManagere0">getWaterHeightMapFromID</a> (<a class="el" href="a04558.html#a11">uint32</a> ID)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a water heightmap from its ID. An assertion is raised if a wrong ID is provided. <a href="#NL3D_1_1UWaterHeightMapManagere0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03956.html#NL3D_1_1UWaterHeightMapManagere1">releaseBlendTextures</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03956.html#NL3D_1_1UWaterHeightMapManagere2">setBlendFactor</a> (<a class="el" href="a02438.html">UDriver</a> *driver, float <a class="el" href="a04223.html#a658">value</a>)</td></tr> + +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NL3D_1_1UWaterHeightMapManagere0" doxytag="NL3D::UWaterHeightMapManager::getWaterHeightMapFromID" ></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="a03955.html">UWaterHeightMap</a> & NL3D::UWaterHeightMapManager::getWaterHeightMapFromID </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a04558.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><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Retrieve a water heightmap from its ID. An assertion is raised if a wrong ID is provided. +<p> + +<p> +Definition at line <a class="el" href="a06743.html#l00040">40</a> of file <a class="el" href="a06743.html">water_user.cpp</a>. +<p> +References <a class="el" href="a06739.html#l00109">NL3D::CWaterPoolManager::getPoolByID()</a>, <a class="el" href="a06739.html#l00078">NL3D::GetWaterPoolManager()</a>, <a class="el" href="a06744.html#l00029">NL3D_MEM_WATER</a>, <a class="el" href="a05622.html#l00290">nlassert</a>, and <a class="el" href="a05981.html#l00100">uint32</a>. +<p> +<div class="fragment"><pre>00041 { +00042 <a class="code" href="a05321.html#a0">NL3D_MEM_WATER</a> +00043 <a class="code" href="a04199.html#a6">nlassert</a>(<a class="code" href="a05363.html#a551">GetWaterPoolManager</a>().hasPool(ID)); <span class="comment">// unknown pool ID!</span> +00044 <span class="keywordflow">return</span> <a class="code" href="a05363.html#a551">GetWaterPoolManager</a>().getPoolByID(ID); +00045 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1UWaterHeightMapManagere1" doxytag="NL3D::UWaterHeightMapManager::releaseBlendTextures" ></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 NL3D::UWaterHeightMapManager::releaseBlendTextures </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> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +release blend textures from memory +<p> +Definition at line <a class="el" href="a06743.html#l00057">57</a> of file <a class="el" href="a06743.html">water_user.cpp</a>. +<p> +References <a class="el" href="a06739.html#l00078">NL3D::GetWaterPoolManager()</a>, and <a class="el" href="a06739.html#l00171">NL3D::CWaterPoolManager::releaseBlendTextures()</a>. +<p> +<div class="fragment"><pre>00058 { +00059 <a class="code" href="a05363.html#a551">GetWaterPoolManager</a>().releaseBlendTextures(); +00060 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1UWaterHeightMapManagere2" doxytag="NL3D::UWaterHeightMapManager::setBlendFactor" ></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 NL3D::UWaterHeightMapManager::setBlendFactor </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02438.html">UDriver</a> * </td> + <td class="mdname" nowrap> <em>driver</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Blend factor for water surfaces that use <a class="el" href="a03488.html">CTextureBlend</a> (day / night mgt for example) The blend factor if clamped to [0, 1] NB : when transition has finished, one should call releaseBlendTexture to eventually release textures from system memory +<p> +Definition at line <a class="el" href="a06743.html#l00049">49</a> of file <a class="el" href="a06743.html">water_user.cpp</a>. +<p> +References <a class="el" href="a05587.html#l00115">NLMISC::clamp()</a>, <a class="el" href="a06739.html#l00078">NL3D::GetWaterPoolManager()</a>, <a class="el" href="a06744.html#l00029">NL3D_MEM_WATER</a>, <a class="el" href="a06739.html#l00152">NL3D::CWaterPoolManager::setBlendFactor()</a>, and <a class="el" href="a05646.html#l01132">value</a>. +<p> +<div class="fragment"><pre>00050 { +00051 <a class="code" href="a05321.html#a0">NL3D_MEM_WATER</a> +00052 <a class="code" href="a05378.html#a374">NLMISC::clamp</a>(value, 0.f, 1.f); +00053 <a class="code" href="a05363.html#a551">GetWaterPoolManager</a>().setBlendFactor(NLMISC::safe_cast<CDriverUser *>(drv)->getDriver(), value); +00054 } +</pre></div> </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="a06639.html">u_water.h</a><li><a class="el" href="a06743.html">water_user.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 08:53:34 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> |