com.wallstop-studios.unity-helpers 2.0.0-rc12 → 2.0.0-rc14

package/Runtime/Core/Random/XorShiroRandom.cs

@@ -0,0 +1,117 @@
+namespace UnityHelpers.Core.Random
+{
+    using System;
+    using System.Runtime.CompilerServices;
+    using System.Text.Json.Serialization;
+    using Extension;
+    using Helper;
+
+    public sealed class XorShiroRandom
+        : AbstractRandom,
+            IEquatable<XorShiroRandom>,
+            IComparable,
+            IComparable<XorShiroRandom>
+    {
+        public override RandomState InternalState => new(_s0, _s1, _cachedGaussian);
+
+        internal ulong _s0;
+        internal ulong _s1;
+
+        public XorShiroRandom()
+            : this(Guid.NewGuid()) { }
+
+        public XorShiroRandom(Guid guid)
+        {
+            byte[] bytes = guid.ToByteArray();
+            _s0 = BitConverter.ToUInt64(bytes, 0);
+            _s1 = BitConverter.ToUInt64(bytes, 8);
+        }
+
+        public XorShiroRandom(ulong seed1, ulong seed2)
+        {
+            _s0 = seed1;
+            _s1 = seed2;
+        }
+
+        [JsonConstructor]
+        public XorShiroRandom(RandomState internalState)
+        {
+            _s0 = internalState.State1;
+            _s1 = internalState.State2;
+            _cachedGaussian = internalState.Gaussian;
+        }
+
+        public override uint NextUint()
+        {
+            unchecked
+            {
+                ulong s0 = _s0;
+                ulong s1 = _s1;
+                ulong result = s0 + s1;
+
+                s1 ^= s0;
+                _s0 = Rotl(s0, 24) ^ s1 ^ (s1 << 16);
+                _s1 = Rotl(s1, 37);
+
+                return (uint)result;
+            }
+        }
+
+        public override IRandom Copy()
+        {
+            return new XorShiroRandom(InternalState);
+        }
+
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        private static ulong Rotl(ulong x, int k)
+        {
+            return (x << k) | (x >> (64 - k));
+        }
+
+        public override bool Equals(object obj)
+        {
+            return Equals(obj as XorShiroRandom);
+        }
+
+        public bool Equals(XorShiroRandom other)
+        {
+            if (other == null)
+            {
+                return false;
+            }
+
+            return _s0 == other._s0 && _s1 == other._s1;
+        }
+
+        public override int GetHashCode()
+        {
+            return Objects.ValueTypeHashCode(_s0, _s1);
+        }
+
+        public override string ToString()
+        {
+            return this.ToJson();
+        }
+
+        public int CompareTo(object obj)
+        {
+            return CompareTo(obj as XorShiroRandom);
+        }
+
+        public int CompareTo(XorShiroRandom other)
+        {
+            if (other == null)
+            {
+                return -1;
+            }
+
+            int comparison = _s0.CompareTo(other._s0);
+            if (comparison != 0)
+            {
+                return comparison;
+            }
+
+            return _s1.CompareTo(other._s1);
+        }
+    }
+}

package/Runtime/Core/Random/XorShiroRandom.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 1252767904fc4f4bb2a8a876964f2dfc
+timeCreated: 1735610452

package/Runtime/UI/LayeredImage.cs

