Google Git
Sign in
android / platform / external / boost / 4422d7a0f10cc9e43771732f06da25183313f8fc / . / libs / geometry / doc / html / geometry / reference / algorithms / buffer / buffer.html
blob: 74adaa446cf37186c5c83615a71b6b3e473247a7 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>buffer</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&#160;1.&#160;Geometry 1.0">
<link rel="up" href="../buffer.html" title="buffer">
<link rel="prev" href="../buffer.html" title="buffer">
<link rel="next" href="return_buffer.html" title="return_buffer">
</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="../buffer.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../buffer.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="return_buffer.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry.reference.algorithms.buffer.buffer"></a><a class="link" href="buffer.html" title="buffer">buffer</a>
</h5></div></div></div>
<p>
<a class="indexterm" name="id835422"></a>
Calculates the buffer of a geometry.
</p>
<a name="geometry.reference.algorithms.buffer.buffer.description"></a><h6>
<a name="geometry.reference.algorithms.buffer.buffer.description-heading"></a>
<a class="link" href="buffer.html#geometry.reference.algorithms.buffer.buffer.description">Description</a>
</h6>
<p>
The free function buffer calculates the buffer (a polygon being the spatial
point set collection within a specified maximum distance from a geometry)
of a geometry.
</p>
<a name="geometry.reference.algorithms.buffer.buffer.synopsis"></a><h6>
<a name="geometry.reference.algorithms.buffer.buffer.synopsis-heading"></a>
<a class="link" href="buffer.html#geometry.reference.algorithms.buffer.buffer.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Input</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Output</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Distance</span><span class="special">&gt;</span>
<span class="keyword">void</span> <span class="identifier">buffer</span><span class="special">(</span><span class="identifier">Input</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">geometry_in</span><span class="special">,</span> <span class="identifier">Output</span> <span class="special">&amp;</span> <span class="identifier">geometry_out</span><span class="special">,</span> <span class="identifier">Distance</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">distance</span><span class="special">,</span> <span class="identifier">Distance</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">chord_length</span> <span class="special">=</span> <span class="special">-</span><span class="number">1</span><span class="special">)</span></pre>
<p>
</p>
<a name="geometry.reference.algorithms.buffer.buffer.parameters"></a><h6>
<a name="geometry.reference.algorithms.buffer.buffer.parameters-heading"></a>
<a class="link" href="buffer.html#geometry.reference.algorithms.buffer.buffer.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>
Input const &amp;
</p>
</td>
<td>
<p>
Any type fulfilling a Geometry Concept
</p>
</td>
<td>
<p>
geometry_in
</p>
</td>
<td>
<p>
A model of the specified concept
</p>
</td>
</tr>
<tr>
<td>
<p>
Output &amp;
</p>
</td>
<td>
<p>
Any type fulfilling a Geometry Concept
</p>
</td>
<td>
<p>
geometry_out
</p>
</td>
<td>
<p>
A model of the specified concept
</p>
</td>
</tr>
<tr>
<td>
<p>
Distance const &amp;
</p>
</td>
<td>
<p>
numerical type (int, double, ttmath, ...)
</p>
</td>
<td>
<p>
distance
</p>
</td>
<td>
<p>
The distance to be used for the buffer
</p>
</td>
</tr>
<tr>
<td>
<p>
Distance const &amp;
</p>
</td>
<td>
<p>
numerical type (int, double, ttmath, ...)
</p>
</td>
<td>
<p>
chord_length
</p>
</td>
<td>
<p>
(optional) The length of the chord's in the generated arcs
around points or bends
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="geometry.reference.algorithms.buffer.buffer.header"></a><h6>
<a name="geometry.reference.algorithms.buffer.buffer.header-heading"></a>
<a class="link" href="buffer.html#geometry.reference.algorithms.buffer.buffer.header">Header</a>
</h6>
<p>
Either
</p>
<p>
<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">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<p>
Or
</p>
<p>
<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">buffer</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<a name="geometry.reference.algorithms.buffer.buffer.behavior"></a><h6>
<a name="geometry.reference.algorithms.buffer.buffer.behavior-heading"></a>
<a class="link" href="buffer.html#geometry.reference.algorithms.buffer.buffer.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>
Rectangle/Rectangle
</p>
</td>
<td>
<p>
Returns a new rectangular box, enlarged with the specified
distance. It is allowed that "geometry_out" the same
object as "geometry_in"
</p>
</td>
</tr></tbody>
</table></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 &#169; 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="../buffer.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../buffer.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="return_buffer.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>