Merge pull request #8006 from smoogipoo/layout-rework

Apply osu!-side invalidation changes

osu.Android.props

@@ -52,6 +52,6 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="ppy.osu.Game.Resources" Version="2020.221.0" />
-    <PackageReference Include="ppy.osu.Framework.Android" Version="2020.229.0" />
+    <PackageReference Include="ppy.osu.Framework.Android" Version="2020.302.0" />
   </ItemGroup>
 </Project>

osu.Game.Rulesets.Mania/Mods/ManiaModFlashlight.cs

@@ -3,8 +3,8 @@
 
 using System;
 using osu.Framework.Bindables;
-using osu.Framework.Caching;
 using osu.Framework.Graphics;
+using osu.Framework.Layout;
 using osu.Game.Rulesets.Mania.Objects;
 using osu.Game.Rulesets.Mods;
 using osuTK;
@@ -22,21 +22,13 @@ namespace osu.Game.Rulesets.Mania.Mods
 
         private class ManiaFlashlight : Flashlight
         {
-            private readonly Cached flashlightProperties = new Cached();
+            private readonly LayoutValue flashlightProperties = new LayoutValue(Invalidation.DrawSize);
 
             public ManiaFlashlight()
             {
                 FlashlightSize = new Vector2(0, default_flashlight_size);
-            }
 
-            public override bool Invalidate(Invalidation invalidation = Invalidation.All, Drawable source = null, bool shallPropagate = true)
-            {
-                if ((invalidation & Invalidation.DrawSize) > 0)
-                {
-                    flashlightProperties.Invalidate();
-                }
-
-                return base.Invalidate(invalidation, source, shallPropagate);
+                AddLayout(flashlightProperties);
             }
 
             protected override void Update()

osu.Game.Rulesets.Mania/Objects/Drawables/Pieces/BodyPiece.cs

@@ -2,13 +2,13 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using System;
-using osu.Framework.Caching;
 using osuTK.Graphics;
 using osu.Framework.Extensions.Color4Extensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Effects;
 using osu.Framework.Graphics.Shapes;
+using osu.Framework.Layout;
 using osu.Game.Graphics;
 
 namespace osu.Game.Rulesets.Mania.Objects.Drawables.Pieces
@@ -65,6 +65,8 @@ namespace osu.Game.Rulesets.Mania.Objects.Drawables.Pieces
                     }
                 }
             };
+
+            AddLayout(subtractionCache);
         }
 
         protected override void LoadComplete()
@@ -100,15 +102,7 @@ namespace osu.Game.Rulesets.Mania.Objects.Drawables.Pieces
             }
         }
 
-        private readonly Cached subtractionCache = new Cached();
-
-        public override bool Invalidate(Invalidation invalidation = Invalidation.All, Drawable source = null, bool shallPropagate = true)
-        {
-            if ((invalidation & Invalidation.DrawSize) > 0)
-                subtractionCache.Invalidate();
-
-            return base.Invalidate(invalidation, source, shallPropagate);
-        }
+        private readonly LayoutValue subtractionCache = new LayoutValue(Invalidation.DrawSize);
 
         protected override void Update()
         {

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

@@ -5,7 +5,6 @@ using System;
 using System.Diagnostics;
 using System.Runtime.InteropServices;
 using osu.Framework.Allocation;
-using osu.Framework.Caching;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Batches;
 using osu.Framework.Graphics.OpenGL.Vertices;
@@ -14,6 +13,7 @@ using osu.Framework.Graphics.Shaders;
 using osu.Framework.Graphics.Textures;
 using osu.Framework.Input;
 using osu.Framework.Input.Events;
+using osu.Framework.Layout;
 using osu.Framework.Timing;
 using osuTK;
 using osuTK.Graphics;
@@ -43,6 +43,8 @@ namespace osu.Game.Rulesets.Osu.UI.Cursor
                 // -1 signals that the part is unusable, and should not be drawn
                 parts[i].InvalidationID = -1;
             }
+
+            AddLayout(partSizeCache);
         }
 
         [BackgroundDependencyLoader]
@@ -72,20 +74,12 @@ namespace osu.Game.Rulesets.Osu.UI.Cursor
             }
         }
 
