boost_mirror/geometry
1
0
Fork 0
mirror of https://github.com/boostorg/geometry.git synced 2025-05-12 14:01:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
geometry/doc/doxygen_output/html/group__union.html
Barend Gehrels 363580fbf6 Added old doxygen docs 
[SVN r59777]
2010-02-20 15:57:12 +00:00

219 lines
11 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>union: calculate new geometry containing geometries A or B</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 GeometryOut , typename Geometry1 , typename Geometry2 , typename OutputIterator &gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">OutputIterator&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__union.html#gebd31239bba0a05cdaff08ea67a1e7ba">boost::geometry::union_inserter</a> (Geometry1 const &amp;geometry1, Geometry2 const &amp;geometry2, OutputIterator out)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Combines two geometries which each other. <a href="#gebd31239bba0a05cdaff08ea67a1e7ba"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename GeometryOut , typename Geometry1 , typename Geometry2 , typename OutputIterator , typename Strategy &gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">OutputIterator&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__union.html#g7a6fe564fb27eab202ffe70fa846a966">boost::geometry::union_inserter</a> (Geometry1 const &amp;geometry1, Geometry2 const &amp;geometry2, OutputIterator out, Strategy const &amp;strategy)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Combines two geometries which each other. <a href="#g7a6fe564fb27eab202ffe70fa846a966"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The union of two geometries A and B is the geometry containing all points belong to either of A or B, but no other elements. <dl class="user" compact><dt><b>Source description:</b></dt><dd><ul>
<li>OGC: Returns a geometric object that represents the Point set union of this geometric object with another Geometry. </li></ul>
</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a href="http://en.wikipedia.org/wiki/Union_(set_theory)">http://en.wikipedia.org/wiki/Union_(set_theory)</a> </dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>A union of two rings can result in a polygon having a hole</dd></dl>
<dl class="user" compact><dt><b>Geometries:</b></dt><dd><ul>
<li><b>polygon</b> + <b>box</b> -&gt; <b>polygon(s)</b> <div align="center">
<img src="svg_union_polygon_box.png" alt="svg_union_polygon_box.png">
</div>
</li><li><b>ring</b> + <b>box</b> -&gt; <b>polygon(s)</b> <div align="center">
<img src="svg_union_ring_box.png" alt="svg_union_ring_box.png">
</div>
</li><li><b>ring</b> + <b>ring</b> -&gt; <b>polygon(s)</b> <div align="center">
<img src="svg_union_ring_ring.png" alt="svg_union_ring_ring.png">
</div>
</li><li><b>polygon</b> + <b>ring</b> -&gt; <b>polygon(s)</b> <div align="center">
<img src="svg_union_polygon_ring.png" alt="svg_union_polygon_ring.png">
</div>
</li><li>combinations above -&gt; <b>ring(s)</b>. <em>If the output is an ouput iterator of rings, holes are omitted</em> </li></ul>
</dd></dl>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g7a6fe564fb27eab202ffe70fa846a966"></a><!-- doxytag: member="boost::geometry::union_inserter" ref="g7a6fe564fb27eab202ffe70fa846a966" args="(Geometry1 const &amp;geometry1, Geometry2 const &amp;geometry2, OutputIterator out, Strategy const &amp;strategy)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename GeometryOut , typename Geometry1 , typename Geometry2 , typename OutputIterator , typename Strategy &gt; </div>
<table class="memname">
<tr>
<td class="memname">OutputIterator boost::geometry::union_inserter </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OutputIterator&nbsp;</td>
<td class="paramname"> <em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Strategy const &amp;&nbsp;</td>
<td class="paramname"> <em>strategy</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Combines two geometries which each other.
<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>GeometryOut</em>&nbsp;</td><td>output <a class="el" href="namespaceboost_1_1geometry.html">geometry</a> type, must be specified </td></tr>
<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>
<tr><td valign="top"></td><td valign="top"><em>OutputIterator</em>&nbsp;</td><td>output iterator </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Strategy</em>&nbsp;</td><td>compound <a class="el" href="namespaceboost_1_1geometry_1_1strategy.html">strategy</a> for intersection </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>
<tr><td valign="top"></td><td valign="top"><em>out</em>&nbsp;</td><td>the output iterator, outputting polygons </td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="namespaceboost_1_1geometry_1_1strategy.html">strategy</a></em>&nbsp;</td><td>the <a class="el" href="namespaceboost_1_1geometry_1_1strategy.html">strategy</a> </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the output iterator </dd></dl>
<p>Definition at line <a class="el" href="union_8hpp_source.html#l00235">235</a> of file <a class="el" href="union_8hpp_source.html">union.hpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="gebd31239bba0a05cdaff08ea67a1e7ba"></a><!-- doxytag: member="boost::geometry::union_inserter" ref="gebd31239bba0a05cdaff08ea67a1e7ba" args="(Geometry1 const &amp;geometry1, Geometry2 const &amp;geometry2, OutputIterator out)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename GeometryOut , typename Geometry1 , typename Geometry2 , typename OutputIterator &gt; </div>
<table class="memname">
<tr>
<td class="memname">OutputIterator boost::geometry::union_inserter </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OutputIterator&nbsp;</td>
<td class="paramname"> <em>out</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Combines two geometries which each other.
<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>GeometryOut</em>&nbsp;</td><td>output <a class="el" href="namespaceboost_1_1geometry.html">geometry</a> type, must be specified </td></tr>
<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>
<tr><td valign="top"></td><td valign="top"><em>OutputIterator</em>&nbsp;</td><td>output iterator </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>
<tr><td valign="top"></td><td valign="top"><em>out</em>&nbsp;</td><td>the output iterator, outputting polygons </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the output iterator </dd></dl>
<p>Definition at line <a class="el" href="union_8hpp_source.html#l00288">288</a> of file <a class="el" href="union_8hpp_source.html">union.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 <20> 1995-2009 Barend Gehrels, Geodan, Amsterdam<br>
Copyright <20> 2008-2009 Bruno Lalande, Paris<br>
Copyright <20> 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