Merge pull request #19556 from HiddenNode/fix_progress_bar_info

Fix progress bar text orientation and scale

osu.Game.Tests/Visual/UserInterface/TestSceneSizePreservingSpriteText.cs

@@ -0,0 +1,94 @@
+// 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.Collections.Generic;
+using System.Globalization;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Shapes;
+using osu.Framework.Graphics;
+using osu.Game.Graphics.Containers;
+using osu.Game.Graphics.Sprites;
+using osu.Game.Graphics;
+
+namespace osu.Game.Tests.Visual.UserInterface
+{
+    public class TestSceneSizePreservingSpriteText : OsuGridTestScene
+    {
+        private readonly List<Container> parentContainers = new List<Container>();
+        private readonly List<UprightAspectMaintainingContainer> childContainers = new List<UprightAspectMaintainingContainer>();
+        private readonly OsuSpriteText osuSpriteText = new OsuSpriteText();
+        private readonly SizePreservingSpriteText sizePreservingSpriteText = new SizePreservingSpriteText();
+
+        public TestSceneSizePreservingSpriteText()
+            : base(1, 2)
+        {
+            for (int i = 0; i < 2; i++)
+            {
+                UprightAspectMaintainingContainer childContainer;
+                Container parentContainer = new Container
+                {
+                    Origin = Anchor.BottomRight,
+                    Anchor = Anchor.BottomCentre,
+                    AutoSizeAxes = Axes.Both,
+                    Rotation = 45,
+                    Y = -200,
+                    Children = new Drawable[]
+                    {
+                        new Box
+                        {
+                            RelativeSizeAxes = Axes.Both,
+                            Colour = Colour4.Red,
+                        },
+                        childContainer = new UprightAspectMaintainingContainer
+                        {
+                            AutoSizeAxes = Axes.Both,
+                            Anchor = Anchor.Centre,
+                            Origin = Anchor.Centre,
+                            Children = new Drawable[]
+                            {
+                                new Box
+                                {
+                                    RelativeSizeAxes = Axes.Both,
+                                    Colour = Colour4.Blue,
+                                },
+                            }
+                        },
+                    }
+                };
+
+                Container cellInfo = new Container
+                {
+                    Origin = Anchor.TopCentre,
+                    Anchor = Anchor.TopCentre,
+                    Margin = new MarginPadding
+                    {
+                        Top = 100,
+                    },
+                    Child = new OsuSpriteText
+                    {
+                        Text = (i == 0) ? "OsuSpriteText" : "SizePreservingSpriteText",
+                        Font = OsuFont.GetFont(Typeface.Inter, weight: FontWeight.Bold, size: 40),
+                        Origin = Anchor.TopCentre,
+                        Anchor = Anchor.TopCentre,
+                    },
+                };
+
+                parentContainers.Add(parentContainer);
+                childContainers.Add(childContainer);
+                Cell(i).Add(cellInfo);
+                Cell(i).Add(parentContainer);
+            }
+
+            childContainers[0].Add(osuSpriteText);
+            childContainers[1].Add(sizePreservingSpriteText);
+            osuSpriteText.Font = sizePreservingSpriteText.Font = OsuFont.GetFont(Typeface.Venera, weight: FontWeight.Bold, size: 20);
+        }
+
+        protected override void Update()
+        {
+            base.Update();
+            osuSpriteText.Text = sizePreservingSpriteText.Text = DateTime.Now.ToString(CultureInfo.InvariantCulture);
+        }
+    }
+}

osu.Game.Tests/Visual/UserInterface/TestSceneUprightAspectMaintainingContainer.cs

