mirror of
https://github.com/boostorg/geometry.git
synced 2025-05-11 05:24:02 +00:00
89 lines
2.5 KiB
Plaintext
89 lines
2.5 KiB
Plaintext
[/============================================================================
|
|
Boost.Geometry (aka GGL, Generic Geometry Library)
|
|
|
|
Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
|
|
Copyright (c) 2009-2011 Mateusz Loskot (mateusz@loskot.net)
|
|
Copyright (c) 2009-2011 Bruno Lalande, Paris, France.
|
|
|
|
Use, modification and distribution is subject to the Boost Software License,
|
|
Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
|
|
http://www.boost.org/LICENSE_1_0.txt)
|
|
=============================================================================/]
|
|
|
|
|
|
[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
|
|
[/ Generated from doxy/doxygen_output/xml/group__envelope.xml]
|
|
[section:envelope envelope]
|
|
|
|
Calculates the envelope of a geometry.
|
|
|
|
[heading Description]
|
|
The free function envelope calculates the envelope (also known as axis aligned bounding box, aabb, or minimum bounding rectangle, mbr) of a geometry.
|
|
|
|
[heading Synopsis]
|
|
``template<typename Geometry, typename Box>
|
|
void envelope(Geometry const & geometry, Box & mbr)``
|
|
|
|
[heading Parameters]
|
|
|
|
[table
|
|
[[Type] [Concept] [Name] [Description] ]
|
|
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
|
|
[[Box &] [Any type fulfilling a Box Concept ] [mbr] [A model of the specified Box Concept which is set to the envelope]]
|
|
]
|
|
|
|
|
|
[heading Header]
|
|
Either
|
|
|
|
`#include <boost/geometry/geometry.hpp>`
|
|
|
|
Or
|
|
|
|
`#include <boost/geometry/algorithms/envelope.hpp>`
|
|
|
|
[heading Example]
|
|
[envelope] [envelope_output]
|
|
|
|
|
|
[endsect]
|
|
|
|
[section:make_envelope make_envelope]
|
|
|
|
Calculates the envelope of a geometry.
|
|
|
|
[heading Description]
|
|
The free function make\u005fenvelope calculates the envelope (also known as axis aligned bounding box, aabb, or minimum bounding rectangle, mbr) of a geometry. This version with the make\u005f prefix returns the envelope, and a template parameter must therefore be specified in the call.
|
|
|
|
[heading Synopsis]
|
|
``template<typename Box, typename Geometry>
|
|
Box make_envelope(Geometry const & geometry)``
|
|
|
|
[heading Parameters]
|
|
|
|
[table
|
|
[[Type] [Concept] [Name] [Description] ]
|
|
[[Box] [Any type fulfilling a Box Concept ] [ - ] [Must be specified]]
|
|
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
|
|
]
|
|
|
|
|
|
[heading Returns]
|
|
The calculated envelope
|
|
|
|
[heading Header]
|
|
Either
|
|
|
|
`#include <boost/geometry/geometry.hpp>`
|
|
|
|
Or
|
|
|
|
`#include <boost/geometry/algorithms/envelope.hpp>`
|
|
|
|
[heading Example]
|
|
[make_envelope] [make_envelope_output]
|
|
|
|
|
|
[endsect]
|
|
|