• 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__line__interpolate.xml]
16[section:line_interpolate_4_with_strategy line_interpolate (with strategy)]
17
18'''<indexterm><primary>line_interpolate</primary></indexterm>'''
19Returns one or more points interpolated along a LineString using the specified strategy.
20
21[heading Synopsis]
22``template<typename Geometry, typename Distance, typename Pointlike, typename Strategy>
23void line_interpolate(Geometry const & geometry, Distance const & max_distance, Pointlike & pointlike,
24                      Strategy const & strategy)``
25
26[heading Parameters]
27
28[table
29[[Type] [Concept] [Name] [Description] ]
30[[Geometry const &] [Any type fulfilling a LineString concept ] [geometry] [Input geometry ]]
31[[Distance const &] [A numerical distance measure ] [max_distance] [Distance threshold (in units depending on coordinate system) representing the spacing between the points ]]
32[[Pointlike &] [Any type fulfilling Point or Multipoint concept ] [pointlike] [Output: either a Point (exactly one point will be constructed) or a MultiPoint (depending on the max_distance one or more points will be constructed) ]]
33[[Strategy const &] [A type fulfilling a LineInterpolatePointStrategy concept ] [strategy] [line_interpolate strategy to be used for interpolation of points]]
34]
35
36
37[heading Header]
38Either
39
40`#include <boost/geometry.hpp>`
41
42
43Or
44
45`#include <boost/geometry/algorithms/line_interpolate.hpp>`
46
47[include reference/algorithms/line_interpolate.qbk]
48[heading Available Strategies]
49* [link geometry.reference.strategies.strategy_line_interpolate_cartesian Cartesian]
50* [link geometry.reference.strategies.strategy_line_interpolate_spherical Spherical]
51* [link geometry.reference.strategies.strategy_line_interpolate_geographic Geographic]
52
53[heading Example]
54[line_interpolate_strategy]
55[line_interpolate_strategy_output]
56
57[heading See also]
58* [link geometry.reference.algorithms.densify densify]
59
60
61[endsect]
62
63[section:line_interpolate_3 line_interpolate]
64
65'''<indexterm><primary>line_interpolate</primary></indexterm>'''
66Returns one or more points interpolated along a LineString.
67
68[heading Synopsis]
69``template<typename Geometry, typename Distance, typename Pointlike>
70void line_interpolate(Geometry const & geometry, Distance const & max_distance, Pointlike & pointlike)``
71
72[heading Parameters]
73
74[table
75[[Type] [Concept] [Name] [Description] ]
76[[Geometry const &] [Any type fulfilling a LineString concept ] [geometry] [Input geometry ]]
77[[Distance const &] [A numerical distance measure ] [max_distance] [Distance threshold (in units depending on coordinate system) representing the spacing between the points ]]
78[[Pointlike &] [Any type fulfilling Point or Multipoint concept ] [pointlike] [Output: either a Point (exactly one point will be constructed) or a MultiPoint (depending on the max_distance one or more points will be constructed)]]
79]
80
81
82[heading Header]
83Either
84
85`#include <boost/geometry.hpp>`
86
87
88Or
89
90`#include <boost/geometry/algorithms/line_interpolate.hpp>`
91
92[include reference/algorithms/line_interpolate.qbk]
93
94[heading Example]
95[line_interpolate]
96[line_interpolate_output]
97
98[heading See also]
99* [link geometry.reference.algorithms.densify densify]
100
101
102[endsect]
103
104