Merge pull request #30114 from bdach/form-slider-bar-transfer-value-on-commit

Fix difficulty settings sliders attempting to reprocess all hitobjects on every instantaneous change

osu.Android.props

@@ -10,7 +10,7 @@
     <EmbedAssembliesIntoApk>true</EmbedAssembliesIntoApk>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="ppy.osu.Framework.Android" Version="2024.1006.0" />
+    <PackageReference Include="ppy.osu.Framework.Android" Version="2024.1007.0" />
   </ItemGroup>
   <PropertyGroup>
     <!-- Fody does not handle Android build well, and warns when unchanged.

osu.Game.Rulesets.Mania/Edit/Setup/ManiaDifficultySection.cs

@@ -48,6 +48,7 @@ namespace osu.Game.Rulesets.Mania.Edit.Setup
                         MaxValue = 10,
                         Precision = 1,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 specialStyle = new FormCheckBox
@@ -67,6 +68,7 @@ namespace osu.Game.Rulesets.Mania.Edit.Setup
                         MaxValue = 10,
                         Precision = 0.1f,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 overallDifficultySlider = new FormSliderBar<float>
@@ -80,6 +82,7 @@ namespace osu.Game.Rulesets.Mania.Edit.Setup
                         MaxValue = 10,
                         Precision = 0.1f,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 baseVelocitySlider = new FormSliderBar<double>
@@ -93,6 +96,7 @@ namespace osu.Game.Rulesets.Mania.Edit.Setup
                         MaxValue = 3.6,
                         Precision = 0.01f,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 tickRateSlider = new FormSliderBar<double>
@@ -106,6 +110,7 @@ namespace osu.Game.Rulesets.Mania.Edit.Setup
                         MaxValue = 4,
                         Precision = 1,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
             };

osu.Game.Rulesets.Osu/Edit/Setup/OsuDifficultySection.cs

@@ -42,6 +42,7 @@ namespace osu.Game.Rulesets.Osu.Edit.Setup
                         MaxValue = 10,
                         Precision = 0.1f,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 healthDrainSlider = new FormSliderBar<float>
@@ -55,6 +56,7 @@ namespace osu.Game.Rulesets.Osu.Edit.Setup
                         MaxValue = 10,
                         Precision = 0.1f,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 approachRateSlider = new FormSliderBar<float>
@@ -68,6 +70,7 @@ namespace osu.Game.Rulesets.Osu.Edit.Setup
                         MaxValue = 10,
                         Precision = 0.1f,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 overallDifficultySlider = new FormSliderBar<float>
@@ -81,6 +84,7 @@ namespace osu.Game.Rulesets.Osu.Edit.Setup
                         MaxValue = 10,
                         Precision = 0.1f,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 baseVelocitySlider = new FormSliderBar<double>
@@ -94,6 +98,7 @@ namespace osu.Game.Rulesets.Osu.Edit.Setup
                         MaxValue = 3.6,
                         Precision = 0.01f,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 tickRateSlider = new FormSliderBar<double>
@@ -107,6 +112,7 @@ namespace osu.Game.Rulesets.Osu.Edit.Setup
                         MaxValue = 4,
                         Precision = 1,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 stackLeniency = new FormSliderBar<float>
@@ -120,6 +126,7 @@ namespace osu.Game.Rulesets.Osu.Edit.Setup
                         MaxValue = 1,
                         Precision = 0.1f
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
             };

osu.Game.Rulesets.Taiko/Edit/Setup/TaikoDifficultySection.cs

@@ -39,6 +39,7 @@ namespace osu.Game.Rulesets.Taiko.Edit.Setup
                         MaxValue = 10,
                         Precision = 0.1f,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 overallDifficultySlider = new FormSliderBar<float>
@@ -52,6 +53,7 @@ namespace osu.Game.Rulesets.Taiko.Edit.Setup
                         MaxValue = 10,
                         Precision = 0.1f,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 baseVelocitySlider = new FormSliderBar<double>
@@ -65,6 +67,7 @@ namespace osu.Game.Rulesets.Taiko.Edit.Setup
                         MaxValue = 3.6,
                         Precision = 0.01f,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 tickRateSlider = new FormSliderBar<double>
