Add mania key area skinning

osu.Game.Rulesets.Mania.Tests/Skinning/TestSceneKeyArea.cs

@@ -0,0 +1,58 @@
+// 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 osu.Framework.Allocation;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Game.Rulesets.Mania.Skinning;
+using osu.Game.Rulesets.Mania.UI.Components;
+using osu.Game.Skinning;
+using osuTK;
+
+namespace osu.Game.Rulesets.Mania.Tests.Skinning
+{
+    public class TestSceneKeyArea : ManiaSkinnableTestScene
+    {
+        public override IReadOnlyList<Type> RequiredTypes => new[]
+        {
+            typeof(DefaultKeyArea),
+            typeof(LegacyKeyArea)
+        };
+
+        [BackgroundDependencyLoader]
+        private void load()
+        {
+            SetContents(() => new FillFlowContainer
+            {
+                Anchor = Anchor.Centre,
+                Origin = Anchor.Centre,
+                RelativeSizeAxes = Axes.Both,
+                Size = new Vector2(0.8f),
+                Direction = FillDirection.Horizontal,
+                Children = new Drawable[]
+                {
+                    new ColumnTestContainer(0, ManiaAction.Key1)
+                    {
+                        RelativeSizeAxes = Axes.Both,
+                        Width = 0.5f,
+                        Child = new SkinnableDrawable(new ManiaSkinComponent(ManiaSkinComponents.KeyArea), _ => new DefaultKeyArea())
+                        {
+                            RelativeSizeAxes = Axes.Both
+                        },
+                    },
+                    new ColumnTestContainer(1, ManiaAction.Key2)
+                    {
+                        RelativeSizeAxes = Axes.Both,
+                        Width = 0.5f,
+                        Child = new SkinnableDrawable(new ManiaSkinComponent(ManiaSkinComponents.KeyArea), _ => new DefaultKeyArea())
+                        {
+                            RelativeSizeAxes = Axes.Both
+                        },
+                    },
+                }
+            });
+        }
+    }
+}

osu.Game.Rulesets.Mania.Tests/TestSceneColumn.cs

@@ -28,7 +28,6 @@ namespace osu.Game.Rulesets.Mania.Tests
         {
             typeof(Column),
             typeof(ColumnBackground),
-            typeof(ColumnKeyArea),
             typeof(ColumnHitObjectArea)
         };
 

osu.Game.Rulesets.Mania/ManiaSkinComponent.cs

@@ -19,5 +19,6 @@ namespace osu.Game.Rulesets.Mania
 
     public enum ManiaSkinComponents
     {
+        KeyArea
     }
 }

