Sophie

Sophie

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

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::Edge 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&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_1Edge.html">Edge</a>
  </div>
</div>
<div class="contents">
<h1>Mercator::Edge Class Reference</h1><!-- doxytag: class="Mercator::Edge" -->The edge of an area.  
<a href="#_details">More...</a>
<p>

<p>
<a href="classMercator_1_1Edge-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_1Edge.html#b69a7b19ce9bb93538f515c49a828364">Edge</a> (const Point2 &amp;a, const Point2 &amp;b)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#b69a7b19ce9bb93538f515c49a828364"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1d697cc82c7555141bfbc7f7c4c1e518"></a><!-- doxytag: member="Mercator::Edge::start" ref="1d697cc82c7555141bfbc7f7c4c1e518" args="() const " -->
Point2&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Edge.html#1d697cc82c7555141bfbc7f7c4c1e518">start</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accessor for the point describing the start of the edge. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eab175725cf59138bbaa562d3979f20c"></a><!-- doxytag: member="Mercator::Edge::end" ref="eab175725cf59138bbaa562d3979f20c" args="() const " -->
Point2&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Edge.html#eab175725cf59138bbaa562d3979f20c">end</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determine the point describing the end of the edge. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Edge.html#9916a216f4a4877ae56254468626303c">xValueAtY</a> (double y) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determine the x coordinate at a given y coordinate.  <a href="#9916a216f4a4877ae56254468626303c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Edge.html#eae3ba15666466b88d798727119fd569">operator&lt;</a> (const <a class="el" href="classMercator_1_1Edge.html">Edge</a> &amp;other) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compare the y coordinate of the start with another edge.  <a href="#eae3ba15666466b88d798727119fd569"></a><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="4a7712660d7e4829292fc005219f72a3"></a><!-- doxytag: member="Mercator::Edge::m_start" ref="4a7712660d7e4829292fc005219f72a3" args="" -->
Point2&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Edge.html#4a7712660d7e4829292fc005219f72a3">m_start</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The point describing the start of the edge. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3302763081c072bde20d5e14fb28b633"></a><!-- doxytag: member="Mercator::Edge::m_seg" ref="3302763081c072bde20d5e14fb28b633" args="" -->
Vector2&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Edge.html#3302763081c072bde20d5e14fb28b633">m_seg</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The vector describing the edge from its start. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f62ad4189c0dab6a88c7327742d68c75"></a><!-- doxytag: member="Mercator::Edge::m_inverseGradient" ref="f62ad4189c0dab6a88c7327742d68c75" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1Edge.html#f62ad4189c0dab6a88c7327742d68c75">m_inverseGradient</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The inverse of the gradient of the line. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The edge of an area. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="b69a7b19ce9bb93538f515c49a828364"></a><!-- doxytag: member="Mercator::Edge::Edge" ref="b69a7b19ce9bb93538f515c49a828364" args="(const Point2 &amp;a, const Point2 &amp;b)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Mercator::Edge::Edge           </td>
          <td>(</td>
          <td class="paramtype">const Point2 &amp;&nbsp;</td>
          <td class="paramname"> <em>a</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const Point2 &amp;&nbsp;</td>
          <td class="paramname"> <em>b</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>a</em>&nbsp;</td><td>one end of the line defining the edge. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>b</em>&nbsp;</td><td>one end of the line defining the edge. </td></tr>
  </table>
</dl>

<p>References <a class="el" href="AreaShader_8cpp_source.html#l00084">m_inverseGradient</a>, <a class="el" href="AreaShader_8cpp_source.html#l00082">m_seg</a>, and <a class="el" href="AreaShader_8cpp_source.html#l00080">m_start</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="eae3ba15666466b88d798727119fd569"></a><!-- doxytag: member="Mercator::Edge::operator&lt;" ref="eae3ba15666466b88d798727119fd569" args="(const Edge &amp;other) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Mercator::Edge::operator&lt;           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classMercator_1_1Edge.html">Edge</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>other</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Compare the y coordinate of the start with another edge. 
<p>
This operator ensures that edges can be sorted, compares the y y coordinate of the start of the edges. 
<p>References <a class="el" href="AreaShader_8cpp_source.html#l00080">m_start</a>.</p>

</div>
</div><p>
<a class="anchor" name="9916a216f4a4877ae56254468626303c"></a><!-- doxytag: member="Mercator::Edge::xValueAtY" ref="9916a216f4a4877ae56254468626303c" args="(double y) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double Mercator::Edge::xValueAtY           </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>y</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Determine the x coordinate at a given y coordinate. 
<p>
Calculate the x coordinate on the edge line where the y coordinate is the value specified. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>the y coordinate where the calculation is required. </td></tr>
  </table>
</dl>

<p>References <a class="el" href="AreaShader_8cpp_source.html#l00084">m_inverseGradient</a>, and <a class="el" href="AreaShader_8cpp_source.html#l00080">m_start</a>.</p>

<p>Referenced by <a class="el" href="AreaShader_8cpp_source.html#l00097">Mercator::EdgeAtY::operator()()</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>AreaShader.cpp</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>