1/*
2 * Copyright (C) 2008, 2010 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// Introduced in DOM Level ?:
27[
28    Constructor([Default=NullString] optional DOMString cssValue),
29    ConstructorRaisesException,
30] interface WebKitCSSMatrix {
31
32    // These attributes are simple aliases for certain elements of the 4x4 matrix
33    attribute double a; // alias for m11
34    attribute double b; // alias for m12
35    attribute double c; // alias for m21
36    attribute double d; // alias for m22
37    attribute double e; // alias for m41
38    attribute double f; // alias for m42
39
40    attribute double m11;
41    attribute double m12;
42    attribute double m13;
43    attribute double m14;
44    attribute double m21;
45    attribute double m22;
46    attribute double m23;
47    attribute double m24;
48    attribute double m31;
49    attribute double m32;
50    attribute double m33;
51    attribute double m34;
52    attribute double m41;
53    attribute double m42;
54    attribute double m43;
55    attribute double m44;
56
57    [RaisesException] void setMatrixValue([Default=Undefined] optional DOMString string);
58
59    // Multiply this matrix by secondMatrix, on the right (result = this * secondMatrix)
60    [Immutable] WebKitCSSMatrix multiply([Default=Undefined] optional WebKitCSSMatrix secondMatrix);
61
62    // Return the inverse of this matrix. Throw an exception if the matrix is not invertible
63    [Immutable, RaisesException] WebKitCSSMatrix inverse();
64
65    // Return this matrix translated by the passed values.
66    // Passing a NaN will use a value of 0. This allows the 3D form to used for 2D operations
67    [Immutable] WebKitCSSMatrix translate([Default=Undefined] optional double x,
68                                          [Default=Undefined] optional double y,
69                                          [Default=Undefined] optional double z);
70
71    // Returns this matrix scaled by the passed values.
72    // Passing scaleX or scaleZ as NaN uses a value of 1, but passing scaleY of NaN
73    // makes it the same as scaleX. This allows the 3D form to used for 2D operations
74    [Immutable] WebKitCSSMatrix scale([Default=Undefined] optional double scaleX,
75                                      [Default=Undefined] optional double scaleY,
76                                      [Default=Undefined] optional double scaleZ);
77
78    // Returns this matrix rotated by the passed values.
79    // If rotY and rotZ are NaN, rotate about Z (rotX=0, rotateY=0, rotateZ=rotX).
80    // Otherwise use a rotation value of 0 for any passed NaN.
81    [Immutable] WebKitCSSMatrix rotate([Default=Undefined] optional double rotX,
82                                       [Default=Undefined] optional double rotY,
83                                       [Default=Undefined] optional double rotZ);
84
85    // Returns this matrix rotated about the passed axis by the passed angle.
86    // Passing a NaN will use a value of 0. If the axis is (0,0,0) use a value
87    // of (0,0,1).
88    [Immutable] WebKitCSSMatrix rotateAxisAngle([Default=Undefined] optional double x,
89                                                [Default=Undefined] optional double y,
90                                                [Default=Undefined] optional double z,
91                                                [Default=Undefined] optional double angle);
92
93    // Returns this matrix skewed along the X axis by the passed values.
94    // Passing a NaN will use a value of 0.
95    [Immutable] WebKitCSSMatrix skewX([Default=Undefined] optional double angle);
96
97    // Returns this matrix skewed along the Y axis by the passed values.
98    // Passing a NaN will use a value of 0.
99    [Immutable] WebKitCSSMatrix skewY([Default=Undefined] optional double angle);
100
101    [NotEnumerable] DOMString toString();
102};
103
104