@@ -78,6 +81,7 @@ namespace osu.Game.Rulesets.Taiko.Edit.Setup
                         MaxValue = 4,
                         Precision = 1,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
             };

osu.Game.Tests/Visual/UserInterface/TestSceneFormControls.cs

@@ -72,7 +72,7 @@ namespace osu.Game.Tests.Visual.UserInterface
                         },
                         new FormSliderBar<float>
                         {
-                            Caption = "Instantaneous slider",
+                            Caption = "Slider",
                             Current = new BindableFloat
                             {
                                 MinValue = 0,
@@ -82,19 +82,6 @@ namespace osu.Game.Tests.Visual.UserInterface
                             },
                             TabbableContentContainer = this,
                         },
-                        new FormSliderBar<float>
-                        {
-                            Caption = "Non-instantaneous slider",
-                            Current = new BindableFloat
-                            {
-                                MinValue = 0,
-                                MaxValue = 10,
-                                Value = 5,
-                                Precision = 0.1f,
-                            },
-                            Instantaneous = false,
-                            TabbableContentContainer = this,
-                        },
                         new FormEnumDropdown<CountdownType>
                         {
                             Caption = EditorSetupStrings.EnableCountdown,

osu.Game.Tests/Visual/UserInterface/TestSceneFormSliderBar.cs

@@ -0,0 +1,63 @@
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using NUnit.Framework;
+using osu.Framework.Allocation;
+using osu.Framework.Bindables;
+using osu.Framework.Extensions.ObjectExtensions;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Game.Graphics.Sprites;
+using osu.Game.Graphics.UserInterfaceV2;
+using osu.Game.Overlays;
+using osuTK;
+
+namespace osu.Game.Tests.Visual.UserInterface
+{
+    public partial class TestSceneFormSliderBar : OsuTestScene
+    {
+        [Cached]
+        private OverlayColourProvider colourProvider = new OverlayColourProvider(OverlayColourScheme.Aquamarine);
+
+        [Test]
+        public void TestTransferValueOnCommit()
+        {
+            OsuSpriteText text;
+            FormSliderBar<float> slider = null!;
+
+            AddStep("create content", () =>
+            {
+                Child = new FillFlowContainer
+                {
+                    RelativeSizeAxes = Axes.Both,
+                    Anchor = Anchor.Centre,
+                    Origin = Anchor.Centre,
+                    Width = 0.5f,
+                    Direction = FillDirection.Vertical,
+                    Spacing = new Vector2(10),
+                    Children = new Drawable[]
+                    {
+                        text = new OsuSpriteText(),
+                        slider = new FormSliderBar<float>
+                        {
+                            Caption = "Slider",
+                            Current = new BindableFloat
+                            {
+                                MinValue = 0,
+                                MaxValue = 10,
+                                Precision = 0.1f,
+                                Default = 5f,
+                            }
+                        },
+                    }
+                };
+                slider.Current.BindValueChanged(_ => text.Text = $"Current value is: {slider.Current.Value}", true);
+            });
+            AddToggleStep("toggle transfer value on commit", b =>
+            {
+                if (slider.IsNotNull())
+                    slider.TransferValueOnCommit = b;
+            });
+        }
+    }
+}

osu.Game/Graphics/UserInterfaceV2/FormSliderBar.cs

@@ -28,27 +28,23 @@ namespace osu.Game.Graphics.UserInterfaceV2
         public Bindable<T> Current
         {
             get => current.Current;
-            set => current.Current = value;
-        }
-
-        private bool instantaneous = true;
-
-        /// <summary>
-        /// Whether changes to the slider should instantaneously transfer to the text box (and vice versa).
-        /// If <see langword="false"/>, the transfer will happen on text box commit (explicit, or implicit via focus loss), or on slider drag end.
-        /// </summary>
-        public bool Instantaneous
-        {
-            get => instantaneous;
             set
             {
-                instantaneous = value;
+                current.Current = value;
-
+                currentNumberInstantaneous.Default = current.Default;
-                if (slider.IsNotNull())
-                    slider.TransferValueOnCommit = !instantaneous;
             }
         }
 
+        private readonly BindableNumberWithCurrent<T> current = new BindableNumberWithCurrent<T>();
+
+        private readonly BindableNumber<T> currentNumberInstantaneous = new BindableNumber<T>();
+
+        /// <summary>
+        /// Whether changes to the value should instantaneously transfer to outside bindables.
+        /// If <see langword="false"/>, the transfer will happen on text box commit (explicit, or implicit via focus loss), or on slider commit.
+        /// </summary>
+        public bool TransferValueOnCommit { get; set; }
+
         private CompositeDrawable? tabbableContentContainer;
 
         public CompositeDrawable? TabbableContentContainer
@@ -62,8 +58,6 @@ namespace osu.Game.Graphics.UserInterfaceV2
             }
         }
 
