Merge branch 'sheared-overlay-container-click-away' into first-run-setup-sheared-overlay

.github/workflows/ci.yml

@@ -2,6 +2,60 @@ on: [push, pull_request]
 name: Continuous Integration
 
 jobs:
+  inspect-code:
+    name: Code Quality
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      # FIXME: Tools won't run in .NET 6.0 unless you install 3.1.x LTS side by side.
+      # https://itnext.io/how-to-support-multiple-net-sdks-in-github-actions-workflows-b988daa884e
+      - name: Install .NET 3.1.x LTS
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: "3.1.x"
+
+      - name: Install .NET 6.0.x
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: "6.0.x"
+
+      - name: Restore Tools
+        run: dotnet tool restore
+
+      - name: Restore Packages
+        run: dotnet restore
+
+      - name: Restore inspectcode cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ github.workspace }}/inspectcode
+          key: inspectcode-${{ hashFiles('.config/dotnet-tools.json') }}-${{ hashFiles('.github/workflows/ci.yml' ) }}
+
+      - name: CodeFileSanity
+        run: |
+          # TODO: Add ignore filters and GitHub Workflow Command Reporting in CFS. That way we don't have to do this workaround.
+          # FIXME: Suppress warnings from templates project
+          exit_code=0
+          while read -r line; do
+            if [[ ! -z "$line" ]]; then
+              echo "::error::$line"
+              exit_code=1
+            fi
+          done <<< $(dotnet codefilesanity)
+          exit $exit_code
+
+      # Temporarily disabled due to test failures, but it won't work anyway until the tool is upgraded.
+      # - name: .NET Format (Dry Run)
+      #   run: dotnet format --dry-run --check
+
+      - name: InspectCode
+        run: dotnet jb inspectcode $(pwd)/osu.Desktop.slnf --no-build --output="inspectcodereport.xml" --caches-home="inspectcode" --verbosity=WARN
+
+      - name: NVika
+        run: dotnet nvika parsereport "${{github.workspace}}/inspectcodereport.xml" --treatwarningsaserrors
+
   test:
     name: Test
     runs-on: ${{matrix.os.fullname}}
@@ -93,58 +147,4 @@ jobs:
       # cannot accept .sln(f) files as arguments.
       # Build just the main game for now.
       - name: Build
-        run: msbuild osu.iOS/osu.iOS.csproj /restore /p:Configuration=Debug
-
-  inspect-code:
-    name: Code Quality
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      # FIXME: Tools won't run in .NET 6.0 unless you install 3.1.x LTS side by side.
-      # https://itnext.io/how-to-support-multiple-net-sdks-in-github-actions-workflows-b988daa884e
-      - name: Install .NET 3.1.x LTS
-        uses: actions/setup-dotnet@v1
-        with:
-          dotnet-version: "3.1.x"
-
-      - name: Install .NET 6.0.x
-        uses: actions/setup-dotnet@v1
-        with:
-          dotnet-version: "6.0.x"
-
-      - name: Restore Tools
-        run: dotnet tool restore
-
-      - name: Restore Packages
-        run: dotnet restore
-
-      - name: Restore inspectcode cache
-        uses: actions/cache@v3
-        with:
-          path: ${{ github.workspace }}/inspectcode
-          key: inspectcode-${{ hashFiles('.config/dotnet-tools.json') }}-${{ hashFiles('.github/workflows/ci.yml' ) }}
-
-      - name: CodeFileSanity
-        run: |
-          # TODO: Add ignore filters and GitHub Workflow Command Reporting in CFS. That way we don't have to do this workaround.
-          # FIXME: Suppress warnings from templates project
-          exit_code=0
-          while read -r line; do
-            if [[ ! -z "$line" ]]; then
-              echo "::error::$line"
-              exit_code=1
-            fi
-          done <<< $(dotnet codefilesanity)
-          exit $exit_code
-
-      # Temporarily disabled due to test failures, but it won't work anyway until the tool is upgraded.
-      # - name: .NET Format (Dry Run)
-      #   run: dotnet format --dry-run --check
-
-      - name: InspectCode
-        run: dotnet jb inspectcode $(pwd)/osu.Desktop.slnf --no-build --output="inspectcodereport.xml" --caches-home="inspectcode" --verbosity=WARN
-
-      - name: NVika
-        run: dotnet nvika parsereport "${{github.workspace}}/inspectcodereport.xml" --treatwarningsaserrors
+        run: msbuild osu.iOS/osu.iOS.csproj /restore /p:Configuration=Debug

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

