Merge pull request #8471 from EVAST9919/overlay-scroll-container

Implement OverlayScrollContainer component

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

@@ -0,0 +1,113 @@
+// 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.Game.Overlays;
+using System;
+using System.Collections.Generic;
+using osu.Framework.Graphics;
+using osu.Framework.Allocation;
+using osu.Framework.Graphics.Shapes;
+using osuTK.Graphics;
+using NUnit.Framework;
+using osu.Framework.Utils;
+using osuTK.Input;
+
+namespace osu.Game.Tests.Visual.UserInterface
+{
+    public class TestSceneOverlayScrollContainer : OsuManualInputManagerTestScene
+    {
+        public override IReadOnlyList<Type> RequiredTypes => new[]
+        {
+            typeof(OverlayScrollContainer)
+        };
+
+        [Cached]
+        private readonly OverlayColourProvider colourProvider = new OverlayColourProvider(OverlayColourScheme.Blue);
+
+        private TestScrollContainer scroll;
+
+        private int invocationCount;
+
+        [SetUp]
+        public void SetUp() => Schedule(() =>
+        {
+            Child = scroll = new TestScrollContainer
+            {
+                RelativeSizeAxes = Axes.Both,
+                Child = new Container
+                {
+                    Height = 3000,
+                    RelativeSizeAxes = Axes.X,
+                    Child = new Box
+                    {
+                        RelativeSizeAxes = Axes.Both,
+                        Colour = Color4.Gray
+                    }
+                }
+            };
+
+            invocationCount = 0;
+
+            scroll.Button.Action += () => invocationCount++;
+        });
+
+        [Test]
+        public void TestButtonVisibility()
+        {
+            AddAssert("button is hidden", () => scroll.Button.State == Visibility.Hidden);
+
+            AddStep("scroll to end", () => scroll.ScrollToEnd(false));
+            AddAssert("button is visible", () => scroll.Button.State == Visibility.Visible);
+
+            AddStep("scroll to start", () => scroll.ScrollToStart(false));
+            AddAssert("button is hidden", () => scroll.Button.State == Visibility.Hidden);
+
+            AddStep("scroll to 500", () => scroll.ScrollTo(500));
+            AddUntilStep("scrolled to 500", () => Precision.AlmostEquals(scroll.Current, 500, 0.1f));
+            AddAssert("button is visible", () => scroll.Button.State == Visibility.Visible);
+        }
+
+        [Test]
+        public void TestButtonAction()
+        {
+            AddStep("scroll to end", () => scroll.ScrollToEnd(false));
+
+            AddStep("invoke action", () => scroll.Button.Action.Invoke());
+
+            AddUntilStep("scrolled back to start", () => Precision.AlmostEquals(scroll.Current, 0, 0.1f));
+        }
+
+        [Test]
+        public void TestClick()
+        {
+            AddStep("scroll to end", () => scroll.ScrollToEnd(false));
+
+            AddStep("click button", () =>
+            {
+                InputManager.MoveMouseTo(scroll.Button);
+                InputManager.Click(MouseButton.Left);
+            });
+
+            AddUntilStep("scrolled back to start", () => Precision.AlmostEquals(scroll.Current, 0, 0.1f));
+        }
+
+        [Test]
+        public void TestMultipleClicks()
+        {
+            AddStep("scroll to end", () => scroll.ScrollToEnd(false));
+
+            AddAssert("invocation count is 0", () => invocationCount == 0);
+
+            AddStep("hover button", () => InputManager.MoveMouseTo(scroll.Button));
+            AddRepeatStep("click button", () => InputManager.Click(MouseButton.Left), 3);
+
+            AddAssert("invocation count is 1", () => invocationCount == 1);
+        }
+
+        private class TestScrollContainer : OverlayScrollContainer
+        {
+            public new ScrollToTopButton Button => base.Button;
+        }
+    }
+}

osu.Game/Overlays/OverlayScrollContainer.cs

