boost/libs/geometry/doc/generated/line_interpolate_cartesian.qbk
2021-10-05 21:37:46 +02:00

77 lines
2.3 KiB
Plaintext

[/============================================================================
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/classboost_1_1geometry_1_1strategy_1_1line__interpolate_1_1cartesian.xml]
[section:strategy_line_interpolate_cartesian strategy::line_interpolate::cartesian]
'''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>line_interpolate</primary></indexterm><indexterm><primary>cartesian</primary></indexterm>'''
Interpolate point on a cartesian segment.
[heading Synopsis]
``template<typename CalculationType, typename DistanceStrategy>
class strategy::line_interpolate::cartesian
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Default] [Description]]
[[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 ]]
[[typename DistanceStrategy] [distance::pythagoras<CalculationType>] [The underlying point-point distance strategy]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
[[``distance_pp_strategy::type get_distance_pp_strategy()``
] [] [
][
]
]
[[``template<typename Point, typename Fraction, typename Distance>
void apply(Point const & p0, Point const & p1, Fraction const & fraction,
Point & p, Distance const & )``
] [] [[* Point const &]: ['p0]:
[* Point const &]: ['p1]:
[* Fraction const &]: ['fraction]:
[* Point &]: ['p]:
[* Distance const &]: [']:
][
]
]
]
[heading Header]
`#include <boost/geometry/strategies/cartesian/line_interpolate.hpp>`
[heading See also]
* [link geometry.reference.algorithms.line_interpolate.line_interpolate_4_with_strategy line_interpolate (with strategy)]
[endsect]