SvgGradientServer.cs 9.18 KB
Newer Older
James Welle's avatar
James Welle committed
1
using System;
davescriven's avatar
davescriven committed
2
3
4
using System.Collections.Generic;
using System.Drawing;
using System.Drawing.Drawing2D;
James Welle's avatar
James Welle committed
5
using Svg.Transforms;
davescriven's avatar
davescriven committed
6
7
8

namespace Svg
{
9
10
11
    /// <summary>
    /// Provides the base class for all paint servers that wish to render a gradient.
    /// </summary>
davescriven's avatar
davescriven committed
12
13
    public abstract class SvgGradientServer : SvgPaintServer
    {
14
        private SvgCoordinateUnits _gradientUnits;
James Welle's avatar
James Welle committed
15
        private SvgGradientSpreadMethod _spreadMethod;
Eric Domke's avatar
Eric Domke committed
16
        private SvgPaintServer _inheritGradient;
davescriven's avatar
davescriven committed
17
18
        private List<SvgGradientStop> _stops;

19
20
21
        /// <summary>
        /// Initializes a new instance of the <see cref="SvgGradientServer"/> class.
        /// </summary>
davescriven's avatar
davescriven committed
22
23
        internal SvgGradientServer()
        {
24
            this.GradientUnits = SvgCoordinateUnits.ObjectBoundingBox;
James Welle's avatar
James Welle committed
25
            this.SpreadMethod = SvgGradientSpreadMethod.Pad;
davescriven's avatar
davescriven committed
26
27
28
            this._stops = new List<SvgGradientStop>();
        }

29
30
31
32
33
34
        /// <summary>
        /// Called by the underlying <see cref="SvgElement"/> when an element has been added to the
        /// <see cref="Children"/> collection.
        /// </summary>
        /// <param name="child">The <see cref="SvgElement"/> that has been added.</param>
        /// <param name="index">An <see cref="int"/> representing the index where the element was added to the collection.</param>
35
        protected override void AddElement(SvgElement child, int index)
davescriven's avatar
davescriven committed
36
37
        {
            if (child is SvgGradientStop)
38
            {
davescriven's avatar
davescriven committed
39
                this.Stops.Add((SvgGradientStop)child);
40
41
            }

42
            base.AddElement(child, index);
davescriven's avatar
davescriven committed
43
44
        }

45
46
47
48
49
        /// <summary>
        /// Called by the underlying <see cref="SvgElement"/> when an element has been removed from the
        /// <see cref="Children"/> collection.
        /// </summary>
        /// <param name="child">The <see cref="SvgElement"/> that has been removed.</param>
50
        protected override void RemoveElement(SvgElement child)
davescriven's avatar
davescriven committed
51
52
        {
            if (child is SvgGradientStop)
53
54
55
56
            {
                this.Stops.Remove((SvgGradientStop)child);
            }

57
            base.RemoveElement(child);
davescriven's avatar
davescriven committed
58
59
        }

60
61
62
        /// <summary>
        /// Gets the ramp of colors to use on a gradient.
        /// </summary>
davescriven's avatar
davescriven committed
63
64
65
66
67
        public List<SvgGradientStop> Stops
        {
            get { return this._stops; }
        }

68
69
70
        /// <summary>
        /// Specifies what happens if the gradient starts or ends inside the bounds of the target rectangle.
        /// </summary>
davescriven's avatar
davescriven committed
71
72
73
74
75
76
77
        [SvgAttribute("spreadMethod")]
        public SvgGradientSpreadMethod SpreadMethod
        {
            get { return this._spreadMethod; }
            set { this._spreadMethod = value; }
        }

78
79
80
        /// <summary>
        /// Gets or sets the coordinate system of the gradient.
        /// </summary>
davescriven's avatar
davescriven committed
81
        [SvgAttribute("gradientUnits")]
82
        public SvgCoordinateUnits GradientUnits
davescriven's avatar
davescriven committed
83
84
85
86
87
        {
            get { return this._gradientUnits; }
            set { this._gradientUnits = value; }
        }

88
89
90
        /// <summary>
        /// Gets or sets another gradient fill from which to inherit the stops from.
        /// </summary>
91
        [SvgAttribute("href")]
Eric Domke's avatar
Eric Domke committed
92
        public SvgPaintServer InheritGradient
davescriven's avatar
davescriven committed
93
94
        {
            get { return this._inheritGradient; }
95
96
97
98
            set 
            { 
                this._inheritGradient = value;
            }
davescriven's avatar
davescriven committed
99
100
        }

James Welle's avatar
James Welle committed
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
        [SvgAttribute("gradientTransform")]
        public SvgTransformCollection GradientTransform
        {
            get
            {
                return (this.Attributes.GetAttribute<SvgTransformCollection>("gradientTransform"));
            }
            set
            {
                this.Attributes["gradientTransform"] = value;
            }
        }

