Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > c64f89a8a05df304b0d9ff680ae1aa00 > files > 141

mercator-devel-0.2.7-4.fc15.i686.rpm

<!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::TileShader 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.3 -->
<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&#160;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&#160;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;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_1TileShader.html">TileShader</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<h1>Mercator::TileShader Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="Mercator::TileShader" --><!-- doxytag: inherits="Mercator::Shader" -->
<p><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> agregating surface data.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="TileShader_8h_source.html">TileShader.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Mercator::TileShader:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classMercator_1_1TileShader.png" usemap="#Mercator::TileShader_map" alt=""/>
  <map id="Mercator::TileShader_map" name="Mercator::TileShader_map">
<area href="classMercator_1_1Shader.html" alt="Mercator::Shader" shape="rect" coords="0,0,131,24"/>
</map>
 </div></div>

<p><a href="classMercator_1_1TileShader-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ce547e611fde5576d949a0e6fc6eb06"></a><!-- doxytag: member="Mercator::TileShader::Shaderstore" ref="a1ce547e611fde5576d949a0e6fc6eb06" args="" -->
typedef std::map&lt; int, <a class="el" href="classMercator_1_1Shader.html">Shader</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1TileShader.html#a1ce547e611fde5576d949a0e6fc6eb06">Shaderstore</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">STL map to store sparse array of <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> pointers. <br/></td></tr>
<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="a107634b523f5ab462e19c5ea748d6bff"></a><!-- doxytag: member="Mercator::TileShader::addShader" ref="a107634b523f5ab462e19c5ea748d6bff" args="(Shader *t, int id)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1TileShader.html#a107634b523f5ab462e19c5ea748d6bff">addShader</a> (<a class="el" href="classMercator_1_1Shader.html">Shader</a> *t, int id)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a shader to those agregated by the tile shader. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1TileShader.html#a5cb9b0c15d7ff4804db74485fbbb00b9">checkIntersect</a> (const <a class="el" href="classMercator_1_1Segment.html">Segment</a> &amp;) const </td></tr>
<tr><td class="mdescLeft">&#160;</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 defined by fo...">Segment</a>.  <a href="#a5cb9b0c15d7ff4804db74485fbbb00b9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd0a5c09f9df1db089ad410f974a7deb"></a><!-- doxytag: member="Mercator::TileShader::shade" ref="abd0a5c09f9df1db089ad410f974a7deb" args="(Surface &amp;) const " -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1TileShader.html#abd0a5c09f9df1db089ad410f974a7deb">shade</a> (<a class="el" href="classMercator_1_1Surface.html">Surface</a> &amp;) const </td></tr>
<tr><td class="mdescLeft">&#160;</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"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3be6ff97532009c5db1e7f11983fe8d"></a><!-- doxytag: member="Mercator::TileShader::m_subShaders" ref="aa3be6ff97532009c5db1e7f11983fe8d" args="" -->
<a class="el" href="classMercator_1_1TileShader.html#a1ce547e611fde5576d949a0e6fc6eb06">Shaderstore</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1TileShader.html#aa3be6ff97532009c5db1e7f11983fe8d">m_subShaders</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Store of shaders which are agregated by this shader. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><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> agregating surface data. </p>
<p>Some applications require the terrain surface data be stored in a single buffer so specific locations can be queried to determine the type. Typically this is used on a server, where lots of surface data optimised for rendering is not required, but fast cheap queries about the surface at a specific point are required. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5cb9b0c15d7ff4804db74485fbbb00b9"></a><!-- doxytag: member="Mercator::TileShader::checkIntersect" ref="a5cb9b0c15d7ff4804db74485fbbb00b9" args="(const Segment &amp;) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Mercator::TileShader::checkIntersect </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classMercator_1_1Segment.html">Segment</a> &amp;&#160;</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 defined by fo...">Segment</a>. </p>
<dl class="return"><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 defined by fo...">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#a6a69ca4a474c18f1038cc9a75a419855">Mercator::Shader</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="TileShader_8h_source.html">TileShader.h</a></li>
<li>TileShader.cpp</li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated for Mercator by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>