Merge pull request #21619 from EVAST9919/buttons-fix

Fix buttons receiving input outside the content

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

@@ -0,0 +1,129 @@
+// 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 osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics;
+using osu.Game.Overlays.Settings;
+using NUnit.Framework;
+using osuTK;
+using osu.Game.Overlays;
+using osu.Game.Graphics.UserInterfaceV2;
+using osu.Game.Graphics.UserInterface;
+using osu.Framework.Allocation;
+using osu.Game.Graphics.Containers;
+using osu.Framework.Graphics.Shapes;
+using osuTK.Graphics;
+using osu.Game.Graphics.Sprites;
+
+namespace osu.Game.Tests.Visual.UserInterface
+{
+    public partial class TestSceneButtonsInput : OsuManualInputManagerTestScene
+    {
+        private const int width = 500;
+
+        [Cached]
+        private OverlayColourProvider colourProvider = new OverlayColourProvider(OverlayColourScheme.Green);
+
+        private readonly SettingsButton settingsButton;
+        private readonly OsuClickableContainer clickableContainer;
+        private readonly RoundedButton roundedButton;
+        private readonly ShearedButton shearedButton;
+
+        public TestSceneButtonsInput()
+        {
+            Add(new FillFlowContainer
+            {
+                AutoSizeAxes = Axes.Y,
+                Width = 500,
+                Spacing = new Vector2(0, 5),
+                Direction = FillDirection.Vertical,
+                Children = new Drawable[]
+                {
+                    clickableContainer = new OsuClickableContainer
+                    {
+                        RelativeSizeAxes = Axes.X,
+                        Height = 40,
+                        Enabled = { Value = true },
+                        Masking = true,
+                        CornerRadius = 20,
+                        Children = new Drawable[]
+                        {
+                            new Box
+                            {
+                                RelativeSizeAxes = Axes.Both,
+                                Colour = Color4.Red
+                            },
+                            new OsuSpriteText
+                            {
+                                Anchor = Anchor.Centre,
+                                Origin = Anchor.Centre,
+                                Text = "Rounded clickable container"
+                            }
+                        }
+                    },
+                    settingsButton = new SettingsButton
+                    {
+                        Enabled = { Value = true },
+                        Text = "Settings button"
+                    },
+                    roundedButton = new RoundedButton
+                    {
+                        RelativeSizeAxes = Axes.X,
+                        Enabled = { Value = true },
+                        Text = "Rounded button"
+                    },
+                    shearedButton = new ShearedButton(width)
+                    {
+                        Text = "Sheared button",
+                        LighterColour = Colour4.FromHex("#FFFFFF"),
+                        DarkerColour = Colour4.FromHex("#FFCC22"),
+                        TextColour = Colour4.Black,
+                        Height = 40,
+                        Enabled = { Value = true },
+                        Padding = new MarginPadding(0)
+                    }
+                }
+            });
+        }
+
+        [Test]
+        public void TestSettingsButtonInput()
+        {
+            AddStep("Move cursor to button", () => InputManager.MoveMouseTo(settingsButton));
+            AddAssert("Button is hovered", () => settingsButton.IsHovered);
+            AddStep("Move cursor to padded area", () => InputManager.MoveMouseTo(settingsButton.ScreenSpaceDrawQuad.TopLeft + new Vector2(SettingsPanel.CONTENT_MARGINS / 2f, 10)));
+            AddAssert("Cursor within a button", () => settingsButton.ScreenSpaceDrawQuad.Contains(InputManager.CurrentState.Mouse.Position));
+            AddAssert("Button is not hovered", () => !settingsButton.IsHovered);
+        }
+
+        [Test]
+        public void TestRoundedButtonInput()
+        {
+            AddStep("Move cursor to button", () => InputManager.MoveMouseTo(roundedButton));
+            AddAssert("Button is hovered", () => roundedButton.IsHovered);
+            AddStep("Move cursor to corner", () => InputManager.MoveMouseTo(roundedButton.ScreenSpaceDrawQuad.TopLeft + Vector2.One));
+            AddAssert("Cursor within a button", () => roundedButton.ScreenSpaceDrawQuad.Contains(InputManager.CurrentState.Mouse.Position));
+            AddAssert("Button is not hovered", () => !roundedButton.IsHovered);
+        }
+
+        [Test]
+        public void TestShearedButtonInput()
+        {
+            AddStep("Move cursor to button", () => InputManager.MoveMouseTo(shearedButton));
+            AddAssert("Button is hovered", () => shearedButton.IsHovered);
+            AddStep("Move cursor to corner", () => InputManager.MoveMouseTo(shearedButton.ScreenSpaceDrawQuad.TopLeft + Vector2.One));
+            AddAssert("Cursor within a button", () => shearedButton.ScreenSpaceDrawQuad.Contains(InputManager.CurrentState.Mouse.Position));
+            AddAssert("Button is not hovered", () => !shearedButton.IsHovered);
+        }
+
+        [Test]
+        public void TestRoundedClickableContainerInput()
+        {
+            AddStep("Move cursor to button", () => InputManager.MoveMouseTo(clickableContainer));
+            AddAssert("Button is hovered", () => clickableContainer.IsHovered);
+            AddStep("Move cursor to corner", () => InputManager.MoveMouseTo(clickableContainer.ScreenSpaceDrawQuad.TopLeft + Vector2.One));
+            AddAssert("Cursor within a button", () => clickableContainer.ScreenSpaceDrawQuad.Contains(InputManager.CurrentState.Mouse.Position));
+            AddAssert("Button is not hovered", () => !clickableContainer.IsHovered);
+        }
+    }
+}

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

