[/============================================================================ Boost.Geometry (aka GGL, Generic Geometry Library) Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands. Copyright (c) 2008-2013 Bruno Lalande, Paris, France. Copyright (c) 2009-2013 Mateusz Loskot, London, UK. 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 1.1.1, don't change, will be overwritten automatically] [/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1box.xml] [section:model_box model::box] '''modelbox''' Class box: defines a box made of two describing points. [heading Description] Box is always described by a min\u005fcorner() and a max\u005fcorner() point. If another rectangle is used, use linear\u005fring or polygon. [heading Model of] [link geometry.reference.concepts.concept_box Box Concept] [heading Synopsis] ``template class model::box { // ... }; `` [heading Template parameter(s)] [table [[Parameter] [Description]] [[typename Point] [point 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.]] ] [heading Constructor(s)] [table [[Function] [Description] [Parameters] ] [[``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 &]: ['min_corner]: [* Point const &]: ['max_corner]: ]] ] [heading Member Function(s)] [table [[Function] [Description] [Parameters] [Returns]] [[``Point const & min_corner()`` ] [] [ ][ ] ] [[``Point const & max_corner()`` ] [] [ ][ ] ] [[``Point & min_corner()`` ] [] [ ][ ] ] [[``Point & max_corner()`` ] [] [ ][ ] ] ] [heading Header] Either `#include ` Or `#include ` [include reference/geometries/box.qbk] [endsect]