Follow the include-order coding conventions
[platform/core/uifw/dali-core.git] / dali / public-api / math / matrix3.cpp
1 /*
2  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17
18 // CLASS HEADER
19 #include <dali/public-api/math/matrix3.h>
20
21 // EXTERNAL INCLUDES
22 #include <string.h>
23 #include <iostream>
24
25 // INTERNAL INCLUDES
26 #include <dali/public-api/math/math-utils.h>
27
28 #define S00 0
29 #define S01 1
30 #define S02 2
31 #define S10 3
32 #define S11 4
33 #define S12 5
34 #define S20 6
35 #define S21 7
36 #define S22 8
37
38 /*
39  * S00 S01 S02
40  * S10 S11 S12
41  * S20 S21 S22
42  */
43
44 namespace
45 {
46 const size_t NUM_BYTES_IN_ROW    = 3*sizeof(float);
47 const size_t NUM_BYTES_IN_MATRIX = 9*sizeof(float);
48 }
49
50 namespace Dali
51 {
52
53 const Matrix3 Matrix3::IDENTITY(1.0f, 0.0f, 0.0f,
54                                 0.0f, 1.0f, 0.0f,
55                                 0.0f, 0.0f, 1.0f);
56
57 Matrix3::Matrix3()
58 {
59   float* m = AsFloat();
60   memset(m, 0, NUM_BYTES_IN_MATRIX);
61   mElements[S00]=1.0f;
62   mElements[S11]=1.0f;
63   mElements[S22]=1.0f;
64 }
65
66 Matrix3::Matrix3(const Matrix3& m)
67 {
68   memcpy( mElements, m.mElements, NUM_BYTES_IN_MATRIX );
69 }
70
71 Matrix3::Matrix3(const Matrix& matrix)
72 {
73   const float* m4 = matrix.AsFloat();
74   memcpy(&mElements[S00], m4,   NUM_BYTES_IN_ROW);
75   memcpy(&mElements[S10], m4+4, NUM_BYTES_IN_ROW);
76   memcpy(&mElements[S20], m4+8, NUM_BYTES_IN_ROW);
77 }
78
79 Matrix3::Matrix3(float s00, float s01, float s02, float s10, float s11, float s12, float s20, float s21, float s22)
80 {
81   mElements[S00] = s00;
82   mElements[S01] = s01;
83   mElements[S02] = s02;
84   mElements[S10] = s10;
85   mElements[S11] = s11;
86   mElements[S12] = s12;
87   mElements[S20] = s20;
88   mElements[S21] = s21;
89   mElements[S22] = s22;
90 }
91
92
93 void Matrix3::SetIdentity()
94 {
95   memset(mElements, 0, NUM_BYTES_IN_MATRIX);
96   mElements[S00]=1.0f;
97   mElements[S11]=1.0f;
98   mElements[S22]=1.0f;
99 }
100
101 Matrix3& Matrix3::operator=( const Matrix3& matrix )
102 {
103   // no point copying if self assigning
104   if( this != &matrix )
105   {
106     memcpy( AsFloat(), matrix.AsFloat(), NUM_BYTES_IN_MATRIX );
107   }
108   return *this;
109 }
110
111 Matrix3& Matrix3::operator=( const Matrix& matrix )
112 {
113   const float* m4 = matrix.AsFloat();
114   memcpy(&mElements[S00], m4,   NUM_BYTES_IN_ROW);
115   memcpy(&mElements[S10], m4+4, NUM_BYTES_IN_ROW);
116   memcpy(&mElements[S20], m4+8, NUM_BYTES_IN_ROW);
117   return *this;
118 }
119
120 bool Matrix3::Invert()
121 {
122   bool succeeded = false;
123
124   float cof[9];
125   cof[S00] = (mElements[S11] * mElements[S22] - mElements[S12] * mElements[S21]);
126   cof[S01] = (mElements[S02] * mElements[S21] - mElements[S01] * mElements[S22]);
127   cof[S02] = (mElements[S01] * mElements[S12] - mElements[S02] * mElements[S11]);
128
129   cof[S10] = (mElements[S12] * mElements[S20] - mElements[S10] * mElements[S22]);
130   cof[S11] = (mElements[S00] * mElements[S22] - mElements[S02] * mElements[S20]);
131   cof[S12] = (mElements[S02] * mElements[S10] - mElements[S00] * mElements[S12]);
132
133   cof[S20] = (mElements[S10] * mElements[S21] - mElements[S11] * mElements[S20]);
134   cof[S21] = (mElements[S01] * mElements[S20] - mElements[S00] * mElements[S21]);
135   cof[S22] = (mElements[S00] * mElements[S11] - mElements[S01] * mElements[S10]);
136
137   float det = mElements[S00] * cof[S00] + mElements[S01] * cof[S10] + mElements[S02] * cof[S20];
138
139   // In the case where the determinant is exactly zero, the matrix is non-invertible
140   if( ! EqualsZero( det ) )
141   {
142     det = 1.0 / det;
143     for (int i = 0; i < 9; i++)
144     {
145       mElements[i] = cof[i] * det;
146     }
147     succeeded = true;
148   }
149   return succeeded;
150 }
151
152 bool Matrix3::Transpose()
153 {
154   float tmp;
155   tmp = mElements[S01]; mElements[S01] = mElements[S10]; mElements[S10]=tmp;
156   tmp = mElements[S02]; mElements[S02] = mElements[S20]; mElements[S20]=tmp;
157   tmp = mElements[S21]; mElements[S21] = mElements[S12]; mElements[S12]=tmp;
158   return true;
159 }
160
161 bool Matrix3::ScaledInverseTranspose()
162 {
163   bool succeeded = false;
164
165   float cof[9];
166   cof[S00] = (mElements[S11] * mElements[S22] - mElements[S12] * mElements[S21]);
167   cof[S01] = (mElements[S02] * mElements[S21] - mElements[S01] * mElements[S22]);
168   cof[S02] = (mElements[S01] * mElements[S12] - mElements[S02] * mElements[S11]);
169
170   cof[S10] = (mElements[S12] * mElements[S20] - mElements[S10] * mElements[S22]);
171   cof[S11] = (mElements[S00] * mElements[S22] - mElements[S02] * mElements[S20]);
172   cof[S12] = (mElements[S02] * mElements[S10] - mElements[S00] * mElements[S12]);
173
174   cof[S20] = (mElements[S10] * mElements[S21] - mElements[S11] * mElements[S20]);
175   cof[S21] = (mElements[S01] * mElements[S20] - mElements[S00] * mElements[S21]);
176   cof[S22] = (mElements[S00] * mElements[S11] - mElements[S01] * mElements[S10]);
177
178   float det = mElements[S00] * cof[S00] + mElements[S01] * cof[S10] + mElements[S02] * cof[S20];
179
180   // In the case where the determinant is exactly zero, the matrix is non-invertible
181   if( ! EqualsZero( det ) )
182   {
183     // Use average rather than determinant to remove rounding to zero errors in further multiplication
184     float sum=0;
185     for(size_t i=0;i<9;i++)
186     {
187       sum+=fabsf(cof[i]);
188     }
189     float scale = 9.0f/sum; // Inverse of the average values
190     if (det < 0)
191     {
192       // Ensure the signs of the inverse are correct
193       scale = -scale;
194     }
195
196     mElements[S00] = cof[S00] * scale;
197     mElements[S01] = cof[S10] * scale;
198     mElements[S02] = cof[S20] * scale;
199
200     mElements[S10] = cof[S01] * scale;
201     mElements[S11] = cof[S11] * scale;
202     mElements[S12] = cof[S21] * scale;
203
204     mElements[S20] = cof[S02] * scale;
205     mElements[S21] = cof[S12] * scale;
206     mElements[S22] = cof[S22] * scale;
207
208     succeeded = true;
209   }
210   return succeeded;
211 }
212
213 void Matrix3::Scale(float scale)
214 {
215   mElements[S00] *= scale;
216   mElements[S01] *= scale;
217   mElements[S02] *= scale;
218   mElements[S10] *= scale;
219   mElements[S11] *= scale;
220   mElements[S12] *= scale;
221   mElements[S20] *= scale;
222   mElements[S21] *= scale;
223   mElements[S22] *= scale;
224 }
225
226 float Matrix3::Magnitude() const
227 {
228   float avg=0;
229   for(size_t i=0;i<9;i++)
230   {
231     avg+=fabsf(mElements[i]);
232   }
233   return avg/3.0f;
234 }
235
236
237 void Matrix3::Multiply( Matrix3& result, const Matrix3& lhs, const Matrix3& rhs )
238 {
239   float* temp = result.AsFloat();
240   const float* rhsPtr  = rhs.AsFloat();
241   const float* lhsPtr = lhs.AsFloat();
242
243   for( int i=0; i < 3; i++ )
244   {
245     int loc = i * 3;
246     int loc1 = loc + 1;
247     int loc2 = loc + 2;
248
249     float value0 = lhsPtr[loc];
250     float value1 = lhsPtr[loc1];
251     float value2 = lhsPtr[loc2];
252     temp[loc]  = (value0 * rhsPtr[0]) +
253                  (value1 * rhsPtr[3]) +
254                  (value2 * rhsPtr[6]);
255
256     temp[loc1] = (value0 * rhsPtr[1]) +
257                  (value1 * rhsPtr[4]) +
258                  (value2 * rhsPtr[7]);
259
260     temp[loc2] = (value0 * rhsPtr[2]) +
261                  (value1 * rhsPtr[5]) +
262                  (value2 * rhsPtr[8]);
263   }
264 }
265
266 bool Matrix3::operator==(const Matrix3 & rhs) const
267 {
268   return (
269     Equals( mElements[0], rhs.mElements[0]) &&
270     Equals( mElements[1], rhs.mElements[1]) &&
271     Equals( mElements[2], rhs.mElements[2]) &&
272     Equals( mElements[3], rhs.mElements[3]) &&
273     Equals( mElements[4], rhs.mElements[4]) &&
274     Equals( mElements[5], rhs.mElements[5]) &&
275     Equals( mElements[6], rhs.mElements[6]) &&
276     Equals( mElements[7], rhs.mElements[7]) &&
277     Equals( mElements[8], rhs.mElements[8]));
278 }
279
280 bool Matrix3::operator!=(const Matrix3& rhs) const
281 {
282   return !(*this == rhs);
283 }
284
285 std::ostream& operator<< (std::ostream& o, const Matrix3& matrix)
286 {
287   return o << "[ [" << matrix.mElements[0] << ", " << matrix.mElements[1] << ", " << matrix.mElements[2]  << "], "
288              << "[" << matrix.mElements[3] << ", " << matrix.mElements[4] << ", " << matrix.mElements[5]  << "], "
289              << "[" << matrix.mElements[6] << ", " << matrix.mElements[7] << ", " << matrix.mElements[8]  << "] ]";
290 }
291
292 } // namespace Dali