com.wallstop-studios.unity-helpers 2.0.0-rc77.7 → 2.0.0-rc77.8

package/Runtime/Visuals/AnimatedSpriteLayer.cs

@@ -0,0 +1,130 @@
+namespace WallstopStudios.UnityHelpers.Visuals
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Linq;
+    using UnityEngine;
+    using WallstopStudios.UnityHelpers.Core.Extension;
+    using WallstopStudios.UnityHelpers.Core.Helper;
+
+    public readonly struct AnimatedSpriteLayer : IEquatable<AnimatedSpriteLayer>
+    {
+        public const float FrameRate = 12f;
+
+        public readonly Vector2[] perFramePixelOffsets;
+        public readonly Sprite[] frames;
+        public readonly float alpha;
+
+        public AnimatedSpriteLayer(
+            IEnumerable<Sprite> sprites,
+            IEnumerable<Vector2> worldSpaceOffsets = null,
+            float alpha = 1
+        )
+        {
+            frames = sprites?.ToArray() ?? Array.Empty<Sprite>();
+            foreach (Sprite frame in frames)
+            {
+                if (frame == null)
+                {
+                    continue;
+                }
+
+                frame.texture.MakeReadable();
+                try
+                {
+                    frame.texture.GetPixel(0, 0);
+                }
+                catch (UnityException e)
+                {
+                    Debug.LogError(
+                        $"Texture '{frame.texture.name}' for sprite '{frame.name}' is not readable. Please enable Read/Write in its import settings. Error: {e.Message}"
+                    );
+                }
+            }
+
+            if (worldSpaceOffsets != null && frames is { Length: > 0 })
+            {
+                perFramePixelOffsets = worldSpaceOffsets
+                    .Zip(
+                        frames,
+                        (offset, frame) =>
+                            frame != null && frame.pixelsPerUnit > 0
+                                ? frame.pixelsPerUnit * offset
+                                : Vector2.zero
+                    )
+                    .ToArray();
+                if (Debug.isDebugBuild)
+                {
+                    Debug.Assert(
+                        perFramePixelOffsets.Length == frames.Length,
+                        $"Expected {frames.Length} sprite frames to match {perFramePixelOffsets.Length} offsets after processing."
+                    );
+                }
+            }
+            else
+            {
+                perFramePixelOffsets = null;
+            }
+
+            this.alpha = Mathf.Clamp01(alpha);
+        }
+
+        public AnimatedSpriteLayer(
+            AnimationClip clip,
+            IEnumerable<Vector2> worldSpaceOffsets = null,
+            float alpha = 1
+        )
+            : this(
+#if UNITY_EDITOR
+                clip.GetSpritesFromClip(),
+#else
+                Enumerable.Empty<Sprite>(),
+#endif
+                worldSpaceOffsets, alpha) { }
+
+        public static bool operator ==(AnimatedSpriteLayer left, AnimatedSpriteLayer right)
+        {
+            return left.Equals(right);
+        }
+
+        public static bool operator !=(AnimatedSpriteLayer left, AnimatedSpriteLayer right)
+        {
+            return !left.Equals(right);
+        }
+
+        public bool Equals(AnimatedSpriteLayer other)
+        {
+            bool equal = perFramePixelOffsets.AsSpan().SequenceEqual(other.perFramePixelOffsets);
+            if (!equal)
+            {
+                return false;
+            }
+
+            equal = frames.Length == other.frames.Length;
+            if (!equal)
+            {
+                return false;
+            }
+
+            for (int i = 0; i < frames.Length; ++i)
+            {
+                if (frames[i] != other.frames[i])
+                {
+                    return false;
+                }
+            }
+
+            return alpha.Equals(other.alpha);
+        }
+
+        public override bool Equals(object obj)
+        {
+            return obj is AnimatedSpriteLayer other && Equals(other);
+        }
+
+        public override int GetHashCode()
+        {
+            return Objects.ValueTypeHashCode(perFramePixelOffsets.Length, frames.Length, alpha);
+        }
+    }
+}

package/Runtime/Visuals/AnimatedSpriteLayer.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: e009b64529cc4ffab131f88c19107534
+timeCreated: 1752518837

package/Runtime/Visuals/UGUI/EnhancedImage.cs

