1 #ifndef __DALI_MATRIX3_H__
2 #define __DALI_MATRIX3_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/math/vector3.h>
23 #include <dali/public-api/math/matrix.h>
24 #include <dali/public-api/common/type-traits.h>
33 * @brief A 3x3 matrix.
36 class DALI_IMPORT_API Matrix3
40 friend std::ostream& operator<< (std::ostream& o, const Matrix3& matrix);
43 * @brief The identity matrix
45 static const Matrix3 IDENTITY;
53 * @brief Copy Constructor.
55 * @param[in] m Another 3x3 matrix
57 Matrix3(const Matrix3& m);
62 * @param[in] m A 4x4 matrix. The translation and shear components are ignored.
64 Matrix3(const Matrix& m);
69 * @param[in] s00 First element
70 * @param[in] s01 Second element
71 * @param[in] s02 Third element
72 * @param[in] s10 Fourth element
73 * @param[in] s11 Fifth element
74 * @param[in] s12 Sixth element
75 * @param[in] s20 Seventh element
76 * @param[in] s21 Eighth element
77 * @param[in] s22 Ninth element
79 Matrix3(float s00, float s01, float s02, float s10, float s11, float s12, float s20, float s21, float s22);
82 * @brief Assignment Operator
83 * @param matrix from which to copy values
84 * @return reference to this object
86 Matrix3& operator=( const Matrix3& matrix );
89 * @brief Assignment Operator
90 * @param matrix from which to copy values
91 * @return reference to this object
93 Matrix3& operator=( const Matrix& matrix );
96 * @brief The equality operator.
98 * Utilises appropriate machine epsilon values.
100 * @param [in] rhs the Matrix to compare this to
101 * @return true if the matrices are equal
103 bool operator==(const Matrix3 & rhs) const;
106 * @brief The inequality operator.
108 * Utilises appropriate machine epsilon values.
110 * @param [in] rhs the Matrix to compare this to
111 * @return true if the matrices are equal
113 bool operator!=(const Matrix3 & rhs) const;
123 * @brief Sets the matrix to the identity matrix.
128 * @brief Returns the contents of the matrix as an array of 9 floats.
130 * The order of the values for a matrix is:
131 * xAxis.x yAxis.x zAxis.x
132 * xAxis.y yAxis.y zAxis.y
133 * xAxis.z yAxis.z zAxis.z
134 * @return the matrix contents as an array of 9 floats.
136 const float* AsFloat() const {return &mElements[0];}
139 * @brief Returns the contents of the matrix as an array of 9 floats.
141 * The order of the values for a matrix is:
142 * xAxis.x yAxis.x zAxis.x
143 * xAxis.y yAxis.y zAxis.y
144 * xAxis.z yAxis.z zAxis.z
145 * @return the matrix contents as an array of 9 floats.
147 float* AsFloat() {return &mElements[0];}
150 * @brief Inverts the matrix.
152 * @return true if successful
157 * @brief Swaps the rows to columns
163 * @brief Multiplies all elements of the matrix by the scale value.
165 * @param scale - the value by which to scale the whole matrix.
168 void Scale(float scale);
171 * @brief Magnitude returns the average of the absolute values of the
174 * (The Magnitude of the unit matrix is therefore 1)
175 * @return the magnitude - always positive.
177 float Magnitude() const;
180 * @brief If the matrix is invertible, then this method inverts, transposes
181 * and scales the matrix such that the resultant element values
184 * If the matrix is not invertible, then the matrix is left unchanged.
186 * @return true if the matrix is invertible, otherwise false
188 bool ScaledInverseTranspose();
191 * @brief Function to multiply two matrices and store the result onto third.
193 * Use this method in time critical path as it does not require temporaries
194 * @param result of the multiplication
195 * @param lhs matrix, this can be same matrix as result
196 * @param rhs matrix, this cannot be same matrix as result
198 static void Multiply( Matrix3& result, const Matrix3& lhs, const Matrix3& rhs );
202 float mElements[9]; ///< The elements of the matrix
206 * @brief Print a 3x3 matrix.
208 * @param [in] o The output stream operator.
209 * @param [in] matrix The matrix to print.
210 * @return The output stream operator.
212 DALI_IMPORT_API std::ostream& operator<< (std::ostream& o, const Matrix3& matrix);
214 // Allow Matrix3 to be treated as a POD type
215 template <> struct TypeTraits< Matrix3 > : public BasicTypes< Matrix3 > { enum { IS_TRIVIAL_TYPE = true }; };
219 #endif //__DALI_MATRIX3_H__