@@ -0,0 +1,149 @@
+// 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 osu.Framework.Allocation;
+using osu.Framework.Extensions.Color4Extensions;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Effects;
+using osu.Framework.Graphics.Shapes;
+using osu.Framework.Graphics.Sprites;
+using osu.Framework.Input.Events;
+using osu.Game.Graphics.Containers;
+using osuTK;
+using osuTK.Graphics;
+
+namespace osu.Game.Overlays
+{
+    /// <summary>
+    /// <see cref="OsuScrollContainer"/> which provides <see cref="ScrollToTopButton"/>. Mostly used in <see cref="FullscreenOverlay"/>.
+    /// </summary>
+    public class OverlayScrollContainer : OsuScrollContainer
+    {
+        /// <summary>
+        /// Scroll position at which the <see cref="ScrollToTopButton"/> will be shown.
+        /// </summary>
+        private const int button_scroll_position = 200;
+
+        protected readonly ScrollToTopButton Button;
+
+        public OverlayScrollContainer()
+        {
+            AddInternal(Button = new ScrollToTopButton
+            {
+                Anchor = Anchor.BottomRight,
+                Origin = Anchor.BottomRight,
+                Margin = new MarginPadding(20),
+                Action = () =>
+                {
+                    ScrollToStart();
+                    Button.State = Visibility.Hidden;
+                }
+            });
+        }
+
+        protected override void UpdateAfterChildren()
+        {
+            base.UpdateAfterChildren();
+
+            if (ScrollContent.DrawHeight + button_scroll_position < DrawHeight)
+            {
+                Button.State = Visibility.Hidden;
+                return;
+            }
+
+            Button.State = Target > button_scroll_position ? Visibility.Visible : Visibility.Hidden;
+        }
+
+        public class ScrollToTopButton : OsuHoverContainer
+        {
+            private const int fade_duration = 500;
+
+            private Visibility state;
+
+            public Visibility State
+            {
+                get => state;
+                set
+                {
+                    if (value == state)
+                        return;
+
+                    state = value;
+                    Enabled.Value = state == Visibility.Visible;
+                    this.FadeTo(state == Visibility.Visible ? 1 : 0, fade_duration, Easing.OutQuint);
+                }
+            }
+
+            protected override IEnumerable<Drawable> EffectTargets => new[] { background };
+
+            private Color4 flashColour;
+
+            private readonly Container content;
+            private readonly Box background;
+
+            public ScrollToTopButton()
+            {
+                Size = new Vector2(50);
+                Alpha = 0;
+                Add(content = new CircularContainer
+                {
+                    RelativeSizeAxes = Axes.Both,
+                    Anchor = Anchor.Centre,
+                    Origin = Anchor.Centre,
+                    Masking = true,
+                    EdgeEffect = new EdgeEffectParameters
+                    {
+                        Type = EdgeEffectType.Shadow,
+                        Offset = new Vector2(0f, 1f),
+                        Radius = 3f,
+                        Colour = Color4.Black.Opacity(0.25f),
+                    },
+                    Children = new Drawable[]
+                    {
+                        background = new Box
+                        {
+                            RelativeSizeAxes = Axes.Both
+                        },
+                        new SpriteIcon
+                        {
+                            Anchor = Anchor.Centre,
+                            Origin = Anchor.Centre,
+                            Size = new Vector2(15),
+                            Icon = FontAwesome.Solid.ChevronUp
+                        }
+                    }
+                });
+
+                TooltipText = "Scroll to top";
+            }
+
+            [BackgroundDependencyLoader]
+            private void load(OverlayColourProvider colourProvider)
+            {
+                IdleColour = colourProvider.Background6;
+                HoverColour = colourProvider.Background5;
+                flashColour = colourProvider.Light1;
+            }
+
+            protected override bool OnClick(ClickEvent e)
+            {
+                background.FlashColour(flashColour, 800, Easing.OutQuint);
+                return base.OnClick(e);
+            }
+
+            protected override bool OnMouseDown(MouseDownEvent e)
+            {
+                content.ScaleTo(0.75f, 2000, Easing.OutQuint);
+                return true;
+            }
+
+            protected override void OnMouseUp(MouseUpEvent e)
+            {
+                content.ScaleTo(1, 1000, Easing.OutElastic);
+                base.OnMouseUp(e);
+            }
+        }
+    }
+}