point_xy.qbk 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  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/classboost_1_1geometry_1_1model_1_1d2_1_1point__xy.xml]
  12. [section:model_d2_point_xy model::d2::point_xy]
  13. '''<indexterm><primary>model</primary></indexterm><indexterm><primary>d2</primary></indexterm><indexterm><primary>point_xy</primary></indexterm>'''
  14. 2D point in Cartesian coordinate system
  15. [heading Model of]
  16. [link geometry.reference.concepts.concept_point Point Concept]
  17. [heading Synopsis]
  18. ``template<typename CoordinateType, typename CoordinateSystem>
  19. class model::d2::point_xy
  20. : public model::point< CoordinateType, 2, CoordinateSystem >
  21. {
  22. // ...
  23. };
  24. ``
  25. [heading Template parameter(s)]
  26. [table
  27. [[Parameter] [Default] [Description]]
  28. [[typename CoordinateType] [] [numeric type, for example, double, float, int ]]
  29. [[typename CoordinateSystem] [cs::cartesian] [coordinate system, defaults to cs::cartesian]]
  30. ]
  31. [heading Constructor(s)]
  32. [table
  33. [[Function] [Description] [Parameters] ]
  34. [[``point_xy()``
  35. ] [Default constructor, no initialization. ] [
  36. ]]
  37. [[``point_xy(CoordinateType const & x, CoordinateType const & y)``
  38. ] [Constructor with x/y values. ] [[* CoordinateType const &]: ['x]:
  39. [* CoordinateType const &]: ['y]:
  40. ]]
  41. ]
  42. [heading Member Function(s)]
  43. [table
  44. [[Function] [Description] [Parameters] [Returns]]
  45. [[``CoordinateType const & x()``
  46. ] [Get x-value. ] [
  47. ][
  48. ]
  49. ]
  50. [[``CoordinateType const & y()``
  51. ] [Get y-value. ] [
  52. ][
  53. ]
  54. ]
  55. [[``void x(CoordinateType const & v)``
  56. ] [Set x-value. ] [[* CoordinateType const &]: ['v]:
  57. ][
  58. ]
  59. ]
  60. [[``void y(CoordinateType const & v)``
  61. ] [Set y-value. ] [[* CoordinateType const &]: ['v]:
  62. ][
  63. ]
  64. ]
  65. ]
  66. [heading Header]
  67. `#include <boost/geometry/geometries/point_xy.hpp>`
  68. [include reference/geometries/point_xy.qbk]
  69. [include reference/geometries/point_assign_warning.qbk]
  70. [endsect]