Merge pull request #5267 from Game4all/refactor-osd

Refactor OnScreenDisplay to allow displaying on custom messages

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

@@ -7,6 +7,7 @@ using osu.Framework.Configuration;
 using osu.Framework.Configuration.Tracking;
 using osu.Framework.Graphics;
 using osu.Game.Overlays;
+using osu.Game.Overlays.OSD;
 
 namespace osu.Game.Tests.Visual.UserInterface
 {
@@ -22,6 +23,12 @@ namespace osu.Game.Tests.Visual.UserInterface
             osd.BeginTracking(this, config);
             Add(osd);
 
+            AddStep("Display empty osd toast", () => osd.Display(new EmptyToast()));
+            AddAssert("Toast width is 240", () => osd.Child.Width == 240);
+
+            AddStep("Display toast with lengthy text", () => osd.Display(new LengthyToast()));
+            AddAssert("Toast width is greater than 240", () => osd.Child.Width > 240);
+
             AddRepeatStep("Change toggle (no bind)", () => config.ToggleSetting(TestConfigSetting.ToggleSettingNoKeybind), 2);
             AddRepeatStep("Change toggle (with bind)", () => config.ToggleSetting(TestConfigSetting.ToggleSettingWithKeybind), 2);
             AddRepeatStep("Change enum (no bind)", () => config.IncrementEnumSetting(TestConfigSetting.EnumSettingNoKeybind), 3);
@@ -86,6 +93,22 @@ namespace osu.Game.Tests.Visual.UserInterface
             Setting4
         }
 
