boost/libs/geometry/doc/generated/append.qbk

52 lines
1.8 KiB
Plaintext
Raw Permalink Normal View History

2018-01-12 21:47:58 +01:00
[/============================================================================
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/group__append.xml]
[section:append append]
'''<indexterm><primary>append</primary></indexterm>'''
Appends one or more points to a linestring, ring, polygon, multi-geometry.
[heading Synopsis]
``template<typename Geometry, typename RangeOrPoint>
void append(Geometry & geometry, RangeOrPoint const & range_or_point, int ring_index = -1,
int multi_index = 0)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
[[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 ]]
[[int] [] [ring_index] [The index of the ring in case of a polygon: exterior ring (-1, the default) or interior ring index ]]
[[int] [] [multi_index] [The index of the geometry to which the points are appended]]
]
[heading Header]
Either
`#include <boost/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/append.hpp>`
[include reference/algorithms/append.qbk]
[endsect]