Merge pull request #1 from Thundernerd/develop

Added pooling for performance gains

Author: Thundernerd

.codacy.yml

@@ -0,0 +1,3 @@
+exclude_paths:
+    - '*.md'
+    - '*.json'

CHANGELOG.md

@@ -1,22 +1,26 @@
 # Changelog
 
+## [3.0.0] - 2020-08-02
+### Added
+- Pooling of Constrained Rect
+
 ## [2.1.0] - 2020-06-07
-## Added
+### Added
 - Options to center horizontally and vertically
 
 ## [2.0.2] - 2020-02-19
-## Fixed
+### Fixed
 - Incorrect naming of assembly definitions
 
 ## [2.0.1] - 2020-02-19
-## Fixed
+### Fixed
 - Tests assembly references
 
 ## [2.0.0] - 2020-02-17
-## Added
+### Added
 - Tests
 
-## Changed
+### Changed
 - Calculation method for left, top, right, bottom
 - Width and height no longer override right and bottom by default
 

Editor/Constrain.cs

@@ -12,7 +12,7 @@ public static ConstrainedRect To(EditorWindow editorWindow)
 
         public static ConstrainedRect To(Rect rect)
         {
-            return new ConstrainedRect(rect);
+            return ConstrainedRectPool.Create(rect);
         }
     }
-}
+}

Editor/ConstrainedRect.cs

@@ -4,7 +4,7 @@ namespace TNRD.Constraints
 {
     public class ConstrainedRect
     {
-        private readonly Rect parent;
+        private Rect parent;
 
         public Constraint Top { get; }
         public Constraint Bottom { get; }
@@ -16,39 +16,75 @@ public class ConstrainedRect
         private bool centerHorizontally;
         private bool centerVertically;
 
-        public ConstrainedRect(Rect parent)
-        {
-            this.parent = parent;
+        private bool isValid;
 
+        internal ConstrainedRect(Rect parent)
+        {
             Top = new Constraint(this, false);
             Bottom = new Constraint(this, true);
             Left = new Constraint(this, false);
             Right = new Constraint(this, true);
             Width = new Constraint(this, false);
             Height = new Constraint(this, false);
+
+            Reset(parent);
+        }
+
+        internal void Reset(Rect parent)
+        {
+            this.parent = parent;
+
+            Top.Reset();
+            Bottom.Reset();
+            Left.Reset();
+            Right.Reset();
+            Width.Reset();
+            Height.Reset();
+
+            isValid = true;
         }
 
         public Rect Relative(float value)
         {
+            ThrowIfInvalid();
             return Relative(value, value, value, value);
         }
 
         public Rect Relative(float left, float top, float right, float bottom)
         {
+            ThrowIfInvalid();
             return Left.Relative(left)
                 .Top.Relative(top)
                 .Right.Relative(right)
                 .Bottom.Relative(bottom)
                 .ToRect();
         }
 
+        public ConstrainedRect CenterHorizontally()
+        {
+            ThrowIfInvalid();
+            centerHorizontally = true;
+            return this;
+        }
+
+        public ConstrainedRect CenterVertically()
+        {
+            ThrowIfInvalid();
+            centerVertically = true;
+            return this;
+        }
+
         public Rect ToRect()
         {
-            float left = 0, top = 0, right = 0, bottom = 0;
+            ThrowIfInvalid();
+            float left, top, right, bottom;
 
             CalculateHorizontal(out left, out right);
             CalculateVertical(out top, out bottom);
 
+            ConstrainedRectPool.Return(this);
+            isValid = false;
+
             return new Rect(left, top, right, bottom);
         }
 
@@ -122,16 +158,12 @@ private void CalculateVertical(out float top, out float bottom)
             }
         }
 
-        public ConstrainedRect CenterHorizontally()
+        internal void ThrowIfInvalid()
         {
-            centerHorizontally = true;
-            return this;
-        }
+            if (isValid)
+                return;
 
-        public ConstrainedRect CenterVertically()
-        {
-            centerVertically = true;
-            return this;
+            throw new InvalidStateException();
         }
     }
 }

Editor/ConstrainedRectPool.cs

