Merge pull request #19349 from bdach/mod-overlay/presets-column

Implement basic appearance of mod preset column

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

@@ -0,0 +1,77 @@
+// 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 NUnit.Framework;
+using osu.Framework.Allocation;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Game.Overlays;
+using osu.Game.Overlays.Mods;
+using osu.Game.Rulesets.Mods;
+using osu.Game.Rulesets.Osu.Mods;
+
+namespace osu.Game.Tests.Visual.UserInterface
+{
+    public class TestSceneModPresetColumn : OsuTestScene
+    {
+        [Cached]
+        private OverlayColourProvider colourProvider = new OverlayColourProvider(OverlayColourScheme.Green);
+
+        [Test]
+        public void TestBasicAppearance()
+        {
+            ModPresetColumn modPresetColumn = null!;
+
+            AddStep("create content", () => Child = new Container
+            {
+                RelativeSizeAxes = Axes.Both,
+                Padding = new MarginPadding(30),
+                Child = modPresetColumn = new ModPresetColumn
+                {
+                    Anchor = Anchor.Centre,
+                    Origin = Anchor.Centre,
+                    Presets = createTestPresets().ToArray()
+                }
+            });
+            AddStep("change presets", () => modPresetColumn.Presets = createTestPresets().Skip(1).ToArray());
+        }
+
+        private static IEnumerable<ModPreset> createTestPresets() => new[]
+        {
+            new ModPreset
+            {
+                Name = "First preset",
+                Description = "Please ignore",
+                Mods = new Mod[]
+                {
+                    new OsuModHardRock(),
+                    new OsuModDoubleTime()
+                }
+            },
+            new ModPreset
+            {
+                Name = "AR0",
+                Description = "For good readers",
+                Mods = new Mod[]
+                {
+                    new OsuModDifficultyAdjust
+                    {
+                        ApproachRate = { Value = 0 }
+                    }
+                }
+            },
+            new ModPreset
+            {
+                Name = "This preset is going to have an extraordinarily long name",
+                Description = "This is done so that the capability to truncate overlong texts may be demonstrated",
+                Mods = new Mod[]
+                {
+                    new OsuModFlashlight(),
+                    new OsuModSpinIn()
+                }
+            }
+        };
+    }
+}

osu.Game/Localisation/ModSelectOverlayStrings.cs

@@ -24,6 +24,11 @@ namespace osu.Game.Localisation
         /// </summary>
         public static LocalisableString ModCustomisation => new TranslatableString(getKey(@"mod_customisation"), @"Mod Customisation");
 
+        /// <summary>
+        /// "Personal Presets"
+        /// </summary>
+        public static LocalisableString PersonalPresets => new TranslatableString(getKey(@"personal_presets"), @"Personal Presets");
+
         private static string getKey(string key) => $@"{prefix}:{key}";
     }
 }

osu.Game/Overlays/Mods/ModColumn.cs

@@ -12,14 +12,10 @@ using osu.Framework.Allocation;
 using osu.Framework.Bindables;
 using osu.Framework.Extensions.Color4Extensions;
 using osu.Framework.Graphics;
-using osu.Framework.Graphics.Colour;
-using osu.Framework.Graphics.Containers;
-using osu.Framework.Graphics.Shapes;
 using osu.Framework.Graphics.Sprites;
 using osu.Framework.Input.Events;
 using osu.Game.Configuration;
 using osu.Game.Graphics;
-using osu.Game.Graphics.Containers;
 using osu.Game.Graphics.UserInterface;
 using osu.Game.Localisation;
 using osu.Game.Overlays.Mods.Input;
@@ -29,10 +25,8 @@ using osuTK.Graphics;
 
 namespace osu.Game.Overlays.Mods
 {
-    public class ModColumn : CompositeDrawable
+    public class ModColumn : ModSelectColumn
     {
-        public readonly Container TopLevelContent;
-
         public readonly ModType ModType;
 
         private IReadOnlyList<ModState> availableMods = Array.Empty<ModState>();
@@ -62,149 +56,29 @@ namespace osu.Game.Overlays.Mods
             }
         }
 
