<!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"/>
<title>Mercator: Mercator::LevelTerrainMod< Shape > 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.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Mercator</div>
</td>
</tr>
</tbody>
</table>
</div>
<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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>Mercator</b> </li>
<li class="navelem"><a class="el" href="classMercator_1_1LevelTerrainMod.html">LevelTerrainMod</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pri-methods">Private Member Functions</a> </div>
<div class="headertitle">
<div class="title">Mercator::LevelTerrainMod< Shape > Class Template Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Mercator::LevelTerrainMod" --><!-- doxytag: inherits="Mercator::ShapeTerrainMod" -->
<p><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="classMercator_1_1LevelTerrainMod.html#details">More...</a></p>
<p><code>#include <<a class="el" href="TerrainMod_8h_source.html">TerrainMod.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Mercator::LevelTerrainMod< Shape >:</div>
<div class="dyncontent">
<div class="center">
<img src="classMercator_1_1LevelTerrainMod.png" usemap="#Mercator::LevelTerrainMod< Shape >_map" alt=""/>
<map id="Mercator::LevelTerrainMod< Shape >_map" name="Mercator::LevelTerrainMod< Shape >_map">
<area href="classMercator_1_1ShapeTerrainMod.html" title="Terrain modifier which is defined by a shape variable." alt="Mercator::ShapeTerrainMod< Shape >" shape="rect" coords="0,112,232,136"/>
<area href="classMercator_1_1TerrainMod.html" title="Base class for modifiers to the procedurally generated terrain." alt="Mercator::TerrainMod" shape="rect" coords="0,56,232,80"/>
<area href="classMercator_1_1Effector.html" title="Device which effects a change in the terrain." alt="Mercator::Effector" shape="rect" coords="0,0,232,24"/>
</map>
</div></div>
<p><a href="classMercator_1_1LevelTerrainMod-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1LevelTerrainMod.html#ae5568f1024581142f57cd2585ebfeb77">LevelTerrainMod</a> (float level, const Shape< 2 > &s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#ae5568f1024581142f57cd2585ebfeb77"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1LevelTerrainMod.html#a7e3eda235fa6b99f5115a4c34cae7072">apply</a> (float &point, int x, int y) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Apply this modifier on a terrain segment. <a href="#a7e3eda235fa6b99f5115a4c34cae7072"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a783e4b9e7d837806529e85b9ae2efc8e"></a><!-- doxytag: member="Mercator::LevelTerrainMod::clone" ref="a783e4b9e7d837806529e85b9ae2efc8e" args="() const " -->
virtual <a class="el" href="classMercator_1_1TerrainMod.html">TerrainMod</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1LevelTerrainMod.html#a783e4b9e7d837806529e85b9ae2efc8e">clone</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a copy of this modifier. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f8a4d422043bed54d3d5fa68206eda0"></a><!-- doxytag: member="Mercator::LevelTerrainMod::setShape" ref="a3f8a4d422043bed54d3d5fa68206eda0" args="(float level, const Shape< 2 > &s)" -->
void </td><td class="memItemRight" valign="bottom"><b>setShape</b> (float level, const Shape< 2 > &s)</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a457f28e8e854be6c2618e24a01c4ccb8"></a><!-- doxytag: member="Mercator::LevelTerrainMod::m_level" ref="a457f28e8e854be6c2618e24a01c4ccb8" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1LevelTerrainMod.html#a457f28e8e854be6c2618e24a01c4ccb8">m_level</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The height level of all points affected. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40f7ffd0284c156950141856ba90723d"></a><!-- doxytag: member="Mercator::LevelTerrainMod::LevelTerrainMod" ref="a40f7ffd0284c156950141856ba90723d" args="(LevelTerrainMod &)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1LevelTerrainMod.html#a40f7ffd0284c156950141856ba90723d">LevelTerrainMod</a> (<a class="el" href="classMercator_1_1LevelTerrainMod.html">LevelTerrainMod</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<template< int > class Shape><br/>
class Mercator::LevelTerrainMod< Shape ></h3>
<p><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>
<p>This modifier sets all points inside the shape to the same altitude </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae5568f1024581142f57cd2585ebfeb77"></a><!-- doxytag: member="Mercator::LevelTerrainMod::LevelTerrainMod" ref="ae5568f1024581142f57cd2585ebfeb77" args="(float level, const Shape< 2 > &s)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<template< int > class Shape> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classMercator_1_1LevelTerrainMod.html">Mercator::LevelTerrainMod</a>< Shape >::<a class="el" href="classMercator_1_1LevelTerrainMod.html">LevelTerrainMod</a> </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>level</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Shape< 2 > & </td>
<td class="paramname"><em>s</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">level</td><td>The height level of all points affected. </td></tr>
<tr><td class="paramname">s</td><td>shape of the modifier. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7e3eda235fa6b99f5115a4c34cae7072"></a><!-- doxytag: member="Mercator::LevelTerrainMod::apply" ref="a7e3eda235fa6b99f5115a4c34cae7072" args="(float &point, int x, int y) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<template< int > class Shape> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classMercator_1_1LevelTerrainMod.html">Mercator::LevelTerrainMod</a>< Shape >::apply </td>
<td>(</td>
<td class="paramtype">float & </td>
<td class="paramname"><em>point</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Apply this modifier on a terrain segment. </p>
<p>The segment is at x,y in local coordinates. Output is placed into point. </p>
<p>Implements <a class="el" href="classMercator_1_1TerrainMod.html#a89b94b74a24df696460e4a8b9bc06fe9">Mercator::TerrainMod</a>.</p>
</div>
</div>
<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>
<li><a class="el" href="TerrainMod__impl_8h_source.html">TerrainMod_impl.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated for Mercator by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
