Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[blender.git] / extern / Eigen2 / Eigen / src / Geometry / Scaling.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_SCALING_H
26 #define EIGEN_SCALING_H
27
28 /** \geometry_module \ingroup Geometry_Module
29   *
30   * \class Scaling
31   *
32   * \brief Represents a possibly non uniform scaling transformation
33   *
34   * \param _Scalar the scalar type, i.e., the type of the coefficients.
35   * \param _Dim the  dimension of the space, can be a compile time value or Dynamic
36   *
37   * \note This class is not aimed to be used to store a scaling transformation,
38   * but rather to make easier the constructions and updates of Transform objects.
39   *
40   * \sa class Translation, class Transform
41   */
42 template<typename _Scalar, int _Dim>
43 class Scaling
44 {
45 public:
46   EIGEN_MAKE_ALIGNED_OPERATOR_NEW_IF_VECTORIZABLE_FIXED_SIZE(_Scalar,_Dim)
47   /** dimension of the space */
48   enum { Dim = _Dim };
49   /** the scalar type of the coefficients */
50   typedef _Scalar Scalar;
51   /** corresponding vector type */
52   typedef Matrix<Scalar,Dim,1> VectorType;
53   /** corresponding linear transformation matrix type */
54   typedef Matrix<Scalar,Dim,Dim> LinearMatrixType;
55   /** corresponding translation type */
56   typedef Translation<Scalar,Dim> TranslationType;
57   /** corresponding affine transformation type */
58   typedef Transform<Scalar,Dim> TransformType;
59
60 protected:
61
62   VectorType m_coeffs;
63
64 public:
65
66   /** Default constructor without initialization. */
67   Scaling() {}
68   /** Constructs and initialize a uniform scaling transformation */
69   explicit inline Scaling(const Scalar& s) { m_coeffs.setConstant(s); }
70   /** 2D only */
71   inline Scaling(const Scalar& sx, const Scalar& sy)
72   {
73     ei_assert(Dim==2);
74     m_coeffs.x() = sx;
75     m_coeffs.y() = sy;
76   }
77   /** 3D only */
78   inline Scaling(const Scalar& sx, const Scalar& sy, const Scalar& sz)
79   {
80     ei_assert(Dim==3);
81     m_coeffs.x() = sx;
82     m_coeffs.y() = sy;
83     m_coeffs.z() = sz;
84   }
85   /** Constructs and initialize the scaling transformation from a vector of scaling coefficients */
86   explicit inline Scaling(const VectorType& coeffs) : m_coeffs(coeffs) {}
87
88   const VectorType& coeffs() const { return m_coeffs; }
89   VectorType& coeffs() { return m_coeffs; }
90
91   /** Concatenates two scaling */
92   inline Scaling operator* (const Scaling& other) const
93   { return Scaling(coeffs().cwise() * other.coeffs()); }
94
95   /** Concatenates a scaling and a translation */
96   inline TransformType operator* (const TranslationType& t) const;
97
98   /** Concatenates a scaling and an affine transformation */
99   inline TransformType operator* (const TransformType& t) const;
100
101   /** Concatenates a scaling and a linear transformation matrix */
102   // TODO returns an expression
103   inline LinearMatrixType operator* (const LinearMatrixType& other) const
104   { return coeffs().asDiagonal() * other; }
105
106   /** Concatenates a linear transformation matrix and a scaling */
107   // TODO returns an expression
108   friend inline LinearMatrixType operator* (const LinearMatrixType& other, const Scaling& s)
109   { return other * s.coeffs().asDiagonal(); }
110
111   template<typename Derived>
112   inline LinearMatrixType operator*(const RotationBase<Derived,Dim>& r) const
113   { return *this * r.toRotationMatrix(); }
114
115   /** Applies scaling to vector */
116   inline VectorType operator* (const VectorType& other) const
117   { return coeffs().asDiagonal() * other; }
118
119   /** \returns the inverse scaling */
120   inline Scaling inverse() const
121   { return Scaling(coeffs().cwise().inverse()); }
122
123   inline Scaling& operator=(const Scaling& other)
124   {
125     m_coeffs = other.m_coeffs;
126     return *this;
127   }
128
129   /** \returns \c *this with scalar type casted to \a NewScalarType
130     *
131     * Note that if \a NewScalarType is equal to the current scalar type of \c *this
132     * then this function smartly returns a const reference to \c *this.
133     */
134   template<typename NewScalarType>
135   inline typename ei_cast_return_type<Scaling,Scaling<NewScalarType,Dim> >::type cast() const
136   { return typename ei_cast_return_type<Scaling,Scaling<NewScalarType,Dim> >::type(*this); }
137
138   /** Copy constructor with scalar type conversion */
139   template<typename OtherScalarType>
140   inline explicit Scaling(const Scaling<OtherScalarType,Dim>& other)
141   { m_coeffs = other.coeffs().template cast<Scalar>(); }
142
143   /** \returns \c true if \c *this is approximately equal to \a other, within the precision
144     * determined by \a prec.
145     *
146     * \sa MatrixBase::isApprox() */
147   bool isApprox(const Scaling& other, typename NumTraits<Scalar>::Real prec = precision<Scalar>()) const
148   { return m_coeffs.isApprox(other.m_coeffs, prec); }
149
150 };
151
152 /** \addtogroup Geometry_Module */
153 //@{
154 typedef Scaling<float, 2> Scaling2f;
155 typedef Scaling<double,2> Scaling2d;
156 typedef Scaling<float, 3> Scaling3f;
157 typedef Scaling<double,3> Scaling3d;
158 //@}
159
160 template<typename Scalar, int Dim>
161 inline typename Scaling<Scalar,Dim>::TransformType
162 Scaling<Scalar,Dim>::operator* (const TranslationType& t) const
163 {
164   TransformType res;
165   res.matrix().setZero();
166   res.linear().diagonal() = coeffs();
167   res.translation() = m_coeffs.cwise() * t.vector();
168   res(Dim,Dim) = Scalar(1);
169   return res;
170 }
171
172 template<typename Scalar, int Dim>
173 inline typename Scaling<Scalar,Dim>::TransformType
174 Scaling<Scalar,Dim>::operator* (const TransformType& t) const
175 {
176   TransformType res = t;
177   res.prescale(m_coeffs);
178   return res;
179 }
180
181 #endif // EIGEN_SCALING_H