@@ -0,0 +1,102 @@
+// 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.Linq;
+using NUnit.Framework;
+using osu.Framework.Allocation;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Shapes;
+using osu.Framework.Testing;
+using osu.Game.Graphics;
+using osu.Game.Graphics.Sprites;
+using osu.Game.Graphics.UserInterface;
+using osu.Game.Overlays;
+using osu.Game.Overlays.Mods;
+using osuTK;
+using osuTK.Graphics;
+using osuTK.Input;
+
+namespace osu.Game.Tests.Visual.UserInterface
+{
+    [TestFixture]
+    public class TestSceneShearedOverlayContainer : OsuManualInputManagerTestScene
+    {
+        private TestShearedOverlayContainer overlay;
+
+        [SetUpSteps]
+        public void SetUpSteps()
+        {
+            AddStep("create overlay", () =>
+            {
+                Child = overlay = new TestShearedOverlayContainer
+                {
+                    State = { Value = Visibility.Visible }
+                };
+            });
+        }
+
+        [Test]
+        public void TestClickAwayToExit()
+        {
+            AddStep("click inside header", () =>
+            {
+                InputManager.MoveMouseTo(overlay.ChildrenOfType<ShearedOverlayHeader>().First().ScreenSpaceDrawQuad.Centre);
+                InputManager.Click(MouseButton.Left);
+            });
+
+            AddAssert("overlay not dismissed", () => overlay.State.Value == Visibility.Visible);
+
+            AddStep("click inside content", () =>
+            {
+                InputManager.MoveMouseTo(overlay.ScreenSpaceDrawQuad.Centre);
+                InputManager.Click(MouseButton.Left);
+            });
+
+            AddAssert("overlay not dismissed", () => overlay.State.Value == Visibility.Visible);
+
+            AddStep("click outside header", () =>
+            {
+                InputManager.MoveMouseTo(new Vector2(overlay.ScreenSpaceDrawQuad.TopLeft.X, overlay.ScreenSpaceDrawQuad.Centre.Y));
+                InputManager.Click(MouseButton.Left);
+            });
+
+            AddAssert("overlay dismissed", () => overlay.State.Value == Visibility.Hidden);
+        }
+
+        public class TestShearedOverlayContainer : ShearedOverlayContainer
+        {
+            protected override OverlayColourScheme ColourScheme => OverlayColourScheme.Green;
+
+            [BackgroundDependencyLoader]
+            private void load()
+            {
+                Header.Title = "Sheared overlay header";
+                Header.Description = string.Join(" ", Enumerable.Repeat("This is a description.", 20));
+
+                MainAreaContent.Child = new InputBlockingContainer
+                {
+                    RelativeSizeAxes = Axes.Both,
+                    Anchor = Anchor.Centre,
+                    Origin = Anchor.Centre,
+                    Size = new Vector2(0.9f),
+                    Children = new Drawable[]
+                    {
+                        new Box
+                        {
+                            Colour = Color4.Blue,
+                            RelativeSizeAxes = Axes.Both,
+                        },
+                        new OsuSpriteText
+                        {
+                            Font = OsuFont.Default.With(size: 24),
+                            Text = "Content",
+                            Anchor = Anchor.Centre,
+                            Origin = Anchor.Centre,
+                        }
+                    }
+                };
+            }
+        }
+    }
+}

osu.Game/Graphics/InputBlockingContainer.cs

@@ -0,0 +1,21 @@
+// 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 enable
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Input.Events;
+
+namespace osu.Game.Graphics
+{
+    /// <summary>
+    /// A simple container which blocks input events from travelling through it.
+    /// </summary>
+    public class InputBlockingContainer : Container
+    {
+        protected override bool OnHover(HoverEvent e) => true;
+
+        protected override bool OnMouseDown(MouseDownEvent e) => true;
+
+        protected override bool OnClick(ClickEvent e) => true;
+    }
+}

osu.Game/Graphics/UserInterface/ShearedOverlayHeader.cs

@@ -66,7 +66,7 @@ namespace osu.Game.Graphics.UserInterface
                 },
                 Children = new Drawable[]
                 {
-                    underlayContainer = new Container
+                    underlayContainer = new InputBlockingContainer
                     {
                         RelativeSizeAxes = Axes.X,
                         Height = HEIGHT,

osu.Game/Overlays/Dashboard/CurrentlyPlayingDisplay.cs

@@ -14,7 +14,6 @@ using osu.Game.Database;
 using osu.Game.Online.API;
 using osu.Game.Online.API.Requests.Responses;
 using osu.Game.Online.Spectator;
-using osu.Game.Resources.Localisation.Web;
 using osu.Game.Screens;
 using osu.Game.Screens.OnlinePlay.Match.Components;
 using osu.Game.Screens.Play;

osu.Game/Overlays/Mods/ShearedOverlayContainer.cs

@@ -5,6 +5,8 @@ using osu.Framework.Allocation;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Shapes;
+using osu.Framework.Input.Events;
+using osu.Game.Graphics;
 using osu.Game.Graphics.Containers;
 using osu.Game.Graphics.UserInterface;
 
@@ -88,7 +90,7 @@ namespace osu.Game.Overlays.Mods
                             Bottom = footer_height + PADDING,
                         }
                     },
-                    Footer = new Container
+                    Footer = new InputBlockingContainer
                     {
                         RelativeSizeAxes = Axes.X,
                         Depth = float.MinValue,
@@ -113,6 +115,17 @@ namespace osu.Game.Overlays.Mods
             };
         }
 
+        protected override bool OnClick(ClickEvent e)
+        {
+            if (State.Value == Visibility.Visible)
+            {
+                Hide();
+                return true;
+            }
+
+            return base.OnClick(e);
+        }
+
         protected override void PopIn()
         {
             const double fade_in_duration = 400;