Merge pull request #5421 from peppy/skin-scaling-modes

Skin scaling modes

osu.Game.Rulesets.Osu/Objects/Drawables/Connections/FollowPoint.cs

@@ -41,7 +41,7 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables.Connections
                     Anchor = Anchor.Centre,
                     Alpha = 0.5f,
                 }
-            }, restrictSize: false);
+            }, confineMode: ConfineMode.NoScaling);
         }
     }
 }

osu.Game.Rulesets.Osu/Objects/Drawables/DrawableRepeatPoint.cs

@@ -37,7 +37,7 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables
                 {
                     RelativeSizeAxes = Axes.Both,
                     Icon = FontAwesome.Solid.ChevronRight
-                }, restrictSize: false)
+                })
             };
         }
 

osu.Game.Rulesets.Osu/Objects/Drawables/DrawableSliderTick.cs

@@ -23,7 +23,7 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables
         public DrawableSliderTick(SliderTick sliderTick)
             : base(sliderTick)
         {
-            Size = new Vector2(16) * sliderTick.Scale;
+            Size = new Vector2(16 * sliderTick.Scale);
             Origin = Anchor.Centre;
 
             InternalChildren = new Drawable[]
@@ -42,7 +42,7 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables
                         Colour = AccentColour.Value,
                         Alpha = 0.3f,
                     }
-                }, restrictSize: false)
+                })
             };
         }
 

osu.Game.Rulesets.Osu/Objects/Drawables/Pieces/NumberPiece.cs

@@ -46,7 +46,7 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables.Pieces
                 {
                     Font = OsuFont.Numeric.With(size: 40),
                     UseFullGlyphHeight = false,
-                }, restrictSize: false)
+                }, confineMode: ConfineMode.NoScaling)
                 {
                     Text = @"1"
                 }

osu.Game.Rulesets.Osu/UI/Cursor/OsuCursor.cs

@@ -101,7 +101,7 @@ namespace osu.Game.Rulesets.Osu.UI.Cursor
                             },
                         },
                     }
