src/third_party/WebKit/Source/core/css/CSSMatrix.h

   1 /*
   2  * Copyright (C) 2008 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 #ifndef CSSMatrix_h
  27 #define CSSMatrix_h
  28
  29 #include "bindings/core/v8/ScriptWrappable.h"
  30 #include "platform/transforms/TransformationMatrix.h"
  31 #include "wtf/RefCounted.h"
  32 #include "wtf/text/WTFString.h"
  33
  34 namespace blink {
  35
  36 class ExceptionState;
  37
  38 class CSSMatrix FINAL : public RefCountedWillBeGarbageCollected<CSSMatrix>, public ScriptWrappable {
  39 public:
  40     static PassRefPtrWillBeRawPtr<CSSMatrix> create(const TransformationMatrix& m)
  41     {
  42         return adoptRefWillBeNoop(new CSSMatrix(m));
  43     }
  44     static PassRefPtrWillBeRawPtr<CSSMatrix> create(const String& s, ExceptionState& exceptionState)
  45     {
  46         return adoptRefWillBeNoop(new CSSMatrix(s, exceptionState));
  47     }
  48
  49     double a() const { return m_matrix.a(); }
  50     double b() const { return m_matrix.b(); }
  51     double c() const { return m_matrix.c(); }
  52     double d() const { return m_matrix.d(); }
  53     double e() const { return m_matrix.e(); }
  54     double f() const { return m_matrix.f(); }
  55
  56     void setA(double f) { m_matrix.setA(f); }
  57     void setB(double f) { m_matrix.setB(f); }
  58     void setC(double f) { m_matrix.setC(f); }
  59     void setD(double f) { m_matrix.setD(f); }
  60     void setE(double f) { m_matrix.setE(f); }
  61     void setF(double f) { m_matrix.setF(f); }
  62
  63     double m11() const { return m_matrix.m11(); }
  64     double m12() const { return m_matrix.m12(); }
  65     double m13() const { return m_matrix.m13(); }
  66     double m14() const { return m_matrix.m14(); }
  67     double m21() const { return m_matrix.m21(); }
  68     double m22() const { return m_matrix.m22(); }
  69     double m23() const { return m_matrix.m23(); }
  70     double m24() const { return m_matrix.m24(); }
  71     double m31() const { return m_matrix.m31(); }
  72     double m32() const { return m_matrix.m32(); }
  73     double m33() const { return m_matrix.m33(); }
  74     double m34() const { return m_matrix.m34(); }
  75     double m41() const { return m_matrix.m41(); }
  76     double m42() const { return m_matrix.m42(); }
  77     double m43() const { return m_matrix.m43(); }
  78     double m44() const { return m_matrix.m44(); }
  79
  80     void setM11(double f) { m_matrix.setM11(f); }
  81     void setM12(double f) { m_matrix.setM12(f); }
  82     void setM13(double f) { m_matrix.setM13(f); }
  83     void setM14(double f) { m_matrix.setM14(f); }
  84     void setM21(double f) { m_matrix.setM21(f); }
  85     void setM22(double f) { m_matrix.setM22(f); }
  86     void setM23(double f) { m_matrix.setM23(f); }
  87     void setM24(double f) { m_matrix.setM24(f); }
  88     void setM31(double f) { m_matrix.setM31(f); }
  89     void setM32(double f) { m_matrix.setM32(f); }
  90     void setM33(double f) { m_matrix.setM33(f); }
  91     void setM34(double f) { m_matrix.setM34(f); }
  92     void setM41(double f) { m_matrix.setM41(f); }
  93     void setM42(double f) { m_matrix.setM42(f); }
  94     void setM43(double f) { m_matrix.setM43(f); }
  95     void setM44(double f) { m_matrix.setM44(f); }
  96
  97     void setMatrixValue(const String&, ExceptionState&);
  98
  99     // The following math function return a new matrix with the
 100     // specified operation applied. The this value is not modified.
 101
 102     // Multiply this matrix by secondMatrix, on the right (result = this * secondMatrix)
 103     PassRefPtrWillBeRawPtr<CSSMatrix> multiply(CSSMatrix* secondMatrix) const;
 104
 105     // Return the inverse of this matrix. Throw an exception if the matrix is not invertible
 106     PassRefPtrWillBeRawPtr<CSSMatrix> inverse(ExceptionState&) const;
 107
 108     // Return this matrix translated by the passed values.
 109     // Passing a NaN will use a value of 0. This allows the 3D form to used for 2D operations
 110     // Operation is performed as though the this matrix is multiplied by a matrix with
 111     // the translation values on the left (result = translation(x,y,z) * this)
 112     PassRefPtrWillBeRawPtr<CSSMatrix> translate(double x, double y, double z) const;
 113
 114     // Returns this matrix scaled by the passed values.
 115     // Passing scaleX or scaleZ as NaN uses a value of 1, but passing scaleY of NaN
 116     // makes it the same as scaleX. This allows the 3D form to used for 2D operations
 117     // Operation is performed as though the this matrix is multiplied by a matrix with
 118     // the scale values on the left (result = scale(x,y,z) * this)
 119     PassRefPtrWillBeRawPtr<CSSMatrix> scale(double scaleX, double scaleY, double scaleZ) const;
 120
 121     // Returns this matrix rotated by the passed values.
 122     // If rotY and rotZ are NaN, rotate about Z (rotX=0, rotateY=0, rotateZ=rotX).
 123     // Otherwise use a rotation value of 0 for any passed NaN.
 124     // Operation is performed as though the this matrix is multiplied by a matrix with
 125     // the rotation values on the left (result = rotation(x,y,z) * this)
 126     PassRefPtrWillBeRawPtr<CSSMatrix> rotate(double rotX, double rotY, double rotZ) const;
 127
 128     // Returns this matrix rotated about the passed axis by the passed angle.
 129     // Passing a NaN will use a value of 0. If the axis is (0,0,0) use a value
 130     // Operation is performed as though the this matrix is multiplied by a matrix with
 131     // the rotation values on the left (result = rotation(x,y,z,angle) * this)
 132     PassRefPtrWillBeRawPtr<CSSMatrix> rotateAxisAngle(double x, double y, double z, double angle) const;
 133
 134     // Return this matrix skewed along the X axis by the passed values.
 135     // Passing a NaN will use a value of 0.
 136     // Operation is performed as though the this matrix is multiplied by a matrix with
 137     // the skew values on the left (result = skewX(angle) * this)
 138     PassRefPtrWillBeRawPtr<CSSMatrix> skewX(double angle) const;
 139
 140     // Return this matrix skewed along the Y axis by the passed values.
 141     // Passing a NaN will use a value of 0.
 142     // Operation is performed as though the this matrix is multiplied by a matrix with
 143     // the skew values on the left (result = skewY(angle) * this)
 144     PassRefPtrWillBeRawPtr<CSSMatrix> skewY(double angle) const;
 145
 146     const TransformationMatrix& transform() const { return m_matrix; }
 147
 148     String toString() const;
 149
 150     void trace(Visitor*) { }
 151
 152 protected:
 153     CSSMatrix(const TransformationMatrix&);
 154     CSSMatrix(const String&, ExceptionState&);
 155
 156     TransformationMatrix m_matrix;
 157 };
 158
 159 } // namespace blink
 160
 161 #endif // CSSMatrix_h