[SVG Masking] Enable the use of <mask> elements for -webkit-mask-image
[WebKit-https.git] / Source / WebCore / css / WebKitCSSMatrix.h
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 WebKitCSSMatrix_h
27 #define WebKitCSSMatrix_h
28
29 #include "ScriptWrappable.h"
30 #include "TransformationMatrix.h"
31 #include <wtf/RefCounted.h>
32 #include <wtf/RefPtr.h>
33 #include <wtf/text/WTFString.h>
34
35 namespace WebCore {
36
37 typedef int ExceptionCode;
38
39 class WebKitCSSMatrix final : public ScriptWrappable, public RefCounted<WebKitCSSMatrix> {
40 public:
41     static PassRefPtr<WebKitCSSMatrix> create(const TransformationMatrix& m)
42     {
43         return adoptRef(new WebKitCSSMatrix(m));
44     }
45     static PassRefPtr<WebKitCSSMatrix> create(const String& s, ExceptionCode& ec)
46     {
47         return adoptRef(new WebKitCSSMatrix(s, ec));
48     }
49
50     ~WebKitCSSMatrix();
51
52     double a() const { return m_matrix.a(); }
53     double b() const { return m_matrix.b(); }
54     double c() const { return m_matrix.c(); }
55     double d() const { return m_matrix.d(); }
56     double e() const { return m_matrix.e(); }
57     double f() const { return m_matrix.f(); }
58
59     void setA(double f) { m_matrix.setA(f); }
60     void setB(double f) { m_matrix.setB(f); }
61     void setC(double f) { m_matrix.setC(f); }
62     void setD(double f) { m_matrix.setD(f); }
63     void setE(double f) { m_matrix.setE(f); }
64     void setF(double f) { m_matrix.setF(f); }
65
66     double m11() const { return m_matrix.m11(); }
67     double m12() const { return m_matrix.m12(); }
68     double m13() const { return m_matrix.m13(); }
69     double m14() const { return m_matrix.m14(); }
70     double m21() const { return m_matrix.m21(); }
71     double m22() const { return m_matrix.m22(); }
72     double m23() const { return m_matrix.m23(); }
73     double m24() const { return m_matrix.m24(); }
74     double m31() const { return m_matrix.m31(); }
75     double m32() const { return m_matrix.m32(); }
76     double m33() const { return m_matrix.m33(); }
77     double m34() const { return m_matrix.m34(); }
78     double m41() const { return m_matrix.m41(); }
79     double m42() const { return m_matrix.m42(); }
80     double m43() const { return m_matrix.m43(); }
81     double m44() const { return m_matrix.m44(); }
82
83     void setM11(double f) { m_matrix.setM11(f); }
84     void setM12(double f) { m_matrix.setM12(f); }
85     void setM13(double f) { m_matrix.setM13(f); }
86     void setM14(double f) { m_matrix.setM14(f); }
87     void setM21(double f) { m_matrix.setM21(f); }
88     void setM22(double f) { m_matrix.setM22(f); }
89     void setM23(double f) { m_matrix.setM23(f); }
90     void setM24(double f) { m_matrix.setM24(f); }
91     void setM31(double f) { m_matrix.setM31(f); }
92     void setM32(double f) { m_matrix.setM32(f); }
93     void setM33(double f) { m_matrix.setM33(f); }
94     void setM34(double f) { m_matrix.setM34(f); }
95     void setM41(double f) { m_matrix.setM41(f); }
96     void setM42(double f) { m_matrix.setM42(f); }
97     void setM43(double f) { m_matrix.setM43(f); }
98     void setM44(double f) { m_matrix.setM44(f); }
99
100     void setMatrixValue(const String&, ExceptionCode&);
101
102     // The following math function return a new matrix with the
103     // specified operation applied. The this value is not modified.
104
105     // Multiply this matrix by secondMatrix, on the right (result = this * secondMatrix)
106     PassRefPtr<WebKitCSSMatrix> multiply(WebKitCSSMatrix* secondMatrix) const;
107
108     // Return the inverse of this matrix. Throw an exception if the matrix is not invertible
109     PassRefPtr<WebKitCSSMatrix> inverse(ExceptionCode&) const;
110
111     // Return this matrix translated by the passed values.
112     // Passing a NaN will use a value of 0. This allows the 3D form to used for 2D operations
113     // Operation is performed as though the this matrix is multiplied by a matrix with
114     // the translation values on the left (result = translation(x,y,z) * this)
115     PassRefPtr<WebKitCSSMatrix> translate(double x, double y, double z) const;
116
117     // Returns this matrix scaled by the passed values.
118     // Passing scaleX or scaleZ as NaN uses a value of 1, but passing scaleY of NaN
119     // makes it the same as scaleX. This allows the 3D form to used for 2D operations
120     // Operation is performed as though the this matrix is multiplied by a matrix with
121     // the scale values on the left (result = scale(x,y,z) * this)
122     PassRefPtr<WebKitCSSMatrix> scale(double scaleX, double scaleY, double scaleZ) const;
123
124     // Returns this matrix rotated by the passed values.
125     // If rotY and rotZ are NaN, rotate about Z (rotX=0, rotateY=0, rotateZ=rotX).
126     // Otherwise use a rotation value of 0 for any passed NaN.
127     // Operation is performed as though the this matrix is multiplied by a matrix with
128     // the rotation values on the left (result = rotation(x,y,z) * this)
129     PassRefPtr<WebKitCSSMatrix> rotate(double rotX, double rotY, double rotZ) const;
130
131     // Returns this matrix rotated about the passed axis by the passed angle.
132     // Passing a NaN will use a value of 0. If the axis is (0,0,0) use a value
133     // Operation is performed as though the this matrix is multiplied by a matrix with
134     // the rotation values on the left (result = rotation(x,y,z,angle) * this)
135     PassRefPtr<WebKitCSSMatrix> rotateAxisAngle(double x, double y, double z, double angle) const;
136
137     // Return this matrix skewed along the X axis by the passed values.
138     // Passing a NaN will use a value of 0.
139     // Operation is performed as though the this matrix is multiplied by a matrix with
140     // the skew values on the left (result = skewX(angle) * this)
141     PassRefPtr<WebKitCSSMatrix> skewX(double angle) const;
142
143     // Return this matrix skewed along the Y axis by the passed values.
144     // Passing a NaN will use a value of 0.
145     // Operation is performed as though the this matrix is multiplied by a matrix with
146     // the skew values on the left (result = skewY(angle) * this)
147     PassRefPtr<WebKitCSSMatrix> skewY(double angle) const;
148
149     const TransformationMatrix& transform() const { return m_matrix; }
150
151     String toString() const;
152
153 protected:
154     WebKitCSSMatrix(const TransformationMatrix&);
155     WebKitCSSMatrix(const String&, ExceptionCode&);
156
157     TransformationMatrix m_matrix;
158 };
159
160 } // namespace WebCore
161
162 #endif // WebKitCSSMatrix_h