libs/geometry/doc/doxy/doxygen_output/html_by_doxygen/group__buffer.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   5 <title>Boost.Geometry (aka GGL, Generic Geometry Library)</title>
   6 <link href="doxygen.css" rel="stylesheet" type="text/css">
   7 <link href="tabs.css" rel="stylesheet" type="text/css">
   8 </head>
   9 <table cellpadding="2" width="100%">
  10 <tbody>
  11 <tr>
  12 <td valign="top">
  13 <img alt="Boost.Geometry" src="images/ggl-logo-big.png" height="80" width="200">
  14 &nbsp;&nbsp;
  15 </td>
  16 <td valign="top" align="right">
  17 <a href="http://www.boost.org">
  18 <img alt="Boost C++ Libraries" src="images/accepted_by_boost.png" height="80" width="230" border="0">
  19 </a>
  20 </td>
  21 </tr>
  22 </tbody>
  23 </table>
  24 <!-- Generated by Doxygen 1.8.6 -->
  25   <div id="navrow1" class="tabs">
  26     <ul class="tablist">
  27       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  28       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  29       <li><a href="modules.html"><span>Modules</span></a></li>
  30       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  31       <li><a href="annotated.html"><span>Classes</span></a></li>
  32       <li><a href="files.html"><span>Files</span></a></li>
  33       <li><a href="examples.html"><span>Examples</span></a></li>
  34     </ul>
  35   </div>
  36 </div><!-- top -->
  37 <div class="header">
  38   <div class="summary">
  39 <a href="#func-members">Functions</a>  </div>
  40   <div class="headertitle">
  41 <div class="title">buffer: calculate buffer of a geometry</div>  </div>
  42 </div><!--header-->
  43 <div class="contents">
  44 <table class="memberdecls">
  45 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  46 Functions</h2></td></tr>
  47 <tr class="memitem:ga60bc23b4b5d3b572cf221714dae9a52a"><td class="memTemplParams" colspan="2">template&lt;typename Input , typename Output , typename Distance &gt; </td></tr>
  48 <tr class="memitem:ga60bc23b4b5d3b572cf221714dae9a52a"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__buffer.html#ga60bc23b4b5d3b572cf221714dae9a52a">boost::geometry::buffer</a> (Input const &amp;geometry_in, Output &amp;geometry_out, Distance const &amp;distance, Distance const &amp;chord_length=-1)</td></tr>
  49 <tr class="memdesc:ga60bc23b4b5d3b572cf221714dae9a52a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates the buffer of a geometry.  <a href="#ga60bc23b4b5d3b572cf221714dae9a52a">More...</a><br/></td></tr>
  50 <tr class="separator:ga60bc23b4b5d3b572cf221714dae9a52a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51 <tr class="memitem:gaf56bd07bd0dc7a7e4812223f23ddae7c"><td class="memTemplParams" colspan="2">template&lt;typename GeometryIn , typename MultiPolygon , typename DistanceStrategy , typename SideStrategy , typename JoinStrategy , typename EndStrategy , typename PointStrategy &gt; </td></tr>
  52 <tr class="memitem:gaf56bd07bd0dc7a7e4812223f23ddae7c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__buffer.html#gaf56bd07bd0dc7a7e4812223f23ddae7c">boost::geometry::buffer</a> (GeometryIn const &amp;geometry_in, MultiPolygon &amp;geometry_out, DistanceStrategy const &amp;distance_strategy, SideStrategy const &amp;side_strategy, JoinStrategy const &amp;join_strategy, EndStrategy const &amp;end_strategy, PointStrategy const &amp;point_strategy)</td></tr>
  53 <tr class="memdesc:gaf56bd07bd0dc7a7e4812223f23ddae7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates the buffer of a geometry.  <a href="#gaf56bd07bd0dc7a7e4812223f23ddae7c">More...</a><br/></td></tr>
  54 <tr class="separator:gaf56bd07bd0dc7a7e4812223f23ddae7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55 <tr class="memitem:ga8f897ad6face43210c41f8afedf526bb"><td class="memTemplParams" colspan="2">template&lt;typename Output , typename Input , typename Distance &gt; </td></tr>
  56 <tr class="memitem:ga8f897ad6face43210c41f8afedf526bb"><td class="memTemplItemLeft" align="right" valign="top">Output&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__buffer.html#ga8f897ad6face43210c41f8afedf526bb">boost::geometry::return_buffer</a> (Input const &amp;geometry, Distance const &amp;distance, Distance const &amp;chord_length=-1)</td></tr>
  57 <tr class="memdesc:ga8f897ad6face43210c41f8afedf526bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates the buffer of a geometry.  <a href="#ga8f897ad6face43210c41f8afedf526bb">More...</a><br/></td></tr>
  58 <tr class="separator:ga8f897ad6face43210c41f8afedf526bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59 </table>
  60 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  61 <h2 class="groupheader">Function Documentation</h2>
  62 <a class="anchor" id="ga60bc23b4b5d3b572cf221714dae9a52a"></a>
  63 <div class="memitem">
  64 <div class="memproto">
  65 <div class="memtemplate">
  66 template&lt;typename Input , typename Output , typename Distance &gt; </div>
  67       <table class="memname">
  68         <tr>
  69           <td class="memname">void boost::geometry::buffer </td>
  70           <td>(</td>
  71           <td class="paramtype">Input const &amp;&#160;</td>
  72           <td class="paramname"><em>geometry_in</em>, </td>
  73         </tr>
  74         <tr>
  75           <td class="paramkey"></td>
  76           <td></td>
  77           <td class="paramtype">Output &amp;&#160;</td>
  78           <td class="paramname"><em>geometry_out</em>, </td>
  79         </tr>
  80         <tr>
  81           <td class="paramkey"></td>
  82           <td></td>
  83           <td class="paramtype">Distance const &amp;&#160;</td>
  84           <td class="paramname"><em>distance</em>, </td>
  85         </tr>
  86         <tr>
  87           <td class="paramkey"></td>
  88           <td></td>
  89           <td class="paramtype">Distance const &amp;&#160;</td>
  90           <td class="paramname"><em>chord_length</em> = <code>-1</code>&#160;</td>
  91         </tr>
  92         <tr>
  93           <td></td>
  94           <td>)</td>
  95           <td></td><td></td>
  96         </tr>
  97       </table>
  98 </div><div class="memdoc">
  99
 100 <p>Calculates the buffer of a geometry. </p>
 101 <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>
 102 <dl class="tparams"><dt>Template Parameters</dt><dd>
 103   <table class="tparams">
 104     <tr><td class="paramname">Input</td><td>Any type fulfilling a Geometry Concept </td></tr>
 105     <tr><td class="paramname">Output</td><td>Any type fulfilling a Geometry Concept </td></tr>
 106     <tr><td class="paramname">Distance</td><td>numerical type (int, double, ttmath, ...) </td></tr>
 107   </table>
 108   </dd>
 109 </dl>
 110 <dl class="params"><dt>Parameters</dt><dd>
 111   <table class="params">
 112     <tr><td class="paramname">geometry_in</td><td>A model of the specified concept </td></tr>
 113     <tr><td class="paramname">geometry_out</td><td>A model of the specified concept </td></tr>
 114     <tr><td class="paramname">distance</td><td>The distance to be used for the buffer </td></tr>
 115     <tr><td class="paramname">chord_length</td><td>(optional) The length of the chord's in the generated arcs around points or bends</td></tr>
 116   </table>
 117   </dd>
 118 </dl>
 119
 120 </div>
 121 </div>
 122 <a class="anchor" id="ga8f897ad6face43210c41f8afedf526bb"></a>
 123 <div class="memitem">
 124 <div class="memproto">
 125 <div class="memtemplate">
 126 template&lt;typename Output , typename Input , typename Distance &gt; </div>
 127       <table class="memname">
 128         <tr>
 129           <td class="memname">Output boost::geometry::return_buffer </td>
 130           <td>(</td>
 131           <td class="paramtype">Input const &amp;&#160;</td>
 132           <td class="paramname"><em>geometry</em>, </td>
 133         </tr>
 134         <tr>
 135           <td class="paramkey"></td>
 136           <td></td>
 137           <td class="paramtype">Distance const &amp;&#160;</td>
 138           <td class="paramname"><em>distance</em>, </td>
 139         </tr>
 140         <tr>
 141           <td class="paramkey"></td>
 142           <td></td>
 143           <td class="paramtype">Distance const &amp;&#160;</td>
 144           <td class="paramname"><em>chord_length</em> = <code>-1</code>&#160;</td>
 145         </tr>
 146         <tr>
 147           <td></td>
 148           <td>)</td>
 149           <td></td><td></td>
 150         </tr>
 151       </table>
 152 </div><div class="memdoc">
 153
 154 <p>Calculates the buffer of a geometry. </p>
 155 <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>
 156 <dl class="tparams"><dt>Template Parameters</dt><dd>
 157   <table class="tparams">
 158     <tr><td class="paramname">Input</td><td>Any type fulfilling a Geometry Concept </td></tr>
 159     <tr><td class="paramname">Output</td><td>Any type fulfilling a Geometry Concept </td></tr>
 160     <tr><td class="paramname">Distance</td><td>numerical type (int, double, ttmath, ...) </td></tr>
 161   </table>
 162   </dd>
 163 </dl>
 164 <dl class="params"><dt>Parameters</dt><dd>
 165   <table class="params">
 166     <tr><td class="paramname">geometry</td><td>A model of the specified concept </td></tr>
 167     <tr><td class="paramname">distance</td><td>The distance to be used for the buffer </td></tr>
 168     <tr><td class="paramname">chord_length</td><td>(optional) The length of the chord's in the generated arcs around points or bends (RESERVED, NOT YET USED) </td></tr>
 169   </table>
 170   </dd>
 171 </dl>
 172 <dl class="section return"><dt>Returns</dt><dd>The calculated buffer </dd></dl>
 173
 174 </div>
 175 </div>
 176 <a class="anchor" id="gaf56bd07bd0dc7a7e4812223f23ddae7c"></a>
 177 <div class="memitem">
 178 <div class="memproto">
 179 <div class="memtemplate">
 180 template&lt;typename GeometryIn , typename MultiPolygon , typename DistanceStrategy , typename SideStrategy , typename JoinStrategy , typename EndStrategy , typename PointStrategy &gt; </div>
 181       <table class="memname">
 182         <tr>
 183           <td class="memname">void boost::geometry::buffer </td>
 184           <td>(</td>
 185           <td class="paramtype">GeometryIn const &amp;&#160;</td>
 186           <td class="paramname"><em>geometry_in</em>, </td>
 187         </tr>
 188         <tr>
 189           <td class="paramkey"></td>
 190           <td></td>
 191           <td class="paramtype">MultiPolygon &amp;&#160;</td>
 192           <td class="paramname"><em>geometry_out</em>, </td>
 193         </tr>
 194         <tr>
 195           <td class="paramkey"></td>
 196           <td></td>
 197           <td class="paramtype">DistanceStrategy const &amp;&#160;</td>
 198           <td class="paramname"><em>distance_strategy</em>, </td>
 199         </tr>
 200         <tr>
 201           <td class="paramkey"></td>
 202           <td></td>
 203           <td class="paramtype">SideStrategy const &amp;&#160;</td>
 204           <td class="paramname"><em>side_strategy</em>, </td>
 205         </tr>
 206         <tr>
 207           <td class="paramkey"></td>
 208           <td></td>
 209           <td class="paramtype">JoinStrategy const &amp;&#160;</td>
 210           <td class="paramname"><em>join_strategy</em>, </td>
 211         </tr>
 212         <tr>
 213           <td class="paramkey"></td>
 214           <td></td>
 215           <td class="paramtype">EndStrategy const &amp;&#160;</td>
 216           <td class="paramname"><em>end_strategy</em>, </td>
 217         </tr>
 218         <tr>
 219           <td class="paramkey"></td>
 220           <td></td>
 221           <td class="paramtype">PointStrategy const &amp;&#160;</td>
 222           <td class="paramname"><em>point_strategy</em>&#160;</td>
 223         </tr>
 224         <tr>
 225           <td></td>
 226           <td>)</td>
 227           <td></td><td></td>
 228         </tr>
 229       </table>
 230 </div><div class="memdoc">
 231
 232 <p>Calculates the buffer of a geometry. </p>
 233 <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>
 234 <dl class="tparams"><dt>Template Parameters</dt><dd>
 235   <table class="tparams">
 236     <tr><td class="paramname">GeometryIn</td><td>Any type fulfilling a Geometry Concept </td></tr>
 237     <tr><td class="paramname">MultiPolygon</td><td>A type fulfilling the MultiPolygon Concept </td></tr>
 238     <tr><td class="paramname">DistanceStrategy</td><td>A strategy defining distance (or radius) </td></tr>
 239     <tr><td class="paramname">SideStrategy</td><td>A strategy defining creation along sides </td></tr>
 240     <tr><td class="paramname">JoinStrategy</td><td>A strategy defining creation around convex corners </td></tr>
 241     <tr><td class="paramname">EndStrategy</td><td>A strategy defining creation at linestring ends </td></tr>
 242     <tr><td class="paramname">PointStrategy</td><td>A strategy defining creation around points </td></tr>
 243   </table>
 244   </dd>
 245 </dl>
 246 <dl class="params"><dt>Parameters</dt><dd>
 247   <table class="params">
 248     <tr><td class="paramname">geometry_in</td><td>A model of the specified concept </td></tr>
 249     <tr><td class="paramname">geometry_out</td><td>output multi polygon (or std:: collection of polygons), will contain a buffered version of the input geometry </td></tr>
 250     <tr><td class="paramname">distance_strategy</td><td>The distance strategy to be used </td></tr>
 251     <tr><td class="paramname">side_strategy</td><td>The side strategy to be used </td></tr>
 252     <tr><td class="paramname">join_strategy</td><td>The join strategy to be used </td></tr>
 253     <tr><td class="paramname">end_strategy</td><td>The end strategy to be used </td></tr>
 254     <tr><td class="paramname">point_strategy</td><td>The point strategy to be used</td></tr>
 255   </table>
 256   </dd>
 257 </dl>
 258
 259 </div>
 260 </div>
 261 </div><!-- contents -->
 262 <hr size="1">
 263 <table width="100%">
 264 <tbody>
 265 <tr>
 266 <td align="left"><small>
 267 <p>April 2, 2011</p>
 268 </small></td>
 269 <td align="right">
 270 <small>
 271 Copyright &copy; 2007-2011 Barend Gehrels, Amsterdam, the Netherlands<br>
 272 Copyright &copy; 2008-2011 Bruno Lalande, Paris, France<br>
 273 Copyright &copy; 2009-2010 Mateusz Loskot, London, UK<br>
 274 </small>
 275 </td>
 276 </tr>
 277 </tbody>
 278 </table>
 279 <address style="text-align: right;"><small>
 280 Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
 281 </small></address>
 282 </body>
 283 </html>