transform_map_transformer.qbk 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  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_1strategy_1_1transform_1_1map__transformer.xml]
  12. [section:strategy_transform_map_transformer strategy::transform::map_transformer]
  13. '''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>transform</primary></indexterm><indexterm><primary>map_transformer</primary></indexterm>'''
  14. Transformation strategy to map from one to another Cartesian coordinate system.
  15. [heading Synopsis]
  16. ``template<typename CalculationType, std::size_t Dimension1, std::size_t Dimension2, bool Mirror,
  17. bool SameScale>
  18. class strategy::transform::map_transformer
  19. : public strategy::transform::matrix_transformer< CalculationType, Dimension1, Dimension2 >
  20. {
  21. // ...
  22. };
  23. ``
  24. [heading Template parameter(s)]
  25. [table
  26. [[Parameter] [Default] [Description]]
  27. [[typename CalculationType] [] []]
  28. [[std::size_t Dimension1] [] []]
  29. [[std::size_t Dimension2] [] []]
  30. [[bool Mirror] [false] [if true map is mirrored upside-down (in most cases pixels are from top to bottom, while map is from bottom to top) ]]
  31. [[bool SameScale] [true] []]
  32. ]
  33. [heading Constructor(s)]
  34. [table
  35. [[Function] [Description] [Parameters] ]
  36. [[``template<typename B, typename D>
  37. map_transformer(B const & box, D const & width, D const & height)``
  38. ] [] [[* B const &]: ['box]:
  39. [* D const &]: ['width]:
  40. [* D const &]: ['height]:
  41. ]]
  42. [[``template<typename W, typename D>
  43. map_transformer(W const & wx1, W const & wy1, W const & wx2,
  44. W const & wy2, D const & width, D const & height)``
  45. ] [] [[* W const &]: ['wx1]:
  46. [* W const &]: ['wy1]:
  47. [* W const &]: ['wx2]:
  48. [* W const &]: ['wy2]:
  49. [* D const &]: ['width]:
  50. [* D const &]: ['height]:
  51. ]]
  52. ]
  53. [heading Header]
  54. `#include <boost/geometry/strategies/transform/map_transformer.hpp>`
  55. [endsect]