75 lines
18 KiB
HTML
75 lines
18 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: Key.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
|
|
 <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><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 List</span></a></li>
|
|
<li><a href="globals.html"><span>File 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_c01eee2f0195f7c921c8a1b68ed5e74c.html">index</a></li><li class="navelem"><a class="el" href="dir_e5230be7d14949f043691ce046034782.html">quadtree</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">quadtree/Key.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="quadtree_2Key_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> <span class="comment">/**********************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * GEOS - Geometry Engine Open Source</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * http://geos.osgeo.org</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Copyright (C) 2009 Sandro Santilli <strk@kbt.io></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Copyright (C) 2006 Refractions Research Inc.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * Copyright (C) 2001-2002 Vivid Solutions Inc.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * This is free software; you can redistribute and/or modify it under</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * the terms of the GNU Lesser General Public Licence as published</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * by the Free Software Foundation.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * See the COPYING file for more information.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> **********************************************************************</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * Last port: index/quadtree/Key.java rev 1.8 (JTS-1.10)</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> **********************************************************************/</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef GEOS_IDX_QUADTREE_KEY_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define GEOS_IDX_QUADTREE_KEY_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="code" href="export_8h.html">geos/export.h</a>></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="code" href="Coordinate_8h.html">geos/geom/Coordinate.h</a>></span> <span class="comment">// for composition</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="Envelope_8h.html">geos/geom/Envelope.h</a>></span> <span class="comment">// for composition</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// Forward declarations</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// ...</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="namespacegeos.html">geos</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span>index { <span class="comment">// geos::index</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">namespace </span>quadtree { <span class="comment">// geos::index::quadtree</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classgeos_1_1index_1_1quadtree_1_1Key.html"> 42</a></span> <span class="keyword">class </span><a class="code" href="export_8h.html#ae36df939090171f6e9a28a8cb6254fea">GEOS_DLL</a> <a class="code" href="classgeos_1_1index_1_1quadtree_1_1Key.html">Key</a> {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// Doesn't touch the Envelope, might as well be const</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">static</span> <span class="keywordtype">int</span> computeQuadLevel(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a>& env);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// Reference to argument won't be used after construction</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classgeos_1_1index_1_1quadtree_1_1Key.html">Key</a>(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a>& itemEnv);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// used to be virtual, but I don't see subclasses...</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  ~<a class="code" href="classgeos_1_1index_1_1quadtree_1_1Key.html">Key</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>& getPoint() <span class="keyword">const</span>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">int</span> getLevel() <span class="keyword">const</span>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a>& getEnvelope() <span class="keyword">const</span>;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>* getCentre() <span class="keyword">const</span>;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">void</span> computeKey(<span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a>& itemEnv);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// the fields which make up the key</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// Owned by this class</span></div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="classgeos_1_1index_1_1quadtree_1_1Key.html#ab760845f2cac30f7b840f47328a5f685"> 75</a></span>  <a class="code" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> <a class="code" href="classgeos_1_1index_1_1quadtree_1_1Key.html#ab760845f2cac30f7b840f47328a5f685">pt</a>;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classgeos_1_1index_1_1quadtree_1_1Key.html#a58fece7ac96c4ded1b7152fa8c187c56"> 77</a></span>  <span class="keywordtype">int</span> <a class="code" href="classgeos_1_1index_1_1quadtree_1_1Key.html#a58fece7ac96c4ded1b7152fa8c187c56">level</a>;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">// auxiliary data which is derived from the key for use in computation</span></div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="classgeos_1_1index_1_1quadtree_1_1Key.html#a3ca12485f0e1900944d2a6d4a188f131"> 80</a></span>  <a class="code" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a> <a class="code" href="classgeos_1_1index_1_1quadtree_1_1Key.html#a3ca12485f0e1900944d2a6d4a188f131">env</a>;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">void</span> computeKey(<span class="keywordtype">int</span> level, <span class="keyword">const</span> <a class="code" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a>& itemEnv);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> };</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> } <span class="comment">// namespace geos::index::quadtree</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> } <span class="comment">// namespace geos::index</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> } <span class="comment">// namespace geos</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#endif // GEOS_IDX_QUADTREE_KEY_H</span></div><div class="ttc" id="classgeos_1_1index_1_1quadtree_1_1Key_html"><div class="ttname"><a href="classgeos_1_1index_1_1quadtree_1_1Key.html">geos::index::quadtree::Key</a></div><div class="ttdoc">A Key is a unique identifier for a node in a quadtree. </div><div class="ttdef"><b>Definition:</b> <a href="quadtree_2Key_8h_source.html#l00042">quadtree/Key.h:42</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="classgeos_1_1index_1_1quadtree_1_1Key_html_a3ca12485f0e1900944d2a6d4a188f131"><div class="ttname"><a href="classgeos_1_1index_1_1quadtree_1_1Key.html#a3ca12485f0e1900944d2a6d4a188f131">geos::index::quadtree::Key::env</a></div><div class="ttdeci">geom::Envelope env</div><div class="ttdef"><b>Definition:</b> <a href="quadtree_2Key_8h_source.html#l00080">quadtree/Key.h:80</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_1index_1_1quadtree_1_1Key_html_ab760845f2cac30f7b840f47328a5f685"><div class="ttname"><a href="classgeos_1_1index_1_1quadtree_1_1Key.html#ab760845f2cac30f7b840f47328a5f685">geos::index::quadtree::Key::pt</a></div><div class="ttdeci">geom::Coordinate pt</div><div class="ttdef"><b>Definition:</b> <a href="quadtree_2Key_8h_source.html#l00075">quadtree/Key.h:75</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="Envelope_8h_html"><div class="ttname"><a href="Envelope_8h.html">Envelope.h</a></div></div>
|
|
<div class="ttc" id="Coordinate_8h_html"><div class="ttname"><a href="Coordinate_8h.html">Coordinate.h</a></div></div>
|
|
<div class="ttc" id="classgeos_1_1index_1_1quadtree_1_1Key_html_a58fece7ac96c4ded1b7152fa8c187c56"><div class="ttname"><a href="classgeos_1_1index_1_1quadtree_1_1Key.html#a58fece7ac96c4ded1b7152fa8c187c56">geos::index::quadtree::Key::level</a></div><div class="ttdeci">int level</div><div class="ttdef"><b>Definition:</b> <a href="quadtree_2Key_8h_source.html#l00077">quadtree/Key.h:77</a></div></div>
|
|
</div><!-- fragment --></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>
|