• 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/group__clear.xml]
16[section:clear clear]
17
18'''<indexterm><primary>clear</primary></indexterm>'''
19Clears a linestring, ring or polygon (exterior+interiors) or multi*.
20
21[heading Description]
22Generic function to clear a geometry. All points will be removed from the collection or collections making up the geometry. In most cases this is equivalent to the .clear() method of a std::vector<...>. In the case of a polygon, this clear functionality is automatically called for the exterior ring, and for the interior ring collection. In the case of a point, boxes and segments, nothing will happen.
23
24[heading Synopsis]
25``template<typename Geometry>
26void clear(Geometry & geometry)``
27
28[heading Parameters]
29
30[table
31[[Type] [Concept] [Name] [Description] ]
32[[Geometry &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept which will be cleared ]]
33]
34
35
36[heading Header]
37Either
38
39`#include <boost/geometry.hpp>`
40
41
42Or
43
44`#include <boost/geometry/algorithms/clear.hpp>`
45
46[include reference/algorithms/clear.qbk]
47
48
49[endsect]
50
51