+        private class EmptyToast : Toast
+        {
+            public EmptyToast()
+                : base("", "", "")
+            {
+            }
+        }
+
+        private class LengthyToast : Toast
+        {
+            public LengthyToast()
+                : base("Toast with a very very very long text", "A very very very very very very long text also", "A very very very very very long shortcut")
+            {
+            }
+        }
+
         private class TestOnScreenDisplay : OnScreenDisplay
         {
             protected override void DisplayTemporarily(Drawable toDisplay) => toDisplay.FadeIn().ResizeHeightTo(110);

osu.Game/Overlays/OSD/Toast.cs

@@ -0,0 +1,84 @@
+// 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;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Shapes;
+using osu.Game.Graphics;
+using osu.Game.Graphics.Sprites;
+using osuTK;
+using osuTK.Graphics;
+
+namespace osu.Game.Overlays.OSD
+{
+    public abstract class Toast : Container
+    {
+        private const int toast_minimum_width = 240;
+
+        private readonly Container content;
+        protected override Container<Drawable> Content => content;
+
+        protected readonly OsuSpriteText ValueText;
+
+        protected Toast(string description, string value, string shortcut)
+        {
+            Anchor = Anchor.Centre;
+            Origin = Anchor.Centre;
+
+            // A toast's height is decided (and transformed) by the containing OnScreenDisplay.
+            RelativeSizeAxes = Axes.Y;
+            AutoSizeAxes = Axes.X;
+
+            InternalChildren = new Drawable[]
+            {
+                new Container //this container exists just to set a minimum width for the toast
+                {
+                    Anchor = Anchor.Centre,
+                    Origin = Anchor.Centre,
+                    Width = toast_minimum_width
+                },
+                new Box
+                {
+                    RelativeSizeAxes = Axes.Both,
+                    Colour = Color4.Black,
+                    Alpha = 0.7f
+                },
+                content = new Container
+                {
+                    Anchor = Anchor.Centre,
+                    Origin = Anchor.Centre,
+                    RelativeSizeAxes = Axes.Both,
+                },
+                new OsuSpriteText
+                {
+                    Padding = new MarginPadding(10),
+                    Name = "Description",
+                    Font = OsuFont.GetFont(size: 14, weight: FontWeight.Black),
+                    Spacing = new Vector2(1, 0),
+                    Anchor = Anchor.TopCentre,
+                    Origin = Anchor.TopCentre,
+                    Text = description.ToUpperInvariant()
+                },
+                ValueText = new OsuSpriteText
+                {
+                    Font = OsuFont.GetFont(size: 24, weight: FontWeight.Light),
+                    Padding = new MarginPadding { Left = 10, Right = 10 },
+                    Name = "Value",
+                    Anchor = Anchor.Centre,
+                    Origin = Anchor.Centre,
+                    Text = value
+                },
+                new OsuSpriteText
+                {
+                    Anchor = Anchor.BottomCentre,
+                    Origin = Anchor.BottomCentre,
+                    Name = "Shortcut",
+                    Alpha = 0.3f,
+                    Margin = new MarginPadding { Bottom = 15 },
+                    Font = OsuFont.GetFont(size: 12, weight: FontWeight.Bold),
+                    Text = string.IsNullOrEmpty(shortcut) ? "NO KEY BOUND" : shortcut.ToUpperInvariant()
+                },
+            };
+        }
+    }
+}

osu.Game/Overlays/OSD/TrackedSettingToast.cs

@@ -0,0 +1,147 @@
+// 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;
+using osu.Framework.Allocation;
+using osu.Framework.Configuration.Tracking;
+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.Game.Graphics;
+using osuTK;
+using osuTK.Graphics;
+
+namespace osu.Game.Overlays.OSD
+{
+    public class TrackedSettingToast : Toast
+    {
+        private const int lights_bottom_margin = 40;
+
+        public TrackedSettingToast(SettingDescription description)
+            : base(description.Name, description.Value, description.Shortcut)
+        {
+            FillFlowContainer<OptionLight> optionLights;
+
+            Children = new Drawable[]
+            {
+                new Container
+                {
+                    Anchor = Anchor.BottomCentre,
+                    Origin = Anchor.BottomCentre,
+                    Margin = new MarginPadding { Bottom = lights_bottom_margin },
+                    Children = new Drawable[]
+                    {
+                        optionLights = new FillFlowContainer<OptionLight>
+                        {
+                            Margin = new MarginPadding { Bottom = 5 },
+                            Spacing = new Vector2(5, 0),
+                            Direction = FillDirection.Horizontal,
+                            Anchor = Anchor.TopCentre,
+                            Origin = Anchor.TopCentre,
+                            AutoSizeAxes = Axes.Both
+                        },
+                    }
+                }
+            };
+
+            int optionCount = 0;
+            int selectedOption = -1;
+
+            switch (description.RawValue)
+            {
+                case bool val:
+                    optionCount = 1;
+                    if (val) selectedOption = 0;
+                    break;
+
+                case Enum _:
+                    var values = Enum.GetValues(description.RawValue.GetType());
+                    optionCount = values.Length;
+                    selectedOption = Convert.ToInt32(description.RawValue);
+                    break;
+            }
+
+            ValueText.Origin = optionCount > 0 ? Anchor.BottomCentre : Anchor.Centre;
+
+            for (int i = 0; i < optionCount; i++)
+                optionLights.Add(new OptionLight { Glowing = i == selectedOption });
+        }
+
+        private class OptionLight : Container
+        {
+            private Color4 glowingColour, idleColour;
+
+            private const float transition_speed = 300;
+
+            private const float glow_strength = 0.4f;
+
+            private readonly Box fill;
+
+            public OptionLight()
+            {
+                Children = new[]
+                {
+                    fill = new Box
+                    {
+                        RelativeSizeAxes = Axes.Both,
+                        Alpha = 1,
+                    },
+                };
+            }
+
+            private bool glowing;
+
+            public bool Glowing
+            {
+                set
+                {
+                    glowing = value;
+                    if (!IsLoaded) return;
+
+                    updateGlow();
+                }
+            }
+
+            [BackgroundDependencyLoader]
+            private void load(OsuColour colours)
+            {
+                fill.Colour = idleColour = Color4.White.Opacity(0.4f);
+                glowingColour = Color4.White;
+
+                Size = new Vector2(25, 5);
+
+                Masking = true;
+                CornerRadius = 3;
+
+                EdgeEffect = new EdgeEffectParameters
+                {
+                    Colour = colours.BlueDark.Opacity(glow_strength),
+                    Type = EdgeEffectType.Glow,
+                    Radius = 8,
+                };
+            }
+
+            protected override void LoadComplete()
+            {
+                updateGlow();
+                FinishTransforms(true);
+            }
+
+            private void updateGlow()
+            {
+                if (glowing)
+                {
+                    fill.FadeColour(glowingColour, transition_speed, Easing.OutQuint);
+                    FadeEdgeEffectTo(glow_strength, transition_speed, Easing.OutQuint);
+                }
+                else
+                {
+                    FadeEdgeEffectTo(0, transition_speed, Easing.OutQuint);
+                    fill.FadeColour(idleColour, transition_speed, Easing.OutQuint);
+                }
+            }
+        }
+    }
+}

osu.Game/Overlays/OnScreenDisplay.cs

@@ -8,34 +8,25 @@ using osu.Framework.Configuration;
 using osu.Framework.Configuration.Tracking;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
-using osu.Framework.Graphics.Shapes;
-using osu.Framework.Graphics.Sprites;
-using osu.Game.Graphics;
 using osuTK;
-using osuTK.Graphics;
-using osu.Framework.Extensions.Color4Extensions;
-using osu.Framework.Graphics.Effects;
 using osu.Framework.Graphics.Transforms;
 using osu.Framework.Threading;
 using osu.Game.Configuration;
-using osu.Game.Graphics.Sprites;
+using osu.Game.Overlays.OSD;
 
 namespace osu.Game.Overlays
 {
+    /// <summary>
+    /// An on-screen display which automatically tracks and displays toast notifications for <seealso cref="TrackedSettings"/>.
+    /// Can also display custom content via <see cref="Display(Toast)"/>
+    /// </summary>
     public class OnScreenDisplay : Container
     {
         private readonly Container box;
 
-        private readonly SpriteText textLine1;
-        private readonly SpriteText textLine2;
-        private readonly SpriteText textLine3;
-
         private const float height = 110;
-        private const float height_notext = 98;
         private const float height_contracted = height * 0.9f;
 
-        private readonly FillFlowContainer<OptionLight> optionLights;
-
         public OnScreenDisplay()
         {
             RelativeSizeAxes = Axes.Both;
@@ -52,64 +43,6 @@ namespace osu.Game.Overlays
                     Height = height_contracted,
                     Alpha = 0,
                     CornerRadius = 20,
-                    Children = new Drawable[]
-                    {
-                        new Box
-                        {
-                            RelativeSizeAxes = Axes.Both,
-                            Colour = Color4.Black,
-                            Alpha = 0.7f,
-                        },
-                        new Container // purely to add a minimum width
-                        {
-                            Anchor = Anchor.Centre,
-                            Origin = Anchor.Centre,
-                            Width = 240,
-                            RelativeSizeAxes = Axes.Y,
-                        },
-                        textLine1 = new OsuSpriteText
-                        {
-                            Padding = new MarginPadding(10),
-                            Font = OsuFont.GetFont(size: 14, weight: FontWeight.Black),
-                            Spacing = new Vector2(1, 0),
-                            Anchor = Anchor.TopCentre,
-                            Origin = Anchor.TopCentre,
-                        },
-                        textLine2 = new OsuSpriteText
-                        {
-                            Font = OsuFont.GetFont(size: 24, weight: FontWeight.Light),
-                            Padding = new MarginPadding { Left = 10, Right = 10 },
-                            Anchor = Anchor.Centre,
-                            Origin = Anchor.BottomCentre,
-                        },
-                        new FillFlowContainer
-                        {
-                            Anchor = Anchor.BottomCentre,
-                            Origin = Anchor.BottomCentre,
-                            AutoSizeAxes = Axes.Both,
-                            Direction = FillDirection.Vertical,
-                            Children = new Drawable[]
-                            {
-                                optionLights = new FillFlowContainer<OptionLight>
-                                {
-                                    Padding = new MarginPadding { Top = 20, Bottom = 5 },
-                                    Spacing = new Vector2(5, 0),
-                                    Direction = FillDirection.Horizontal,
-                                    Anchor = Anchor.TopCentre,
-                                    Origin = Anchor.TopCentre,
-                                    AutoSizeAxes = Axes.Both
-                                },
-                                textLine3 = new OsuSpriteText
-                                {
-                                    Anchor = Anchor.TopCentre,
-                                    Origin = Anchor.TopCentre,
-                                    Margin = new MarginPadding { Bottom = 15 },
-                                    Font = OsuFont.GetFont(size: 12, weight: FontWeight.Bold),
-                                    Alpha = 0.3f,
-                                },
-                            }
-                        }
-                    }
                 },
             };
         }
@@ -142,7 +75,7 @@ namespace osu.Game.Overlays
                 return;
 
             configManager.LoadInto(trackedSettings);
-            trackedSettings.SettingChanged += display;
+            trackedSettings.SettingChanged += displayTrackedSettingChange;
 
             trackedConfigManagers.Add((source, configManager), trackedSettings);
         }
