WebCore/platform/graphics/Gradient.h

   1 /*
   2  * Copyright (C) 2006, 2007, 2008 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 #define USE_CG_SHADING defined(BUILDING_ON_TIGER) || defined(BUILDING_ON_LEOPARD)
  45
  46 #if USE_CG_SHADING
  47 typedef struct CGShading* CGShadingRef;
  48 typedef CGShadingRef PlatformGradient;
  49 #else
  50 typedef struct CGGradient* CGGradientRef;
  51 typedef CGGradientRef PlatformGradient;
  52 #endif
  53
  54 #elif PLATFORM(QT)
  55 QT_BEGIN_NAMESPACE
  56 class QGradient;
  57 QT_END_NAMESPACE
  58 typedef QGradient* PlatformGradient;
  59 #elif PLATFORM(CAIRO)
  60 typedef struct _cairo_pattern cairo_pattern_t;
  61 typedef cairo_pattern_t* PlatformGradient;
  62 #elif PLATFORM(SKIA)
  63 class SkShader;
  64 typedef class SkShader* PlatformGradient;
  65 typedef class SkShader* PlatformPattern;
  66 #elif PLATFORM(HAIKU)
  67 class BGradient;
  68 typedef BGradient* PlatformGradient;
  69 #else
  70 typedef void* PlatformGradient;
  71 #endif
  72
  73 namespace WebCore {
  74
  75     class Color;
  76
  77     class Gradient : public Generator {
  78     public:
  79         static PassRefPtr<Gradient> create(const FloatPoint& p0, const FloatPoint& p1)
  80         {
  81             return adoptRef(new Gradient(p0, p1));
  82         }
  83         static PassRefPtr<Gradient> create(const FloatPoint& p0, float r0, const FloatPoint& p1, float r1, float aspectRatio = 1)
  84         {
  85             return adoptRef(new Gradient(p0, r0, p1, r1, aspectRatio));
  86         }
  87         virtual ~Gradient();
  88
  89         struct ColorStop;
  90         void addColorStop(const ColorStop&);
  91         void addColorStop(float, const Color&);
  92
  93         void getColor(float value, float* r, float* g, float* b, float* a) const;
  94         bool hasAlpha() const;
  95
  96         bool isRadial() const { return m_radial; }
  97         bool isZeroSize() const { return m_p0.x() == m_p1.x() && m_p0.y() == m_p1.y() && (!m_radial || m_r0 == m_r1); }
  98
  99         const FloatPoint& p0() const { return m_p0; }
 100         const FloatPoint& p1() const { return m_p1; }
 101
 102         void setP0(const FloatPoint& p) { m_p0 = p; }
 103         void setP1(const FloatPoint& p) { m_p1 = p; }
 104
 105         float startRadius() const { return m_r0; }
 106         float endRadius() const { return m_r1; }
 107
 108         void setStartRadius(float r) { m_r0 = r; }
 109         void setEndRadius(float r) { m_r1 = r; }
 110
 111         float aspectRatio() const { return m_aspectRatio; }
 112
 113 #if OS(WINCE) && !PLATFORM(QT)
 114         const Vector<ColorStop, 2>& getStops() const;
 115 #else
 116         PlatformGradient platformGradient();
 117 #endif
 118         struct ColorStop {
 119             float stop;
 120             float red;
 121             float green;
 122             float blue;
 123             float alpha;
 124
 125             ColorStop() : stop(0), red(0), green(0), blue(0), alpha(0) { }
 126             ColorStop(float s, float r, float g, float b, float a) : stop(s), red(r), green(g), blue(b), alpha(a) { }
 127         };
 128
 129         void setStopsSorted(bool s) { m_stopsSorted = s; }
 130
 131         void setSpreadMethod(GradientSpreadMethod);
 132         GradientSpreadMethod spreadMethod() { return m_spreadMethod; }
 133         void setGradientSpaceTransform(const AffineTransform& gradientSpaceTransformation);
 134         // Qt and CG transform the gradient at draw time
 135         AffineTransform gradientSpaceTransform() { return m_gradientSpaceTransformation; }
 136
 137         virtual void fill(GraphicsContext*, const FloatRect&);
 138         virtual void adjustParametersForTiledDrawing(IntSize& size, FloatRect& srcRect);
 139
 140         void setPlatformGradientSpaceTransform(const AffineTransform& gradientSpaceTransformation);
 141
 142 #if PLATFORM(CG)
 143         void paint(CGContextRef);
 144         void paint(GraphicsContext*);
 145 #endif
 146     private:
 147         Gradient(const FloatPoint& p0, const FloatPoint& p1);
 148         Gradient(const FloatPoint& p0, float r0, const FloatPoint& p1, float r1, float aspectRatio);
 149
 150         void platformInit() { m_gradient = 0; }
 151         void platformDestroy();
 152
 153         int findStop(float value) const;
 154         void sortStopsIfNecessary();
 155
 156         bool m_radial;
 157         FloatPoint m_p0;
 158         FloatPoint m_p1;
 159         float m_r0;
 160         float m_r1;
 161         float m_aspectRatio; // For elliptical gradient, width / height.
 162         mutable Vector<ColorStop, 2> m_stops;
 163         mutable bool m_stopsSorted;
 164         mutable int m_lastStop;
 165         GradientSpreadMethod m_spreadMethod;
 166         AffineTransform m_gradientSpaceTransformation;
 167
 168         PlatformGradient m_gradient;
 169     };
 170
 171 } //namespace
 172
 173 #endif