Implement DOMMatrixReadOnly.transformPoint()
[WebKit-https.git] / Source / WebCore / css / DOMMatrixReadOnly.idl
1 /*
2  * Copyright (C) 2017 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 // FIXME: Should be exposed to workers as well.
27 [
28     Constructor(optional (DOMString or sequence<unrestricted double>) init),
29     ConstructorMayThrowException,
30     ExportMacro=WEBCORE_EXPORT,
31     ImplementationLacksVTable
32 ] interface DOMMatrixReadOnly {
33     [MayThrowException, NewObject] static DOMMatrixReadOnly fromMatrix(optional DOMMatrixInit other);
34     [MayThrowException, NewObject] static DOMMatrixReadOnly fromFloat32Array(Float32Array array32);
35     [MayThrowException, NewObject] static DOMMatrixReadOnly fromFloat64Array(Float64Array array64);
36
37     // These attributes are simple aliases for certain elements of the 4x4 matrix
38     readonly attribute unrestricted double a; // Alias for m11.
39     readonly attribute unrestricted double b; // Alias for m12.
40     readonly attribute unrestricted double c; // Alias for m21.
41     readonly attribute unrestricted double d; // Alias for m22.
42     readonly attribute unrestricted double e; // Alias for m41.
43     readonly attribute unrestricted double f; // Alias for m42.
44
45     readonly attribute unrestricted double m11;
46     readonly attribute unrestricted double m12;
47     readonly attribute unrestricted double m13;
48     readonly attribute unrestricted double m14;
49     readonly attribute unrestricted double m21;
50     readonly attribute unrestricted double m22;
51     readonly attribute unrestricted double m23;
52     readonly attribute unrestricted double m24;
53     readonly attribute unrestricted double m31;
54     readonly attribute unrestricted double m32;
55     readonly attribute unrestricted double m33;
56     readonly attribute unrestricted double m34;
57     readonly attribute unrestricted double m41;
58     readonly attribute unrestricted double m42;
59     readonly attribute unrestricted double m43;
60     readonly attribute unrestricted double m44;
61
62     readonly attribute boolean is2D;
63     readonly attribute boolean isIdentity;
64
65     // Immutable transform methods
66     [NewObject] DOMMatrix translate(optional unrestricted double tx = 0,
67                                     optional unrestricted double ty = 0,
68                                     optional unrestricted double tz = 0);
69     [NewObject] DOMMatrix scale(optional unrestricted double scaleX = 1,
70                                 optional unrestricted double scaleY,
71                                 optional unrestricted double scaleZ = 1,
72                                 optional unrestricted double originX = 0,
73                                 optional unrestricted double originY = 0,
74                                 optional unrestricted double originZ = 0);
75     [NewObject] DOMMatrix scale3d(optional unrestricted double scale = 1,
76                                   optional unrestricted double originX = 0,
77                                   optional unrestricted double originY = 0,
78                                   optional unrestricted double originZ = 0);
79     [NewObject] DOMMatrix rotate(optional unrestricted double rotX = 0,
80                                  optional unrestricted double rotY,
81                                  optional unrestricted double rotZ); // Angles are in degrees.
82     [NewObject] DOMMatrix rotateFromVector(optional unrestricted double x = 0,
83                                            optional unrestricted double y = 0);
84     [NewObject] DOMMatrix rotateAxisAngle(optional unrestricted double x = 0,
85                                           optional unrestricted double y = 0,
86                                           optional unrestricted double z = 0,
87                                           optional unrestricted double angle = 0); // Angle is in degrees.
88     [NewObject] DOMMatrix skewX(optional unrestricted double sx = 0); // Angle is in degrees.
89     [NewObject] DOMMatrix skewY(optional unrestricted double sy = 0); // Angle is in degrees.
90     [MayThrowException, NewObject] DOMMatrix multiply(optional DOMMatrixInit other);
91     [NewObject] DOMMatrix flipX();
92     [NewObject] DOMMatrix flipY();
93     [NewObject] DOMMatrix inverse();
94
95     [NewObject] DOMPoint transformPoint(optional DOMPointInit point);
96     [MayThrowException] Float32Array toFloat32Array();
97     [MayThrowException] Float64Array toFloat64Array();
98
99     [MayThrowException] DOMString toString(); // FIXME: Should be stringifier; once it is supported.
100     serializer = { attribute };
101 };