• 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/classboost_1_1geometry_1_1model_1_1multi__polygon.xml]
16[section:model_multi_polygon model::multi_polygon]
17
18'''<indexterm><primary>model</primary></indexterm><indexterm><primary>multi_polygon</primary></indexterm>'''
19multi_polygon, a collection of polygons
20
21[heading Description]
22Multi-polygon can be used to group polygons belonging to each other, e.g. Hawaii
23
24[heading Model of]
25[link geometry.reference.concepts.concept_multi_polygon MultiPolygon Concept]
26
27[heading Synopsis]
28``template<typename Polygon, template< typename, typename > class Container, template< typename > class Allocator>
29class model::multi_polygon
30      : public Container< Polygon, Allocator< Polygon > >
31{
32  // ...
33};
34``
35
36[heading Template parameter(s)]
37[table
38[[Parameter] [Default] [Description]]
39[[typename Polygon] [] []]
40[[template< typename, typename > class Container] [std::vector] []]
41[[template< typename > class Allocator] [std::allocator] []]
42]
43
44[heading Constructor(s)]
45[table
46[[Function] [Description] [Parameters] ]
47[[``multi_polygon()``
48
49] [Default constructor, creating an empty multi_polygon. ] [
50
51]]
52[[``multi_polygon(std::initializer_list< Polygon > l)``
53
54] [Constructor taking std::initializer_list, filling the multi_polygon. ] [[* std::initializer_list< Polygon >]: ['l]:
55
56
57
58]]
59]
60
61[heading Header]
62Either
63
64`#include <boost/geometry/geometries/geometries.hpp>`
65
66
67Or
68
69`#include <boost/geometry/geometries/multi_polygon.hpp>`
70
71[include reference/geometries/multi_polygon.qbk]
72
73[endsect]
74
75