@@ -0,0 +1,244 @@
+// 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.Collections.Generic;
+using System.Linq;
+using NUnit.Framework;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Shapes;
+using osu.Framework.Graphics;
+using osu.Framework.Utils;
+using osu.Game.Graphics.Containers;
+using osu.Game.Graphics.Sprites;
+using osu.Game.Graphics;
+using osuTK.Graphics;
+using osuTK;
+
+namespace osu.Game.Tests.Visual.UserInterface
+{
+    public class TestSceneUprightAspectMaintainingContainer : OsuGridTestScene
+    {
+        private const int rows = 3;
+        private const int columns = 4;
+
+        private readonly ScaleMode[] scaleModeValues = { ScaleMode.NoScaling, ScaleMode.Horizontal, ScaleMode.Vertical };
+        private readonly float[] scalingFactorValues = { 1.0f / 3, 1.0f / 2, 1.0f, 1.5f };
+
+        private readonly List<List<Container>> parentContainers = new List<List<Container>>(rows);
+        private readonly List<List<UprightAspectMaintainingContainer>> childContainers = new List<List<UprightAspectMaintainingContainer>>(rows);
+
+        // Preferably should be set to (4 * 2^n)
+        private const int rotation_step_count = 3;
+
+        private readonly List<int> flipStates = new List<int>();
+        private readonly List<float> rotationSteps = new List<float>();
+        private readonly List<float> scaleSteps = new List<float>();
+
+        public TestSceneUprightAspectMaintainingContainer()
+            : base(rows, columns)
+        {
+            for (int i = 0; i < rows; i++)
+            {
+                parentContainers.Add(new List<Container>());
+                childContainers.Add(new List<UprightAspectMaintainingContainer>());
+
+                for (int j = 0; j < columns; j++)
+                {
+                    UprightAspectMaintainingContainer child;
+                    Container parent = new Container
+                    {
+                        Anchor = Anchor.Centre,
+                        Origin = Anchor.Centre,
+                        Height = 80,
+                        Width = 80,
+                        Children = new Drawable[]
+                        {
+                            new Box
+                            {
+                                RelativeSizeAxes = Axes.Both,
+                                Colour = new Color4(255, 0, 0, 160),
+                            },
+                            new OsuSpriteText
+                            {
+                                Text = "Parent",
+                            },
+                            child = new UprightAspectMaintainingContainer
+                            {
+                                Origin = Anchor.Centre,
+                                Anchor = Anchor.Centre,
+                                AutoSizeAxes = Axes.Both,
+
+                                // These are the parameters being Tested
+                                Scaling = scaleModeValues[i],
+                                ScalingFactor = scalingFactorValues[j],
+
+                                Children = new Drawable[]
+                                {
+                                    new Box
+                                    {
+                                        RelativeSizeAxes = Axes.Both,
+                                        Colour = new Color4(0, 0, 255, 160),
+                                    },
+                                    new OsuSpriteText
+                                    {
+                                        Text = "Text",
+                                        Font = OsuFont.Numeric,
+                                        Origin = Anchor.Centre,
+                                        Anchor = Anchor.Centre,
+                                        Padding = new MarginPadding
+                                        {
+                                            Horizontal = 4,
+                                            Vertical = 4,
+                                        }
+                                    },
+                                }
+                            }
+                        }
+                    };
+
+                    Container cellInfo = new Container
+                    {
+                        Children = new Drawable[]
+                        {
+                            new OsuSpriteText
+                            {
+                                Text = "Scaling: " + scaleModeValues[i].ToString(),
+                            },
+                            new OsuSpriteText
+                            {
+                                Text = "ScalingFactor: " + scalingFactorValues[j].ToString("0.00"),
+                                Margin = new MarginPadding
+                                {
+                                    Top = 15,
+                                },
+                            },
+                        },
+                    };
+
+                    Cell(i * columns + j).Add(cellInfo);
+                    Cell(i * columns + j).Add(parent);
+                    parentContainers[i].Add(parent);
+                    childContainers[i].Add(child);
+                }
+            }
+
+            flipStates.AddRange(new[] { 1, -1 });
+            rotationSteps.AddRange(Enumerable.Range(0, rotation_step_count).Select(x => 360f * ((float)x / rotation_step_count)));
+            scaleSteps.AddRange(new[] { 1, 0.3f, 1.5f });
+        }
+
+        [Test]
+        public void ExplicitlySizedParent()
+        {
+            var parentStates = from xFlip in flipStates
+                               from yFlip in flipStates
+                               from xScale in scaleSteps
+                               from yScale in scaleSteps
+                               from rotation in rotationSteps
+                               select new { xFlip, yFlip, xScale, yScale, rotation };
+
+            foreach (var state in parentStates)
+            {
+                Vector2 parentScale = new Vector2(state.xFlip * state.xScale, state.yFlip * state.yScale);
+                float parentRotation = state.rotation;
+
+                AddStep("S: (" + parentScale.X.ToString("0.00") + ", " + parentScale.Y.ToString("0.00") + "), R: " + parentRotation.ToString("0.00"), () =>
+                {
+                    foreach (List<Container> list in parentContainers)
+                    {
+                        foreach (Container container in list)
+                        {
+                            container.Scale = parentScale;
+                            container.Rotation = parentRotation;
+                        }
+                    }
+                });
+
+                AddAssert("Check if state is valid", () =>
+                {
+                    foreach (int i in Enumerable.Range(0, parentContainers.Count))
+                    {
+                        foreach (int j in Enumerable.Range(0, parentContainers[i].Count))
+                        {
+                            if (!uprightAspectMaintainingContainerStateIsValid(parentContainers[i][j], childContainers[i][j]))
+                                return false;
+                        }
+                    }
+
+                    return true;
+                });
+            }
+        }
+
+        private bool uprightAspectMaintainingContainerStateIsValid(Container parent, UprightAspectMaintainingContainer child)
+        {
+            Matrix3 parentMatrix = parent.DrawInfo.Matrix;
+            Matrix3 childMatrix = child.DrawInfo.Matrix;
+            Vector3 childScale = childMatrix.ExtractScale();
+            Vector3 parentScale = parentMatrix.ExtractScale();
+
+            // Orientation check
+            if (!(isNearlyZero(MathF.Abs(childMatrix.M21)) && isNearlyZero(MathF.Abs(childMatrix.M12))))
+                return false;
+
+            // flip check
+            if (!(childMatrix.M11 * childMatrix.M22 > 0))
+                return false;
+
+            // Aspect ratio check
+            if (!isNearlyZero(childScale.X - childScale.Y))
+                return false;
+
+            // ScalingMode check
+            switch (child.Scaling)
+            {
+                case ScaleMode.NoScaling:
+                    if (!(isNearlyZero(childMatrix.M11 - 1.0f) && isNearlyZero(childMatrix.M22 - 1.0f)))
+                        return false;
+
+                    break;
+
+                case ScaleMode.Vertical:
+                    if (!(checkScaling(child.ScalingFactor, parentScale.Y, childScale.Y)))
+                        return false;
+
+                    break;
+
+                case ScaleMode.Horizontal:
+                    if (!(checkScaling(child.ScalingFactor, parentScale.X, childScale.X)))
+                        return false;
+
+                    break;
+            }
+
+            return true;
+        }
+
+        private bool checkScaling(float scalingFactor, float parentScale, float childScale)
+        {
+            if (scalingFactor <= 1.0f)
+            {
+                if (!isNearlyZero(1.0f + (parentScale - 1.0f) * scalingFactor - childScale))
+                    return false;
+            }
+            else if (scalingFactor > 1.0f)
+            {
+                if (parentScale < 1.0f)
+                {
+                    if (!isNearlyZero((parentScale * (1.0f / scalingFactor)) - childScale))
+                        return false;
+                }
+                else if (!isNearlyZero(parentScale * scalingFactor - childScale))
+                    return false;
+            }
+
+            return true;
+        }
+
+        private bool isNearlyZero(float f, float epsilon = Precision.FLOAT_EPSILON)
+        {
+            return f < epsilon;
+        }
+    }
+}

