DifficultyBindable.cs

// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.

using System;
using osu.Framework.Bindables;
using osu.Game.Beatmaps;

namespace osu.Game.Rulesets.Mods
{
    public class DifficultyBindable : Bindable<float?>
    {
        /// <summary>
        /// Whether the extended limits should be applied to this bindable.
        /// </summary>
        public readonly BindableBool ExtendedLimits = new BindableBool();

        /// <summary>
        /// An internal numeric bindable to hold and propagate min/max/precision.
        /// The value of this bindable should not be set.
        /// </summary>
        internal readonly BindableFloat CurrentNumber = new BindableFloat
        {
            MinValue = 0,
            MaxValue = 10,
        };

        /// <summary>
        /// A function that can extract the current value of this setting from a beatmap difficulty for display purposes.
        /// </summary>
        public Func<IBeatmapDifficultyInfo, float>? ReadCurrentFromDifficulty;

        public float Precision
        {
            set => CurrentNumber.Precision = value;
        }

        private float minValue;

        public float MinValue
        {
            get => minValue;
            set
            {
                if (value == minValue)
                    return;

                minValue = value;
                updateExtents();
            }
        }

        private float maxValue = 10; // matches default max value of `CurrentNumber`

        public float MaxValue
        {
            get => maxValue;
            set
            {
                if (value == maxValue)
                    return;

                maxValue = value;
                updateExtents();
            }
        }

        private float? extendedMinValue;

        /// <summary>
        /// The minimum value to be used when extended limits are applied.
        /// </summary>
        public float? ExtendedMinValue
        {
            get => extendedMinValue;
            set
            {
                if (value == extendedMinValue)
                    return;

                extendedMinValue = value;
                updateExtents();
            }
        }

        private float? extendedMaxValue;

        /// <summary>
        /// The maximum value to be used when extended limits are applied.
        /// </summary>
        public float? ExtendedMaxValue
        {
            get => extendedMaxValue;
            set
            {
                if (value == extendedMaxValue)
                    return;

                extendedMaxValue = value;
                updateExtents();
            }
        }

        public DifficultyBindable()
            : this(null)
        {
        }

        public DifficultyBindable(float? defaultValue = null)
            : base(defaultValue)
        {
            ExtendedLimits.BindValueChanged(_ => updateExtents());
        }

        public override float? Value
        {
            get => base.Value;
            set
            {
                // Ensure that in the case serialisation runs in the wrong order (and limit extensions aren't applied yet) the deserialised value is still propagated.
                if (value != null)
                {
                    CurrentNumber.MinValue = Math.Clamp(MathF.Min(CurrentNumber.MinValue, value.Value), ExtendedMinValue ?? MinValue, MinValue);
                    CurrentNumber.MaxValue = Math.Clamp(MathF.Max(CurrentNumber.MaxValue, value.Value), MaxValue, ExtendedMaxValue ?? MaxValue);

                    base.Value = Math.Clamp(value.Value, CurrentNumber.MinValue, CurrentNumber.MaxValue);
                }
                else
                    base.Value = value;
            }
        }

        private void updateExtents()
        {
            CurrentNumber.MinValue = ExtendedLimits.Value && extendedMinValue != null ? extendedMinValue.Value : minValue;
            CurrentNumber.MaxValue = ExtendedLimits.Value && extendedMaxValue != null ? extendedMaxValue.Value : maxValue;
        }

        public override void CopyTo(Bindable<float?> them)
        {
            if (!(them is DifficultyBindable otherDifficultyBindable))
                throw new InvalidOperationException($"Cannot copy to a non-{nameof(DifficultyBindable)}.");

            base.CopyTo(them);

            otherDifficultyBindable.ReadCurrentFromDifficulty = ReadCurrentFromDifficulty;

            // the following max value copies are only safe as long as these values are effectively constants.
            otherDifficultyBindable.MaxValue = maxValue;
            otherDifficultyBindable.ExtendedMaxValue = extendedMaxValue;
            otherDifficultyBindable.MinValue = minValue;
            otherDifficultyBindable.ExtendedMinValue = extendedMinValue;
        }

        public override void BindTo(Bindable<float?> them)
        {
            if (!(them is DifficultyBindable otherDifficultyBindable))
                throw new InvalidOperationException($"Cannot bind to a non-{nameof(DifficultyBindable)}.");

            // ensure that MaxValue and ExtendedMaxValue are copied across first before continuing.
            // not doing so may cause the value of CurrentNumber to be truncated to 10.
            otherDifficultyBindable.CopyTo(this);

            // set up mutual binding for ExtendedLimits to correctly set the upper bound of CurrentNumber.
            ExtendedLimits.BindTarget = otherDifficultyBindable.ExtendedLimits;

            // set up mutual binding for CurrentNumber. this must happen after all of the above.
            CurrentNumber.BindTarget = otherDifficultyBindable.CurrentNumber;

            // finish up the binding by setting up weak references via the base call.
            // unfortunately this will call `.CopyTo()` again, but fixing that is problematic and messy.
            base.BindTo(them);
        }

        public override void UnbindFrom(IUnbindable them)
        {
            if (!(them is DifficultyBindable otherDifficultyBindable))
                throw new InvalidOperationException($"Cannot unbind from a non-{nameof(DifficultyBindable)}.");

            base.UnbindFrom(them);

            CurrentNumber.UnbindFrom(otherDifficultyBindable.CurrentNumber);
            ExtendedLimits.UnbindFrom(otherDifficultyBindable.ExtendedLimits);
        }

        protected override Bindable<float?> CreateInstance() => new DifficultyBindable();
    }
}