chore(release): 5.0.0-preview.11 [skip ci]

# [5.0.0-preview.11](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v5.0.0-preview.10...v5.0.0-preview.11) (2024-09-29)

### Features

* change the default value of `UIParticle.scale` from `10` to `1` ([4e188dd](4e188dd39e))
* UIParticle no longer inherits from MaskableGraphic ([52eb28c](52eb28cdaf))

### BREAKING CHANGES

* Some members inherited from MaskableGraphic will no longer be available.

CHANGELOG.md

@@ -1,16 +1,15 @@
-## [4.10.3](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.10.2...v4.10.3) (2024-11-20)
+# [5.0.0-preview.11](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v5.0.0-preview.10...v5.0.0-preview.11) (2024-09-29)
 
 
-### Bug Fixes
+### Features
 
-* if not configured as a preloaded asset, the project settings asset will be regenerated ([abe0948](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/abe09485f65dd4efd18e74675e752e0213bdf3be)), closes [#342](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/342)
-
-## [4.10.2](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.10.1...v4.10.2) (2024-11-01)
+* change the default value of `UIParticle.scale` from `10` to `1` ([4e188dd](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/4e188dd39ee32dd1339066a6946e43ba3580c324))
+* UIParticle no longer inherits from MaskableGraphic ([52eb28c](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/52eb28cdafe7c9009d5a4b76978e002798440e8d))
 
 
-### Bug Fixes
+### BREAKING CHANGES
 
-* trail incorrect offset ([afe00a1](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/afe00a1dde80eb1c0a7bb668b75f4c3733d3fa43)), closes [#335](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/335)
+* Some members inherited from MaskableGraphic will no longer be available.
 
 ## [4.10.1](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.10.0...v4.10.1) (2024-09-29)
 

Editor/UIParticleEditor.cs

@@ -2,7 +2,6 @@ using System.Collections.Generic;
 using System.Linq;
 using System.Text.RegularExpressions;
 using UnityEditor;
-using UnityEditor.UI;
 using UnityEditorInternal;
 using UnityEngine;
 using UnityEngine.Profiling;
@@ -26,7 +25,7 @@ namespace Coffee.UIExtensions
 {
     [CustomEditor(typeof(UIParticle))]
     [CanEditMultipleObjects]
-    internal class UIParticleEditor : GraphicEditor
+    internal class UIParticleEditor : Editor
     {
         //################################
         // Constant or Static Members.
@@ -81,10 +80,8 @@ namespace Coffee.UIExtensions
         /// <summary>
         /// This function is called when the object becomes enabled and active.
         /// </summary>
-        protected override void OnEnable()
+        private void OnEnable()
         {
-            base.OnEnable();
-
             _maskable = serializedObject.FindProperty("m_Maskable");
             _scale3D = serializedObject.FindProperty("m_Scale3D");
             _animatableProperties = serializedObject.FindProperty("m_AnimatableProperties");
@@ -437,9 +434,11 @@ namespace Coffee.UIExtensions
         {
             if (!p || (ignoreCurrent && target == p)) return;
 
-            var cr = p.canvasRenderer;
-            DestroyImmediate(p);
-            DestroyImmediate(cr);
+            Misc.DestroyImmediate(p);
+            if (p.TryGetComponent<CanvasRenderer>(out var cr))
+            {
+                Misc.DestroyImmediate(cr);
+            }
 
 #if UNITY_2018_3_OR_NEWER
             var stage = PrefabStageUtility.GetCurrentPrefabStage();

README.md

@@ -11,7 +11,7 @@
 [![](https://img.shields.io/github/watchers/mob-sakai/ParticleEffectForUGUI.svg?style=social&label=Watch)](https://github.com/mob-sakai/ParticleEffectForUGUI/subscription)
 [![](https://img.shields.io/twitter/follow/mob_sakai.svg?label=Follow&style=social)](https://twitter.com/intent/follow?screen_name=mob_sakai)
 
-<< [📝 Description](#-description-) | [📌 Key Features](#-key-features) | [🎮 Demo](#-demo) | [⚙ Installation](#-installation) | [🚀 Usage](#-usage) | [🛠 Development Note](#-development-note) | [🤝 Contributing](#-contributing) >>
+<< [📝 Description](#-description-) | [📌 Key Features](#-key-features) | [🎮 Demo](#-demo) | [⚙ Installation](#-installation) | [🔄 Upgrading to 5.x](#-upgrading-from-3x4x-to-5x) | [🚀 Usage](#-usage) | [🛠 Development Note](#-development-note) | [🤝 Contributing](#-contributing) >>
 
 ## 📝 Description <!-- omit in toc -->
 
@@ -27,6 +27,8 @@ You can render, mask, and sort your `ParticleSystems` for UI without the need fo
     - [Install via UPM (with Package Manager UI)](#install-via-upm-with-package-manager-ui)
     - [Install via UPM (Manually)](#install-via-upm-manually)
     - [Install as Embedded Package](#install-as-embedded-package)
+- [🔄 Upgrading from 3.x/4.x to 5.x](#-upgrading-from-3x4x-to-5x)
+  - [Breaking Changes](#breaking-changes)
 - [🚀 Usage](#-usage)
   - [Component: UIParticle](#component-uiparticle)
   - [Basic Usage](#basic-usage)
@@ -152,6 +154,17 @@ _This package requires **Unity 2018.3 or later**._
 
 <br><br>
 
+## 🔄 Upgrading from 3.x/4.x to 5.x
+
+### Breaking Changes
+
+- The default value of `UIParticle.scale` has been changed from `10` to `1`.
+- `UIParticle` no longer inherits from `MaskableGraphic`.
+- Add project settings for UIParticle
+  - enableLinearToGamma: Enables LinearToGamma during mesh baking
+
+<br><br>
+
 ## 🚀 Usage
 
 ### Component: UIParticle

Runtime/Internal/Extensions/ComponentExtensions.cs

@@ -134,35 +134,6 @@ namespace Coffee.UIParticleInternal
             Profiler.EndSample();
         }
 
-        /// <summary>
-        /// Add a component of a specific type to the children of a GameObject.
-        /// </summary>
-        public static void AddComponentOnChildren<T>(this Component self, bool includeSelf)
-            where T : Component
-        {
-            if (self == null) return;
-
-            Profiler.BeginSample("(COF)[ComponentExt] AddComponentOnChildren > Self");
-            if (includeSelf && !self.TryGetComponent<T>(out _))
-            {
-                self.gameObject.AddComponent<T>();
-            }
-
-            Profiler.EndSample();
-
-            Profiler.BeginSample("(COF)[ComponentExt] AddComponentOnChildren > Child");
-            var childCount = self.transform.childCount;
-            for (var i = 0; i < childCount; i++)
-            {
-                var child = self.transform.GetChild(i);
-                if (child.TryGetComponent<T>(out _)) continue;
-
-                child.gameObject.AddComponent<T>();
-            }
-
-            Profiler.EndSample();
-        }
-
 #if !UNITY_2021_2_OR_NEWER && !UNITY_2020_3_45 && !UNITY_2020_3_46 && !UNITY_2020_3_47 && !UNITY_2020_3_48
         public static T GetComponentInParent<T>(this Component self, bool includeInactive) where T : Component
         {

Runtime/Internal/Extensions/Misc.cs

@@ -6,15 +6,6 @@ namespace Coffee.UIParticleInternal
 {
     internal static class Misc
     {
-        public static T[] FindObjectsOfType<T>() where T : Object
-        {
-#if UNITY_2023_1_OR_NEWER
-            return Object.FindObjectsByType<T>(FindObjectsInactive.Include, FindObjectsSortMode.None);
-#else
-            return Object.FindObjectsOfType<T>();
-#endif
-        }
-
         public static void Destroy(Object obj)
         {
             if (!obj) return;

Runtime/Internal/Extensions/Misc.cs.meta

@@ -1,5 +1,5 @@
 fileFormatVersion: 2
-guid: 182319ecc315e4858b119764af0fbcb0
+guid: 39ed6a6b0a72e482488bd298b2ae762e
 MonoImporter:
   externalObjects: {}
   serializedVersion: 2

Runtime/Internal/ProjectSettings/PreloadedProjectSettings.cs

@@ -1,9 +1,9 @@
 using System;
 using System.Linq;
+using System.Reflection;
 using UnityEngine;
 using Object = UnityEngine.Object;
 #if UNITY_EDITOR
-using System.IO;
 using UnityEditor;
 using UnityEditor.Build;
 using UnityEditor.Build.Reporting;
@@ -14,14 +14,6 @@ namespace Coffee.UIParticleInternal
     public abstract class PreloadedProjectSettings : ScriptableObject
 #if UNITY_EDITOR
     {
-        private class Postprocessor : AssetPostprocessor
-        {
-            private static void OnPostprocessAllAssets(string[] _, string[] __, string[] ___, string[] ____)
-            {
-                Initialize();
-            }
-        }
-
         private class PreprocessBuildWithReport : IPreprocessBuildWithReport
         {
             int IOrderedCallback.callbackOrder => 0;
@@ -32,32 +24,32 @@ namespace Coffee.UIParticleInternal
             }
         }
 
+        [InitializeOnLoadMethod]
+        [InitializeOnEnterPlayMode]
         private static void Initialize()
         {
+            const BindingFlags flags = BindingFlags.Public | BindingFlags.Static | BindingFlags.FlattenHierarchy;
             foreach (var t in TypeCache.GetTypesDerivedFrom(typeof(PreloadedProjectSettings<>)))
             {
                 var defaultSettings = GetDefaultSettings(t);
                 if (!defaultSettings)
                 {
                     // When create a new instance, automatically set it as default settings.
-                    defaultSettings = CreateInstance(t) as PreloadedProjectSettings;
-                    SetDefaultSettings(defaultSettings);
+                    defaultSettings = t.GetProperty("instance", flags)
+                        ?.GetValue(null, null) as PreloadedProjectSettings;
                 }
                 else if (GetPreloadedSettings(t).Length != 1)
                 {
                     SetDefaultSettings(defaultSettings);
                 }
-
-                if (defaultSettings)
-                {
-                    defaultSettings.OnInitialize();
-                }
             }
+
+            EditorApplication.QueuePlayerLoopUpdate();
         }
 
         protected static string GetDefaultName(Type type, bool nicify)
         {
-            var typeName = type.Name;
+            var typeName = type.Name.Replace("ProjectSettings", "");
             return nicify
                 ? ObjectNames.NicifyVariableName(typeName)
                 : typeName;
@@ -82,7 +74,6 @@ namespace Coffee.UIParticleInternal
         protected static void SetDefaultSettings(PreloadedProjectSettings asset)
         {
             if (!asset) return;
-
             var type = asset.GetType();
             if (string.IsNullOrEmpty(AssetDatabase.GetAssetPath(asset)))
             {
@@ -93,11 +84,7 @@ namespace Coffee.UIParticleInternal
 
                 var assetPath = $"Assets/ProjectSettings/{GetDefaultName(type, false)}.asset";
                 assetPath = AssetDatabase.GenerateUniqueAssetPath(assetPath);
-                if (!File.Exists(assetPath))
-                {
-                    AssetDatabase.CreateAsset(asset, assetPath);
-                    asset.OnCreateAsset();
-                }
+                AssetDatabase.CreateAsset(asset, assetPath);
             }
 
             var preloadedAssets = PlayerSettings.GetPreloadedAssets();
@@ -111,14 +98,6 @@ namespace Coffee.UIParticleInternal
 
             AssetDatabase.Refresh();
         }
-
-        protected virtual void OnCreateAsset()
-        {
-        }
-
-        protected virtual void OnInitialize()
-        {
-        }
     }
 #else
     {

Runtime/Internal/Utilities/UIExtraCallbacks.cs

@@ -14,8 +14,6 @@ namespace Coffee.UIParticleInternal
         private static readonly FastAction s_AfterCanvasRebuildAction = new FastAction();
         private static readonly FastAction s_LateAfterCanvasRebuildAction = new FastAction();
         private static readonly FastAction s_BeforeCanvasRebuildAction = new FastAction();
-        private static readonly FastAction s_OnScreenSizeChangedAction = new FastAction();
-        private static Vector2Int s_LastScreenSize;
 
         static UIExtraCallbacks()
         {
@@ -50,15 +48,6 @@ namespace Coffee.UIParticleInternal
             remove => s_AfterCanvasRebuildAction.Remove(value);
         }
 
-        /// <summary>
-        /// Event that occurs when the screen size changes.
-        /// </summary>
-        public static event Action onScreenSizeChanged
-        {
-            add => s_OnScreenSizeChangedAction.Add(value);
-            remove => s_OnScreenSizeChangedAction.Remove(value);
-        }
-
         /// <summary>
         /// Initializes the UIExtraCallbacks to ensure proper event handling.
         /// </summary>
@@ -88,17 +77,6 @@ namespace Coffee.UIParticleInternal
         /// </summary>
         private static void OnBeforeCanvasRebuild()
         {
-            var screenSize = new Vector2Int(Screen.width, Screen.height);
-            if (s_LastScreenSize != screenSize)
-            {
-                if (s_LastScreenSize != default)
-                {
-                    s_OnScreenSizeChangedAction.Invoke();
-                }
-
-                s_LastScreenSize = screenSize;
-            }
-
             s_BeforeCanvasRebuildAction.Invoke();
             InitializeAfterCanvasRebuild();
         }

Runtime/UIParticle.cs

@@ -3,14 +3,12 @@ using System.Collections.Generic;
 using System.Runtime.CompilerServices;
 using Coffee.UIParticleInternal;
 using UnityEngine;
+using UnityEngine.EventSystems;
 using UnityEngine.Rendering;
 using UnityEngine.Serialization;
-using UnityEngine.UI;
 using Random = UnityEngine.Random;
 
 [assembly: InternalsVisibleTo("Coffee.UIParticle.Editor")]
-[assembly: InternalsVisibleTo("Coffee.UIParticle.PerformanceDemo")]
-[assembly: InternalsVisibleTo("Coffee.UIParticle.Demo")]
 
 namespace Coffee.UIExtensions
 {
@@ -20,7 +18,7 @@ namespace Coffee.UIExtensions
     [ExecuteAlways]
     [RequireComponent(typeof(RectTransform))]
     [RequireComponent(typeof(CanvasRenderer))]
-    public class UIParticle : MaskableGraphic, ISerializationCallbackReceiver
+    public class UIParticle : UIBehaviour, ISerializationCallbackReceiver
     {
         public enum AutoScalingMode
         {
@@ -62,7 +60,7 @@ namespace Coffee.UIExtensions
 
         [Tooltip("Scale the rendering particles. When the `3D` toggle is enabled, 3D scale (x, y, z) is supported.")]
         [SerializeField]
-        private Vector3 m_Scale3D = new Vector3(10, 10, 10);
+        private Vector3 m_Scale3D = new Vector3(1, 1, 1);
 
         [Tooltip("If you want to update material properties (e.g. _MainTex_ST, _Color) in AnimationClip, " +
                  "use this to mark as animatable.")]
@@ -119,20 +117,48 @@ namespace Coffee.UIExtensions
                  "Change the bake view size.")]
         private float m_CustomViewSize = 10;
 
+        [SerializeField]
+        private bool m_Maskable = true;
+
         private readonly List<UIParticleRenderer> _renderers = new List<UIParticleRenderer>();
         private Camera _bakeCamera;
+        private Canvas _canvas;
         private int _groupId;
         private bool _isScaleStored;
         private Vector3 _storedScale;
         private DrivenRectTransformTracker _tracker;
 
-        /// <summary>
-        /// Should this graphic be considered a target for ray-casting?
-        /// </summary>
-        public override bool raycastTarget
+        public RectTransform rectTransform => transform as RectTransform;
+
+        public Canvas canvas
         {
-            get => false;
-            set { }
+            get
+            {
+                if (_canvas) return _canvas;
+
+                var tr = transform;
+                while (tr && !_canvas)
+                {
+                    if (tr.TryGetComponent(out _canvas)) return _canvas;
+                    tr = tr.parent;
+                }
+
+                return null;
+            }
+        }
+
+        /// <summary>
+        /// Does this graphic allow masking.
+        /// </summary>
+        public bool maskable
+        {
+            get => m_Maskable;
+            set
+            {
+                if (value == m_Maskable) return;
+                m_Maskable = value;
+                UpdateRendererMaterial();
+            }
         }
 
         /// <summary>
@@ -309,15 +335,15 @@ namespace Coffee.UIExtensions
 
         public Vector3 parentScale { get; private set; }
 
-        public Vector3 canvasScale { get; private set; }
+        private Vector3 canvasScale { get; set; }
 
         protected override void OnEnable()
         {
             _isScaleStored = false;
             ResetGroupId();
             UIParticleUpdater.Register(this);
-            RegisterDirtyMaterialCallback(UpdateRendererMaterial);
 
+            //
             if (0 < particles.Count)
             {
                 RefreshParticles(particles);
@@ -327,7 +353,7 @@ namespace Coffee.UIExtensions
                 RefreshParticles();
             }
 
-            base.OnEnable();
+            UpdateRendererMaterial();
         }
 
         /// <summary>
@@ -344,9 +370,15 @@ namespace Coffee.UIExtensions
             _isScaleStored = false;
             UIParticleUpdater.Unregister(this);
             _renderers.ForEach(r => r.Reset());
-            UnregisterDirtyMaterialCallback(UpdateRendererMaterial);
+            _canvas = null;
+        }
 
-            base.OnDisable();
+        /// <summary>
+        /// Called when the state of the parent Canvas is changed.
+        /// </summary>
+        protected override void OnCanvasHierarchyChanged()
+        {
+            _canvas = null;
         }
 
         /// <summary>
@@ -356,6 +388,14 @@ namespace Coffee.UIExtensions
         {
         }
 
+        /// <summary>
+        /// This function is called when a direct or indirect parent of the transform of the GameObject has changed.
+        /// </summary>
+        protected override void OnTransformParentChanged()
+        {
+            _canvas = null;
+        }
+
         void ISerializationCallbackReceiver.OnBeforeSerialize()
         {
         }
@@ -648,17 +688,6 @@ namespace Coffee.UIExtensions
                 : Random.Range(m_GroupId, m_GroupMaxId + 1);
         }
 
-        protected override void UpdateMaterial()
-        {
-        }
-
-        /// <summary>
-        /// Call to update the geometry of the Graphic onto the CanvasRenderer.
-        /// </summary>
-        protected override void UpdateGeometry()
-        {
-        }
-
         private void UpdateRendererMaterial()
         {
             for (var i = 0; i < _renderers.Count; i++)

Runtime/UIParticleRenderer.cs

@@ -542,12 +542,6 @@ namespace Coffee.UIExtensions
                     return Matrix4x4.Translate(psPos)
                            * Matrix4x4.Scale(scale);
                 case ParticleSystemSimulationSpace.World:
-                    if (_isTrail)
-                    {
-                        return Matrix4x4.Translate(psPos)
-                               * Matrix4x4.Scale(scale)
-                               * Matrix4x4.Translate(-psPos);
-                    }
                     return Matrix4x4.Scale(scale);
                 case ParticleSystemSimulationSpace.Custom:
                     return Matrix4x4.Translate(_particleSystem.main.customSimulationSpace.position.GetScaled(scale))

Samples~/Demo/Scripts/UIParticle_Demo.cs

@@ -1,4 +1,3 @@
-using Coffee.UIParticleInternal;
 using UnityEngine;
 using UnityEngine.Serialization;
 using UnityEngine.UI;
@@ -52,7 +51,11 @@ namespace Coffee.UIExtensions.Demo
 
         public void EnableAnimations(bool flag)
         {
-            foreach (var animator in Misc.FindObjectsOfType<Animator>())
+#if UNITY_2023_1_OR_NEWER
+            foreach (var animator in FindObjectsByType<Animator>(FindObjectsInactive.Include, FindObjectsSortMode.None))
+#else
+            foreach (var animator in FindObjectsOfType<Animator>())
+#endif
             {
                 animator.enabled = flag;
             }
@@ -80,7 +83,11 @@ namespace Coffee.UIExtensions.Demo
 
         public void UIParticle_Scale(float scale)
         {
-            foreach (var uip in Misc.FindObjectsOfType<UIParticle>())
+#if UNITY_2023_1_OR_NEWER
+            foreach (var uip in FindObjectsByType<UIParticle>(FindObjectsInactive.Include, FindObjectsSortMode.None))
+#else
+            foreach (var uip in FindObjectsOfType<UIParticle>())
+#endif
             {
                 uip.scale = scale;
             }
@@ -88,7 +95,11 @@ namespace Coffee.UIExtensions.Demo
 
         public void ParticleSystem_WorldSpaseSimulation(bool flag)
         {
-            foreach (var p in Misc.FindObjectsOfType<ParticleSystem>())
+#if UNITY_2023_1_OR_NEWER
+            foreach (var p in FindObjectsByType<ParticleSystem>(FindObjectsInactive.Include, FindObjectsSortMode.None))
+#else
+            foreach (var p in FindObjectsOfType<ParticleSystem>())
+#endif
             {
                 var main = p.main;
                 main.simulationSpace = flag
@@ -124,7 +135,11 @@ namespace Coffee.UIExtensions.Demo
 
         public void ParticleSystem_SetScale(float scale)
         {
-            foreach (var ps in Misc.FindObjectsOfType<ParticleSystem>())
+#if UNITY_2023_1_OR_NEWER
+            foreach (var ps in FindObjectsByType<ParticleSystem>(FindObjectsInactive.Include, FindObjectsSortMode.None))
+#else
+            foreach (var ps in FindObjectsOfType<ParticleSystem>())
+#endif
             {
                 ps.transform.localScale = new Vector3(scale, scale, scale);
             }

package.json

@@ -2,7 +2,7 @@
   "name": "com.coffee.ui-particle",
   "displayName": "UI Particle",
   "description": "This package provides a component to render particle effects for uGUI.\nThe particle rendering is maskable and sortable, without the need for an extra Camera, RenderTexture, or Canvas.",
-  "version": "4.10.3",
+  "version": "5.0.0-preview.11",
   "unity": "2018.2",
   "license": "MIT",
   "repository": {