Merge pull request #5036 from GSculerlor/difficulty-icon-tooltip

Add tooltips to difficulty icons with extra details

osu.Game/Beatmaps/Drawables/DifficultyIcon.cs

@@ -1,4 +1,4 @@
-// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// 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;
@@ -6,23 +6,25 @@ using osu.Framework.Allocation;
 using osu.Framework.Extensions.Color4Extensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Cursor;
 using osu.Framework.Graphics.Effects;
 using osu.Framework.Graphics.Shapes;
 using osu.Framework.Graphics.Sprites;
 using osu.Game.Graphics;
 using osu.Game.Graphics.Containers;
+using osu.Game.Graphics.Sprites;
 using osu.Game.Rulesets;
 using osuTK;
 using osuTK.Graphics;
 
 namespace osu.Game.Beatmaps.Drawables
 {
-    public class DifficultyIcon : Container
+    public class DifficultyIcon : Container, IHasCustomTooltip
     {
         private readonly BeatmapInfo beatmap;
         private readonly RulesetInfo ruleset;
 
-        public DifficultyIcon(BeatmapInfo beatmap, RulesetInfo ruleset = null)
+        public DifficultyIcon(BeatmapInfo beatmap, RulesetInfo ruleset = null, bool shouldShowTooltip = true)
         {
             if (beatmap == null)
                 throw new ArgumentNullException(nameof(beatmap));
@@ -30,10 +32,18 @@ namespace osu.Game.Beatmaps.Drawables
             this.beatmap = beatmap;
 
             this.ruleset = ruleset ?? beatmap.Ruleset;
+            if (shouldShowTooltip)
+                TooltipContent = beatmap;
 
             Size = new Vector2(20);
         }
 
+        public string TooltipText { get; set; }
+
+        public ITooltip GetCustomTooltip() => new DifficultyIconTooltip();
+
+        public object TooltipContent { get; set; }
+
         [BackgroundDependencyLoader]
         private void load(OsuColour colours)
         {
@@ -68,5 +78,105 @@ namespace osu.Game.Beatmaps.Drawables
                 }
             };
         }
+
+        private class DifficultyIconTooltip : VisibilityContainer, ITooltip
+        {
+            private readonly OsuSpriteText difficultyName, starRating;
+            private readonly Box background;
+
+            private readonly FillFlowContainer difficultyFlow;
+
+            public string TooltipText
+            {
+                set { }
+            }
+
+            public DifficultyIconTooltip()
+            {
+                AutoSizeAxes = Axes.Both;
+                Masking = true;
+                CornerRadius = 5;
+
+                Children = new Drawable[]
+                {
+                    background = new Box
+                    {
+                        RelativeSizeAxes = Axes.Both
+                    },
+                    new FillFlowContainer
+                    {
+                        AutoSizeAxes = Axes.Both,
+                        AutoSizeDuration = 200,
+                        AutoSizeEasing = Easing.OutQuint,
+                        Direction = FillDirection.Vertical,
+                        Padding = new MarginPadding(10),
+                        Children = new Drawable[]
+                        {
+                            difficultyName = new OsuSpriteText
+                            {
+                                Anchor = Anchor.Centre,
+                                Origin = Anchor.Centre,
+                                Font = OsuFont.GetFont(size: 16, weight: FontWeight.Bold),
+                            },
+                            difficultyFlow = new FillFlowContainer
+                            {
+                                AutoSizeAxes = Axes.Both,
+                                Anchor = Anchor.Centre,
+                                Origin = Anchor.Centre,
+                                Direction = FillDirection.Horizontal,
+                                Children = new Drawable[]
+                                {
+                                    starRating = new OsuSpriteText
+                                    {
+                                        Anchor = Anchor.Centre,
+                                        Origin = Anchor.Centre,
+                                        Font = OsuFont.GetFont(size: 16, weight: FontWeight.Regular),
+                                    },
+                                    new SpriteIcon
+                                    {
+                                        Anchor = Anchor.Centre,
+                                        Origin = Anchor.Centre,
+                                        Margin = new MarginPadding { Left = 4 },
+                                        Icon = FontAwesome.Solid.Star,
+                                        Size = new Vector2(12),
+                                    },
+                                }
+                            }
+                        }
+                    }
+                };
+            }
+
+            private OsuColour colours;
+
+            [BackgroundDependencyLoader]
+            private void load(OsuColour colours)
+            {
+                this.colours = colours;
+                background.Colour = colours.Gray3;
+            }
+
+            public bool SetContent(object content)
+            {
+                if (!(content is BeatmapInfo beatmap))
+                    return false;
+
+                difficultyName.Text = beatmap.Version;
+                starRating.Text = $"{beatmap.StarDifficulty:0.##}";
+                difficultyFlow.Colour = colours.ForDifficultyRating(beatmap.DifficultyRating);
+
+                return true;
+            }
+
+            public void Refresh()
+            {
+            }
+
+            public void Move(Vector2 pos) => Position = pos;
+
+            protected override void PopIn() => this.FadeIn(200, Easing.OutQuint);
+
+            protected override void PopOut() => this.FadeOut(200, Easing.OutQuint);
+        }
     }
 }

osu.Game/Overlays/BeatmapSet/BeatmapPicker.cs

@@ -234,7 +234,7 @@ namespace osu.Game.Overlays.BeatmapSet
                             Colour = Color4.Black.Opacity(0.5f),
                         },
                     },
-                    icon = new DifficultyIcon(beatmap)
+                    icon = new DifficultyIcon(beatmap, shouldShowTooltip: false)
                     {
                         Anchor = Anchor.Centre,
                         Origin = Anchor.Centre,

osu.Game/Screens/Select/Carousel/DrawableCarouselBeatmap.cs

@@ -82,7 +82,7 @@ namespace osu.Game.Screens.Select.Carousel
                     Origin = Anchor.CentreLeft,
                     Children = new Drawable[]
                     {
-                        new DifficultyIcon(beatmap)
+                        new DifficultyIcon(beatmap, shouldShowTooltip: false)
                         {
                             Scale = new Vector2(1.8f),
                         },