Bug 17169: Support transform on Canvas
[WebKit-https.git] / WebCore / html / CanvasRenderingContext2D.h
1 /*
2  * Copyright (C) 2006, 2007 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 COMPUTER, 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 COMPUTER, 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 CanvasRenderingContext2D_h
27 #define CanvasRenderingContext2D_h
28
29 #include "FloatSize.h"
30 #include "GraphicsTypes.h"
31 #include "Path.h"
32 #include "PlatformString.h"
33 #include <wtf/Vector.h>
34
35 #if PLATFORM(CG)
36 #include <ApplicationServices/ApplicationServices.h>
37 #endif
38
39 namespace WebCore {
40
41     class CanvasGradient;
42     class CanvasPattern;
43     class CanvasStyle;
44     class FloatRect;
45     class GraphicsContext;
46     class HTMLCanvasElement;
47     class HTMLImageElement;
48
49     typedef int ExceptionCode;
50
51     class CanvasRenderingContext2D : public RefCounted<CanvasRenderingContext2D> {
52     public:
53         CanvasRenderingContext2D(HTMLCanvasElement*);
54
55         HTMLCanvasElement* canvas() const { return m_canvas; }
56
57         CanvasStyle* strokeStyle() const;
58         void setStrokeStyle(PassRefPtr<CanvasStyle>);
59
60         CanvasStyle* fillStyle() const;
61         void setFillStyle(PassRefPtr<CanvasStyle>);
62
63         float lineWidth() const;
64         void setLineWidth(float);
65
66         String lineCap() const;
67         void setLineCap(const String&);
68
69         String lineJoin() const;
70         void setLineJoin(const String&);
71
72         float miterLimit() const;
73         void setMiterLimit(float);
74
75         float shadowOffsetX() const;
76         void setShadowOffsetX(float);
77
78         float shadowOffsetY() const;
79         void setShadowOffsetY(float);
80
81         float shadowBlur() const;
82         void setShadowBlur(float);
83
84         String shadowColor() const;
85         void setShadowColor(const String&);
86
87         float globalAlpha() const;
88         void setGlobalAlpha(float);
89
90         String globalCompositeOperation() const;
91         void setGlobalCompositeOperation(const String&);
92
93         void save();
94         void restore();
95
96         void scale(float sx, float sy);
97         void rotate(float angleInRadians);
98         void translate(float tx, float ty);
99         void transform(float m11, float m12, float m21, float m22, float dx, float dy);
100
101         void setStrokeColor(const String& color);
102         void setStrokeColor(float grayLevel);
103         void setStrokeColor(const String& color, float alpha);
104         void setStrokeColor(float grayLevel, float alpha);
105         void setStrokeColor(float r, float g, float b, float a);
106         void setStrokeColor(float c, float m, float y, float k, float a);
107
108         void setFillColor(const String& color);
109         void setFillColor(float grayLevel);
110         void setFillColor(const String& color, float alpha);
111         void setFillColor(float grayLevel, float alpha);
112         void setFillColor(float r, float g, float b, float a);
113         void setFillColor(float c, float m, float y, float k, float a);
114
115         void beginPath();
116         void closePath();
117
118         void moveTo(float x, float y);
119         void lineTo(float x, float y);
120         void quadraticCurveTo(float cpx, float cpy, float x, float y);
121         void bezierCurveTo(float cp1x, float cp1y, float cp2x, float cp2y, float x, float y);
122         void arcTo(float x0, float y0, float x1, float y1, float radius, ExceptionCode&);
123         void arc(float x, float y, float r, float sa, float ea, bool clockwise, ExceptionCode&);
124         void rect(float x, float y, float width, float height, ExceptionCode&);
125
126         void fill();
127         void stroke();
128         void clip();
129
130         bool isPointInPath(const float x, const float y);
131
132         void clearRect(float x, float y, float width, float height, ExceptionCode&);
133         void fillRect(float x, float y, float width, float height, ExceptionCode&);
134         void strokeRect(float x, float y, float width, float height, ExceptionCode&);
135         void strokeRect(float x, float y, float width, float height, float lineWidth, ExceptionCode&);
136
137         void setShadow(float width, float height, float blur);
138         void setShadow(float width, float height, float blur, const String& color);
139         void setShadow(float width, float height, float blur, float grayLevel);
140         void setShadow(float width, float height, float blur, const String& color, float alpha);
141         void setShadow(float width, float height, float blur, float grayLevel, float alpha);
142         void setShadow(float width, float height, float blur, float r, float g, float b, float a);
143         void setShadow(float width, float height, float blur, float c, float m, float y, float k, float a);
144
145         void clearShadow();
146
147         void drawImage(HTMLImageElement*, float x, float y);
148         void drawImage(HTMLImageElement*, float x, float y, float width, float height, ExceptionCode&);
149         void drawImage(HTMLImageElement*, const FloatRect& srcRect, const FloatRect& dstRect, ExceptionCode&);
150         void drawImage(HTMLCanvasElement*, float x, float y);
151         void drawImage(HTMLCanvasElement*, float x, float y, float width, float height, ExceptionCode&);
152         void drawImage(HTMLCanvasElement*, const FloatRect& srcRect, const FloatRect& dstRect, ExceptionCode&);
153
154         void drawImageFromRect(HTMLImageElement*, float sx, float sy, float sw, float sh,
155             float dx, float dy, float dw, float dh, const String& compositeOperation);
156
157         void setAlpha(float);
158
159         void setCompositeOperation(const String&);
160
161         PassRefPtr<CanvasGradient> createLinearGradient(float x0, float y0, float x1, float y1);
162         PassRefPtr<CanvasGradient> createRadialGradient(float x0, float y0, float r0, float x1, float y1, float r1);
163         PassRefPtr<CanvasPattern> createPattern(HTMLImageElement*, const String& repetitionType, ExceptionCode&);
164         PassRefPtr<CanvasPattern> createPattern(HTMLCanvasElement*, const String& repetitionType, ExceptionCode&);
165
166         void reset();
167         void detachCanvas() { m_canvas = 0; }
168
169     private:
170         struct State {
171             State();
172
173             RefPtr<CanvasStyle> m_strokeStyle;
174             RefPtr<CanvasStyle> m_fillStyle;
175             Path m_path;
176             float m_lineWidth;
177             LineCap m_lineCap;
178             LineJoin m_lineJoin;
179             float m_miterLimit;
180             FloatSize m_shadowOffset;
181             float m_shadowBlur;
182             String m_shadowColor;
183             float m_globalAlpha;
184             CompositeOperator m_globalComposite;
185             bool m_appliedStrokePattern;
186             bool m_appliedFillPattern;
187 #if PLATFORM(CG)
188             CGAffineTransform m_strokeStylePatternTransform;
189             CGAffineTransform m_fillStylePatternTransform;
190 #endif
191         };
192
193         State& state() { return m_stateStack.last(); }
194         const State& state() const { return m_stateStack.last(); }
195
196         void applyShadow();
197
198         void willDraw(const FloatRect&);
199
200         GraphicsContext* drawingContext() const;
201
202         void applyStrokePattern();
203         void applyFillPattern();
204
205         void clearPathForDashboardBackwardCompatibilityMode();
206
207         HTMLCanvasElement* m_canvas;
208         Vector<State, 1> m_stateStack;
209     };
210
211 } // namespace WebCore
212
213 #endif