Add basic component structure for skinnable health displays

osu.Game.Tests/Visual/Gameplay/TestSceneSkinnableHealthDisplay.cs

@@ -0,0 +1,62 @@
+// 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.Collections.Generic;
+using System.Linq;
+using NUnit.Framework;
+using osu.Framework.Testing;
+using osu.Game.Rulesets;
+using osu.Game.Rulesets.Judgements;
+using osu.Game.Rulesets.Osu;
+using osu.Game.Rulesets.Osu.Judgements;
+using osu.Game.Screens.Play;
+using osuTK;
+
+namespace osu.Game.Tests.Visual.Gameplay
+{
+    public class TestSceneSkinnableHealthDisplay : SkinnableTestScene
+    {
+        private IEnumerable<SkinnableHealthDisplay> healthDisplays => CreatedDrawables.OfType<SkinnableHealthDisplay>();
+
+        protected override Ruleset CreateRulesetForSkinProvider() => new OsuRuleset();
+
+        [SetUpSteps]
+        public void SetUpSteps()
+        {
+            AddStep("Create health displays", () =>
+            {
+                SetContents(() => new SkinnableHealthDisplay());
+            });
+            AddStep(@"Reset all", delegate
+            {
+                foreach (var s in healthDisplays)
+                    s.Current.Value = 1;
+            });
+        }
+
+        [Test]
+        public void TestHealthDisplayIncrementing()
+        {
+            AddRepeatStep(@"decrease hp", delegate
+            {
+                foreach (var healthDisplay in healthDisplays)
+                    healthDisplay.Current.Value -= 0.08f;
+            }, 10);
+
+            AddRepeatStep(@"increase hp without flash", delegate
+            {
+                foreach (var healthDisplay in healthDisplays)
+                    healthDisplay.Current.Value += 0.1f;
+            }, 3);
+
+            AddRepeatStep(@"increase hp with flash", delegate
+            {
+                foreach (var healthDisplay in healthDisplays)
+                {
+                    healthDisplay.Current.Value += 0.1f;
+                    healthDisplay.Flash(new JudgementResult(null, new OsuJudgement()));
+                }
+            }, 3);
+        }
+    }
+}

osu.Game/Screens/Play/HUD/DefaultHealthDisplay.cs

@@ -16,7 +16,7 @@ using osu.Framework.Utils;
 
 namespace osu.Game.Screens.Play.HUD
 {
-    public class StandardHealthDisplay : HealthDisplay, IHasAccentColour
+    public class DefaultHealthDisplay : HealthDisplay, IHasAccentColour
     {
         /// <summary>
         /// The base opacity of the glow.
@@ -71,8 +71,12 @@ namespace osu.Game.Screens.Play.HUD
             }
         }
 
-        public StandardHealthDisplay()
+        public DefaultHealthDisplay()
         {
+            Size = new Vector2(1, 5);
+            RelativeSizeAxes = Axes.X;
+            Margin = new MarginPadding { Top = 20 };
+
             Children = new Drawable[]
             {
                 new Box
@@ -103,7 +107,7 @@ namespace osu.Game.Screens.Play.HUD
             GlowColour = colours.BlueDarker;
         }
 
-        public void Flash(JudgementResult result)
+        public override void Flash(JudgementResult result)
         {
             if (!result.IsHit)
                 return;

osu.Game/Screens/Play/HUD/HealthDisplay.cs

@@ -3,6 +3,7 @@
 
 using osu.Framework.Bindables;
 using osu.Framework.Graphics.Containers;
+using osu.Game.Rulesets.Judgements;
 using osu.Game.Rulesets.Scoring;
 using osu.Game.Rulesets.UI;
 
@@ -12,14 +13,18 @@ namespace osu.Game.Screens.Play.HUD
     /// A container for components displaying the current player health.
     /// Gets bound automatically to the <see cref="HealthProcessor"/> when inserted to <see cref="DrawableRuleset.Overlays"/> hierarchy.
     /// </summary>
-    public abstract class HealthDisplay : Container
+    public abstract class HealthDisplay : Container, IHealthDisplay
     {
-        public readonly BindableDouble Current = new BindableDouble(1)
+        public Bindable<double> Current { get; } = new BindableDouble(1)
         {
             MinValue = 0,
             MaxValue = 1
         };
 
+        public virtual void Flash(JudgementResult result)
+        {
+        }
+
         /// <summary>
         /// Bind the tracked fields of <see cref="HealthProcessor"/> to this health display.
         /// </summary>

osu.Game/Screens/Play/HUD/IHealthDisplay.cs

@@ -0,0 +1,26 @@
+// 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.Bindables;
+using osu.Framework.Graphics;
+using osu.Game.Rulesets.Judgements;
+
+namespace osu.Game.Screens.Play.HUD
+{
+    /// <summary>
+    /// An interface providing a set of methods to update a health display.
+    /// </summary>
+    public interface IHealthDisplay : IDrawable
+    {
+        /// <summary>
+        /// The current health to be displayed.
+        /// </summary>
+        Bindable<double> Current { get; }
+
+        /// <summary>
+        /// Flash the display for a specified result type.
+        /// </summary>
+        /// <param name="result">The result type.</param>
+        void Flash(JudgementResult result);
+    }
+}

osu.Game/Screens/Play/HUDOverlay.cs

@@ -33,7 +33,7 @@ namespace osu.Game.Screens.Play
         public readonly SkinnableComboCounter ComboCounter;
         public readonly SkinnableScoreCounter ScoreCounter;
         public readonly SkinnableAccuracyCounter AccuracyCounter;
-        public readonly HealthDisplay HealthDisplay;
+        public readonly SkinnableHealthDisplay HealthDisplay;
         public readonly SongProgress Progress;
         public readonly ModDisplay ModDisplay;
         public readonly HitErrorDisplay HitErrorDisplay;
@@ -272,12 +272,7 @@ namespace osu.Game.Screens.Play
 
         protected virtual SkinnableComboCounter CreateComboCounter() => new SkinnableComboCounter();
 
-        protected virtual HealthDisplay CreateHealthDisplay() => new StandardHealthDisplay
+        protected virtual SkinnableHealthDisplay CreateHealthDisplay() => new SkinnableHealthDisplay();
-        {
-            Size = new Vector2(1, 5),
-            RelativeSizeAxes = Axes.X,
-            Margin = new MarginPadding { Top = 20 }
-        };
 
         protected virtual FailingLayer CreateFailingLayer() => new FailingLayer
         {
@@ -320,7 +315,7 @@ namespace osu.Game.Screens.Play
             AccuracyCounter?.Current.BindTo(processor.Accuracy);
             ComboCounter?.Current.BindTo(processor.Combo);
 
-            if (HealthDisplay is StandardHealthDisplay shd)
+            if (HealthDisplay.Drawable is IHealthDisplay shd)
                 processor.NewJudgement += shd.Flash;
         }
 

osu.Game/Screens/Play/SkinnableHealthDisplay.cs

@@ -0,0 +1,47 @@
+// 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 osu.Framework.Bindables;
+using osu.Game.Rulesets.Judgements;
+using osu.Game.Rulesets.Scoring;
+using osu.Game.Screens.Play.HUD;
+using osu.Game.Skinning;
+
+namespace osu.Game.Screens.Play
+{
+    public class SkinnableHealthDisplay : SkinnableDrawable, IHealthDisplay
+    {
+        public Bindable<double> Current { get; } = new Bindable<double>();
+
+        public void Flash(JudgementResult result) => skinnedCounter?.Flash(result);
+
+        private HealthProcessor processor;
+
+        public void BindHealthProcessor(HealthProcessor processor)
+        {
+            if (this.processor != null)
+                throw new InvalidOperationException("Can't bind to a processor more than once");
+
+            this.processor = processor;
+
+            Current.BindTo(processor.Health);
+        }
+
+        public SkinnableHealthDisplay()
+            : base(new HUDSkinComponent(HUDSkinComponents.HealthDisplay), _ => new DefaultHealthDisplay())
+        {
+            CentreComponent = false;
+        }
+
+        private IHealthDisplay skinnedCounter;
+
+        protected override void SkinChanged(ISkinSource skin, bool allowFallback)
+        {
+            base.SkinChanged(skin, allowFallback);
+
+            skinnedCounter = Drawable as IHealthDisplay;
+            skinnedCounter?.Current.BindTo(Current);
+        }
+    }
+}

osu.Game/Skinning/HUDSkinComponents.cs

@@ -7,6 +7,7 @@ namespace osu.Game.Skinning
     {
         ComboCounter,
         ScoreCounter,
-        AccuracyCounter
+        AccuracyCounter,
+        HealthDisplay
     }
 }