-        private readonly Cached<Vector2> partSizeCache = new Cached<Vector2>();
+        private readonly LayoutValue<Vector2> partSizeCache = new LayoutValue<Vector2>(Invalidation.DrawInfo | Invalidation.RequiredParentSizeToFit | Invalidation.Presence);
 
         private Vector2 partSize => partSizeCache.IsValid
             ? partSizeCache.Value
             : (partSizeCache.Value = new Vector2(Texture.DisplayWidth, Texture.DisplayHeight) * DrawInfo.Matrix.ExtractScale().Xy);
 
-        public override bool Invalidate(Invalidation invalidation = Invalidation.All, Drawable source = null, bool shallPropagate = true)
-        {
-            if ((invalidation & (Invalidation.DrawInfo | Invalidation.RequiredParentSizeToFit | Invalidation.Presence)) > 0)
-                partSizeCache.Invalidate();
-
-            return base.Invalidate(invalidation, source, shallPropagate);
-        }
-
         /// <summary>
         /// The amount of time to fade the cursor trail pieces.
         /// </summary>
@@ -97,7 +91,7 @@ namespace osu.Game.Rulesets.Osu.UI.Cursor
         {
             base.Update();
 
-            Invalidate(Invalidation.DrawNode, shallPropagate: false);
+            Invalidate(Invalidation.DrawNode);
 
             const int fade_clock_reset_threshold = 1000000;
 

osu.Game.Rulesets.Taiko/Mods/TaikoModFlashlight.cs

@@ -2,8 +2,8 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using osu.Framework.Bindables;
-using osu.Framework.Caching;
 using osu.Framework.Graphics;
+using osu.Framework.Layout;
 using osu.Game.Rulesets.Mods;
 using osu.Game.Rulesets.Taiko.Objects;
 using osu.Game.Rulesets.Taiko.UI;
@@ -30,13 +30,15 @@ namespace osu.Game.Rulesets.Taiko.Mods
 
         private class TaikoFlashlight : Flashlight
         {
-            private readonly Cached flashlightProperties = new Cached();
+            private readonly LayoutValue flashlightProperties = new LayoutValue(Invalidation.DrawSize);
             private readonly TaikoPlayfield taikoPlayfield;
 
             public TaikoFlashlight(TaikoPlayfield taikoPlayfield)
             {
                 this.taikoPlayfield = taikoPlayfield;
                 FlashlightSize = new Vector2(0, getSizeFor(0));
+
+                AddLayout(flashlightProperties);
             }
 
             private float getSizeFor(int combo)
@@ -56,16 +58,6 @@ namespace osu.Game.Rulesets.Taiko.Mods
 
             protected override string FragmentShader => "CircularFlashlight";
 
-            public override bool Invalidate(Invalidation invalidation = Invalidation.All, Drawable source = null, bool shallPropagate = true)
-            {
-                if ((invalidation & Invalidation.DrawSize) > 0)
-                {
-                    flashlightProperties.Invalidate();
-                }
-
-                return base.Invalidate(invalidation, source, shallPropagate);
-            }
-
             protected override void Update()
             {
                 base.Update();

osu.Game/Graphics/Backgrounds/Triangles.cs

@@ -129,7 +129,7 @@ namespace osu.Game.Graphics.Backgrounds
         {
             base.Update();
 
-            Invalidate(Invalidation.DrawNode, shallPropagate: false);
+            Invalidate(Invalidation.DrawNode);
 
             if (CreateNewTriangles)
                 addTriangles(false);

osu.Game/Graphics/Containers/SectionsContainer.cs

@@ -6,6 +6,7 @@ using System.Linq;
 using osu.Framework.Bindables;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
+using osu.Framework.Layout;
 
 namespace osu.Game.Graphics.Containers
 {
@@ -142,15 +143,17 @@ namespace osu.Game.Graphics.Containers
 
         public void ScrollToTop() => scrollContainer.ScrollTo(0);
 
-        public override void InvalidateFromChild(Invalidation invalidation, Drawable source = null)
+        protected override bool OnInvalidate(Invalidation invalidation, InvalidationSource source)
         {
-            base.InvalidateFromChild(invalidation, source);
+            var result = base.OnInvalidate(invalidation, source);
 
-            if ((invalidation & Invalidation.DrawSize) != 0)
+            if (source == InvalidationSource.Child && (invalidation & Invalidation.DrawSize) != 0)
             {
-                if (source == ExpandableHeader) //We need to recalculate the positions if the ExpandableHeader changed its size
                 lastKnownScroll = -1;
+                result = true;
             }
+
+            return result;
         }
 
         private float lastKnownScroll;

osu.Game/Graphics/UserInterface/LineGraph.cs

@@ -4,11 +4,11 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using osu.Framework.Caching;
 using osuTK;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Lines;
+using osu.Framework.Layout;
 using osuTK.Graphics;
 
 namespace osu.Game.Graphics.UserInterface
@@ -83,17 +83,11 @@ namespace osu.Game.Graphics.UserInterface
                     PathRadius = 1
                 }
             });
+
+            AddLayout(pathCached);
         }
 
-        public override bool Invalidate(Invalidation invalidation = Invalidation.All, Drawable source = null, bool shallPropagate = true)
-        {
-            if ((invalidation & Invalidation.DrawSize) > 0)
-                pathCached.Invalidate();
-
-            return base.Invalidate(invalidation, source, shallPropagate);
-        }
-
-        private readonly Cached pathCached = new Cached();
+        private readonly LayoutValue pathCached = new LayoutValue(Invalidation.DrawSize);
 
         protected override void Update()
         {

osu.Game/Rulesets/UI/Scrolling/ScrollingHitObjectContainer.cs

@@ -6,6 +6,7 @@ using osu.Framework.Allocation;
 using osu.Framework.Bindables;
 using osu.Framework.Caching;
 using osu.Framework.Graphics;
+using osu.Framework.Layout;
 using osu.Game.Rulesets.Objects.Drawables;
 using osu.Game.Rulesets.Objects.Types;
 
@@ -19,11 +20,13 @@ namespace osu.Game.Rulesets.UI.Scrolling
         [Resolved]
         private IScrollingInfo scrollingInfo { get; set; }
 
-        private readonly Cached initialStateCache = new Cached();
+        private readonly LayoutValue initialStateCache = new LayoutValue(Invalidation.RequiredParentSizeToFit | Invalidation.DrawInfo);
 
         public ScrollingHitObjectContainer()
         {
             RelativeSizeAxes = Axes.Both;
+
+            AddLayout(initialStateCache);
         }
 
         [BackgroundDependencyLoader]
@@ -55,14 +58,6 @@ namespace osu.Game.Rulesets.UI.Scrolling
             return result;
         }
 
-        public override bool Invalidate(Invalidation invalidation = Invalidation.All, Drawable source = null, bool shallPropagate = true)
-        {
-            if ((invalidation & (Invalidation.RequiredParentSizeToFit | Invalidation.DrawInfo)) > 0)
-                initialStateCache.Invalidate();
-
-            return base.Invalidate(invalidation, source, shallPropagate);
-        }
-
         private float scrollLength;
 
         protected override void Update()

osu.Game/Screens/Edit/Compose/Components/DistanceSnapGrid.cs

@@ -3,10 +3,10 @@
 
 using System;
 using osu.Framework.Allocation;
-using osu.Framework.Caching;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Colour;
 using osu.Framework.Graphics.Containers;
+using osu.Framework.Layout;
 using osu.Game.Graphics;
 using osu.Game.Rulesets.Edit;
 using osuTK;
@@ -51,7 +51,7 @@ namespace osu.Game.Screens.Edit.Compose.Components
         [Resolved]
         private BindableBeatDivisor beatDivisor { get; set; }
 
-        private readonly Cached gridCache = new Cached();
+        private readonly LayoutValue gridCache = new LayoutValue(Invalidation.RequiredParentSizeToFit);
         private readonly double? endTime;
 
         /// <summary>
@@ -67,6 +67,8 @@ namespace osu.Game.Screens.Edit.Compose.Components
             StartTime = startTime;
 
             RelativeSizeAxes = Axes.Both;
+
+            AddLayout(gridCache);
         }
 
         protected override void LoadComplete()
