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