osu.Game.Rulesets.Mania/Skinning/LegacyKeyArea.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.Allocation;
+using osu.Framework.Bindables;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Sprites;
+using osu.Framework.Input.Bindings;
+using osu.Game.Rulesets.Mania.UI;
+using osu.Game.Rulesets.UI.Scrolling;
+using osu.Game.Skinning;
+using osuTK;
+
+namespace osu.Game.Rulesets.Mania.Skinning
+{
+    public class LegacyKeyArea : CompositeDrawable, IKeyBindingHandler<ManiaAction>
+    {
+        private readonly IBindable<ScrollingDirection> direction = new Bindable<ScrollingDirection>();
+
+        private Container directionContainer;
+        private Sprite upSprite;
+        private Sprite downSprite;
+
+        [Resolved(CanBeNull = true)]
+        private ManiaStage stage { get; set; }
+
+        [Resolved]
+        private Column column { get; set; }
+
+        public LegacyKeyArea()
+        {
+            RelativeSizeAxes = Axes.Both;
+        }
+
+        [BackgroundDependencyLoader]
+        private void load(ISkinSource skin, IScrollingInfo scrollingInfo)
+        {
+            int fallbackColumn = column.Index % 2 + 1;
+
+            string upImage = skin.GetConfig<LegacyManiaSkinConfigurationLookup, string>(
+                                 new LegacyManiaSkinConfigurationLookup(stage?.Columns.Count ?? 4, LegacyManiaSkinConfigurationLookups.KeyImage, column.Index))?.Value
+                             ?? $"mania-key{fallbackColumn}";
+
+            string downImage = skin.GetConfig<LegacyManiaSkinConfigurationLookup, string>(
+                                   new LegacyManiaSkinConfigurationLookup(stage?.Columns.Count ?? 4, LegacyManiaSkinConfigurationLookups.KeyImageDown, column.Index))?.Value
+                               ?? $"mania-key{fallbackColumn}D";
+
+            InternalChild = directionContainer = new Container
+            {
+                RelativeSizeAxes = Axes.X,
+                AutoSizeAxes = Axes.Y,
+                Children = new Drawable[]
+                {
+                    upSprite = new Sprite
+                    {
+                        Origin = Anchor.BottomCentre,
+                        Texture = skin.GetTexture(upImage),
+                        RelativeSizeAxes = Axes.X,
+                        Width = 1
+                    },
+                    downSprite = new Sprite
+                    {
+                        Origin = Anchor.BottomCentre,
+                        Texture = skin.GetTexture(downImage),
+                        RelativeSizeAxes = Axes.X,
+                        Width = 1,
+                        Alpha = 0
+                    }
+                }
+            };
+
+            direction.BindTo(scrollingInfo.Direction);
+            direction.BindValueChanged(onDirectionChanged, true);
+        }
+
+        private void onDirectionChanged(ValueChangedEvent<ScrollingDirection> direction)
+        {
+            if (direction.NewValue == ScrollingDirection.Up)
+            {
+                directionContainer.Anchor = directionContainer.Origin = Anchor.TopCentre;
+                upSprite.Anchor = downSprite.Anchor = Anchor.TopCentre;
+                upSprite.Scale = downSprite.Scale = new Vector2(1, -1);
+            }
+            else
+            {
+                directionContainer.Anchor = directionContainer.Origin = Anchor.BottomCentre;
+                upSprite.Anchor = downSprite.Anchor = Anchor.BottomCentre;
+                upSprite.Scale = downSprite.Scale = Vector2.One;
+            }
+        }
+
+        public bool OnPressed(ManiaAction action)
+        {
+            if (action == column.Action.Value)
+            {
+                upSprite.FadeTo(0);
+                downSprite.FadeTo(1);
+            }
+
+            return false;
+        }
+
+        public void OnReleased(ManiaAction action)
+        {
+            if (action == column.Action.Value)
+            {
+                upSprite.FadeTo(1);
+                downSprite.FadeTo(0);
+            }
+        }
+    }
+}

osu.Game.Rulesets.Mania/Skinning/ManiaLegacySkinTransformer.cs

@@ -38,10 +38,16 @@ namespace osu.Game.Rulesets.Mania.Skinning
                 case GameplaySkinComponent<HitResult> resultComponent:
                     return getResult(resultComponent);
 
-                case ManiaSkinComponent _:
+                case ManiaSkinComponent maniaComponent:
                     if (!isLegacySkin.Value)
                         return null;
 
+                    switch (maniaComponent.Component)
+                    {
+                        case ManiaSkinComponents.KeyArea:
+                            return new LegacyKeyArea();
+                    }
+
                     break;
             }
 

osu.Game.Rulesets.Mania/UI/Column.cs

@@ -15,6 +15,7 @@ using osu.Game.Rulesets.Mania.Objects.Drawables;
 using osu.Game.Rulesets.Mania.Objects.Drawables.Pieces;
 using osu.Game.Rulesets.Mania.UI.Components;
 using osu.Game.Rulesets.UI.Scrolling;
+using osu.Game.Skinning;
 using osuTK;
 
 namespace osu.Game.Rulesets.Mania.UI
@@ -33,7 +34,6 @@ namespace osu.Game.Rulesets.Mania.UI
         public readonly Bindable<ManiaAction> Action = new Bindable<ManiaAction>();
 
         private readonly ColumnBackground background;
-        private readonly ColumnKeyArea keyArea;
         private readonly ColumnHitObjectArea hitObjectArea;
 
         internal readonly Container TopLevelContainer;
@@ -71,10 +71,9 @@ namespace osu.Game.Rulesets.Mania.UI
                         }
                     }
                 },
-                keyArea = new ColumnKeyArea
+                new SkinnableDrawable(new ManiaSkinComponent(ManiaSkinComponents.KeyArea), _ => new DefaultKeyArea())
                 {
-                    RelativeSizeAxes = Axes.X,
+                    RelativeSizeAxes = Axes.Both
-                    Height = ManiaStage.HIT_TARGET_POSITION,
                 },
                 background,
                 TopLevelContainer = new Container { RelativeSizeAxes = Axes.Both }
