<!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::TopClip 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 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_1TopClip.html">TopClip</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"> <h1>Mercator::TopClip Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="Mercator::TopClip" --> <p>Helper to clip points to a given range. <a href="#_details">More...</a></p> <p><a href="classMercator_1_1TopClip-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_1TopClip.html#aa4d3c561309539649d52e5748723e8a4">TopClip</a> (double t)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1TopClip.html#a2abbf9873c93026deba4be199c727333">inside</a> (const Point2 &p) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Check a point is outside this clip. <a href="#a2abbf9873c93026deba4be199c727333"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">Point2 </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1TopClip.html#a45ce033a5497224be70470aaeb538175">clip</a> (const Point2 &u, const Point2 &v) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Determine the point where a line crosses this clip. <a href="#a45ce033a5497224be70470aaeb538175"></a><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="a85ffde8e2a34833448f2036fcd850d10"></a><!-- doxytag: member="Mercator::TopClip::topY" ref="a85ffde8e2a34833448f2036fcd850d10" args="" --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1TopClip.html#a85ffde8e2a34833448f2036fcd850d10">topY</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Top of y range. <br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Helper to clip points to a given range. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aa4d3c561309539649d52e5748723e8a4"></a><!-- doxytag: member="Mercator::TopClip::TopClip" ref="aa4d3c561309539649d52e5748723e8a4" args="(double t)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Mercator::TopClip::TopClip </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"><em>t</em></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">t</td><td>top of y range </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a45ce033a5497224be70470aaeb538175"></a><!-- doxytag: member="Mercator::TopClip::clip" ref="a45ce033a5497224be70470aaeb538175" args="(const Point2 &u, const Point2 &v) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Point2 Mercator::TopClip::clip </td> <td>(</td> <td class="paramtype">const Point2 & </td> <td class="paramname"><em>u</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const Point2 & </td> <td class="paramname"><em>v</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Determine the point where a line crosses this clip. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">u</td><td>one of of a line that crosses this clip </td></tr> <tr><td class="paramname">v</td><td>one of of a line that crosses this clip </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>a point where the line cross this clip. </dd></dl> </div> </div> <a class="anchor" id="a2abbf9873c93026deba4be199c727333"></a><!-- doxytag: member="Mercator::TopClip::inside" ref="a2abbf9873c93026deba4be199c727333" args="(const Point2 &p) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Mercator::TopClip::inside </td> <td>(</td> <td class="paramtype">const Point2 & </td> <td class="paramname"><em>p</em></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Check a point is outside this clip. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">p</td><td>point to be checked. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>true if p is outside the clip. </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>Area.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.3 </small></address> </body> </html>