@@ -0,0 +1,76 @@
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("WallstopStudios.UnityHelpers.Editor", AllInternalsVisible = true)]
+
+namespace WallstopStudios.UnityHelpers.Visuals.UGUI
+{
+    using UnityEngine;
+    using UnityEngine.Serialization;
+    using UnityEngine.UI;
+
+    public sealed class EnhancedImage : Image
+    {
+        private static readonly int ShapeMaskPropertyID = Shader.PropertyToID("_ShapeMask");
+        private static readonly int ColorPropertyID = Shader.PropertyToID("_Color");
+
+        public Color HdrColor
+        {
+            get => _hdrColor;
+            set
+            {
+                if (_hdrColor == value)
+                {
+                    return;
+                }
+                _hdrColor = value;
+                UpdateMaterialInstance();
+            }
+        }
+
+        // ShapeMask: This functionality mimics Unity's UI mask components, but works with custom materials
+        // To function, your image material must use a shader with a Texture2D property of this name, its
+        // alpha mapped to the sprite shader's alpha
+        [FormerlySerializedAs("shapeMask")]
+        [SerializeField]
+        internal Texture2D _shapeMask;
+
+        // HDR Color field that will override the base Image color if values set > 1
+        [FormerlySerializedAs("hdrColor")]
+        [SerializeField]
+        [ColorUsage(showAlpha: true, hdr: true)]
+        internal Color _hdrColor = Color.white;
+
+        protected override void Start()
+        {
+            base.Start();
+            UpdateMaterialInstance();
+        }
+
+        protected override void OnValidate()
+        {
+            base.OnValidate();
+            UpdateMaterialInstance();
+        }
+
+        private void UpdateMaterialInstance()
+        {
+            Material localMaterial = material;
+            if (localMaterial == null)
+            {
+                return;
+            }
+
+            Material materialInstance = new(localMaterial);
+            if (_shapeMask != null)
+            {
+                materialInstance.SetTexture(ShapeMaskPropertyID, _shapeMask);
+            }
+
+            materialInstance.SetColor(
+                ColorPropertyID,
+                _hdrColor.maxColorComponent > 1 ? _hdrColor : color
+            );
+            material = materialInstance;
+        }
+    }
+}

package/Runtime/Visuals/UGUI/EnhancedImage.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 472d8cff7f974d96a300628f2378d3a1
+timeCreated: 1752518479

package/Runtime/Visuals/UGUI.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: e6310918ad5249a588dafdbaef3b56d9
+timeCreated: 1752518413

package/Runtime/{UI → Visuals/UIToolkit}/LayeredImage.cs

@@ -1,137 +1,15 @@
-namespace WallstopStudios.UnityHelpers.UI
+namespace WallstopStudios.UnityHelpers.Visuals.UIToolkit
 {
     using System;
     using System.Collections.Generic;
     using System.Diagnostics;
     using System.Linq;
     using System.Threading.Tasks;
-    using Core.Extension;
-    using Core.Helper;
+    using UnityEditor;
     using UnityEngine;
     using UnityEngine.UIElements;
-    using Utils;
-    using Debug = UnityEngine.Debug;
-#if UNITY_EDITOR
-    using UnityEditor;
-#endif
-
-    public readonly struct AnimatedSpriteLayer : IEquatable<AnimatedSpriteLayer>
-    {
-        public const float FrameRate = 12f;
-
-        public readonly Vector2[] perFramePixelOffsets;
-        public readonly Sprite[] frames;
-        public readonly float alpha;
-
-        public AnimatedSpriteLayer(
-            IEnumerable<Sprite> sprites,
-            IEnumerable<Vector2> worldSpaceOffsets = null,
-            float alpha = 1
-        )
-        {
-            frames = sprites?.ToArray() ?? Array.Empty<Sprite>();
-            foreach (Sprite frame in frames)
-            {
-                if (frame == null)
-                {
-                    continue;
-                }
-
-                frame.texture.MakeReadable();
-                try
-                {
-                    frame.texture.GetPixel(0, 0);
-                }
-                catch (UnityException e)
-                {
-                    Debug.LogError(
-                        $"Texture '{frame.texture.name}' for sprite '{frame.name}' is not readable. Please enable Read/Write in its import settings. Error: {e.Message}"
-                    );
-                }
-            }
-
-            if (worldSpaceOffsets != null && frames is { Length: > 0 })
-            {
-                perFramePixelOffsets = worldSpaceOffsets
-                    .Zip(
-                        frames,
-                        (offset, frame) =>
-                            frame != null && frame.pixelsPerUnit > 0
-                                ? frame.pixelsPerUnit * offset
-                                : Vector2.zero
-                    )
-                    .ToArray();
-                Debug.Assert(
-                    perFramePixelOffsets.Length == frames.Length,
-                    $"Expected {frames.Length} sprite frames to match {perFramePixelOffsets.Length} offsets after processing."
-                );
-            }
-            else
-            {
-                perFramePixelOffsets = null;
-            }
-
-            this.alpha = Mathf.Clamp01(alpha);
-        }
-
-        public AnimatedSpriteLayer(
-            AnimationClip clip,
-            IEnumerable<Vector2> worldSpaceOffsets = null,
-            float alpha = 1
-        )
-            : this(
-#if UNITY_EDITOR
-                clip.GetSpritesFromClip(),
-#else
-                Enumerable.Empty<Sprite>(),
-#endif
-                worldSpaceOffsets, alpha) { }
-
-        public static bool operator ==(AnimatedSpriteLayer left, AnimatedSpriteLayer right)
-        {
-            return left.Equals(right);
-        }
-
-        public static bool operator !=(AnimatedSpriteLayer left, AnimatedSpriteLayer right)
-        {
-            return !left.Equals(right);
-        }
-
-        public bool Equals(AnimatedSpriteLayer other)
-        {
-            bool equal = perFramePixelOffsets.AsSpan().SequenceEqual(other.perFramePixelOffsets);
-            if (!equal)
-            {
-                return false;
-            }
-
-            equal = frames.Length == other.frames.Length;
-            if (!equal)
-            {
-                return false;
-            }
-
-            for (int i = 0; i < frames.Length; ++i)
-            {
-                if (frames[i] != other.frames[i])
-                {
-                    return false;
-                }
-            }
-
-            return alpha.Equals(other.alpha);
-        }
-
-        public override bool Equals(object obj)
-        {
-            return obj is AnimatedSpriteLayer other && Equals(other);
-        }
-
-        public override int GetHashCode()
-        {
-            return Objects.ValueTypeHashCode(perFramePixelOffsets.Length, frames.Length, alpha);
-        }
-    }
+    using WallstopStudios.UnityHelpers.Core.Helper;
+    using WallstopStudios.UnityHelpers.Utils;
 
     public sealed class LayeredImage : VisualElement
     {

package/Runtime/{UI → Visuals/UIToolkit}/MultiFileSelectorElement.cs

@@ -1,13 +1,13 @@
-namespace WallstopStudios.UnityHelpers.UI
+namespace WallstopStudios.UnityHelpers.Visuals.UIToolkit
 {
     using System;
     using System.Collections.Generic;
     using System.IO;
     using System.Linq;
-    using Core.Extension;
-    using Core.Helper;
     using UnityEngine;
     using UnityEngine.UIElements;
+    using WallstopStudios.UnityHelpers.Core.Extension;
+    using WallstopStudios.UnityHelpers.Core.Helper;
 
     public sealed class MultiFileSelectorElement : VisualElement
     {

package/Runtime/Visuals/UIToolkit.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: c946717a68e84eacab89e3d4efb2a37b
+timeCreated: 1752518403

package/Shaders/Materials/BackgroundMask-Material.mat

@@ -0,0 +1,59 @@
+%YAML 1.1
+%TAG !u! tag:unity3d.com,2011:
+--- !u!114 &-1479414424530981672
+MonoBehaviour:
+  m_ObjectHideFlags: 11
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 0}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: d0353a89b1f911e48b9e16bdc9f2e058, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  version: 7
+--- !u!21 &2100000
+Material:
+  serializedVersion: 8
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_Name: BackgroundMask-Material
+  m_Shader: {fileID: -6465566751694194690, guid: 5f547121767cdd84ab771a0950431148, type: 3}
+  m_Parent: {fileID: 0}
+  m_ModifiedSerializedProperties: 0
+  m_ValidKeywords: []
+  m_InvalidKeywords: []
+  m_LightmapFlags: 4
+  m_EnableInstancingVariants: 0
+  m_DoubleSidedGI: 0
+  m_CustomRenderQueue: -1
+  stringTagMap: {}
+  disabledShaderPasses: []
+  m_LockedProperties: 
+  m_SavedProperties:
+    serializedVersion: 3
+    m_TexEnvs:
+    - _MainTex:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - unity_Lightmaps:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - unity_LightmapsInd:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - unity_ShadowMasks:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    m_Ints: []
+    m_Floats: []
+    m_Colors:
+    - _Color: {r: 1, g: 1, b: 1, a: 1}
+  m_BuildTextureStacks: []

package/Shaders/Materials/BackgroundMask-Material.mat.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 2207cc8dbdd586d499b0da5e6e2ac282
+NativeFormatImporter:
+  externalObjects: {}
+  mainObjectFileID: 2100000
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Shaders/Materials.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 5e587563728a9344f940ef5a3e17cd53
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: