libs/geometry/doc/html/geometry/reference/algorithms/intersects/intersects_1_one_geometry.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>intersects (one geometry)</title>
   5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Geometry">
   8 <link rel="up" href="../intersects.html" title="intersects">
   9 <link rel="prev" href="../intersects.html" title="intersects">
  10 <link rel="next" href="intersects_3_with_strategy.html" title="intersects (with strategy)">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="../intersects.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../intersects.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="intersects_3_with_strategy.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="geometry.reference.algorithms.intersects.intersects_1_one_geometry"></a><a class="link" href="intersects_1_one_geometry.html" title="intersects (one geometry)">intersects
  28           (one geometry)</a>
  29 </h5></div></div></div>
  30 <p>
  31             <a class="indexterm" name="idm46186997700864"></a>
  32 Checks if a geometry has at least one intersection (crossing or self-tangency)
  33           </p>
  34 <h6>
  35 <a name="geometry.reference.algorithms.intersects.intersects_1_one_geometry.h0"></a>
  36             <span class="phrase"><a name="geometry.reference.algorithms.intersects.intersects_1_one_geometry.synopsis"></a></span><a class="link" href="intersects_1_one_geometry.html#geometry.reference.algorithms.intersects.intersects_1_one_geometry.synopsis">Synopsis</a>
  37           </h6>
  38 <p>
  39 </p>
  40 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Geometry</span><span class="special">&gt;</span>
  41 <span class="keyword">bool</span> <span class="identifier">intersects</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">geometry</span><span class="special">)</span></pre>
  42 <p>
  43           </p>
  44 <h6>
  45 <a name="geometry.reference.algorithms.intersects.intersects_1_one_geometry.h1"></a>
  46             <span class="phrase"><a name="geometry.reference.algorithms.intersects.intersects_1_one_geometry.parameters"></a></span><a class="link" href="intersects_1_one_geometry.html#geometry.reference.algorithms.intersects.intersects_1_one_geometry.parameters">Parameters</a>
  47           </h6>
  48 <div class="informaltable"><table class="table">
  49 <colgroup>
  50 <col>
  51 <col>
  52 <col>
  53 <col>
  54 </colgroup>
  55 <thead><tr>
  56 <th>
  57                     <p>
  58                       Type
  59                     </p>
  60                   </th>
  61 <th>
  62                     <p>
  63                       Concept
  64                     </p>
  65                   </th>
  66 <th>
  67                     <p>
  68                       Name
  69                     </p>
  70                   </th>
  71 <th>
  72                     <p>
  73                       Description
  74                     </p>
  75                   </th>
  76 </tr></thead>
  77 <tbody><tr>
  78 <td>
  79                     <p>
  80                       Geometry const &amp;
  81                     </p>
  82                   </td>
  83 <td>
  84                     <p>
  85                       Any type fulfilling a Geometry Concept
  86                     </p>
  87                   </td>
  88 <td>
  89                     <p>
  90                       geometry
  91                     </p>
  92                   </td>
  93 <td>
  94                     <p>
  95                       A model of the specified concept
  96                     </p>
  97                   </td>
  98 </tr></tbody>
  99 </table></div>
 100 <h6>
 101 <a name="geometry.reference.algorithms.intersects.intersects_1_one_geometry.h2"></a>
 102             <span class="phrase"><a name="geometry.reference.algorithms.intersects.intersects_1_one_geometry.returns"></a></span><a class="link" href="intersects_1_one_geometry.html#geometry.reference.algorithms.intersects.intersects_1_one_geometry.returns">Returns</a>
 103           </h6>
 104 <p>
 105             Returns true if the geometry is self-intersecting
 106           </p>
 107 <h6>
 108 <a name="geometry.reference.algorithms.intersects.intersects_1_one_geometry.h3"></a>
 109             <span class="phrase"><a name="geometry.reference.algorithms.intersects.intersects_1_one_geometry.header"></a></span><a class="link" href="intersects_1_one_geometry.html#geometry.reference.algorithms.intersects.intersects_1_one_geometry.header">Header</a>
 110           </h6>
 111 <p>
 112             Either
 113           </p>
 114 <p>
 115             <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 116           </p>
 117 <p>
 118             Or
 119           </p>
 120 <p>
 121             <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">algorithms</span><span class="special">/</span><span class="identifier">intersects</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 122           </p>
 123 <h6>
 124 <a name="geometry.reference.algorithms.intersects.intersects_1_one_geometry.h4"></a>
 125             <span class="phrase"><a name="geometry.reference.algorithms.intersects.intersects_1_one_geometry.conformance"></a></span><a class="link" href="intersects_1_one_geometry.html#geometry.reference.algorithms.intersects.intersects_1_one_geometry.conformance">Conformance</a>
 126           </h6>
 127 <p>
 128             The function intersects implements function Intersects from the <a href="http://www.opengeospatial.org/standards/sfa" target="_top">OGC Simple Feature
 129             Specification</a>.
 130           </p>
 131 <p>
 132             The version with one parameter is additional and not described in the
 133             OGC standard
 134           </p>
 135 <h6>
 136 <a name="geometry.reference.algorithms.intersects.intersects_1_one_geometry.h5"></a>
 137             <span class="phrase"><a name="geometry.reference.algorithms.intersects.intersects_1_one_geometry.examples"></a></span><a class="link" href="intersects_1_one_geometry.html#geometry.reference.algorithms.intersects.intersects_1_one_geometry.examples">Examples</a>
 138           </h6>
 139 <p>
 140             Check if two linestrings intersect each other
 141           </p>
 142 <p>
 143 </p>
 144 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
 145
 146 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 147 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">linestring</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 148 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">point_xy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 149
 150 <span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
 151 <span class="special">{</span>
 152     <span class="comment">// Calculate the intersects of a cartesian polygon</span>
 153     <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">d2</span><span class="special">::</span><span class="identifier">point_xy</span><span class="special">&lt;</span><span class="keyword">double</span><span class="special">&gt;</span> <span class="identifier">P</span><span class="special">;</span>
 154     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">linestring</span><span class="special">&lt;</span><span class="identifier">P</span><span class="special">&gt;</span> <span class="identifier">line1</span><span class="special">,</span> <span class="identifier">line2</span><span class="special">;</span>
 155
 156     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">read_wkt</span><span class="special">(</span><span class="string">"linestring(1 1,2 2,3 3)"</span><span class="special">,</span> <span class="identifier">line1</span><span class="special">);</span>
 157     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">read_wkt</span><span class="special">(</span><span class="string">"linestring(2 1,1 2,4 0)"</span><span class="special">,</span> <span class="identifier">line2</span><span class="special">);</span>
 158
 159     <span class="keyword">bool</span> <span class="identifier">b</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">line1</span><span class="special">,</span> <span class="identifier">line2</span><span class="special">);</span>
 160
 161     <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"Intersects: "</span> <span class="special">&lt;&lt;</span> <span class="special">(</span><span class="identifier">b</span> <span class="special">?</span> <span class="string">"YES"</span> <span class="special">:</span> <span class="string">"NO"</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
 162
 163     <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
 164 <span class="special">}</span>
 165 </pre>
 166 <p>
 167           </p>
 168 <p>
 169             Output:
 170           </p>
 171 <pre class="programlisting">Intersects: YES
 172 </pre>
 173 </div>
 174 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 175 <td align="left"></td>
 176 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 177       Wulkiewicz, Oracle and/or its affiliates<p>
 178         Distributed under the Boost Software License, Version 1.0. (See accompanying
 179         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 180       </p>
 181 </div></td>
 182 </tr></table>
 183 <hr>
 184 <div class="spirit-nav">
 185 <a accesskey="p" href="../intersects.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../intersects.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="intersects_3_with_strategy.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 186 </div>
 187 </body>
 188 </html>