diff options
Diffstat (limited to 'docs/doxygen/nel/classNL3D_1_1CWaterInstanceUser.html')
| -rw-r--r-- | docs/doxygen/nel/classNL3D_1_1CWaterInstanceUser.html | 311 |
1 files changed, 311 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNL3D_1_1CWaterInstanceUser.html b/docs/doxygen/nel/classNL3D_1_1CWaterInstanceUser.html new file mode 100644 index 00000000..249b529d --- /dev/null +++ b/docs/doxygen/nel/classNL3D_1_1CWaterInstanceUser.html @@ -0,0 +1,311 @@ +<!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::CWaterInstanceUser Class Reference</h1>implementation of <a class="el" href="classNL3D_1_1UWaterInstance.html">UWaterInstance</a> methods. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="water__user_8h-source.html">water_user.h</a>></code> +<p> +<p>Inheritance diagram for NL3D::CWaterInstanceUser: +<p><center><img src="classNL3D_1_1CWaterInstanceUser.gif" usemap="#NL3D::CWaterInstanceUser_map" border="0"></center> +<map name="NL3D::CWaterInstanceUser_map"> +<area href="classNL3D_1_1CInstanceUser.html" alt="NL3D::CInstanceUser" shape="rect" coords="132,168,298,192"> +<area href="classNL3D_1_1UWaterInstance.html" alt="NL3D::UWaterInstance" shape="rect" coords="308,168,474,192"> +<area href="classNL3D_1_1UInstance.html" alt="NL3D::UInstance" shape="rect" coords="0,112,166,136"> +<area href="classNL3D_1_1CTransformUser.html" alt="NL3D::CTransformUser" shape="rect" coords="264,112,430,136"> +<area href="classNL3D_1_1UTransform.html" alt="NL3D::UTransform" shape="rect" coords="0,56,166,80"> +<area href="classNL3D_1_1UTransform.html" alt="NL3D::UTransform" shape="rect" coords="176,56,342,80"> +<area href="classNL3D_1_1CTransformableUser.html" alt="NL3D::CTransformableUser" shape="rect" coords="352,56,518,80"> +<area href="classNL3D_1_1UTransformable.html" alt="NL3D::UTransformable" shape="rect" coords="0,0,166,24"> +<area href="classNL3D_1_1UTransformable.html" alt="NL3D::UTransformable" shape="rect" coords="176,0,342,24"> +<area href="classNL3D_1_1UTransformable.html" alt="NL3D::UTransformable" shape="rect" coords="352,0,518,24"> +</map> +<a href="classNL3D_1_1CWaterInstanceUser-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> </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterInstanceUser.html#a0">CWaterInstanceUser</a> (<a class="el" href="classNL3D_1_1CScene.html">CScene</a> *scene, <a class="el" href="classNL3D_1_1IModel.html">IModel</a> *trans)</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="memory__common_8h.html#a11">uint32</a> </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterInstanceUser.html#a1">getWaterHeightMapID</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the ID of the water height map attached with this surface of water.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterInstanceUser.html#a2">getHeightFactor</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>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.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterInstanceUser.html#a3">getHeight</a> (const <a class="el" href="classNLMISC_1_1CVector2f.html">NLMISC::CVector2f</a> &pos)</td></tr> +<tr><td> </td><td><font size=-1><em>Get the height of the water in world space at the given location.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classNL3D_1_1CWaterInstanceUser.html#a4">getAttenuatedHeight</a> (const <a class="el" href="classNLMISC_1_1CVector2f.html">NLMISC::CVector2f</a> &pos, const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &viewer)</td></tr> +<tr><td> </td><td><font size=-1><em>Get the attenuated height of the water in world space at the given location.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +implementation of <a class="el" href="classNL3D_1_1UWaterInstance.html">UWaterInstance</a> methods. +<p> + +<p> +Definition at line <a class="el" href="water__user_8h-source.html#l00036">36</a> of file <a class="el" href="water__user_8h-source.html">water_user.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NL3D::CWaterInstanceUser::CWaterInstanceUser"></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::CWaterInstanceUser::CWaterInstanceUser </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNL3D_1_1CScene.html">CScene</a> * </td> + <td class="mdname" nowrap> <em>scene</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="classNL3D_1_1IModel.html">IModel</a> * </td> + <td class="mdname" nowrap> <em>trans</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><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__user_8h-source.html#l00039">39</a> of file <a class="el" href="water__user_8h-source.html">water_user.h</a>. +<p> +References <a class="el" href="instance__user_8cpp-source.html#l00041">NL3D::CInstanceUser::CInstanceUser</a>, and <a class="el" href="water__user_8h-source.html#l00029">NL3D_MEM_WATER</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a4" doxytag="NL3D::CWaterInstanceUser::getAttenuatedHeight"></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"> float NL3D::CWaterInstanceUser::getAttenuatedHeight </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector2f.html">NLMISC::CVector2f</a> & </td> + <td class="mdname" nowrap> <em>pos</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const <a class="el" href="classNLMISC_1_1CVector.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> [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. +<p> +You must provide the viewer position This is useful if you want to compute the position of a floating object +<p> +Implements <a class="el" href="classNL3D_1_1UWaterInstance.html#a3">NL3D::UWaterInstance</a>. +<p> +Definition at line <a class="el" href="water__user_8cpp-source.html#l00082">82</a> of file <a class="el" href="water__user_8cpp-source.html">water_user.cpp</a>. +<p> +References <a class="el" href="water__user_8h-source.html#l00029">NL3D_MEM_WATER</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NL3D::CWaterInstanceUser::getHeight"></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"> float NL3D::CWaterInstanceUser::getHeight </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector2f.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> [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> +Implements <a class="el" href="classNL3D_1_1UWaterInstance.html#a2">NL3D::UWaterInstance</a>. +<p> +Definition at line <a class="el" href="water__user_8cpp-source.html#l00074">74</a> of file <a class="el" href="water__user_8cpp-source.html">water_user.cpp</a>. +<p> +References <a class="el" href="water__user_8h-source.html#l00029">NL3D_MEM_WATER</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NL3D::CWaterInstanceUser::getHeightFactor"></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"> float NL3D::CWaterInstanceUser::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> [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. +<p> +This returns this factor +<p> +Implements <a class="el" href="classNL3D_1_1UWaterInstance.html#a1">NL3D::UWaterInstance</a>. +<p> +Definition at line <a class="el" href="water__user_8cpp-source.html#l00066">66</a> of file <a class="el" href="water__user_8cpp-source.html">water_user.cpp</a>. +<p> +References <a class="el" href="water__user_8h-source.html#l00029">NL3D_MEM_WATER</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NL3D::CWaterInstanceUser::getWaterHeightMapID"></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#a11">uint32</a> NL3D::CWaterInstanceUser::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> [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. +<p> +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> +Implements <a class="el" href="classNL3D_1_1UWaterInstance.html#a0">NL3D::UWaterInstance</a>. +<p> +Definition at line <a class="el" href="water__user_8cpp-source.html#l00057">57</a> of file <a class="el" href="water__user_8cpp-source.html">water_user.cpp</a>. +<p> +References <a class="el" href="water__user_8h-source.html#l00029">NL3D_MEM_WATER</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="water__user_8h-source.html">water_user.h</a><li><a class="el" href="water__user_8cpp-source.html">water_user.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> |