303 lines
16 KiB
HTML
303 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::algorithm::PointLocation 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
|
|
 <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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related 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 List</span></a></li>
|
|
<li><a href="inherits.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"><a class="el" href="namespacegeos.html">geos</a></li><li class="navelem"><a class="el" href="namespacegeos_1_1algorithm.html">algorithm</a></li><li class="navelem"><a class="el" href="classgeos_1_1algorithm_1_1PointLocation.html">PointLocation</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="classgeos_1_1algorithm_1_1PointLocation-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">geos::algorithm::PointLocation Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Functions for locating points within basic geometric structures such as lines and rings.
|
|
<a href="classgeos_1_1algorithm_1_1PointLocation.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="PointLocation_8h_source.html">PointLocation.h</a>></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:a2abed39fcc482e285a9059cb07858724"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1algorithm_1_1PointLocation.html#a2abed39fcc482e285a9059cb07858724">isOnLine</a> (const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &p, const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> *line)</td></tr>
|
|
<tr class="memdesc:a2abed39fcc482e285a9059cb07858724"><td class="mdescLeft"> </td><td class="mdescRight">Tests whether a point lies on the line defined by a <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a>. <a href="#a2abed39fcc482e285a9059cb07858724">More...</a><br /></td></tr>
|
|
<tr class="separator:a2abed39fcc482e285a9059cb07858724"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab898539922fb5340b0037e46a6299447"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1algorithm_1_1PointLocation.html#ab898539922fb5340b0037e46a6299447">isInRing</a> (const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &p, const std::vector< const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> * > &ring)</td></tr>
|
|
<tr class="memdesc:ab898539922fb5340b0037e46a6299447"><td class="mdescLeft"> </td><td class="mdescRight">Tests whether a point lies inside or on a ring. <a href="#ab898539922fb5340b0037e46a6299447">More...</a><br /></td></tr>
|
|
<tr class="separator:ab898539922fb5340b0037e46a6299447"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b9d8f5d196e42c9089933f00d899b99"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1algorithm_1_1PointLocation.html#a7b9d8f5d196e42c9089933f00d899b99">isInRing</a> (const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &p, const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> *ring)</td></tr>
|
|
<tr class="separator:a7b9d8f5d196e42c9089933f00d899b99"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a39f02ccaddb0aba0753eb3a64b9adb39"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8">geom::Location</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1algorithm_1_1PointLocation.html#a39f02ccaddb0aba0753eb3a64b9adb39">locateInRing</a> (const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &p, const std::vector< const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> * > &ring)</td></tr>
|
|
<tr class="memdesc:a39f02ccaddb0aba0753eb3a64b9adb39"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a point lies in the interior, on the boundary, or in the exterior of a ring. The ring may be oriented in either direction. <a href="#a39f02ccaddb0aba0753eb3a64b9adb39">More...</a><br /></td></tr>
|
|
<tr class="separator:a39f02ccaddb0aba0753eb3a64b9adb39"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c961455f5abfae731ac229b914e5618"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8">geom::Location</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1algorithm_1_1PointLocation.html#a4c961455f5abfae731ac229b914e5618">locateInRing</a> (const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &p, const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> &ring)</td></tr>
|
|
<tr class="separator:a4c961455f5abfae731ac229b914e5618"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Functions for locating points within basic geometric structures such as lines and rings. </p>
|
|
<dl class="section author"><dt>Author</dt><dd>Martin Davis </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="PointLocation_8h_source.html#l00037">37</a> of file <a class="el" href="PointLocation_8h_source.html">PointLocation.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="ab898539922fb5340b0037e46a6299447"></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::algorithm::PointLocation::isInRing </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> & </td>
|
|
<td class="paramname"><em>p</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> * > & </td>
|
|
<td class="paramname"><em>ring</em> </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>Tests whether a point lies inside or on a ring. </p>
|
|
<p>The ring may be oriented in either direction. A point lying exactly on the ring boundary is considered to be inside the ring.</p>
|
|
<p>This method does <b>not</b> first check the point against the envelope of the ring.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">p</td><td>point to check for ring inclusion </td></tr>
|
|
<tr><td class="paramname">ring</td><td>an array of coordinates representing the ring (which must have first point identical to last point) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if p is inside ring</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classgeos_1_1algorithm_1_1RayCrossingCounter.html#aad834286a28d2fbd6c6459d7155f960a" title="Determines the Location of a point in a ring. ">RayCrossingCounter::locatePointInRing()</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7b9d8f5d196e42c9089933f00d899b99"></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::algorithm::PointLocation::isInRing </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> & </td>
|
|
<td class="paramname"><em>p</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> * </td>
|
|
<td class="paramname"><em>ring</em> </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="a2abed39fcc482e285a9059cb07858724"></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::algorithm::PointLocation::isOnLine </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> & </td>
|
|
<td class="paramname"><em>p</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> * </td>
|
|
<td class="paramname"><em>line</em> </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>Tests whether a point lies on the line defined by a <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">p</td><td>the point to test </td></tr>
|
|
<tr><td class="paramname">line</td><td>the line coordinates </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if the point is a vertex of the line or lies in the interior of a line segment in the line </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a39f02ccaddb0aba0753eb3a64b9adb39"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8">geom::Location</a> geos::algorithm::PointLocation::locateInRing </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> & </td>
|
|
<td class="paramname"><em>p</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> * > & </td>
|
|
<td class="paramname"><em>ring</em> </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>Determines whether a point lies in the interior, on the boundary, or in the exterior of a ring. The ring may be oriented in either direction. </p>
|
|
<p>This method does <em>not</em> first check the point against the envelope of the ring.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">p</td><td>point to check for ring inclusion </td></tr>
|
|
<tr><td class="paramname">ring</td><td>an array of coordinates representing the ring (which must have first point identical to last point) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>the <a class="el" href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8">Location</a> of p relative to the ring </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4c961455f5abfae731ac229b914e5618"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8">geom::Location</a> geos::algorithm::PointLocation::locateInRing </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> & </td>
|
|
<td class="paramname"><em>p</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> & </td>
|
|
<td class="paramname"><em>ring</em> </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>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="PointLocation_8h_source.html">PointLocation.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.11
|
|
</small></address>
|
|
</body>
|
|
</html>
|