@@ -0,0 +1,364 @@
+namespace UnityHelpers.UI
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Diagnostics;
+    using System.Linq;
+    using System.Threading;
+    using System.Threading.Tasks;
+    using Core.Extension;
+    using Core.Helper;
+    using UnityEditor;
+    using UnityEngine;
+    using UnityEngine.UIElements;
+    using Utils;
+    using Debug = UnityEngine.Debug;
+
+    public readonly struct AnimatedSpriteLayer
+    {
+        public const float FrameRate = 12f;
+
+        public readonly Vector2[] offsets;
+        public readonly Sprite[] frames;
+        public readonly float alpha;
+
+        public AnimatedSpriteLayer(
+            IEnumerable<Sprite> sprites,
+            IEnumerable<Vector2> offsets,
+            float alpha = 1
+        )
+        {
+            frames = sprites?.ToArray() ?? Array.Empty<Sprite>();
+            foreach (Sprite frame in frames)
+            {
+                if (frame == null)
+                {
+                    continue;
+                }
+
+                frame.texture.MakeReadable();
+            }
+
+            this.offsets =
+                offsets?.Zip(frames, (offset, frame) => frame.pixelsPerUnit * offset).ToArray()
+                ?? Array.Empty<Vector2>();
+            Debug.Assert(
+                this.offsets.Length == frames.Length,
+                $"Expected {frames.Length} to match {this.offsets.Length}"
+            );
+            this.alpha = Mathf.Clamp01(alpha);
+        }
+
+        public AnimatedSpriteLayer(
+            AnimationClip clip,
+            IEnumerable<Vector2> offsets,
+            float alpha = 1
+        )
+            : this(
+#if UNITY_EDITOR
+                clip.GetSpritesFromClip(),
+#else
+                Enumerable.Empty<Sprite>(),
+#endif
+                offsets, alpha) { }
+    }
+
+    public sealed class LayeredImage : VisualElement
+    {
+        private readonly AnimatedSpriteLayer[] _layers;
+        private readonly Texture2D[] _computed;
+        private readonly Color _backgroundColor;
+
+        private readonly Rect? _largestArea;
+
+        public LayeredImage(
+            IEnumerable<AnimatedSpriteLayer> inputSpriteLayers,
+            Color? backgroundColor = null,
+            float fps = AnimatedSpriteLayer.FrameRate
+        )
+        {
+            _layers = inputSpriteLayers.ToArray();
+            _backgroundColor = backgroundColor ?? Color.white;
+            _computed = ComputeTextures().ToArray();
+            _largestArea = null;
+            foreach (Texture2D computed in _computed)
+            {
+                if (_largestArea == null)
+                {
+                    _largestArea = new Rect(0, 0, computed.width, computed.height);
+                }
+                else
+                {
+                    Rect largestArea = _largestArea.Value;
+                    largestArea.width = Mathf.Max(largestArea.width, computed.width);
+                    largestArea.height = Mathf.Max(largestArea.height, computed.height);
+                    _largestArea = largestArea;
+                }
+            }
+
+            Render(0);
+            float fpsMs = 1000f / fps;
+            if (1 < _computed.Length)
+            {
+#if UNITY_EDITOR
+                if (!Application.isPlaying)
+                {
+                    TimeSpan lastTick = TimeSpan.Zero;
+                    TimeSpan fpsSpan = TimeSpan.FromMilliseconds(fpsMs);
+                    int index = 0;
+                    Stopwatch timer = Stopwatch.StartNew();
+                    EditorApplication.update += () =>
+                    {
+                        TimeSpan elapsed = timer.Elapsed;
+                        if (lastTick + fpsSpan < elapsed)
+                        {
+                            index = index.WrappedIncrement(_computed.Length);
+                            lastTick = elapsed;
+                            Render(index);
+                        }
+                    };
+                    return;
+                }
+
+#endif
+                {
+                    int index = 0;
+                    CoroutineHandler.Instance.StartFunctionAsCoroutine(
+                        () =>
+                        {
+                            index = index.WrappedIncrement(_computed.Length);
+                            Render(index);
+                        },
+                        1f / fps
+                    );
+                }
+            }
+        }
+
+        private void Render(int index)
+        {
+            Texture2D computed = _computed[index];
+            if (computed != null)
+            {
+                style.backgroundImage = computed;
+                style.width = computed.width;
+                style.height = computed.height;
+            }
+
+            style.marginRight = 0;
+            style.marginBottom = 0;
+            if (_largestArea != null)
+            {
+                Rect largestArea = _largestArea.Value;
+                if (style.width.value.value < largestArea.width)
+                {
+                    style.marginRight = largestArea.width - style.width.value.value;
+                }
+
+                if (style.height.value.value < largestArea.height)
+                {
+                    style.marginBottom = largestArea.height - style.height.value.value;
+                }
+            }
+        }
+
+        private IEnumerable<Texture2D> ComputeTextures()
+        {
+            const float pixelCutoff = 0.01f;
+            int frameCount = _layers.Select(layer => layer.frames.Length).Distinct().Single();
+
+            Color transparent = Color.clear;
+            for (int frameIndex = 0; frameIndex < frameCount; ++frameIndex)
+            {
+                int minX = int.MaxValue;
+                int maxX = int.MinValue;
+                int minY = int.MaxValue;
+                int maxY = int.MinValue;
+                foreach (AnimatedSpriteLayer layer in _layers)
+                {
+                    if (!layer.frames.Any())
+                    {
+                        continue;
+                    }
+
+                    Sprite sprite = layer.frames[frameIndex];
+                    Vector2 offset = layer.offsets[frameIndex];
+                    Rect spriteRect = sprite.rect;
+
+                    int left = Mathf.RoundToInt(offset.x + spriteRect.xMin);
+                    int right = Mathf.RoundToInt(offset.x + spriteRect.xMax);
+                    int bottom = Mathf.RoundToInt(offset.y + spriteRect.yMin);
+                    int top = Mathf.RoundToInt(offset.y + spriteRect.yMax);
+
+                    minX = Mathf.Min(minX, left);
+                    maxX = Mathf.Max(maxX, right);
+                    minY = Mathf.Min(minY, bottom);
+                    maxY = Mathf.Max(maxY, top);
+                }
+
+                if (minX == int.MaxValue)
+                {
+                    continue;
+                }
+
+                // Calculate the width and height of the non-transparent region
+                int width = maxX - minX + 1;
+                int height = maxY - minY + 1;
+
+                Color[] pixels = new Color[width * height];
+                Array.Fill(pixels, Color.clear);
+
+                foreach (AnimatedSpriteLayer layer in _layers)
+                {
+                    if (!layer.frames.Any())
+                    {
+                        continue;
+                    }
+
+                    Sprite sprite = layer.frames[frameIndex];
+                    Vector2 offset = layer.offsets[frameIndex];
+                    float alpha = layer.alpha;
+                    int offsetX = Mathf.RoundToInt(offset.x);
+                    int offsetY = Mathf.RoundToInt(offset.y);
+                    Texture2D texture = sprite.texture;
+                    Rect spriteRect = sprite.rect;
+
+                    int spriteX = Mathf.RoundToInt(spriteRect.xMin);
+                    int spriteWidth = Mathf.RoundToInt(spriteRect.width);
+                    int spriteY = Mathf.RoundToInt(spriteRect.yMin);
+                    int spriteHeight = Mathf.RoundToInt(spriteRect.height);
+                    Color[] spritePixels = texture.GetPixels(
+                        spriteX,
+                        spriteY,
+                        spriteWidth,
+                        spriteHeight
+                    );
+
+                    Parallel.For(
+                        0,
+                        spritePixels.Length,
+                        inIndex =>
+                        {
+                            int x = inIndex % spriteWidth;
+                            int y = inIndex / spriteWidth;
+
+                            Color pixelColor = spritePixels[inIndex];
+                            if (pixelColor.a < pixelCutoff)
+                            {
+                                return;
+                            }
+
+                            int textureX = offsetX + x + spriteX;
+                            int textureY = offsetY + y + spriteY;
+                            int index = textureY * width + textureX;
+
+                            if (index < 0 || pixels.Length <= index)
+                            {
+                                return;
+                            }
+
+                            Color existingColor = pixels[index];
+                            if (existingColor == transparent)
+                            {
+                                existingColor = _backgroundColor;
+                            }
+
+                            Color blendedColor = Color.Lerp(existingColor, pixelColor, alpha);
+                            pixels[index] = blendedColor;
+                        }
+                    );
+                }
+
+                // Find the bounds of the non-transparent pixels in the temporary texture
+                int finalMinX = int.MaxValue;
+                int finalMaxX = int.MinValue;
+                int finalMinY = int.MaxValue;
+                int finalMaxY = int.MinValue;
+
+                Parallel.For(
+                    0,
+                    height * width,
+                    inIndex =>
+                    {
+                        Color pixelColor = pixels[inIndex];
+                        if (pixelColor.a < pixelCutoff)
+                        {
+                            return;
+                        }
+
+                        int x = inIndex % width;
+                        int y = inIndex / width;
+
+                        int expectedX = finalMinX;
+                        while (x < expectedX)
+                        {
+                            expectedX = Interlocked.CompareExchange(ref finalMinX, x, expectedX);
+                        }
+
+                        expectedX = finalMaxX;
+                        while (expectedX < x)
+                        {
+                            expectedX = Interlocked.CompareExchange(ref finalMaxX, x, expectedX);
+                        }
+
+                        int expectedY = finalMinY;
+                        while (y < expectedY)
+                        {
+                            expectedY = Interlocked.CompareExchange(ref finalMinY, y, expectedY);
+                        }
+
+                        expectedY = finalMaxY;
+                        while (expectedY < y)
+                        {
+                            expectedY = Interlocked.CompareExchange(ref finalMaxY, y, expectedY);
+                        }
+                    }
+                );
+
+                if (finalMinX == int.MaxValue)
+                {
+                    continue;
+                }
+
+                // Calculate the final width and height of the culled texture
+                int finalWidth = finalMaxX - finalMinX + 1;
+                int finalHeight = finalMaxY - finalMinY + 1;
+
+                Color[] finalPixels = new Color[finalWidth * finalHeight];
+                Array.Fill(finalPixels, _backgroundColor);
+
+                // Copy the non-transparent pixels from the temporary texture to the final texture
+                Parallel.For(
+                    0,
+                    finalWidth * finalHeight,
+                    inIndex =>
+                    {
+                        int x = inIndex % finalWidth;
+                        int y = inIndex / finalWidth;
+                        int outerX = x + finalMinX;
+                        int outerY = y + finalMinY;
+                        Color pixelColor = pixels[outerY * width + outerX];
+                        if (pixelColor.a < pixelCutoff)
+                        {
+                            return;
+                        }
+                        finalPixels[y * finalWidth + x] = pixelColor;
+                    }
+                );
+
+                Texture2D finalTexture = new(
+                    finalWidth,
+                    finalHeight,
+                    TextureFormat.RGBA32,
+                    mipChain: false,
+                    linear: false,
+                    createUninitialized: true
+                );
+                finalTexture.SetPixels(finalPixels);
+                finalTexture.Apply(false, false);
+
+                yield return finalTexture;
+            }
+        }
+    }
+}

