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__envelope.xml] 16[section:envelope_3_with_strategy envelope (with strategy)] 17 18'''<indexterm><primary>envelope</primary></indexterm>''' 19Calculates the envelope (with strategy) of a geometry. 20 21[heading Description] 22The free function envelope calculates the envelope (also known as axis aligned bounding box, aabb, or minimum bounding rectangle, mbr) of a geometry. 23 24[heading Synopsis] 25``template<typename Geometry, typename Box, typename Strategy> 26void envelope(Geometry const & geometry, Box & mbr, Strategy const & strategy)`` 27 28[heading Parameters] 29 30[table 31[[Type] [Concept] [Name] [Description] ] 32[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 33[[Box &] [Any type fulfilling a Box Concept ] [mbr] [A model of the specified Box Concept which is set to the envelope ]] 34[[Strategy const &] [Any type fulfilling a Envelope Strategy Concept ] [strategy] [The strategy which will be used for envelope calculations]] 35] 36 37 38[heading Header] 39Either 40 41`#include <boost/geometry.hpp>` 42 43 44Or 45 46`#include <boost/geometry/algorithms/envelope.hpp>` 47 48[include reference/algorithms/envelope.qbk] 49[heading Example] 50[envelope] [envelope_output] 51 52 53[endsect] 54 55[section:envelope_2 envelope] 56 57'''<indexterm><primary>envelope</primary></indexterm>''' 58Calculates the envelope of a geometry. 59 60[heading Description] 61The free function envelope calculates the envelope (also known as axis aligned bounding box, aabb, or minimum bounding rectangle, mbr) of a geometry. 62 63[heading Synopsis] 64``template<typename Geometry, typename Box> 65void envelope(Geometry const & geometry, Box & mbr)`` 66 67[heading Parameters] 68 69[table 70[[Type] [Concept] [Name] [Description] ] 71[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 72[[Box &] [Any type fulfilling a Box Concept ] [mbr] [A model of the specified Box Concept which is set to the envelope]] 73] 74 75 76[heading Header] 77Either 78 79`#include <boost/geometry.hpp>` 80 81 82Or 83 84`#include <boost/geometry/algorithms/envelope.hpp>` 85 86[include reference/algorithms/envelope.qbk] 87[heading Example] 88[envelope] [envelope_output] 89 90 91[endsect] 92 93[section:return_envelope_2_with_strategy return_envelope (with strategy)] 94 95'''<indexterm><primary>return_envelope</primary></indexterm>''' 96Calculates the envelope of a geometry. 97 98[heading Description] 99The free function return\u005fenvelope calculates the envelope (also known as axis aligned bounding box, aabb, or minimum bounding rectangle, mbr) of a geometry. This version with the return\u005f prefix returns the envelope, and a template parameter must therefore be specified in the call. 100 101[heading Synopsis] 102``template<typename Box, typename Geometry, typename Strategy> 103Box return_envelope(Geometry const & geometry, Strategy const & strategy)`` 104 105[heading Parameters] 106 107[table 108[[Type] [Concept] [Name] [Description] ] 109[[Box] [Any type fulfilling a Box Concept ] [ - ] [Must be specified]] 110[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 111[[Strategy const &] [Any type fulfilling a Envelope Strategy Concept ] [strategy] [The strategy which will be used for envelope calculations ]] 112] 113 114 115[heading Returns] 116The calculated envelope 117 118[heading Header] 119Either 120 121`#include <boost/geometry.hpp>` 122 123 124Or 125 126`#include <boost/geometry/algorithms/envelope.hpp>` 127 128[include reference/algorithms/envelope.qbk] 129[heading Example] 130[return_envelope] [return_envelope_output] 131 132 133[endsect] 134 135[section:return_envelope_1 return_envelope] 136 137'''<indexterm><primary>return_envelope</primary></indexterm>''' 138Calculates the envelope of a geometry. 139 140[heading Description] 141The free function return\u005fenvelope calculates the envelope (also known as axis aligned bounding box, aabb, or minimum bounding rectangle, mbr) of a geometry. This version with the return\u005f prefix returns the envelope, and a template parameter must therefore be specified in the call. 142 143[heading Synopsis] 144``template<typename Box, typename Geometry> 145Box return_envelope(Geometry const & geometry)`` 146 147[heading Parameters] 148 149[table 150[[Type] [Concept] [Name] [Description] ] 151[[Box] [Any type fulfilling a Box Concept ] [ - ] [Must be specified]] 152[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 153] 154 155 156[heading Returns] 157The calculated envelope 158 159[heading Header] 160Either 161 162`#include <boost/geometry.hpp>` 163 164 165Or 166 167`#include <boost/geometry/algorithms/envelope.hpp>` 168 169[include reference/algorithms/envelope.qbk] 170[heading Example] 171[return_envelope] [return_envelope_output] 172 173 174[endsect] 175 176