@@ -92,14 +94,6 @@ namespace osu.Game.Screens.Edit.Compose.Components
             gridCache.Invalidate();
         }
 
-        public override bool Invalidate(Invalidation invalidation = Invalidation.All, Drawable source = null, bool shallPropagate = true)
-        {
-            if ((invalidation & Invalidation.RequiredParentSizeToFit) > 0)
-                gridCache.Invalidate();
-
-            return base.Invalidate(invalidation, source, shallPropagate);
-        }
-
         protected override void Update()
         {
             base.Update();

osu.Game/Screens/Menu/LogoVisualisation.cs

@@ -150,7 +150,7 @@ namespace osu.Game.Screens.Menu
                     frequencyAmplitudes[i] = 0;
             }
 
-            Invalidate(Invalidation.DrawNode, shallPropagate: false);
+            Invalidate(Invalidation.DrawNode);
         }
 
         protected override DrawNode CreateDrawNode() => new VisualisationDrawNode(this);

osu.Game/Screens/Multi/DrawableRoomPlaylistItem.cs

@@ -246,10 +246,11 @@ namespace osu.Game.Screens.Multi
                         FillMode = FillMode.Fill,
                         Beatmap = { BindTarget = Beatmap }
                     },
-                    new Container
+                    new FillFlowContainer
                     {
                         Depth = -1,
                         RelativeSizeAxes = Axes.Both,
+                        Direction = FillDirection.Horizontal,
                         // This makes the gradient not be perfectly horizontal, but diagonal at a ~40° angle
                         Shear = new Vector2(0.8f, 0),
                         Alpha = 0.5f,
@@ -259,7 +260,6 @@ namespace osu.Game.Screens.Multi
                             new Box
                             {
                                 RelativeSizeAxes = Axes.Both,
-                                RelativePositionAxes = Axes.Both,
                                 Colour = Color4.Black,
                                 Width = 0.4f,
                             },
@@ -267,26 +267,20 @@ namespace osu.Game.Screens.Multi
                             new Box
                             {
                                 RelativeSizeAxes = Axes.Both,
-                                RelativePositionAxes = Axes.Both,
                                 Colour = ColourInfo.GradientHorizontal(Color4.Black, new Color4(0f, 0f, 0f, 0.9f)),
                                 Width = 0.05f,
-                                X = 0.4f,
                             },
                             new Box
                             {
                                 RelativeSizeAxes = Axes.Both,
-                                RelativePositionAxes = Axes.Both,
                                 Colour = ColourInfo.GradientHorizontal(new Color4(0f, 0f, 0f, 0.9f), new Color4(0f, 0f, 0f, 0.1f)),
                                 Width = 0.2f,
-                                X = 0.45f,
                             },
                             new Box
                             {
                                 RelativeSizeAxes = Axes.Both,
-                                RelativePositionAxes = Axes.Both,
                                 Colour = ColourInfo.GradientHorizontal(new Color4(0f, 0f, 0f, 0.1f), new Color4(0, 0, 0, 0)),
                                 Width = 0.05f,
-                                X = 0.65f,
                             },
                         }
                     }

