chore(release): 3.3.1 [skip ci]

## [3.3.1](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/3.3.0...3.3.1) (2021-02-01)

### Bug Fixes

* ignore material check and transform check ([d11cd0a](d11cd0a06d)), closes [#119](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/119)
* the trail is incorrect in SimulationSpace.Local ([9313489](9313489552))

.github/workflows/release.yml

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

.github/workflows/test.yml

@@ -0,0 +1,96 @@
+# Secrets
+#   UNITY_LICENSE:
+name: test
+
+on:
+  push:
+    branches:
+      - develop
+    tags:
+      - "!*"
+  pull_request:
+    types:
+      - opened
+      - synchronize
+
+jobs:
+  unity-test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        unityVersion: [
+            "2018.3.14f1",
+            "2018.4.30f1",
+            "2019.1.14f1",
+            "2019.2.21f1",
+            "2019.3.15f1",
+            "2019.4.16f1",
+            "2020.1.17f1",
+            "2020.2.1f1",
+          ]
+    env:
+      UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
+
+    steps:
+      # Checkout sandbox project
+      - uses: actions/checkout@v2
+        with:
+          ref: sandbox
+          submodules: true
+          fetch-depth: 0
+
+      # Update package submodule
+      - name: "Update package submodule"
+        working-directory: Packages/dev
+        run: git checkout ${{ github.sha }}
+
+      - uses: actions/cache@v2
+        with:
+          path: Library
+          key: Library-${{ matrix.unityVersion }}-${{ github.sha }}
+          restore-keys: |
+            Library-${{ matrix.unityVersion }}-
+            Library-
+
+      # Install codecoverage package
+      - name: "Install codecoverage package"
+        if: startsWith(matrix.unityVersion, '2019.4.')
+        run: |
+          npx openupm-cli add -f com.unity.testtools.codecoverage@0.4.0-preview
+
+      # Run tests
+      - name: "Run tests"
+        uses: game-ci/unity-test-runner@main
+        with:
+          unityVersion: ${{ matrix.unityVersion }}
+          customImage: ghcr.io/mob-sakai/unity3d:${{ matrix.unityVersion }}
+          customParameters: -enableCodeCoverage
+          # customParameters: -enableCodeCoverage -coverageOptions assemblyFilters:+CSharpCompilerSettings_,-*-CSharp,-*.Tests,-IgnoreAccessibility
+
+      - uses: actions/upload-artifact@v2
+        if: always()
+        with:
+          name: TestResults-${{ matrix.unityVersion }}
+          path: |
+            artifacts/*.xml
+            CodeCoverage/**/TestCoverageResults_*.xml
+
+  publish:
+    needs: unity-test
+    runs-on: ubuntu-latest
+    if: always()
+    steps:
+      
+      - uses: actions/download-artifact@v2
+        with:
+          path: artifacts
+      
+      - uses: testspace-com/setup-testspace@v1
+        with:
+          domain: ${{github.repository_owner}}
+
+      - name: Push test results
+        if: always()
+        run: |
+          testspace `find . -name '*.xml' | tr '\n' ' '`

.github/workflows/unity-test.yml

@@ -1,100 +0,0 @@
-name: unity-test
-
-on:
-  push:
-    branches:
-      - develop
-    tags:
-      - "!*"
-  pull_request:
-    types:
-      - opened
-      - synchronize
-
-jobs:
-  unity-test:
-    strategy:
-      fail-fast: false
-      matrix:
-        unity:
-          [
-            "2018.3.14f1",
-            "2018.4.25f1",
-            "2019.1.14f1",
-            "2019.2.11f1",
-            "2019.3.15f1",
-            "2019.4.8f1",
-            "2020.1.5f1",
-          ]
-
-    runs-on: ubuntu-latest
-    container:
-      # Use Unity image from https://hub.docker.com/r/gableroux/unity3d/tags
-      image: gableroux/unity3d:${{ matrix.unity }}
-
-    steps:
-      # Activate Unity Editor
-      - name: Activate Unity Editor
-        id: activation
-        run: |
-          apt-get update > /dev/null
-          apt-get install software-properties-common -y > /dev/null
-          apt-add-repository ppa:git-core/ppa -y > /dev/null
-          apt-get update > /dev/null
-          apt-get install git -y > /dev/null
-          git clone https://gist.github.com/135c940b45ec4e385861c8711777db7f.git .ulfs
-          chmod 755 .ulfs/activate.sh && .ulfs/activate.sh ${{ matrix.unity }}
-
-      # (On failed activation) Upload unity activation file
-      - name: Upload unity activation file
-        uses: actions/upload-artifact@v2
-        if: failure()
-        with:
-          name: Unity_v${{ matrix.unity }}.alf
-          path: ./*.alf
-
-      # Checkout sandbox project
-      - uses: actions/checkout@v2
-        with:
-          ref: "sandbox"
-          submodules: "true"
-
-      # Update package submodule
-      - name: "Update package submodule"
-        working-directory: Packages/dev
-        run: git checkout ${{ github.head_ref }}
-
-      # Install codecoverage package
-      - name: "Install codecoverage package"
-        if: always() && steps.activation.conclusion == 'success'
-        run: |
-          [ -n "`echo ${{ matrix.unity }} | grep -e '\(2017.\|2018.\|2019.1.\|2019.2.\)'`" ] && exit 0
-          npm i -g openupm-cli
-          openupm add com.unity.testtools.codecoverage
-
-      # Run playmode tests
-      - name: "Run playmode tests"
-        if: always() && steps.activation.conclusion == 'success'
-        run: |
-          xvfb-run --auto-servernum --server-args='-screen 0 640x480x24' \
-            /opt/Unity/Editor/Unity -batchmode -nographics -silent-crashes -logFile -projectPath . \
-            -runTests -testPlatform playmode -enableCodeCoverage
-
-      # Run editmode tests
-      - name: "Run editmode tests"
-        if: always() && steps.activation.conclusion == 'success'
-        run: |
-          xvfb-run --auto-servernum --server-args='-screen 0 640x480x24' \
-            /opt/Unity/Editor/Unity -batchmode -nographics -silent-crashes -logFile -projectPath . \
-            -runTests -testPlatform editmode -enableCodeCoverage
-
-      # Setup testspace
-      - uses: testspace-com/setup-testspace@v1
-        if: always() && steps.activation.conclusion == 'success'
-        with:
-          domain: ${{ github.repository_owner }}
-
-      # Push test results
-      - name: Push test results
-        if: always() && steps.activation.conclusion == 'success'
-        run: testspace "[${{ matrix.unity }}]TestResults-*.xml" "[Code Coverage]CodeCoverage/**/TestCoverageResults_*.xml"

CHANGELOG.md

@@ -1,3 +1,25 @@
+## [3.3.1](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/3.3.0...3.3.1) (2021-02-01)
+
+
+### Bug Fixes
+
+* ignore material check and transform check ([d11cd0a](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/d11cd0a06d76a32b2a119387bddc34c703b9b497)), closes [#119](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/119)
+* the trail is incorrect in SimulationSpace.Local ([9313489](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/9313489552b30f2e2b0b42a641f5e0502995b03d))
+
+# [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)
 
 

README.md

@@ -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

@@ -41,6 +41,9 @@ namespace Coffee.UIExtensions
         [Tooltip("Particles")] [SerializeField]
         private List<ParticleSystem> m_Particles = new List<ParticleSystem>();
 
+        [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
@@ -81,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>
@@ -217,7 +231,7 @@ namespace Coffee.UIExtensions
             }
 
             particles.Exec(p => p.GetComponent<ParticleSystemRenderer>().enabled = !enabled);
-            particles.SortForRendering(transform);
+            particles.SortForRendering(transform, m_ShrinkByMaterial);
 
             SetMaterialDirty();
         }
@@ -245,12 +259,7 @@ 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;
             }
 
