third_party/WebKit/Source/core/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 // Introduced in DOM Level ?:
  27 [
  28     Constructor(optional DOMString cssValue = null),
  29     ConstructorCallWith=ExecutionContext,
  30     ImplementedAs=CSSMatrix,
  31     RaisesException=Constructor,
  32     WillBeGarbageCollected
  33 ] interface WebKitCSSMatrix {
  34
  35     // These attributes are simple aliases for certain elements of the 4x4 matrix
  36     attribute unrestricted double a; // alias for m11
  37     attribute unrestricted double b; // alias for m12
  38     attribute unrestricted double c; // alias for m21
  39     attribute unrestricted double d; // alias for m22
  40     attribute unrestricted double e; // alias for m41
  41     attribute unrestricted double f; // alias for m42
  42
  43     attribute unrestricted double m11;
  44     attribute unrestricted double m12;
  45     attribute unrestricted double m13;
  46     attribute unrestricted double m14;
  47     attribute unrestricted double m21;
  48     attribute unrestricted double m22;
  49     attribute unrestricted double m23;
  50     attribute unrestricted double m24;
  51     attribute unrestricted double m31;
  52     attribute unrestricted double m32;
  53     attribute unrestricted double m33;
  54     attribute unrestricted double m34;
  55     attribute unrestricted double m41;
  56     attribute unrestricted double m42;
  57     attribute unrestricted double m43;
  58     attribute unrestricted double m44;
  59
  60     [RaisesException] void setMatrixValue([Default=Undefined] optional DOMString string);
  61
  62     // Multiply this matrix by secondMatrix, on the right (result = this * secondMatrix)
  63     [Immutable] WebKitCSSMatrix multiply([Default=Undefined] optional WebKitCSSMatrix secondMatrix);
  64
  65     // Return the inverse of this matrix. Throw an exception if the matrix is not invertible
  66     [Immutable, RaisesException] WebKitCSSMatrix inverse();
  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([Default=Undefined] optional unrestricted double x,
  71                                           [Default=Undefined] optional unrestricted double y,
  72                                           [Default=Undefined] optional unrestricted 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([Default=Undefined] optional unrestricted double scaleX,
  78                                       [Default=Undefined] optional unrestricted double scaleY,
  79                                       [Default=Undefined] optional unrestricted 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([Default=Undefined] optional unrestricted double rotX,
  85                                        [Default=Undefined] optional unrestricted double rotY,
  86                                        [Default=Undefined] optional unrestricted 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([Default=Undefined] optional unrestricted double x,
  92                                                 [Default=Undefined] optional unrestricted double y,
  93                                                 [Default=Undefined] optional unrestricted double z,
  94                                                 [Default=Undefined] optional unrestricted 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([Default=Undefined] optional unrestricted 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([Default=Undefined] optional unrestricted double angle);
 103
 104     [NotEnumerable] stringifier;
 105 };
 106