Merge pull request #1919 from smoogipoo/fix-cursor-hiding

Fix cursor not showing in visualtests

osu-framework

@@ -1 +1 @@
-Subproject commit 2c595626a3da0a28ca9cd46c4639b63ff37d5b5a
+Subproject commit 8f36ddab946ff538620081ede7719461d4732b79

osu.Game.Tests/Visual/TestCaseCursors.cs

@@ -0,0 +1,274 @@
+// Copyright (c) 2007-2018 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+using osu.Framework.Extensions.IEnumerableExtensions;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Cursor;
+using osu.Framework.Graphics.Shapes;
+using osu.Framework.Input;
+using osu.Framework.MathUtils;
+using osu.Framework.Testing.Input;
+using osu.Game.Graphics.Cursor;
+using osu.Game.Graphics.Sprites;
+using OpenTK;
+using OpenTK.Graphics;
+
+namespace osu.Game.Tests.Visual
+{
+    public class TestCaseCursors : OsuTestCase
+    {
+        private readonly ManualInputManager inputManager;
+        private readonly CursorOverrideContainer cursorOverrideContainer;
+        private readonly CustomCursorBox[] cursorBoxes = new CustomCursorBox[6];
+
+        public TestCaseCursors()
+        {
+            Child = inputManager = new ManualInputManager
+            {
+                Child = cursorOverrideContainer = new CursorOverrideContainer
+                {
+                    RelativeSizeAxes = Axes.Both,
+                    Children = new[]
+                    {
+                        // Middle user
+                        cursorBoxes[0] = new CustomCursorBox(Color4.Green)
+                        {
+                            Anchor = Anchor.Centre,
+                            Origin = Anchor.Centre,
+                            RelativeSizeAxes = Axes.Both,
+                            Size = new Vector2(0.5f),
+                        },
+                        // Top-left user
+                        cursorBoxes[1] = new CustomCursorBox(Color4.Blue)
+                        {
+                            RelativeSizeAxes = Axes.Both,
+                            Size = new Vector2(0.4f)
+                        },
+                        // Bottom-right user
+                        cursorBoxes[2] = new CustomCursorBox(Color4.Red)
+                        {
+                            Anchor = Anchor.BottomRight,
+                            Origin = Anchor.BottomRight,
+                            RelativeSizeAxes = Axes.Both,
+                            Size = new Vector2(0.4f)
+                        },
+                        // Bottom-left local
+                        cursorBoxes[3] = new CustomCursorBox(Color4.Magenta, false)
+                        {
+                            Anchor = Anchor.BottomLeft,
+                            Origin = Anchor.BottomLeft,
+                            RelativeSizeAxes = Axes.Both,
+                            Size = new Vector2(0.4f)
+                        },
+                        // Top-right local
+                        cursorBoxes[4] = new CustomCursorBox(Color4.Cyan, false)
+                        {
+                            Anchor = Anchor.TopRight,
+                            Origin = Anchor.TopRight,
+                            RelativeSizeAxes = Axes.Both,
+                            Size = new Vector2(0.4f)
+                        },
+                        // Left-local
+                        cursorBoxes[5] = new CustomCursorBox(Color4.Yellow, false)
+                        {
+                            Anchor = Anchor.CentreLeft,
+                            Origin = Anchor.CentreLeft,
+                            RelativeSizeAxes = Axes.Both,
+                            Size = new Vector2(0.2f, 1),
+                        },
+                    }
+                }
+            };
+
+            returnUserInput();
+
+            AddToggleStep("Smooth transitions", b => cursorBoxes.ForEach(box => box.SmoothTransition = b));
+
+            testUserCursor();
+            testLocalCursor();
+            testUserCursorOverride();
+            testMultipleLocalCursors();
+            returnUserInput();
+        }
+
+        /// <summary>
+        /// Returns input back to the user.
+        /// </summary>
+        private void returnUserInput()
+        {
+            AddStep("Return user input", () => inputManager.UseParentState = true);
+        }
+
+        /// <summary>
+        /// -- Green Box --
+        /// Tests whether hovering in and out of a drawable that provides the user cursor (green)
+        /// results in the correct visibility state for that cursor.
+        /// </summary>
+        private void testUserCursor()
+        {
+            AddStep("Move to green area", () => inputManager.MoveMouseTo(cursorBoxes[0]));
+            AddAssert("Check green cursor visible", () => checkVisible(cursorBoxes[0].Cursor));
+            AddAssert("Check green cursor at mouse", () => checkAtMouse(cursorBoxes[0].Cursor));
+            AddStep("Move out", moveOut);
+            AddAssert("Check green cursor invisible", () => !checkVisible(cursorBoxes[0].Cursor));
+            AddAssert("Check global cursor visible", () => checkVisible(cursorOverrideContainer.Cursor));
+        }
+
+        /// <summary>
+        /// -- Purple Box --
+        /// Tests whether hovering in and out of a drawable that provides a local cursor (purple)
+        /// results in the correct visibility and state for that cursor.
+        /// </summary>
+        private void testLocalCursor()
+        {
+            AddStep("Move to purple area", () => inputManager.MoveMouseTo(cursorBoxes[3]));
+            AddAssert("Check purple cursor visible", () => checkVisible(cursorBoxes[3].Cursor));
+            AddAssert("Check purple cursor at mouse", () => checkAtMouse(cursorBoxes[3].Cursor));
+            AddAssert("Check global cursor visible", () => checkVisible(cursorOverrideContainer.Cursor));
+            AddAssert("Check global cursor at mouse", () => checkAtMouse(cursorOverrideContainer.Cursor));
+            AddStep("Move out", moveOut);
+            AddAssert("Check purple cursor visible", () => checkVisible(cursorBoxes[3].Cursor));
+            AddAssert("Check global cursor visible", () => checkVisible(cursorOverrideContainer.Cursor));
+        }
+
+        /// <summary>
+        /// -- Blue-Green Box Boundary --
+        /// Tests whether overriding a user cursor (green) with another user cursor (blue)
+        /// results in the correct visibility and states for the cursors.
+        /// </summary>
+        private void testUserCursorOverride()
+        {
+            AddStep("Move to blue-green boundary", () => inputManager.MoveMouseTo(cursorBoxes[1].ScreenSpaceDrawQuad.BottomRight - new Vector2(10)));
+            AddAssert("Check blue cursor visible", () => checkVisible(cursorBoxes[1].Cursor));
+            AddAssert("Check green cursor invisible", () => !checkVisible(cursorBoxes[0].Cursor));
+            AddAssert("Check blue cursor at mouse", () => checkAtMouse(cursorBoxes[1].Cursor));
+            AddStep("Move out", moveOut);
+            AddAssert("Check blue cursor not visible", () => !checkVisible(cursorBoxes[1].Cursor));
+            AddAssert("Check green cursor not visible", () => !checkVisible(cursorBoxes[0].Cursor));
+        }
+
+        /// <summary>
+        /// -- Yellow-Purple Box Boundary --
+        /// Tests whether multiple local cursors (purple + yellow) may be visible and at the mouse position at the same time.
+        /// </summary>
+        private void testMultipleLocalCursors()
+        {
+            AddStep("Move to yellow-purple boundary", () => inputManager.MoveMouseTo(cursorBoxes[5].ScreenSpaceDrawQuad.BottomRight - new Vector2(10)));
+            AddAssert("Check purple cursor visible", () => checkVisible(cursorBoxes[3].Cursor));
+            AddAssert("Check purple cursor at mouse", () => checkAtMouse(cursorBoxes[3].Cursor));
+            AddAssert("Check yellow cursor visible", () => checkVisible(cursorBoxes[5].Cursor));
+            AddAssert("Check yellow cursor at mouse", () => checkAtMouse(cursorBoxes[5].Cursor));
+            AddStep("Move out", moveOut);
+            AddAssert("Check purple cursor visible", () => checkVisible(cursorBoxes[3].Cursor));
+            AddAssert("Check yellow cursor visible", () => checkVisible(cursorBoxes[5].Cursor));
+        }
+
+        /// <summary>
+        /// -- Yellow-Blue Box Boundary --
+        /// Tests whether a local cursor (yellow) may be displayed along with a user cursor override (blue).
+        /// </summary>
+        private void testUserOverrideWithLocal()
+        {
+            AddStep("Move to yellow-blue boundary", () => inputManager.MoveMouseTo(cursorBoxes[5].ScreenSpaceDrawQuad.TopRight - new Vector2(10)));
+            AddAssert("Check blue cursor visible", () => checkVisible(cursorBoxes[1].Cursor));
+            AddAssert("Check blue cursor at mouse", () => checkAtMouse(cursorBoxes[1].Cursor));
+            AddAssert("Check yellow cursor visible", () => checkVisible(cursorBoxes[5].Cursor));
+            AddAssert("Check yellow cursor at mouse", () => checkAtMouse(cursorBoxes[5].Cursor));
+            AddStep("Move out", moveOut);
+            AddAssert("Check blue cursor invisible", () => !checkVisible(cursorBoxes[1].Cursor));
+            AddAssert("Check yellow cursor visible", () => checkVisible(cursorBoxes[5].Cursor));
+        }
+
+        /// <summary>
+        /// Moves the cursor to a point not covered by any cursor containers.
+        /// </summary>
+        private void moveOut()
+            => inputManager.MoveMouseTo(new Vector2(inputManager.ScreenSpaceDrawQuad.Centre.X, inputManager.ScreenSpaceDrawQuad.TopLeft.Y));
+
+        /// <summary>
+        /// Checks if a cursor is visible.
+        /// </summary>
+        /// <param name="cursorContainer">The cursor to check.</param>
+        private bool checkVisible(CursorContainer cursorContainer) => cursorContainer.State == Visibility.Visible;
+
+        /// <summary>
+        /// Checks if a cursor is at the current inputmanager screen position.
+        /// </summary>
+        /// <param name="cursorContainer">The cursor to check.</param>
+        private bool checkAtMouse(CursorContainer cursorContainer)
+            => Precision.AlmostEquals(inputManager.CurrentState.Mouse.NativeState.Position, cursorContainer.ToScreenSpace(cursorContainer.ActiveCursor.DrawPosition));
+
+        private class CustomCursorBox : Container, IProvideCursor
+        {
+            public bool SmoothTransition;
+
+            public CursorContainer Cursor { get; }
+            public bool ProvidingUserCursor { get; }
+
+            public override bool ReceiveMouseInputAt(Vector2 screenSpacePos) => base.ReceiveMouseInputAt(screenSpacePos) || SmoothTransition && !ProvidingUserCursor;
+
+            private readonly Box background;
+
+            public CustomCursorBox(Color4 cursorColour, bool providesUserCursor = true)
+            {
+                ProvidingUserCursor = providesUserCursor;
+
+                Colour = cursorColour;
+                Masking = true;
+
+                Children = new Drawable[]
+                {
+                    background = new Box
+                    {
+                        RelativeSizeAxes = Axes.Both,
+                        Alpha = 0.1f
+                    },
+                    new OsuSpriteText
+                    {
+                        Anchor = Anchor.Centre,
+                        Origin = Anchor.Centre,
+                        Text = providesUserCursor ? "User cursor" : "Local cursor"
+                    },
+                    Cursor = new TestCursorContainer
+                    {
+                        State = providesUserCursor ? Visibility.Hidden : Visibility.Visible,
+                    }
+                };
+            }
+
+            protected override bool OnHover(InputState state)
+            {
+                background.FadeTo(0.4f, 250, Easing.OutQuint);
+                return false;
+            }
+
+            protected override void OnHoverLost(InputState state)
+            {
+                background.FadeTo(0.1f, 250);
+                base.OnHoverLost(state);
+            }
+        }
+
+        private class TestCursorContainer : CursorContainer
+        {
+            protected override Drawable CreateCursor() => new TestCursor();
+
+            private class TestCursor : CircularContainer
+            {
+                public TestCursor()
+                {
+                    Origin = Anchor.Centre;
+
+                    Size = new Vector2(50);
+                    Masking = true;
+
+                    Blending = BlendingMode.Additive;
+                    Alpha = 0.5f;
+
+                    Child = new Box { RelativeSizeAxes = Axes.Both };
+                }
+            }
+        }
+    }
+}

