<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Mercator: Mercator::BasePoint Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</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 class="navpath"><b>Mercator</b>::<a class="el" href="classMercator_1_1BasePoint.html">BasePoint</a>
</div>
</div>
<div class="contents">
<h1>Mercator::BasePoint Class Reference</h1><!-- doxytag: class="Mercator::BasePoint" -->Point on the fundamental grid that is used as the basis for terrain.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="BasePoint_8h_source.html">BasePoint.h</a>></code>
<p>
<p>
<a href="classMercator_1_1BasePoint-members.html">List of all members.</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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BasePoint.html#cb0738f587daed82d0eee6a9ccc3d98a">BasePoint</a> (float h=<a class="el" href="classMercator_1_1BasePoint.html#75ea29975e41decd1d28910c860b9c7c">HEIGHT</a>, float r=<a class="el" href="classMercator_1_1BasePoint.html#4cba8bcf0560a5dc44676d57b482b7d6">ROUGHNESS</a>, float f=<a class="el" href="classMercator_1_1BasePoint.html#c6fea8de72cf7f30d993e2a7b55cf603">FALLOFF</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#cb0738f587daed82d0eee6a9ccc3d98a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3f742e08daa4aa5d74480f582b708240"></a><!-- doxytag: member="Mercator::BasePoint::height" ref="3f742e08daa4aa5d74480f582b708240" args="() const " -->
const float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BasePoint.html#3f742e08daa4aa5d74480f582b708240">height</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the height at the base point. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fd06990a536cf5b7beb752aef72f64d4"></a><!-- doxytag: member="Mercator::BasePoint::height" ref="fd06990a536cf5b7beb752aef72f64d4" args="()" -->
float & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BasePoint.html#fd06990a536cf5b7beb752aef72f64d4">height</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the height at the base point. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8f2d0b4c91d0abedf6ccb17d7a3b3547"></a><!-- doxytag: member="Mercator::BasePoint::roughness" ref="8f2d0b4c91d0abedf6ccb17d7a3b3547" args="() const " -->
const float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BasePoint.html#8f2d0b4c91d0abedf6ccb17d7a3b3547">roughness</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the roughness at the base point. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="87074a8e4cd81cd53245ff63739836b9"></a><!-- doxytag: member="Mercator::BasePoint::roughness" ref="87074a8e4cd81cd53245ff63739836b9" args="()" -->
float & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BasePoint.html#87074a8e4cd81cd53245ff63739836b9">roughness</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the roughness at the base point. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1cd9349c213a54d4c11fa42278540aff"></a><!-- doxytag: member="Mercator::BasePoint::falloff" ref="1cd9349c213a54d4c11fa42278540aff" args="() const " -->
const float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BasePoint.html#1cd9349c213a54d4c11fa42278540aff">falloff</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the falloff at the base point. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d559546ddf37cad56b510089f88672e4"></a><!-- doxytag: member="Mercator::BasePoint::falloff" ref="d559546ddf37cad56b510089f88672e4" args="()" -->
float & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BasePoint.html#d559546ddf37cad56b510089f88672e4">falloff</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the falloff at the base point. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="479a70faeca80d1686a3fe273bf87507"></a><!-- doxytag: member="Mercator::BasePoint::seed" ref="479a70faeca80d1686a3fe273bf87507" args="() const " -->
unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BasePoint.html#479a70faeca80d1686a3fe273bf87507">seed</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calculate the random seed used at this base point. <br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="75ea29975e41decd1d28910c860b9c7c"></a><!-- doxytag: member="Mercator::BasePoint::HEIGHT" ref="75ea29975e41decd1d28910c860b9c7c" args="" -->
static const float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BasePoint.html#75ea29975e41decd1d28910c860b9c7c">HEIGHT</a> = 8.0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default height at the base point. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4cba8bcf0560a5dc44676d57b482b7d6"></a><!-- doxytag: member="Mercator::BasePoint::ROUGHNESS" ref="4cba8bcf0560a5dc44676d57b482b7d6" args="" -->
static const float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BasePoint.html#4cba8bcf0560a5dc44676d57b482b7d6">ROUGHNESS</a> = 1.25</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default roughness at the base point. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c6fea8de72cf7f30d993e2a7b55cf603"></a><!-- doxytag: member="Mercator::BasePoint::FALLOFF" ref="c6fea8de72cf7f30d993e2a7b55cf603" args="" -->
static const float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BasePoint.html#c6fea8de72cf7f30d993e2a7b55cf603">FALLOFF</a> = 0.25</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default falloff at the base point. <br></td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6d371a9676d73f928347be68da1f8488"></a><!-- doxytag: member="Mercator::BasePoint::m_height" ref="6d371a9676d73f928347be68da1f8488" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BasePoint.html#6d371a9676d73f928347be68da1f8488">m_height</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The height at the base point. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="351e22d1f6e0772e5a017680ebd3e313"></a><!-- doxytag: member="Mercator::BasePoint::m_roughness" ref="351e22d1f6e0772e5a017680ebd3e313" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BasePoint.html#351e22d1f6e0772e5a017680ebd3e313">m_roughness</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The roughness at the base point. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d5e4dd8cec302b2c5d9b4ae3e024a449"></a><!-- doxytag: member="Mercator::BasePoint::m_falloff" ref="d5e4dd8cec302b2c5d9b4ae3e024a449" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BasePoint.html#d5e4dd8cec302b2c5d9b4ae3e024a449">m_falloff</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The falloff at the base point. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Point on the fundamental grid that is used as the basis for terrain.
<p>
The terrain is defined by a sparse grid of evenly spaced points, each of which is defined by an instance of this class. The most fundamental property of each point is its elevation stored as height, as this is also used to seed the random number generators. Additional parameters for roughness and falloff are often specified. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="cb0738f587daed82d0eee6a9ccc3d98a"></a><!-- doxytag: member="Mercator::BasePoint::BasePoint" ref="cb0738f587daed82d0eee6a9ccc3d98a" args="(float h=HEIGHT, float r=ROUGHNESS, float f=FALLOFF)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Mercator::BasePoint::BasePoint </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>h</em> = <code><a class="el" href="classMercator_1_1BasePoint.html#75ea29975e41decd1d28910c860b9c7c">HEIGHT</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>r</em> = <code><a class="el" href="classMercator_1_1BasePoint.html#4cba8bcf0560a5dc44676d57b482b7d6">ROUGHNESS</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>f</em> = <code><a class="el" href="classMercator_1_1BasePoint.html#c6fea8de72cf7f30d993e2a7b55cf603">FALLOFF</a></code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>h</em> </td><td>height at the base point. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>r</em> </td><td>roughness at the base point. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>falloff at the base point. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="BasePoint_8h_source.html">BasePoint.h</a><li>BasePoint.cpp</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated for Mercator by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
