// ReSharper disable MemberCanBeProtected.Global
// ReSharper disable MemberCanBePrivate.Global
// ReSharper disable AutoPropertyCanBeMadeGetOnly.Global
using System.Collections.Generic;
using System.Linq;
using RGB.NET.Core;
namespace RGB.NET.Brushes.Gradients
{
///
/// Represents a basic gradient.
///
public abstract class AbstractGradient : IGradient
{
#region Properties & Fields
///
/// Gets a list of the stops used by this .
///
public IList GradientStops { get; } = new List();
///
/// Gets or sets if the Gradient wraps around if there isn't a second stop to take.
/// Example: There is a stop at offset 0.0, 0.5 and 0.75.
/// Without wrapping offset 1.0 will be calculated the same as 0.75; with wrapping it would be the same as 0.0.
///
public bool WrapGradient { get; set; }
#endregion
#region Constructors
///
/// Initializes a new instance of the class.
///
protected AbstractGradient()
{ }
///
/// Initializes a new instance of the class.
///
/// The stops with which the gradient should be initialized.
protected AbstractGradient(params GradientStop[] gradientStops)
{
foreach (GradientStop gradientStop in gradientStops)
GradientStops.Add(gradientStop);
}
///
/// Initializes a new instance of the class.
///
/// Specifies whether the gradient should wrapp or not (see for an example of what this means).
/// The stops with which the gradient should be initialized.
protected AbstractGradient(bool wrapGradient, params GradientStop[] gradientStops)
{
this.WrapGradient = wrapGradient;
foreach (GradientStop gradientStop in gradientStops)
GradientStops.Add(gradientStop);
}
#endregion
#region Methods
///
/// Clips the offset and ensures, that it is inside the bounds of the stop list.
///
///
///
protected double ClipOffset(double offset)
{
double max = GradientStops.Max(n => n.Offset);
if (offset > max)
return max;
double min = GradientStops.Min(n => n.Offset);
return offset < min ? min : offset;
}
///
public abstract Color GetColor(double offset);
#endregion
}
}