        private Matrix EffectiveGradientTransform
        {
            get
            {
                var transform = new Matrix();

                if (GradientTransform != null)
                {
                    transform.Multiply(GradientTransform.GetMatrix());
                }
                return transform;
            }
        }

128
        /// <summary>
129
        /// Gets a <see cref="ColorBlend"/> representing the <see cref="SvgGradientServer"/>'s gradient stops.
130
131
132
        /// </summary>
        /// <param name="owner">The parent <see cref="SvgVisualElement"/>.</param>
        /// <param name="opacity">The opacity of the colour blend.</param>
James Welle's avatar
James Welle committed
133
        protected ColorBlend GetColorBlend(SvgVisualElement owner, float opacity, bool radial)
davescriven's avatar
davescriven committed
134
135
136
137
138
139
140
        {
            int colourBlends = this.Stops.Count;
            bool insertStart = false;
            bool insertEnd = false;

            //gradient.Transform = renderingElement.Transforms.Matrix;

141
            //stops should be processed in reverse order if it's a radial gradient
142

davescriven's avatar
davescriven committed
143
144
145
146
147
148
149
            // May need to increase the number of colour blends because the range *must* be from 0.0 to 1.0.
            // E.g. 0.5 - 0.8 isn't valid therefore the rest need to be calculated.

            // If the first stop doesn't start at zero
            if (this.Stops[0].Offset.Value > 0)
            {
                colourBlends++;
150
151
152
153
154
155
156
157
158
                
                if (radial)
                {
                    insertEnd = true;
                }
                else
                {
                    insertStart = true;
                }
davescriven's avatar
davescriven committed
159
160
161
162
163
164
165
            }

            // If the last stop doesn't end at 1 a stop
            float lastValue = this.Stops[this.Stops.Count - 1].Offset.Value;
            if (lastValue < 100 || lastValue < 1)
            {
                colourBlends++;
166
167
168
169
170
171
172
173
                if (radial)
                {
                    insertStart = true;
                }
                else
                {
                    insertEnd = true;
                }
davescriven's avatar
davescriven committed
174
175
            }

176
            ColorBlend blend = new ColorBlend(colourBlends);
davescriven's avatar
davescriven committed
177
178
179
180
181
182
183
184
185

            // Set positions and colour values
            int actualStops = 0;
            float mergedOpacity = 0.0f;
            float position = 0.0f;
            Color colour = Color.Black;

            for (int i = 0; i < colourBlends; i++)
            {
186
                var currentStop = this.Stops[radial ? this.Stops.Count - 1 - actualStops : actualStops];
187
188

                mergedOpacity = opacity * currentStop.Opacity;
189
190
191
192
                position =
                    radial
                    ? 1 - (currentStop.Offset.ToDeviceValue(owner) / owner.Bounds.Width)
                    : (currentStop.Offset.ToDeviceValue(owner) / owner.Bounds.Width);
193
194
195
                colour = Color.FromArgb((int)(mergedOpacity * 255), currentStop.Colour);

                actualStops++;
davescriven's avatar
davescriven committed
196
197
198
199
200

                // Insert this colour before itself at position 0
                if (insertStart && i == 0)
                {
                    blend.Positions[i] = 0.0f;
201
202
203
                    blend.Colors[i] = colour;

                    i++;
davescriven's avatar
davescriven committed
204
205
206
207
208
209
210
211
                }

                blend.Positions[i] = position;
                blend.Colors[i] = colour;

                // Insert this colour after itself at position 0
                if (insertEnd && i == colourBlends - 2)
                {
212
213
214
215
                    i++;

                    blend.Positions[i] = 1.0f;
                    blend.Colors[i] = colour;
davescriven's avatar
davescriven committed
216
217
218
219
220
221
                }
            }

            return blend;
        }

Eric Domke's avatar
Eric Domke committed
222
        protected void LoadStops()
davescriven's avatar
davescriven committed
223
        {
Eric Domke's avatar
Eric Domke committed
224
225
            var core = SvgDeferredPaintServer.TryGet<SvgGradientServer>(_inheritGradient);
            if (this.Stops.Count == 0 && core != null)
226
            {
Eric Domke's avatar
Eric Domke committed
227
                _stops.AddRange(core.Stops);
228
            }
davescriven's avatar
davescriven committed
229
        }
230

James Welle's avatar
James Welle committed
231
232
233
234
        protected ISvgBoundable CalculateBoundable(SvgVisualElement renderingElement)
        {
            return (this.GradientUnits == SvgCoordinateUnits.ObjectBoundingBox) ? (ISvgBoundable)renderingElement : renderingElement.OwnerDocument;
        }
235

James Welle's avatar
James Welle committed
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
        protected PointF TransformPoint(PointF originalPoint)
        {
            var newPoint = new[] { originalPoint };

            EffectiveGradientTransform.TransformPoints(newPoint);

            return newPoint[0];
        }

        protected PointF TransformVector(PointF originalVector)
        {
            var newVector = new[] { originalVector };

            EffectiveGradientTransform.TransformVectors(newVector);

            return newVector[0];
        }

        protected static double CalculateDistance(PointF first, PointF second)
        {
            return Math.Sqrt(Math.Pow(first.X - second.X, 2) + Math.Pow(first.Y - second.Y, 2));
        }

        protected static float CalculateLength(PointF vector)
        {
            return (float)Math.Sqrt(Math.Pow(vector.X, 2) + Math.Pow(vector.Y, 2));
        }

        public override SvgElement DeepCopy<T>()
        {
            var newObj = base.DeepCopy<T>() as SvgGradientServer;
            
268
            newObj.SpreadMethod = this.SpreadMethod;
James Welle's avatar
James Welle committed
269
270
271
            newObj.GradientUnits = this.GradientUnits;
            newObj.InheritGradient = this.InheritGradient;
            newObj.GradientTransform = this.GradientTransform;
272

James Welle's avatar
James Welle committed
273
274
            return newObj;
        }
davescriven's avatar
davescriven committed
275
276
    }
}