@@ -0,0 +1,34 @@
+using System.Collections.Generic;
+using UnityEngine;
+
+namespace TNRD.Constraints
+{
+    internal static class ConstrainedRectPool
+    {
+        private static List<ConstrainedRect> available = new List<ConstrainedRect>();
+
+        public static ConstrainedRect Create(Rect to)
+        {
+            if (available.Count == 0)
+            {
+                return CreateNew(to);
+            }
+
+            var constrainedRect = available[0];
+            available.Remove(constrainedRect);
+            constrainedRect.Reset(to);
+            return constrainedRect;
+        }
+
+        private static ConstrainedRect CreateNew(Rect to)
+        {
+            var constrainedRect = new ConstrainedRect(to);
+            return constrainedRect;
+        }
+
+        public static void Return(ConstrainedRect constrainedRect)
+        {
+            available.Add(constrainedRect);
+        }
+    }
+}

Editor/ConstrainedRectPool.cs.meta

@@ -21,35 +21,46 @@ private enum ConstrainMode
 
         public bool IsSet => mode != ConstrainMode.NotSet;
 
-        public Constraint(ConstrainedRect parent, bool negateValue)
+        internal Constraint(ConstrainedRect parent, bool negateValue)
         {
             this.parent = parent;
             this.negateValue = negateValue;
+            Reset();
+        }
+
+        internal void Reset()
+        {
+            mode = ConstrainMode.NotSet;
+            value = 0;
         }
 
         public ConstrainedRect Relative(float value)
         {
+            parent.ThrowIfInvalid();
             mode = ConstrainMode.Relative;
             this.value = value;
             return parent;
         }
 
         public ConstrainedRect Absolute(float value)
         {
+            parent.ThrowIfInvalid();
             mode = ConstrainMode.Absolute;
             this.value = value;
             return parent;
         }
 
         public ConstrainedRect Percentage(float value)
         {
+            parent.ThrowIfInvalid();
             mode = ConstrainMode.Percentage;
             this.value = value;
             return parent;
         }
 
         internal float Apply(float value)
         {
+            parent.ThrowIfInvalid();
             switch (mode)
             {
                 case ConstrainMode.Relative:

Editor/Constraint.cs

@@ -0,0 +1,12 @@
+using System;
+
+namespace TNRD.Constraints
+{
+    public class InvalidStateException : Exception
+    {
+        public InvalidStateException()
+            : base("The Constrained Rect that you're trying to modify has already been pooled and is no longer available for usage")
+        {
+        }
+    }
+}

Editor/InvalidStateException.cs

@@ -16,6 +16,17 @@
 
 Constrained Rect is a small helper that aims to make it easier to create Rect's based on existing ones.
 
+## Installation
+1. The package is available on the [openupm registry](https://openupm.com). You can install it via [openupm-cli](https://github.com/openupm/openupm-cli).
+```
+openupm add net.tnrd.constrainedrect
+```
+2. You can also install via git url by adding these entries in your **manifest.json**
+```json
+"net.tnrd.constrainedrect": "https://github.com/Thundernerd/Unity3D-ConstrainedRect.git"
+```
+
+
 ## Usage
 Using constrained rects is easy. You simply call `Constrain.To(...)` and pass it either a `Rect` or an `EditorWindow`.
 
@@ -59,20 +70,17 @@ private void Foo()
 }
 ```
 
-## Contributing
-Pull requests are welcomed. Please feel free to fix any issues you find, or add new features.
+### Important
+Due to the nature of Unity's editor architecture it is common to use Constrained Rects in high volume. In an attempt to prevent creating and collecting too much garbage as a result of using Constrained Rects they are now being pooled.
 
-## Installing
-Installing Constrained Rect into your Unity3D project is done through the [Package Manager](https://docs.unity3d.com/Manual/Packages.html).
+After you've finalized your Constrained Rect by calling `.ToRect()` the Constrained Rect will be returned to the pool and free to use for other instances. 
 
-You can either add the package manually to the [manifest.json](https://docs.unity3d.com/Manual/upm-dependencies.html) file:
-```json
-{
-    "dependencies": {
-        "net.tnrd.constrainedrect": "https://github.com/Thundernerd/Unity3D-ConstrainedRect.git"
-    }
-}
-```
+While all of this happens under the hood it is important to understand that from the moment that you call `.ToRect()` the Constrained Rect will throw an exception if it is not being used. This also means that if it is being used then the properties and variables might be different from what you might expect.
 
-Or add it through the UI by selecting the **+ button** in the top left of the Package Manager, selecting _Add package from git URL..._, and pasting https://github.com/Thundernerd/Unity3D-ConstrainedRect.git in the input field.
+## Support
+**Constrained Rect** is a small and open-source utility that I hope helps other people. It is by no means necessary but if you feel generous you can support me by donating.
 
+[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/J3J11GEYY)
+
+## Contributing
+Pull requests are welcomed. Please feel free to fix any issues you find, or add new features.