• 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/classboost_1_1geometry_1_1strategy_1_1line__interpolate_1_1cartesian.xml]
16[section:strategy_line_interpolate_cartesian strategy::line_interpolate::cartesian]
17
18'''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>line_interpolate</primary></indexterm><indexterm><primary>cartesian</primary></indexterm>'''
19Interpolate point on a cartesian segment.
20
21[heading Synopsis]
22``template<typename CalculationType, typename DistanceStrategy>
23class strategy::line_interpolate::cartesian
24{
25  // ...
26};
27``
28
29[heading Template parameter(s)]
30[table
31[[Parameter] [Default] [Description]]
32[[typename CalculationType] [void] [numeric type for calculation (e.g. high precision); if [*void] then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point ]]
33[[typename DistanceStrategy] [distance::pythagoras<CalculationType>] [The underlying point-point distance strategy]]
34]
35
36[heading Member Function(s)]
37[table
38[[Function] [Description] [Parameters]  [Returns]]
39[[``distance_pp_strategy::type get_distance_pp_strategy()``
40
41] [] [
42
43][
44
45]
46]
47[[``template<typename Point, typename Fraction, typename Distance>
48void apply(Point const & p0, Point const & p1, Fraction const & fraction,
49           Point & p, Distance const & )``
50
51] [] [[* Point const &]: ['p0]:
52
53[* Point const &]: ['p1]:
54
55[* Fraction const &]: ['fraction]:
56
57[* Point &]: ['p]:
58
59[* Distance const &]: [']:
60
61
62
63][
64
65]
66]
67]
68
69[heading Header]
70`#include <boost/geometry/strategies/cartesian/line_interpolate.hpp>`
71
72[heading See also]
73* [link geometry.reference.algorithms.line_interpolate.line_interpolate_4_with_strategy line_interpolate (with strategy)]
74
75[endsect]
76
77