• 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__convert.xml]
16[section:convert convert]
17
18'''<indexterm><primary>convert</primary></indexterm>'''
19Converts one geometry to another geometry.
20
21[heading Description]
22The convert algorithm converts one geometry, e.g. a BOX, to another geometry, e.g. a RING. This only works if it is possible and applicable. If the point-order is different, or the closure is different between two geometry types, it will be converted correctly by explicitly reversing the points or closing or opening the polygon rings.
23
24[heading Synopsis]
25``template<typename Geometry1, typename Geometry2>
26void convert(Geometry1 const & geometry1, Geometry2 & geometry2)``
27
28[heading Parameters]
29
30[table
31[[Type] [Concept] [Name] [Description] ]
32[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept (source) ]]
33[[Geometry2 &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept (target)]]
34]
35
36
37[heading Header]
38Either
39
40`#include <boost/geometry.hpp>`
41
42
43Or
44
45`#include <boost/geometry/algorithms/convert.hpp>`
46
47[include reference/algorithms/convert.qbk]
48
49
50[endsect]
51
52