osu.Game/Graphics/Containers/UprightAspectMaintainingContainer.cs

@@ -0,0 +1,119 @@
+// 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.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Layout;
+using osuTK;
+
+namespace osu.Game.Graphics.Containers
+{
+    /// <summary>
+    /// A container that reverts any rotation (and optionally scale) applied by its direct parent.
+    /// </summary>
+    public class UprightAspectMaintainingContainer : Container
+    {
+        /// <summary>
+        /// Controls how much this container scales compared to its parent (default is 1.0f).
+        /// </summary>
+        public float ScalingFactor { get; set; } = 1;
+
+        /// <summary>
+        /// Controls the scaling of this container.
+        /// </summary>
+        public ScaleMode Scaling { get; set; } = ScaleMode.Vertical;
+
+        private readonly LayoutValue layout = new LayoutValue(Invalidation.DrawInfo, InvalidationSource.Parent);
+
+        public UprightAspectMaintainingContainer()
+        {
+            AddLayout(layout);
+        }
+
+        protected override void Update()
+        {
+            base.Update();
+
+            if (!layout.IsValid)
+            {
+                keepUprightAndUnstretched();
+                layout.Validate();
+            }
+        }
+
+        /// <summary>
+        /// Keeps the drawable upright and unstretched preventing it from being rotated, sheared, scaled or flipped with its Parent.
+        /// </summary>
+        private void keepUprightAndUnstretched()
+        {
+            // Decomposes the inverse of the parent DrawInfo.Matrix into rotation, shear and scale.
+            var parentMatrix = Parent.DrawInfo.Matrix;
+
+            // Remove Translation.>
+            parentMatrix.M31 = 0.0f;
+            parentMatrix.M32 = 0.0f;
+
+            Matrix3 reversedParent = parentMatrix.Inverted();
+
+            // Extract the rotation.
+            float angle = MathF.Atan2(reversedParent.M12, reversedParent.M11);
+            Rotation = MathHelper.RadiansToDegrees(angle);
+
+            // Remove rotation from the C matrix so that it only contains shear and scale.
+            Matrix3 m = Matrix3.CreateRotationZ(-angle);
+            reversedParent *= m;
+
+            // Extract shear.
+            float alpha = reversedParent.M21 / reversedParent.M22;
+            Shear = new Vector2(-alpha, 0);
+
+            // Etract scale.
+            float sx = reversedParent.M11;
+            float sy = reversedParent.M22;
+
+            Vector3 parentScale = parentMatrix.ExtractScale();
+
+            float usedScale = 1.0f;
+
+            switch (Scaling)
+            {
+                case ScaleMode.Horizontal:
+                    usedScale = parentScale.X;
+                    break;
+
+                case ScaleMode.Vertical:
+                    usedScale = parentScale.Y;
+                    break;
+            }
+
+            if (Scaling != ScaleMode.NoScaling)
+            {
+                if (ScalingFactor < 1.0f)
+                    usedScale = 1.0f + (usedScale - 1.0f) * ScalingFactor;
+                if (ScalingFactor > 1.0f)
+                    usedScale = (usedScale < 1.0f) ? usedScale * (1.0f / ScalingFactor) : usedScale * ScalingFactor;
+            }
+
+            Scale = new Vector2(sx * usedScale, sy * usedScale);
+        }
+    }
+
+    public enum ScaleMode
+    {
+        /// <summary>
+        /// Prevent this container from scaling.
+        /// </summary>
+        NoScaling,
+
+        /// <summary>
+        /// Scale uniformly (maintaining aspect ratio) based on the vertical scale of the parent.
+        /// </summary>
+        Vertical,
+
+        /// <summary>
+        /// Scale uniformly (maintaining aspect ratio) based on the horizontal scale of the parent.
+        /// </summary>
+        Horizontal,
+    }
+}

