Merge pull request #12747 from frenzibyte/current-star-rating

Allow changing current star difficulty of a `StarRatingDisplay`

osu.Game.Tests/Visual/Ranking/TestSceneStarRatingDisplay.cs

@@ -1,32 +1,65 @@
 // 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.Linq;
+using NUnit.Framework;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
+using osu.Framework.Utils;
 using osu.Game.Beatmaps;
 using osu.Game.Screens.Ranking.Expanded;
+using osuTK;
 
 namespace osu.Game.Tests.Visual.Ranking
 {
     public class TestSceneStarRatingDisplay : OsuTestScene
     {
-        public TestSceneStarRatingDisplay()
+        [Test]
+        public void TestDisplay()
         {
-            Child = new FillFlowContainer
+            AddStep("load displays", () => Child = new FillFlowContainer
             {
                 Anchor = Anchor.Centre,
                 Origin = Anchor.Centre,
-                Children = new Drawable[]
+                ChildrenEnumerable = new[]
                 {
-                    new StarRatingDisplay(new StarDifficulty(1.23, 0)),
+                    1.23,
-                    new StarRatingDisplay(new StarDifficulty(2.34, 0)),
+                    2.34,
-                    new StarRatingDisplay(new StarDifficulty(3.45, 0)),
+                    3.45,
-                    new StarRatingDisplay(new StarDifficulty(4.56, 0)),
+                    4.56,
-                    new StarRatingDisplay(new StarDifficulty(5.67, 0)),
+                    5.67,
-                    new StarRatingDisplay(new StarDifficulty(6.78, 0)),
+                    6.78,
-                    new StarRatingDisplay(new StarDifficulty(10.11, 0)),
+                    10.11,
-                }
+                }.Select(starRating => new StarRatingDisplay(new StarDifficulty(starRating, 0))
-            };
+                {
+                    Anchor = Anchor.Centre,
+                    Origin = Anchor.Centre
+                })
+            });
+        }
+
+        [Test]
+        public void TestChangingStarRatingDisplay()
+        {
+            StarRatingDisplay starRating = null;
+
+            AddStep("load display", () => Child = starRating = new StarRatingDisplay(new StarDifficulty(5.55, 1))
+            {
+                Anchor = Anchor.Centre,
+                Origin = Anchor.Centre,
+                Scale = new Vector2(3f),
+            });
+
+            AddRepeatStep("set random value", () =>
+            {
+                starRating.Current.Value = new StarDifficulty(RNG.NextDouble(0.0, 11.0), 1);
+            }, 10);
+
+            AddSliderStep("set exact stars", 0.0, 11.0, 5.55, d =>
+            {
+                if (starRating != null)
+                    starRating.Current.Value = new StarDifficulty(d, 1);
+            });
         }
     }
 }

osu.Game/Screens/Ranking/Expanded/StarRatingDisplay.cs

@@ -3,12 +3,14 @@
 
 using System.Globalization;
 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.Graphics.UserInterface;
 using osu.Game.Beatmaps;
 using osu.Game.Graphics;
 using osu.Game.Graphics.Containers;
@@ -20,9 +22,21 @@ namespace osu.Game.Screens.Ranking.Expanded
     /// <summary>
     /// A pill that displays the star rating of a <see cref="BeatmapInfo"/>.
     /// </summary>
-    public class StarRatingDisplay : CompositeDrawable
+    public class StarRatingDisplay : CompositeDrawable, IHasCurrentValue<StarDifficulty>
     {
-        private readonly StarDifficulty difficulty;
+        private Box background;
+        private OsuTextFlowContainer textFlow;
+
+        [Resolved]
+        private OsuColour colours { get; set; }
+
+        private readonly BindableWithCurrent<StarDifficulty> current = new BindableWithCurrent<StarDifficulty>();
+
+        public Bindable<StarDifficulty> Current
+        {
+            get => current.Current;
+            set => current.Current = value;
+        }
 
         /// <summary>
         /// Creates a new <see cref="StarRatingDisplay"/> using an already computed <see cref="StarDifficulty"/>.
@@ -30,7 +44,7 @@ namespace osu.Game.Screens.Ranking.Expanded
         /// <param name="starDifficulty">The already computed <see cref="StarDifficulty"/> to display the star difficulty of.</param>
         public StarRatingDisplay(StarDifficulty starDifficulty)
         {
-            difficulty = starDifficulty;
+            Current.Value = starDifficulty;
         }
 
         [BackgroundDependencyLoader]
@@ -38,15 +52,6 @@ namespace osu.Game.Screens.Ranking.Expanded
         {
             AutoSizeAxes = Axes.Both;
 
-            var starRatingParts = difficulty.Stars.ToString("0.00", CultureInfo.InvariantCulture).Split('.');
-            string wholePart = starRatingParts[0];
-            string fractionPart = starRatingParts[1];
-            string separator = CultureInfo.CurrentCulture.NumberFormat.NumberDecimalSeparator;
-
-            ColourInfo backgroundColour = difficulty.DifficultyRating == DifficultyRating.ExpertPlus
-                ? ColourInfo.GradientVertical(Color4Extensions.FromHex("#C1C1C1"), Color4Extensions.FromHex("#595959"))
-                : (ColourInfo)colours.ForDifficultyRating(difficulty.DifficultyRating);
-
             InternalChildren = new Drawable[]
             {
                 new CircularContainer
@@ -55,10 +60,9 @@ namespace osu.Game.Screens.Ranking.Expanded
                     Masking = true,
                     Children = new Drawable[]
                     {
-                        new Box
+                        background = new Box
                         {
                             RelativeSizeAxes = Axes.Both,
-                            Colour = backgroundColour
                         },
                     }
                 },
@@ -78,32 +82,54 @@ namespace osu.Game.Screens.Ranking.Expanded
                             Icon = FontAwesome.Solid.Star,
                             Colour = Color4.Black
                         },
-                        new OsuTextFlowContainer(s => s.Font = OsuFont.Numeric.With(weight: FontWeight.Black))
+                        textFlow = new OsuTextFlowContainer(s => s.Font = OsuFont.Numeric.With(weight: FontWeight.Black))
                         {
                             Anchor = Anchor.CentreLeft,
                             Origin = Anchor.CentreLeft,
                             AutoSizeAxes = Axes.Both,
                             Direction = FillDirection.Horizontal,
                             TextAnchor = Anchor.BottomLeft,
-                        }.With(t =>
+                        }
-                        {
-                            t.AddText($"{wholePart}", s =>
-                            {
-                                s.Colour = Color4.Black;
-                                s.Font = s.Font.With(size: 14);
-                                s.UseFullGlyphHeight = false;
-                            });
-
-                            t.AddText($"{separator}{fractionPart}", s =>
-                            {
-                                s.Colour = Color4.Black;
-                                s.Font = s.Font.With(size: 7);
-                                s.UseFullGlyphHeight = false;
-                            });
-                        })
                     }
                 }
             };
         }
+
+        protected override void LoadComplete()
+        {
+            base.LoadComplete();
+
+            Current.BindValueChanged(_ => updateDisplay(), true);
+        }
+
+        private void updateDisplay()
+        {
+            var starRatingParts = Current.Value.Stars.ToString("0.00", CultureInfo.InvariantCulture).Split('.');
+            string wholePart = starRatingParts[0];
+            string fractionPart = starRatingParts[1];
+            string separator = CultureInfo.CurrentCulture.NumberFormat.NumberDecimalSeparator;
+
+            var rating = Current.Value.DifficultyRating;
+
+            background.Colour = rating == DifficultyRating.ExpertPlus
+                ? ColourInfo.GradientVertical(Color4Extensions.FromHex("#C1C1C1"), Color4Extensions.FromHex("#595959"))
+                : (ColourInfo)colours.ForDifficultyRating(rating);
+
+            textFlow.Clear();
+
+            textFlow.AddText($"{wholePart}", s =>
+            {
+                s.Colour = Color4.Black;
+                s.Font = s.Font.With(size: 14);
+                s.UseFullGlyphHeight = false;
+            });
+
+            textFlow.AddText($"{separator}{fractionPart}", s =>
+            {
+                s.Colour = Color4.Black;
+                s.Font = s.Font.With(size: 7);
+                s.UseFullGlyphHeight = false;
+            });
+        }
     }
 }