@@ -1,47 +0,0 @@
-// 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.
-
-#nullable disable
-
-using NUnit.Framework;
-using osu.Framework.Graphics;
-using osu.Game.Graphics.UserInterface;
-using osuTK;
-
-namespace osu.Game.Tests.Visual.UserInterface
-{
-    public partial class TestSceneOsuButton : OsuTestScene
-    {
-        [Test]
-        public void TestToggleEnabled()
-        {
-            OsuButton button = null;
-
-            AddStep("add button", () => Child = button = new OsuButton
-            {
-                Anchor = Anchor.Centre,
-                Origin = Anchor.Centre,
-                Size = new Vector2(200),
-                Text = "Button"
-            });
-
-            AddToggleStep("toggle enabled", toggle =>
-            {
-                for (int i = 0; i < 6; i++)
-                    button.Action = toggle ? () => { } : null;
-            });
-        }
-
-        [Test]
-        public void TestInitiallyDisabled()
-        {
-            AddStep("add button", () => Child = new OsuButton
-            {
-                Anchor = Anchor.Centre,
-                Origin = Anchor.Centre,
-                Size = new Vector2(200),
-                Text = "Button"
-            });
-        }
-    }
-}

osu.Game/Graphics/Containers/OsuClickableContainer.cs

@@ -1,14 +1,13 @@
 // 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.
 
-#nullable disable
-
 using osu.Framework.Allocation;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Cursor;
 using osu.Framework.Localisation;
 using osu.Game.Graphics.UserInterface;
+using osuTK;
 
 namespace osu.Game.Graphics.Containers
 {
@@ -18,6 +17,12 @@ namespace osu.Game.Graphics.Containers
 
         private readonly Container content = new Container { RelativeSizeAxes = Axes.Both };
 
+        public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) =>
+            // base call is checked for cases when `OsuClickableContainer` has masking applied to it directly (ie. externally in object initialisation).
+            base.ReceivePositionalInputAt(screenSpacePos)
+            // Implementations often apply masking / edge rounding at a content level, so it's imperative to check that as well.
+            && Content.ReceivePositionalInputAt(screenSpacePos);
+
         protected override Container<Drawable> Content => content;
 
         protected virtual HoverSounds CreateHoverSounds(HoverSampleSet sampleSet) => new HoverClickSounds(sampleSet) { Enabled = { BindTarget = Enabled } };