osu.Game/Graphics/Sprites/SizePreservingSpriteText.cs

@@ -0,0 +1,108 @@
+// 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.Collections.Generic;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Sprites;
+using osu.Framework.Localisation;
+using osuTK;
+using osuTK.Graphics;
+
+namespace osu.Game.Graphics.Sprites
+{
+    /// <summary>
+    /// A wrapped version of <see cref="OsuSpriteText"/> which will expand in size based on text content, but never shrink back down.
+    /// </summary>
+    public class SizePreservingSpriteText : CompositeDrawable
+    {
+        private readonly OsuSpriteText text = new OsuSpriteText();
+
+        private Vector2 maximumSize;
+
+        public SizePreservingSpriteText(Vector2? minimumSize = null)
+        {
+            text.Origin = Anchor.Centre;
+            text.Anchor = Anchor.Centre;
+
+            AddInternal(text);
+            maximumSize = minimumSize ?? Vector2.Zero;
+        }
+
+        protected override void Update()
+        {
+            Width = maximumSize.X = MathF.Max(maximumSize.X, text.Width);
+            Height = maximumSize.Y = MathF.Max(maximumSize.Y, text.Height);
+        }
+
+        public new Axes AutoSizeAxes
+        {
+            get => Axes.None;
+            set => throw new InvalidOperationException("You can't set AutoSizeAxes of this container");
+        }
+
+        /// <summary>
+        /// Gets or sets the text to be displayed.
+        /// </summary>
+        public LocalisableString Text
+        {
+            get => text.Text;
+            set => text.Text = value;
+        }
+
+        /// <summary>
+        /// Contains information on the font used to display the text.
+        /// </summary>
+        public FontUsage Font
+        {
+            get => text.Font;
+            set => text.Font = value;
+        }
+
+        /// <summary>
+        /// True if a shadow should be displayed around the text.
+        /// </summary>
+        public bool Shadow
+        {
+            get => text.Shadow;
+            set => text.Shadow = value;
+        }
+
+        /// <summary>
+        /// The colour of the shadow displayed around the text. A shadow will only be displayed if the <see cref="Shadow"/> property is set to true.
+        /// </summary>
+        public Color4 ShadowColour
+        {
+            get => text.ShadowColour;
+            set => text.ShadowColour = value;
+        }
+
+        /// <summary>
+        /// The offset of the shadow displayed around the text. A shadow will only be displayed if the <see cref="Shadow"/> property is set to true.
+        /// </summary>
+        public Vector2 ShadowOffset
+        {
+            get => text.ShadowOffset;
+            set => text.ShadowOffset = value;
+        }
+
+        /// <summary>
+        /// True if the <see cref="SpriteText"/>'s vertical size should be equal to <see cref="FontUsage.Size"/>  (the full height) or precisely the size of used characters.
+        /// Set to false to allow better centering of individual characters/numerals/etc.
+        /// </summary>
+        public bool UseFullGlyphHeight
+        {
+            get => text.UseFullGlyphHeight;
+            set => text.UseFullGlyphHeight = value;
+        }
+
+        public override bool IsPresent => text.IsPresent;
+
+        public override string ToString() => text.ToString();
+
+        public float LineBaseHeight => text.LineBaseHeight;
+
+        public IEnumerable<LocalisableString> FilterTerms => text.FilterTerms;
+    }
+}

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

