feat: external time controller

## [4.10.7](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.10.6...v4.10.7) (2025-01-14)

### Bug Fixes

* editor crashed on exit play mode (editor, windows) ([47ee45c](47ee45cbbe)), closes [#351](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/351)

Packages/manifest.json

@@ -1,6 +1,7 @@
 {
   "dependencies": {
     "com.coffee.development": "https://github.com/mob-sakai/Coffee.Internal.git?path=Packages/Development",
+    "com.coffee.minimal-resource": "https://github.com/mob-sakai/Coffee.Internal.git?path=Packages/MinimalResource",
     "com.coffee.nano-monitor": "https://github.com/mob-sakai/Coffee.Internal.git?path=Packages/NanoMonitor",
     "com.unity.ide.rider": "3.0.31",
     "com.unity.test-framework": "1.1.33",

Packages/packages-lock.json

@@ -5,7 +5,14 @@
       "depth": 0,
       "source": "git",
       "dependencies": {},
-      "hash": "4e5f735ccf956ee469b5014ae781068c49a2825d"
+      "hash": "52987fb6e66e7fc48498d8d164c3c8808de4de6b"
+    },
+    "com.coffee.minimal-resource": {
+      "version": "https://github.com/mob-sakai/Coffee.Internal.git?path=Packages/MinimalResource",
+      "depth": 0,
+      "source": "git",
+      "dependencies": {},
+      "hash": "52987fb6e66e7fc48498d8d164c3c8808de4de6b"
     },
     "com.coffee.nano-monitor": {
       "version": "https://github.com/mob-sakai/Coffee.Internal.git?path=Packages/NanoMonitor",
@@ -14,7 +21,7 @@
       "dependencies": {
         "com.unity.ugui": "1.0.0"
       },
-      "hash": "4e5f735ccf956ee469b5014ae781068c49a2825d"
+      "hash": "52987fb6e66e7fc48498d8d164c3c8808de4de6b"
     },
     "com.coffee.ui-particle": {
       "version": "file:src",

Packages/src/CHANGELOG.md

@@ -1,3 +1,25 @@
+## [4.10.7](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.10.6...v4.10.7) (2025-01-14)
+
+
+### Bug Fixes
+
+* editor crashed on exit play mode (editor, windows) ([47ee45c](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/47ee45cbbe651a8f87ca2b8a3948f8b88db8211e)), closes [#351](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/351)
+
+## [4.10.6](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.10.5...v4.10.6) (2025-01-03)
+
+
+### Bug Fixes
+
+* sub-emitter particles may not render correctly in certain scenarios ([8276684](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/8276684c3b1646f0490ed64557547ba15281664a)), closes [#348](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/348)
+* sub-emitter's `inherit velocity` module doubles at runtime ([67de3d1](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/67de3d1bd3e16dc9b564625cb990c53d75769506)), closes [#349](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/349)
+
+## [4.10.5](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.10.4...v4.10.5) (2024-12-23)
+
+
+### Bug Fixes
+
+* '3D' scale toggle in the inspector does not keep on reload ([934f4b8](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/934f4b8f1c61f8ff20228d0ebcea9f636a3758ed)), closes [#346](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/346)
+
 ## [4.10.4](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v4.10.3...v4.10.4) (2024-12-19)
 
 

Packages/src/Editor/UIParticleEditor.cs

@@ -28,6 +28,11 @@ namespace Coffee.UIExtensions
     [CanEditMultipleObjects]
     internal class UIParticleEditor : GraphicEditor
     {
+        internal class State : ScriptableSingleton<State>
+        {
+            public bool is3DScaleMode;
+        }
+
         //################################
         // Constant or Static Members.
         //################################
@@ -46,7 +51,6 @@ namespace Coffee.UIExtensions
         private static readonly GUIContent s_ContentPrimary = new GUIContent("Primary");
         private static readonly Regex s_RegexBuiltInGuid = new Regex(@"^0{16}.0{15}$", RegexOptions.Compiled);
         private static readonly List<Material> s_TempMaterials = new List<Material>();
-        private static bool s_XYZMode;
 
         private SerializedProperty _maskable;
         private SerializedProperty _scale3D;
@@ -60,6 +64,7 @@ namespace Coffee.UIExtensions
         private SerializedProperty _customViewSize;
         private ReorderableList _ro;
         private bool _showMax;
+        private bool _is3DScaleMode;
 
         private static readonly HashSet<Shader> s_Shaders = new HashSet<Shader>();
 #if UNITY_2018 || UNITY_2019
@@ -163,6 +168,19 @@ namespace Coffee.UIExtensions
                     uip.RefreshParticles(uip.particles);
                 }
             }
+
+            // Initialize 3D scale mode.
+            _is3DScaleMode = State.instance.is3DScaleMode;
+            if (!_is3DScaleMode)
+            {
+                var x = _scale3D.FindPropertyRelative("x");
+                var y = _scale3D.FindPropertyRelative("y");
+                var z = _scale3D.FindPropertyRelative("z");
+                _is3DScaleMode = !Mathf.Approximately(x.floatValue, y.floatValue) ||
+                                 !Mathf.Approximately(y.floatValue, z.floatValue) ||
+                                 y.hasMultipleDifferentValues ||
+                                 z.hasMultipleDifferentValues;
+            }
         }
 
         /// <summary>
@@ -181,7 +199,11 @@ namespace Coffee.UIExtensions
 
             // Scale
             EditorGUI.BeginDisabledGroup(!_meshSharing.hasMultipleDifferentValues && _meshSharing.intValue == 4);
-            s_XYZMode = DrawFloatOrVector3Field(_scale3D, s_XYZMode);
+            if (DrawFloatOrVector3Field(_scale3D, _is3DScaleMode) != _is3DScaleMode)
+            {
+                State.instance.is3DScaleMode = _is3DScaleMode = !_is3DScaleMode;
+            }
+
             EditorGUI.EndDisabledGroup();
 
             // AnimatableProperties

Packages/src/Runtime/Coffee.UIParticle.R.dll.meta

@@ -0,0 +1,33 @@
+fileFormatVersion: 2
+guid: 4d73b3825bf044d418ae21bb331d3902
+PluginImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  iconMap: {}
+  executionOrder: {}
+  defineConstraints: []
+  isPreloaded: 0
+  isOverridable: 1
+  isExplicitlyReferenced: 0
+  validateReferences: 1
+  platformData:
+  - first:
+      Any: 
+    second:
+      enabled: 1
+      settings: {}
+  - first:
+      Editor: Editor
+    second:
+      enabled: 0
+      settings:
+        DefaultValueInitialized: true
+  - first:
+      Windows Store Apps: WindowsStoreApps
+    second:
+      enabled: 0
+      settings:
+        CPU: AnyCPU
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

Packages/src/Runtime/Internal/Extensions/ComponentExtensions.cs

@@ -18,10 +18,10 @@ namespace Coffee.UIParticleInternal
         public static T[] GetComponentsInChildren<T>(this Component self, int depth)
             where T : Component
         {
-            var results = ListPool<T>.Rent();
+            var results = InternalListPool<T>.Rent();
             self.GetComponentsInChildren_Internal(results, depth);
             var array = results.ToArray();
-            ListPool<T>.Return(ref results);
+            InternalListPool<T>.Return(ref results);
             return array;
         }
 

Packages/src/Runtime/Internal/ProjectSettings/PreloadedProjectSettings.cs

@@ -133,6 +133,8 @@ namespace Coffee.UIParticleInternal
 #if UNITY_EDITOR
         private string _jsonText;
 
+        public static bool hasInstance => s_Instance;
+
         public static T instance
         {
             get

Packages/src/Runtime/Internal/Utilities/FastAction.cs

@@ -10,8 +10,9 @@ namespace Coffee.UIParticleInternal
     /// </summary>
     internal class FastActionBase<T>
     {
-        private static readonly ObjectPool<LinkedListNode<T>> s_NodePool =
-            new ObjectPool<LinkedListNode<T>>(() => new LinkedListNode<T>(default), _ => true, x => x.Value = default);
+        private static readonly InternalObjectPool<LinkedListNode<T>> s_NodePool =
+            new InternalObjectPool<LinkedListNode<T>>(() => new LinkedListNode<T>(default), _ => true,
+                x => x.Value = default);
 
         private readonly LinkedList<T> _delegates = new LinkedList<T>();
 

Packages/src/Runtime/Internal/Utilities/MaterialRepository.cs

@@ -15,7 +15,7 @@ namespace Coffee.UIParticleInternal
 
 #if UNITY_EDITOR
         [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.SubsystemRegistration)]
-        private static void Clear()
+        public static void Clear()
         {
             s_Repository.Clear();
         }

Packages/src/Runtime/Internal/Utilities/Misc.cs

@@ -1,6 +1,13 @@
+using System;
 using System.Diagnostics;
 using UnityEditor;
 using UnityEngine;
+using Object = UnityEngine.Object;
+#if UNITY_EDITOR && UNITY_2021_2_OR_NEWER
+using UnityEditor.SceneManagement;
+#elif UNITY_EDITOR
+using UnityEditor.Experimental.SceneManagement;
+#endif
 
 namespace Coffee.UIParticleInternal
 {
@@ -53,5 +60,17 @@ namespace Coffee.UIParticleInternal
             EditorUtility.SetDirty(obj);
 #endif
         }
+
+#if UNITY_EDITOR
+        public static T[] GetAllComponentsInPrefabStage<T>() where T : Component
+        {
+            var prefabStage = PrefabStageUtility.GetCurrentPrefabStage();
+            if (prefabStage == null) return Array.Empty<T>();
+
+            return prefabStage.prefabContentsRoot.GetComponentsInChildren<T>(true);
+        }
+
+        public static bool isBatchOrBuilding => Application.isBatchMode || BuildPipeline.isBuildingPlayer;
+#endif
     }
 }

Packages/src/Runtime/Internal/Utilities/ObjectPool.cs

@@ -6,15 +6,58 @@ namespace Coffee.UIParticleInternal
     /// <summary>
     /// Object pool.
     /// </summary>
-    internal class ObjectPool<T>
+    internal class InternalObjectPool<T> where T : class
     {
+#if UNITY_2021_1_OR_NEWER
+        private readonly Predicate<T> _onValid; // Delegate for checking if instances are valid
+        private readonly UnityEngine.Pool.ObjectPool<T> _pool;
+
+        public InternalObjectPool(Func<T> onCreate, Predicate<T> onValid, Action<T> onReturn)
+        {
+            _pool = new UnityEngine.Pool.ObjectPool<T>(onCreate, null, onReturn);
+            _onValid = onValid;
+        }
+
+        /// <summary>
+        /// Rent an instance from the pool.
+        /// When you no longer need it, return it with <see cref="Return" />.
+        /// </summary>
+        public T Rent()
+        {
+            while (0 < _pool.CountInactive)
+            {
+                var instance = _pool.Get();
+                if (_onValid(instance))
+                {
+                    return instance;
+                }
+            }
+
+            // If there are no instances in the pool, create a new one.
+            Logging.Log(this, $"A new instance is created (pooled: {_pool.CountInactive}, created: {_pool.CountAll}).");
+            return _pool.Get();
+        }
+
+        /// <summary>
+        /// Return an instance to the pool and assign null.
+        /// Be sure to return the instance obtained with <see cref="Rent" /> with this method.
+        /// </summary>
+        public void Return(ref T instance)
+        {
+            if (instance == null) return; // Ignore if already pooled or null.
+
+            _pool.Release(instance);
+            Logging.Log(this, $"An instance is released (pooled: {_pool.CountInactive}, created: {_pool.CountAll}).");
+            instance = default; // Set the reference to null.
+        }
+#else
         private readonly Func<T> _onCreate; // Delegate for creating instances
         private readonly Action<T> _onReturn; // Delegate for returning instances to the pool
         private readonly Predicate<T> _onValid; // Delegate for checking if instances are valid
         private readonly Stack<T> _pool = new Stack<T>(32); // Object pool
         private int _count; // Total count of created instances
 
-        public ObjectPool(Func<T> onCreate, Predicate<T> onValid, Action<T> onReturn)
+        public InternalObjectPool(Func<T> onCreate, Predicate<T> onValid, Action<T> onReturn)
         {
             _onCreate = onCreate;
             _onValid = onValid;
@@ -54,15 +97,40 @@ namespace Coffee.UIParticleInternal
             Logging.Log(this, $"An instance is released (pooled: {_pool.Count}, created: {_count}).");
             instance = default; // Set the reference to null.
         }
+#endif
     }
 
     /// <summary>
     /// Object pool for <see cref="List{T}" />.
     /// </summary>
-    internal static class ListPool<T>
+    internal static class InternalListPool<T>
     {
-        private static readonly ObjectPool<List<T>> s_ListPool =
-            new ObjectPool<List<T>>(() => new List<T>(), _ => true, x => x.Clear());
+#if UNITY_2021_1_OR_NEWER
+        /// <summary>
+        /// Rent an instance from the pool.
+        /// When you no longer need it, return it with <see cref="Return" />.
+        /// </summary>
+        public static List<T> Rent()
+        {
+            return UnityEngine.Pool.ListPool<T>.Get();
+        }
+
+        /// <summary>
+        /// Return an instance to the pool and assign null.
+        /// Be sure to return the instance obtained with <see cref="Rent" /> with this method.
+        /// </summary>
+        public static void Return(ref List<T> toRelease)
+        {
+            if (toRelease != null)
+            {
+                UnityEngine.Pool.ListPool<T>.Release(toRelease);
+            }
+
+            toRelease = null;
+        }
+#else
+        private static readonly InternalObjectPool<List<T>> s_ListPool =
+            new InternalObjectPool<List<T>>(() => new List<T>(), _ => true, x => x.Clear());
 
         /// <summary>
         /// Rent an instance from the pool.
@@ -81,5 +149,6 @@ namespace Coffee.UIParticleInternal
         {
             s_ListPool.Return(ref toRelease);
         }
+#endif
     }
 }

Packages/src/Runtime/UIParticle.cs

@@ -577,12 +577,14 @@ namespace Coffee.UIExtensions
             {
                 var ps = particleSystems[i];
                 if (!ps) continue;
-                GetRenderer(j++).Set(this, ps, false);
+
+                var mainEmitter = ps.GetMainEmitter(particleSystems);
+                GetRenderer(j++).Set(this, ps, false, mainEmitter);
 
                 // If the trail is enabled, set it additionally.
                 if (ps.trails.enabled)
                 {
-                    GetRenderer(j++).Set(this, ps, true);
+                    GetRenderer(j++).Set(this, ps, true, mainEmitter);
                 }
             }
         }

Packages/src/Runtime/UIParticleRenderer.cs

@@ -40,6 +40,7 @@ namespace Coffee.UIExtensions
         private Vector2Int _prevScreenSize;
         private bool _preWarm;
         private ParticleSystemRenderer _renderer;
+        private ParticleSystem _mainEmitter;
 
         public override Texture mainTexture => _isTrail ? null : _particleSystem.GetTextureForSprite();
 
@@ -112,6 +113,7 @@ namespace Coffee.UIExtensions
             _parent = null;
             _particleSystem = null;
             _renderer = null;
+            _mainEmitter = null;
             if (0 <= index)
             {
                 _index = index;
@@ -223,7 +225,7 @@ namespace Coffee.UIExtensions
             return _modifiedMaterial;
         }
 
-        public void Set(UIParticle parent, ParticleSystem ps, bool isTrail)
+        public void Set(UIParticle parent, ParticleSystem ps, bool isTrail, ParticleSystem mainEmitter)
         {
             _parent = parent;
             maskable = parent.maskable;
@@ -246,10 +248,7 @@ namespace Coffee.UIExtensions
 
             ps.TryGetComponent(out _renderer);
             _renderer.enabled = false;
-
-            //_emitter = emitter;
             _isTrail = isTrail;
-
             _renderer.GetSharedMaterials(s_Materials);
             material = s_Materials[isTrail ? 1 : 0];
             s_Materials.Clear();
@@ -266,6 +265,7 @@ namespace Coffee.UIExtensions
             _prevScreenSize = new Vector2Int(Screen.width, Screen.height);
             _prevCanvasScale = canvas ? canvas.scaleFactor : 1f;
             _delay = true;
+            _mainEmitter = mainEmitter;
 
             canvasRenderer.SetTexture(null);
 
@@ -303,7 +303,7 @@ namespace Coffee.UIExtensions
 
             // Simulate particles.
             Profiler.BeginSample("[UIParticle] Bake Mesh > Simulate Particles");
-            if (!_isTrail && _parent.canSimulate)
+            if (!_isTrail && _parent.canSimulate && !_mainEmitter)
             {
 #if UNITY_EDITOR
                 if (!Application.isPlaying)
@@ -421,7 +421,7 @@ namespace Coffee.UIExtensions
                     workerMesh.LinearToGamma();
                 }
 
-                var components = ListPool<Component>.Rent();
+                var components = InternalListPool<Component>.Rent();
                 GetComponents(typeof(IMeshModifier), components);
                 for (var i = 0; i < components.Count; i++)
                 {
@@ -430,7 +430,7 @@ namespace Coffee.UIExtensions
 #pragma warning restore CS0618 // Type or member is obsolete
                 }
 
-                ListPool<Component>.Return(ref components);
+                InternalListPool<Component>.Return(ref components);
             }
 
             Profiler.EndSample();
@@ -442,7 +442,7 @@ namespace Coffee.UIExtensions
 
             // Get grouped renderers.
             Profiler.BeginSample("[UIParticleRenderer] Set Mesh");
-            var renderers = ListPool<UIParticleRenderer>.Rent();
+            var renderers = InternalListPool<UIParticleRenderer>.Rent();
             if (_parent.useMeshSharing)
             {
                 UIParticleUpdater.GetGroupedRenderers(_parent.groupId, _index, renderers);
@@ -459,7 +459,7 @@ namespace Coffee.UIExtensions
                 r.canvasRenderer.SetMaterial(materialForRendering, 0);
             }
 
-            ListPool<UIParticleRenderer>.Return(ref renderers);
+            InternalListPool<UIParticleRenderer>.Return(ref renderers);
 
             if (_parent.canRender)
             {
@@ -548,6 +548,24 @@ namespace Coffee.UIExtensions
                                * Matrix4x4.Scale(scale)
                                * Matrix4x4.Translate(-psPos);
                     }
+
+                    if (_mainEmitter)
+                    {
+                        if (_mainEmitter.IsLocalSpace())
+                        {
+                            return Matrix4x4.Translate(psPos)
+                                   * Matrix4x4.Scale(scale)
+                                   * Matrix4x4.Translate(-psPos);
+                        }
+                        else
+                        {
+                            psPos = _particleSystem.transform.position - _mainEmitter.transform.position;
+                            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))
@@ -608,7 +626,7 @@ namespace Coffee.UIExtensions
             var deltaTime = paused
                 ? 0
                 : main.useUnscaledTime
-                    ? Time.unscaledDeltaTime
+                    ? 0
                     : Time.deltaTime;
 
             // Pre-warm:

Packages/src/Runtime/UIParticleUpdater.cs

@@ -40,13 +40,26 @@ namespace Coffee.UIExtensions
 
 #if UNITY_EDITOR
         [InitializeOnLoadMethod]
+        private static void InitializeOnLoad()
+        {
+            UIExtraCallbacks.onAfterCanvasRebuild += Refresh;
+
+            EditorApplication.playModeStateChanged += state =>
+            {
+                UIExtraCallbacks.onAfterCanvasRebuild -= Refresh;
+                if (state == PlayModeStateChange.EnteredEditMode || state == PlayModeStateChange.EnteredPlayMode)
+                {
+                    UIExtraCallbacks.onAfterCanvasRebuild += Refresh;
+                }
+            };
+        }
 #else
         [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)]
