Merge pull request #31802 from frenzibyte/carousel-v2-depth-ordering

Allow ordering certain carousel panels behind others

Author: peppy

osu.Game/Screens/SelectV2/BeatmapCarouselFilterGrouping.cs

@@ -66,7 +66,12 @@ public async Task<IEnumerable<CarouselItem>> Run(IEnumerable<CarouselItem> items
                         {
                             starGroup = (int)Math.Floor(b.StarRating);
                             var groupDefinition = new GroupDefinition($"{starGroup} - {++starGroup} *");
-                            var groupItem = new CarouselItem(groupDefinition) { DrawHeight = GroupPanel.HEIGHT };
+
+                            var groupItem = new CarouselItem(groupDefinition)
+                            {
+                                DrawHeight = GroupPanel.HEIGHT,
+                                DepthLayer = -2
+                            };
 
                             newItems.Add(groupItem);
                             groupItems[groupDefinition] = new HashSet<CarouselItem> { groupItem };
@@ -95,7 +100,12 @@ public async Task<IEnumerable<CarouselItem>> Run(IEnumerable<CarouselItem> items
 
                         if (newBeatmapSet)
                         {
-                            var setItem = new CarouselItem(beatmap.BeatmapSet!) { DrawHeight = BeatmapSetPanel.HEIGHT };
+                            var setItem = new CarouselItem(beatmap.BeatmapSet!)
+                            {
+                                DrawHeight = BeatmapSetPanel.HEIGHT,
+                                DepthLayer = -1
+                            };
+
                             setItems[beatmap.BeatmapSet!] = new HashSet<CarouselItem> { setItem };
                             newItems.Insert(i, setItem);
                             i++;

osu.Game/Screens/SelectV2/Carousel.cs

@@ -548,6 +548,8 @@ protected override void Update()
                 updateDisplayedRange(range);
             }
 
+            double selectedYPos = currentSelection.CarouselItem?.CarouselYPosition ?? 0;
+
             foreach (var panel in scroll.Panels)
             {
                 var c = (ICarouselPanel)panel;
@@ -556,8 +558,8 @@ protected override void Update()
                 if (c.Item == null)
                     continue;
 
-                double selectedYPos = currentSelection?.CarouselItem?.CarouselYPosition ?? 0;
-                scroll.Panels.ChangeChildDepth(panel, (float)Math.Abs(c.DrawYPosition - selectedYPos));
+                float normalisedDepth = (float)(Math.Abs(selectedYPos - c.DrawYPosition) / DrawHeight);
+                scroll.Panels.ChangeChildDepth(panel, c.Item.DepthLayer + normalisedDepth);
 
                 if (c.DrawYPosition != c.Item.CarouselYPosition)
                     c.DrawYPosition = Interpolation.DampContinuously(c.DrawYPosition, c.Item.CarouselYPosition, 50, Time.Elapsed);

osu.Game/Screens/SelectV2/CarouselItem.cs

@@ -29,6 +29,11 @@ public sealed class CarouselItem : IComparable<CarouselItem>
         /// </summary>
         public float DrawHeight { get; set; } = DEFAULT_HEIGHT;
 
+        /// <summary>
+        /// Defines the display depth relative to other <see cref="CarouselItem"/>s.
+        /// </summary>
+        public int DepthLayer { get; set; }
+
         /// <summary>
         /// Whether this item is visible or hidden.
         /// </summary>