1[/============================================================================ 2 Boost.Geometry (aka GGL, Generic Geometry Library) 3 4 Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands. 5 Copyright (c) 2008-2013 Bruno Lalande, Paris, France. 6 Copyright (c) 2009-2013 Mateusz Loskot, London, UK. 7 8 Use, modification and distribution is subject to the Boost Software License, 9 Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at 10 http://www.boost.org/LICENSE_1_0.txt) 11=============================================================================/] 12 13 14[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically] 15[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1box.xml] 16[section:model_box model::box] 17 18'''<indexterm><primary>model</primary></indexterm><indexterm><primary>box</primary></indexterm>''' 19Class box: defines a box made of two describing points. 20 21[heading Description] 22Box is always described by a min\u005fcorner() and a max\u005fcorner() point. If another rectangle is used, use linear\u005fring or polygon. 23 24[heading Model of] 25[link geometry.reference.concepts.concept_box Box Concept] 26 27[heading Synopsis] 28``template<typename Point> 29class model::box 30{ 31 // ... 32}; 33`` 34 35[heading Template parameter(s)] 36[table 37[[Parameter] [Description]] 38[[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.]] 39] 40 41[heading Constructor(s)] 42[table 43[[Function] [Description] [Parameters] ] 44[[``box()`` 45 46] [Default constructor, no initialization. ] [ 47 48]] 49[[``box(Point const & min_corner, Point const & max_corner)`` 50 51] [Constructor taking the minimum corner point and the maximum corner point. ] [[* Point const &]: ['min_corner]: 52 53[* Point const &]: ['max_corner]: 54 55 56 57]] 58] 59 60[heading Member Function(s)] 61[table 62[[Function] [Description] [Parameters] [Returns]] 63[[``Point const & min_corner()`` 64 65] [] [ 66 67][ 68 69] 70] 71[[``Point const & max_corner()`` 72 73] [] [ 74 75][ 76 77] 78] 79[[``Point & min_corner()`` 80 81] [] [ 82 83][ 84 85] 86] 87[[``Point & max_corner()`` 88 89] [] [ 90 91][ 92 93] 94] 95] 96 97[heading Header] 98Either 99 100`#include <boost/geometry/geometries/geometries.hpp>` 101 102 103Or 104 105`#include <boost/geometry/geometries/box.hpp>` 106 107[include reference/geometries/box.qbk] 108 109[endsect] 110 111