-        /// <summary>
-        /// Determines whether this column should accept user input.
-        /// </summary>
-        public Bindable<bool> Active = new BindableBool(true);
-
-        protected override bool ReceivePositionalInputAtSubTree(Vector2 screenSpacePos) => base.ReceivePositionalInputAtSubTree(screenSpacePos) && Active.Value;
-
         protected virtual ModPanel CreateModPanel(ModState mod) => new ModPanel(mod);
 
         private readonly bool allowIncompatibleSelection;
 
-        private readonly TextFlowContainer headerText;
-        private readonly Box headerBackground;
-        private readonly Container contentContainer;
-        private readonly Box contentBackground;
-        private readonly FillFlowContainer<ModPanel> panelFlow;
         private readonly ToggleAllCheckbox? toggleAllCheckbox;
 
-        private Colour4 accentColour;
-
         private Bindable<ModSelectHotkeyStyle> hotkeyStyle = null!;
         private IModHotkeyHandler hotkeyHandler = null!;
 
         private Task? latestLoadTask;
         internal bool ItemsLoaded => latestLoadTask == null;
 
-        private const float header_height = 42;
-
         public ModColumn(ModType modType, bool allowIncompatibleSelection)
         {
             ModType = modType;
             this.allowIncompatibleSelection = allowIncompatibleSelection;
 
-            Width = 320;
+            HeaderText = ModType.Humanize(LetterCasing.Title);
-            RelativeSizeAxes = Axes.Y;
-            Shear = new Vector2(ShearedOverlayContainer.SHEAR, 0);
-
-            Container controlContainer;
-            InternalChildren = new Drawable[]
-            {
-                TopLevelContent = new Container
-                {
-                    RelativeSizeAxes = Axes.Both,
-                    CornerRadius = ModSelectPanel.CORNER_RADIUS,
-                    Masking = true,
-                    Children = new Drawable[]
-                    {
-                        new Container
-                        {
-                            RelativeSizeAxes = Axes.X,
-                            Height = header_height + ModSelectPanel.CORNER_RADIUS,
-                            Children = new Drawable[]
-                            {
-                                headerBackground = new Box
-                                {
-                                    RelativeSizeAxes = Axes.X,
-                                    Height = header_height + ModSelectPanel.CORNER_RADIUS
-                                },
-                                headerText = new OsuTextFlowContainer(t =>
-                                {
-                                    t.Font = OsuFont.TorusAlternate.With(size: 17);
-                                    t.Shadow = false;
-                                    t.Colour = Colour4.Black;
-                                })
-                                {
-                                    RelativeSizeAxes = Axes.X,
-                                    AutoSizeAxes = Axes.Y,
-                                    Anchor = Anchor.CentreLeft,
-                                    Origin = Anchor.CentreLeft,
-                                    Shear = new Vector2(-ShearedOverlayContainer.SHEAR, 0),
-                                    Padding = new MarginPadding
-                                    {
-                                        Horizontal = 17,
-                                        Bottom = ModSelectPanel.CORNER_RADIUS
-                                    }
-                                }
-                            }
-                        },
-                        new Container
-                        {
-                            RelativeSizeAxes = Axes.Both,
-                            Padding = new MarginPadding { Top = header_height },
-                            Child = contentContainer = new Container
-                            {
-                                RelativeSizeAxes = Axes.Both,
-                                Masking = true,
-                                CornerRadius = ModSelectPanel.CORNER_RADIUS,
-                                BorderThickness = 3,
-                                Children = new Drawable[]
-                                {
-                                    contentBackground = new Box
-                                    {
-                                        RelativeSizeAxes = Axes.Both
-                                    },
-                                    new GridContainer
-                                    {
-                                        RelativeSizeAxes = Axes.Both,
-                                        RowDimensions = new[]
-                                        {
-                                            new Dimension(GridSizeMode.AutoSize),
-                                            new Dimension()
-                                        },
-                                        Content = new[]
-                                        {
-                                            new Drawable[]
-                                            {
-                                                controlContainer = new Container
-                                                {
-                                                    RelativeSizeAxes = Axes.X,
-                                                    Padding = new MarginPadding { Horizontal = 14 }
-                                                }
-                                            },
-                                            new Drawable[]
-                                            {
-                                                new OsuScrollContainer(Direction.Vertical)
-                                                {
-                                                    RelativeSizeAxes = Axes.Both,
-                                                    ClampExtension = 100,
-                                                    ScrollbarOverlapsContent = false,
-                                                    Child = panelFlow = new FillFlowContainer<ModPanel>
-                                                    {
-                                                        RelativeSizeAxes = Axes.X,
-                                                        AutoSizeAxes = Axes.Y,
-                                                        Spacing = new Vector2(0, 7),
-                                                        Padding = new MarginPadding(7)
-                                                    }
-                                                }
-                                            }
-                                        }
-                                    }
-                                }
-                            }
-                        }
-                    }
-                }
-            };
-
-            createHeaderText();
 
             if (allowIncompatibleSelection)
             {
-                controlContainer.Height = 35;
+                ControlContainer.Height = 35;
-                controlContainer.Add(toggleAllCheckbox = new ToggleAllCheckbox(this)
+                ControlContainer.Add(toggleAllCheckbox = new ToggleAllCheckbox(this)
                 {
                     Anchor = Anchor.CentreLeft,
                     Origin = Anchor.CentreLeft,
@@ -212,7 +86,7 @@ namespace osu.Game.Overlays.Mods
                     RelativeSizeAxes = Axes.X,
                     Shear = new Vector2(-ShearedOverlayContainer.SHEAR, 0)
                 });
-                panelFlow.Padding = new MarginPadding
+                ItemsFlow.Padding = new MarginPadding
                 {
                     Top = 0,
                     Bottom = 7,
@@ -221,33 +95,17 @@ namespace osu.Game.Overlays.Mods
             }
         }
 
-        private void createHeaderText()
-        {
-            IEnumerable<string> headerTextWords = ModType.Humanize(LetterCasing.Title).Split(' ');
-
-            if (headerTextWords.Count() > 1)
-            {
-                headerText.AddText($"{headerTextWords.First()} ", t => t.Font = t.Font.With(weight: FontWeight.SemiBold));
-                headerTextWords = headerTextWords.Skip(1);
-            }
-
-            headerText.AddText(string.Join(' ', headerTextWords));
-        }
-
         [BackgroundDependencyLoader]
-        private void load(OverlayColourProvider colourProvider, OsuColour colours, OsuConfigManager configManager)
+        private void load(OsuColour colours, OsuConfigManager configManager)
         {
-            headerBackground.Colour = accentColour = colours.ForModType(ModType);
+            AccentColour = colours.ForModType(ModType);
 
             if (toggleAllCheckbox != null)
             {
-                toggleAllCheckbox.AccentColour = accentColour;
+                toggleAllCheckbox.AccentColour = AccentColour;
-                toggleAllCheckbox.AccentHoverColour = accentColour.Lighten(0.3f);
+                toggleAllCheckbox.AccentHoverColour = AccentColour.Lighten(0.3f);
             }
 
-            contentContainer.BorderColour = ColourInfo.GradientVertical(colourProvider.Background4, colourProvider.Background3);
-            contentBackground.Colour = colourProvider.Background4;
-
             hotkeyStyle = configManager.GetBindable<ModSelectHotkeyStyle>(OsuSetting.ModSelectHotkeyStyle);
         }
 
@@ -278,7 +136,7 @@ namespace osu.Game.Overlays.Mods
 
             latestLoadTask = loadTask = LoadComponentsAsync(panels, loaded =>
             {
-                panelFlow.ChildrenEnumerable = loaded;
+                ItemsFlow.ChildrenEnumerable = loaded;
                 updateState();
             }, (cancellationTokenSource = new CancellationTokenSource()).Token);
             loadTask.ContinueWith(_ =>

osu.Game/Overlays/Mods/ModPresetColumn.cs

@@ -0,0 +1,77 @@
+// 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 System.Collections.Generic;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using osu.Framework.Allocation;
+using osu.Game.Graphics;
+using osu.Game.Localisation;
+using osu.Game.Rulesets.Mods;
+using osuTK;
+
+namespace osu.Game.Overlays.Mods
+{
+    public class ModPresetColumn : ModSelectColumn
+    {
+        private IReadOnlyList<ModPreset> presets = Array.Empty<ModPreset>();
+
+        /// <summary>
+        /// Sets the collection of available mod presets.
+        /// </summary>
+        public IReadOnlyList<ModPreset> Presets
+        {
+            get => presets;
+            set
+            {
+                presets = value;
+
+                if (IsLoaded)
+                    asyncLoadPanels();
+            }
+        }
+
+        [BackgroundDependencyLoader]
+        private void load(OsuColour colours)
+        {
+            AccentColour = colours.Orange1;
+            HeaderText = ModSelectOverlayStrings.PersonalPresets;
+        }
+
+        protected override void LoadComplete()
+        {
+            base.LoadComplete();
+
+            asyncLoadPanels();
+        }
+
+        private CancellationTokenSource? cancellationTokenSource;
+
+        private Task? latestLoadTask;
+        internal bool ItemsLoaded => latestLoadTask == null;
+
+        private void asyncLoadPanels()
+        {
+            cancellationTokenSource?.Cancel();
+
+            var panels = presets.Select(preset => new ModPresetPanel(preset)
+            {
+                Shear = Vector2.Zero
+            });
+
+            Task? loadTask;
+
+            latestLoadTask = loadTask = LoadComponentsAsync(panels, loaded =>
+            {
+                ItemsFlow.ChildrenEnumerable = loaded;
+            }, (cancellationTokenSource = new CancellationTokenSource()).Token);
+            loadTask.ContinueWith(_ =>
+            {
+                if (loadTask == latestLoadTask)
+                    latestLoadTask = null;
+            });
+        }
+    }
+}

osu.Game/Overlays/Mods/ModSelectColumn.cs

@@ -0,0 +1,177 @@
+// 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.Allocation;
+using osu.Framework.Bindables;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Colour;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Shapes;
+using osu.Framework.Localisation;
+using osu.Game.Graphics;
+using osu.Game.Graphics.Containers;
+using osuTK;
+using osuTK.Graphics;
+
+namespace osu.Game.Overlays.Mods
+{
+    public abstract class ModSelectColumn : CompositeDrawable, IHasAccentColour
+    {
+        public readonly Container TopLevelContent;
+
+        public LocalisableString HeaderText
+        {
+            set => createHeaderText(value);
+        }
+
+        public Color4 AccentColour
+        {
+            get => headerBackground.Colour;
+            set => headerBackground.Colour = value;
+        }
+
+        /// <summary>
+        /// Determines whether this column should accept user input.
+        /// </summary>
+        public readonly Bindable<bool> Active = new BindableBool(true);
+
+        protected override bool ReceivePositionalInputAtSubTree(Vector2 screenSpacePos) => base.ReceivePositionalInputAtSubTree(screenSpacePos) && Active.Value;
+
+        protected readonly Container ControlContainer;
+        protected readonly FillFlowContainer ItemsFlow;
+
+        private readonly TextFlowContainer headerText;
+        private readonly Box headerBackground;
+        private readonly Container contentContainer;
+        private readonly Box contentBackground;
+
+        private const float header_height = 42;
+
+        protected ModSelectColumn()
+        {
+            Width = 320;
+            RelativeSizeAxes = Axes.Y;
+            Shear = new Vector2(ShearedOverlayContainer.SHEAR, 0);
+
+            InternalChildren = new Drawable[]
+            {
+                TopLevelContent = new Container
+                {
+                    RelativeSizeAxes = Axes.Both,
+                    CornerRadius = ModSelectPanel.CORNER_RADIUS,
+                    Masking = true,
+                    Children = new Drawable[]
+                    {
+                        new Container
+                        {
+                            RelativeSizeAxes = Axes.X,
+                            Height = header_height + ModSelectPanel.CORNER_RADIUS,
+                            Children = new Drawable[]
+                            {
+                                headerBackground = new Box
+                                {
+                                    RelativeSizeAxes = Axes.X,
+                                    Height = header_height + ModSelectPanel.CORNER_RADIUS
+                                },
+                                headerText = new OsuTextFlowContainer(t =>
+                                {
+                                    t.Font = OsuFont.TorusAlternate.With(size: 17);
+                                    t.Shadow = false;
+                                    t.Colour = Colour4.Black;
+                                })
+                                {
+                                    RelativeSizeAxes = Axes.X,
+                                    AutoSizeAxes = Axes.Y,
+                                    Anchor = Anchor.CentreLeft,
+                                    Origin = Anchor.CentreLeft,
+                                    Shear = new Vector2(-ShearedOverlayContainer.SHEAR, 0),
+                                    Padding = new MarginPadding
+                                    {
+                                        Horizontal = 17,
+                                        Bottom = ModSelectPanel.CORNER_RADIUS
+                                    }
+                                }
+                            }
+                        },
+                        new Container
+                        {
+                            RelativeSizeAxes = Axes.Both,
+                            Padding = new MarginPadding { Top = header_height },
+                            Child = contentContainer = new Container
+                            {
+                                RelativeSizeAxes = Axes.Both,
+                                Masking = true,
+                                CornerRadius = ModSelectPanel.CORNER_RADIUS,
+                                BorderThickness = 3,
+                                Children = new Drawable[]
+                                {
+                                    contentBackground = new Box
+                                    {
+                                        RelativeSizeAxes = Axes.Both
+                                    },
+                                    new GridContainer
+                                    {
+                                        RelativeSizeAxes = Axes.Both,
+                                        RowDimensions = new[]
+                                        {
+                                            new Dimension(GridSizeMode.AutoSize),
+                                            new Dimension()
+                                        },
+                                        Content = new[]
+                                        {
+                                            new Drawable[]
+                                            {
+                                                ControlContainer = new Container
+                                                {
+                                                    RelativeSizeAxes = Axes.X,
+                                                    Padding = new MarginPadding { Horizontal = 14 }
+                                                }
+                                            },
+                                            new Drawable[]
+                                            {
+                                                new OsuScrollContainer(Direction.Vertical)
+                                                {
+                                                    RelativeSizeAxes = Axes.Both,
+                                                    ClampExtension = 100,
+                                                    ScrollbarOverlapsContent = false,
+                                                    Child = ItemsFlow = new FillFlowContainer
+                                                    {
+                                                        RelativeSizeAxes = Axes.X,
+                                                        AutoSizeAxes = Axes.Y,
+                                                        Spacing = new Vector2(0, 7),
+                                                        Padding = new MarginPadding(7)
+                                                    }
+                                                }
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            };
+        }
+
+        private void createHeaderText(LocalisableString text)
+        {
+            headerText.Clear();
+
+            int wordIndex = 0;
+
+            headerText.AddText(text, t =>
+            {
+                if (wordIndex == 0)
+                    t.Font = t.Font.With(weight: FontWeight.SemiBold);
+                wordIndex += 1;
+            });
+        }
+
+        [BackgroundDependencyLoader]
+        private void load(OverlayColourProvider colourProvider)
+        {
+            contentContainer.BorderColour = ColourInfo.GradientVertical(colourProvider.Background4, colourProvider.Background3);
+            contentBackground.Colour = colourProvider.Background4;
+        }
+    }
+}