package/Runtime/UI/LayeredImage.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: d4af7f20a66c40e686d59e4253d72156
+timeCreated: 1735605169

package/Runtime/UI.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: dd17cad9fb2348fa8249a668bc458174
+timeCreated: 1735605163

package/Tests/Runtime/Attributes/ChildComponentTests.cs

@@ -0,0 +1,81 @@
+namespace UnityHelpers.Tests.Attributes
+{
+    using System.Collections;
+    using System.Linq;
+    using Components;
+    using Core.Attributes;
+    using UnityEngine;
+    using UnityEngine.Assertions;
+    using UnityEngine.TestTools;
+
+    public sealed class ChildComponentTests
+    {
+        [UnityTest]
+        public IEnumerator Nominal()
+        {
+            GameObject parent = new("Parent-ChildComponentTest", typeof(SpriteRenderer));
+            GameObject baseGameObject = new(
+                "Base-ChildComponentTest",
+                typeof(SpriteRenderer),
+                typeof(ExpectChildSpriteRenderers)
+            );
+            baseGameObject.transform.SetParent(parent.transform);
+            GameObject childLevel1 = new("ChildLevel1", typeof(SpriteRenderer));
+            childLevel1.transform.SetParent(baseGameObject.transform);
+            GameObject childLevel2 = new("ChildLevel2", typeof(SpriteRenderer));
+            childLevel2.transform.SetParent(childLevel1.transform);
+            GameObject childLevel2Point1 = new("ChildLevel2.1", typeof(SpriteRenderer));
+            childLevel2Point1.transform.SetParent(childLevel1.transform);
+
+            ExpectChildSpriteRenderers expect =
+                baseGameObject.GetComponent<ExpectChildSpriteRenderers>();
+            expect.AssignChildComponents();
+
+            Assert.AreEqual(4, expect.exclusiveChildrenArray.Length);
+            Assert.AreEqual(4, expect.exclusiveChildrenList.Count);
+            Assert.IsTrue(
+                expect.exclusiveChildrenList.Contains(baseGameObject.GetComponent<SpriteRenderer>())
+            );
+            Assert.IsTrue(
+                expect.exclusiveChildrenList.Contains(childLevel1.GetComponent<SpriteRenderer>())
+            );
+            Assert.IsTrue(
+                expect.exclusiveChildrenList.Contains(childLevel2.GetComponent<SpriteRenderer>())
+            );
+            Assert.IsTrue(
+                expect.exclusiveChildrenList.Contains(
+                    childLevel2Point1.GetComponent<SpriteRenderer>()
+                )
+            );
+            Assert.IsTrue(
+                expect.exclusiveChildrenList.ToHashSet().SetEquals(expect.exclusiveChildrenArray)
+            );
+
+            Assert.AreEqual(3, expect.inclusiveChildrenArray.Length);
+            Assert.AreEqual(3, expect.inclusiveChildrenList.Count);
+
+            Assert.IsTrue(
+                expect.inclusiveChildrenList.Contains(childLevel1.GetComponent<SpriteRenderer>())
+            );
+            Assert.IsTrue(
+                expect.inclusiveChildrenList.Contains(childLevel2.GetComponent<SpriteRenderer>())
+            );
+            Assert.IsTrue(
+                expect.inclusiveChildrenList.Contains(
+                    childLevel2Point1.GetComponent<SpriteRenderer>()
+                )
+            );
+            Assert.IsTrue(
+                expect.inclusiveChildrenList.ToHashSet().SetEquals(expect.inclusiveChildrenArray)
+            );
+
+            Assert.IsTrue(expect.exclusiveChild != null);
+            Assert.AreEqual(expect.GetComponent<SpriteRenderer>(), expect.exclusiveChild);
+
+            Assert.IsTrue(expect.inclusiveChild != null);
+            Assert.AreEqual(childLevel1.GetComponent<SpriteRenderer>(), expect.inclusiveChild);
+
+            yield break;
+        }
+    }
+}

