Merge pull request ppy#18191 from frenzibyte/button-use-overlay-colour

Fix buttons no longer coloured using `OverlayColourProvider`
Lawtrohux · May 10, 2022 · 8a559ff · 8a559ff
2 parents 5b17e92 + 5726cf6
commit 8a559ff
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 39 deletions.
diff --git a/osu.Game.Tests/Visual/UserInterface/TestSceneRoundedButton.cs b/osu.Game.Tests/Visual/UserInterface/TestSceneRoundedButton.cs
@@ -1,44 +1,40 @@
 // 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 System;
+using System.Linq;
 using NUnit.Framework;
+using osu.Framework.Bindables;
 using osu.Framework.Graphics;
-using osu.Framework.Graphics.Containers;
-using osu.Framework.Graphics.Shapes;
+using osu.Framework.Testing;
 using osu.Game.Graphics.UserInterfaceV2;
+using osu.Game.Overlays;
 
 namespace osu.Game.Tests.Visual.UserInterface
 {
-    public class TestSceneRoundedButton : OsuTestScene
+    public class TestSceneRoundedButton : ThemeComparisonTestScene
     {
-        [Test]
-        public void TestBasic()
+        private readonly BindableBool enabled = new BindableBool(true);
+
+        protected override Drawable CreateContent() => new RoundedButton
         {
-            RoundedButton button = null;
+            Width = 400,
+            Text = "Test button",
+            Anchor = Anchor.Centre,
+            Origin = Anchor.Centre,
+            Enabled = { BindTarget = enabled },
+        };
 
-            AddStep("create button", () => Child = new Container
-            {
-                RelativeSizeAxes = Axes.Both,
-                Children = new Drawable[]
-                {
-                    new Box
-                    {
-                        RelativeSizeAxes = Axes.Both,
-                        Colour = Colour4.DarkGray
-                    },
-                    button = new RoundedButton
-                    {
-                        Width = 400,
-                        Text = "Test button",
-                        Anchor = Anchor.Centre,
-                        Origin = Anchor.Centre,
-                        Action = () => { }
-                    }
-                }
-            });
+        [Test]
+        public void TestDisabled()
+        {
+            AddToggleStep("toggle disabled", disabled => enabled.Value = !disabled);
+        }
 
-            AddToggleStep("toggle disabled", disabled => button.Action = disabled ? (Action)null : () => { });
+        [Test]
+        public void TestBackgroundColour()
+        {
+            AddStep("set red scheme", () => CreateThemedContent(OverlayColourScheme.Red));
+            AddAssert("first button has correct colour", () => Cell(0, 1).ChildrenOfType<RoundedButton>().First().BackgroundColour == new OverlayColourProvider(OverlayColourScheme.Red).Highlight1);
         }
     }
 }
diff --git a/osu.Game/Graphics/UserInterface/OsuButton.cs b/osu.Game/Graphics/UserInterface/OsuButton.cs
@@ -1,7 +1,6 @@
 // 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 System.Diagnostics;
 using osu.Framework.Allocation;
 using osu.Framework.Extensions.Color4Extensions;
 using osu.Framework.Graphics;
@@ -33,16 +32,36 @@ public LocalisableString Text
 
         private Color4? backgroundColour;
 
+        /// <summary>
+        /// Sets a custom background colour to this button, replacing the provided default.
+        /// </summary>
         public Color4 BackgroundColour
         {
-            get => backgroundColour ?? Color4.White;
+            get => backgroundColour ?? defaultBackgroundColour;
             set
             {
                 backgroundColour = value;
                 Background.FadeColour(value);
             }
         }
 
+        private Color4 defaultBackgroundColour;
+
+        /// <summary>
+        /// Sets a default background colour to this button.
+        /// </summary>
+        protected Color4 DefaultBackgroundColour
+        {
+            get => defaultBackgroundColour;
+            set
+            {
+                defaultBackgroundColour = value;
+
+                if (backgroundColour == null)
+                    Background.FadeColour(value);
+            }
+        }
+
         protected override Container<Drawable> Content { get; }
 
         protected Box Hover;
@@ -89,8 +108,7 @@ public OsuButton(HoverSampleSet? hoverSounds = HoverSampleSet.Button)
         [BackgroundDependencyLoader]
         private void load(OsuColour colours)
         {
-            if (backgroundColour == null)
-                BackgroundColour = colours.BlueDark;
+            DefaultBackgroundColour = colours.BlueDark;
         }
 
         protected override void LoadComplete()
@@ -106,10 +124,7 @@ protected override void LoadComplete()
         protected override bool OnClick(ClickEvent e)
         {
             if (Enabled.Value)
-            {
-                Debug.Assert(backgroundColour != null);
-                Background.FlashColour(backgroundColour.Value.Lighten(0.4f), 200);
-            }
+                Background.FlashColour(BackgroundColour.Lighten(0.4f), 200);
 
             return base.OnClick(e);
         }

diff --git a/osu.Game/Graphics/UserInterfaceV2/RoundedButton.cs b/osu.Game/Graphics/UserInterfaceV2/RoundedButton.cs
@@ -8,7 +8,6 @@
 using osu.Framework.Graphics.Containers;
 using osu.Game.Graphics.UserInterface;
 using osu.Game.Overlays;
-using osuTK.Graphics;
 
 namespace osu.Game.Graphics.UserInterfaceV2
 {
@@ -29,8 +28,7 @@ public override float Height
         [BackgroundDependencyLoader(true)]
         private void load([CanBeNull] OverlayColourProvider overlayColourProvider, OsuColour colours)
         {
-            if (BackgroundColour == Color4.White)
-                BackgroundColour = overlayColourProvider?.Highlight1 ?? colours.Blue3;
+            DefaultBackgroundColour = overlayColourProvider?.Highlight1 ?? colours.Blue3;
         }
 
         protected override void LoadComplete()