fab562d92fb3014ddaa4040599be86d27cd58785
[WebKit-https.git] / Source / WebCore / platform / graphics / transforms / AffineTransform.h
1 /*
2  * Copyright (C) 2005, 2006 Apple Inc.  All rights reserved.
3  *               2010 Dirk Schulze <krit@webkit.org>
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #ifndef AffineTransform_h
28 #define AffineTransform_h
29
30 #include "PlatformExportMacros.h"
31 #include <array>
32 #include <wtf/FastMalloc.h>
33
34 #if USE(CG)
35 typedef struct CGAffineTransform CGAffineTransform;
36 #elif USE(CAIRO)
37 #include <cairo.h>
38 #endif
39
40 namespace WebCore {
41
42 class FloatPoint;
43 class FloatQuad;
44 class FloatRect;
45 class FloatSize;
46 class IntPoint;
47 class IntSize;
48 class IntRect;
49 class TextStream;
50 class TransformationMatrix;
51
52 class AffineTransform {
53     WTF_MAKE_FAST_ALLOCATED;
54 public:
55     WEBCORE_EXPORT AffineTransform();
56     WEBCORE_EXPORT AffineTransform(double a, double b, double c, double d, double e, double f);
57
58 #if USE(CG)
59     AffineTransform(const CGAffineTransform&);
60 #endif
61
62     void setMatrix(double a, double b, double c, double d, double e, double f);
63
64     void map(double x, double y, double& x2, double& y2) const;
65
66     // Rounds the mapped point to the nearest integer value.
67     WEBCORE_EXPORT IntPoint mapPoint(const IntPoint&) const;
68
69     WEBCORE_EXPORT FloatPoint mapPoint(const FloatPoint&) const;
70
71     IntSize mapSize(const IntSize&) const;
72
73     FloatSize mapSize(const FloatSize&) const;
74
75     // Rounds the resulting mapped rectangle out. This is helpful for bounding
76     // box computations but may not be what is wanted in other contexts.
77     IntRect mapRect(const IntRect&) const;
78
79     WEBCORE_EXPORT FloatRect mapRect(const FloatRect&) const;
80     FloatQuad mapQuad(const FloatQuad&) const;
81
82     WEBCORE_EXPORT bool isIdentity() const;
83
84     double a() const { return m_transform[0]; }
85     void setA(double a) { m_transform[0] = a; }
86     double b() const { return m_transform[1]; }
87     void setB(double b) { m_transform[1] = b; }
88     double c() const { return m_transform[2]; }
89     void setC(double c) { m_transform[2] = c; }
90     double d() const { return m_transform[3]; }
91     void setD(double d) { m_transform[3] = d; }
92     double e() const { return m_transform[4]; }
93     void setE(double e) { m_transform[4] = e; }
94     double f() const { return m_transform[5]; }
95     void setF(double f) { m_transform[5] = f; }
96
97     void makeIdentity();
98
99     WEBCORE_EXPORT AffineTransform& multiply(const AffineTransform& other);
100     WEBCORE_EXPORT AffineTransform& scale(double);
101     AffineTransform& scale(double sx, double sy); 
102     AffineTransform& scaleNonUniform(double sx, double sy);
103     AffineTransform& scale(const FloatSize&);
104     AffineTransform& rotate(double d);
105     AffineTransform& rotateFromVector(double x, double y);
106     WEBCORE_EXPORT AffineTransform& translate(double tx, double ty);
107     AffineTransform& translate(const FloatPoint&);
108     AffineTransform& shear(double sx, double sy);
109     AffineTransform& flipX();
110     WEBCORE_EXPORT AffineTransform& flipY();
111     AffineTransform& skew(double angleX, double angleY);
112     AffineTransform& skewX(double angle);
113     AffineTransform& skewY(double angle);
114
115     // These functions get the length of an axis-aligned unit vector
116     // once it has been mapped through the transform
117     WEBCORE_EXPORT double xScale() const;
118     WEBCORE_EXPORT double yScale() const;
119
120     double det() const;
121     WEBCORE_EXPORT bool isInvertible() const;
122     WEBCORE_EXPORT AffineTransform inverse() const;
123
124     void blend(const AffineTransform& from, double progress);
125
126     TransformationMatrix toTransformationMatrix() const;
127
128     bool isIdentityOrTranslation() const
129     {
130         return m_transform[0] == 1 && m_transform[1] == 0 && m_transform[2] == 0 && m_transform[3] == 1;
131     }
132     
133     bool isIdentityOrTranslationOrFlipped() const
134     {
135         return m_transform[0] == 1 && m_transform[1] == 0 && m_transform[2] == 0 && (m_transform[3] == 1 || m_transform[3] == -1);
136     }
137
138     bool preservesAxisAlignment() const
139     {
140         return (m_transform[1] == 0 && m_transform[2] == 0) || (m_transform[0] == 0 && m_transform[3] == 0);
141     }
142
143     bool operator== (const AffineTransform& m2) const
144     {
145         return (m_transform[0] == m2.m_transform[0]
146              && m_transform[1] == m2.m_transform[1]
147              && m_transform[2] == m2.m_transform[2]
148              && m_transform[3] == m2.m_transform[3]
149              && m_transform[4] == m2.m_transform[4]
150              && m_transform[5] == m2.m_transform[5]);
151     }
152
153     bool operator!=(const AffineTransform& other) const { return !(*this == other); }
154
155     // *this = *this * t (i.e., a multRight)
156     AffineTransform& operator*=(const AffineTransform& t)
157     {
158         return multiply(t);
159     }
160     
161     // result = *this * t (i.e., a multRight)
162     AffineTransform operator*(const AffineTransform& t) const
163     {
164         AffineTransform result = *this;
165         result *= t;
166         return result;
167     }
168
169 #if USE(CG)
170     operator CGAffineTransform() const;
171 #elif USE(CAIRO)
172     operator cairo_matrix_t() const;
173 #endif
174
175     static AffineTransform translation(double x, double y)
176     {
177         return AffineTransform(1, 0, 0, 1, x, y);
178     }
179
180     // decompose the matrix into its component parts
181     typedef struct {
182         double scaleX, scaleY;
183         double angle;
184         double remainderA, remainderB, remainderC, remainderD;
185         double translateX, translateY;
186     } DecomposedType;
187     
188     bool decompose(DecomposedType&) const;
189     void recompose(const DecomposedType&);
190
191 private:
192     std::array<double, 6> m_transform;
193 };
194
195 AffineTransform makeMapBetweenRects(const FloatRect& source, const FloatRect& dest);
196
197 WEBCORE_EXPORT TextStream& operator<<(TextStream&, const AffineTransform&);
198
199 }
200
201 #endif