package/Tests/Runtime/Attributes/ChildComponentTests.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: cc73f4a11fc64edc872f700bc7a0a767
+timeCreated: 1735258003

package/Tests/Runtime/Attributes/Components/ExpectChildSpriteRenderers.cs

@@ -0,0 +1,28 @@
+namespace UnityHelpers.Tests.Attributes.Components
+{
+    using System.Collections.Generic;
+    using Core.Attributes;
+    using UnityEngine;
+
+    [DisallowMultipleComponent]
+    public sealed class ExpectChildSpriteRenderers : MonoBehaviour
+    {
+        [ChildComponent(onlyDescendents = true)]
+        public List<SpriteRenderer> inclusiveChildrenList;
+
+        [ChildComponent(onlyDescendents = false)]
+        public List<SpriteRenderer> exclusiveChildrenList;
+
+        [ChildComponent(onlyDescendents = true)]
+        public SpriteRenderer[] inclusiveChildrenArray;
+
+        [ChildComponent(onlyDescendents = false)]
+        public SpriteRenderer[] exclusiveChildrenArray;
+
+        [ChildComponent(onlyDescendents = true)]
+        public SpriteRenderer inclusiveChild;
+
+        [ChildComponent(onlyDescendents = false)]
+        public SpriteRenderer exclusiveChild;
+    }
+}

