1 /*
2  * Copyright (C) 2010 The Android Open Source Project
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 #ifndef ANDROID_HWUI_MATRIX_H
18 #define ANDROID_HWUI_MATRIX_H
19 
20 #include <SkMatrix.h>
21 
22 #include <cutils/compiler.h>
23 
24 #include "Rect.h"
25 
26 namespace android {
27 namespace uirenderer {
28 
29 #define SK_MATRIX_STRING "[%.2f %.2f %.2f] [%.2f %.2f %.2f] [%.2f %.2f %.2f]"
30 #define SK_MATRIX_ARGS(m) \
31     (m)->get(0), (m)->get(1), (m)->get(2), \
32     (m)->get(3), (m)->get(4), (m)->get(5), \
33     (m)->get(6), (m)->get(7), (m)->get(8)
34 
35 #define MATRIX_4_STRING "[%.2f %.2f %.2f %.2f] [%.2f %.2f %.2f %.2f]" \
36     " [%.2f %.2f %.2f %.2f] [%.2f %.2f %.2f %.2f]"
37 #define MATRIX_4_ARGS(m) \
38     (m)->data[0], (m)->data[4], (m)->data[8], (m)->data[12], \
39     (m)->data[1], (m)->data[5], (m)->data[9], (m)->data[13], \
40     (m)->data[2], (m)->data[6], (m)->data[10], (m)->data[14], \
41     (m)->data[3], (m)->data[7], (m)->data[11], (m)->data[15] \
42 
43 ///////////////////////////////////////////////////////////////////////////////
44 // Classes
45 ///////////////////////////////////////////////////////////////////////////////
46 
47 class ANDROID_API Matrix4 {
48 public:
49     float data[16];
50 
51     enum Entry {
52         kScaleX = 0,
53         kSkewY = 1,
54         kPerspective0 = 3,
55         kSkewX = 4,
56         kScaleY = 5,
57         kPerspective1 = 7,
58         kScaleZ = 10,
59         kTranslateX = 12,
60         kTranslateY = 13,
61         kTranslateZ = 14,
62         kPerspective2 = 15
63     };
64 
65     // NOTE: The flags from kTypeIdentity to kTypePerspective
66     //       must be kept in sync with the type flags found
67     //       in SkMatrix
68     enum Type {
69         kTypeIdentity = 0,
70         kTypeTranslate = 0x1,
71         kTypeScale = 0x2,
72         kTypeAffine = 0x4,
73         kTypePerspective = 0x8,
74         kTypeRectToRect = 0x10,
75         kTypeUnknown = 0x20,
76     };
77 
78     static const int sGeometryMask = 0xf;
79 
Matrix4()80     Matrix4() {
81         loadIdentity();
82     }
83 
Matrix4(const float * v)84     Matrix4(const float* v) {
85         load(v);
86     }
87 
Matrix4(const Matrix4 & v)88     Matrix4(const Matrix4& v) {
89         load(v);
90     }
91 
Matrix4(const SkMatrix & v)92     Matrix4(const SkMatrix& v) {
93         load(v);
94     }
95 
96     float operator[](int index) const {
97         return data[index];
98     }
99 
100     float& operator[](int index) {
101         mType = kTypeUnknown;
102         return data[index];
103     }
104 
105     Matrix4& operator=(const SkMatrix& v) {
106         load(v);
107         return *this;
108     }
109 
110     friend bool operator==(const Matrix4& a, const Matrix4& b) {
111         return !memcmp(&a.data[0], &b.data[0], 16 * sizeof(float));
112     }
113 
114     friend bool operator!=(const Matrix4& a, const Matrix4& b) {
115         return !(a == b);
116     }
117 
118     void loadIdentity();
119 
120     void load(const float* v);
121     void load(const Matrix4& v);
122     void load(const SkMatrix& v);
123 
124     void loadInverse(const Matrix4& v);
125 
126     void loadTranslate(float x, float y, float z);
127     void loadScale(float sx, float sy, float sz);
128     void loadSkew(float sx, float sy);
129     void loadRotate(float angle);
130     void loadRotate(float angle, float x, float y, float z);
131     void loadMultiply(const Matrix4& u, const Matrix4& v);
132 
133     void loadOrtho(float left, float right, float bottom, float top, float near, float far);
134 
135     uint8_t getType() const;
136 
multiply(const Matrix4 & v)137     void multiply(const Matrix4& v) {
138         Matrix4 u;
139         u.loadMultiply(*this, v);
140         load(u);
141     }
142 
143     void multiply(float v);
144 
145     void translate(float x, float y, float z = 0) {
146         if ((getType() & sGeometryMask) <= kTypeTranslate) {
147             data[kTranslateX] += x;
148             data[kTranslateY] += y;
149             data[kTranslateZ] += z;
150             mType |= kTypeUnknown;
151         } else {
152             // Doing a translation will only affect the translate bit of the type
153             // Save the type
154             uint8_t type = mType;
155 
156             Matrix4 u;
157             u.loadTranslate(x, y, z);
158             multiply(u);
159 
160             // Restore the type and fix the translate bit
161             mType = type;
162             if (data[kTranslateX] != 0.0f || data[kTranslateY] != 0.0f) {
163                 mType |= kTypeTranslate;
164             } else {
165                 mType &= ~kTypeTranslate;
166             }
167         }
168     }
169 
scale(float sx,float sy,float sz)170     void scale(float sx, float sy, float sz) {
171         Matrix4 u;
172         u.loadScale(sx, sy, sz);
173         multiply(u);
174     }
175 
skew(float sx,float sy)176     void skew(float sx, float sy) {
177         Matrix4 u;
178         u.loadSkew(sx, sy);
179         multiply(u);
180     }
181 
rotate(float angle,float x,float y,float z)182     void rotate(float angle, float x, float y, float z) {
183         Matrix4 u;
184         u.loadRotate(angle, x, y, z);
185         multiply(u);
186     }
187 
188     /**
189      * If the matrix is identity or translate and/or scale.
190      */
191     bool isSimple() const;
192     bool isPureTranslate() const;
193     bool isIdentity() const;
194     bool isPerspective() const;
195     bool rectToRect() const;
196     bool positiveScale() const;
197 
198     bool changesBounds() const;
199 
200     void copyTo(float* v) const;
201     void copyTo(SkMatrix& v) const;
202 
203     float mapZ(const Vector3& orig) const;
204     void mapPoint3d(Vector3& vec) const;
205     void mapPoint(float& x, float& y) const; // 2d only
206     void mapRect(Rect& r) const; // 2d only
207 
208     float getTranslateX() const;
209     float getTranslateY() const;
210 
211     void decomposeScale(float& sx, float& sy) const;
212 
213     void dump(const char* label = NULL) const;
214 
215     static const Matrix4& identity();
216 
217 private:
218     mutable uint8_t mType;
219 
get(int i,int j)220     inline float get(int i, int j) const {
221         return data[i * 4 + j];
222     }
223 
set(int i,int j,float v)224     inline void set(int i, int j, float v) {
225         data[i * 4 + j] = v;
226     }
227 
228     uint8_t getGeometryType() const;
229 
230 }; // class Matrix4
231 
232 ///////////////////////////////////////////////////////////////////////////////
233 // Types
234 ///////////////////////////////////////////////////////////////////////////////
235 
236 typedef Matrix4 mat4;
237 
238 }; // namespace uirenderer
239 }; // namespace android
240 
241 #endif // ANDROID_HWUI_MATRIX_H
242