@@ -95,8 +94,6 @@ namespace osu.Game.Rulesets.Mania.UI
                     Top = dir.NewValue == ScrollingDirection.Up ? NotePiece.NOTE_HEIGHT / 2 : 0,
                     Bottom = dir.NewValue == ScrollingDirection.Down ? NotePiece.NOTE_HEIGHT / 2 : 0
                 };
-
-                keyArea.Anchor = keyArea.Origin = dir.NewValue == ScrollingDirection.Up ? Anchor.TopLeft : Anchor.BottomLeft;
             }, true);
         }
 
@@ -131,7 +128,6 @@ namespace osu.Game.Rulesets.Mania.UI
                 accentColour = value;
 
                 background.AccentColour = value;
-                keyArea.AccentColour = value;
                 hitObjectArea.AccentColour = value;
             }
         }

osu.Game.Rulesets.Mania/UI/Components/ColumnKeyArea.cs

@@ -1,124 +0,0 @@
-// 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.Extensions.Color4Extensions;
-using osu.Framework.Graphics;
-using osu.Framework.Graphics.Colour;
-using osu.Framework.Graphics.Containers;
-using osu.Framework.Graphics.Effects;
-using osu.Framework.Graphics.Shapes;
-using osu.Framework.Input.Bindings;
-using osu.Game.Graphics;
-using osu.Game.Rulesets.UI.Scrolling;
-using osuTK;
-using osuTK.Graphics;
-
-namespace osu.Game.Rulesets.Mania.UI.Components
-{
-    public class ColumnKeyArea : CompositeDrawable, IKeyBindingHandler<ManiaAction>, IHasAccentColour
-    {
-        private const float key_icon_size = 10;
-        private const float key_icon_corner_radius = 3;
-
-        private readonly IBindable<ManiaAction> action = new Bindable<ManiaAction>();
-        private readonly IBindable<ScrollingDirection> direction = new Bindable<ScrollingDirection>();
-
-        private Container keyIcon;
-
-        [BackgroundDependencyLoader]
-        private void load(IBindable<ManiaAction> action, IScrollingInfo scrollingInfo)
-        {
-            this.action.BindTo(action);
-
-            Drawable gradient;
-
-            InternalChildren = new[]
-            {
-                gradient = new Box
-                {
-                    Name = "Key gradient",
-                    RelativeSizeAxes = Axes.Both,
-                    Alpha = 0.5f
-                },
-                keyIcon = new Container
-                {
-                    Name = "Key icon",
-                    Anchor = Anchor.Centre,
-                    Origin = Anchor.Centre,
-                    Size = new Vector2(key_icon_size),
-                    Masking = true,
-                    CornerRadius = key_icon_corner_radius,
-                    BorderThickness = 2,
-                    BorderColour = Color4.White, // Not true
-                    Children = new[]
-                    {
-                        new Box
-                        {
-                            RelativeSizeAxes = Axes.Both,
-                            Alpha = 0,
-                            AlwaysPresent = true
-                        }
-                    }
-                }
-            };
-
-            direction.BindTo(scrollingInfo.Direction);
-            direction.BindValueChanged(dir =>
-            {
-                gradient.Colour = ColourInfo.GradientVertical(
-                    dir.NewValue == ScrollingDirection.Up ? Color4.Black : Color4.Black.Opacity(0),
-                    dir.NewValue == ScrollingDirection.Up ? Color4.Black.Opacity(0) : Color4.Black);
-            }, true);
-        }
-
-        protected override void LoadComplete()
-        {
-            base.LoadComplete();
-            updateColours();
-        }
-
-        private Color4 accentColour;
-
-        public Color4 AccentColour
-        {
-            get => accentColour;
-            set
-            {
-                if (accentColour == value)
-                    return;
-
-                accentColour = value;
-
-                updateColours();
-            }
-        }
-
-        private void updateColours()
-        {
-            if (!IsLoaded)
-                return;
-
-            keyIcon.EdgeEffect = new EdgeEffectParameters
-            {
-                Type = EdgeEffectType.Glow,
-                Radius = 5,
-                Colour = accentColour.Opacity(0.5f),
-            };
-        }
-
-        public bool OnPressed(ManiaAction action)
-        {
-            if (action == this.action.Value)
-                keyIcon.ScaleTo(1.4f, 50, Easing.OutQuint).Then().ScaleTo(1.3f, 250, Easing.OutQuint);
-            return false;
-        }
-
-        public void OnReleased(ManiaAction action)
-        {
-            if (action == this.action.Value)
-                keyIcon.ScaleTo(1f, 125, Easing.OutQuint);
-        }
-    }
-}