osu.Game.Tests/osu.Game.Tests.csproj

@@ -104,6 +104,7 @@
     <Compile Include="Visual\TestCaseBreakOverlay.cs" />
     <Compile Include="Visual\TestCaseChatDisplay.cs" />
     <Compile Include="Visual\TestCaseContextMenu.cs" />
+    <Compile Include="Visual\TestCaseCursors.cs" />
     <Compile Include="Visual\TestCaseDialogOverlay.cs" />
     <Compile Include="Visual\TestCaseDirect.cs" />
     <Compile Include="Visual\TestCaseDrawableRoom.cs" />

osu.Game/Graphics/Cursor/CursorOverrideContainer.cs

@@ -20,7 +20,7 @@ namespace osu.Game.Graphics.Cursor
         /// <summary>
         /// Whether any cursors can be displayed.
         /// </summary>
-        public bool CanShowCursor;
+        public bool CanShowCursor = true;
 
         public CursorContainer Cursor { get; }
         public bool ProvidingUserCursor => true;

osu.Game/OsuGame.cs

@@ -157,6 +157,11 @@ namespace osu.Game
         {
             base.LoadComplete();
 
+            // The next time this is updated is in UpdateAfterChildren, which occurs too late and results
+            // in the cursor being shown for a few frames during the intro.
+            // This prevents the cursor from showing until we have a screen with CursorVisible = true
+            CursorOverrideContainer.CanShowCursor = currentScreen?.CursorVisible ?? false;
+
             // hook up notifications to components.
             BeatmapManager.PostNotification = n => notifications?.Post(n);
             BeatmapManager.GetStableStorage = GetStorageForStableInstall;