package/Tests/Runtime/Attributes/Components/ExpectChildSpriteRenderers.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: f61c01c0d3244332a29ca54076b3579d
+timeCreated: 1735258030

package/Tests/Runtime/Attributes/Components/ExpectParentSpriteRenderers.cs

@@ -0,0 +1,28 @@
+namespace UnityHelpers.Tests.Attributes.Components
+{
+    using System.Collections.Generic;
+    using Core.Attributes;
+    using UnityEngine;
+
+    [DisallowMultipleComponent]
+    public sealed class ExpectParentSpriteRenderers : MonoBehaviour
+    {
+        [ParentComponent(onlyAncestors = true)]
+        public List<SpriteRenderer> inclusiveParentList;
+
+        [ParentComponent(onlyAncestors = false)]
+        public List<SpriteRenderer> exclusiveParentList;
+
+        [ParentComponent(onlyAncestors = true)]
+        public SpriteRenderer[] inclusiveParentArray;
+
+        [ParentComponent(onlyAncestors = false)]
+        public SpriteRenderer[] exclusiveParentArray;
+
+        [ParentComponent(onlyAncestors = true)]
+        public SpriteRenderer inclusiveParent;
+
+        [ParentComponent(onlyAncestors = false)]
+        public SpriteRenderer exclusiveParent;
+    }
+}

package/Tests/Runtime/Attributes/Components/ExpectParentSpriteRenderers.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: d51b737f9e824f44be6d53ea0e4a4fa1
+timeCreated: 1735258037

package/Tests/Runtime/Attributes/Components.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: c960c544d65840d7bbf51747723b4195
+timeCreated: 1735258008