osu.Game.Rulesets.Mania/UI/Components/DefaultKeyArea.cs

@@ -0,0 +1,114 @@
+// 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.Extensions.Color4Extensions;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Colour;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Effects;
+using osu.Framework.Graphics.Shapes;
+using osu.Framework.Input.Bindings;
+using osu.Game.Rulesets.UI.Scrolling;
+using osuTK;
+using osuTK.Graphics;
+
+namespace osu.Game.Rulesets.Mania.UI.Components
+{
+    public class DefaultKeyArea : CompositeDrawable, IKeyBindingHandler<ManiaAction>
+    {
+        private const float key_icon_size = 10;
+        private const float key_icon_corner_radius = 3;
+
+        private readonly IBindable<ScrollingDirection> direction = new Bindable<ScrollingDirection>();
+
+        private Container directionContainer;
+        private Container keyIcon;
+        private Drawable gradient;
+
+        [Resolved]
+        private Column column { get; set; }
+
+        public DefaultKeyArea()
+        {
+            RelativeSizeAxes = Axes.Both;
+        }
+
+        [BackgroundDependencyLoader]
+        private void load(IScrollingInfo scrollingInfo)
+        {
+            InternalChild = directionContainer = new Container
+            {
+                RelativeSizeAxes = Axes.X,
+                Height = ManiaStage.HIT_TARGET_POSITION,
+                Children = new[]
+                {
+                    gradient = new Box
+                    {
+                        Name = "Key gradient",
+                        RelativeSizeAxes = Axes.Both,
+                        Alpha = 0.5f
+                    },
+                    keyIcon = new Container
+                    {
+                        Name = "Key icon",
+                        Anchor = Anchor.Centre,
+                        Origin = Anchor.Centre,
+                        Size = new Vector2(key_icon_size),
+                        Masking = true,
+                        CornerRadius = key_icon_corner_radius,
+                        BorderThickness = 2,
+                        BorderColour = Color4.White, // Not true
+                        Children = new[]
+                        {
+                            new Box
+                            {
+                                RelativeSizeAxes = Axes.Both,
+                                Alpha = 0,
+                                AlwaysPresent = true
+                            }
+                        }
+                    }
+                }
+            };
+
+            keyIcon.EdgeEffect = new EdgeEffectParameters
+            {
+                Type = EdgeEffectType.Glow,
+                Radius = 5,
+                Colour = column.AccentColour.Opacity(0.5f),
+            };
+
+            direction.BindTo(scrollingInfo.Direction);
+            direction.BindValueChanged(onDirectionChanged, true);
+        }
+
+        private void onDirectionChanged(ValueChangedEvent<ScrollingDirection> direction)
+        {
+            if (direction.NewValue == ScrollingDirection.Up)
+            {
+                directionContainer.Anchor = directionContainer.Origin = Anchor.TopLeft;
+                gradient.Colour = ColourInfo.GradientVertical(Color4.Black, Color4.Black.Opacity(0));
+            }
+            else
+            {
+                directionContainer.Anchor = directionContainer.Origin = Anchor.BottomLeft;
+                gradient.Colour = ColourInfo.GradientVertical(Color4.Black.Opacity(0), Color4.Black);
+            }
+        }
+
+        public bool OnPressed(ManiaAction action)
+        {
+            if (action == column.Action.Value)
+                keyIcon.ScaleTo(1.4f, 50, Easing.OutQuint).Then().ScaleTo(1.3f, 250, Easing.OutQuint);
+            return false;
+        }
+
+        public void OnReleased(ManiaAction action)
+        {
+            if (action == column.Action.Value)
+                keyIcon.ScaleTo(1f, 125, Easing.OutQuint);
+        }
+    }
+}

osu.Game/Skinning/LegacyManiaSkinConfigurationLookup.cs

@@ -19,5 +19,7 @@ namespace osu.Game.Skinning
 
     public enum LegacyManiaSkinConfigurationLookups
     {
+        KeyImage,
+        KeyImageDown
     }
 }