Merge pull request #19774 from josh-codes/master

Add basic touch support for osu!catch

osu.Game.Rulesets.Catch.Tests/TestSceneCatchTouchInput.cs

@@ -0,0 +1,43 @@
+// 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.Graphics;
+using osu.Framework.Testing;
+using osu.Game.Rulesets.Catch.UI;
+using osu.Game.Tests.Visual;
+
+namespace osu.Game.Rulesets.Catch.Tests
+{
+    [TestFixture]
+    public class TestSceneCatchTouchInput : OsuTestScene
+    {
+        private CatchTouchInputMapper catchTouchInputMapper = null!;
+
+        [SetUpSteps]
+        public void SetUpSteps()
+        {
+            AddStep("create input overlay", () =>
+            {
+                Child = new CatchInputManager(new CatchRuleset().RulesetInfo)
+                {
+                    RelativeSizeAxes = Axes.Both,
+                    Children = new Drawable[]
+                    {
+                        catchTouchInputMapper = new CatchTouchInputMapper
+                        {
+                            Anchor = Anchor.Centre,
+                            Origin = Anchor.Centre
+                        }
+                    }
+                };
+            });
+        }
+
+        [Test]
+        public void TestBasic()
+        {
+            AddStep("show overlay", () => catchTouchInputMapper.Show());
+        }
+    }
+}

osu.Game.Rulesets.Catch/CatchInputManager.cs

@@ -4,11 +4,13 @@
 #nullable disable
 
 using System.ComponentModel;
