Boost.Geometry    Boost C++ Libraries
Public Member Functions
boost::geometry::model::box< Point > Class Template Reference

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

List of all members.

Public Member Functions

 box ()
 Default constructor, no initialization.
 box (Point const &min_corner, Point const &max_corner)
 Constructor taking the minimum corner point and the maximum corner point.
Point const & max_corner () const
Point & max_corner ()
Point const & min_corner () const
Point & min_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.
Examples:
02_linestring_example.cpp, 03_polygon_example.cpp, 07_a_graph_route_example.cpp, 07_b_graph_route_example.cpp, and c05_custom_point_pointer_example.cpp.

Constructor & Destructor Documentation

template<typename Point>
boost::geometry::model::box< Point >::box ( )

Default constructor, no initialization.

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

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


Member Function Documentation

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

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