chore(release): 3.3.0 [skip ci]

# [3.3.0](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/3.2.0...3.3.0) (2020-11-20)

### Bug Fixes

* the particles may disappear unintentionally ([2ec81da](2ec81da048)), closes [#117](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/117)

### Features

* ignore rendering of particle systems that do not have a SharedMaterial and TrailMaterial ([08c4aba](08c4aba8ab)), closes [#118](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/118)
* show/hide materials in inspector ([4b4aebf](4b4aebff8c))
* shrink rendering by material ([46a7ddd](46a7dddd11)), closes [#113](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/113)

.github/workflows/release.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches:
       - preview
-      - master
+      - main
       - v*.x
     tags-ignore:
       - "**"

CHANGELOG.md

@@ -1,3 +1,32 @@
+# [3.3.0](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/3.2.0...3.3.0) (2020-11-20)
+
+
+### Bug Fixes
+
+* the particles may disappear unintentionally ([2ec81da](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/2ec81da04877d63593dd863133b6da149dcd79e6)), closes [#117](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/117)
+
+
+### Features
+
+* ignore rendering of particle systems that do not have a SharedMaterial and TrailMaterial ([08c4aba](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/08c4aba8ab9b5a041d4350a72dae62d25530afca)), closes [#118](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/118)
+* show/hide materials in inspector ([4b4aebf](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/4b4aebff8cdaff9acc696a1094e170e65631135f))
+* shrink rendering by material ([46a7ddd](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/46a7dddd11c3e030192cd998ae1a79441f5e5c14)), closes [#113](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/113)
+
+# [3.2.0](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/3.1.1...3.2.0) (2020-11-15)
+
+
+### Features
+
+* compatibility with other IMaterialModifier ([08273cb](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/08273cb0c340ccb4f35120dc804c37d758da9ce1)), closes [#115](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/115)
+
+## [3.1.1](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/3.1.0...3.1.1) (2020-11-09)
+
+
+### Bug Fixes
+
+* error on build in Unity 2019.3.11-15 ([68669c7](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/68669c739676f2354db4913a0e2296ab1715ee1f)), closes [#114](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/114)
+* null Reference when creating New Scene after Prefab was open in PrefabMode ([22bcecd](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/22bcecd0abd6ad651fcf066e5c9efe9a43fd217a)), closes [#111](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/111)
+
 # [3.1.0](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/3.0.1...3.1.0) (2020-10-28)
 
 

README.md

@@ -60,7 +60,7 @@ Compares this "Baking mesh" approach with the conventional approach:
 
 ## Demo
 
-* [WebGL Demo](http://mob-sakai.github.io/ParticleEffectForUGUI)
+* [WebGL Demo](https://mob-sakai.github.io/Demos/ParticleEffectForUGUI)
 * [WebGL Demo (Cartoon FX & War FX)](https://mob-sakai.github.io/Demos/ParticleEffectForUGUI_CFX)
   * [Cartoon FX Free][CFX] & [War FX][WFX] (by [Jean Moreno (JMO)][JMO]) with UIParticle
 
@@ -95,14 +95,11 @@ openupm add com.coffee.ui-particle
 
 Find the manifest.json file in the Packages folder of your project and add a line to `dependencies` field.
 
-* Major version: ![](https://img.shields.io/github/v/release/mob-sakai/ParticleEffectForUGUI)  
-`"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git"`
-* Preview version: ![](https://img.shields.io/github/v/release/mob-sakai/ParticleEffectForUGUI?include_prereleases)  
-`"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git#preview"`
+* `"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git"`
 
 To update the package, change suffix `#{version}` to the target version.
 
-* e.g. `"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git#3.0.0",`
+* `"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git#3.3.0",`
 
 Or, use [UpmGitExtension](https://github.com/mob-sakai/UpmGitExtension) to install and update the package.
 
@@ -150,11 +147,16 @@ Unity 2018.2 supports embedded packages.
 
 `UIParticle` controls the ParticleSystems that is attached to its own game objects and child game objects.
 
-| Properties | Screenshot |
-| -- | -- |
-| **Ignore Canvas Scale:** Ignore the scale of the root canvas. This prevents it from displaying small even in hierarchy scaling mode of ParticleSystem. <br>**Scale:** Scale the rendering. When the `3D` toggle is enabled, 3D scale (x,y,z) is supported. <br>**AnimatableProperties:** If you want update material properties (e.g. `_MainTex_ST`, `_Color`) in AnimationClip, use this to mark the changes. <br>**Rendering Order:** The ParticleSystems to be rendered. You can change the rendering order and the materials. | ![][inspector] |
+![](https://user-images.githubusercontent.com/12690315/99765566-af129a80-2b42-11eb-88f6-661182d0b619.png)
 
-[inspector]:https://user-images.githubusercontent.com/12690315/95017219-1cea2c00-0693-11eb-9490-c52b8d0fdbb6.png
+| Properties | Description |
+| -- | -- |
+| Maskable | Does this graphic allow masking. |
+| Ignore Canvas Scale | Ignore the scale of the root canvas.<br>This prevents it from displaying small even in hierarchy scaling mode of `ParticleSystem`. |
+| Scale | Scale the rendering.<br>When the `3D` toggle is enabled, 3D scale (x,y,z) is supported. |
+| Animatable Properties | If you want update material properties (e.g. `_MainTex_ST`, `_Color`) in AnimationClip, use this to mark the changes. |
+| Shrink By Material | Shrink rendering by material.<br>Performance will be improved, but in some cases the rendering is not correct. |
+| Rendering Order | The ParticleSystems to be rendered.<br>You can change the rendering order and the materials. |
 
 NOTE: Press `Refresh` button to reconstruct rendering order based on children ParticleSystem's sorting order and z position.
 

Scripts/Editor/UIParticleEditor.cs

@@ -29,9 +29,11 @@ namespace Coffee.UIExtensions
         private SerializedProperty _spScale;
         private SerializedProperty _spIgnoreCanvasScaler;
         private SerializedProperty _spAnimatableProperties;
+        private SerializedProperty _spShrinkByMaterial;
 
         private ReorderableList _ro;
         private bool _xyzMode;
+        private bool _showMaterials;
 
         private static readonly List<string> s_MaskablePropertyNames = new List<string>
         {
@@ -57,10 +59,15 @@ namespace Coffee.UIExtensions
             _spScale = serializedObject.FindProperty("m_Scale3D");
             _spIgnoreCanvasScaler = serializedObject.FindProperty("m_IgnoreCanvasScaler");
             _spAnimatableProperties = serializedObject.FindProperty("m_AnimatableProperties");
+            _spShrinkByMaterial = serializedObject.FindProperty("m_ShrinkByMaterial");
+            _showMaterials = EditorPrefs.GetBool("Coffee.UIExtensions.UIParticleEditor._showMaterials", true);
 
             var sp = serializedObject.FindProperty("m_Particles");
             _ro = new ReorderableList(sp.serializedObject, sp, true, true, true, true);
             _ro.elementHeight = EditorGUIUtility.singleLineHeight * 3 + 4;
+            _ro.elementHeightCallback = _ => _showMaterials
+                ? 3 * (EditorGUIUtility.singleLineHeight + 2)
+                : EditorGUIUtility.singleLineHeight + 2;
             _ro.drawElementCallback = (rect, index, active, focused) =>
             {
                 EditorGUI.BeginDisabledGroup(sp.hasMultipleDifferentValues);
@@ -68,6 +75,7 @@ namespace Coffee.UIExtensions
                 rect.height = EditorGUIUtility.singleLineHeight;
                 var p = sp.GetArrayElementAtIndex(index);
                 EditorGUI.ObjectField(rect, p, GUIContent.none);
+                if (!_showMaterials) return;
 
                 rect.x += 15;
                 rect.width -= 15;
@@ -87,15 +95,15 @@ namespace Coffee.UIExtensions
             };
             _ro.drawHeaderCallback += rect =>
             {
+#if !UNITY_2019_3_OR_NEWER
+                rect.y -= 1;
+#endif
                 EditorGUI.LabelField(new Rect(rect.x, rect.y, 150, rect.height), s_ContentRenderingOrder);
 
-                #if UNITY_2019_3_OR_NEWER
-                rect = new Rect(rect.width - 55, rect.y, 80, rect.height);
-                #else
-                rect = new Rect(rect.width - 55, rect.y - 1, 80, rect.height);
-                #endif
+                var content = EditorGUIUtility.IconContent(_showMaterials ? "VisibilityOn" : "VisibilityOff");
+                _showMaterials = GUI.Toggle(new Rect(rect.width - 55, rect.y, 24, 20), _showMaterials, content, EditorStyles.label);
 
-                if (GUI.Button(rect, s_ContentRefresh, EditorStyles.miniButton))
+                if (GUI.Button(new Rect(rect.width - 35, rect.y, 60, rect.height), s_ContentRefresh, EditorStyles.miniButton))
                 {
                     foreach (UIParticle t in targets)
                     {
@@ -164,6 +172,9 @@ namespace Coffee.UIExtensions
                     t.SetMaterialDirty();
             }
 
+            // ShrinkByMaterial
+            EditorGUILayout.PropertyField(_spShrinkByMaterial);
+
             // Target ParticleSystems.
             _ro.DoLayoutList();
 

Scripts/UIParticle.cs

@@ -1,3 +1,6 @@
+#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
+#define SERIALIZE_FIELD_MASKABLE
+#endif
 using System.Collections.Generic;
 using System.Runtime.CompilerServices;
 using Coffee.UIParticleExtensions;
@@ -38,9 +41,11 @@ namespace Coffee.UIExtensions
         [Tooltip("Particles")] [SerializeField]
         private List<ParticleSystem> m_Particles = new List<ParticleSystem>();
 
-#if !UNITY_2019_4_OR_NEWER
-        [SerializeField]
-        private bool m_Maskable = true;
+        [Tooltip("Shrink rendering by material on refresh.\nNOTE: Performance will be improved, but in some cases the rendering is not correct.")] [SerializeField]
+        bool m_ShrinkByMaterial = false;
+
+#if !SERIALIZE_FIELD_MASKABLE
+        [SerializeField] private bool m_Maskable = true;
 #endif
 
         private bool _shouldBeRemoved;
@@ -54,6 +59,7 @@ namespace Coffee.UIExtensions
         private static MaterialPropertyBlock s_Mpb;
         private static readonly List<Material> s_PrevMaskMaterials = new List<Material>();
         private static readonly List<Material> s_PrevModifiedMaterials = new List<Material>();
+        private static readonly List<Component> s_Components = new List<Component>();
 
 
         /// <summary>
@@ -78,6 +84,17 @@ namespace Coffee.UIExtensions
             }
         }
 
+        public bool shrinkByMaterial
+        {
+            get { return m_ShrinkByMaterial; }
+            set
+            {
+                if (m_ShrinkByMaterial == value) return;
+                m_ShrinkByMaterial = value;
+                RefreshParticles();
+            }
+        }
+
         /// <summary>
         /// Particle effect scale.
         /// </summary>
@@ -121,6 +138,11 @@ namespace Coffee.UIExtensions
             get { return _modifiedMaterials; }
         }
 
+        public override Material materialForRendering
+        {
+            get { return canvasRenderer.GetMaterial(0); }
+        }
+
         public List<bool> activeMeshIndices
         {
             get { return _activeMeshIndices; }
@@ -209,7 +231,7 @@ namespace Coffee.UIExtensions
             }
 
             particles.Exec(p => p.GetComponent<ParticleSystemRenderer>().enabled = !enabled);
-            particles.SortForRendering(transform);
+            particles.SortForRendering(transform, m_ShrinkByMaterial);
 
             SetMaterialDirty();
         }
@@ -237,16 +259,12 @@ namespace Coffee.UIExtensions
             if (count == 0 || !isActiveAndEnabled || particles.Count == 0)
             {
                 canvasRenderer.Clear();
-
-                foreach (var m in s_PrevMaskMaterials)
-                    StencilMaterial.Remove(m);
-
-                foreach (var m in s_PrevModifiedMaterials)
-                    ModifiedMaterial.Remove(m);
+                ClearPreviousMaterials();
                 return;
             }
 
             //
+            GetComponents(typeof(IMaterialModifier), s_Components);
             var materialCount = Mathf.Max(8, count);
             canvasRenderer.materialCount = materialCount;
             var j = 0;
@@ -265,6 +283,8 @@ namespace Coffee.UIExtensions
                 if (activeMeshIndices[index] && 0 < s_TempMaterials.Count)
                 {
                     var mat = GetModifiedMaterial(s_TempMaterials[0], ps.GetTextureForSprite());
+                    for (var k = 1; k < s_Components.Count; k++)
+                        mat = (s_Components[k] as IMaterialModifier).GetModifiedMaterial(mat);
                     canvasRenderer.SetMaterial(mat, j);
                     UpdateMaterialProperties(r, j);
                     j++;
@@ -276,15 +296,24 @@ namespace Coffee.UIExtensions
                 if (activeMeshIndices[index] && 1 < s_TempMaterials.Count)
                 {
                     var mat = GetModifiedMaterial(s_TempMaterials[1], null);
+                    for (var k = 1; k < s_Components.Count; k++)
+                        mat = (s_Components[k] as IMaterialModifier).GetModifiedMaterial(mat);
                     canvasRenderer.SetMaterial(mat, j++);
                 }
             }
 
+            ClearPreviousMaterials();
+        }
+
+        private void ClearPreviousMaterials()
+        {
             foreach (var m in s_PrevMaskMaterials)
                 StencilMaterial.Remove(m);
+            s_PrevMaskMaterials.Clear();
 
             foreach (var m in s_PrevModifiedMaterials)
                 ModifiedMaterial.Remove(m);
+            s_PrevModifiedMaterials.Clear();
         }
 
         private Material GetModifiedMaterial(Material baseMaterial, Texture2D texture)
@@ -355,7 +384,7 @@ namespace Coffee.UIExtensions
         /// </summary>
         protected override void OnEnable()
         {
-#if !UNITY_2019_4_OR_NEWER
+#if !SERIALIZE_FIELD_MASKABLE
             maskable = m_Maskable;
 #endif
             _cachedPosition = transform.localPosition;
@@ -448,7 +477,7 @@ namespace Coffee.UIExtensions
             SetVerticesDirty();
             m_ShouldRecalculateStencil = true;
             RecalculateClipping();
-#if !UNITY_2019_4_OR_NEWER
+#if !SERIALIZE_FIELD_MASKABLE
             maskable = m_Maskable;
 #endif
         }

Scripts/UIParticleUpdater.cs

@@ -59,7 +59,7 @@ namespace Coffee.UIExtensions
 
         private static void Refresh(UIParticle particle)
         {
-            if (!particle || !particle.canvas || !particle.canvasRenderer) return;
+            if (!particle || !particle.bakedMesh || !particle.canvas || !particle.canvasRenderer) return;
 
             Profiler.BeginSample("[UIParticle] Modify scale");
             ModifyScale(particle);
@@ -164,6 +164,8 @@ namespace Coffee.UIExtensions
                 // No particle to render.
                 var currentPs = particle.particles[i];
                 if (!currentPs || !currentPs.IsAlive() || currentPs.particleCount == 0) continue;
+                var r = currentPs.GetComponent<ParticleSystemRenderer>();
+                if (!r.sharedMaterial && !r.trailMaterial) continue;
 
                 // Calc matrix.
                 Profiler.BeginSample("[UIParticle] Bake Mesh > Calc matrix");
@@ -218,7 +220,6 @@ namespace Coffee.UIExtensions
 #endif
 
                 // Bake main particles.
-                var r = currentPs.GetComponent<ParticleSystemRenderer>();
                 if (CanBakeMesh(r))
                 {
                     Profiler.BeginSample("[UIParticle] Bake Mesh > Bake Main Particles");

Scripts/Utils.cs

@@ -185,7 +185,7 @@ namespace Coffee.UIParticleExtensions
 
     internal static class ParticleSystemExtensions
     {
-        public static void SortForRendering(this List<ParticleSystem> self, Transform transform)
+        public static void SortForRendering(this List<ParticleSystem> self, Transform transform, bool sortByMaterial)
         {
             self.Sort((a, b) =>
             {
@@ -194,8 +194,15 @@ namespace Coffee.UIParticleExtensions
                 var bRenderer = b.GetComponent<ParticleSystemRenderer>();
 
                 // Render queue: ascending
-                var aMat = aRenderer.sharedMaterial;
-                var bMat = bRenderer.sharedMaterial;
+                var aMat = aRenderer.sharedMaterial ?? aRenderer.trailMaterial;
+                var bMat = bRenderer.sharedMaterial ?? bRenderer.trailMaterial;
+                if (!aMat && !bMat) return 0;
+                if (!aMat) return -1;
+                if (!bMat) return 1;
+
+                if (sortByMaterial)
+                    return aMat.GetInstanceID() - bMat.GetInstanceID();
+
                 if (aMat.renderQueue != bMat.renderQueue)
                     return aMat.renderQueue - bMat.renderQueue;
 
@@ -210,10 +217,10 @@ namespace Coffee.UIParticleExtensions
                 // Z position & sortingFudge: descending
                 var aTransform = a.transform;
                 var bTransform = b.transform;
-                var aPos = tr.InverseTransformPoint(aTransform.position).z+ aRenderer.sortingFudge;
-                var bPos = tr.InverseTransformPoint(bTransform.position).z+ bRenderer.sortingFudge;
+                var aPos = tr.InverseTransformPoint(aTransform.position).z + aRenderer.sortingFudge;
+                var bPos = tr.InverseTransformPoint(bTransform.position).z + bRenderer.sortingFudge;
                 if (!Mathf.Approximately(aPos, bPos))
-                    return (int)Mathf.Sign(bPos - aPos);
+                    return (int) Mathf.Sign(bPos - aPos);
 
                 // Material instance ID: match
                 if (aMat.GetInstanceID() == bMat.GetInstanceID())

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": "3.1.0",
+  "version": "3.3.0",
   "unity": "2018.2",
   "license": "MIT",
   "repository": {