• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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/structboost_1_1geometry_1_1box__view.xml]
16[section:box_view box_view]
17
18'''<indexterm><primary>box_view</primary></indexterm>'''
19Makes a box behave like a ring or a range.
20
21[heading Description]
22Adapts a box to the Boost.Range concept, enabling the user to iterating box corners. The box\u005fview is registered as a Ring Concept
23
24[heading Model of]
25[link geometry.reference.concepts.concept_ring Ring Concept]
26
27[heading Synopsis]
28``template<typename Box, bool Clockwise>
29struct box_view
30      : public detail::points_view< geometry::point_type< Box >::type, 5 >
31{
32  // ...
33};
34``
35
36[heading Template parameter(s)]
37[table
38[[Parameter] [Default] [Description]]
39[[typename Box] [] [A type fulfilling the Box Concept ]]
40[[bool Clockwise] [true] [If true, walks in clockwise direction, otherwise it walks in counterclockwise direction]]
41]
42
43[heading Constructor(s)]
44[table
45[[Function] [Description] [Parameters] ]
46[[``box_view(Box const & box)``
47
48] [Constructor accepting the box to adapt. ] [[* Box const &]: ['box]:
49
50
51
52]]
53]
54
55[heading Header]
56Either
57
58`#include <boost/geometry.hpp>`
59
60
61Or
62
63`#include <boost/geometry/views/box_view.hpp>`
64
65[include reference/views/box_view.qbk]
66
67[endsect]
68
69