libs/geometry/doc/doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1transform_1_1rotate__transformer.xml

   1 <?xml version='1.0' encoding='UTF-8' standalone='no'?>
   2 <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.6">
   3   <compounddef id="classboost_1_1geometry_1_1strategy_1_1transform_1_1rotate__transformer" kind="class" prot="public">
   4     <compoundname>boost::geometry::strategy::transform::rotate_transformer</compoundname>
   5     <basecompoundref prot="public" virt="non-virtual">detail::rad_rotate_transformer&lt; CalculationType, Dimension1, Dimension2 &gt;</basecompoundref>
   6     <includes local="no">matrix_transformers.hpp</includes>
   7     <templateparamlist>
   8       <param>
   9         <type>typename</type>
  10         <declname>DegreeOrRadian</declname>
  11         <defname>DegreeOrRadian</defname>
  12       </param>
  13       <param>
  14         <type>typename</type>
  15         <declname>CalculationType</declname>
  16         <defname>CalculationType</defname>
  17       </param>
  18       <param>
  19         <type>std::size_t</type>
  20         <declname>Dimension1</declname>
  21         <defname>Dimension1</defname>
  22       </param>
  23       <param>
  24         <type>std::size_t</type>
  25         <declname>Dimension2</declname>
  26         <defname>Dimension2</defname>
  27       </param>
  28     </templateparamlist>
  29       <sectiondef kind="public-func">
  30       <memberdef kind="function" id="classboost_1_1geometry_1_1strategy_1_1transform_1_1rotate__transformer_1a221aa2c0b9ef219f6c807406e6134c20" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
  31         <type></type>
  32         <definition>boost::geometry::strategy::transform::rotate_transformer&lt; DegreeOrRadian, CalculationType, Dimension1, Dimension2 &gt;::rotate_transformer</definition>
  33         <argsstring>(CalculationType const &amp;angle)</argsstring>
  34         <name>rotate_transformer</name>
  35         <param>
  36           <type>CalculationType const &amp;</type>
  37           <declname>angle</declname>
  38         </param>
  39         <briefdescription>
  40         </briefdescription>
  41         <detaileddescription>
  42         </detaileddescription>
  43         <inbodydescription>
  44         </inbodydescription>
  45         <location file="/home/ubuntu/boost/boost/geometry/strategies/transform/matrix_transformers.hpp" line="404" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/transform/matrix_transformers.hpp" bodystart="404" bodyend="409"/>
  46       </memberdef>
  47       </sectiondef>
  48     <briefdescription>
  49 <para>Strategy for rotate transformation in Cartesian coordinate system. </para>    </briefdescription>
  50     <detaileddescription>
  51 <para>Rotate rotates a geometry of specified angle about a fixed point (e.g. origin). <simplesect kind="see"><para><ulink url="http://en.wikipedia.org/wiki/Rotation_%28mathematics%29">http://en.wikipedia.org/wiki/Rotation_%28mathematics%29</ulink></para></simplesect>
  52 <parameterlist kind="templateparam"><parameteritem>
  53 <parameternamelist>
  54 <parametername>DegreeOrRadian</parametername>
  55 </parameternamelist>
  56 <parameterdescription>
  57 <para>degree/or/radian, type of rotation angle specification </para></parameterdescription>
  58 </parameteritem>
  59 </parameterlist>
  60 <simplesect kind="note"><para>A single angle is needed to specify a rotation in 2D. Not yet in 3D, the 3D version requires special things to allow for rotation around X, Y, Z or arbitrary axis. </para></simplesect>
  61 </para>    </detaileddescription>
  62     <inheritancegraph>
  63       <node id="1542">
  64         <label>boost::geometry::strategy::transform::rotate_transformer&lt; DegreeOrRadian, CalculationType, Dimension1, Dimension2 &gt;</label>
  65         <link refid="classboost_1_1geometry_1_1strategy_1_1transform_1_1rotate__transformer"/>
  66         <childnode refid="1543" relation="public-inheritance">
  67         </childnode>
  68       </node>
  69       <node id="1543">
  70         <label>detail::rad_rotate_transformer&lt; CalculationType, Dimension1, Dimension2 &gt;</label>
  71       </node>
  72     </inheritancegraph>
  73     <collaborationgraph>
  74       <node id="1544">
  75         <label>boost::geometry::strategy::transform::rotate_transformer&lt; DegreeOrRadian, CalculationType, Dimension1, Dimension2 &gt;</label>
  76         <link refid="classboost_1_1geometry_1_1strategy_1_1transform_1_1rotate__transformer"/>
  77         <childnode refid="1545" relation="public-inheritance">
  78         </childnode>
  79       </node>
  80       <node id="1545">
  81         <label>detail::rad_rotate_transformer&lt; CalculationType, Dimension1, Dimension2 &gt;</label>
  82       </node>
  83     </collaborationgraph>
  84     <location file="/home/ubuntu/boost/boost/geometry/strategies/transform/matrix_transformers.hpp" line="401" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/transform/matrix_transformers.hpp" bodystart="400" bodyend="410"/>
  85     <listofallmembers>
  86       <member refid="classboost_1_1geometry_1_1strategy_1_1transform_1_1rotate__transformer_1a221aa2c0b9ef219f6c807406e6134c20" prot="public" virt="non-virtual"><scope>boost::geometry::strategy::transform::rotate_transformer</scope><name>rotate_transformer</name></member>
  87     </listofallmembers>
  88   </compounddef>
  89 </doxygen>