libs/geometry/doc/doxy/doxygen_output/html_by_doxygen/group__intersects.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   5 <title>Boost.Geometry (aka GGL, Generic Geometry Library)</title>
   6 <link href="doxygen.css" rel="stylesheet" type="text/css">
   7 <link href="tabs.css" rel="stylesheet" type="text/css">
   8 </head>
   9 <table cellpadding="2" width="100%">
  10 <tbody>
  11 <tr>
  12 <td valign="top">
  13 <img alt="Boost.Geometry" src="images/ggl-logo-big.png" height="80" width="200">
  14 &nbsp;&nbsp;
  15 </td>
  16 <td valign="top" align="right">
  17 <a href="http://www.boost.org">
  18 <img alt="Boost C++ Libraries" src="images/accepted_by_boost.png" height="80" width="230" border="0">
  19 </a>
  20 </td>
  21 </tr>
  22 </tbody>
  23 </table>
  24 <!-- Generated by Doxygen 1.8.6 -->
  25   <div id="navrow1" class="tabs">
  26     <ul class="tablist">
  27       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  28       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  29       <li><a href="modules.html"><span>Modules</span></a></li>
  30       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  31       <li><a href="annotated.html"><span>Classes</span></a></li>
  32       <li><a href="files.html"><span>Files</span></a></li>
  33       <li><a href="examples.html"><span>Examples</span></a></li>
  34     </ul>
  35   </div>
  36 </div><!-- top -->
  37 <div class="header">
  38   <div class="summary">
  39 <a href="#func-members">Functions</a>  </div>
  40   <div class="headertitle">
  41 <div class="title">intersects: detect if a geometry self-intersects or if two geometries intersect</div>  </div>
  42 </div><!--header-->
  43 <div class="contents">
  44 <table class="memberdecls">
  45 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  46 Functions</h2></td></tr>
  47 <tr class="memitem:gacc0c6eb239493fc30afd057d7d56bb11"><td class="memTemplParams" colspan="2">template&lt;typename Geometry &gt; </td></tr>
  48 <tr class="memitem:gacc0c6eb239493fc30afd057d7d56bb11"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__intersects.html#gacc0c6eb239493fc30afd057d7d56bb11">boost::geometry::intersects</a> (Geometry const &amp;geometry)</td></tr>
  49 <tr class="memdesc:gacc0c6eb239493fc30afd057d7d56bb11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a geometry has at least one intersection (crossing or self-tangency)  <a href="#gacc0c6eb239493fc30afd057d7d56bb11">More...</a><br/></td></tr>
  50 <tr class="separator:gacc0c6eb239493fc30afd057d7d56bb11"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51 <tr class="memitem:ga3d8bd9a2b73bb493d66cbcb37426a7be"><td class="memTemplParams" colspan="2">template&lt;typename Geometry1 , typename Geometry2 &gt; </td></tr>
  52 <tr class="memitem:ga3d8bd9a2b73bb493d66cbcb37426a7be"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__intersects.html#ga3d8bd9a2b73bb493d66cbcb37426a7be">boost::geometry::intersects</a> (Geometry1 const &amp;geometry1, Geometry2 const &amp;geometry2)</td></tr>
  53 <tr class="memdesc:ga3d8bd9a2b73bb493d66cbcb37426a7be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if two geometries have at least one intersection.  <a href="#ga3d8bd9a2b73bb493d66cbcb37426a7be">More...</a><br/></td></tr>
  54 <tr class="separator:ga3d8bd9a2b73bb493d66cbcb37426a7be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55 </table>
  56 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  57 <h2 class="groupheader">Function Documentation</h2>
  58 <a class="anchor" id="gacc0c6eb239493fc30afd057d7d56bb11"></a>
  59 <div class="memitem">
  60 <div class="memproto">
  61 <div class="memtemplate">
  62 template&lt;typename Geometry &gt; </div>
  63       <table class="memname">
  64         <tr>
  65           <td class="memname">bool boost::geometry::intersects </td>
  66           <td>(</td>
  67           <td class="paramtype">Geometry const &amp;&#160;</td>
  68           <td class="paramname"><em>geometry</em></td><td>)</td>
  69           <td></td>
  70         </tr>
  71       </table>
  72 </div><div class="memdoc">
  73
  74 <p>Checks if a geometry has at least one intersection (crossing or self-tangency) </p>
  75 <dl class="section note"><dt>Note</dt><dd>This function can be called for one geometry (self-intersection) and also for two geometries (intersection)</dd></dl>
  76 <dl class="tparams"><dt>Template Parameters</dt><dd>
  77   <table class="tparams">
  78     <tr><td class="paramname">Geometry</td><td>Any type fulfilling a Geometry Concept </td></tr>
  79   </table>
  80   </dd>
  81 </dl>
  82 <dl class="params"><dt>Parameters</dt><dd>
  83   <table class="params">
  84     <tr><td class="paramname">geometry</td><td>A model of the specified concept </td></tr>
  85   </table>
  86   </dd>
  87 </dl>
  88 <dl class="section return"><dt>Returns</dt><dd>Returns true if the geometry is self-intersecting</dd></dl>
  89
  90 </div>
  91 </div>
  92 <a class="anchor" id="ga3d8bd9a2b73bb493d66cbcb37426a7be"></a>
  93 <div class="memitem">
  94 <div class="memproto">
  95 <div class="memtemplate">
  96 template&lt;typename Geometry1 , typename Geometry2 &gt; </div>
  97       <table class="memname">
  98         <tr>
  99           <td class="memname">bool boost::geometry::intersects </td>
 100           <td>(</td>
 101           <td class="paramtype">Geometry1 const &amp;&#160;</td>
 102           <td class="paramname"><em>geometry1</em>, </td>
 103         </tr>
 104         <tr>
 105           <td class="paramkey"></td>
 106           <td></td>
 107           <td class="paramtype">Geometry2 const &amp;&#160;</td>
 108           <td class="paramname"><em>geometry2</em>&#160;</td>
 109         </tr>
 110         <tr>
 111           <td></td>
 112           <td>)</td>
 113           <td></td><td></td>
 114         </tr>
 115       </table>
 116 </div><div class="memdoc">
 117
 118 <p>Checks if two geometries have at least one intersection. </p>
 119 <dl class="tparams"><dt>Template Parameters</dt><dd>
 120   <table class="tparams">
 121     <tr><td class="paramname">Geometry1</td><td>Any type fulfilling a Geometry Concept </td></tr>
 122     <tr><td class="paramname">Geometry2</td><td>Any type fulfilling a Geometry Concept </td></tr>
 123   </table>
 124   </dd>
 125 </dl>
 126 <dl class="params"><dt>Parameters</dt><dd>
 127   <table class="params">
 128     <tr><td class="paramname">geometry1</td><td>A model of the specified concept </td></tr>
 129     <tr><td class="paramname">geometry2</td><td>A model of the specified concept </td></tr>
 130   </table>
 131   </dd>
 132 </dl>
 133 <dl class="section return"><dt>Returns</dt><dd>Returns true if two geometries intersect each other</dd></dl>
 134
 135 </div>
 136 </div>
 137 </div><!-- contents -->
 138 <hr size="1">
 139 <table width="100%">
 140 <tbody>
 141 <tr>
 142 <td align="left"><small>
 143 <p>April 2, 2011</p>
 144 </small></td>
 145 <td align="right">
 146 <small>
 147 Copyright &copy; 2007-2011 Barend Gehrels, Amsterdam, the Netherlands<br>
 148 Copyright &copy; 2008-2011 Bruno Lalande, Paris, France<br>
 149 Copyright &copy; 2009-2010 Mateusz Loskot, London, UK<br>
 150 </small>
 151 </td>
 152 </tr>
 153 </tbody>
 154 </table>
 155 <address style="text-align: right;"><small>
 156 Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
 157 </small></address>
 158 </body>
 159 </html>