osu.Game/Screens/Play/SquareGraph.cs

@@ -6,7 +6,6 @@ using System.Collections.Generic;
 using System.Linq;
 using System.Threading;
 using osu.Framework;
-using osu.Framework.Caching;
 using osu.Framework.Extensions.Color4Extensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
@@ -14,6 +13,7 @@ using osuTK;
 using osuTK.Graphics;
 using osu.Framework.Graphics.Shapes;
 using osu.Framework.Allocation;
+using osu.Framework.Layout;
 using osu.Framework.Threading;
 
 namespace osu.Game.Screens.Play
@@ -22,6 +22,11 @@ namespace osu.Game.Screens.Play
     {
         private BufferedContainer<Column> columns;
 
+        public SquareGraph()
+        {
+            AddLayout(layout);
+        }
+
         public int ColumnCount => columns?.Children.Count ?? 0;
 
         private int progress;
@@ -68,14 +73,7 @@ namespace osu.Game.Screens.Play
             }
         }
 
-        public override bool Invalidate(Invalidation invalidation = Invalidation.All, Drawable source = null, bool shallPropagate = true)
-        {
-            if ((invalidation & Invalidation.DrawSize) > 0)
-                layout.Invalidate();
-            return base.Invalidate(invalidation, source, shallPropagate);
-        }
-
-        private readonly Cached layout = new Cached();
+        private readonly LayoutValue layout = new LayoutValue(Invalidation.DrawSize);
         private ScheduledDelegate scheduledCreate;
 
         protected override void Update()

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

@@ -159,11 +159,11 @@ namespace osu.Game.Screens.Select.Carousel
                         Origin = Anchor.Centre,
                         FillMode = FillMode.Fill,
                     },
-                    // Todo: This should be a fill flow, but has invalidation issues (see https://github.com/ppy/osu-framework/issues/223)
-                    new Container
+                    new FillFlowContainer
                     {
                         Depth = -1,
                         RelativeSizeAxes = Axes.Both,
+                        Direction = FillDirection.Horizontal,
                         // This makes the gradient not be perfectly horizontal, but diagonal at a ~40° angle
                         Shear = new Vector2(0.8f, 0),
                         Alpha = 0.5f,
@@ -173,7 +173,6 @@ namespace osu.Game.Screens.Select.Carousel
                             new Box
                             {
                                 RelativeSizeAxes = Axes.Both,
-                                RelativePositionAxes = Axes.Both,
                                 Colour = Color4.Black,
                                 Width = 0.4f,
                             },
@@ -181,26 +180,20 @@ namespace osu.Game.Screens.Select.Carousel
                             new Box
                             {
                                 RelativeSizeAxes = Axes.Both,
-                                RelativePositionAxes = Axes.Both,
                                 Colour = ColourInfo.GradientHorizontal(Color4.Black, new Color4(0f, 0f, 0f, 0.9f)),
                                 Width = 0.05f,
-                                X = 0.4f,
                             },
                             new Box
                             {
                                 RelativeSizeAxes = Axes.Both,
-                                RelativePositionAxes = Axes.Both,
                                 Colour = ColourInfo.GradientHorizontal(new Color4(0f, 0f, 0f, 0.9f), new Color4(0f, 0f, 0f, 0.1f)),
                                 Width = 0.2f,
-                                X = 0.45f,
                             },
                             new Box
                             {
                                 RelativeSizeAxes = Axes.Both,
-                                RelativePositionAxes = Axes.Both,
                                 Colour = ColourInfo.GradientHorizontal(new Color4(0f, 0f, 0f, 0.1f), new Color4(0, 0, 0, 0)),
                                 Width = 0.05f,
-                                X = 0.65f,
                             },
                         }
                     },

osu.Game/osu.Game.csproj

@@ -23,7 +23,7 @@
     <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite.Core" Version="2.2.6" />
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
     <PackageReference Include="ppy.osu.Game.Resources" Version="2020.221.0" />
-    <PackageReference Include="ppy.osu.Framework" Version="2020.229.0" />
+    <PackageReference Include="ppy.osu.Framework" Version="2020.302.0" />
     <PackageReference Include="Sentry" Version="2.0.3" />
     <PackageReference Include="SharpCompress" Version="0.24.0" />
     <PackageReference Include="NUnit" Version="3.12.0" />

osu.iOS.props

@@ -71,7 +71,7 @@
   </ItemGroup>
   <ItemGroup Label="Package References">
     <PackageReference Include="ppy.osu.Game.Resources" Version="2020.221.0" />
-    <PackageReference Include="ppy.osu.Framework.iOS" Version="2020.229.0" />
+    <PackageReference Include="ppy.osu.Framework.iOS" Version="2020.302.0" />
   </ItemGroup>
   <!-- Xamarin.iOS does not automatically handle transitive dependencies from NuGet packages. -->
   <ItemGroup Label="Transitive Dependencies">
@@ -79,7 +79,7 @@
     <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="2.2.6" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite.Core" Version="2.2.6" />
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
-    <PackageReference Include="ppy.osu.Framework" Version="2020.229.0" />
+    <PackageReference Include="ppy.osu.Framework" Version="2020.302.0" />
     <PackageReference Include="SharpCompress" Version="0.24.0" />
     <PackageReference Include="NUnit" Version="3.12.0" />
     <PackageReference Include="SharpRaven" Version="2.4.0" />