ShrlAlgoToolkit/WPFluent/Controls/ProgressRing/ProgressRing.cs




/* https://docs.microsoft.com/en-us/fluent-ui/web-components/components/progress-ring */

using Brush = System.Windows.Media.Brush;
using Brushes = System.Windows.Media.Brushes;

// ReSharper disable once CheckNamespace
namespace WPFluent.Controls;

/// <summary>
/// Rotating loading ring.
/// </summary>
public class ProgressRing : System.Windows.Controls.Control
{
    /// <summary>
    /// Identifies the <see cref="CoverRingStroke"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty CoverRingStrokeProperty = DependencyProperty.RegisterAttached(
        nameof(CoverRingStroke),
        typeof(Brush),
        typeof(ProgressRing),
        new FrameworkPropertyMetadata(
            Brushes.Black,
            FrameworkPropertyMetadataOptions.AffectsRender |
                FrameworkPropertyMetadataOptions.SubPropertiesDoNotAffectRender |
                FrameworkPropertyMetadataOptions.Inherits));

    /// <summary>
    /// Identifies the <see cref="CoverRingVisibility"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty CoverRingVisibilityProperty = DependencyProperty.Register(
        nameof(CoverRingVisibility),
        typeof(Visibility),
        typeof(ProgressRing),
        new PropertyMetadata(Visibility.Visible));

    /// <summary>
    /// Identifies the <see cref="EngAngle"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty EngAngleProperty = DependencyProperty.Register(
        nameof(EngAngle),
        typeof(double),
        typeof(ProgressRing),
        new PropertyMetadata(180.0d));

    /// <summary>
    /// Identifies the <see cref="IndeterminateAngle"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty IndeterminateAngleProperty = DependencyProperty.Register(
        nameof(IndeterminateAngle),
        typeof(double),
        typeof(ProgressRing),
        new PropertyMetadata(180.0d));

    /// <summary>
    /// Identifies the <see cref="IsIndeterminate"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty IsIndeterminateProperty = DependencyProperty.Register(
        nameof(IsIndeterminate),
        typeof(bool),
        typeof(ProgressRing),
        new PropertyMetadata(false));
    /// <summary>
    /// Identifies the <see cref="Progress"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty ProgressProperty = DependencyProperty.Register(
        nameof(Progress),
        typeof(double),
        typeof(ProgressRing),
        new PropertyMetadata(50d, OnProgressChanged));

    /// <summary>
    /// Validates the entered <see cref="Progress"/> and redraws the <see cref="Arc"/>.
    /// </summary>
    protected static void OnProgressChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        if (d is not ProgressRing control)
        {
            return;
        }

        control.UpdateProgressAngle();
    }

    /// <summary>
    /// Re-draws <see cref="Arc.EndAngle"/> depending on <see cref="Progress"/>.
    /// </summary>
    protected void UpdateProgressAngle()
    {
        var percentage = Progress;

        if (percentage > 100)
        {
            percentage = 100;
        }

        if (percentage < 0)
        {
            percentage = 0;
        }

        // (360 / 100) * percentage
        var endAngle = 3.6d * percentage;

        if (endAngle >= 360)
        {
            endAngle = 359;
        }

        SetCurrentValue(EngAngleProperty, endAngle);
    }

    /// <summary>
    /// Gets background ring fill.
    /// </summary>
    public Brush CoverRingStroke
    {
        get => (Brush)GetValue(CoverRingStrokeProperty);
        internal set => SetValue(CoverRingStrokeProperty, value);
    }

    /// <summary>
    /// Gets background ring visibility.
    /// </summary>
    public Visibility CoverRingVisibility
    {
        get => (Visibility)GetValue(CoverRingVisibilityProperty);
        internal set => SetValue(CoverRingVisibilityProperty, value);
    }

    /// <summary>
    /// Gets or sets the <see cref="Arc.EndAngle"/>.
    /// </summary>
    public double EngAngle { get => (double)GetValue(EngAngleProperty); set => SetValue(EngAngleProperty, value); }

    /// <summary>
    /// Gets the <see cref="Arc.EndAngle"/> when <see cref="IsIndeterminate"/> is <see langword="true"/>.
    /// </summary>
    public double IndeterminateAngle
    {
        get => (double)GetValue(IndeterminateAngleProperty);
        internal set => SetValue(IndeterminateAngleProperty, value);
    }

    /// <summary>
    /// Gets or sets a value indicating whether <see cref="ProgressRing"/> shows actual values (<see langword="false"/>)
    /// or generic, continuous progress feedback.
    /// </summary>
    public bool IsIndeterminate
    {
        get => (bool)GetValue(IsIndeterminateProperty);
        set => SetValue(IsIndeterminateProperty, value);
    }

    /// <summary>
    /// Gets or sets the progress.
    /// </summary>
    public double Progress { get => (double)GetValue(ProgressProperty); set => SetValue(ProgressProperty, value); }
}