geos_390_docs/classgeos_1_1geom_1_1Quadra...

413 lines
16 KiB
HTML

<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>GEOS: geos::geom::Quadrant Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">GEOS
&#160;<span id="projectnumber">3.9.1dev</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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="inherits.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"><a class="el" href="namespacegeos.html">geos</a></li><li class="navelem"><a class="el" href="namespacegeos_1_1geom.html">geom</a></li><li class="navelem"><a class="el" href="classgeos_1_1geom_1_1Quadrant.html">Quadrant</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classgeos_1_1geom_1_1Quadrant-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::geom::Quadrant Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Utility functions for working with quadrants.
<a href="classgeos_1_1geom_1_1Quadrant.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Quadrant_8h_source.html">Quadrant.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a022f72d7bd9d264c7c0f81a26d40d587"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1Quadrant.html#a022f72d7bd9d264c7c0f81a26d40d587">quadrant</a> (double dx, double dy)</td></tr>
<tr class="separator:a022f72d7bd9d264c7c0f81a26d40d587"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71209d8f6af8b83cce811c54648a6833"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1Quadrant.html#a71209d8f6af8b83cce811c54648a6833">quadrant</a> (const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &amp;p0, const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &amp;p1)</td></tr>
<tr class="separator:a71209d8f6af8b83cce811c54648a6833"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f1c2ec80d8507dfbdd0729c85da006c"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1Quadrant.html#a2f1c2ec80d8507dfbdd0729c85da006c">isOpposite</a> (int quad1, int quad2)</td></tr>
<tr class="separator:a2f1c2ec80d8507dfbdd0729c85da006c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0153e3f8c22ce2440ba125574eb440d1"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1Quadrant.html#a0153e3f8c22ce2440ba125574eb440d1">commonHalfPlane</a> (int quad1, int quad2)</td></tr>
<tr class="separator:a0153e3f8c22ce2440ba125574eb440d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40fe00dcdba1ce9fb7d3d2be7bdc2209"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1Quadrant.html#a40fe00dcdba1ce9fb7d3d2be7bdc2209">isInHalfPlane</a> (int quad, int halfPlane)</td></tr>
<tr class="separator:a40fe00dcdba1ce9fb7d3d2be7bdc2209"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6faa8d3743b36f6e53fdf5b82c119463"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1Quadrant.html#a6faa8d3743b36f6e53fdf5b82c119463">isNorthern</a> (int quad)</td></tr>
<tr class="separator:a6faa8d3743b36f6e53fdf5b82c119463"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a6c529bbdf9905b4c7abf59d1ef0cee33"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1Quadrant.html#a6c529bbdf9905b4c7abf59d1ef0cee33">NE</a> = 0</td></tr>
<tr class="separator:a6c529bbdf9905b4c7abf59d1ef0cee33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00cf8f2adfed97d896575f1fa4129b84"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1Quadrant.html#a00cf8f2adfed97d896575f1fa4129b84">NW</a> = 1</td></tr>
<tr class="separator:a00cf8f2adfed97d896575f1fa4129b84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe04d5195ffe4b445388223a5d850f6b"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1Quadrant.html#abe04d5195ffe4b445388223a5d850f6b">SW</a> = 2</td></tr>
<tr class="separator:abe04d5195ffe4b445388223a5d850f6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3b7ca38281b8333d75e98e57e5ebae4"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1Quadrant.html#ad3b7ca38281b8333d75e98e57e5ebae4">SE</a> = 3</td></tr>
<tr class="separator:ad3b7ca38281b8333d75e98e57e5ebae4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Utility functions for working with quadrants. </p>
<p>The quadrants are numbered as follows: </p><pre>
1 | 0
&ndash;+&ndash;
2 | 3
</pre>
<p>Definition at line <a class="el" href="Quadrant_8h_source.html#l00050">50</a> of file <a class="el" href="Quadrant_8h_source.html">Quadrant.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a0153e3f8c22ce2440ba125574eb440d1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int geos::geom::Quadrant::commonHalfPlane </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>quad1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>quad2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a40fe00dcdba1ce9fb7d3d2be7bdc2209"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool geos::geom::Quadrant::isInHalfPlane </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>quad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>halfPlane</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether the given quadrant lies within the given halfplane (specified by its right-hand quadrant). </p>
</div>
</div>
<a class="anchor" id="a6faa8d3743b36f6e53fdf5b82c119463"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool geos::geom::Quadrant::isNorthern </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>quad</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the given quadrant is 0 or 1. </p>
</div>
</div>
<a class="anchor" id="a2f1c2ec80d8507dfbdd0729c85da006c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool geos::geom::Quadrant::isOpposite </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>quad1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>quad2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the quadrants are 1 and 3, or 2 and 4 </p>
</div>
</div>
<a class="anchor" id="a022f72d7bd9d264c7c0f81a26d40d587"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int geos::geom::Quadrant::quadrant </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>dx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>dy</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the quadrant of a directed line segment (specified as x and y displacements, which cannot both be 0).</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">IllegalArgumentException</td><td>if the displacements are both 0 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a71209d8f6af8b83cce811c54648a6833"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int geos::geom::Quadrant::quadrant </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &amp;&#160;</td>
<td class="paramname"><em>p0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &amp;&#160;</td>
<td class="paramname"><em>p1</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the quadrant of a directed line segment from p0 to p1.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">IllegalArgumentException</td><td>if the points are equal </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a6c529bbdf9905b4c7abf59d1ef0cee33"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int geos::geom::Quadrant::NE = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="Quadrant_8h_source.html#l00054">54</a> of file <a class="el" href="Quadrant_8h_source.html">Quadrant.h</a>.</p>
</div>
</div>
<a class="anchor" id="a00cf8f2adfed97d896575f1fa4129b84"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int geos::geom::Quadrant::NW = 1</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="Quadrant_8h_source.html#l00055">55</a> of file <a class="el" href="Quadrant_8h_source.html">Quadrant.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad3b7ca38281b8333d75e98e57e5ebae4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int geos::geom::Quadrant::SE = 3</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="Quadrant_8h_source.html#l00057">57</a> of file <a class="el" href="Quadrant_8h_source.html">Quadrant.h</a>.</p>
</div>
</div>
<a class="anchor" id="abe04d5195ffe4b445388223a5d850f6b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int geos::geom::Quadrant::SW = 2</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="Quadrant_8h_source.html#l00056">56</a> of file <a class="el" href="Quadrant_8h_source.html">Quadrant.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Quadrant_8h_source.html">Quadrant.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>