geos_390_docs/RectangleContains_8h_source...

78 lines
21 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: RectangleContains.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_cc91dd2a378845bf7e3e6edb554afff8.html">operation</a></li><li class="navelem"><a class="el" href="dir_31b67544e64dbe20968ebff6dd254c98.html">predicate</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">RectangleContains.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="RectangleContains_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) 2006 Refractions Research Inc.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * This is free software; you can redistribute and/or modify it under</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * the terms of the GNU Lesser General Public Licence as published</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * by the Free Software Foundation.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * See the COPYING file for more information.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> *</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"> * Last port: operation/predicate/RectangleContains.java rev 1.5 (JTS-1.10)</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> *</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;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef GEOS_OP_PREDICATE_RECTANGLECONTAINS_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define GEOS_OP_PREDICATE_RECTANGLECONTAINS_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</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="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="Polygon_8h.html">geos/geom/Polygon.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>Envelope;</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>Point;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">class </span>Coordinate;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">class </span>LineString;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment">//class Polygon;</span></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>operation { <span class="comment">// geos::operation</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keyword">namespace </span>predicate { <span class="comment">// geos::operation::predicate</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classgeos_1_1operation_1_1predicate_1_1RectangleContains.html"> 51</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_1operation_1_1predicate_1_1RectangleContains.html">RectangleContains</a> {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classgeos_1_1operation_1_1predicate_1_1RectangleContains.html#a368a65b823f64a12f10279bd98ae5bf1"> 55</a></span>&#160; <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a>&amp; <a class="code" href="classgeos_1_1operation_1_1predicate_1_1RectangleContains.html#a368a65b823f64a12f10279bd98ae5bf1">rectEnv</a>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">bool</span> isContainedInBoundary(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a>&amp; geom);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">bool</span> isPointContainedInBoundary(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Point.html">geom::Point</a>&amp; geom);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordtype">bool</span> isPointContainedInBoundary(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>&amp; pt);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordtype">bool</span> isLineStringContainedInBoundary(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1LineString.html">geom::LineString</a>&amp; line);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordtype">bool</span> isLineSegmentContainedInBoundary(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>&amp; p0,</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>&amp; p1);</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"> 90</span>&#160;<span class="keyword">public</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="keyword">static</span> <span class="keywordtype">bool</span></div><div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="classgeos_1_1operation_1_1predicate_1_1RectangleContains.html#a9aceb571e52730765a233ac06f7bf34c"> 93</a></span>&#160; <a class="code" href="classgeos_1_1operation_1_1predicate_1_1RectangleContains.html#a9aceb571e52730765a233ac06f7bf34c">contains</a>(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Polygon.html">geom::Polygon</a>&amp; rect, <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a>&amp; b)</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; {</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <a class="code" href="classgeos_1_1operation_1_1predicate_1_1RectangleContains.html">RectangleContains</a> rc(rect);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordflow">return</span> rc.<a class="code" href="classgeos_1_1operation_1_1predicate_1_1RectangleContains.html#a9aceb571e52730765a233ac06f7bf34c">contains</a>(b);</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;</div><div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classgeos_1_1operation_1_1predicate_1_1RectangleContains.html#a3c5c3b5906d99167a0f74cd1f3525710"> 104</a></span>&#160; <a class="code" href="classgeos_1_1operation_1_1predicate_1_1RectangleContains.html#a3c5c3b5906d99167a0f74cd1f3525710">RectangleContains</a>(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Polygon.html">geom::Polygon</a>&amp; rect)</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; rectEnv(*(rect.getEnvelopeInternal()))</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; {}</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; <span class="keywordtype">bool</span> contains(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a>&amp; geom);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="comment">// Declare type as noncopyable</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <a class="code" href="classgeos_1_1operation_1_1predicate_1_1RectangleContains.html">RectangleContains</a>(<span class="keyword">const</span> <a class="code" href="classgeos_1_1operation_1_1predicate_1_1RectangleContains.html">RectangleContains</a>&amp; other) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <a class="code" href="classgeos_1_1operation_1_1predicate_1_1RectangleContains.html">RectangleContains</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="classgeos_1_1operation_1_1predicate_1_1RectangleContains.html">RectangleContains</a>&amp; rhs) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;};</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;} <span class="comment">// namespace geos::operation::predicate</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;} <span class="comment">// namespace geos::operation</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;} <span class="comment">// namespace geos</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;<span class="preprocessor">#endif // ifndef GEOS_OP_PREDICATE_RECTANGLECONTAINS_H</span></div><div class="ttc" id="classgeos_1_1operation_1_1predicate_1_1RectangleContains_html_a3c5c3b5906d99167a0f74cd1f3525710"><div class="ttname"><a href="classgeos_1_1operation_1_1predicate_1_1RectangleContains.html#a3c5c3b5906d99167a0f74cd1f3525710">geos::operation::predicate::RectangleContains::RectangleContains</a></div><div class="ttdeci">RectangleContains(const geom::Polygon &amp;rect)</div><div class="ttdef"><b>Definition:</b> <a href="RectangleContains_8h_source.html#l00104">RectangleContains.h:104</a></div></div>
<div class="ttc" id="classgeos_1_1geom_1_1Envelope_html"><div class="ttname"><a href="classgeos_1_1geom_1_1Envelope.html">geos::geom::Envelope</a></div><div class="ttdoc">An Envelope defines a rectangulare region of the 2D coordinate plane. </div><div class="ttdef"><b>Definition:</b> <a href="Envelope_8h_source.html#l00058">Envelope.h:58</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_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="classgeos_1_1operation_1_1predicate_1_1RectangleContains_html_a9aceb571e52730765a233ac06f7bf34c"><div class="ttname"><a href="classgeos_1_1operation_1_1predicate_1_1RectangleContains.html#a9aceb571e52730765a233ac06f7bf34c">geos::operation::predicate::RectangleContains::contains</a></div><div class="ttdeci">static bool contains(const geom::Polygon &amp;rect, const geom::Geometry &amp;b)</div><div class="ttdef"><b>Definition:</b> <a href="RectangleContains_8h_source.html#l00093">RectangleContains.h:93</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_1operation_1_1predicate_1_1RectangleContains_html_a368a65b823f64a12f10279bd98ae5bf1"><div class="ttname"><a href="classgeos_1_1operation_1_1predicate_1_1RectangleContains.html#a368a65b823f64a12f10279bd98ae5bf1">geos::operation::predicate::RectangleContains::rectEnv</a></div><div class="ttdeci">const geom::Envelope &amp; rectEnv</div><div class="ttdef"><b>Definition:</b> <a href="RectangleContains_8h_source.html#l00055">RectangleContains.h:55</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_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="Polygon_8h_html"><div class="ttname"><a href="Polygon_8h.html">Polygon.h</a></div></div>
<div class="ttc" id="classgeos_1_1operation_1_1predicate_1_1RectangleContains_html"><div class="ttname"><a href="classgeos_1_1operation_1_1predicate_1_1RectangleContains.html">geos::operation::predicate::RectangleContains</a></div><div class="ttdoc">Optimized implementation of spatial predicate &quot;contains&quot; for cases where the first Geometry is a rect...</div><div class="ttdef"><b>Definition:</b> <a href="RectangleContains_8h_source.html#l00051">RectangleContains.h:51</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><!-- 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>