<!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::Plant 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.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_1Plant.html">Plant</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<div class="title">Mercator::Plant Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Mercator::Plant" -->
<p>This is the simple class for representing instances of vegetation.
<a href="classMercator_1_1Plant.html#details">More...</a></p>
<p><code>#include <<a class="el" href="Plant_8h_source.html">Plant.h</a>></code></p>
<p><a href="classMercator_1_1Plant-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"><a class="anchor" id="a4d3ea76ce8e80b1191d12fcc53088c55"></a><!-- doxytag: member="Mercator::Plant::Plant" ref="a4d3ea76ce8e80b1191d12fcc53088c55" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Plant.html#a4d3ea76ce8e80b1191d12fcc53088c55">Plant</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Height is initialised explicitly to zero. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5cb16ae530ce69d3d00214bb6ad63417"></a><!-- doxytag: member="Mercator::Plant::~Plant" ref="a5cb16ae530ce69d3d00214bb6ad63417" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Plant.html#a5cb16ae530ce69d3d00214bb6ad63417">~Plant</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Nothing special in the destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f85ea3aa03b375a331d1dabc4a5e62a"></a><!-- doxytag: member="Mercator::Plant::getDisplacement" ref="a7f85ea3aa03b375a331d1dabc4a5e62a" args="() const " -->
const WFMath::Point< 2 > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Plant.html#a7f85ea3aa03b375a331d1dabc4a5e62a">getDisplacement</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessor for displacement from grid point. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3fe2afdac56e8f193b1ac999d93332b4"></a><!-- doxytag: member="Mercator::Plant::setDisplacement" ref="a3fe2afdac56e8f193b1ac999d93332b4" args="(const WFMath::Point< 2 > &d)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Plant.html#a3fe2afdac56e8f193b1ac999d93332b4">setDisplacement</a> (const WFMath::Point< 2 > &d)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the displacement to a new value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3fb17ddd5adf3e1102d3a05abd891ee"></a><!-- doxytag: member="Mercator::Plant::getOrientation" ref="ad3fb17ddd5adf3e1102d3a05abd891ee" args="() const " -->
const WFMath::Quaternion & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Plant.html#ad3fb17ddd5adf3e1102d3a05abd891ee">getOrientation</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessor for orientation. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9658e6f8339acab9cf5abca6562011e3"></a><!-- doxytag: member="Mercator::Plant::setOrientation" ref="a9658e6f8339acab9cf5abca6562011e3" args="(const WFMath::Quaternion &o)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Plant.html#a9658e6f8339acab9cf5abca6562011e3">setOrientation</a> (const WFMath::Quaternion &o)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the orientation to a new value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0d084f9a8c2bd262eeae2d073b9143b"></a><!-- doxytag: member="Mercator::Plant::getHeight" ref="af0d084f9a8c2bd262eeae2d073b9143b" args="() const " -->
const float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Plant.html#af0d084f9a8c2bd262eeae2d073b9143b">getHeight</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessor for height. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a33eefc99bc4ede447e9d20d5278d9c95"></a><!-- doxytag: member="Mercator::Plant::setHeight" ref="a33eefc99bc4ede447e9d20d5278d9c95" args="(float h)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Plant.html#a33eefc99bc4ede447e9d20d5278d9c95">setHeight</a> (float h)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the height to a new value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42b6c909164abc47be58f85f10cb1fde"></a><!-- doxytag: member="Mercator::Plant::setParameter" ref="a42b6c909164abc47be58f85f10cb1fde" args="(const std::string &, float)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Plant.html#a42b6c909164abc47be58f85f10cb1fde">setParameter</a> (const std::string &, float)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a named parameter value for this plant. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea43d9105709dbacb0a0a95f9327c2ea"></a><!-- doxytag: member="Mercator::Plant::m_displacement" ref="aea43d9105709dbacb0a0a95f9327c2ea" args="" -->
WFMath::Point< 2 > </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Plant.html#aea43d9105709dbacb0a0a95f9327c2ea">m_displacement</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Position of the vegetation relative to its grid point. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc5dd9568cf541eec28ee77526ff4812"></a><!-- doxytag: member="Mercator::Plant::m_orientation" ref="acc5dd9568cf541eec28ee77526ff4812" args="" -->
WFMath::Quaternion </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Plant.html#acc5dd9568cf541eec28ee77526ff4812">m_orientation</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Orientation of the vegetation. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e42df23f264d55b19daddecf27b04cd"></a><!-- doxytag: member="Mercator::Plant::m_height" ref="a6e42df23f264d55b19daddecf27b04cd" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Plant.html#a6e42df23f264d55b19daddecf27b04cd">m_height</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Height of the vegetation. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This is the simple class for representing instances of vegetation. </p>
<p>It is used in instances of class <a class="el" href="classMercator_1_1Forest.html" title="This is the core class for any area to be populated with vegetation.">Forest</a> to represent each instance of vegetation created when the <a class="el" href="classMercator_1_1Forest.html" title="This is the core class for any area to be populated with vegetation.">Forest</a> is populated. </p>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Plant_8h_source.html">Plant.h</a></li>
<li>Plant.cpp</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>
