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