@@ -38,11 +43,8 @@ namespace osu.Game.Graphics.Containers
                 content.AutoSizeAxes = AutoSizeAxes;
             }
 
-            InternalChildren = new Drawable[]
-            {
-                content,
-                CreateHoverSounds(sampleSet)
-            };
+            AddInternal(content);
+            Add(CreateHoverSounds(sampleSet));
         }
     }
 }

osu.Game/Graphics/UserInterface/OsuButton.cs

@@ -1,8 +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.
 
-#nullable disable
-
 using osu.Framework.Allocation;
 using osu.Framework.Extensions.Color4Extensions;
 using osu.Framework.Graphics;
@@ -13,6 +11,7 @@ using osu.Framework.Graphics.UserInterface;
 using osu.Framework.Input.Events;
 using osu.Framework.Localisation;
 using osu.Game.Graphics.Sprites;
+using osuTK;
 using osuTK.Graphics;
 
 namespace osu.Game.Graphics.UserInterface
@@ -20,16 +19,12 @@ namespace osu.Game.Graphics.UserInterface
     /// <summary>
     /// A button with added default sound effects.
     /// </summary>
-    public partial class OsuButton : Button
+    public abstract partial class OsuButton : Button
     {
         public LocalisableString Text
         {
-            get => SpriteText?.Text ?? default;
-            set
-            {
-                if (SpriteText != null)
-                    SpriteText.Text = value;
-            }
+            get => SpriteText.Text;
+            set => SpriteText.Text = value;
         }
 
         private Color4? backgroundColour;
@@ -66,13 +61,19 @@ namespace osu.Game.Graphics.UserInterface
 
         protected override Container<Drawable> Content { get; }
 
+        public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) =>
+            // base call is checked for cases when `OsuClickableContainer` has masking applied to it directly (ie. externally in object initialisation).
+            base.ReceivePositionalInputAt(screenSpacePos)
+            // Implementations often apply masking / edge rounding at a content level, so it's imperative to check that as well.
+            && Content.ReceivePositionalInputAt(screenSpacePos);
+
         protected Box Hover;
         protected Box Background;
         protected SpriteText SpriteText;
 
         private readonly Box flashLayer;
 
-        public OsuButton(HoverSampleSet? hoverSounds = HoverSampleSet.Button)
+        protected OsuButton(HoverSampleSet? hoverSounds = HoverSampleSet.Button)
         {
             Height = 40;
 
@@ -115,7 +116,7 @@ namespace osu.Game.Graphics.UserInterface
             });
 
             if (hoverSounds.HasValue)
-                AddInternal(new HoverClickSounds(hoverSounds.Value) { Enabled = { BindTarget = Enabled } });
+                Add(new HoverClickSounds(hoverSounds.Value) { Enabled = { BindTarget = Enabled } });
         }
 
         [BackgroundDependencyLoader]

osu.Game/Overlays/Chat/DrawableUsername.cs

@@ -30,7 +30,7 @@ namespace osu.Game.Overlays.Chat
         public Color4 AccentColour { get; }
 
         public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) =>
-            Child.ReceivePositionalInputAt(screenSpacePos);
+            colouredDrawable.ReceivePositionalInputAt(screenSpacePos);
 
         public float FontSize
         {
@@ -87,13 +87,13 @@ namespace osu.Game.Overlays.Chat
             {
                 AccentColour = default_colours[user.Id % default_colours.Length];
 
-                Child = colouredDrawable = drawableText;
+                Add(colouredDrawable = drawableText);
             }
             else
             {
                 AccentColour = Color4Extensions.FromHex(user.Colour);
 
-                Child = new Container
+                Add(new Container
                 {
                     Anchor = Anchor.TopRight,
                     Origin = Anchor.TopRight,
@@ -127,7 +127,7 @@ namespace osu.Game.Overlays.Chat
                             }
                         }
                     }
-                };
+                });
             }
         }