-                }, restrictSize: false)
+                })
                 {
                     Origin = Anchor.Centre,
                     Anchor = Anchor.Centre,

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

@@ -1,145 +0,0 @@
-// 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 NUnit.Framework;
-using osu.Framework.Audio.Sample;
-using osu.Framework.Graphics;
-using osu.Framework.Graphics.Containers;
-using osu.Framework.Graphics.Shapes;
-using osu.Framework.Graphics.Textures;
-using osu.Game.Graphics;
-using osu.Game.Graphics.Sprites;
-using osu.Game.Skinning;
-using osuTK.Graphics;
-
-namespace osu.Game.Tests.Visual.Gameplay
-{
-    public class TestSceneSkinReloadable : OsuTestScene
-    {
-        [Test]
-        public void TestInitialLoad()
-        {
-            var secondarySource = new SecondarySource();
-            SkinConsumer consumer = null;
-
-            AddStep("setup layout", () =>
-            {
-                Child = new SkinSourceContainer
-                {
-                    RelativeSizeAxes = Axes.Both,
-                    Child = new LocalSkinOverrideContainer(secondarySource)
-                    {
-                        RelativeSizeAxes = Axes.Both,
-                        Child = consumer = new SkinConsumer("test", name => new NamedBox("Default Implementation"), source => true)
-                    }
-                };
-            });
-
-            AddAssert("consumer using override source", () => consumer.Drawable is SecondarySourceBox);
-            AddAssert("skinchanged only called once", () => consumer.SkinChangedCount == 1);
-        }
-
-        [Test]
-        public void TestOverride()
-        {
-            var secondarySource = new SecondarySource();
-
-            SkinConsumer consumer = null;
-            Container target = null;
-
-            AddStep("setup layout", () =>
-            {
-                Child = new SkinSourceContainer
-                {
-                    RelativeSizeAxes = Axes.Both,
-                    Child = target = new LocalSkinOverrideContainer(secondarySource)
-                    {
-                        RelativeSizeAxes = Axes.Both,
-                    }
-                };
-            });
-
-            AddStep("add permissive", () => target.Add(consumer = new SkinConsumer("test", name => new NamedBox("Default Implementation"), source => true)));
-            AddAssert("consumer using override source", () => consumer.Drawable is SecondarySourceBox);
-            AddAssert("skinchanged only called once", () => consumer.SkinChangedCount == 1);
-        }
-
-        private class NamedBox : Container
-        {
-            public NamedBox(string name)
-            {
-                Children = new Drawable[]
-                {
-                    new Box
-                    {
-                        Colour = Color4.Black,
-                        RelativeSizeAxes = Axes.Both,
-                    },
-                    new OsuSpriteText
-                    {
-                        Font = OsuFont.Default.With(size: 40),
-                        Anchor = Anchor.Centre,
-                        Origin = Anchor.Centre,
-                        Text = name
-                    }
-                };
-            }
-        }
-
-        private class SkinConsumer : SkinnableDrawable
-        {
-            public new Drawable Drawable => base.Drawable;
-            public int SkinChangedCount { get; private set; }
-
-            public SkinConsumer(string name, Func<string, Drawable> defaultImplementation, Func<ISkinSource, bool> allowFallback = null, bool restrictSize = true)
-                : base(name, defaultImplementation, allowFallback, restrictSize)
-            {
-            }
-
-            protected override void SkinChanged(ISkinSource skin, bool allowFallback)
-            {
-                base.SkinChanged(skin, allowFallback);
-                SkinChangedCount++;
-            }
-        }
-
-        private class BaseSourceBox : NamedBox
-        {
-            public BaseSourceBox()
-                : base("Base Source")
-            {
-            }
-        }
-
-        private class SecondarySourceBox : NamedBox
-        {
-            public SecondarySourceBox()
-                : base("Secondary Source")
-            {
-            }
-        }
-
-        private class SecondarySource : ISkin
-        {
-            public Drawable GetDrawableComponent(string componentName) => new SecondarySourceBox();
-
-            public Texture GetTexture(string componentName) => throw new NotImplementedException();
-
-            public SampleChannel GetSample(string sampleName) => throw new NotImplementedException();
-
-            public TValue GetValue<TConfiguration, TValue>(Func<TConfiguration, TValue> query) where TConfiguration : SkinConfiguration => throw new NotImplementedException();
-        }
-
-        private class SkinSourceContainer : Container, ISkin
-        {
-            public Drawable GetDrawableComponent(string componentName) => new BaseSourceBox();
-
-            public Texture GetTexture(string componentName) => throw new NotImplementedException();
-
-            public SampleChannel GetSample(string sampleName) => throw new NotImplementedException();
-
-            public TValue GetValue<TConfiguration, TValue>(Func<TConfiguration, TValue> query) where TConfiguration : SkinConfiguration => throw new NotImplementedException();
-        }
-    }
-}

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

@@ -0,0 +1,283 @@
+// 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 System.Globalization;
+using System.Linq;
+using NUnit.Framework;
+using osu.Framework.Audio.Sample;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Shapes;
+using osu.Framework.Graphics.Textures;
+using osu.Game.Graphics;
+using osu.Game.Graphics.Sprites;
+using osu.Game.Skinning;
+using osuTK;
+using osuTK.Graphics;
+
+namespace osu.Game.Tests.Visual.Gameplay
+{
+    public class TestSceneSkinnableDrawable : OsuTestScene
+    {
+        [Test]
+        public void TestConfineScaleDown()
+        {
+            FillFlowContainer<ExposedSkinnableDrawable> fill = null;
+
+            AddStep("setup layout larger source", () =>
+            {
+                Child = new LocalSkinOverrideContainer(new SizedSource(50))
+                {
+                    RelativeSizeAxes = Axes.Both,
+                    Child = fill = new FillFlowContainer<ExposedSkinnableDrawable>
+                    {
+                        Size = new Vector2(30),
+                        Anchor = Anchor.Centre,
+                        Origin = Anchor.Centre,
+                        Spacing = new Vector2(10),
+                        Children = new[]
+                        {
+                            new ExposedSkinnableDrawable("default", _ => new DefaultBox(), _ => true),
+                            new ExposedSkinnableDrawable("available", _ => new DefaultBox(), _ => true),
+                            new ExposedSkinnableDrawable("available", _ => new DefaultBox(), _ => true, ConfineMode.ScaleToFit),
+                            new ExposedSkinnableDrawable("available", _ => new DefaultBox(), _ => true, ConfineMode.NoScaling)
+                        }
+                    },
+                };
+            });
+
+            AddAssert("check sizes", () => fill.Children.Select(c => c.Drawable.DrawWidth).SequenceEqual(new float[] { 30, 30, 30, 50 }));
+            AddStep("adjust scale", () => fill.Scale = new Vector2(2));
+            AddAssert("check sizes unchanged by scale", () => fill.Children.Select(c => c.Drawable.DrawWidth).SequenceEqual(new float[] { 30, 30, 30, 50 }));
+        }
+
+        [Test]
+        public void TestConfineScaleUp()
+        {
+            FillFlowContainer<ExposedSkinnableDrawable> fill = null;
+
+            AddStep("setup layout larger source", () =>
+            {
+                Child = new LocalSkinOverrideContainer(new SizedSource(30))
+                {
+                    RelativeSizeAxes = Axes.Both,
+                    Child = fill = new FillFlowContainer<ExposedSkinnableDrawable>
+                    {
+                        Size = new Vector2(50),
+                        Anchor = Anchor.Centre,
+                        Origin = Anchor.Centre,
+                        Spacing = new Vector2(10),
+                        Children = new[]
+                        {
+                            new ExposedSkinnableDrawable("default", _ => new DefaultBox(), _ => true),
+                            new ExposedSkinnableDrawable("available", _ => new DefaultBox(), _ => true),
+                            new ExposedSkinnableDrawable("available", _ => new DefaultBox(), _ => true, ConfineMode.ScaleToFit),
+                            new ExposedSkinnableDrawable("available", _ => new DefaultBox(), _ => true, ConfineMode.NoScaling)
+                        }
+                    },
+                };
+            });
+
+            AddAssert("check sizes", () => fill.Children.Select(c => c.Drawable.DrawWidth).SequenceEqual(new float[] { 50, 30, 50, 30 }));
+            AddStep("adjust scale", () => fill.Scale = new Vector2(2));
+            AddAssert("check sizes unchanged by scale", () => fill.Children.Select(c => c.Drawable.DrawWidth).SequenceEqual(new float[] { 50, 30, 50, 30 }));
+        }
+
+        [Test]
+        public void TestInitialLoad()
+        {
+            var secondarySource = new SecondarySource();
+            SkinConsumer consumer = null;
+
+            AddStep("setup layout", () =>
+            {
+                Child = new SkinSourceContainer
+                {
+                    RelativeSizeAxes = Axes.Both,
+                    Child = new LocalSkinOverrideContainer(secondarySource)
+                    {
+                        RelativeSizeAxes = Axes.Both,
+                        Child = consumer = new SkinConsumer("test", name => new NamedBox("Default Implementation"), source => true)
+                    }
+                };
+            });
+
+            AddAssert("consumer using override source", () => consumer.Drawable is SecondarySourceBox);
+            AddAssert("skinchanged only called once", () => consumer.SkinChangedCount == 1);
+        }
+
+        [Test]
+        public void TestOverride()
+        {
+            var secondarySource = new SecondarySource();
+
+            SkinConsumer consumer = null;
+            Container target = null;
+
+            AddStep("setup layout", () =>
+            {
+                Child = new SkinSourceContainer
+                {
+                    RelativeSizeAxes = Axes.Both,
+                    Child = target = new LocalSkinOverrideContainer(secondarySource)
+                    {
+                        RelativeSizeAxes = Axes.Both,
+                    }
+                };
+            });
+
+            AddStep("add permissive", () => target.Add(consumer = new SkinConsumer("test", name => new NamedBox("Default Implementation"), source => true)));
+            AddAssert("consumer using override source", () => consumer.Drawable is SecondarySourceBox);
+            AddAssert("skinchanged only called once", () => consumer.SkinChangedCount == 1);
+        }
+
+        private class ExposedSkinnableDrawable : SkinnableDrawable
+        {
+            public new Drawable Drawable => base.Drawable;
+
+            public ExposedSkinnableDrawable(string name, Func<string, Drawable> defaultImplementation, Func<ISkinSource, bool> allowFallback = null, ConfineMode confineMode = ConfineMode.ScaleDownToFit)
+                : base(name, defaultImplementation, allowFallback, confineMode)
+            {
+            }
+        }
+
+        private class DefaultBox : DrawWidthBox
+        {
+            public DefaultBox()
+            {
+                RelativeSizeAxes = Axes.Both;
+            }
+        }
+
+        private class DrawWidthBox : Container
+        {
+            private readonly OsuSpriteText text;
+
+            public DrawWidthBox()
+            {
+                Children = new Drawable[]
+                {
+                    new Box
+                    {
+                        Colour = Color4.Gray,
+                        RelativeSizeAxes = Axes.Both,
+                    },
+                    text = new OsuSpriteText
+                    {
+                        Anchor = Anchor.Centre,
+                        Origin = Anchor.Centre,
+                    }
+                };
+            }
+
+            protected override void UpdateAfterChildren()
+            {
+                base.UpdateAfterChildren();
+                text.Text = DrawWidth.ToString(CultureInfo.InvariantCulture);
+            }
+        }
+
+        private class NamedBox : Container
+        {
+            public NamedBox(string name)
+            {
+                Children = new Drawable[]
+                {
+                    new Box
+                    {
+                        Colour = Color4.Black,
+                        RelativeSizeAxes = Axes.Both,
+                    },
+                    new OsuSpriteText
+                    {
+                        Font = OsuFont.Default.With(size: 40),
+                        Anchor = Anchor.Centre,
+                        Origin = Anchor.Centre,
+                        Text = name
+                    }
+                };
+            }
+        }
+
+        private class SkinConsumer : SkinnableDrawable
+        {
+            public new Drawable Drawable => base.Drawable;
+            public int SkinChangedCount { get; private set; }
+
+            public SkinConsumer(string name, Func<string, Drawable> defaultImplementation, Func<ISkinSource, bool> allowFallback = null)
+                : base(name, defaultImplementation, allowFallback)
+            {
+            }
+
+            protected override void SkinChanged(ISkinSource skin, bool allowFallback)
+            {
+                base.SkinChanged(skin, allowFallback);
+                SkinChangedCount++;
+            }
+        }
+
+        private class BaseSourceBox : NamedBox
+        {
+            public BaseSourceBox()
+                : base("Base Source")
+            {
+            }
+        }
+
+        private class SecondarySourceBox : NamedBox
+        {
+            public SecondarySourceBox()
+                : base("Secondary Source")
+            {
+            }
+        }
+
+        private class SizedSource : ISkin
+        {
+            private readonly float size;
+
+            public SizedSource(float size)
+            {
+                this.size = size;
+            }
+
+            public Drawable GetDrawableComponent(string componentName) =>
+                componentName == "available"
+                    ? new DrawWidthBox
+                    {
+                        Colour = Color4.Yellow,
+                        Size = new Vector2(size)
+                    }
+                    : null;
+
+            public Texture GetTexture(string componentName) => throw new NotImplementedException();
+
+            public SampleChannel GetSample(string sampleName) => throw new NotImplementedException();
+
+            public TValue GetValue<TConfiguration, TValue>(Func<TConfiguration, TValue> query) where TConfiguration : SkinConfiguration => throw new NotImplementedException();
+        }
+
+        private class SecondarySource : ISkin
+        {
+            public Drawable GetDrawableComponent(string componentName) => new SecondarySourceBox();
+
+            public Texture GetTexture(string componentName) => throw new NotImplementedException();
+
+            public SampleChannel GetSample(string sampleName) => throw new NotImplementedException();
+
+            public TValue GetValue<TConfiguration, TValue>(Func<TConfiguration, TValue> query) where TConfiguration : SkinConfiguration => throw new NotImplementedException();
+        }
+
+        private class SkinSourceContainer : Container, ISkin
+        {
+            public Drawable GetDrawableComponent(string componentName) => new BaseSourceBox();
+
+            public Texture GetTexture(string componentName) => throw new NotImplementedException();
+
+            public SampleChannel GetSample(string sampleName) => throw new NotImplementedException();
+
+            public TValue GetValue<TConfiguration, TValue>(Func<TConfiguration, TValue> query) where TConfiguration : SkinConfiguration => throw new NotImplementedException();
+        }
+    }
+}

osu.Game/Rulesets/Judgements/DrawableJudgement.cs

@@ -67,7 +67,7 @@ namespace osu.Game.Rulesets.Judgements
                     Font = OsuFont.Numeric.With(size: 12),
                     Colour = judgementColour(Result.Type),
                     Scale = new Vector2(0.85f, 1),
-                }, restrictSize: false)
+                })
             };
         }
 

