transform_rotate_transformer.qbk 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  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_1rotate__transformer.xml]
  12. [section:strategy_transform_rotate_transformer strategy::transform::rotate_transformer]
  13. '''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>transform</primary></indexterm><indexterm><primary>rotate_transformer</primary></indexterm>'''
  14. Strategy for rotate transformation in Cartesian coordinate system.
  15. [heading Description]
  16. Rotate rotates a geometry by a specified angle about a fixed point (e.g. origin).
  17. [heading Synopsis]
  18. ``template<typename DegreeOrRadian, typename CalculationType, std::size_t Dimension1, std::size_t Dimension2>
  19. class strategy::transform::rotate_transformer
  20. : public detail::rad_rotate_transformer< CalculationType, Dimension1, Dimension2 >
  21. {
  22. // ...
  23. };
  24. ``
  25. [heading Template parameter(s)]
  26. [table
  27. [[Parameter] [Description]]
  28. [[typename DegreeOrRadian] [degree/or/radian, type of rotation angle specification ]]
  29. [[typename CalculationType] []]
  30. [[std::size_t Dimension1] []]
  31. [[std::size_t Dimension2] []]
  32. ]
  33. [heading Constructor(s)]
  34. [table
  35. [[Function] [Description] [Parameters] ]
  36. [[``rotate_transformer(CalculationType const & angle)``
  37. ] [] [[* CalculationType const &]: ['angle]:
  38. ]]
  39. ]
  40. [heading Header]
  41. `#include <boost/geometry/strategies/transform/matrix_transformers.hpp>`
  42. [endsect]