@@ -162,56 +95,23 @@ namespace osu.Game.Overlays
                 return;
 
             existing.Unload();
-            existing.SettingChanged -= display;
+            existing.SettingChanged -= displayTrackedSettingChange;
 
             trackedConfigManagers.Remove((source, configManager));
         }
 
-        private void display(SettingDescription description)
+        /// <summary>
+        /// Displays the provided <see cref="Toast"/> temporarily.
+        /// </summary>
+        /// <param name="toast"></param>
+        public void Display(Toast toast)
         {
-            Schedule(() =>
+            box.Child = toast;
-            {
+            DisplayTemporarily(box);
-                textLine1.Text = description.Name.ToUpperInvariant();
-                textLine2.Text = description.Value;
-                textLine3.Text = description.Shortcut.ToUpperInvariant();
-
-                if (string.IsNullOrEmpty(textLine3.Text))
-                    textLine3.Text = "NO KEY BOUND";
-
-                DisplayTemporarily(box);
-
-                int optionCount = 0;
-                int selectedOption = -1;
-
-                switch (description.RawValue)
-                {
-                    case bool val:
-                        optionCount = 1;
-                        if (val) selectedOption = 0;
-                        break;
-
-                    case Enum _:
-                        var values = Enum.GetValues(description.RawValue.GetType());
-                        optionCount = values.Length;
-                        selectedOption = Convert.ToInt32(description.RawValue);
-                        break;
-                }
-
-                textLine2.Origin = optionCount > 0 ? Anchor.BottomCentre : Anchor.Centre;
-                textLine2.Y = optionCount > 0 ? 0 : 5;
-
-                if (optionLights.Children.Count != optionCount)
-                {
-                    optionLights.Clear();
-                    for (int i = 0; i < optionCount; i++)
-                        optionLights.Add(new OptionLight());
-                }
-
-                for (int i = 0; i < optionCount; i++)
-                    optionLights.Children[i].Glowing = i == selectedOption;
-            });
         }
 