@@ -293,11 +302,18 @@ namespace Coffee.UIExtensions
                 }
             }
 
+            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)

Scripts/UIParticleUpdater.cs

@@ -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");
@@ -240,6 +241,10 @@ namespace Coffee.UIExtensions
                     var hash = currentPs.GetMaterialHash(true);
                     if (hash != 0)
                     {
+                        matrix = currentPs.main.simulationSpace == ParticleSystemSimulationSpace.Local
+                            ? matrix * Matrix4x4.Translate(-currentPs.transform.position)
+                            : matrix;
+
                         var m = MeshHelper.GetTemporaryMesh();
                         try
                         {

Scripts/Utils.cs

@@ -9,8 +9,9 @@ namespace Coffee.UIParticleExtensions
     internal static class SpriteExtensions
     {
 #if UNITY_EDITOR
-        private static Type tSpriteEditorExtension = Type.GetType("UnityEditor.Experimental.U2D.SpriteEditorExtension, UnityEditor")
-                                                     ?? Type.GetType("UnityEditor.U2D.SpriteEditorExtension, UnityEditor");
+        private static Type tSpriteEditorExtension =
+            Type.GetType("UnityEditor.Experimental.U2D.SpriteEditorExtension, UnityEditor")
+            ?? Type.GetType("UnityEditor.U2D.SpriteEditorExtension, UnityEditor");
 
         private static MethodInfo miGetActiveAtlasTexture = tSpriteEditorExtension
             .GetMethod("GetActiveAtlasTexture", BindingFlags.Static | BindingFlags.NonPublic);
@@ -185,7 +186,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 +195,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;
 
@@ -215,27 +223,18 @@ namespace Coffee.UIParticleExtensions
                 if (!Mathf.Approximately(aPos, bPos))
                     return (int) Mathf.Sign(bPos - aPos);
 
-                // Material instance ID: match
-                if (aMat.GetInstanceID() == bMat.GetInstanceID())
-                    return 0;
-
-                // Transform: ascending
-                return TransformCompare(aTransform, bTransform);
+                return (int) Mathf.Sign(GetIndex(self, a) - GetIndex(self, b));
             });
         }
 
-        private static int TransformCompare(Transform a, Transform b)
+        private static int GetIndex(IList<ParticleSystem> list, Object ps)
         {
-            while (true)
+            for (var i = 0; i < list.Count; i++)
             {
-                if (!a && !b) return 0;
-                if (!a) return -1;
-                if (!b) return 1;
-                if (a.parent == b.parent) return a.GetSiblingIndex() - b.GetSiblingIndex();
-
-                a = a.parent;
-                b = b.parent;
+                if (list[i].GetInstanceID() == ps.GetInstanceID()) return i;
             }
+
+            return 0;
         }
 
         public static long GetMaterialHash(this ParticleSystem self, bool trail)

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.2.0",
+  "version": "3.3.1",
   "unity": "2018.2",
   "license": "MIT",
   "repository": {