| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>return_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 1. Geometry 1.0"> |
| <link rel="up" href="../buffer.html" title="buffer"> |
| <link rel="prev" href="buffer.html" title="buffer"> |
| <link rel="next" href="../centroid.html" title="centroid"> |
| </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="../centroid.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.return_buffer"></a><a class="link" href="return_buffer.html" title="return_buffer">return_buffer</a> |
| </h5></div></div></div> |
| <p> |
| <a class="indexterm" name="id836157"></a> |
| Calculates the buffer of a geometry. |
| </p> |
| <a name="geometry.reference.algorithms.buffer.return_buffer.description"></a><h6> |
| <a name="geometry.reference.algorithms.buffer.return_buffer.description-heading"></a> |
| <a class="link" href="return_buffer.html#geometry.reference.algorithms.buffer.return_buffer.description">Description</a> |
| </h6> |
| <p> |
| The free function return_buffer calculates the buffer (a polygon being |
| the spatial point set collection within a specified maximum distance |
| from a geometry) of a geometry. This version with the return_ prefix |
| returns the buffer, and a template parameter must therefore be specified |
| in the call.. |
| </p> |
| <a name="geometry.reference.algorithms.buffer.return_buffer.synopsis"></a><h6> |
| <a name="geometry.reference.algorithms.buffer.return_buffer.synopsis-heading"></a> |
| <a class="link" href="return_buffer.html#geometry.reference.algorithms.buffer.return_buffer.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">Output</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Input</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T</span><span class="special">,</span> <span class="special">></span> |
| <span class="identifier">Output</span> <span class="identifier">return_buffer</span><span class="special">(</span><span class="identifier">Input</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">geometry</span><span class="special">,</span> <span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">distance</span><span class="special">,</span> <span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</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.return_buffer.parameters"></a><h6> |
| <a name="geometry.reference.algorithms.buffer.return_buffer.parameters-heading"></a> |
| <a class="link" href="return_buffer.html#geometry.reference.algorithms.buffer.return_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> |
| Output |
| </p> |
| </td> |
| <td> |
| <p> |
| Any type fulfilling a Geometry Concept |
| </p> |
| </td> |
| <td> |
| <p> |
| - |
| </p> |
| </td> |
| <td> |
| <p> |
| Must be specified |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| Distance |
| </p> |
| </td> |
| <td> |
| <p> |
| numerical type (int, double, ttmath, ...) |
| </p> |
| </td> |
| <td> |
| <p> |
| - |
| </p> |
| </td> |
| <td> |
| <p> |
| Must be specified |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| Input const & |
| </p> |
| </td> |
| <td> |
| <p> |
| Any type fulfilling a Geometry Concept |
| </p> |
| </td> |
| <td> |
| <p> |
| geometry |
| </p> |
| </td> |
| <td> |
| <p> |
| A model of the specified concept |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| T const & |
| </p> |
| </td> |
| <td> |
| </td> |
| <td> |
| <p> |
| distance |
| </p> |
| </td> |
| <td> |
| <p> |
| The distance to be used for the buffer |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| T const & |
| </p> |
| </td> |
| <td> |
| </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.return_buffer.returns"></a><h6> |
| <a name="geometry.reference.algorithms.buffer.return_buffer.returns-heading"></a> |
| <a class="link" href="return_buffer.html#geometry.reference.algorithms.buffer.return_buffer.returns">Returns</a> |
| </h6> |
| <p> |
| The calculated buffer |
| </p> |
| <a name="geometry.reference.algorithms.buffer.return_buffer.header"></a><h6> |
| <a name="geometry.reference.algorithms.buffer.return_buffer.header-heading"></a> |
| <a class="link" href="return_buffer.html#geometry.reference.algorithms.buffer.return_buffer.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">buffer</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> |
| </p> |
| </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="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="../centroid.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |