Rewrite a lot of ManiaPlayfield/Column to support left/right special styles and arbitrary number of columns.

osu.Desktop.VisualTests/Tests/TestCaseManiaPlayfield.cs

@@ -20,7 +20,7 @@ namespace osu.Desktop.VisualTests.Tests
         {
             base.Reset();
 
-            const int max_columns = 9;
+            const int max_columns = 10;
 
             for (int i = 1; i <= max_columns; i++)
             {
@@ -38,6 +38,8 @@ namespace osu.Desktop.VisualTests.Tests
 
                 AddStep("Trigger keys down", () => ((ManiaPlayfield)Children.First()).Columns.Children.ForEach(triggerKeyDown));
                 AddStep("Trigger keys up", () => ((ManiaPlayfield)Children.First()).Columns.Children.ForEach(triggerKeyUp));
+                AddStep("Left special style", () => ((ManiaPlayfield)Children.First()).SpecialColumnStyle = SpecialColumnStyle.Left);
+                AddStep("Right special style", () => ((ManiaPlayfield)Children.First()).SpecialColumnStyle = SpecialColumnStyle.Right);
             }
         }
 

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

@@ -29,31 +29,6 @@ namespace osu.Game.Rulesets.Mania.UI
         private const float column_width = 45;
         private const float special_column_width = 70;
 
-        private Color4 accentColour;
-        public Color4 AccentColour
-        {
-            get { return accentColour; }
-            set
-            {
-                if (accentColour == value)
-                    return;
-                accentColour = value;
-
-                setAccentColour();
-            }
-        }
-
-        private bool isSpecialColumn;
-        public bool IsSpecialColumn
-        {
-            get { return isSpecialColumn; }
-            set
-            {
-                isSpecialColumn = value;
-                Width = isSpecialColumn ? special_column_width : column_width;
-            }
-        }
-
         public Key Key;
 
         private readonly Box background;
@@ -159,23 +134,46 @@ namespace osu.Game.Rulesets.Mania.UI
             };
         }
 
-        private void setAccentColour()
+        private bool isSpecial;
+        public bool IsSpecial
         {
-            background.Colour = AccentColour;
+            get { return isSpecial; }
-
+            set
-            hitTargetBar.EdgeEffect = new EdgeEffect
             {
-                Type = EdgeEffectType.Glow,
+                if (isSpecial == value)
-                Radius = 5,
+                    return;
-                Colour = AccentColour.Opacity(0.5f),
+                isSpecial = value;
-            };
 
-            keyIcon.EdgeEffect = new EdgeEffect
+                Width = isSpecial ? special_column_width : column_width;
+            }
+        }
+
+        private Color4 accentColour;
+        public Color4 AccentColour
+        {
+            get { return accentColour; }
+            set
             {
-                Type = EdgeEffectType.Glow,
+                if (accentColour == value)
-                Radius = 5,
+                    return;
-                Colour = AccentColour.Opacity(0.5f),
+                accentColour = value;
-            };
+
+                background.Colour = accentColour;
+
+                hitTargetBar.EdgeEffect = new EdgeEffect
+                {
+                    Type = EdgeEffectType.Glow,
+                    Radius = 5,
+                    Colour = accentColour.Opacity(0.5f),
+                };
+
+                keyIcon.EdgeEffect = new EdgeEffect
+                {
+                    Type = EdgeEffectType.Glow,
+                    Radius = 5,
+                    Colour = accentColour.Opacity(0.5f),
+                };
+            }
         }
 
         protected override bool OnKeyDown(InputState state, KeyDownEventArgs args)

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

@@ -15,18 +15,50 @@ using osu.Game.Graphics;
 using osu.Framework.Allocation;
 using OpenTK.Input;
 using System.Linq;
+using System.Collections.Generic;
 
 namespace osu.Game.Rulesets.Mania.UI
 {
     public class ManiaPlayfield : Playfield<ManiaBaseHit, ManiaJudgement>
     {
+        /// <summary>
+        /// Default column keys, expanding outwards from the middle as more column are added.
+        /// E.g. 2 columns use FJ, 4 columns use DFJK, 6 use SDFJKL, etc...
+        /// </summary>
+        private static readonly Key[] default_keys = new[] { Key.A, Key.S, Key.D, Key.F, Key.J, Key.K, Key.L, Key.Semicolon };
+
+        private SpecialColumnStyle specialColumnStyle;
+        /// <summary>
+        /// The style to use for the special column.
+        /// </summary>
+        public SpecialColumnStyle SpecialColumnStyle
+        {
+            get { return specialColumnStyle; }
+            set
+            {
+                if (specialColumnStyle == value)
+                    return;
+                specialColumnStyle = value;
+
+                if (!IsLoaded)
+                    return;
+
+                updateColumnStyle();
+            }
+        }
+
         public readonly FlowContainer<Column> Columns;
 
-        public ManiaPlayfield(int columns)
+        private List<Color4> normalColumnColours = new List<Color4>();
+        private Color4 specialColumnColour;
+
+        private readonly int columnCount;
+
+        public ManiaPlayfield(int columnCount)
         {
-            if (columns > 9)
+            this.columnCount = columnCount;
-                throw new ArgumentException($"{columns} columns is not supported.");
+
-            if (columns <= 0)
+            if (columnCount <= 0)
                 throw new ArgumentException("Can't have zero or fewer columns.");
 
             Children = new Drawable[]
@@ -56,43 +88,81 @@ namespace osu.Game.Rulesets.Mania.UI
                 }
             };
 
-            for (int i = 0; i < columns; i++)
+            for (int i = 0; i < columnCount; i++)
                 Columns.Add(new Column());
         }
 
         [BackgroundDependencyLoader]
         private void load(OsuColour colours)
         {
-            var columnColours = new[]
+            normalColumnColours = new List<Color4>
             {
                 colours.RedDark,
-                colours.GreenDark,
+                colours.GreenDark
-                colours.BlueDark // Special column
             };
 
-            int columnCount = Columns.Children.Count();
+            specialColumnColour = colours.BlueDark;
-            int halfColumns = columnCount / 2;
 
-            var keys = new[] { Key.A, Key.S, Key.D, Key.F, Key.Space, Key.J, Key.K, Key.L, Key.Semicolon };
+            updateColumnStyle();
+        }
 
-            for (int i = 0; i < halfColumns; i++)
+        /// <summary>
+        /// Updates the column style (special style/colours) + keys.
+        /// </summary>
+        private void updateColumnStyle()
+        {
+            // Set the special column + colour + key
+            for (int i = 0; i < columnCount; i++)
             {
-                Column leftColumn = Columns.Children.ElementAt(i);
+                Column column = Columns.Children.ElementAt(i);
-                Column rightColumn = Columns.Children.ElementAt(columnCount - 1 - i);
+                column.IsSpecial = isSpecialColumn(i);
 
-                Color4 accent = columnColours[i % 2];
+                if (!column.IsSpecial)
-                leftColumn.AccentColour = rightColumn.AccentColour = accent;
+                    continue;
-                leftColumn.Key = keys[keys.Length / 2 - halfColumns + i];
+
-                rightColumn.Key = keys[keys.Length / 2 + halfColumns - i];
+                column.Key = Key.Space;
+                column.AccentColour = specialColumnColour;
             }
 
-            bool hasSpecial = halfColumns * 2 < columnCount;
+            var nonSpecialColumns = Columns.Children.Where(c => !c.IsSpecial).ToList();
-            if (hasSpecial)
+
+            // We'll set the colours of the non-special columns in a separate loop, because the non-special
+            // column colours are mirrored across their centre and special styles mess with this
+            for (int i = 0; i < Math.Ceiling(nonSpecialColumns.Count / 2f); i++)
             {
-                Column specialColumn = Columns.Children.ElementAt(halfColumns);
+                Color4 colour = normalColumnColours[i % normalColumnColours.Count];
-                specialColumn.IsSpecialColumn = true;
+                nonSpecialColumns[i].AccentColour = colour;
-                specialColumn.AccentColour = columnColours[2];
+                nonSpecialColumns[nonSpecialColumns.Count - 1 - i].AccentColour = colour;
-                specialColumn.Key = keys[keys.Length / 2];
+            }
+
+            // We'll set the keys for non-special columns in another separate loop because it's not mirrored like the above colours
+            // Todo: This needs to go when we get to bindings and use Button1, ..., ButtonN instead
+            for (int i = 0; i < nonSpecialColumns.Count; i++)
+            {
+                Column column = nonSpecialColumns[i];
+
+                int keyOffset = default_keys.Length / 2 - nonSpecialColumns.Count / 2 + i;
+                if (keyOffset >= 0 && keyOffset < default_keys.Length)
+                    column.Key = default_keys[keyOffset];
+            }
+        }
+
+        /// <summary>
+        /// Whether the column index is a special column for this playfield.
+        /// </summary>
+        /// <param name="column">The 0-based column index.</param>
+        /// <returns>Whether the column is a special column.</returns>
+        private bool isSpecialColumn(int column)
+        {
+            switch (SpecialColumnStyle)
+            {
+                default:
+                case SpecialColumnStyle.Normal:
+                    return columnCount % 2 == 1 && column == columnCount / 2;
+                case SpecialColumnStyle.Left:
+                    return column == 0;
+                case SpecialColumnStyle.Right:
+                    return column == columnCount - 1;
             }
         }
     }

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

@@ -0,0 +1,21 @@
+// Copyright (c) 2007-2017 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+namespace osu.Game.Rulesets.Mania.UI
+{
+    public enum SpecialColumnStyle
+    {
+        /// <summary>
+        /// The special column will lie in the center of the columns.
+        /// </summary>
+        Normal,
+        /// <summary>
+        /// The special column will lie to the left of the columns.
+        /// </summary>
+        Left,
+        /// <summary>
+        /// The special column will lie to the right of the columns.
+        /// </summary>
+        Right
+    }
+}

osu.Game.Rulesets.Mania/osu.Game.Rulesets.Mania.csproj

@@ -61,6 +61,7 @@
     <Compile Include="UI\ManiaPlayfield.cs" />
     <Compile Include="ManiaRuleset.cs" />
     <Compile Include="Mods\ManiaMod.cs" />
+    <Compile Include="UI\SpecialColumnStyle.cs" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\osu-framework\osu.Framework\osu.Framework.csproj">