osu.Game/Skinning/SkinnableDrawable.cs

@@ -2,6 +2,7 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using System;
+using osu.Framework.Caching;
 using osu.Framework.Graphics;
 using osuTK;
 
@@ -9,8 +10,8 @@ namespace osu.Game.Skinning
 {
     public class SkinnableDrawable : SkinnableDrawable<Drawable>
     {
-        public SkinnableDrawable(string name, Func<string, Drawable> defaultImplementation, Func<ISkinSource, bool> allowFallback = null, bool restrictSize = true)
+        public SkinnableDrawable(string name, Func<string, Drawable> defaultImplementation, Func<ISkinSource, bool> allowFallback = null, ConfineMode confineMode = ConfineMode.ScaleDownToFit)
-            : base(name, defaultImplementation, allowFallback, restrictSize)
+            : base(name, defaultImplementation, allowFallback, confineMode)
         {
         }
     }
@@ -29,7 +30,7 @@ namespace osu.Game.Skinning
 
         private readonly string componentName;
 
-        private readonly bool restrictSize;
+        private readonly ConfineMode confineMode;
 
         /// <summary>
         /// Create a new skinnable drawable.
@@ -37,28 +38,32 @@ namespace osu.Game.Skinning
         /// <param name="name">The namespace-complete resource name for this skinnable element.</param>
         /// <param name="defaultImplementation">A function to create the default skin implementation of this element.</param>
         /// <param name="allowFallback">A conditional to decide whether to allow fallback to the default implementation if a skinned element is not present.</param>
-        /// <param name="restrictSize">Whether a user-skin drawable should be limited to the size of our parent.</param>
+        /// <param name="confineMode">How (if at all) the <see cref="Drawable"/> should be resize to fit within our own bounds.</param>
-        public SkinnableDrawable(string name, Func<string, T> defaultImplementation, Func<ISkinSource, bool> allowFallback = null, bool restrictSize = true)
+        public SkinnableDrawable(string name, Func<string, T> defaultImplementation, Func<ISkinSource, bool> allowFallback = null, ConfineMode confineMode = ConfineMode.ScaleDownToFit)
-            : this(name, allowFallback, restrictSize)
+            : this(name, allowFallback, confineMode)
         {
             createDefault = defaultImplementation;
         }
 
-        protected SkinnableDrawable(string name, Func<ISkinSource, bool> allowFallback = null, bool restrictSize = true)
+        protected SkinnableDrawable(string name, Func<ISkinSource, bool> allowFallback = null, ConfineMode confineMode = ConfineMode.ScaleDownToFit)
             : base(allowFallback)
         {
             componentName = name;
-            this.restrictSize = restrictSize;
+            this.confineMode = confineMode;
 
             RelativeSizeAxes = Axes.Both;
         }
 
         private readonly Func<string, T> createDefault;
 
+        private readonly Cached scaling = new Cached();
+
+        private bool isDefault;
+
         protected virtual T CreateDefault(string name) => createDefault(name);
 
         /// <summary>
-        /// Whether to apply size restrictions (specified via <see cref="restrictSize"/>) to the default implementation.
+        /// Whether to apply size restrictions (specified via <see cref="confineMode"/>) to the default implementation.
         /// </summary>
         protected virtual bool ApplySizeRestrictionsToDefault => false;
 
@@ -66,7 +71,7 @@ namespace osu.Game.Skinning
         {
             Drawable = skin.GetDrawableComponent(componentName);
 
-            bool isDefault = false;
+            isDefault = false;
 
             if (Drawable == null && allowFallback)
             {
@@ -76,21 +81,57 @@ namespace osu.Game.Skinning
 
             if (Drawable != null)
             {
-                if (restrictSize && (!isDefault || ApplySizeRestrictionsToDefault))
+                scaling.Invalidate();
-                {
-                    Drawable.RelativeSizeAxes = Axes.Both;
-                    Drawable.Size = Vector2.One;
-                    Drawable.Scale = Vector2.One;
-                    Drawable.FillMode = FillMode.Fit;
-                }
-
                 Drawable.Origin = Anchor.Centre;
                 Drawable.Anchor = Anchor.Centre;
-
                 InternalChild = Drawable;
             }
             else
                 ClearInternal();
         }
+
+        protected override void Update()
+        {
+            base.Update();
+
+            if (!scaling.IsValid)
+            {
+                try
+                {
+                    if (Drawable == null || (isDefault && !ApplySizeRestrictionsToDefault)) return;
+
+                    switch (confineMode)
+                    {
+                        case ConfineMode.NoScaling:
+                            return;
+
+                        case ConfineMode.ScaleDownToFit:
+                            if (Drawable.DrawSize.X <= DrawSize.X && Drawable.DrawSize.Y <= DrawSize.Y)
+                                return;
+
+                            break;
+                    }
+
+                    Drawable.RelativeSizeAxes = Axes.Both;
+                    Drawable.Size = Vector2.One;
+                    Drawable.Scale = Vector2.One;
+                    Drawable.FillMode = FillMode.Fit;
+                }
+                finally
+                {
+                    scaling.Validate();
+                }
+            }
+        }
+    }
+
+    public enum ConfineMode
+    {
+        /// <summary>
+        /// Don't apply any scaling. This allows the user element to be of any size, exceeding specified bounds.
+        /// </summary>
+        NoScaling,
+        ScaleDownToFit,
+        ScaleToFit,
     }
 }

