append.qbk 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  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/group__append.xml]
  12. [section:append append]
  13. '''<indexterm><primary>append</primary></indexterm>'''
  14. Appends one or more points to a linestring, ring, polygon, multi-geometry.
  15. [heading Synopsis]
  16. ``template<typename Geometry, typename RangeOrPoint>
  17. void append(Geometry & geometry, RangeOrPoint const & range_or_point, int ring_index = -1,
  18. int multi_index = 0)``
  19. [heading Parameters]
  20. [table
  21. [[Type] [Concept] [Name] [Description] ]
  22. [[Geometry &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
  23. [[RangeOrPoint const &] [Either a range or a point, fullfilling Boost.Range concept or Boost.Geometry Point Concept ] [range_or_point] [The point or range to add ]]
  24. [[int] [] [ring_index] [The index of the ring in case of a polygon: exterior ring (-1, the default) or interior ring index ]]
  25. [[int] [] [multi_index] [The index of the geometry to which the points are appended]]
  26. ]
  27. [heading Header]
  28. Either
  29. `#include <boost/geometry.hpp>`
  30. Or
  31. `#include <boost/geometry/algorithms/append.hpp>`
  32. [include reference/algorithms/append.qbk]
  33. [endsect]