1/*
2 * Copyright (C) 2008 Apple Inc. All Rights Reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef CSSMatrix_h
27#define CSSMatrix_h
28
29#include "bindings/core/v8/ScriptWrappable.h"
30#include "platform/transforms/TransformationMatrix.h"
31#include "wtf/RefCounted.h"
32#include "wtf/text/WTFString.h"
33
34namespace blink {
35
36class ExceptionState;
37
38class CSSMatrix FINAL : public RefCountedWillBeGarbageCollected<CSSMatrix>, public ScriptWrappable {
39    DEFINE_WRAPPERTYPEINFO();
40public:
41    static PassRefPtrWillBeRawPtr<CSSMatrix> create(const TransformationMatrix& m)
42    {
43        return adoptRefWillBeNoop(new CSSMatrix(m));
44    }
45    static PassRefPtrWillBeRawPtr<CSSMatrix> create(const String& s, ExceptionState& exceptionState)
46    {
47        return adoptRefWillBeNoop(new CSSMatrix(s, exceptionState));
48    }
49
50    double a() const { return m_matrix.a(); }
51    double b() const { return m_matrix.b(); }
52    double c() const { return m_matrix.c(); }
53    double d() const { return m_matrix.d(); }
54    double e() const { return m_matrix.e(); }
55    double f() const { return m_matrix.f(); }
56
57    void setA(double f) { m_matrix.setA(f); }
58    void setB(double f) { m_matrix.setB(f); }
59    void setC(double f) { m_matrix.setC(f); }
60    void setD(double f) { m_matrix.setD(f); }
61    void setE(double f) { m_matrix.setE(f); }
62    void setF(double f) { m_matrix.setF(f); }
63
64    double m11() const { return m_matrix.m11(); }
65    double m12() const { return m_matrix.m12(); }
66    double m13() const { return m_matrix.m13(); }
67    double m14() const { return m_matrix.m14(); }
68    double m21() const { return m_matrix.m21(); }
69    double m22() const { return m_matrix.m22(); }
70    double m23() const { return m_matrix.m23(); }
71    double m24() const { return m_matrix.m24(); }
72    double m31() const { return m_matrix.m31(); }
73    double m32() const { return m_matrix.m32(); }
74    double m33() const { return m_matrix.m33(); }
75    double m34() const { return m_matrix.m34(); }
76    double m41() const { return m_matrix.m41(); }
77    double m42() const { return m_matrix.m42(); }
78    double m43() const { return m_matrix.m43(); }
79    double m44() const { return m_matrix.m44(); }
80
81    void setM11(double f) { m_matrix.setM11(f); }
82    void setM12(double f) { m_matrix.setM12(f); }
83    void setM13(double f) { m_matrix.setM13(f); }
84    void setM14(double f) { m_matrix.setM14(f); }
85    void setM21(double f) { m_matrix.setM21(f); }
86    void setM22(double f) { m_matrix.setM22(f); }
87    void setM23(double f) { m_matrix.setM23(f); }
88    void setM24(double f) { m_matrix.setM24(f); }
89    void setM31(double f) { m_matrix.setM31(f); }
90    void setM32(double f) { m_matrix.setM32(f); }
91    void setM33(double f) { m_matrix.setM33(f); }
92    void setM34(double f) { m_matrix.setM34(f); }
93    void setM41(double f) { m_matrix.setM41(f); }
94    void setM42(double f) { m_matrix.setM42(f); }
95    void setM43(double f) { m_matrix.setM43(f); }
96    void setM44(double f) { m_matrix.setM44(f); }
97
98    void setMatrixValue(const String&, ExceptionState&);
99
100    // The following math function return a new matrix with the
101    // specified operation applied. The this value is not modified.
102
103    // Multiply this matrix by secondMatrix, on the right (result = this * secondMatrix)
104    PassRefPtrWillBeRawPtr<CSSMatrix> multiply(CSSMatrix* secondMatrix) const;
105
106    // Return the inverse of this matrix. Throw an exception if the matrix is not invertible
107    PassRefPtrWillBeRawPtr<CSSMatrix> inverse(ExceptionState&) const;
108
109    // Return this matrix translated by the passed values.
110    // Passing a NaN will use a value of 0. This allows the 3D form to used for 2D operations
111    // Operation is performed as though the this matrix is multiplied by a matrix with
112    // the translation values on the left (result = translation(x,y,z) * this)
113    PassRefPtrWillBeRawPtr<CSSMatrix> translate(double x, double y, double z) const;
114
115    // Returns this matrix scaled by the passed values.
116    // Passing scaleX or scaleZ as NaN uses a value of 1, but passing scaleY of NaN
117    // makes it the same as scaleX. This allows the 3D form to used for 2D operations
118    // Operation is performed as though the this matrix is multiplied by a matrix with
119    // the scale values on the left (result = scale(x,y,z) * this)
120    PassRefPtrWillBeRawPtr<CSSMatrix> scale(double scaleX, double scaleY, double scaleZ) const;
121
122    // Returns this matrix rotated by the passed values.
123    // If rotY and rotZ are NaN, rotate about Z (rotX=0, rotateY=0, rotateZ=rotX).
124    // Otherwise use a rotation value of 0 for any passed NaN.
125    // Operation is performed as though the this matrix is multiplied by a matrix with
126    // the rotation values on the left (result = rotation(x,y,z) * this)
127    PassRefPtrWillBeRawPtr<CSSMatrix> rotate(double rotX, double rotY, double rotZ) const;
128
129    // Returns this matrix rotated about the passed axis by the passed angle.
130    // Passing a NaN will use a value of 0. If the axis is (0,0,0) use a value
131    // Operation is performed as though the this matrix is multiplied by a matrix with
132    // the rotation values on the left (result = rotation(x,y,z,angle) * this)
133    PassRefPtrWillBeRawPtr<CSSMatrix> rotateAxisAngle(double x, double y, double z, double angle) const;
134
135    // Return this matrix skewed along the X axis by the passed values.
136    // Passing a NaN will use a value of 0.
137    // Operation is performed as though the this matrix is multiplied by a matrix with
138    // the skew values on the left (result = skewX(angle) * this)
139    PassRefPtrWillBeRawPtr<CSSMatrix> skewX(double angle) const;
140
141    // Return this matrix skewed along the Y axis by the passed values.
142    // Passing a NaN will use a value of 0.
143    // Operation is performed as though the this matrix is multiplied by a matrix with
144    // the skew values on the left (result = skewY(angle) * this)
145    PassRefPtrWillBeRawPtr<CSSMatrix> skewY(double angle) const;
146
147    const TransformationMatrix& transform() const { return m_matrix; }
148
149    String toString() const;
150
151    void trace(Visitor*) { }
152
153protected:
154    CSSMatrix(const TransformationMatrix&);
155    CSSMatrix(const String&, ExceptionState&);
156
157    TransformationMatrix m_matrix;
158};
159
160} // namespace blink
161
162#endif // CSSMatrix_h
163