osu.Game/Skinning/SkinnableSprite.cs

@@ -18,8 +18,8 @@ namespace osu.Game.Skinning
         [Resolved]
         private TextureStore textures { get; set; }
 
-        public SkinnableSprite(string name, Func<ISkinSource, bool> allowFallback = null, bool restrictSize = true)
+        public SkinnableSprite(string name, Func<ISkinSource, bool> allowFallback = null, ConfineMode confineMode = ConfineMode.ScaleDownToFit)
-            : base(name, allowFallback, restrictSize)
+            : base(name, allowFallback, confineMode)
         {
         }
 

osu.Game/Skinning/SkinnableSpriteText.cs

@@ -8,8 +8,8 @@ namespace osu.Game.Skinning
 {
     public class SkinnableSpriteText : SkinnableDrawable<SpriteText>, IHasText
     {
-        public SkinnableSpriteText(string name, Func<string, SpriteText> defaultImplementation, Func<ISkinSource, bool> allowFallback = null, bool restrictSize = true)
+        public SkinnableSpriteText(string name, Func<string, SpriteText> defaultImplementation, Func<ISkinSource, bool> allowFallback = null, ConfineMode confineMode = ConfineMode.ScaleDownToFit)
-            : base(name, defaultImplementation, allowFallback, restrictSize)
+            : base(name, defaultImplementation, allowFallback, confineMode)
         {
         }