<!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::geom::prep::PreparedPolygonContainsProperly 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_1geom.html">geom</a> </li> <li><b>prep</b> </li> <li><a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedPolygonContainsProperly.html">geos::geom::prep::PreparedPolygonContainsProperly</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::geom::prep::PreparedPolygonContainsProperly Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="geos::geom::prep::PreparedPolygonContainsProperly" --><!-- doxytag: inherits="geos::geom::prep::PreparedPolygonPredicate" --> <p>Computes the <code>containsProperly</code> spatial relationship predicate for <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedPolygon.html">PreparedPolygon</a>s relative to all other <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> classes. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="PreparedPolygonContainsProperly_8h_source.html">PreparedPolygonContainsProperly.h</a>></code></p> <div class="dynheader"> Inheritance diagram for geos::geom::prep::PreparedPolygonContainsProperly:</div> <div class="dyncontent"> <div class="center"> <img src="classgeos_1_1geom_1_1prep_1_1PreparedPolygonContainsProperly.png" usemap="#geos::geom::prep::PreparedPolygonContainsProperly_map" alt=""/> <map id="geos::geom::prep::PreparedPolygonContainsProperly_map" name="geos::geom::prep::PreparedPolygonContainsProperly_map"> <area href="classgeos_1_1geom_1_1prep_1_1PreparedPolygonPredicate.html" alt="geos::geom::prep::PreparedPolygonPredicate" shape="rect" coords="0,0,310,24"/> </map> </div> <p><a href="classgeos_1_1geom_1_1prep_1_1PreparedPolygonContainsProperly-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedPolygonContainsProperly.html#ab60e2d24a82cd44c7b86b5ca838a804f">PreparedPolygonContainsProperly</a> (const <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedPolygon.html">PreparedPolygon</a> *const prep)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedPolygonContainsProperly.html#a0cf8039a02d6d332ed7ef2c149d339fe">containsProperly</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *geom)</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">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedPolygonContainsProperly.html#ab7bc9a0d4d55d178349fd6810909fcc4">containsProperly</a> (const <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedPolygon.html">PreparedPolygon</a> *const prep, const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *geom)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Computes the <code>containsProperly</code> spatial relationship predicate for <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedPolygon.html">PreparedPolygon</a>s relative to all other <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> classes. </p> <p>Uses short-circuit tests and indexing to improve performance.</p> <p>A <a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">Geometry</a> A <code>containsProperly</code> another <a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">Geometry</a> B iff all points of B are contained in the Interior of A. Equivalently, B is contained in A AND B does not intersect the Boundary of A.</p> <p>The advantage to using this predicate is that it can be computed efficiently, with no need to compute topology at individual points. In a situation with many geometries intersecting the boundary of the target geometry, this can make a performance difference.</p> <dl class="author"><dt><b>Author:</b></dt><dd>Martin Davis </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ab60e2d24a82cd44c7b86b5ca838a804f"></a><!-- doxytag: member="geos::geom::prep::PreparedPolygonContainsProperly::PreparedPolygonContainsProperly" ref="ab60e2d24a82cd44c7b86b5ca838a804f" args="(const PreparedPolygon *const prep)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">geos::geom::prep::PreparedPolygonContainsProperly::PreparedPolygonContainsProperly </td> <td>(</td> <td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedPolygon.html">PreparedPolygon</a> *const </td> <td class="paramname"> <em>prep</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Creates an instance of this operation.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>prepPoly</em> </td><td>the <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedPolygon.html" title="A prepared version of Polygon or MultiPolygon geometries.">PreparedPolygon</a> to evaluate </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ab7bc9a0d4d55d178349fd6810909fcc4"></a><!-- doxytag: member="geos::geom::prep::PreparedPolygonContainsProperly::containsProperly" ref="ab7bc9a0d4d55d178349fd6810909fcc4" args="(const PreparedPolygon *const prep, const geom::Geometry *geom)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static bool geos::geom::prep::PreparedPolygonContainsProperly::containsProperly </td> <td>(</td> <td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedPolygon.html">PreparedPolygon</a> *const </td> <td class="paramname"> <em>prep</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> * </td> <td class="paramname"> <em>geom</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline, static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Computes the containsProperly predicate between a <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedPolygon.html">PreparedPolygon</a> and a <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a>.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>prep</em> </td><td>the prepared polygon </td></tr> <tr><td valign="top"></td><td valign="top"><em>geom</em> </td><td>a test geometry </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>true if the polygon properly contains the geometry </dd></dl> <p>References <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedPolygonContainsProperly.html#ab7bc9a0d4d55d178349fd6810909fcc4">containsProperly()</a>.</p> <p>Referenced by <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedPolygonContainsProperly.html#ab7bc9a0d4d55d178349fd6810909fcc4">containsProperly()</a>.</p> </div> </div> <a class="anchor" id="a0cf8039a02d6d332ed7ef2c149d339fe"></a><!-- doxytag: member="geos::geom::prep::PreparedPolygonContainsProperly::containsProperly" ref="a0cf8039a02d6d332ed7ef2c149d339fe" args="(const geom::Geometry *geom)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool geos::geom::prep::PreparedPolygonContainsProperly::containsProperly </td> <td>(</td> <td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> * </td> <td class="paramname"> <em>geom</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Tests whether this <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedPolygon.html" title="A prepared version of Polygon or MultiPolygon geometries.">PreparedPolygon</a> containsProperly a given geometry.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>geom</em> </td><td>the test geometry </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>true if the test geometry is contained properly </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="PreparedPolygonContainsProperly_8h_source.html">PreparedPolygonContainsProperly.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>