line_interpolate.qbk 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. [/============================================================================
  2. Boost.Geometry (aka GGL, Generic Geometry Library)
  3. Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
  4. Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
  5. Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
  6. Use, modification and distribution is subject to the Boost Software License,
  7. Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  8. http://www.boost.org/LICENSE_1_0.txt)
  9. =============================================================================/]
  10. [/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
  11. [/ Generated from doxy/doxygen_output/xml/group__line__interpolate.xml]
  12. [section:line_interpolate_4_with_strategy line_interpolate (with strategy)]
  13. '''<indexterm><primary>line_interpolate</primary></indexterm>'''
  14. Returns one or more points interpolated along a LineString using the specified strategy.
  15. [heading Synopsis]
  16. ``template<typename Geometry, typename Distance, typename Pointlike, typename Strategy>
  17. void line_interpolate(Geometry const & geometry, Distance const & max_distance, Pointlike & pointlike,
  18. Strategy const & strategy)``
  19. [heading Parameters]
  20. [table
  21. [[Type] [Concept] [Name] [Description] ]
  22. [[Geometry const &] [Any type fulfilling a LineString concept ] [geometry] [Input geometry ]]
  23. [[Distance const &] [A numerical distance measure ] [max_distance] [Distance threshold (in units depending on coordinate system) representing the spacing between the points ]]
  24. [[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) ]]
  25. [[Strategy const &] [A type fulfilling a LineInterpolatePointStrategy concept ] [strategy] [line_interpolate strategy to be used for interpolation of points]]
  26. ]
  27. [heading Header]
  28. Either
  29. `#include <boost/geometry.hpp>`
  30. Or
  31. `#include <boost/geometry/algorithms/line_interpolate.hpp>`
  32. [include reference/algorithms/line_interpolate.qbk]
  33. [heading Available Strategies]
  34. * [link geometry.reference.strategies.strategy_line_interpolate_cartesian Cartesian]
  35. * [link geometry.reference.strategies.strategy_line_interpolate_spherical Spherical]
  36. * [link geometry.reference.strategies.strategy_line_interpolate_geographic Geographic]
  37. [heading Example]
  38. [line_interpolate_strategy]
  39. [line_interpolate_strategy_output]
  40. [heading See also]
  41. * [link geometry.reference.algorithms.densify densify]
  42. [endsect]
  43. [section:line_interpolate_3 line_interpolate]
  44. '''<indexterm><primary>line_interpolate</primary></indexterm>'''
  45. Returns one or more points interpolated along a LineString.
  46. [heading Synopsis]
  47. ``template<typename Geometry, typename Distance, typename Pointlike>
  48. void line_interpolate(Geometry const & geometry, Distance const & max_distance, Pointlike & pointlike)``
  49. [heading Parameters]
  50. [table
  51. [[Type] [Concept] [Name] [Description] ]
  52. [[Geometry const &] [Any type fulfilling a LineString concept ] [geometry] [Input geometry ]]
  53. [[Distance const &] [A numerical distance measure ] [max_distance] [Distance threshold (in units depending on coordinate system) representing the spacing between the points ]]
  54. [[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)]]
  55. ]
  56. [heading Header]
  57. Either
  58. `#include <boost/geometry.hpp>`
  59. Or
  60. `#include <boost/geometry/algorithms/line_interpolate.hpp>`
  61. [include reference/algorithms/line_interpolate.qbk]
  62. [heading Example]
  63. [line_interpolate]
  64. [line_interpolate_output]
  65. [heading See also]
  66. * [link geometry.reference.algorithms.densify densify]
  67. [endsect]