Boost.Geometry    Boost C++ Libraries
Functions
envelope: calculate envelope (minimum bounding rectangle) of a geometry

Functions

template<typename Geometry , typename Box , typename Strategy >
void boost::geometry::envelope (Geometry const &geometry, Box &mbr, Strategy const &strategy)
 Calculates the envelope (with strategy) of a geometry. More...
 
template<typename Geometry , typename Box >
void boost::geometry::envelope (Geometry const &geometry, Box &mbr)
 Calculates the envelope of a geometry. More...
 
template<typename Box , typename Geometry , typename Strategy >
Box boost::geometry::return_envelope (Geometry const &geometry, Strategy const &strategy)
 Calculates the envelope of a geometry. More...
 
template<typename Box , typename Geometry >
Box boost::geometry::return_envelope (Geometry const &geometry)
 Calculates the envelope of a geometry. More...
 

Detailed Description

Function Documentation

template<typename Geometry , typename Box , typename Strategy >
void boost::geometry::envelope ( Geometry const &  geometry,
Box &  mbr,
Strategy const &  strategy 
)

Calculates the envelope (with strategy) of a geometry.

The free function envelope calculates the envelope (also known as axis aligned bounding box, aabb, or minimum bounding rectangle, mbr) of a geometry.

Template Parameters
GeometryAny type fulfilling a Geometry Concept
BoxAny type fulfilling a Box Concept
StrategyAny type fulfilling a Envelope Strategy Concept
Parameters
geometryA model of the specified concept
mbrA model of the specified Box Concept which is set to the envelope
strategyThe strategy which will be used for envelope calculations
Examples:
02_linestring_example.cpp, and 03_polygon_example.cpp.
template<typename Geometry , typename Box >
void boost::geometry::envelope ( Geometry const &  geometry,
Box &  mbr 
)

Calculates the envelope of a geometry.

The free function envelope calculates the envelope (also known as axis aligned bounding box, aabb, or minimum bounding rectangle, mbr) of a geometry.

Template Parameters
GeometryAny type fulfilling a Geometry Concept
BoxAny type fulfilling a Box Concept
Parameters
geometryA model of the specified concept
mbrA model of the specified Box Concept which is set to the envelope
template<typename Box , typename Geometry , typename Strategy >
Box boost::geometry::return_envelope ( Geometry const &  geometry,
Strategy const &  strategy 
)

Calculates the envelope of a geometry.

The free function return_envelope calculates the envelope (also known as axis aligned bounding box, aabb, or minimum bounding rectangle, mbr) of a geometry. This version with the return_ prefix returns the envelope, and a template parameter must therefore be specified in the call.

Template Parameters
BoxAny type fulfilling a Box Concept
GeometryAny type fulfilling a Geometry Concept
StrategyAny type fulfilling a Envelope Strategy Concept
Parameters
geometryA model of the specified concept
strategyThe strategy which will be used for envelope calculations
Returns
The calculated envelope
template<typename Box , typename Geometry >
Box boost::geometry::return_envelope ( Geometry const &  geometry)

Calculates the envelope of a geometry.

The free function return_envelope calculates the envelope (also known as axis aligned bounding box, aabb, or minimum bounding rectangle, mbr) of a geometry. This version with the return_ prefix returns the envelope, and a template parameter must therefore be specified in the call.

Template Parameters
BoxAny type fulfilling a Box Concept
GeometryAny type fulfilling a Geometry Concept
Parameters
geometryA model of the specified concept
Returns
The calculated envelope

April 2, 2011

Copyright © 2007-2011 Barend Gehrels, Amsterdam, the Netherlands
Copyright © 2008-2011 Bruno Lalande, Paris, France
Copyright © 2009-2010 Mateusz Loskot, London, UK
Documentation is generated by Doxygen