| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>intersection</title> |
| <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> |
| <link rel="home" href="../../../index.html" title="Chapter 1. Geometry 1.0"> |
| <link rel="up" href="../algorithms.html" title="Algorithms"> |
| <link rel="prev" href="for_each/for_each_segment_2.html" title="for_each_segment"> |
| <link rel="next" href="intersects.html" title="intersects"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> |
| <td align="center"><a href="../../../../../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../../../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="for_each/for_each_segment_2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.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.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="section"> |
| <div class="titlepage"><div><div><h4 class="title"> |
| <a name="geometry.reference.algorithms.intersection"></a><a class="link" href="intersection.html" title="intersection">intersection</a> |
| </h4></div></div></div> |
| <p> |
| <a class="indexterm" name="id870965"></a> |
| Calculate the intersection of two geometries. |
| </p> |
| <a name="geometry.reference.algorithms.intersection.description"></a><h6> |
| <a name="geometry.reference.algorithms.intersection.description-heading"></a> |
| <a class="link" href="intersection.html#geometry.reference.algorithms.intersection.description">Description</a> |
| </h6> |
| <p> |
| The free function intersection calculates the spatial set theoretic intersection |
| of two geometries. |
| </p> |
| <a name="geometry.reference.algorithms.intersection.synopsis"></a><h6> |
| <a name="geometry.reference.algorithms.intersection.synopsis-heading"></a> |
| <a class="link" href="intersection.html#geometry.reference.algorithms.intersection.synopsis">Synopsis</a> |
| </h6> |
| <p> |
| |
| </p> |
| <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Geometry1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Geometry2</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">GeometryOut</span><span class="special">></span> |
| <span class="keyword">bool</span> <span class="identifier">intersection</span><span class="special">(</span><span class="identifier">Geometry1</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">geometry1</span><span class="special">,</span> <span class="identifier">Geometry2</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">geometry2</span><span class="special">,</span> <span class="identifier">GeometryOut</span> <span class="special">&</span> <span class="identifier">geometry_out</span><span class="special">)</span></pre> |
| <p> |
| </p> |
| <a name="geometry.reference.algorithms.intersection.parameters"></a><h6> |
| <a name="geometry.reference.algorithms.intersection.parameters-heading"></a> |
| <a class="link" href="intersection.html#geometry.reference.algorithms.intersection.parameters">Parameters</a> |
| </h6> |
| <div class="informaltable"><table class="table"> |
| <colgroup> |
| <col> |
| <col> |
| <col> |
| <col> |
| </colgroup> |
| <thead><tr> |
| <th> |
| <p> |
| Type |
| </p> |
| </th> |
| <th> |
| <p> |
| Concept |
| </p> |
| </th> |
| <th> |
| <p> |
| Name |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| </tr></thead> |
| <tbody> |
| <tr> |
| <td> |
| <p> |
| Geometry1 const & |
| </p> |
| </td> |
| <td> |
| <p> |
| Any type fulfilling a Geometry Concept |
| </p> |
| </td> |
| <td> |
| <p> |
| geometry1 |
| </p> |
| </td> |
| <td> |
| <p> |
| A model of the specified concept |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| Geometry2 const & |
| </p> |
| </td> |
| <td> |
| <p> |
| Any type fulfilling a Geometry Concept |
| </p> |
| </td> |
| <td> |
| <p> |
| geometry2 |
| </p> |
| </td> |
| <td> |
| <p> |
| A model of the specified concept |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| GeometryOut & |
| </p> |
| </td> |
| <td> |
| <p> |
| Collection of geometries (e.g. std::vector, std::deque, boost::geometry::multi*) |
| of which the value_type fulfills a Point, LineString or Polygon |
| concept, or it is the output geometry (e.g. for a box) |
| </p> |
| </td> |
| <td> |
| <p> |
| geometry_out |
| </p> |
| </td> |
| <td> |
| <p> |
| The output geometry, either a multi_point, multi_polygon, multi_linestring, |
| or a box (for intersection of two boxes) |
| </p> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| <a name="geometry.reference.algorithms.intersection.header"></a><h6> |
| <a name="geometry.reference.algorithms.intersection.header-heading"></a> |
| <a class="link" href="intersection.html#geometry.reference.algorithms.intersection.header">Header</a> |
| </h6> |
| <p> |
| Either |
| </p> |
| <p> |
| <code class="computeroutput"><span class="preprocessor">#include</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">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> |
| </p> |
| <p> |
| Or |
| </p> |
| <p> |
| <code class="computeroutput"><span class="preprocessor">#include</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">algorithms</span><span class="special">/</span><span class="identifier">intersection</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> |
| </p> |
| <a name="geometry.reference.algorithms.intersection.behavior"></a><h6> |
| <a name="geometry.reference.algorithms.intersection.behavior-heading"></a> |
| <a class="link" href="intersection.html#geometry.reference.algorithms.intersection.behavior">Behavior</a> |
| </h6> |
| <div class="informaltable"><table class="table"> |
| <colgroup> |
| <col> |
| <col> |
| </colgroup> |
| <thead><tr> |
| <th> |
| <p> |
| Case |
| </p> |
| </th> |
| <th> |
| <p> |
| Behavior |
| </p> |
| </th> |
| </tr></thead> |
| <tbody> |
| <tr> |
| <td> |
| <p> |
| GeometryOut is a Point |
| </p> |
| </td> |
| <td> |
| <p> |
| Calculates intersection points of input geometries |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| GeometryOut is a Linestring |
| </p> |
| </td> |
| <td> |
| <p> |
| Calculates intersection linestrings of input geometries (NYI) |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| GeometryOut is a Polygon |
| </p> |
| </td> |
| <td> |
| <p> |
| Calculates intersection polygons input (multi)polygons and/or |
| boxes |
| </p> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| <a name="geometry.reference.algorithms.intersection.example"></a><h6> |
| <a name="geometry.reference.algorithms.intersection.example-heading"></a> |
| <a class="link" href="intersection.html#geometry.reference.algorithms.intersection.example">Example</a> |
| </h6> |
| <p> |
| Shows the intersection of two polygons |
| </p> |
| <p> |
| |
| </p> |
| <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> |
| <span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">deque</span><span class="special">></span> |
| |
| <span class="preprocessor">#include</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">hpp</span><span class="special">></span> |
| <span class="preprocessor">#include</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">geometries</span><span class="special">/</span><span class="identifier">point_xy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> |
| <span class="preprocessor">#include</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">geometries</span><span class="special">/</span><span class="identifier">polygon</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> |
| <span class="preprocessor">#include</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">domains</span><span class="special">/</span><span class="identifier">gis</span><span class="special">/</span><span class="identifier">io</span><span class="special">/</span><span class="identifier">wkt</span><span class="special">/</span><span class="identifier">wkt</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> |
| |
| <span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">foreach</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> |
| |
| |
| <span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span> |
| <span class="special">{</span> |
| <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">polygon</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">model</span><span class="special">::</span><span class="identifier">d2</span><span class="special">::</span><span class="identifier">point_xy</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="special">></span> <span class="identifier">polygon</span><span class="special">;</span> |
| |
| <span class="identifier">polygon</span> <span class="identifier">green</span><span class="special">,</span> <span class="identifier">blue</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">read_wkt</span><span class="special">(</span> |
| <span class="string">"POLYGON((2 1.3,2.4 1.7,2.8 1.8,3.4 1.2,3.7 1.6,3.4 2,4.1 3,5.3 2.6,5.4 1.2,4.9 0.8,2.9 0.7,2 1.3)"</span> |
| <span class="string">"(4.0 2.0, 4.2 1.4, 4.8 1.9, 4.4 2.2, 4.0 2.0))"</span><span class="special">,</span> <span class="identifier">green</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">read_wkt</span><span class="special">(</span> |
| <span class="string">"POLYGON((4.0 -0.5 , 3.5 1.0 , 2.0 1.5 , 3.5 2.0 , 4.0 3.5 , 4.5 2.0 , 6.0 1.5 , 4.5 1.0 , 4.0 -0.5))"</span><span class="special">,</span> <span class="identifier">blue</span><span class="special">);</span> |
| |
| <span class="identifier">std</span><span class="special">::</span><span class="identifier">deque</span><span class="special"><</span><span class="identifier">polygon</span><span class="special">></span> <span class="identifier">output</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">intersection</span><span class="special">(</span><span class="identifier">green</span><span class="special">,</span> <span class="identifier">blue</span><span class="special">,</span> <span class="identifier">output</span><span class="special">);</span> |
| |
| <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> |
| <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="string">"green && blue:"</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> |
| <span class="identifier">BOOST_FOREACH</span><span class="special">(</span><span class="identifier">polygon</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">p</span><span class="special">,</span> <span class="identifier">output</span><span class="special">)</span> |
| <span class="special">{</span> |
| <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">i</span><span class="special">++</span> <span class="special"><<</span> <span class="string">": "</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">area</span><span class="special">(</span><span class="identifier">p</span><span class="special">)</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> |
| <span class="special">}</span> |
| |
| |
| <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> |
| <span class="special">}</span> |
| |
| </pre> |
| <p> |
| </p> |
| <p> |
| Output: |
| </p> |
| <pre class="programlisting">green && blue: |
| 0: 2.50205 |
| |
| <img src="../../../img/algorithms/intersection.png" alt="intersection"> |
| |
| </pre> |
| <a name="geometry.reference.algorithms.intersection.see_also"></a><h6> |
| <a name="geometry.reference.algorithms.intersection.see_also-heading"></a> |
| <a class="link" href="intersection.html#geometry.reference.algorithms.intersection.see_also">See |
| also</a> |
| </h6> |
| <div class="itemizedlist"><ul class="itemizedlist" type="disc"> |
| <li class="listitem"> |
| <a class="link" href="union_.html" title="union_">union</a> |
| </li> |
| <li class="listitem"> |
| <a class="link" href="difference.html" title="difference">difference</a> |
| </li> |
| <li class="listitem"> |
| <a class="link" href="sym_difference.html" title="sym_difference">sym_difference |
| (symmetric difference)</a> |
| </li> |
| </ul></div> |
| </div> |
| <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
| <td align="left"></td> |
| <td align="right"><div class="copyright-footer">Copyright © 2011 Barend Gehrels, Bruno Lalande, Mateusz Loskot<p> |
| Distributed under the Boost Software License, Version 1.0. (See accompanying |
| 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>) |
| </p> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="for_each/for_each_segment_2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.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.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |