• 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_1segment__view.xml]
16[section:segment_view segment_view]
17
18'''<indexterm><primary>segment_view</primary></indexterm>'''
19Makes a segment behave like a linestring or a range.
20
21[heading Description]
22Adapts a segment to the Boost.Range concept, enabling the user to iterate the two segment points. The segment\u005fview is registered as a LineString Concept
23
24[heading Model of]
25[link geometry.reference.concepts.concept_linestring LineString Concept]
26
27[heading Synopsis]
28``template<typename Segment>
29struct segment_view
30      : public detail::points_view< geometry::point_type< Segment >::type, 2 >
31{
32  // ...
33};
34``
35
36[heading Template parameter(s)]
37[table
38[[Parameter] [Description]]
39[[typename Segment] [A type fulfilling the Segment Concept]]
40]
41
42[heading Constructor(s)]
43[table
44[[Function] [Description] [Parameters] ]
45[[``segment_view(Segment const & segment)``
46
47] [Constructor accepting the segment to adapt. ] [[* Segment const &]: ['segment]:
48
49
50
51]]
52]
53
54[heading Header]
55Either
56
57`#include <boost/geometry.hpp>`
58
59
60Or
61
62`#include <boost/geometry/views/segment_view.hpp>`
63
64[include reference/views/segment_view.qbk]
65
66[endsect]
67
68