Reviewed by Eric. Rubber stamped by Oliver.
[WebKit-https.git] / WebCore / platform / graphics / svg / SVGPaintServerGradient.h
1 /*
2  * Copyright (C) 2006 Nikolas Zimmermann <zimmermann@kde.org>
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 SVGPaintServerGradient_H
27 #define SVGPaintServerGradient_H
28
29 #ifdef SVG_SUPPORT
30
31 #include "AffineTransform.h"
32 #include "Color.h"
33 #include "SVGPaintServer.h"
34
35 #if PLATFORM(CG)
36 #include "SVGResourceImage.h"
37 #endif
38
39 #if PLATFORM(QT)
40 class QGradient;
41 #endif
42
43 namespace WebCore {
44
45     enum SVGGradientSpreadMethod {
46         SPREADMETHOD_PAD = 1,
47         SPREADMETHOD_REPEAT = 2,
48         SPREADMETHOD_REFLECT = 4
49     };
50
51     typedef std::pair<float, Color> SVGGradientStop;
52
53     class SVGPaintServerGradient : public SVGPaintServer {
54     public:
55         SVGPaintServerGradient();
56         virtual ~SVGPaintServerGradient();
57
58         const Vector<SVGGradientStop>& gradientStops() const;
59         void setGradientStops(const Vector<SVGGradientStop>&);
60         void setGradientStops(SVGPaintServerGradient*);
61
62         SVGGradientSpreadMethod spreadMethod() const;
63         void setGradientSpreadMethod(const SVGGradientSpreadMethod&);
64
65         // Gradient start and end points are percentages when used in boundingBox mode.
66         // For instance start point with value (0,0) is top-left and end point with
67         // value (100, 100) is bottom-right. BoundingBox mode is enabled by default.
68         bool boundingBoxMode() const;
69         void setBoundingBoxMode(bool mode = true);
70
71         AffineTransform gradientTransform() const;
72         void setGradientTransform(const AffineTransform&);
73
74         SVGResourceListener* listener() const;
75         void setListener(SVGResourceListener*);
76
77         virtual TextStream& externalRepresentation(TextStream&) const;
78
79 #if PLATFORM(CG)
80         virtual void teardown(GraphicsContext*&, const RenderObject*, SVGPaintTargetType) const;
81         virtual void renderPath(GraphicsContext*&, const RenderPath*, SVGPaintTargetType) const;
82
83         virtual bool setup(GraphicsContext*&, const RenderObject*, SVGPaintTargetType) const;
84
85         virtual void invalidate();
86
87         // Helpers
88         void invalidateCaches();
89         void updateQuartzGradientStopsCache(const Vector<SVGGradientStop>&);
90         void updateQuartzGradientCache(const SVGPaintServerGradient*);
91 #endif
92
93 #if PLATFORM(QT)
94     protected:
95         void fillColorArray(QGradient&, const Vector<SVGGradientStop>&, float opacity) const;
96 #endif
97
98     private:
99         Vector<SVGGradientStop> m_stops;
100         SVGGradientSpreadMethod m_spreadMethod;
101         bool m_boundingBoxMode;
102         AffineTransform m_gradientTransform;
103         SVGResourceListener* m_listener;
104
105 #if PLATFORM(CG)
106     public:
107         typedef struct {
108             CGFloat colorArray[4];
109             CGFloat offset;
110             CGFloat previousDeltaInverse;
111         } QuartzGradientStop;
112
113         QuartzGradientStop* m_stopsCache;
114         int m_stopsCount;
115
116         CGShadingRef m_shadingCache;
117         mutable RefPtr<SVGResourceImage> m_maskImage;
118
119         mutable GraphicsContext* m_savedContext;
120 #endif
121     };
122
123     inline SVGGradientStop makeGradientStop(float offset, const Color& color)
124     {
125         return std::make_pair(offset, color);
126     }
127
128 } // namespace WebCore
129
130 #endif
131
132 #endif // SVGPaintServerGradient_H