-        private readonly BindableNumberWithCurrent<T> current = new BindableNumberWithCurrent<T>();
-
         /// <summary>
         /// Caption describing this slider bar, displayed on top of the controls.
         /// </summary>
@@ -147,8 +141,8 @@ namespace osu.Game.Graphics.UserInterfaceV2
                             Origin = Anchor.CentreRight,
                             RelativeSizeAxes = Axes.X,
                             Width = 0.5f,
-                            Current = Current,
+                            Current = currentNumberInstantaneous,
-                            TransferValueOnCommit = !instantaneous,
+                            OnCommit = () => current.Value = currentNumberInstantaneous.Value,
                         }
                     },
                 },
@@ -170,9 +164,28 @@ namespace osu.Game.Graphics.UserInterfaceV2
 
             slider.IsDragging.BindValueChanged(_ => updateState());
 
-            currentLanguage.BindValueChanged(_ => Schedule(updateValueDisplay));
+            current.ValueChanged += e => currentNumberInstantaneous.Value = e.NewValue;
-            current.BindValueChanged(_ =>
+            current.MinValueChanged += v => currentNumberInstantaneous.MinValue = v;
+            current.MaxValueChanged += v => currentNumberInstantaneous.MaxValue = v;
+            current.PrecisionChanged += v => currentNumberInstantaneous.Precision = v;
+            current.DisabledChanged += disabled =>
             {
+                if (disabled)
+                {
+                    // revert any changes before disabling to make sure we are in a consistent state.
+                    currentNumberInstantaneous.Value = current.Value;
+                }
+
+                currentNumberInstantaneous.Disabled = disabled;
+            };
+
+            current.CopyTo(currentNumberInstantaneous);
+            currentLanguage.BindValueChanged(_ => Schedule(updateValueDisplay));
+            currentNumberInstantaneous.BindValueChanged(e =>
+            {
+                if (!TransferValueOnCommit)
+                    current.Value = e.NewValue;
+
                 updateState();
                 updateValueDisplay();
             }, true);
@@ -182,17 +195,15 @@ namespace osu.Game.Graphics.UserInterfaceV2
 
         private void textChanged(ValueChangedEvent<string> change)
         {
-            if (!instantaneous) return;
-
             tryUpdateSliderFromTextBox();
         }
 
         private void textCommitted(TextBox t, bool isNew)
         {
             tryUpdateSliderFromTextBox();
-
             // If the attempted update above failed, restore text box to match the slider.
-            Current.TriggerChange();
+            currentNumberInstantaneous.TriggerChange();
+            current.Value = currentNumberInstantaneous.Value;
 
             flashLayer.Colour = ColourInfo.GradientVertical(colourProvider.Dark2.Opacity(0), colourProvider.Dark2);
             flashLayer.FadeOutFromOne(800, Easing.OutQuint);
@@ -204,7 +215,7 @@ namespace osu.Game.Graphics.UserInterfaceV2
 
             try
             {
-                switch (Current)
+                switch (currentNumberInstantaneous)
                 {
                     case Bindable<int> bindableInt:
                         bindableInt.Value = int.Parse(textBox.Current.Value);
@@ -215,7 +226,7 @@ namespace osu.Game.Graphics.UserInterfaceV2
                         break;
 
                     default:
-                        Current.Parse(textBox.Current.Value, CultureInfo.CurrentCulture);
+                        currentNumberInstantaneous.Parse(textBox.Current.Value, CultureInfo.CurrentCulture);
                         break;
                 }
             }
@@ -250,9 +261,9 @@ namespace osu.Game.Graphics.UserInterfaceV2
         {
             textBox.Alpha = 1;
 
-            background.Colour = Current.Disabled ? colourProvider.Background4 : colourProvider.Background5;
+            background.Colour = currentNumberInstantaneous.Disabled ? colourProvider.Background4 : colourProvider.Background5;
-            caption.Colour = Current.Disabled ? colourProvider.Foreground1 : colourProvider.Content2;
+            caption.Colour = currentNumberInstantaneous.Disabled ? colourProvider.Foreground1 : colourProvider.Content2;
-            textBox.Colour = Current.Disabled ? colourProvider.Foreground1 : colourProvider.Content1;
+            textBox.Colour = currentNumberInstantaneous.Disabled ? colourProvider.Foreground1 : colourProvider.Content1;
 
             BorderThickness = IsHovered || textBox.Focused.Value || slider.IsDragging.Value ? 2 : 0;
             BorderColour = textBox.Focused.Value ? colourProvider.Highlight1 : colourProvider.Light4;
@@ -269,12 +280,13 @@ namespace osu.Game.Graphics.UserInterfaceV2
         {
             if (updatingFromTextBox) return;
 
-            textBox.Text = slider.GetDisplayableValue(Current.Value).ToString();
+            textBox.Text = slider.GetDisplayableValue(currentNumberInstantaneous.Value).ToString();
         }
 
         private partial class Slider : OsuSliderBar<T>
         {
             public BindableBool IsDragging { get; set; } = new BindableBool();
+            public Action? OnCommit { get; set; }
 
             private Box leftBox = null!;
             private Box rightBox = null!;
@@ -381,6 +393,16 @@ namespace osu.Game.Graphics.UserInterfaceV2
             {
                 nub.MoveToX(value, 200, Easing.OutPow10);
             }
+
+            protected override bool Commit()
+            {
+                bool result = base.Commit();
+
+                if (result)
+                    OnCommit?.Invoke();
+
+                return result;
+            }
         }
     }
 }

osu.Game/Screens/Edit/Setup/DifficultySection.cs

@@ -40,6 +40,7 @@ namespace osu.Game.Screens.Edit.Setup
                         MaxValue = 10,
                         Precision = 0.1f,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 healthDrainSlider = new FormSliderBar<float>
@@ -53,6 +54,7 @@ namespace osu.Game.Screens.Edit.Setup
                         MaxValue = 10,
                         Precision = 0.1f,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 approachRateSlider = new FormSliderBar<float>
@@ -66,6 +68,7 @@ namespace osu.Game.Screens.Edit.Setup
                         MaxValue = 10,
                         Precision = 0.1f,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 overallDifficultySlider = new FormSliderBar<float>
@@ -79,6 +82,7 @@ namespace osu.Game.Screens.Edit.Setup
                         MaxValue = 10,
                         Precision = 0.1f,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 baseVelocitySlider = new FormSliderBar<double>
@@ -92,6 +96,7 @@ namespace osu.Game.Screens.Edit.Setup
                         MaxValue = 3.6,
                         Precision = 0.01f,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
                 tickRateSlider = new FormSliderBar<double>
@@ -105,6 +110,7 @@ namespace osu.Game.Screens.Edit.Setup
                         MaxValue = 4,
                         Precision = 1,
                     },
+                    TransferValueOnCommit = true,
                     TabbableContentContainer = this,
                 },
             };

osu.Game/osu.Game.csproj

@@ -35,7 +35,7 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
     <PackageReference Include="Realm" Version="11.5.0" />
-    <PackageReference Include="ppy.osu.Framework" Version="2024.1006.0" />
+    <PackageReference Include="ppy.osu.Framework" Version="2024.1007.0" />
     <PackageReference Include="ppy.osu.Game.Resources" Version="2024.904.0" />
     <PackageReference Include="Sentry" Version="4.3.0" />
     <!-- Held back due to 0.34.0 failing AOT compilation on ZstdSharp.dll dependency. -->

osu.iOS.props

@@ -17,6 +17,6 @@
     <MtouchInterpreter>-all</MtouchInterpreter>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="ppy.osu.Framework.iOS" Version="2024.1006.0" />
+    <PackageReference Include="ppy.osu.Framework.iOS" Version="2024.1007.0" />
   </ItemGroup>
 </Project>