-#endif
         private static void InitializeOnLoad()
         {
             UIExtraCallbacks.onAfterCanvasRebuild += Refresh;
         }
+#endif
 
         private static void Refresh()
         {

Packages/src/Runtime/Utilities/ParticleSystemExtensions.cs

@@ -171,5 +171,30 @@ namespace Coffee.UIParticleInternal
                 action.Invoke(p);
             }
         }
+
+        public static ParticleSystem GetMainEmitter(this ParticleSystem self, List<ParticleSystem> list)
+        {
+            if (!self || list == null || list.Count == 0) return null;
+
+            for (var i = 0; i < list.Count; i++)
+            {
+                var parent = list[i];
+                if (parent != self && IsSubEmitterOf(self, parent)) return parent;
+            }
+
+            return null;
+        }
+
+        public static bool IsSubEmitterOf(this ParticleSystem self, ParticleSystem parent)
+        {
+            var subEmitters = parent.subEmitters;
+            var count = subEmitters.subEmittersCount;
+            for (var i = 0; i < count; i++)
+            {
+                if (subEmitters.GetSubEmitterSystem(i) == self) return true;
+            }
+
+            return false;
+        }
     }
 }

Packages/src/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.4",
+  "version": "4.10.7",
   "unity": "2018.2",
   "license": "MIT",
   "repository": {

ProjectSettings/MinimalResourceSettings.json

@@ -0,0 +1,11 @@
+{
+    "MonoBehaviour": {
+        "m_Enabled": true,
+        "m_EditorHideFlags": 0,
+        "m_Name": "",
+        "m_EditorClassIdentifier": "",
+        "m_OutputDllPaths": [
+            "Packages/com.coffee.ui-particle/Runtime/Coffee.UIParticle.R.dll"
+        ]
+    }
+}