<!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::BandShader 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_1BandShader.html">BandShader</a>
</div>
</div>
<div class="contents">
<h1>Mercator::BandShader Class Reference</h1><!-- doxytag: class="Mercator::BandShader" --><!-- doxytag: inherits="Mercator::Shader" --><a class="el" href="classMercator_1_1Surface.html" title="Data store for terrain surface data.">Surface</a> shader that defines the surface between two levels.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="ThresholdShader_8h_source.html">ThresholdShader.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for Mercator::BandShader:</div>
<div class="dynsection">
<p><center><img src="classMercator_1_1BandShader.png" usemap="#Mercator::BandShader_map" border="0" alt=""></center>
<map name="Mercator::BandShader_map">
<area href="classMercator_1_1Shader.html" alt="Mercator::Shader" shape="rect" coords="0,0,140,24">
</map>
</div>
<p>
<a href="classMercator_1_1BandShader-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_1BandShader.html#81e75f30baa431f779d3751a28f66ebc">BandShader</a> (float low_threshold=<a class="el" href="classMercator_1_1BandShader.html#b581d6f1ce596212774350097a98a4a4">default_lowThreshold</a>, float high_threshold=<a class="el" href="classMercator_1_1BandShader.html#0047fc3357a7500d912033d74d2f048c">default_highThreshold</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#81e75f30baa431f779d3751a28f66ebc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BandShader.html#035d402b834fbbb4365fa5e63a0b2973">BandShader</a> (const <a class="el" href="classMercator_1_1Shader.html#1e99426c6c90afbb8c54114bb692b861">Parameters</a> &params)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#035d402b834fbbb4365fa5e63a0b2973"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4b38d967a4dae2f504175b4fe15852c4"></a><!-- doxytag: member="Mercator::BandShader::lowThreshold" ref="4b38d967a4dae2f504175b4fe15852c4" args="() const " -->
const float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BandShader.html#4b38d967a4dae2f504175b4fe15852c4">lowThreshold</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the level above which the shader renders. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="503cfad3938637c578a4ecbe1d2c5344"></a><!-- doxytag: member="Mercator::BandShader::highThreshold" ref="503cfad3938637c578a4ecbe1d2c5344" args="() const " -->
const float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BandShader.html#503cfad3938637c578a4ecbe1d2c5344">highThreshold</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the level below which the shader renders. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BandShader.html#78d44205f6f171d6672a0bf71e2a8a90">checkIntersect</a> (const <a class="el" href="classMercator_1_1Segment.html">Segment</a> &) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check whether this <a class="el" href="classMercator_1_1Shader.html" title="Base class for Shader objects which create surface data for use when rendering terrain...">Shader</a> has any effect on the given <a class="el" href="classMercator_1_1Segment.html" title="Class storing heightfield and other data for a single fixed size square area of terrain...">Segment</a>. <a href="#78d44205f6f171d6672a0bf71e2a8a90"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d0a99f20de21ad09f2a29cf57a52c311"></a><!-- doxytag: member="Mercator::BandShader::shade" ref="d0a99f20de21ad09f2a29cf57a52c311" args="(Surface &) const " -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BandShader.html#d0a99f20de21ad09f2a29cf57a52c311">shade</a> (<a class="el" href="classMercator_1_1Surface.html">Surface</a> &) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Populate a <a class="el" href="classMercator_1_1Surface.html" title="Data store for terrain surface data.">Surface</a> with data. <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="f4b4253a94f288a5bfdbd746d4df79b5"></a><!-- doxytag: member="Mercator::BandShader::key_lowThreshold" ref="f4b4253a94f288a5bfdbd746d4df79b5" args="" -->
static const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BandShader.html#f4b4253a94f288a5bfdbd746d4df79b5">key_lowThreshold</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Key string used when specifying the low threshold parameter. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8a41503a9384a0e1a41947a1168be0ab"></a><!-- doxytag: member="Mercator::BandShader::key_highThreshold" ref="8a41503a9384a0e1a41947a1168be0ab" args="" -->
static const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BandShader.html#8a41503a9384a0e1a41947a1168be0ab">key_highThreshold</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Key string used when specifying the high threshold parameter. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b581d6f1ce596212774350097a98a4a4"></a><!-- doxytag: member="Mercator::BandShader::default_lowThreshold" ref="b581d6f1ce596212774350097a98a4a4" args="" -->
static const float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BandShader.html#b581d6f1ce596212774350097a98a4a4">default_lowThreshold</a> = -1.f</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default level above which the shader renders. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0047fc3357a7500d912033d74d2f048c"></a><!-- doxytag: member="Mercator::BandShader::default_highThreshold" ref="0047fc3357a7500d912033d74d2f048c" args="" -->
static const float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BandShader.html#0047fc3357a7500d912033d74d2f048c">default_highThreshold</a> = 1.f</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default level below which the shader renders. <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="6a486c8f96587b320f872db3a1c75e18"></a><!-- doxytag: member="Mercator::BandShader::m_lowThreshold" ref="6a486c8f96587b320f872db3a1c75e18" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BandShader.html#6a486c8f96587b320f872db3a1c75e18">m_lowThreshold</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The level above which the shader renders. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4d8980a0aba1931cb421ddfe33286baf"></a><!-- doxytag: member="Mercator::BandShader::m_highThreshold" ref="4d8980a0aba1931cb421ddfe33286baf" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1BandShader.html#4d8980a0aba1931cb421ddfe33286baf">m_highThreshold</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The level below which the shader renders. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classMercator_1_1Surface.html" title="Data store for terrain surface data.">Surface</a> shader that defines the surface between two levels. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="81e75f30baa431f779d3751a28f66ebc"></a><!-- doxytag: member="Mercator::BandShader::BandShader" ref="81e75f30baa431f779d3751a28f66ebc" args="(float low_threshold=default_lowThreshold, float high_threshold=default_highThreshold)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Mercator::BandShader::BandShader </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>low_threshold</em> = <code><a class="el" href="classMercator_1_1BandShader.html#b581d6f1ce596212774350097a98a4a4">default_lowThreshold</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>high_threshold</em> = <code><a class="el" href="classMercator_1_1BandShader.html#0047fc3357a7500d912033d74d2f048c">default_highThreshold</a></code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [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>low_threshold</em> </td><td>level above which the shader renders. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>high_threshold</em> </td><td>level below which the shader renders. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="035d402b834fbbb4365fa5e63a0b2973"></a><!-- doxytag: member="Mercator::BandShader::BandShader" ref="035d402b834fbbb4365fa5e63a0b2973" args="(const Parameters &params)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Mercator::BandShader::BandShader </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classMercator_1_1Shader.html#1e99426c6c90afbb8c54114bb692b861">Parameters</a> & </td>
<td class="paramname"> <em>params</em> </td>
<td> ) </td>
<td><code> [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>params</em> </td><td>a map of parameters for the shader. </td></tr>
</table>
</dl>
<p>References <a class="el" href="ThresholdShader_8h_source.html#l00081">key_highThreshold</a>, <a class="el" href="ThresholdShader_8h_source.html#l00079">key_lowThreshold</a>, <a class="el" href="ThresholdShader_8h_source.html#l00076">m_highThreshold</a>, and <a class="el" href="ThresholdShader_8h_source.html#l00074">m_lowThreshold</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="78d44205f6f171d6672a0bf71e2a8a90"></a><!-- doxytag: member="Mercator::BandShader::checkIntersect" ref="78d44205f6f171d6672a0bf71e2a8a90" args="(const Segment &) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Mercator::BandShader::checkIntersect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classMercator_1_1Segment.html">Segment</a> & </td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check whether this <a class="el" href="classMercator_1_1Shader.html" title="Base class for Shader objects which create surface data for use when rendering terrain...">Shader</a> has any effect on the given <a class="el" href="classMercator_1_1Segment.html" title="Class storing heightfield and other data for a single fixed size square area of terrain...">Segment</a>.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the given <a class="el" href="classMercator_1_1Segment.html" title="Class storing heightfield and other data for a single fixed size square area of terrain...">Segment</a> height range is within the range that this <a class="el" href="classMercator_1_1Shader.html" title="Base class for Shader objects which create surface data for use when rendering terrain...">Shader</a> uses. e.g. A high altitude snow shader will have no effect on low level terrain. </dd></dl>
<p>Implements <a class="el" href="classMercator_1_1Shader.html#6a69ca4a474c18f1038cc9a75a419855">Mercator::Shader</a>.</p>
<p>References <a class="el" href="Segment_8h_source.html#l00172">Mercator::Segment::getMax()</a>, <a class="el" href="Segment_8h_source.html#l00174">Mercator::Segment::getMin()</a>, <a class="el" href="ThresholdShader_8h_source.html#l00076">m_highThreshold</a>, and <a class="el" href="ThresholdShader_8h_source.html#l00074">m_lowThreshold</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="ThresholdShader_8h_source.html">ThresholdShader.h</a><li>ThresholdShader.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>