+        private void displayTrackedSettingChange(SettingDescription description) => Schedule(() => Display(new TrackedSettingToast(description)));
+
         private TransformSequence<Drawable> fadeIn;
         private ScheduledDelegate fadeOut;
 
@@ -236,80 +136,5 @@ namespace osu.Game.Overlays
                     b => b.ResizeHeightTo(height_contracted, 1500, Easing.InQuint));
             }, 500);
         }
-
-        private class OptionLight : Container
-        {
-            private Color4 glowingColour, idleColour;
-
-            private const float transition_speed = 300;
-
-            private const float glow_strength = 0.4f;
-
-            private readonly Box fill;
-
-            public OptionLight()
-            {
-                Children = new[]
-                {
-                    fill = new Box
-                    {
-                        RelativeSizeAxes = Axes.Both,
-                        Alpha = 1,
-                    },
-                };
-            }
-
-            private bool glowing;
-
-            public bool Glowing
-            {
-                set
-                {
-                    glowing = value;
-                    if (!IsLoaded) return;
-
-                    updateGlow();
-                }
-            }
-
-            private void updateGlow()
-            {
-                if (glowing)
-                {
-                    fill.FadeColour(glowingColour, transition_speed, Easing.OutQuint);
-                    FadeEdgeEffectTo(glow_strength, transition_speed, Easing.OutQuint);
-                }
-                else
-                {
-                    FadeEdgeEffectTo(0, transition_speed, Easing.OutQuint);
-                    fill.FadeColour(idleColour, transition_speed, Easing.OutQuint);
-                }
-            }
-
-            [BackgroundDependencyLoader]
-            private void load(OsuColour colours)
-            {
-                fill.Colour = idleColour = Color4.White.Opacity(0.4f);
-                glowingColour = Color4.White;
-
-                Size = new Vector2(25, 5);
-
-                Masking = true;
-                CornerRadius = 3;
-
-                EdgeEffect = new EdgeEffectParameters
-                {
-                    Colour = colours.BlueDark.Opacity(glow_strength),
-                    Type = EdgeEffectType.Glow,
-                    Radius = 8,
-                };
-            }
-
-            protected override void LoadComplete()
-            {
-                updateGlow();
-                FinishTransforms(true);
-            }
-        }
     }
 }