@@ -16,7 +16,6 @@ namespace osu.Game.Screens.Play.HUD
 {
     public class DefaultSongProgress : SongProgress
     {
-        private const float info_height = 20;
         private const float bottom_bar_height = 5;
         private const float graph_height = SquareGraph.Column.WIDTH * 6;
         private const float handle_height = 18;
@@ -65,7 +64,6 @@ namespace osu.Game.Screens.Play.HUD
                     Origin = Anchor.BottomLeft,
                     Anchor = Anchor.BottomLeft,
                     RelativeSizeAxes = Axes.X,
-                    Height = info_height,
                 },
                 graph = new SongProgressGraph
                 {
@@ -178,7 +176,7 @@ namespace osu.Game.Screens.Play.HUD
         protected override void Update()
         {
             base.Update();
-            Height = bottom_bar_height + graph_height + handle_size.Y + info_height - graph.Y;
+            Height = bottom_bar_height + graph_height + handle_size.Y + info.Height - graph.Y;
         }
 
         private void updateBarVisibility()

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

@@ -7,6 +7,7 @@ using osu.Framework.Allocation;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Game.Graphics;
+using osu.Game.Graphics.Containers;
 using osu.Game.Graphics.Sprites;
 using System;
 
@@ -14,9 +15,9 @@ namespace osu.Game.Screens.Play.HUD
 {
     public class SongProgressInfo : Container
     {
-        private OsuSpriteText timeCurrent;
-        private OsuSpriteText timeLeft;
-        private OsuSpriteText progress;
+        private SizePreservingSpriteText timeCurrent;
+        private SizePreservingSpriteText timeLeft;
+        private SizePreservingSpriteText progress;
 
         private double startTime;
         private double endTime;
@@ -46,36 +47,71 @@ namespace osu.Game.Screens.Play.HUD
             if (clock != null)
                 gameplayClock = clock;
 
+            AutoSizeAxes = Axes.Y;
             Children = new Drawable[]
             {
-                timeCurrent = new OsuSpriteText
+                new Container
                 {
-                    Origin = Anchor.BottomLeft,
-                    Anchor = Anchor.BottomLeft,
-                    Colour = colours.BlueLighter,
-                    Font = OsuFont.Numeric,
-                    Margin = new MarginPadding
+                    Anchor = Anchor.CentreLeft,
+                    Origin = Anchor.CentreLeft,
+                    AutoSizeAxes = Axes.Both,
+                    Child = new UprightAspectMaintainingContainer
                     {
-                        Left = margin,
-                    },
+                        Origin = Anchor.Centre,
+                        Anchor = Anchor.Centre,
+                        AutoSizeAxes = Axes.Both,
+                        Scaling = ScaleMode.Vertical,
+                        ScalingFactor = 0.5f,
+                        Child = timeCurrent = new SizePreservingSpriteText
+                        {
+                            Origin = Anchor.Centre,
+                            Anchor = Anchor.Centre,
+                            Colour = colours.BlueLighter,
+                            Font = OsuFont.Numeric,
+                        }
+                    }
                 },
-                progress = new OsuSpriteText
+                new Container
                 {
-                    Origin = Anchor.BottomCentre,
-                    Anchor = Anchor.BottomCentre,
-                    Colour = colours.BlueLighter,
-                    Font = OsuFont.Numeric,
-                },
-                timeLeft = new OsuSpriteText
-                {
-                    Origin = Anchor.BottomRight,
-                    Anchor = Anchor.BottomRight,
-                    Colour = colours.BlueLighter,
-                    Font = OsuFont.Numeric,
-                    Margin = new MarginPadding
+                    Origin = Anchor.Centre,
+                    Anchor = Anchor.Centre,
+                    AutoSizeAxes = Axes.Both,
+                    Child = new UprightAspectMaintainingContainer
                     {
-                        Right = margin,
-                    },
+                        Origin = Anchor.Centre,
+                        Anchor = Anchor.Centre,
+                        AutoSizeAxes = Axes.Both,
+                        Scaling = ScaleMode.Vertical,
+                        ScalingFactor = 0.5f,
+                        Child = progress = new SizePreservingSpriteText
+                        {
+                            Origin = Anchor.Centre,
+                            Anchor = Anchor.Centre,
+                            Colour = colours.BlueLighter,
+                            Font = OsuFont.Numeric,
+                        }
+                    }
+                },
+                new Container
+                {
+                    Origin = Anchor.CentreRight,
+                    Anchor = Anchor.CentreRight,
+                    AutoSizeAxes = Axes.Both,
+                    Child = new UprightAspectMaintainingContainer
+                    {
+                        Origin = Anchor.Centre,
+                        Anchor = Anchor.Centre,
+                        AutoSizeAxes = Axes.Both,
+                        Scaling = ScaleMode.Vertical,
+                        ScalingFactor = 0.5f,
+                        Child = timeLeft = new SizePreservingSpriteText
+                        {
+                            Origin = Anchor.Centre,
+                            Anchor = Anchor.Centre,
+                            Colour = colours.BlueLighter,
+                            Font = OsuFont.Numeric,
+                        }
+                    }
                 }
             };
         }