Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::geometry::model::box< Point > Class Template Reference

Class box: defines a box made of two describing points. More...

#include <box.hpp>

Public Member Functions

 box ()
 
 box (Point const &min_corner, Point const &max_corner)
 Constructor taking the minimum corner point and the maximum corner point. More...
 
Point const & min_corner () const
 
Point const & max_corner () const
 
Point & min_corner ()
 
Point & max_corner ()
 

Detailed Description

template<typename Point>
class boost::geometry::model::box< Point >

Class box: defines a box made of two describing points.

Box is always described by a min_corner() and a max_corner() point. If another rectangle is used, use linear_ring or polygon.

Note
Boxes are for selections and for calculating the envelope of geometries. Not all algorithms are implemented for box. Boxes are also used in Spatial Indexes.
Template Parameters
Pointpoint type. The box takes a point type as template parameter. The point type can be any point type. It can be 2D but can also be 3D or more dimensional. The box can also take a latlong point type as template parameter.

Constructor & Destructor Documentation

template<typename Point>
boost::geometry::model::box< Point >::box ( )
inline
template<typename Point>
boost::geometry::model::box< Point >::box ( Point const &  min_corner,
Point const &  max_corner 
)
inline

Constructor taking the minimum corner point and the maximum corner point.

References boost::geometry::convert().

Member Function Documentation

template<typename Point>
Point const& boost::geometry::model::box< Point >::max_corner ( ) const
inline
template<typename Point>
Point& boost::geometry::model::box< Point >::max_corner ( )
inline
template<typename Point>
Point const& boost::geometry::model::box< Point >::min_corner ( ) const
inline
template<typename Point>
Point& boost::geometry::model::box< Point >::min_corner ( )
inline

The documentation for this class was generated from the following file: