improved ui tests and added additional performance tests

MLEM.Ui/Elements/Element.cs

@@ -197,9 +197,10 @@ namespace MLEM.Ui.Elements {
             }
         }
         /// <summary>
-        /// This element's transform matrix.
+        /// This element's transform matrix, which is used for drawing and mouse/touch interaction. All children and grandchildren of this element will have this transform applied to them, along with their own transforms. This can be useful for briefly changing the visuals of an element when using a <see cref="UiAnimation"/>.
-        /// Can easily be scaled using <see cref="ScaleTransform"/>.
+        /// This matrix has no bearing on this element's permanent <see cref="DisplayArea"/> or <see cref="Scale"/>, as it is only applied "on the fly" in <see cref="Draw"/> and <see cref="TransformInverse"/>.
-        /// Note that, when this is non-null, a new <c>SpriteBatch.Begin</c> call is used for this element.
+        /// When this is anything other than <see cref="Matrix.Identity"/>, a new <c>SpriteBatch.Begin</c> call is used for this element when drawing.
+        /// This matrix can easily be scaled relative to its center or an arbitrary point using <see cref="ScaleTransform"/>.
         /// </summary>
         public Matrix Transform = Matrix.Identity;
         /// <summary>
@@ -1194,6 +1195,7 @@ namespace MLEM.Ui.Elements {
 
         /// <summary>
         /// Scales this element's <see cref="Transform"/> matrix based on the given scale and origin.
+        /// Please note the documentation for <see cref="Transform"/> for in-depth information about how this matrix is used.
         /// </summary>
         /// <param name="scale">The scale to use</param>
         /// <param name="origin">The origin to use for scaling, or null to use this element's center point</param>

Tests/UiTests.cs

@@ -32,7 +32,7 @@ public class UiTests {
         };
         invalidPanel.AddChild(new Paragraph(Anchor.AutoRight, 1, "This is some test text!", true));
         invalidPanel.AddChild(new VerticalSpace(1));
-        Assert.Throws<ArithmeticException>(() => this.AddAndUpdate(invalidPanel));
+        Assert.Throws<ArithmeticException>(() => this.AddAndUpdate(invalidPanel, out _, out _));
     }
 
     [Test]
@@ -40,7 +40,7 @@ public class UiTests {
         var oddPanel = new Panel(Anchor.Center, Vector2.One, Vector2.Zero, true) {SetWidthBasedOnChildren = true};
         oddPanel.AddChild(new Group(Anchor.TopCenter, new Vector2(100), false));
         oddPanel.AddChild(new Group(Anchor.AutoRight, new Vector2(120), false));
-        this.AddAndUpdate(oddPanel);
+        this.AddAndUpdate(oddPanel, out _, out _);
         Assert.AreEqual(120 + 10, oddPanel.DisplayArea.Width);
     }
 
@@ -60,7 +60,7 @@ public class UiTests {
                 CanBeMoused = false
             });
         }
-        this.AddAndUpdate(group);
+        this.AddAndUpdate(group, out _, out _);
 
         // group has 1 panel with 1 scroll bar, and the panel's 10 children
         Assert.AreEqual(1, group.GetChildren().Count());
@@ -89,7 +89,7 @@ public class UiTests {
         var el2 = parent.AddChild(new Button(Anchor.AutoLeft, new Vector2(0.25F, -0.5F)) {
             AutoSizeAddedAbsolute = new Vector2(-25, 50)
         });
-        this.AddAndUpdate(parent);
+        this.AddAndUpdate(parent, out _, out _);
 
         Assert.AreEqual(0.5F * 200 - 50, el1.DisplayArea.Width);
         Assert.AreEqual(0.75F * 100 + 25, el1.DisplayArea.Height);
@@ -118,8 +118,7 @@ public class UiTests {
     }
 
     [Test]
-    public void TestAutoAreaPerformance() {
+    public void TestAutoAreaPerformanceDeep() {
-        var stopwatch = new Stopwatch();
         for (var i = 1; i <= 100; i++) {
             var totalUpdates = 0;
             var main = new Group(Anchor.TopLeft, new Vector2(50)) {
@@ -131,20 +130,65 @@ public class UiTests {
                     OnAreaUpdated = _ => totalUpdates++
                 });
             }
-            stopwatch.Restart();
+            this.AddAndUpdate(main, out var addTime, out var updateTime);
-            this.AddAndUpdate(main);
-            stopwatch.Stop();
             var allChildren = main.GetChildren(regardGrandchildren: true);
-            TestContext.WriteLine($"{allChildren.Count()} children, {totalUpdates} updates total, took {stopwatch.Elapsed.TotalMilliseconds * 1000000}ns");
+            TestContext.WriteLine($"{allChildren.Count()} children, {totalUpdates} updates total, took {addTime.TotalMilliseconds * 1000000}ns to add, {updateTime.TotalMilliseconds * 1000000}ns to update");
         }
     }
 
-    private void AddAndUpdate(Element element) {
+    [Test]
+    public void TestAutoAreaPerformanceSideBySide() {
+        for (var i = 1; i <= 100; i++) {
+            var totalUpdates = 0;
+            var main = new Group(Anchor.TopLeft, new Vector2(50)) {
+                OnAreaUpdated = _ => totalUpdates++
+            };
+            for (var g = 0; g < i; g++) {
+                main.AddChild(new Group(Anchor.AutoInlineIgnoreOverflow, new Vector2(1F / i, 1)) {
+                    OnAreaUpdated = _ => totalUpdates++
+                });
+            }
+            this.AddAndUpdate(main, out var addTime, out var updateTime);
+            var allChildren = main.GetChildren(regardGrandchildren: true);
+            TestContext.WriteLine($"{allChildren.Count()} children, {totalUpdates} updates total, took {addTime.TotalMilliseconds * 1000000}ns to add, {updateTime.TotalMilliseconds * 1000000}ns to update");
+        }
+    }
+
+    [Test]
+    public void TestAutoAreaPerformanceRandom() {
+        for (var i = 0; i <= 1000; i += 10) {
+            var random = new Random(93829345);
+            var totalUpdates = 0;
+            var main = new Group(Anchor.TopLeft, new Vector2(50)) {
+                OnAreaUpdated = _ => totalUpdates++
+            };
+            var group = main;
+            for (var g = 0; g < i; g++) {
+                var newGroup = group.AddChild(new Group(Anchor.TopLeft, Vector2.One) {
+                    OnAreaUpdated = _ => totalUpdates++
+                });
+                if (random.NextSingle() <= 0.25F)
+                    group = newGroup;
+            }
+            this.AddAndUpdate(main, out var addTime, out var updateTime);
+            var allChildren = main.GetChildren(regardGrandchildren: true);
+            TestContext.WriteLine($"{allChildren.Count()} children, {totalUpdates} updates total, took {addTime.TotalMilliseconds * 1000000}ns to add, {updateTime.TotalMilliseconds * 1000000}ns to update");
+        }
+    }
+
+    private void AddAndUpdate(Element element, out TimeSpan addTime, out TimeSpan updateTime) {
         foreach (var root in this.game.UiSystem.GetRootElements())
             this.game.UiSystem.Remove(root.Name);
 
+        var stopwatch = Stopwatch.StartNew();
         this.game.UiSystem.Add("Test", element);
+        stopwatch.Stop();
+        addTime = stopwatch.Elapsed;
+
+        stopwatch.Restart();
         element.ForceUpdateArea();
+        stopwatch.Stop();
+        updateTime = stopwatch.Elapsed;
     }
 
 }