Another set of UI messages fixes and tweaks! No functional changes.
[blender.git] / extern / Eigen3 / Eigen / src / Geometry / Rotation2D.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr>
5 //
6 // Eigen is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 3 of the License, or (at your option) any later version.
10 //
11 // Alternatively, you can redistribute it and/or
12 // modify it under the terms of the GNU General Public License as
13 // published by the Free Software Foundation; either version 2 of
14 // the License, or (at your option) any later version.
15 //
16 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
17 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
19 // GNU General Public License for more details.
20 //
21 // You should have received a copy of the GNU Lesser General Public
22 // License and a copy of the GNU General Public License along with
23 // Eigen. If not, see <http://www.gnu.org/licenses/>.
24
25 #ifndef EIGEN_ROTATION2D_H
26 #define EIGEN_ROTATION2D_H
27
28 /** \geometry_module \ingroup Geometry_Module
29   *
30   * \class Rotation2D
31   *
32   * \brief Represents a rotation/orientation in a 2 dimensional space.
33   *
34   * \param _Scalar the scalar type, i.e., the type of the coefficients
35   *
36   * This class is equivalent to a single scalar representing a counter clock wise rotation
37   * as a single angle in radian. It provides some additional features such as the automatic
38   * conversion from/to a 2x2 rotation matrix. Moreover this class aims to provide a similar
39   * interface to Quaternion in order to facilitate the writing of generic algorithms
40   * dealing with rotations.
41   *
42   * \sa class Quaternion, class Transform
43   */
44
45 namespace internal {
46
47 template<typename _Scalar> struct traits<Rotation2D<_Scalar> >
48 {
49   typedef _Scalar Scalar;
50 };
51 } // end namespace internal
52
53 template<typename _Scalar>
54 class Rotation2D : public RotationBase<Rotation2D<_Scalar>,2>
55 {
56   typedef RotationBase<Rotation2D<_Scalar>,2> Base;
57
58 public:
59
60   using Base::operator*;
61
62   enum { Dim = 2 };
63   /** the scalar type of the coefficients */
64   typedef _Scalar Scalar;
65   typedef Matrix<Scalar,2,1> Vector2;
66   typedef Matrix<Scalar,2,2> Matrix2;
67
68 protected:
69
70   Scalar m_angle;
71
72 public:
73
74   /** Construct a 2D counter clock wise rotation from the angle \a a in radian. */
75   inline Rotation2D(Scalar a) : m_angle(a) {}
76
77   /** \returns the rotation angle */
78   inline Scalar angle() const { return m_angle; }
79
80   /** \returns a read-write reference to the rotation angle */
81   inline Scalar& angle() { return m_angle; }
82
83   /** \returns the inverse rotation */
84   inline Rotation2D inverse() const { return -m_angle; }
85
86   /** Concatenates two rotations */
87   inline Rotation2D operator*(const Rotation2D& other) const
88   { return m_angle + other.m_angle; }
89
90   /** Concatenates two rotations */
91   inline Rotation2D& operator*=(const Rotation2D& other)
92   { return m_angle += other.m_angle; return *this; }
93
94   /** Applies the rotation to a 2D vector */
95   Vector2 operator* (const Vector2& vec) const
96   { return toRotationMatrix() * vec; }
97
98   template<typename Derived>
99   Rotation2D& fromRotationMatrix(const MatrixBase<Derived>& m);
100   Matrix2 toRotationMatrix(void) const;
101
102   /** \returns the spherical interpolation between \c *this and \a other using
103     * parameter \a t. It is in fact equivalent to a linear interpolation.
104     */
105   inline Rotation2D slerp(Scalar t, const Rotation2D& other) const
106   { return m_angle * (1-t) + other.angle() * t; }
107
108   /** \returns \c *this with scalar type casted to \a NewScalarType
109     *
110     * Note that if \a NewScalarType is equal to the current scalar type of \c *this
111     * then this function smartly returns a const reference to \c *this.
112     */
113   template<typename NewScalarType>
114   inline typename internal::cast_return_type<Rotation2D,Rotation2D<NewScalarType> >::type cast() const
115   { return typename internal::cast_return_type<Rotation2D,Rotation2D<NewScalarType> >::type(*this); }
116
117   /** Copy constructor with scalar type conversion */
118   template<typename OtherScalarType>
119   inline explicit Rotation2D(const Rotation2D<OtherScalarType>& other)
120   {
121     m_angle = Scalar(other.angle());
122   }
123
124   inline static Rotation2D Identity() { return Rotation2D(0); }
125
126   /** \returns \c true if \c *this is approximately equal to \a other, within the precision
127     * determined by \a prec.
128     *
129     * \sa MatrixBase::isApprox() */
130   bool isApprox(const Rotation2D& other, typename NumTraits<Scalar>::Real prec = NumTraits<Scalar>::dummy_precision()) const
131   { return internal::isApprox(m_angle,other.m_angle, prec); }
132 };
133
134 /** \ingroup Geometry_Module
135   * single precision 2D rotation type */
136 typedef Rotation2D<float> Rotation2Df;
137 /** \ingroup Geometry_Module
138   * double precision 2D rotation type */
139 typedef Rotation2D<double> Rotation2Dd;
140
141 /** Set \c *this from a 2x2 rotation matrix \a mat.
142   * In other words, this function extract the rotation angle
143   * from the rotation matrix.
144   */
145 template<typename Scalar>
146 template<typename Derived>
147 Rotation2D<Scalar>& Rotation2D<Scalar>::fromRotationMatrix(const MatrixBase<Derived>& mat)
148 {
149   EIGEN_STATIC_ASSERT(Derived::RowsAtCompileTime==2 && Derived::ColsAtCompileTime==2,YOU_MADE_A_PROGRAMMING_MISTAKE)
150   m_angle = internal::atan2(mat.coeff(1,0), mat.coeff(0,0));
151   return *this;
152 }
153
154 /** Constructs and \returns an equivalent 2x2 rotation matrix.
155   */
156 template<typename Scalar>
157 typename Rotation2D<Scalar>::Matrix2
158 Rotation2D<Scalar>::toRotationMatrix(void) const
159 {
160   Scalar sinA = internal::sin(m_angle);
161   Scalar cosA = internal::cos(m_angle);
162   return (Matrix2() << cosA, -sinA, sinA, cosA).finished();
163 }
164
165 #endif // EIGEN_ROTATION2D_H