Sophie

Sophie

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

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::LevelTerrainMod&lt; Shape &gt; Class Template 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_1LevelTerrainMod.html">LevelTerrainMod</a>
  </div>
</div>
<div class="contents">
<h1>Mercator::LevelTerrainMod&lt; Shape &gt; Class Template Reference</h1><!-- doxytag: class="Mercator::LevelTerrainMod" --><!-- doxytag: inherits="ShapeTerrainMod&lt; Shape &gt;" --><a class="el" href="classMercator_1_1Terrain.html" title="Class storing centrally all data about an instance of some terrain.">Terrain</a> modifier that defines an area of fixed height.  
<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::LevelTerrainMod&lt; Shape &gt;:</div>
<div class="dynsection">

<p><center><img src="classMercator_1_1LevelTerrainMod.png" usemap="#Mercator::LevelTerrainMod< Shape >_map" border="0" alt=""></center>
<map name="Mercator::LevelTerrainMod< Shape >_map">
<area href="classMercator_1_1ShapeTerrainMod.html" alt="Mercator::ShapeTerrainMod< Shape >" shape="rect" coords="0,56,232,80">
<area href="classMercator_1_1TerrainMod.html" alt="Mercator::TerrainMod" shape="rect" coords="0,0,232,24">
</map>
</div>

<p>
<a href="classMercator_1_1LevelTerrainMod-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1LevelTerrainMod.html#e5883a9223f7a737bddcc113c4ddd6c3">LevelTerrainMod</a> (float level, const Shape &amp;s)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#e5883a9223f7a737bddcc113c4ddd6c3"></a><br></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_1LevelTerrainMod.html#7e3eda235fa6b99f5115a4c34cae7072">apply</a> (float &amp;point, int x, int y) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Apply this modifier on a terrain segment.  <a href="#7e3eda235fa6b99f5115a4c34cae7072"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="783e4b9e7d837806529e85b9ae2efc8e"></a><!-- doxytag: member="Mercator::LevelTerrainMod::clone" ref="783e4b9e7d837806529e85b9ae2efc8e" args="() const " -->
virtual <a class="el" href="classMercator_1_1TerrainMod.html">TerrainMod</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1LevelTerrainMod.html#783e4b9e7d837806529e85b9ae2efc8e">clone</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a copy of this modifier. <br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="457f28e8e854be6c2618e24a01c4ccb8"></a><!-- doxytag: member="Mercator::LevelTerrainMod::m_level" ref="457f28e8e854be6c2618e24a01c4ccb8" args="" -->
float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1LevelTerrainMod.html#457f28e8e854be6c2618e24a01c4ccb8">m_level</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The height level of all points affected. <br></td></tr>
<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="40f7ffd0284c156950141856ba90723d"></a><!-- doxytag: member="Mercator::LevelTerrainMod::LevelTerrainMod" ref="40f7ffd0284c156950141856ba90723d" args="(LevelTerrainMod &amp;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1LevelTerrainMod.html#40f7ffd0284c156950141856ba90723d">LevelTerrainMod</a> (<a class="el" href="classMercator_1_1LevelTerrainMod.html">LevelTerrainMod</a> &amp;)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;typename Shape&gt;<br>
 class Mercator::LevelTerrainMod&lt; Shape &gt;</h3>

<a class="el" href="classMercator_1_1Terrain.html" title="Class storing centrally all data about an instance of some terrain.">Terrain</a> modifier that defines an area of fixed height. 
<p>
This modifier sets all points inside the shape to the same altitude <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="e5883a9223f7a737bddcc113c4ddd6c3"></a><!-- doxytag: member="Mercator::LevelTerrainMod::LevelTerrainMod" ref="e5883a9223f7a737bddcc113c4ddd6c3" args="(float level, const Shape &amp;s)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shape&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classMercator_1_1LevelTerrainMod.html">Mercator::LevelTerrainMod</a>&lt; Shape &gt;::<a class="el" href="classMercator_1_1LevelTerrainMod.html">LevelTerrainMod</a>           </td>
          <td>(</td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>level</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const Shape &amp;&nbsp;</td>
          <td class="paramname"> <em>s</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</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>level</em>&nbsp;</td><td>The height level of all points affected. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>s</em>&nbsp;</td><td>shape of the modifier. </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7e3eda235fa6b99f5115a4c34cae7072"></a><!-- doxytag: member="Mercator::LevelTerrainMod::apply" ref="7e3eda235fa6b99f5115a4c34cae7072" args="(float &amp;point, int x, int y) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shape &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classMercator_1_1LevelTerrainMod.html">Mercator::LevelTerrainMod</a>&lt; Shape &gt;::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> [inline, 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>Implements <a class="el" href="classMercator_1_1TerrainMod.html#89b94b74a24df696460e4a8b9bc06fe9">Mercator::TerrainMod</a>.</p>

<p>References <a class="el" href="TerrainMod_8h_source.html#l00082">Mercator::LevelTerrainMod&lt; Shape &gt;::m_level</a>, and <a class="el" href="TerrainMod_8h_source.html#l00053">Mercator::ShapeTerrainMod&lt; Shape &gt;::m_shape</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><a class="el" href="TerrainMod__impl_8h_source.html">TerrainMod_impl.h</a></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>