diff options
| author | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
|---|---|---|
| committer | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
| commit | 0ea5fc66924303d1bf73ba283a383e2aadee02f2 (patch) | |
| tree | 2568e71a7ccc44ec23b8bb3f0ff97fb6bf2ed709 /docs/doxygen/nel/a03957.html | |
| download | nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.tar.xz nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.zip | |
Initial commit
Diffstat (limited to 'docs/doxygen/nel/a03957.html')
| -rw-r--r-- | docs/doxygen/nel/a03957.html | 179 |
1 files changed, 179 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03957.html b/docs/doxygen/nel/a03957.html new file mode 100644 index 00000000..41a6dbb9 --- /dev/null +++ b/docs/doxygen/nel/a03957.html @@ -0,0 +1,179 @@ +<!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::UWaterInstance 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::UWaterInstance Class Reference</h1><code>#include <<a class="el" href="a06639.html">u_water.h</a>></code> +<p> +<p>Inheritance diagram for NL3D::UWaterInstance: +<p><center><img src="a03957.png" usemap="#NL3D::UWaterInstance_map" border="0" alt=""></center> +<map name="NL3D::UWaterInstance_map"> +<area href="a03720.html" alt="NL3D::CWaterInstanceUser" shape="rect" coords="0,56,165,80"> +<area href="a03721.html" alt="NL3D::CWaterModel" shape="rect" coords="175,56,340,80"> +</map> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Helps to get infos about a water model You can get this interface by using a dynamic_cast on a <a class="el" href="a03047.html">UInstance</a> that is a water instance <dl compact><dt><b>Author:</b></dt><dd>Nicolas Vizerie <p> +Nevrax France </dd></dl> +<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl> + +<p> + +<p> +Definition at line <a class="el" href="a06639.html#l00053">53</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="a03957.html#NL3D_1_1UWaterInstancea0">getAttenuatedHeight</a> (const <a class="el" href="a03660.html">NLMISC::CVector2f</a> &pos, const <a class="el" href="a03128.html">NLMISC::CVector</a> &viewer)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual float </td><td class="memItemRight" valign=bottom><a class="el" href="a03957.html#NL3D_1_1UWaterInstancea1">getHeight</a> (const <a class="el" href="a03660.html">NLMISC::CVector2f</a> &pos)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the height of the water in world space at the given location. <a href="#NL3D_1_1UWaterInstancea1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual float </td><td class="memItemRight" valign=bottom><a class="el" href="a03957.html#NL3D_1_1UWaterInstancea2">getHeightFactor</a> () const=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a11">uint32</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03957.html#NL3D_1_1UWaterInstancea3">getWaterHeightMapID</a> () const=0</td></tr> + +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NL3D_1_1UWaterInstancea0" doxytag="NL3D::UWaterInstance::getAttenuatedHeight" ></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::UWaterInstance::getAttenuatedHeight </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>const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname" nowrap> <em>viewer</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> +Get the attenuated height of the water in world space at the given location. You must provide the viewer position This is useful if you want to compute the position of a floating object +<p> +Implemented in <a class="el" href="a03721.html#NL3D_1_1CWaterModela7">NL3D::CWaterModel</a>, and <a class="el" href="a03720.html#NL3D_1_1CWaterInstanceUsera3">NL3D::CWaterInstanceUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1UWaterInstancea1" doxytag="NL3D::UWaterInstance::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::UWaterInstance::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 height of the water in world space at the given location. +<p> + +<p> +Implemented in <a class="el" href="a03721.html#NL3D_1_1CWaterModela13">NL3D::CWaterModel</a>, and <a class="el" href="a03720.html#NL3D_1_1CWaterInstanceUsera8">NL3D::CWaterInstanceUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1UWaterInstancea2" doxytag="NL3D::UWaterInstance::getHeightFactor" ></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::UWaterInstance::getHeightFactor </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> +When displaying the water height field, the value in the height field is actually multiplied by a factor to get the height in world space. This returns this factor +<p> +Implemented in <a class="el" href="a03721.html#NL3D_1_1CWaterModela14">NL3D::CWaterModel</a>, and <a class="el" href="a03720.html#NL3D_1_1CWaterInstanceUsera9">NL3D::CWaterInstanceUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1UWaterInstancea3" doxytag="NL3D::UWaterInstance::getWaterHeightMapID" ></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 <a class="el" href="a04558.html#a11">uint32</a> NL3D::UWaterInstance::getWaterHeightMapID </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 ID of the water height map attached with this surface of water. Once you got it, you can get an interface on it from the water height map manager. NB : a water height map is usually shared between several wtare instances +<p> +Implemented in <a class="el" href="a03721.html#NL3D_1_1CWaterModela28">NL3D::CWaterModel</a>, and <a class="el" href="a03720.html#NL3D_1_1CWaterInstanceUsera23">NL3D::CWaterInstanceUser</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:36 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> |