Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[blender.git] / extern / Eigen2 / Eigen / src / Geometry / EulerAngles.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra. Eigen itself is part of the KDE project.
3 //
4 // Copyright (C) 2008 Gael Guennebaud <g.gael@free.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_EULERANGLES_H
26 #define EIGEN_EULERANGLES_H
27
28 /** \geometry_module \ingroup Geometry_Module
29   * \nonstableyet
30   *
31   * \returns the Euler-angles of the rotation matrix \c *this using the convention defined by the triplet (\a a0,\a a1,\a a2)
32   *
33   * Each of the three parameters \a a0,\a a1,\a a2 represents the respective rotation axis as an integer in {0,1,2}.
34   * For instance, in:
35   * \code Vector3f ea = mat.eulerAngles(2, 0, 2); \endcode
36   * "2" represents the z axis and "0" the x axis, etc. The returned angles are such that
37   * we have the following equality:
38   * \code
39   * mat == AngleAxisf(ea[0], Vector3f::UnitZ())
40   *      * AngleAxisf(ea[1], Vector3f::UnitX())
41   *      * AngleAxisf(ea[2], Vector3f::UnitZ()); \endcode
42   * This corresponds to the right-multiply conventions (with right hand side frames).
43   */
44 template<typename Derived>
45 inline Matrix<typename MatrixBase<Derived>::Scalar,3,1>
46 MatrixBase<Derived>::eulerAngles(int a0, int a1, int a2) const
47 {
48   /* Implemented from Graphics Gems IV */
49   EIGEN_STATIC_ASSERT_MATRIX_SPECIFIC_SIZE(Derived,3,3)
50
51   Matrix<Scalar,3,1> res;
52   typedef Matrix<typename Derived::Scalar,2,1> Vector2;
53   const Scalar epsilon = precision<Scalar>();
54
55   const int odd = ((a0+1)%3 == a1) ? 0 : 1;
56   const int i = a0;
57   const int j = (a0 + 1 + odd)%3;
58   const int k = (a0 + 2 - odd)%3;
59
60   if (a0==a2)
61   {
62     Scalar s = Vector2(coeff(j,i) , coeff(k,i)).norm();
63     res[1] = ei_atan2(s, coeff(i,i));
64     if (s > epsilon)
65     {
66       res[0] = ei_atan2(coeff(j,i), coeff(k,i));
67       res[2] = ei_atan2(coeff(i,j),-coeff(i,k));
68     }
69     else
70     {
71       res[0] = Scalar(0);
72       res[2] = (coeff(i,i)>0?1:-1)*ei_atan2(-coeff(k,j), coeff(j,j));
73     }
74   }
75   else
76   {
77     Scalar c = Vector2(coeff(i,i) , coeff(i,j)).norm();
78     res[1] = ei_atan2(-coeff(i,k), c);
79     if (c > epsilon)
80     {
81       res[0] = ei_atan2(coeff(j,k), coeff(k,k));
82       res[2] = ei_atan2(coeff(i,j), coeff(i,i));
83     }
84     else
85     {
86       res[0] = Scalar(0);
87       res[2] = (coeff(i,k)>0?1:-1)*ei_atan2(-coeff(k,j), coeff(j,j));
88     }
89   }
90   if (!odd)
91     res = -res;
92   return res;
93 }
94
95
96 #endif // EIGEN_EULERANGLES_H