diff options
Diffstat (limited to 'Doc/doxygen/html/class_water.html')
| -rw-r--r-- | Doc/doxygen/html/class_water.html | 478 |
1 files changed, 478 insertions, 0 deletions
diff --git a/Doc/doxygen/html/class_water.html b/Doc/doxygen/html/class_water.html new file mode 100644 index 0000000..bc150d2 --- /dev/null +++ b/Doc/doxygen/html/class_water.html @@ -0,0 +1,478 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<title>Starshatter_Open: Water Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">Starshatter_Open + </div> + <div id="projectbrief">Open source Starshatter engine</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('class_water.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pro-attribs">Protected Attributes</a> </div> + <div class="headertitle"> +<div class="title">Water Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_water_8h_source.html">Water.h</a>></code></p> + +<p><a href="class_water-members.html">List of all members.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a32d8f391b149a405008a606ceafa35ee"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_water.html#a32d8f391b149a405008a606ceafa35ee">Water</a> ()</td></tr> +<tr class="memitem:aa613ad181694d2d0e18059f3822415fe"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_water.html#aa613ad181694d2d0e18059f3822415fe">~Water</a> ()</td></tr> +<tr class="memitem:a6e531eb81a5b3da30ddb3894cd7bffff"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_water.html#a6e531eb81a5b3da30ddb3894cd7bffff">Init</a> (int nVerts, float <a class="el" href="class_water.html#aa5c8ea6ab0eb7aceb3921b00c697d164">size</a>, float <a class="el" href="class_water.html#a0a82cd0c3c66db6a4505393d8a7ebee2">depth</a>)</td></tr> +<tr class="memitem:a2afc107caf58cec0f159ee6391dcbb2c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_water.html#a2afc107caf58cec0f159ee6391dcbb2c">CalcWaves</a> (double seconds)</td></tr> +<tr class="memitem:a672dd845027506dca4be724cc910945b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_water.html#a672dd845027506dca4be724cc910945b">UpdateSurface</a> (<a class="el" href="struct_vec3.html">Vec3</a> &eyePos, <a class="el" href="struct_vertex_set.html">VertexSet</a> *vset)</td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2><a name="pro-attribs"></a> +Protected Attributes</h2></td></tr> +<tr class="memitem:aa5c8ea6ab0eb7aceb3921b00c697d164"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_water.html#aa5c8ea6ab0eb7aceb3921b00c697d164">size</a></td></tr> +<tr class="memitem:a0a82cd0c3c66db6a4505393d8a7ebee2"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_water.html#a0a82cd0c3c66db6a4505393d8a7ebee2">depth</a></td></tr> +<tr class="memitem:a444962cc6bd34faaead95baa60cdca0f"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_water.html#a444962cc6bd34faaead95baa60cdca0f">scaleTex</a></td></tr> +<tr class="memitem:aee72ce68073e8cb18c991439df103920"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_water.html#aee72ce68073e8cb18c991439df103920">avgHeight</a></td></tr> +<tr class="memitem:af9d66580b11adb2a54bb59a5c7183c19"><td class="memItemLeft" align="right" valign="top">DWORD </td><td class="memItemRight" valign="bottom"><a class="el" href="class_water.html#af9d66580b11adb2a54bb59a5c7183c19">nVertices</a></td></tr> +<tr class="memitem:a52fb75c11e2e4f1699413fd2d59fc139"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_w_a_t_e_r___s_u_r_f_a_c_e.html">WATER_SURFACE</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_water.html#a52fb75c11e2e4f1699413fd2d59fc139">surface</a></td></tr> +<tr class="memitem:aa28439cf1f0e9bc26e2a2bf95eeea9f7"><td class="memItemLeft" align="right" valign="top">float * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_water.html#aa28439cf1f0e9bc26e2a2bf95eeea9f7">waves</a></td></tr> +<tr class="memitem:a4be45cd6612d64b4a365505ac80ac3d8"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_water.html#a4be45cd6612d64b4a365505ac80ac3d8">offsets</a> [16]</td></tr> +</table> +<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> +<div class="textblock"> +<p>Definition at line <a class="el" href="_water_8h_source.html#l00028">28</a> of file <a class="el" href="_water_8h_source.html">Water.h</a>.</p> +</div><hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="a32d8f391b149a405008a606ceafa35ee"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Water::Water </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="_water_8cpp_source.html#l00068">68</a> of file <a class="el" href="_water_8cpp_source.html">Water.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="aa613ad181694d2d0e18059f3822415fe"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">Water::~Water </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="_water_8cpp_source.html#l00074">74</a> of file <a class="el" href="_water_8cpp_source.html">Water.cpp</a>.</p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a2afc107caf58cec0f159ee6391dcbb2c"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void Water::CalcWaves </td> + <td>(</td> + <td class="paramtype">double </td> + <td class="paramname"><em>seconds</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="_water_8cpp_source.html#l00153">153</a> of file <a class="el" href="_water_8cpp_source.html">Water.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a6e531eb81a5b3da30ddb3894cd7bffff"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void Water::Init </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>nVerts</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"><em>size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"><em>depth</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="_water_8cpp_source.html#l00083">83</a> of file <a class="el" href="_water_8cpp_source.html">Water.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a672dd845027506dca4be724cc910945b"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void Water::UpdateSurface </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_vec3.html">Vec3</a> & </td> + <td class="paramname"><em>eyePos</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_vertex_set.html">VertexSet</a> * </td> + <td class="paramname"><em>vset</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="_water_8cpp_source.html#l00234">234</a> of file <a class="el" href="_water_8cpp_source.html">Water.cpp</a>.</p> + +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="aee72ce68073e8cb18c991439df103920"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">float Water::avgHeight</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="_water_8h_source.html#l00042">42</a> of file <a class="el" href="_water_8h_source.html">Water.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a0a82cd0c3c66db6a4505393d8a7ebee2"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">float Water::depth</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="_water_8h_source.html#l00040">40</a> of file <a class="el" href="_water_8h_source.html">Water.h</a>.</p> + +</div> +</div> +<a class="anchor" id="af9d66580b11adb2a54bb59a5c7183c19"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">DWORD Water::nVertices</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="_water_8h_source.html#l00044">44</a> of file <a class="el" href="_water_8h_source.html">Water.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a4be45cd6612d64b4a365505ac80ac3d8"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">float Water::offsets[16]</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="_water_8h_source.html#l00048">48</a> of file <a class="el" href="_water_8h_source.html">Water.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a444962cc6bd34faaead95baa60cdca0f"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">float Water::scaleTex</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="_water_8h_source.html#l00041">41</a> of file <a class="el" href="_water_8h_source.html">Water.h</a>.</p> + +</div> +</div> +<a class="anchor" id="aa5c8ea6ab0eb7aceb3921b00c697d164"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">float Water::size</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="_water_8h_source.html#l00039">39</a> of file <a class="el" href="_water_8h_source.html">Water.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a52fb75c11e2e4f1699413fd2d59fc139"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="struct_w_a_t_e_r___s_u_r_f_a_c_e.html">WATER_SURFACE</a>* Water::surface</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="_water_8h_source.html#l00046">46</a> of file <a class="el" href="_water_8h_source.html">Water.h</a>.</p> + +</div> +</div> +<a class="anchor" id="aa28439cf1f0e9bc26e2a2bf95eeea9f7"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">float* Water::waves</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="_water_8h_source.html#l00047">47</a> of file <a class="el" href="_water_8h_source.html">Water.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>D:/SRC/StarshatterSVN/nGenEx/<a class="el" href="_water_8h_source.html">Water.h</a></li> +<li>D:/SRC/StarshatterSVN/nGenEx/<a class="el" href="_water_8cpp_source.html">Water.cpp</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="class_water.html">Water</a></li> + <li class="footer">Generated on Tue Jun 5 2012 20:48:14 for Starshatter_Open by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1 </li> + </ul> +</div> +</body> +</html> |