multi_polygon.qbk 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. [/============================================================================
  2. Boost.Geometry (aka GGL, Generic Geometry Library)
  3. Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
  4. Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
  5. Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
  6. Use, modification and distribution is subject to the Boost Software License,
  7. Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  8. http://www.boost.org/LICENSE_1_0.txt)
  9. =============================================================================/]
  10. [/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
  11. [/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1multi__polygon.xml]
  12. [section:model_multi_polygon model::multi_polygon]
  13. '''<indexterm><primary>model</primary></indexterm><indexterm><primary>multi_polygon</primary></indexterm>'''
  14. multi_polygon, a collection of polygons
  15. [heading Description]
  16. Multi-polygon can be used to group polygons belonging to each other, e.g. Hawaii
  17. [heading Model of]
  18. [link geometry.reference.concepts.concept_multi_polygon MultiPolygon Concept]
  19. [heading Synopsis]
  20. ``template<typename Polygon, template< typename, typename > class Container, template< typename > class Allocator>
  21. class model::multi_polygon
  22. : public Container< Polygon, Allocator< Polygon > >
  23. {
  24. // ...
  25. };
  26. ``
  27. [heading Template parameter(s)]
  28. [table
  29. [[Parameter] [Default] [Description]]
  30. [[typename Polygon] [] []]
  31. [[template< typename, typename > class Container] [std::vector] []]
  32. [[template< typename > class Allocator] [std::allocator] []]
  33. ]
  34. [heading Constructor(s)]
  35. [table
  36. [[Function] [Description] [Parameters] ]
  37. [[``multi_polygon()``
  38. ] [Default constructor, creating an empty multi_polygon. ] [
  39. ]]
  40. [[``multi_polygon(std::initializer_list< Polygon > l)``
  41. ] [Constructor taking std::initializer_list, filling the multi_polygon. ] [[* std::initializer_list< Polygon >]: ['l]:
  42. ]]
  43. ]
  44. [heading Header]
  45. Either
  46. `#include <boost/geometry/geometries/geometries.hpp>`
  47. Or
  48. `#include <boost/geometry/geometries/multi_polygon.hpp>`
  49. [include reference/geometries/multi_polygon.qbk]
  50. [endsect]