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__buffer.html
Barend Gehrels 363580fbf6 Added old doxygen docs 
[SVN r59777]
2010-02-20 15:57:12 +00:00

188 lines
9.5 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>buffer: calculate buffer of a geometry</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 Input , typename Output , typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__buffer.html#gc9330cc842e4cdb3669e1ebe42bf94d4">boost::geometry::buffer</a> (Input const &amp;geometry_in, Output &amp;geometry_out, T const &amp;distance, T const &amp;chord_length=-1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate buffer (= new <a class="el" href="namespaceboost_1_1geometry.html">geometry</a>) around specified distance of <a class="el" href="namespaceboost_1_1geometry.html">geometry</a>. <a href="#gc9330cc842e4cdb3669e1ebe42bf94d4"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename Output , typename Input , typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">Output&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__buffer.html#g52678ccf91ab33af8a0adb57d6fe757a">boost::geometry::make_buffer</a> (Input const &amp;geometry, T const &amp;distance, T const &amp;chord_length=-1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate and return buffer (= new <a class="el" href="namespaceboost_1_1geometry.html">geometry</a>) around specified distance of <a class="el" href="namespaceboost_1_1geometry.html">geometry</a>. <a href="#g52678ccf91ab33af8a0adb57d6fe757a"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<dl class="user" compact><dt><b>Source description:</b></dt><dd><ul>
<li>OGC: Returns a geometric object that represents all Points whose distance from this geometric object is less than or equal to distance. Calculations are in the spatial reference system of this geometric object. Because of the limitations of linear interpolation, there will often be some relatively small error in this distance, but it should be near the resolution of the coordinates used </li></ul>
</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a href="http://en.wikipedia.org/wiki/Buffer_(GIS)">http://en.wikipedia.org/wiki/Buffer_(GIS)</a> </dd></dl>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gc9330cc842e4cdb3669e1ebe42bf94d4"></a><!-- doxytag: member="boost::geometry::buffer" ref="gc9330cc842e4cdb3669e1ebe42bf94d4" args="(Input const &amp;geometry_in, Output &amp;geometry_out, T const &amp;distance, T const &amp;chord_length=&#45;1)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Input , typename Output , typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname">void boost::geometry::buffer </td>
<td>(</td>
<td class="paramtype">Input const &amp;&nbsp;</td>
<td class="paramname"> <em>geometry_in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Output &amp;&nbsp;</td>
<td class="paramname"> <em>geometry_out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&nbsp;</td>
<td class="paramname"> <em>distance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&nbsp;</td>
<td class="paramname"> <em>chord_length</em> = <code>-1</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Calculate buffer (= new <a class="el" href="namespaceboost_1_1geometry.html">geometry</a>) around specified distance of <a class="el" href="namespaceboost_1_1geometry.html">geometry</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>geometry_in</em>&nbsp;</td><td>input <a class="el" href="namespaceboost_1_1geometry.html">geometry</a> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>distance</em>&nbsp;</td><td>the distance used in buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>chord_length</em>&nbsp;</td><td>length of the chord's in the generated arcs around points or bends </td></tr>
<tr><td valign="top"></td><td valign="top"><em>geometry_out</em>&nbsp;</td><td>buffered <a class="el" href="namespaceboost_1_1geometry.html">geometry</a> </td></tr>
</table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Currently only implemented for <a class="el" href="classboost_1_1geometry_1_1box.html" title="Class box: defines a box made of two describing points.">box</a>, the trivial case, but still useful </dd></dl>
<dl class="user" compact><dt><b>Use case:</b></dt><dd>BOX + distance -&gt; BOX: it is allowed that "geometry_out" the same object as "geometry_in" </dd></dl>
<p>Definition at line <a class="el" href="buffer_8hpp_source.html#l00107">107</a> of file <a class="el" href="buffer_8hpp_source.html">buffer.hpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="g52678ccf91ab33af8a0adb57d6fe757a"></a><!-- doxytag: member="boost::geometry::make_buffer" ref="g52678ccf91ab33af8a0adb57d6fe757a" args="(Input const &amp;geometry, T const &amp;distance, T const &amp;chord_length=&#45;1)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Output , typename Input , typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname">Output boost::geometry::make_buffer </td>
<td>(</td>
<td class="paramtype">Input const &amp;&nbsp;</td>
<td class="paramname"> <em>geometry</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&nbsp;</td>
<td class="paramname"> <em>distance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&nbsp;</td>
<td class="paramname"> <em>chord_length</em> = <code>-1</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Calculate and return buffer (= new <a class="el" href="namespaceboost_1_1geometry.html">geometry</a>) around specified distance of <a class="el" href="namespaceboost_1_1geometry.html">geometry</a>.
<p>
<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>input <a class="el" href="namespaceboost_1_1geometry.html">geometry</a> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>distance</em>&nbsp;</td><td>the distance used in buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>chord_length</em>&nbsp;</td><td>length of the chord's in the generated arcs around points or bends </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the buffered <a class="el" href="namespaceboost_1_1geometry.html">geometry</a> </dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>See also: buffer </dd></dl>
<p>Definition at line <a class="el" href="buffer_8hpp_source.html#l00133">133</a> of file <a class="el" href="buffer_8hpp_source.html">buffer.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