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