libs/geometry/doc/generated/transform_rotate_transformer.qbk

   1 [/============================================================================
   2   Boost.Geometry (aka GGL, Generic Geometry Library)
   3
   4   Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
   5   Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
   6   Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
   7
   8   Use, modification and distribution is subject to the Boost Software License,
   9   Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  10   http://www.boost.org/LICENSE_1_0.txt)
  11 =============================================================================/]
  12
  13
  14 [/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
  15 [/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1transform_1_1rotate__transformer.xml]
  16 [section:strategy_transform_rotate_transformer strategy::transform::rotate_transformer]
  17
  18 '''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>transform</primary></indexterm><indexterm><primary>rotate_transformer</primary></indexterm>'''
  19 Strategy for rotate transformation in Cartesian coordinate system.
  20
  21 [heading Description]
  22 Rotate rotates a geometry by a specified angle about a fixed point (e.g. origin).
  23
  24 [heading Synopsis]
  25 ``template<typename DegreeOrRadian, typename CalculationType, std::size_t Dimension1, std::size_t Dimension2>
  26 class strategy::transform::rotate_transformer
  27       : public detail::rad_rotate_transformer< CalculationType, Dimension1, Dimension2 >
  28 {
  29   // ...
  30 };
  31 ``
  32
  33 [heading Template parameter(s)]
  34 [table
  35 [[Parameter] [Description]]
  36 [[typename DegreeOrRadian] [degree/or/radian, type of rotation angle specification ]]
  37 [[typename CalculationType] []]
  38 [[std::size_t Dimension1] []]
  39 [[std::size_t Dimension2] []]
  40 ]
  41
  42 [heading Constructor(s)]
  43 [table
  44 [[Function] [Description] [Parameters] ]
  45 [[``rotate_transformer(CalculationType const & angle)``
  46
  47 ] [] [[* CalculationType const &]: ['angle]:
  48
  49
  50
  51 ]]
  52 ]
  53
  54 [heading Header]
  55 `#include <boost/geometry/strategies/transform/matrix_transformers.hpp>`
  56
  57 [endsect]
  58