1[/============================================================================ 2 Boost.Geometry (aka GGL, Generic Geometry Library) 3 4 Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands. 5 Copyright (c) 2008-2013 Bruno Lalande, Paris, France. 6 Copyright (c) 2009-2013 Mateusz Loskot, London, UK. 7 8 Use, modification and distribution is subject to the Boost Software License, 9 Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at 10 http://www.boost.org/LICENSE_1_0.txt) 11=============================================================================/] 12 13 14[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically] 15[/ Generated from doxy/doxygen_output/xml/group__buffer.xml] 16[section:buffer_4 buffer] 17 18'''<indexterm><primary>buffer</primary></indexterm>''' 19Calculates the buffer of a geometry. 20 21[heading Description] 22The 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. 23 24[heading Synopsis] 25``template<typename Input, typename Output, typename Distance> 26void buffer(Input const & geometry_in, Output & geometry_out, Distance const & distance, 27 Distance const & chord_length = -1)`` 28 29[heading Parameters] 30 31[table 32[[Type] [Concept] [Name] [Description] ] 33[[Input const &] [Any type fulfilling a Geometry Concept ] [geometry_in] [A model of the specified concept ]] 34[[Output &] [Any type fulfilling a Geometry Concept ] [geometry_out] [A model of the specified concept ]] 35[[Distance const &] [numerical type (int, double, ttmath, ...) ] [distance] [The distance to be used for the buffer ]] 36[[Distance const &] [numerical type (int, double, ttmath, ...) ] [chord_length] [(optional) The length of the chord's in the generated arcs around points or bends]] 37] 38 39 40[heading Header] 41Either 42 43`#include <boost/geometry.hpp>` 44 45 46Or 47 48`#include <boost/geometry/algorithms/buffer.hpp>` 49 50[include reference/algorithms/buffer.qbk] 51 52 53[endsect] 54 55[section:buffer_7_with_strategies buffer (with strategies)] 56 57'''<indexterm><primary>buffer</primary></indexterm>''' 58Calculates the buffer of a geometry. 59 60[heading Description] 61The 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. 62 63[heading Synopsis] 64``template<typename GeometryIn, typename MultiPolygon, typename DistanceStrategy, typename SideStrategy, 65 typename JoinStrategy, typename EndStrategy, typename PointStrategy> 66void buffer(GeometryIn const & geometry_in, MultiPolygon & geometry_out, DistanceStrategy const & distance_strategy, 67 SideStrategy const & side_strategy, JoinStrategy const & join_strategy, EndStrategy const & end_strategy, 68 PointStrategy const & point_strategy)`` 69 70[heading Parameters] 71 72[table 73[[Type] [Concept] [Name] [Description] ] 74[[GeometryIn const &] [Any type fulfilling a Geometry Concept ] [geometry_in] [A model of the specified concept ]] 75[[MultiPolygon &] [A type fulfilling the MultiPolygon Concept ] [geometry_out] [output multi polygon (or std:: collection of polygons), will contain a buffered version of the input geometry ]] 76[[DistanceStrategy const &] [A strategy defining distance (or radius) ] [distance_strategy] [The distance strategy to be used ]] 77[[SideStrategy const &] [A strategy defining creation along sides ] [side_strategy] [The side strategy to be used ]] 78[[JoinStrategy const &] [A strategy defining creation around convex corners ] [join_strategy] [The join strategy to be used ]] 79[[EndStrategy const &] [A strategy defining creation at linestring ends ] [end_strategy] [The end strategy to be used ]] 80[[PointStrategy const &] [A strategy defining creation around points ] [point_strategy] [The point strategy to be used]] 81] 82 83 84[heading Header] 85Either 86 87`#include <boost/geometry.hpp>` 88 89 90Or 91 92`#include <boost/geometry/algorithms/buffer.hpp>` 93 94[include reference/algorithms/buffer_with_strategies.qbk] 95 96 97[endsect] 98 99[section:return_buffer return_buffer] 100 101'''<indexterm><primary>return_buffer</primary></indexterm>''' 102Calculates the buffer of a geometry. 103 104[heading Description] 105The free function return\u005fbuffer 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\u005f prefix returns the buffer, and a template parameter must therefore be specified in the call.. 106 107[heading Synopsis] 108``template<typename Output, typename Input, typename Distance> 109Output return_buffer(Input const & geometry, Distance const & distance, Distance const & chord_length = -1)`` 110 111[heading Parameters] 112 113[table 114[[Type] [Concept] [Name] [Description] ] 115[[Output] [Any type fulfilling a Geometry Concept ] [ - ] [Must be specified]] 116[[Input const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 117[[Distance const &] [numerical type (int, double, ttmath, ...) ] [distance] [The distance to be used for the buffer ]] 118[[Distance const &] [numerical type (int, double, ttmath, ...) ] [chord_length] [(optional) The length of the chord's in the generated arcs around points or bends (RESERVED, NOT YET USED) ]] 119] 120 121 122[heading Returns] 123The calculated buffer 124 125[heading Header] 126Either 127 128`#include <boost/geometry.hpp>` 129 130 131Or 132 133`#include <boost/geometry/algorithms/buffer.hpp>` 134 135 136[endsect] 137 138