geos_390_docs/PointLocator_8h_source.html

82 lines
22 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: PointLocator.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0bc14b2fb119a11b6a0f32f4d350db61.html">geos</a></li><li class="navelem"><a class="el" href="dir_fba022f40ef995f34b1af53ee3c8dd03.html">algorithm</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">PointLocator.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="PointLocator_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/**********************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * GEOS - Geometry Engine Open Source</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * http://geos.osgeo.org</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * Copyright (C) 2005-2011 Refractions Research Inc.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Copyright (C) 2001-2002 Vivid Solutions Inc.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * This is free software; you can redistribute and/or modify it under</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * the terms of the GNU Lesser General Public Licence as published</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * by the Free Software Foundation.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * See the COPYING file for more information.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> **********************************************************************</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * Last port: algorithm/PointLocator.java 95fbe34b (JTS-1.15.2-SNAPSHOT)</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> **********************************************************************/</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifndef GEOS_ALGORITHM_POINTLOCATOR_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define GEOS_ALGORITHM_POINTLOCATOR_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="export_8h.html">geos/export.h</a>&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="Location_8h.html">geos/geom/Location.h</a>&gt;</span> <span class="comment">// for inlines</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment">// Forward declarations</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegeos.html">geos</a> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">namespace </span>geom {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">class </span>Coordinate;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">class </span>Geometry;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">class </span>LinearRing;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">class </span>LineString;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">class </span>Polygon;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">class </span>Point;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;}</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;}</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegeos.html">geos</a> {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="keyword">namespace </span>algorithm { <span class="comment">// geos::algorithm</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classgeos_1_1algorithm_1_1PointLocator.html"> 57</a></span>&#160;<span class="keyword">class </span><a class="code" href="export_8h.html#ae36df939090171f6e9a28a8cb6254fea">GEOS_DLL</a> <a class="code" href="classgeos_1_1algorithm_1_1PointLocator.html">PointLocator</a> {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classgeos_1_1algorithm_1_1PointLocator.html#a53e356dc338f66ac4a36d6122bd81267"> 59</a></span>&#160; <a class="code" href="classgeos_1_1algorithm_1_1PointLocator.html#a53e356dc338f66ac4a36d6122bd81267">PointLocator</a>() {}</div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classgeos_1_1algorithm_1_1PointLocator.html#a0d33972ddead8c35ffe7f175b344dda2"> 60</a></span>&#160; <a class="code" href="classgeos_1_1algorithm_1_1PointLocator.html#a0d33972ddead8c35ffe7f175b344dda2">~PointLocator</a>() {}</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <a class="code" href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8">geom::Location</a> locate(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>&amp; p, <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a>* geom);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordtype">bool</span></div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classgeos_1_1algorithm_1_1PointLocator.html#aa1b29c8c5eb9d5a9e28a597e37de8601"> 81</a></span>&#160; <a class="code" href="classgeos_1_1algorithm_1_1PointLocator.html#aa1b29c8c5eb9d5a9e28a597e37de8601">intersects</a>(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>&amp; p, <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a>* geom)</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; {</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordflow">return</span> locate(p, geom) != <a class="code" href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8a275ff52c0d43ea11e057b037be21d30e">geom::Location::EXTERIOR</a>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; }</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="classgeos_1_1algorithm_1_1PointLocator.html#a9ca5438c5775feee2accc1eb0104ec62"> 88</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classgeos_1_1algorithm_1_1PointLocator.html#a9ca5438c5775feee2accc1eb0104ec62">isIn</a>; <span class="comment">// true if the point lies in or on any Geometry element</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="classgeos_1_1algorithm_1_1PointLocator.html#a68d85cb4241ceacc55bb0a036952f352"> 90</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classgeos_1_1algorithm_1_1PointLocator.html#a68d85cb4241ceacc55bb0a036952f352">numBoundaries</a>; <span class="comment">// the number of sub-elements whose boundaries the point lies in</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordtype">void</span> computeLocation(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>&amp; p, <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a>* geom);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordtype">void</span> updateLocationInfo(<a class="code" href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8">geom::Location</a> loc);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <a class="code" href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8">geom::Location</a> locate(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>&amp; p, <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Point.html">geom::Point</a>* pt);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <a class="code" href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8">geom::Location</a> locate(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>&amp; p, <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1LineString.html">geom::LineString</a>* l);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <a class="code" href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8">geom::Location</a> locateInPolygonRing(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>&amp; p, <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1LinearRing.html">geom::LinearRing</a>* ring);</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <a class="code" href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8">geom::Location</a> locate(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>&amp; p, <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Polygon.html">geom::Polygon</a>* poly);</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;};</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;} <span class="comment">// namespace geos::algorithm</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;} <span class="comment">// namespace geos</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="preprocessor">#endif // GEOS_ALGORITHM_POINTLOCATOR_H</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;</div><div class="ttc" id="classgeos_1_1algorithm_1_1PointLocator_html_a68d85cb4241ceacc55bb0a036952f352"><div class="ttname"><a href="classgeos_1_1algorithm_1_1PointLocator.html#a68d85cb4241ceacc55bb0a036952f352">geos::algorithm::PointLocator::numBoundaries</a></div><div class="ttdeci">int numBoundaries</div><div class="ttdef"><b>Definition:</b> <a href="PointLocator_8h_source.html#l00090">PointLocator.h:90</a></div></div>
<div class="ttc" id="classgeos_1_1algorithm_1_1PointLocator_html_aa1b29c8c5eb9d5a9e28a597e37de8601"><div class="ttname"><a href="classgeos_1_1algorithm_1_1PointLocator.html#aa1b29c8c5eb9d5a9e28a597e37de8601">geos::algorithm::PointLocator::intersects</a></div><div class="ttdeci">bool intersects(const geom::Coordinate &amp;p, const geom::Geometry *geom)</div><div class="ttdef"><b>Definition:</b> <a href="PointLocator_8h_source.html#l00081">PointLocator.h:81</a></div></div>
<div class="ttc" id="export_8h_html_ae36df939090171f6e9a28a8cb6254fea"><div class="ttname"><a href="export_8h.html#ae36df939090171f6e9a28a8cb6254fea">GEOS_DLL</a></div><div class="ttdeci">#define GEOS_DLL</div><div class="ttdef"><b>Definition:</b> <a href="export_8h_source.html#l00028">export.h:28</a></div></div>
<div class="ttc" id="classgeos_1_1algorithm_1_1PointLocator_html_a9ca5438c5775feee2accc1eb0104ec62"><div class="ttname"><a href="classgeos_1_1algorithm_1_1PointLocator.html#a9ca5438c5775feee2accc1eb0104ec62">geos::algorithm::PointLocator::isIn</a></div><div class="ttdeci">bool isIn</div><div class="ttdef"><b>Definition:</b> <a href="PointLocator_8h_source.html#l00088">PointLocator.h:88</a></div></div>
<div class="ttc" id="classgeos_1_1geom_1_1Coordinate_html"><div class="ttname"><a href="classgeos_1_1geom_1_1Coordinate.html">geos::geom::Coordinate</a></div><div class="ttdoc">Coordinate is the lightweight class used to store coordinates. </div><div class="ttdef"><b>Definition:</b> <a href="Coordinate_8h_source.html#l00060">Coordinate.h:60</a></div></div>
<div class="ttc" id="export_8h_html"><div class="ttname"><a href="export_8h.html">export.h</a></div></div>
<div class="ttc" id="namespacegeos_1_1geom_html_ae55a225cd843a6b153a7b6ca5a4707c8a275ff52c0d43ea11e057b037be21d30e"><div class="ttname"><a href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8a275ff52c0d43ea11e057b037be21d30e">geos::geom::Location::EXTERIOR</a></div></div>
<div class="ttc" id="classgeos_1_1algorithm_1_1PointLocator_html"><div class="ttname"><a href="classgeos_1_1algorithm_1_1PointLocator.html">geos::algorithm::PointLocator</a></div><div class="ttdoc">Computes the topological relationship (Location) of a single point to a Geometry. ...</div><div class="ttdef"><b>Definition:</b> <a href="PointLocator_8h_source.html#l00057">PointLocator.h:57</a></div></div>
<div class="ttc" id="classgeos_1_1geom_1_1Geometry_html"><div class="ttname"><a href="classgeos_1_1geom_1_1Geometry.html">geos::geom::Geometry</a></div><div class="ttdoc">Basic implementation of Geometry, constructed and destructed by GeometryFactory. </div><div class="ttdef"><b>Definition:</b> <a href="Geometry_8h_source.html#l00188">Geometry.h:188</a></div></div>
<div class="ttc" id="classgeos_1_1algorithm_1_1PointLocator_html_a53e356dc338f66ac4a36d6122bd81267"><div class="ttname"><a href="classgeos_1_1algorithm_1_1PointLocator.html#a53e356dc338f66ac4a36d6122bd81267">geos::algorithm::PointLocator::PointLocator</a></div><div class="ttdeci">PointLocator()</div><div class="ttdef"><b>Definition:</b> <a href="PointLocator_8h_source.html#l00059">PointLocator.h:59</a></div></div>
<div class="ttc" id="classgeos_1_1geom_1_1LineString_html"><div class="ttname"><a href="classgeos_1_1geom_1_1LineString.html">geos::geom::LineString</a></div><div class="ttdef"><b>Definition:</b> <a href="LineString_8h_source.html#l00068">LineString.h:68</a></div></div>
<div class="ttc" id="classgeos_1_1geom_1_1Polygon_html"><div class="ttname"><a href="classgeos_1_1geom_1_1Polygon.html">geos::geom::Polygon</a></div><div class="ttdoc">Represents a linear polygon, which may include holes. </div><div class="ttdef"><b>Definition:</b> <a href="Polygon_8h_source.html#l00064">Polygon.h:64</a></div></div>
<div class="ttc" id="namespacegeos_1_1geom_html_ae55a225cd843a6b153a7b6ca5a4707c8"><div class="ttname"><a href="namespacegeos_1_1geom.html#ae55a225cd843a6b153a7b6ca5a4707c8">geos::geom::Location</a></div><div class="ttdeci">Location</div><div class="ttdoc">Constants representing the location of a point relative to a geometry. </div><div class="ttdef"><b>Definition:</b> <a href="Location_8h_source.html#l00034">Location.h:34</a></div></div>
<div class="ttc" id="classgeos_1_1algorithm_1_1PointLocator_html_a0d33972ddead8c35ffe7f175b344dda2"><div class="ttname"><a href="classgeos_1_1algorithm_1_1PointLocator.html#a0d33972ddead8c35ffe7f175b344dda2">geos::algorithm::PointLocator::~PointLocator</a></div><div class="ttdeci">~PointLocator()</div><div class="ttdef"><b>Definition:</b> <a href="PointLocator_8h_source.html#l00060">PointLocator.h:60</a></div></div>
<div class="ttc" id="namespacegeos_html"><div class="ttname"><a href="namespacegeos.html">geos</a></div><div class="ttdoc">Basic namespace for all GEOS functionalities. </div><div class="ttdef"><b>Definition:</b> <a href="IndexedNestedRingTester_8h_source.html#l00026">IndexedNestedRingTester.h:26</a></div></div>
<div class="ttc" id="classgeos_1_1geom_1_1LinearRing_html"><div class="ttname"><a href="classgeos_1_1geom_1_1LinearRing.html">geos::geom::LinearRing</a></div><div class="ttdoc">Models an OGC SFS LinearRing. A LinearRing is a LineString which is both closed and simple...</div><div class="ttdef"><b>Definition:</b> <a href="LinearRing_8h_source.html#l00054">LinearRing.h:54</a></div></div>
<div class="ttc" id="classgeos_1_1geom_1_1Point_html"><div class="ttname"><a href="classgeos_1_1geom_1_1Point.html">geos::geom::Point</a></div><div class="ttdef"><b>Definition:</b> <a href="Point_8h_source.html#l00066">Point.h:66</a></div></div>
<div class="ttc" id="Location_8h_html"><div class="ttname"><a href="Location_8h.html">Location.h</a></div></div>
</div><!-- fragment --></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>