<!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"/>
<title>GEOS: geos::index::quadtree::Key Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div 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 class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespacegeos.html">geos</a> </li>
<li><a class="el" href="namespacegeos_1_1index.html">index</a> </li>
<li><a class="el" href="namespacegeos_1_1index_1_1quadtree.html">quadtree</a> </li>
<li><a class="el" href="classgeos_1_1index_1_1quadtree_1_1Key.html">geos::index::quadtree::Key</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>geos::index::quadtree::Key Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="geos::index::quadtree::Key" -->
<p>A <a class="el" href="classgeos_1_1index_1_1quadtree_1_1Key.html" title="A Key is a unique identifier for a node in a quadtree.">Key</a> is a unique identifier for a node in a quadtree.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="quadtree_2Key_8h_source.html">Key.h</a>></code></p>
<p><a href="classgeos_1_1index_1_1quadtree_1_1Key-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f923811a1a2a60046f6657521638f68"></a><!-- doxytag: member="geos::index::quadtree::Key::Key" ref="a3f923811a1a2a60046f6657521638f68" args="(const geom::Envelope &itemEnv)" -->
</td><td class="memItemRight" valign="bottom"><b>Key</b> (const <a class="el" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a> &itemEnv)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a09ba2170001e680684e376735f51778d"></a><!-- doxytag: member="geos::index::quadtree::Key::getPoint" ref="a09ba2170001e680684e376735f51778d" args="() const " -->
const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1quadtree_1_1Key.html#a09ba2170001e680684e376735f51778d">getPoint</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returned object ownership retained by this class. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acda777d163fb1f202da54eb7f6c3761f"></a><!-- doxytag: member="geos::index::quadtree::Key::getLevel" ref="acda777d163fb1f202da54eb7f6c3761f" args="() const " -->
int </td><td class="memItemRight" valign="bottom"><b>getLevel</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0d1d55272bc534eb8b4bf50f4d51d01"></a><!-- doxytag: member="geos::index::quadtree::Key::getEnvelope" ref="aa0d1d55272bc534eb8b4bf50f4d51d01" args="() const " -->
const <a class="el" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1quadtree_1_1Key.html#aa0d1d55272bc534eb8b4bf50f4d51d01">getEnvelope</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returned object ownership retained by this class. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace42f08041ea29323dad3bc8572b919d"></a><!-- doxytag: member="geos::index::quadtree::Key::getCentre" ref="ace42f08041ea29323dad3bc8572b919d" args="() const " -->
<a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1quadtree_1_1Key.html#ace42f08041ea29323dad3bc8572b919d">getCentre</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns newly allocated object (ownership transferred). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1quadtree_1_1Key.html#a412ebe1ea7bd11123e57f9dd76cd6af8">computeKey</a> (const <a class="el" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a> &itemEnv)</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae105c63e49239bfb0fdd734abadb8d44"></a><!-- doxytag: member="geos::index::quadtree::Key::computeQuadLevel" ref="ae105c63e49239bfb0fdd734abadb8d44" args="(const geom::Envelope &env)" -->
static int </td><td class="memItemRight" valign="bottom"><b>computeQuadLevel</b> (const <a class="el" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a> &env)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A <a class="el" href="classgeos_1_1index_1_1quadtree_1_1Key.html" title="A Key is a unique identifier for a node in a quadtree.">Key</a> is a unique identifier for a node in a quadtree. </p>
<p>It contains a lower-left point and a level number. The level number is the power of two for the size of the node envelope </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a412ebe1ea7bd11123e57f9dd76cd6af8"></a><!-- doxytag: member="geos::index::quadtree::Key::computeKey" ref="a412ebe1ea7bd11123e57f9dd76cd6af8" args="(const geom::Envelope &itemEnv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void geos::index::quadtree::Key::computeKey </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a> & </td>
<td class="paramname"> <em>itemEnv</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return a square envelope containing the argument envelope, whose extent is a power of two and which is based at a power of 2 </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="quadtree_2Key_8h_source.html">quadtree/Key.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jul 22 2010 for GEOS by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