+using osu.Framework.Allocation;
 using osu.Framework.Input.Bindings;
 using osu.Game.Rulesets.UI;
 
 namespace osu.Game.Rulesets.Catch
 {
+    [Cached]
     public class CatchInputManager : RulesetInputManager<CatchAction>
     {
         public CatchInputManager(RulesetInfo ruleset)

osu.Game.Rulesets.Catch/UI/CatchTouchInputMapper.cs

@@ -0,0 +1,277 @@
+// 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.Collections.Generic;
+using System.Linq;
+using osu.Framework.Allocation;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Shapes;
+using osu.Framework.Input.Bindings;
+using osu.Framework.Input.Events;
+using osu.Game.Graphics;
+using osuTK;
+using osuTK.Input;
+
+namespace osu.Game.Rulesets.Catch.UI
+{
+    public class CatchTouchInputMapper : VisibilityContainer
+    {
+        public override bool PropagatePositionalInputSubTree => true;
+        public override bool PropagateNonPositionalInputSubTree => true;
+
+        private readonly Dictionary<object, TouchCatchAction> trackedActionSources = new Dictionary<object, TouchCatchAction>();
+
+        private KeyBindingContainer<CatchAction> keyBindingContainer = null!;
+
+        private Container mainContent = null!;
+
+        private InputArea leftBox = null!;
+        private InputArea rightBox = null!;
+        private InputArea leftDashBox = null!;
+        private InputArea rightDashBox = null!;
+
+        [BackgroundDependencyLoader]
+        private void load(CatchInputManager catchInputManager, OsuColour colours)
+        {
+            const float width = 0.15f;
+
+            keyBindingContainer = catchInputManager.KeyBindingContainer;
+
+            RelativeSizeAxes = Axes.Both;
+
+            Children = new Drawable[]
+            {
+                mainContent = new Container
+                {
+                    RelativeSizeAxes = Axes.Both,
+                    Alpha = 0,
+                    Children = new Drawable[]
+                    {
+                        new Container
+                        {
+                            RelativeSizeAxes = Axes.Both,
+                            Width = width,
+                            Children = new Drawable[]
+                            {
+                                leftDashBox = new InputArea(TouchCatchAction.DashLeft, trackedActionSources)
+                                {
+                                    RelativeSizeAxes = Axes.Both,
+                                    Width = 0.5f,
+                                },
+                                leftBox = new InputArea(TouchCatchAction.MoveLeft, trackedActionSources)
+                                {
+                                    RelativeSizeAxes = Axes.Both,
+                                    Width = 0.5f,
+                                    Colour = colours.Gray9,
+                                    Anchor = Anchor.TopRight,
+                                    Origin = Anchor.TopRight,
+                                },
+                            }
+                        },
+                        new Container
+                        {
+                            RelativeSizeAxes = Axes.Both,
+                            Width = width,
+                            Anchor = Anchor.TopRight,
+                            Origin = Anchor.TopRight,
+                            Children = new Drawable[]
+                            {
+                                rightBox = new InputArea(TouchCatchAction.MoveRight, trackedActionSources)
+                                {
+                                    RelativeSizeAxes = Axes.Both,
+                                    Width = 0.5f,
+                                    Colour = colours.Gray9,
+                                },
+                                rightDashBox = new InputArea(TouchCatchAction.DashRight, trackedActionSources)
+                                {
+                                    RelativeSizeAxes = Axes.Both,
+                                    Width = 0.5f,
+                                    Anchor = Anchor.TopRight,
+                                    Origin = Anchor.TopRight,
+                                },
+                            }
+                        },
+                    },
+                },
+            };
+        }
+
+        protected override bool OnKeyDown(KeyDownEvent e)
+        {
+            // Hide whenever the keyboard is used.
+            Hide();
+            return false;
+        }
+
+        protected override bool OnMouseDown(MouseDownEvent e)
+        {
+            return updateAction(e.Button, getTouchCatchActionFromInput(e.ScreenSpaceMousePosition));
+        }
+
+        protected override bool OnTouchDown(TouchDownEvent e)
+        {
+            return updateAction(e.Touch.Source, getTouchCatchActionFromInput(e.ScreenSpaceTouch.Position));
+        }
+
+        protected override bool OnMouseMove(MouseMoveEvent e)
+        {
+            Show();
+
+            TouchCatchAction? action = getTouchCatchActionFromInput(e.ScreenSpaceMousePosition);
+
+            // multiple mouse buttons may be pressed and handling the same action.
+            foreach (MouseButton button in e.PressedButtons)
+                updateAction(button, action);
+
+            return false;
+        }
+
+        protected override void OnTouchMove(TouchMoveEvent e)
+        {
+            updateAction(e.Touch.Source, getTouchCatchActionFromInput(e.ScreenSpaceTouch.Position));
+            base.OnTouchMove(e);
+        }
+
+        protected override void OnMouseUp(MouseUpEvent e)
+        {
+            updateAction(e.Button, null);
+            base.OnMouseUp(e);
+        }
+
+        protected override void OnTouchUp(TouchUpEvent e)
+        {
+            updateAction(e.Touch.Source, null);
+            base.OnTouchUp(e);
+        }
+
+        private bool updateAction(object source, TouchCatchAction? newAction)
+        {
+            TouchCatchAction? actionBefore = null;
+
+            if (trackedActionSources.TryGetValue(source, out TouchCatchAction found))
+                actionBefore = found;
+
+            if (actionBefore != newAction)
+            {
+                if (newAction != null)
+                    trackedActionSources[source] = newAction.Value;
+                else
+                    trackedActionSources.Remove(source);
+
+                updatePressedActions();
+            }
+
+            return newAction != null;
+        }
+
+        private void updatePressedActions()
+        {
+            Show();
+
+            if (trackedActionSources.ContainsValue(TouchCatchAction.DashLeft) || trackedActionSources.ContainsValue(TouchCatchAction.MoveLeft))
+                keyBindingContainer.TriggerPressed(CatchAction.MoveLeft);
+            else
+                keyBindingContainer.TriggerReleased(CatchAction.MoveLeft);
+
+            if (trackedActionSources.ContainsValue(TouchCatchAction.DashRight) || trackedActionSources.ContainsValue(TouchCatchAction.MoveRight))
+                keyBindingContainer.TriggerPressed(CatchAction.MoveRight);
+            else
+                keyBindingContainer.TriggerReleased(CatchAction.MoveRight);
+
+            if (trackedActionSources.ContainsValue(TouchCatchAction.DashLeft) || trackedActionSources.ContainsValue(TouchCatchAction.DashRight))
+                keyBindingContainer.TriggerPressed(CatchAction.Dash);
+            else
+                keyBindingContainer.TriggerReleased(CatchAction.Dash);
+        }
+
+        private TouchCatchAction? getTouchCatchActionFromInput(Vector2 screenSpaceInputPosition)
+        {
+            if (leftDashBox.Contains(screenSpaceInputPosition))
+                return TouchCatchAction.DashLeft;
+            if (rightDashBox.Contains(screenSpaceInputPosition))
+                return TouchCatchAction.DashRight;
+            if (leftBox.Contains(screenSpaceInputPosition))
+                return TouchCatchAction.MoveLeft;
+            if (rightBox.Contains(screenSpaceInputPosition))
+                return TouchCatchAction.MoveRight;
+
+            return null;
+        }
+
+        protected override void PopIn() => mainContent.FadeIn(300, Easing.OutQuint);
+
+        protected override void PopOut() => mainContent.FadeOut(300, Easing.OutQuint);
+
+        private class InputArea : CompositeDrawable, IKeyBindingHandler<CatchAction>
+        {
+            private readonly TouchCatchAction handledAction;
+
+            private readonly Box highlightOverlay;
+
+            private readonly IEnumerable<KeyValuePair<object, TouchCatchAction>> trackedActions;
+
+            private bool isHighlighted;
+
+            public InputArea(TouchCatchAction handledAction, IEnumerable<KeyValuePair<object, TouchCatchAction>> trackedActions)
+            {
+                this.handledAction = handledAction;
+                this.trackedActions = trackedActions;
+
+                InternalChildren = new Drawable[]
+                {
+                    new Container
+                    {
+                        RelativeSizeAxes = Axes.Both,
+                        Masking = true,
+                        CornerRadius = 10,
+                        Children = new Drawable[]
+                        {
+                            new Box
+                            {
+                                RelativeSizeAxes = Axes.Both,
+                                Alpha = 0.15f,
+                            },
+                            highlightOverlay = new Box
+                            {
+                                RelativeSizeAxes = Axes.Both,
+                                Alpha = 0,
+                                Blending = BlendingParameters.Additive,
+                            }
+                        }
+                    }
+                };
+            }
+
+            public bool OnPressed(KeyBindingPressEvent<CatchAction> _)
+            {
+                updateHighlight();
+                return false;
+            }
+
+            public void OnReleased(KeyBindingReleaseEvent<CatchAction> _)
+            {
+                updateHighlight();
+            }
+
+            private void updateHighlight()
+            {
+                bool isHandling = trackedActions.Any(a => a.Value == handledAction);
+
+                if (isHandling == isHighlighted)
+                    return;
+
+                isHighlighted = isHandling;
+                highlightOverlay.FadeTo(isHighlighted ? 0.1f : 0, isHighlighted ? 80 : 400, Easing.OutQuint);
+            }
+        }
+
+        public enum TouchCatchAction
+        {
+            MoveLeft,
+            MoveRight,
+            DashLeft,
+            DashRight,
+        }
+    }
+}

osu.Game.Rulesets.Catch/UI/DrawableCatchRuleset.cs

@@ -4,6 +4,7 @@
 #nullable disable
 
 using System.Collections.Generic;
+using osu.Framework.Allocation;
 using osu.Framework.Input;
 using osu.Game.Beatmaps;
 using osu.Game.Configuration;
@@ -32,6 +33,12 @@ namespace osu.Game.Rulesets.Catch.UI
             TimeRange.Value = IBeatmapDifficultyInfo.DifficultyRange(beatmap.Difficulty.ApproachRate, 1800, 1200, 450);
         }
 
+        [BackgroundDependencyLoader]
+        private void load()
+        {
+            KeyBindingInputManager.Add(new CatchTouchInputMapper());
+        }
+
         protected override ReplayInputHandler CreateReplayInputHandler(Replay replay) => new CatchFramedReplayInputHandler(replay);
 
         protected override ReplayRecorder CreateReplayRecorder(Score score) => new CatchReplayRecorder(score, (CatchPlayfield)Playfield);