75 lines
2.1 KiB
Plaintext
75 lines
2.1 KiB
Plaintext
[/============================================================================
|
|
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_1multi__polygon.xml]
|
|
[section:model_multi_polygon model::multi_polygon]
|
|
|
|
'''<indexterm><primary>model</primary></indexterm><indexterm><primary>multi_polygon</primary></indexterm>'''
|
|
multi_polygon, a collection of polygons
|
|
|
|
[heading Description]
|
|
Multi-polygon can be used to group polygons belonging to each other, e.g. Hawaii
|
|
|
|
[heading Model of]
|
|
[link geometry.reference.concepts.concept_multi_polygon MultiPolygon Concept]
|
|
|
|
[heading Synopsis]
|
|
``template<typename Polygon, template< typename, typename > class Container, template< typename > class Allocator>
|
|
class model::multi_polygon
|
|
: public Container< Polygon, Allocator< Polygon > >
|
|
{
|
|
// ...
|
|
};
|
|
``
|
|
|
|
[heading Template parameter(s)]
|
|
[table
|
|
[[Parameter] [Default] [Description]]
|
|
[[typename Polygon] [] []]
|
|
[[template< typename, typename > class Container] [std::vector] []]
|
|
[[template< typename > class Allocator] [std::allocator] []]
|
|
]
|
|
|
|
[heading Constructor(s)]
|
|
[table
|
|
[[Function] [Description] [Parameters] ]
|
|
[[``multi_polygon()``
|
|
|
|
] [Default constructor, creating an empty multi_polygon. ] [
|
|
|
|
]]
|
|
[[``multi_polygon(std::initializer_list< Polygon > l)``
|
|
|
|
] [Constructor taking std::initializer_list, filling the multi_polygon. ] [[* std::initializer_list< Polygon >]: ['l]:
|
|
|
|
|
|
|
|
]]
|
|
]
|
|
|
|
[heading Header]
|
|
Either
|
|
|
|
`#include <boost/geometry/geometries/geometries.hpp>`
|
|
|
|
|
|
Or
|
|
|
|
`#include <boost/geometry/geometries/multi_polygon.hpp>`
|
|
|
|
[include reference/geometries/multi_polygon.qbk]
|
|
|
|
[endsect]
|
|
|