Matrix.h revision 7c85c54499994c687a833644f7f213e747fadb98 
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
26namespace android {
27namespace 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
47class ANDROID_API Matrix4 {
48public:
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
80    Matrix4() {
81        loadIdentity();
82    }
83
84    Matrix4(const float* v) {
85        load(v);
86    }
87
88    Matrix4(const SkMatrix& v) {
89        load(v);
90    }
91
92    float operator[](int index) const {
93        return data[index];
94    }
95
96    float& operator[](int index) {
97        mType = kTypeUnknown;
98        return data[index];
99    }
100
101    Matrix4& operator=(const SkMatrix& v) {
102        load(v);
103        return *this;
104    }
105
106    friend bool operator==(const Matrix4& a, const Matrix4& b) {
107        return !memcmp(&a.data[0], &b.data[0], 16 * sizeof(float));
108    }
109
110    friend bool operator!=(const Matrix4& a, const Matrix4& b) {
111        return !(a == b);
112    }
113
114    void loadIdentity();
115
116    void load(const float* v);
117    void load(const SkMatrix& v);
118
119    void loadInverse(const Matrix4& v);
120
121    void loadTranslate(float x, float y, float z);
122    void loadScale(float sx, float sy, float sz);
123    void loadSkew(float sx, float sy);
124    void loadRotate(float angle);
125    void loadRotate(float angle, float x, float y, float z);
126    void loadMultiply(const Matrix4& u, const Matrix4& v);
127
128    void loadOrtho(float left, float right, float bottom, float top, float near, float far);
129
130    uint8_t getType() const;
131
132    void multiplyInverse(const Matrix4& v) {
133        Matrix4 inv;
134        inv.loadInverse(v);
135        multiply(inv);
136    }
137
138    void multiply(const Matrix4& v) {
139        Matrix4 u;
140        u.loadMultiply(*this, v);
141        *this = u;
142    }
143
144    void multiply(float v);
145
146    void translate(float x, float y, float z = 0) {
147        if ((getType() & sGeometryMask) <= kTypeTranslate) {
148            data[kTranslateX] += x;
149            data[kTranslateY] += y;
150            data[kTranslateZ] += z;
151            mType |= kTypeUnknown;
152        } else {
153            // Doing a translation will only affect the translate bit of the type
154            // Save the type
155            uint8_t type = mType;
156
157            Matrix4 u;
158            u.loadTranslate(x, y, z);
159            multiply(u);
160
161            // Restore the type and fix the translate bit
162            mType = type;
163            if (data[kTranslateX] != 0.0f || data[kTranslateY] != 0.0f) {
164                mType |= kTypeTranslate;
165            } else {
166                mType &= ~kTypeTranslate;
167            }
168        }
169    }
170
171    void scale(float sx, float sy, float sz) {
172        Matrix4 u;
173        u.loadScale(sx, sy, sz);
174        multiply(u);
175    }
176
177    void skew(float sx, float sy) {
178        Matrix4 u;
179        u.loadSkew(sx, sy);
180        multiply(u);
181    }
182
183    void rotate(float angle, float x, float y, float z) {
184        Matrix4 u;
185        u.loadRotate(angle, x, y, z);
186        multiply(u);
187    }
188
189    /**
190     * If the matrix is identity or translate and/or scale.
191     */
192    bool isSimple() const;
193    bool isPureTranslate() const;
194    bool isIdentity() const;
195    bool isPerspective() const;
196    bool rectToRect() const;
197    bool positiveScale() const;
198
199    bool changesBounds() const;
200
201    void copyTo(float* v) const;
202    void copyTo(SkMatrix& v) const;
203
204    float mapZ(const Vector3& orig) const;
205    void mapPoint3d(Vector3& vec) const;
206    void mapPoint(float& x, float& y) const; // 2d only
207    void mapRect(Rect& r) const; // 2d only
208
209    float getTranslateX() const;
210    float getTranslateY() const;
211
212    void decomposeScale(float& sx, float& sy) const;
213
214    void dump(const char* label = nullptr) const;
215
216    static const Matrix4& identity();
217
218private:
219    mutable uint8_t mType;
220
221    inline float get(int i, int j) const {
222        return data[i * 4 + j];
223    }
224
225    inline void set(int i, int j, float v) {
226        data[i * 4 + j] = v;
227    }
228
229    uint8_t getGeometryType() const;
230
231}; // class Matrix4
232
233///////////////////////////////////////////////////////////////////////////////
234// Types
235///////////////////////////////////////////////////////////////////////////////
236
237typedef Matrix4 mat4;
238
239}; // namespace uirenderer
240}; // namespace android
241
242#endif // ANDROID_HWUI_MATRIX_H
243