Add basic skinning capabilities to osu!catch catcher (#5128)

Add basic skinning capabilities to osu!catch catcher

Co-authored-by: Dan Balasescu <smoogipoo@smgi.me>
Co-authored-by: Dean Herbert <pe@ppy.sh>

osu.Game.Rulesets.Catch.Tests/TestSceneCatcher.cs

@@ -0,0 +1,105 @@
+// 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 NUnit.Framework;
+using osu.Framework.Allocation;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics;
+using osu.Game.Rulesets.Catch.UI;
+using osu.Game.Tests.Visual;
+using System;
+using System.Collections.Generic;
+using osu.Game.Skinning;
+using osu.Framework.Graphics.Shapes;
+using osu.Framework.Graphics.Sprites;
+using osuTK.Graphics;
+using osu.Framework.Audio.Sample;
+using osu.Framework.Graphics.Textures;
+
+namespace osu.Game.Rulesets.Catch.Tests
+{
+    [TestFixture]
+    public class TestSceneCatcher : OsuTestScene
+    {
+        public override IReadOnlyList<Type> RequiredTypes => new[]
+        {
+            typeof(CatcherSprite),
+        };
+
+        private readonly Container container;
+
+        public TestSceneCatcher()
+        {
+            Child = container = new Container
+            {
+                Anchor = Anchor.Centre,
+                Origin = Anchor.Centre,
+            };
+        }
+
+        [BackgroundDependencyLoader]
+        private void load()
+        {
+            AddStep("show default catcher implementation", () => { container.Child = new CatcherSprite(); });
+
+            AddStep("show custom catcher implementation", () =>
+            {
+                container.Child = new CatchCustomSkinSourceContainer
+                {
+                    Child = new CatcherSprite()
+                };
+            });
+        }
+
+        private class CatcherCustomSkin : Container
+        {
+            public CatcherCustomSkin()
+            {
+                RelativeSizeAxes = Axes.Both;
+
+                Children = new Drawable[]
+                {
+                    new Box
+                    {
+                        RelativeSizeAxes = Axes.Both,
+                        Colour = Color4.Blue
+                    },
+                    new SpriteText
+                    {
+                        Text = "custom"
+                    }
+                };
+            }
+        }
+
+        [Cached(typeof(ISkinSource))]
+        private class CatchCustomSkinSourceContainer : Container, ISkinSource
+        {
+            public event Action SourceChanged
+            {
+                add { }
+                remove { }
+            }
+
+            public Drawable GetDrawableComponent(string componentName)
+            {
+                switch (componentName)
+                {
+                    case "Play/Catch/fruit-catcher-idle":
+                        return new CatcherCustomSkin();
+                }
+
+                return null;
+            }
+
+            public SampleChannel GetSample(string sampleName) =>
+                throw new NotImplementedException();
+
+            public Texture GetTexture(string componentName) =>
+                throw new NotImplementedException();
+
+            public TValue GetValue<TConfiguration, TValue>(Func<TConfiguration, TValue> query) where TConfiguration : SkinConfiguration =>
+                throw new NotImplementedException();
+        }
+    }
+}

osu.Game.Rulesets.Catch/UI/CatcherArea.cs

@@ -6,8 +6,6 @@ using System.Linq;
 using osu.Framework.Allocation;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
-using osu.Framework.Graphics.Sprites;
-using osu.Framework.Graphics.Textures;
 using osu.Framework.Input.Bindings;
 using osu.Framework.MathUtils;
 using osu.Game.Beatmaps;
@@ -141,7 +139,7 @@ namespace osu.Game.Rulesets.Catch.UI
             [BackgroundDependencyLoader]
             private void load()
             {
-                Children = new Drawable[]
+                Children = new[]
                 {
                     caughtFruit = new Container<DrawableHitObject>
                     {
@@ -212,7 +210,7 @@ namespace osu.Game.Rulesets.Catch.UI
                 Scheduler.AddDelayed(beginTrail, HyperDashing ? 25 : 50);
             }
 
-            private Sprite createCatcherSprite() => new CatcherSprite();
+            private Drawable createCatcherSprite() => new CatcherSprite();
 
             /// <summary>
             /// Add a caught fruit to the catcher's stack.
@@ -444,23 +442,6 @@ namespace osu.Game.Rulesets.Catch.UI
 
                 fruit.Expire();
             }
-
-            private class CatcherSprite : Sprite
-            {
-                public CatcherSprite()
-                {
-                    Size = new Vector2(CATCHER_SIZE);
-
-                    // Sets the origin roughly to the centre of the catcher's plate to allow for correct scaling.
-                    OriginPosition = new Vector2(-0.02f, 0.06f) * CATCHER_SIZE;
-                }
-
-                [BackgroundDependencyLoader]
-                private void load(TextureStore textures)
-                {
-                    Texture = textures.Get(@"Play/Catch/fruit-catcher-idle");
-                }
-            }
         }
     }
 }

osu.Game.Rulesets.Catch/UI/CatcherSprite.cs

@@ -0,0 +1,33 @@
+// 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.Allocation;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Game.Skinning;
+using osuTK;
+
+namespace osu.Game.Rulesets.Catch.UI
+{
+    public class CatcherSprite : CompositeDrawable
+    {
+        public CatcherSprite()
+        {
+            Size = new Vector2(CatcherArea.CATCHER_SIZE);
+
+            // Sets the origin roughly to the centre of the catcher's plate to allow for correct scaling.
+            OriginPosition = new Vector2(-0.02f, 0.06f) * CatcherArea.CATCHER_SIZE;
+        }
+
+        [BackgroundDependencyLoader]
+        private void load()
+        {
+            InternalChild = new SkinnableSprite(@"Play/Catch/fruit-catcher-idle")
+            {
+                RelativeSizeAxes = Axes.Both,
+                Anchor = Anchor.TopCentre,
+                Origin = Anchor.TopCentre,
+            };
+        }
+    }
+}