WebCore/platform/graphics/Gradient.h

   1 /*
   2  * Copyright (C) 2006, 2007, 2008, 2011 Apple Inc. All rights reserved.
   3  * Copyright (C) 2007 Alp Toker <alp@atoker.com>
   4  * Copyright (C) 2008 Torch Mobile, Inc.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef Gradient_h
  29 #define Gradient_h
  30
  31 #include "AffineTransform.h"
  32 #include "FloatPoint.h"
  33 #include "Generator.h"
  34 #include "GraphicsTypes.h"
  35 #include <wtf/PassRefPtr.h>
  36 #include <wtf/Vector.h>
  37
  38 #if PLATFORM(WIN)
  39 #include <CoreGraphics/CoreGraphics.h>
  40 #endif
  41
  42 #if PLATFORM(CG)
  43
  44 typedef struct CGContext* CGContextRef;
  45
  46 #define USE_CG_SHADING defined(BUILDING_ON_TIGER) || defined(BUILDING_ON_LEOPARD)
  47
  48 #if USE_CG_SHADING
  49 typedef struct CGShading* CGShadingRef;
  50 typedef CGShadingRef PlatformGradient;
  51 #else
  52 typedef struct CGGradient* CGGradientRef;
  53 typedef CGGradientRef PlatformGradient;
  54 #endif
  55
  56 #elif PLATFORM(QT)
  57 QT_BEGIN_NAMESPACE
  58 class QGradient;
  59 QT_END_NAMESPACE
  60 typedef QGradient* PlatformGradient;
  61 #elif PLATFORM(CAIRO)
  62 typedef struct _cairo_pattern cairo_pattern_t;
  63 typedef cairo_pattern_t* PlatformGradient;
  64 #elif PLATFORM(SKIA)
  65 class SkShader;
  66 typedef class SkShader* PlatformGradient;
  67 typedef class SkShader* PlatformPattern;
  68 #elif PLATFORM(HAIKU)
  69 class BGradient;
  70 typedef BGradient* PlatformGradient;
  71 #else
  72 typedef void* PlatformGradient;
  73 #endif
  74
  75 namespace WebCore {
  76
  77     class Color;
  78
  79     class Gradient : public Generator {
  80     public:
  81         static PassRefPtr<Gradient> create(const FloatPoint& p0, const FloatPoint& p1)
  82         {
  83             return adoptRef(new Gradient(p0, p1));
  84         }
  85         static PassRefPtr<Gradient> create(const FloatPoint& p0, float r0, const FloatPoint& p1, float r1, float aspectRatio = 1)
  86         {
  87             return adoptRef(new Gradient(p0, r0, p1, r1, aspectRatio));
  88         }
  89         virtual ~Gradient();
  90
  91         struct ColorStop;
  92         void addColorStop(const ColorStop&);
  93         void addColorStop(float, const Color&);
  94
  95         void getColor(float value, float* r, float* g, float* b, float* a) const;
  96         bool hasAlpha() const;
  97
  98         bool isRadial() const { return m_radial; }
  99         bool isZeroSize() const { return m_p0.x() == m_p1.x() && m_p0.y() == m_p1.y() && (!m_radial || m_r0 == m_r1); }
 100
 101         const FloatPoint& p0() const { return m_p0; }
 102         const FloatPoint& p1() const { return m_p1; }
 103
 104         void setP0(const FloatPoint& p) { m_p0 = p; }
 105         void setP1(const FloatPoint& p) { m_p1 = p; }
 106
 107         float startRadius() const { return m_r0; }
 108         float endRadius() const { return m_r1; }
 109
 110         void setStartRadius(float r) { m_r0 = r; }
 111         void setEndRadius(float r) { m_r1 = r; }
 112
 113         float aspectRatio() const { return m_aspectRatio; }
 114
 115 #if OS(WINCE) && !PLATFORM(QT)
 116         const Vector<ColorStop, 2>& getStops() const;
 117 #else
 118         PlatformGradient platformGradient();
 119 #endif
 120
 121         struct ColorStop {
 122             float stop;
 123             float red;
 124             float green;
 125             float blue;
 126             float alpha;
 127
 128             ColorStop() : stop(0), red(0), green(0), blue(0), alpha(0) { }
 129             ColorStop(float s, float r, float g, float b, float a) : stop(s), red(r), green(g), blue(b), alpha(a) { }
 130         };
 131
 132         void setStopsSorted(bool s) { m_stopsSorted = s; }
 133
 134         void setSpreadMethod(GradientSpreadMethod);
 135         GradientSpreadMethod spreadMethod() { return m_spreadMethod; }
 136         void setGradientSpaceTransform(const AffineTransform& gradientSpaceTransformation);
 137         // Qt and CG transform the gradient at draw time
 138         AffineTransform gradientSpaceTransform() { return m_gradientSpaceTransformation; }
 139
 140         virtual void fill(GraphicsContext*, const FloatRect&);
 141         virtual void adjustParametersForTiledDrawing(IntSize& size, FloatRect& srcRect);
 142
 143         void setPlatformGradientSpaceTransform(const AffineTransform& gradientSpaceTransformation);
 144
 145 #if PLATFORM(CG)
 146         void paint(CGContextRef);
 147         void paint(GraphicsContext*);
 148 #endif
 149
 150     private:
 151         Gradient(const FloatPoint& p0, const FloatPoint& p1);
 152         Gradient(const FloatPoint& p0, float r0, const FloatPoint& p1, float r1, float aspectRatio);
 153
 154         void platformInit() { m_gradient = 0; }
 155         void platformDestroy();
 156
 157         int findStop(float value) const;
 158         void sortStopsIfNecessary();
 159
 160         bool m_radial;
 161         FloatPoint m_p0;
 162         FloatPoint m_p1;
 163         float m_r0;
 164         float m_r1;
 165         float m_aspectRatio; // For elliptical gradient, width / height.
 166         mutable Vector<ColorStop, 2> m_stops;
 167         mutable bool m_stopsSorted;
 168         mutable int m_lastStop;
 169         GradientSpreadMethod m_spreadMethod;
 170         AffineTransform m_gradientSpaceTransformation;
 171
 172         PlatformGradient m_gradient;
 173     };
 174
 175 } //namespace
 176
 177 #endif