diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/a03955.html | 204 |
1 files changed, 204 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03955.html b/docs/doxygen/nel/a03955.html new file mode 100644 index 00000000..9c82e7e0 --- /dev/null +++ b/docs/doxygen/nel/a03955.html @@ -0,0 +1,204 @@ +<!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::UWaterHeightMap 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::UWaterHeightMap Class Reference</h1><code>#include <<a class="el" href="a06639.html">u_water.h</a>></code> +<p> +<p>Inheritance diagram for NL3D::UWaterHeightMap: +<p><center><img src="a03955.png" usemap="#NL3D::UWaterHeightMap_map" border="0" alt=""></center> +<map name="NL3D::UWaterHeightMap_map"> +<area href="a03719.html" alt="NL3D::CWaterHeightMap" shape="rect" coords="0,56,153,80"> +</map> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Interface to water height maps. +<p> + +<p> +Definition at line <a class="el" href="a06639.html#l00098">98</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>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual float </td><td class="memItemRight" valign=bottom><a class="el" href="a03955.html#NL3D_1_1UWaterHeightMapa0">getHeight</a> (const <a class="el" href="a03660.html">NLMISC::CVector2f</a> &pos)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual float </td><td class="memItemRight" valign=bottom><a class="el" href="a03955.html#NL3D_1_1UWaterHeightMapa1">getUnitSize</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">get the size in meter of a heightmap texel <a href="#NL3D_1_1UWaterHeightMapa1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03955.html#NL3D_1_1UWaterHeightMapa2">perturbate</a> (const <a class="el" href="a03660.html">NLMISC::CVector2f</a> &pos, float strenght, float radius)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03955.html#NL3D_1_1UWaterHeightMapa3">perturbatePoint</a> (const <a class="el" href="a03660.html">NLMISC::CVector2f</a> &pos, float strenght)=0</td></tr> + +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NL3D_1_1UWaterHeightMapa0" doxytag="NL3D::UWaterHeightMap::getHeight" ></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 float NL3D::UWaterHeightMap::getHeight </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03660.html">NLMISC::CVector2f</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>pos</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the value of the height map at the given location. To get the height in world coordinate, You should use getHeight +<p> +Implemented in <a class="el" href="a03719.html#NL3D_1_1CWaterHeightMapa8">NL3D::CWaterHeightMap</a>. </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1UWaterHeightMapa1" doxytag="NL3D::UWaterHeightMap::getUnitSize" ></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 float NL3D::UWaterHeightMap::getUnitSize </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<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +get the size in meter of a heightmap texel +<p> + +<p> +Implemented in <a class="el" href="a03719.html#NL3D_1_1CWaterHeightMapa14">NL3D::CWaterHeightMap</a>. </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1UWaterHeightMapa2" doxytag="NL3D::UWaterHeightMap::perturbate" ></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 void NL3D::UWaterHeightMap::perturbate </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03660.html">NLMISC::CVector2f</a> & </td> + <td class="mdname" nowrap> <em>pos</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>strenght</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>radius</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Apply a perturbation on this heightmap at the given location. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign=top><em>pos,The</em> </td><td>x and y coords of the perturbation. </td></tr> + <tr><td valign=top><em>strenght</em> </td><td>Strenght of the impulsion </td></tr> + <tr><td valign=top><em>radius</em> </td><td>Radius of the impulsion</td></tr> + </table> +</dl> + +<p> +Implemented in <a class="el" href="a03719.html#NL3D_1_1CWaterHeightMapa19">NL3D::CWaterHeightMap</a>. </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1UWaterHeightMapa3" doxytag="NL3D::UWaterHeightMap::perturbatePoint" ></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 void NL3D::UWaterHeightMap::perturbatePoint </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03660.html">NLMISC::CVector2f</a> & </td> + <td class="mdname" nowrap> <em>pos</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>strenght</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Apply a point perturbation on this heightmap at the given location. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign=top><em>pos,The</em> </td><td>x and y coords of the perturbation. </td></tr> + <tr><td valign=top><em>strenght</em> </td><td>Strenght of the impulsion</td></tr> + </table> +</dl> + +<p> +Implemented in <a class="el" href="a03719.html#NL3D_1_1CWaterHeightMapa21">NL3D::CWaterHeightMap</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="a06639.html">u_water.h</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 08:53:33 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> |