boost/geometry
2
0
Fork 0
mirror of https://github.com/boostorg/geometry.git synced 2026-02-14 12:52:09 +00:00
Code Issues Projects Releases Wiki Activity
Files
a6dec17e20fbc6d4eafef3596060da4dff9fa48f
geometry/doc/doxygen_output/html/group__intersects.html
Barend Gehrels 363580fbf6 Added old doxygen docs 
[SVN r59777]
2010-02-20 15:57:12 +00:00

173 lines
8.1 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Boost.Geometry (aka GGL, Generic Geometry Library)</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<table cellpadding="2" width="100%">
<tbody>
<tr>
<td valign="top">
<img alt="Boost.Geometry" src="images/ggl-logo-big.png" height="80" width="200">
&nbsp;&nbsp;
</td>
<td valign="top" align="right">
<a href="http://www.boost.org">
<img alt="Boost C++ Libraries" src="images/accepted_by_boost.png" height="80" width="230" border="0">
</a>
</td>
</tr>
</tbody>
</table>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>intersects: detect if a geometry self-intersects or if two geometries intersect</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename Geometry1 , typename Geometry2 &gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__intersects.html#gc04415b986998e25000ce69fd9804e2d">boost::geometry::intersects</a> (Geometry1 const &amp;geometry1, Geometry2 const &amp;geometry2)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determine if there is at least one intersection. <a href="#gc04415b986998e25000ce69fd9804e2d"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename Geometry &gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__intersects.html#g24d9754b52dce625f3e3cfafb9c3957b">boost::geometry::intersects</a> (Geometry const &amp;geometry)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determine if there is at least one intersection (crossing or self-tangency). <a href="#g24d9754b52dce625f3e3cfafb9c3957b"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<dl class="user" compact><dt><b>Source descriptions:</b></dt><dd><ul>
<li>OGC description: Returns 1 (TRUE) if this geometric object spatially intersects anotherGeometry.</li><li>OGC: a.Intersects(b) &lt;=&gt; ! a.Disjoint(b) </li></ul>
</dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>There are two overloaded versions:<ul>
<li>with one geometry, detecting self-intersections</li><li>with two geometries, deferring to disjoint, returning !disjoint</li></ul>
</dd></dl>
<dl class="user" compact><dt><b>Geometries:</b></dt><dd><ul>
<li><b>ring</b> </li><li><b>polygon</b> </li><li>for two geometries: same is disjoint</li></ul>
</dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>if one geometry is completely within another geometry, it "intersects" </dd></dl>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g24d9754b52dce625f3e3cfafb9c3957b"></a><!-- doxytag: member="boost::geometry::intersects" ref="g24d9754b52dce625f3e3cfafb9c3957b" args="(Geometry const &amp;geometry)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Geometry &gt; </div>
<table class="memname">
<tr>
<td class="memname">bool boost::geometry::intersects </td>
<td>(</td>
<td class="paramtype">Geometry const &amp;&nbsp;</td>
<td class="paramname"> <em>geometry</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Determine if there is at least one intersection (crossing or self-tangency).
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>This function can be called for one <a class="el" href="namespaceboost_1_1geometry.html">geometry</a> (self-intersection) and also for two geometries (intersection)</dd></dl>
<dl compact><dt><b>Template Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Geometry</em>&nbsp;</td><td><a class="el" href="namespaceboost_1_1geometry.html">geometry</a> type </td></tr>
</table>
</dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="namespaceboost_1_1geometry.html">geometry</a></em>&nbsp;</td><td><a class="el" href="namespaceboost_1_1geometry.html">geometry</a> </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if there are intersections, else false </dd></dl>
<p>Definition at line <a class="el" href="intersects_8hpp_source.html#l00060">60</a> of file <a class="el" href="intersects_8hpp_source.html">intersects.hpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="gc04415b986998e25000ce69fd9804e2d"></a><!-- doxytag: member="boost::geometry::intersects" ref="gc04415b986998e25000ce69fd9804e2d" args="(Geometry1 const &amp;geometry1, Geometry2 const &amp;geometry2)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Geometry1 , typename Geometry2 &gt; </div>
<table class="memname">
<tr>
<td class="memname">bool boost::geometry::intersects </td>
<td>(</td>
<td class="paramtype">Geometry1 const &amp;&nbsp;</td>
<td class="paramname"> <em>geometry1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Geometry2 const &amp;&nbsp;</td>
<td class="paramname"> <em>geometry2</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Determine if there is at least one intersection.
<p>
<dl compact><dt><b>Template Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Geometry1</em>&nbsp;</td><td>first <a class="el" href="namespaceboost_1_1geometry.html">geometry</a> type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Geometry2</em>&nbsp;</td><td>second <a class="el" href="namespaceboost_1_1geometry.html">geometry</a> type </td></tr>
</table>
</dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>geometry1</em>&nbsp;</td><td>first <a class="el" href="namespaceboost_1_1geometry.html">geometry</a> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>geometry2</em>&nbsp;</td><td>second <a class="el" href="namespaceboost_1_1geometry.html">geometry</a> </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if there are intersection(s), else false </dd></dl>
<p>Definition at line <a class="el" href="intersects_8hpp_source.html#l00101">101</a> of file <a class="el" href="intersects_8hpp_source.html">intersects.hpp</a>.</p>
</div>
</div><p>
</div>
<hr size="1">
<table width="100%">
<tbody>
<tr>
<td align="left"><small>
<p>December 1, 2009</p>
</small></td>
<td align="right">
<small>Copyright © 1995-2009 Barend Gehrels, Geodan, Amsterdam<br>
Copyright © 2008-2009 Bruno Lalande, Paris<br>
Copyright © 2009 Mateusz Loskot, Cadcorp, London<br>
</small>
</td>
</tr>
</tbody>
</table>
<address style="text-align: right;"><small>
Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink