chore(release): 4.5.0 [skip ci]

# [4.5.0](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/4.4.0...4.5.0) (2023-12-23)

### Bug Fixes

* incorrect rendering of world-space simulated particles while animating scale ([ac58475](ac58475539)), closes [#285](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/285)
* remove obsolete warning ([5d5eb34](5d5eb34590))

### Features

* Automatically generated objects are no longer editable (NotEditable). ([5607dc4](5607dc4eed))
* support IMeshModifier ([5c3232f](5c3232faf3)), closes [#282](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/282)

CHANGELOG.md

@@ -1,3 +1,39 @@
+# [4.5.0](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/4.4.0...4.5.0) (2023-12-23)
+
+
+### Bug Fixes
+
+* incorrect rendering of world-space simulated particles while animating scale ([ac58475](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/ac584755393d87bda2e80d9653370b7e4c68912f)), closes [#285](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/285)
+* remove obsolete warning ([5d5eb34](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/5d5eb34590b7cefb0e4ac26c0441e104176ce522))
+
+
+### Features
+
+* Automatically generated objects are no longer editable (NotEditable). ([5607dc4](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/5607dc4eed0c086b4651941953df6c7d535712e0))
+* support IMeshModifier ([5c3232f](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/5c3232faf3d2cfad1e3e1a9349b8346c7982a608)), closes [#282](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/282)
+
+# [4.4.0](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/4.3.0...4.4.0) (2023-11-08)
+
+
+### Features
+
+* support 'Active Apply Color Space' for linear color space ([45c56bb](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/45c56bbd850202365751ea019baf5131b2eb9fbe))
+
+# [4.3.0](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/4.2.2...4.3.0) (2023-11-08)
+
+
+### Features
+
+* added 'autoScalingMode (None, Transform.localScale, UIParticle.scale)' instead of 'autoScaling' ([107f901](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/107f901fe3232223322681edc4bf908642474298))
+* reset transform.localScale on upgrading v3.x to v4.x ([c710787](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/c710787b5ba496cf73e7eb43458bb3958139baa9)), closes [#277](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/277)
+
+## [4.2.2](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/4.2.1...4.2.2) (2023-10-25)
+
+
+### Bug Fixes
+
+* il2cpp code stripping bug ([73f6dad](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/73f6dad0f33641a76ddd05ffc6812ced3f8a276d)), closes [#269](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/269)
+
 ## [4.2.1](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/4.2.0...4.2.1) (2023-08-18)
 
 

README.md

@@ -286,13 +286,13 @@ UIParticle does not support all built-in shaders except for `UI/Default`.
 If their use is detected, an error is displayed in the inspector.  
 Use UI shaders instead.
 
-#### UV.zw components will be discarded
+#### (2019.4 or earlier) UV.zw components will be discarded
 
 UIParticleRenderer renders the particles based on UIVertex.  
 Therefore, only xy components is available for each UV in the shader. (zw components will be discarded).  
 So unfortunately UIParticles will not work well with some shaders.  
 
-#### Custom vertex streams
+#### (2019.4 or earlier) Custom vertex streams
 
 When using custom vertex streams, you can fill zw components with "unnecessary" data.  
 https://github.com/mob-sakai/ParticleEffectForUGUI/issues/191

Scripts/Editor/UIParticleEditor.cs

@@ -70,7 +70,7 @@ namespace Coffee.UIExtensions
         private SerializedProperty _groupId;
         private SerializedProperty _groupMaxId;
         private SerializedProperty _positionMode;
-        private SerializedProperty _autoScaling;
+        private SerializedProperty _autoScalingMode;
         private ReorderableList _ro;
         private bool _showMax;
 
@@ -153,7 +153,7 @@ namespace Coffee.UIExtensions
             _groupId = serializedObject.FindProperty("m_GroupId");
             _groupMaxId = serializedObject.FindProperty("m_GroupMaxId");
             _positionMode = serializedObject.FindProperty("m_PositionMode");
-            _autoScaling = serializedObject.FindProperty("m_AutoScaling");
+            _autoScalingMode = serializedObject.FindProperty("m_AutoScalingMode");
 
             var sp = serializedObject.FindProperty("m_Particles");
             _ro = new ReorderableList(sp.serializedObject, sp, true, true, true, true)
@@ -271,7 +271,7 @@ namespace Coffee.UIExtensions
             EditorGUILayout.PropertyField(_positionMode);
 
             // Auto Scaling
-            DrawAutoScaling(_autoScaling, targets.OfType<UIParticle>());
+            DrawAutoScaling(_autoScalingMode, targets.OfType<UIParticle>());
 
             // Target ParticleSystems.
             EditorGUI.BeginChangeCheck();
@@ -332,8 +332,6 @@ namespace Coffee.UIExtensions
                 DestroyUIParticle(current);
             }
 
-            // #203: When using linear color space, the particle colors are not output correctly.
-            // To fix, set 'Apply Active Color Space' in renderer module to false.
             var allPsRenderers = targets.OfType<UIParticle>()
                 .SelectMany(x => x.particles)
                 .Where(x => x)
@@ -341,16 +339,6 @@ namespace Coffee.UIExtensions
                 .ToArray();
             if (0 < allPsRenderers.Length)
             {
-                var so = new SerializedObject(allPsRenderers);
-                var sp = so.FindProperty("m_ApplyActiveColorSpace");
-                label = "When using linear color space, the particle colors are not output correctly.\n" +
-                        "To fix, set 'Apply Active Color Space' in renderer module to false.";
-                if (FixButton(sp.boolValue || sp.hasMultipleDifferentValues, label))
-                {
-                    sp.boolValue = false;
-                    so.ApplyModifiedProperties();
-                }
-
                 // Check to use 'TEXCOORD*.zw' components as custom vertex stream.
                 foreach (var psr in allPsRenderers)
                 {
@@ -478,16 +466,17 @@ namespace Coffee.UIExtensions
 
         private static void DrawAutoScaling(SerializedProperty prop, IEnumerable<UIParticle> uiParticles)
         {
+            var isTransformMode = prop.intValue == (int)UIParticle.AutoScalingMode.Transform;
             EditorGUI.BeginChangeCheck();
             EditorGUILayout.PropertyField(prop);
-            if (!EditorGUI.EndChangeCheck()) return;
+            if (!EditorGUI.EndChangeCheck() || !isTransformMode) return;
 
             // on changed true->false, reset scale.
             EditorApplication.delayCall += () =>
             {
                 foreach (var uip in uiParticles)
                 {
-                    if (!uip || uip.autoScaling) continue;
+                    if (!uip) continue;
                     uip.transform.localScale = Vector3.one;
                 }
             };
@@ -509,7 +498,7 @@ namespace Coffee.UIExtensions
                     EditorGUILayout.PropertyField(s_SerializedObject.FindProperty("m_Enabled"));
                     s_XYZMode = DrawFloatOrVector3Field(s_SerializedObject.FindProperty("m_Scale3D"), s_XYZMode);
                     EditorGUILayout.PropertyField(s_SerializedObject.FindProperty("m_PositionMode"));
-                    DrawAutoScaling(s_SerializedObject.FindProperty("m_AutoScaling"), uiParticles);
+                    DrawAutoScaling(s_SerializedObject.FindProperty("m_AutoScalingMode"), uiParticles);
                     EditorGUIUtility.labelWidth = labelWidth;
                 }
 

Scripts/UIParticle.cs

@@ -1,13 +1,13 @@
-#if UNITY_2019_3_11 || UNITY_2019_3_12 || UNITY_2019_3_13 || UNITY_2019_3_14 || UNITY_2019_3_15 || UNITY_2019_4_OR_NEWER
+using System;
-#define SERIALIZE_FIELD_MASKABLE
-#endif
 using System.Collections.Generic;
 using System.Runtime.CompilerServices;
 using Coffee.UIParticleExtensions;
+using UnityEditor;
 using UnityEngine;
 using UnityEngine.Rendering;
 using UnityEngine.Serialization;
 using UnityEngine.UI;
+using Random = UnityEngine.Random;
 
 [assembly: InternalsVisibleTo("Coffee.UIParticle.Editor")]
 
@@ -36,6 +36,13 @@ namespace Coffee.UIExtensions
             Absolute
         }
 
+        public enum AutoScalingMode
+        {
+            None,
+            UIParticle,
+            Transform
+        }
+
         [HideInInspector]
         [SerializeField]
         internal bool m_IsTrail;
@@ -85,14 +92,17 @@ namespace Coffee.UIExtensions
         private PositionMode m_PositionMode = PositionMode.Relative;
 
         [SerializeField]
-        [Tooltip("Transform.lossyScale (=world scale) is automatically set to (1, 1, 1), " +
+        [Tooltip("Prevent the root-Canvas scale from affecting the hierarchy-scaled ParticleSystem.")]
-                 "to prevent the root-Canvas scale from affecting the hierarchy-scaled ParticleSystem.")]
         private bool m_AutoScaling = true;
 
-#if !SERIALIZE_FIELD_MASKABLE
         [SerializeField]
-        private bool m_Maskable = true;
+        [Tooltip("Transform: Transform.lossyScale (=world scale) will be set to (1, 1, 1)." +
-#endif
+                 "UIParticle: UIParticle.scale will be adjusted.")]
+        private AutoScalingMode m_AutoScalingMode = AutoScalingMode.Transform;
+
+        [SerializeField]
+        private bool m_ResetScaleOnEnable;
+
         private readonly List<UIParticleRenderer> _renderers = new List<UIParticleRenderer>();
         private int _groupId;
         private Camera _orthoCamera;
@@ -173,16 +183,30 @@ namespace Coffee.UIExtensions
         }
 
         /// <summary>
-        /// Transform.lossyScale (=world scale) will be set to (1, 1, 1) on update.
+        /// Prevents the root-Canvas scale from affecting the hierarchy-scaled ParticleSystem.
-        /// It prevents the root-Canvas scale from affecting the hierarchy-scaled ParticleSystem.
         /// </summary>
+        [Obsolete("The autoScaling is now obsolete. Please use the autoScalingMode instead.", false)]
         public bool autoScaling
         {
-            get { return m_AutoScaling; }
+            get { return m_AutoScalingMode != AutoScalingMode.None; }
             set
             {
-                if (m_AutoScaling == value) return;
+                autoScalingMode = value ? AutoScalingMode.Transform : AutoScalingMode.None;
-                m_AutoScaling = value;
+            }
+        }
+
+        /// <summary>
+        /// Auto scaling mode.
+        /// Transform: Transform.lossyScale (=world scale) will be set to (1, 1, 1).
+        /// UIParticle: UIParticle.scale will be adjusted.
+        /// </summary>
+        public AutoScalingMode autoScalingMode
+        {
+            get { return m_AutoScalingMode; }
+            set
+            {
+                if (m_AutoScalingMode == value) return;
+                m_AutoScalingMode = value;
                 UpdateTracker();
             }
         }
@@ -241,6 +265,14 @@ namespace Coffee.UIExtensions
             set { m_Scale3D = value; }
         }
 
+        /// <summary>
+        /// Particle effect scale.
+        /// </summary>
+        public Vector3 scale3DForCalc
+        {
+            get { return autoScalingMode == AutoScalingMode.UIParticle ? m_Scale3D.GetScaled(canvasScale) : m_Scale3D; }
+        }
+
         public List<ParticleSystem> particles
         {
             get { return m_Particles; }
@@ -274,11 +306,10 @@ namespace Coffee.UIExtensions
 
         public Vector3 parentScale { get; private set; }
 
+        public Vector3 canvasScale { get; private set; }
+
         protected override void OnEnable()
         {
-#if !SERIALIZE_FIELD_MASKABLE
-            maskable = m_Maskable;
-#endif
             ResetGroupId();
             UpdateTracker();
             UIParticleUpdater.Register(this);
@@ -294,6 +325,13 @@ namespace Coffee.UIExtensions
             }
 
             base.OnEnable();
+
+            // Reset scale for upgrade.
+            if (m_ResetScaleOnEnable)
+            {
+                m_ResetScaleOnEnable = false;
+                transform.localScale = Vector3.one;
+            }
         }
 
         /// <summary>
@@ -330,10 +368,22 @@ namespace Coffee.UIExtensions
 
         void ISerializationCallbackReceiver.OnAfterDeserialize()
         {
-            if (m_IgnoreCanvasScaler)
+            if (m_IgnoreCanvasScaler || m_AutoScaling)
             {
                 m_IgnoreCanvasScaler = false;
                 m_AutoScaling = false;
+                m_AutoScalingMode = AutoScalingMode.Transform;
+                m_ResetScaleOnEnable = true;
+
+#if UNITY_EDITOR
+                EditorApplication.delayCall += () =>
+                {
+                    if (!this || !gameObject || !transform) return;
+                    transform.localScale = Vector3.one;
+                    m_ResetScaleOnEnable = false;
+                    EditorUtility.SetDirty(this);
+                };
+#endif
             }
 
             if (m_AbsoluteMode)
@@ -481,8 +531,9 @@ namespace Coffee.UIExtensions
 
         internal void UpdateTransformScale()
         {
+            canvasScale = canvas.rootCanvas.transform.localScale.Inverse();
             parentScale = transform.parent.lossyScale;
-            if (!autoScaling) return;
+            if (autoScalingMode != AutoScalingMode.Transform) return;
 
             var newScale = parentScale.Inverse();
             if (transform.localScale != newScale)
@@ -596,7 +647,7 @@ namespace Coffee.UIExtensions
                 // Create ortho-camera.
                 if (!_orthoCamera)
                 {
-                    var go = new GameObject("[generated] UIParticleOverlayCamera") { hideFlags = HideFlags.DontSave };
+                    var go = new GameObject("[generated] UIParticleOverlayCamera") { hideFlags = HideFlags.DontSave | HideFlags.NotEditable };
                     go.SetActive(false);
                     go.transform.SetParent(transform, false);
                     _orthoCamera = go.AddComponent<Camera>();
@@ -616,7 +667,9 @@ namespace Coffee.UIExtensions
 
         private void UpdateTracker()
         {
-            if (!enabled || !autoScaling)
+#pragma warning disable CS0618 // Type or member is obsolete
+            if (!enabled || !autoScaling || autoScalingMode != AutoScalingMode.Transform)
+#pragma warning restore CS0618 // Type or member is obsolete
             {
                 _tracker.Clear();
             }

Scripts/UIParticleAttractor.cs

@@ -182,21 +182,22 @@ namespace Coffee.UIExtensions
             if (isUI)
             {
                 var inverseScale = _uiParticle.parentScale.Inverse();
-                dstPos = dstPos.GetScaled(inverseScale, _uiParticle.scale3D.Inverse());
+                var scale3d = _uiParticle.scale3DForCalc;
+                dstPos = dstPos.GetScaled(inverseScale, scale3d.Inverse());
 
                 // Relative mode
                 if (_uiParticle.positionMode == UIParticle.PositionMode.Relative)
                 {
                     var diff = _uiParticle.transform.position - psPos;
-                    diff.Scale(_uiParticle.scale3D - inverseScale);
+                    diff.Scale(scale3d - inverseScale);
-                    diff.Scale(_uiParticle.scale3D.Inverse());
+                    diff.Scale(scale3d.Inverse());
                     dstPos += diff;
                 }
 
 #if UNITY_EDITOR
                 if (!Application.isPlaying && !isLocalSpace)
                 {
-                    dstPos += psPos - psPos.GetScaled(inverseScale, _uiParticle.scale3D.Inverse());
+                    dstPos += psPos - psPos.GetScaled(inverseScale, scale3d.Inverse());
                 }
 #endif
             }

Scripts/UIParticleRenderer.cs

@@ -14,10 +14,12 @@ namespace Coffee.UIExtensions
     [AddComponentMenu("")]
     internal class UIParticleRenderer : MaskableGraphic
     {
+        private static readonly List<Component> s_Components = new List<Component>();
         private static readonly CombineInstance[] s_CombineInstances = { new CombineInstance() };
         private static readonly List<Material> s_Materials = new List<Material>(2);
         private static MaterialPropertyBlock s_Mpb;
         private static readonly List<UIParticleRenderer> s_Renderers = new List<UIParticleRenderer>();
+        private static readonly List<Color32> s_Colors = new List<Color32>();
         private static readonly Vector3[] s_Corners = new Vector3[4];
         private Material _currentMaterialForRendering;
         private bool _delay;
@@ -31,6 +33,7 @@ namespace Coffee.UIExtensions
         private Vector3 _prevPsPos;
         private Vector3 _prevScale;
         private Vector2Int _prevScreenSize;
+        private float _prevCanvasScale;
         private bool _prewarm;
         private ParticleSystemRenderer _renderer;
 
@@ -151,7 +154,7 @@ namespace Coffee.UIExtensions
             // Create renderer object.
             var go = new GameObject("[generated] UIParticleRenderer", typeof(UIParticleRenderer))
             {
-                hideFlags = HideFlags.DontSave,
+                hideFlags = HideFlags.DontSave | HideFlags.NotEditable,
                 layer = parent.gameObject.layer
             };
 
@@ -245,6 +248,7 @@ namespace Coffee.UIExtensions
             _prevScale = GetWorldScale();
             _prevPsPos = _particleSystem.transform.position;
             _prevScreenSize = new Vector2Int(Screen.width, Screen.height);
+            _prevCanvasScale = canvas ? canvas.scaleFactor : 1f;
             _delay = true;
             _prevParticleCount = 0;
 
@@ -260,7 +264,7 @@ namespace Coffee.UIExtensions
                 !isActiveAndEnabled || !_particleSystem || !_parent
                 || !canvasRenderer || !canvas || !bakeCamera
                 || _parent.meshSharing == UIParticle.MeshSharing.Replica
-                || !transform.lossyScale.GetScaled(_parent.scale3D).IsVisible() // Scale is not visible.
+                || !transform.lossyScale.GetScaled(_parent.scale3DForCalc).IsVisible() // Scale is not visible.
                 || (!_particleSystem.IsAlive() && !_particleSystem.isPlaying) // No particle.
                 || (_isTrail && !_particleSystem.trails.enabled) // Trail, but it is not enabled.
 #if UNITY_2018_3_OR_NEWER
@@ -380,6 +384,34 @@ namespace Coffee.UIExtensions
                 bounds.extents = extents;
                 workerMesh.bounds = bounds;
                 _lastBounds = bounds;
+
+                // Convert linear color to gamma color.
+                if (QualitySettings.activeColorSpace == ColorSpace.Linear)
+                {
+                    Profiler.BeginSample("[UIParticleRenderer] Convert Linear to Gamma");
+                    workerMesh.GetColors(s_Colors);
+                    var count_c = s_Colors.Count;
+                    for (var i = 0; i < count_c; i++)
+                    {
+                        var c = s_Colors[i];
+                        c.r = c.r.LinearToGamma();
+                        c.g = c.g.LinearToGamma();
+                        c.b = c.b.LinearToGamma();
+                        s_Colors[i] = c;
+                    }
+                    workerMesh.SetColors(s_Colors);
+                    Profiler.EndSample();
+                }
+
+                GetComponents(typeof(IMeshModifier), s_Components);
+                for (var i = 0; i < s_Components.Count; i++)
+                {
+#pragma warning disable CS0618 // Type or member is obsolete
+                    ((IMeshModifier)s_Components[i]).ModifyMesh(workerMesh);
+#pragma warning restore CS0618 // Type or member is obsolete
+                }
+
+                s_Components.Clear();
             }
 
             Profiler.EndSample();
@@ -462,7 +494,7 @@ namespace Coffee.UIExtensions
         private Vector3 GetWorldScale()
         {
             Profiler.BeginSample("[UIParticleRenderer] GetWorldScale");
-            var scale = _parent.scale3D.GetScaled(_parent.parentScale);
+            var scale = _parent.scale3DForCalc.GetScaled(_parent.parentScale);
             Profiler.EndSample();
             return scale;
         }
@@ -515,7 +547,8 @@ namespace Coffee.UIExtensions
         {
             var screenSize = new Vector2Int(Screen.width, Screen.height);
             var isWorldSpace = _particleSystem.IsWorldSpace();
-            var resolutionChanged = _prevScreenSize != screenSize || _prevScale != scale;
+            var canvasScale = _parent.canvas ? _parent.canvas.scaleFactor : 1f;
+            var resolutionChanged = _prevScreenSize != screenSize || _prevCanvasScale != canvasScale;
             if (resolutionChanged && isWorldSpace)
             {
                 // Update particle array size and get particles.
@@ -544,6 +577,7 @@ namespace Coffee.UIExtensions
                 _prevPsPos = psPos;
             }
 
+            _prevCanvasScale = canvas ? canvas.scaleFactor : 1f;
             _prevScreenSize = screenSize;
         }
 

Scripts/Utils.cs

@@ -6,6 +6,25 @@ using Object = UnityEngine.Object;
 
 namespace Coffee.UIParticleExtensions
 {
+    public static class Color32Extensions
+    {
+        private static byte[] s_LinearToGammaLut;
+
+        public static byte LinearToGamma(this byte self)
+        {
+            if (s_LinearToGammaLut == null)
+            {
+                s_LinearToGammaLut = new byte[256];
+                for (var i = 0; i < 256; i++)
+                {
+                    s_LinearToGammaLut[i] = (byte)(Mathf.LinearToGammaSpace(i / 255f) * 255f);
+                }
+            }
+
+            return s_LinearToGammaLut[self];
+        }
+    }
+
     public static class Vector3Extensions
     {
         public static Vector3 Inverse(this Vector3 self)

package.json

@@ -2,7 +2,7 @@
   "name": "com.coffee.ui-particle",
   "displayName": "UI Particle",
   "description": "This plugin provide a component to render particle effect for uGUI.\nThe particle rendering is maskable and sortable, without Camera, RenderTexture or Canvas.",
-  "version": "4.2.1",
+  "version": "4.5.0",
   "unity": "2018.2",
   "license": "MIT",
   "repository": {