Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > 96617cbbea5434e5cff4ccd67437c037 > files > 137

mercator-devel-0.2.7-3.fc12.i686.rpm

<!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::TerrainMod 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><b>Mercator</b>::<a class="el" href="classMercator_1_1TerrainMod.html">TerrainMod</a>
  </div>
</div>
<div class="contents">
<h1>Mercator::TerrainMod Class Reference</h1><!-- doxytag: class="Mercator::TerrainMod" -->Base class for modifiers to the procedurally generated terrain.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="TerrainMod_8h_source.html">TerrainMod.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for Mercator::TerrainMod:</div>
<div class="dynsection">

<p><center><img src="classMercator_1_1TerrainMod.png" usemap="#Mercator::TerrainMod_map" border="0" alt=""></center>
<map name="Mercator::TerrainMod_map">
<area href="classMercator_1_1CraterTerrainMod.html" alt="Mercator::CraterTerrainMod" shape="rect" coords="0,56,232,80">
<area href="classMercator_1_1ShapeTerrainMod.html" alt="Mercator::ShapeTerrainMod< Shape >" shape="rect" coords="242,56,474,80">
<area href="classMercator_1_1ShapeTerrainMod.html" alt="Mercator::ShapeTerrainMod< Shape >" shape="rect" coords="484,56,716,80">
<area href="classMercator_1_1AdjustTerrainMod.html" alt="Mercator::AdjustTerrainMod< Shape >" shape="rect" coords="242,112,474,136">
<area href="classMercator_1_1LevelTerrainMod.html" alt="Mercator::LevelTerrainMod< Shape >" shape="rect" coords="484,112,716,136">
<area href="classMercator_1_1SlopeTerrainMod.html" alt="Mercator::SlopeTerrainMod< Shape >" shape="rect" coords="726,112,958,136">
</map>
</div>

<p>
<a href="classMercator_1_1TerrainMod-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">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1TerrainMod.html#89b94b74a24df696460e4a8b9bc06fe9">apply</a> (float &amp;point, int x, int y) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Apply this modifier on a terrain segment.  <a href="#89b94b74a24df696460e4a8b9bc06fe9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e06969bb6863ee497cf58fd3b2f277c0"></a><!-- doxytag: member="Mercator::TerrainMod::bbox" ref="e06969bb6863ee497cf58fd3b2f277c0" args="() const =0" -->
virtual WFMath::AxisBox&lt; 2 &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1TerrainMod.html#e06969bb6863ee497cf58fd3b2f277c0">bbox</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the boundingbox of the modifier. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a5708a72384c888c6924bbf77363887"></a><!-- doxytag: member="Mercator::TerrainMod::clone" ref="2a5708a72384c888c6924bbf77363887" args="() const =0" -->
virtual <a class="el" href="classMercator_1_1TerrainMod.html">TerrainMod</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1TerrainMod.html#2a5708a72384c888c6924bbf77363887">clone</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a copy of this modifier. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for modifiers to the procedurally generated terrain. 
<p>
Anything that modifies the terrain implements this interface. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="89b94b74a24df696460e4a8b9bc06fe9"></a><!-- doxytag: member="Mercator::TerrainMod::apply" ref="89b94b74a24df696460e4a8b9bc06fe9" args="(float &amp;point, int x, int y) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void Mercator::TerrainMod::apply           </td>
          <td>(</td>
          <td class="paramtype">float &amp;&nbsp;</td>
          <td class="paramname"> <em>point</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Apply this modifier on a terrain segment. 
<p>
The segment is at x,y in local coordinates. Output is placed into point. 
<p>Implemented in <a class="el" href="classMercator_1_1LevelTerrainMod.html#7e3eda235fa6b99f5115a4c34cae7072">Mercator::LevelTerrainMod&lt; Shape &gt;</a>, <a class="el" href="classMercator_1_1AdjustTerrainMod.html#3c41c52f0978f526b3d33465a3bf2b49">Mercator::AdjustTerrainMod&lt; Shape &gt;</a>, <a class="el" href="classMercator_1_1SlopeTerrainMod.html#4d7909ab5bb4e8e22a2c94802e71a131">Mercator::SlopeTerrainMod&lt; Shape &gt;</a>, and <a class="el" href="classMercator_1_1CraterTerrainMod.html#ca2a508b943e2009ae1b4285d6af4024">Mercator::CraterTerrainMod</a>.</p>

<p>Referenced by <a class="el" href="Segment_8cpp_source.html#l00623">Mercator::Segment::applyMod()</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="TerrainMod_8h_source.html">TerrainMod.h</a><li>TerrainMod.cpp</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated for Mercator by&nbsp;
<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>