Merge pull request #28 from CyberAgentGameEntertainment/feature/error-message

Error messages and documentation when Read/Write is disabled.

Author: CyTakayukiKiyohara

Assets/AirSticker/Runtime/Scripts/Core/DecalMeshRenderer.cs

@@ -4,8 +4,7 @@ namespace AirSticker.Runtime.Scripts.Core
 {
     internal sealed class DecalMeshRenderer
     {
-        private readonly Component _receiverComponent;
-
+        private readonly Renderer _renderer;
         public DecalMeshRenderer(Component receiverComponent, Material decalMaterial, Mesh mesh)
         {
             Owner = new GameObject("AirStickerRenderer");
@@ -15,6 +14,7 @@ public DecalMeshRenderer(Component receiverComponent, Material decalMaterial, Me
                 meshRenderer.material = decalMaterial;
                 var meshFilter = Owner.AddComponent<MeshFilter>();
                 meshFilter.mesh = mesh;
+                _renderer = meshRenderer;
             }
             else if (receiverComponent is SkinnedMeshRenderer s)
             {
@@ -23,10 +23,10 @@ public DecalMeshRenderer(Component receiverComponent, Material decalMaterial, Me
                 skinnedMeshRenderer.material = decalMaterial;
                 skinnedMeshRenderer.rootBone = s.rootBone;
                 skinnedMeshRenderer.bones = s.bones;
+                _renderer = skinnedMeshRenderer;
             }
-
-            _receiverComponent = receiverComponent;
-            Owner.transform.parent = _receiverComponent.transform;
+            
+            Owner.transform.parent = receiverComponent.transform;
             Owner.transform.localPosition = Vector3.zero;
             Owner.transform.localRotation = Quaternion.identity;
             Owner.transform.localScale = Vector3.one;
@@ -36,12 +36,12 @@ public DecalMeshRenderer(Component receiverComponent, Material decalMaterial, Me
 
         public void DisableDecalMeshRenderer()
         {
-            _receiverComponent.gameObject.SetActive(false);
+            _renderer.gameObject.SetActive(false);
         }
 
         public void EnableDecalMeshRenderer()
         {
-            _receiverComponent.gameObject.SetActive(true);
+            _renderer.gameObject.SetActive(true);
         }
 
         public void Destroy()

Assets/AirSticker/Runtime/Scripts/Core/TrianglePolygonsFactory.cs

@@ -74,6 +74,12 @@ private static int GetNumPolygonsFromSkinModelRenderers(SkinnedMeshRenderer[] sk
             {
                 if (!renderer || renderer.sharedMesh == null) return -1;
                 var mesh = renderer.sharedMesh;
+                if (mesh.isReadable == false)
+                {
+                    Debug.LogError($"The mesh of the skinned mesh renderer named {renderer.name} is not readable. Please set the Read/Write Enabled flag in the model import settings.");
+                    return -1;
+                }
+
                 numPolygon += mesh.triangles.Length / 3;
             }
 
@@ -106,6 +112,11 @@ private static int GetNumPolygonsFromMeshFilters(MeshFilter[] meshFilters)
             {
                 if (!meshFilter || meshFilter.sharedMesh == null) return -1;
                 var mesh = meshFilter.sharedMesh;
+                if(mesh.isReadable == false)
+                {
+                    Debug.LogError($"The mesh of the mesh filter named {meshFilter.name} is not readable. Please set the Read/Write Enabled flag in the model import settings.");
+                    return -1;
+                }
                 var numPoly = mesh.triangles.Length / 3;
                 numPolygon += numPoly;
             }
@@ -118,8 +129,12 @@ private static void CalculateCapacityConvexPolygonInfos(MeshFilter[] meshFilters
             float terrainMehResolutionScale)
         {
             var capacity = 0;
-            capacity += GetNumPolygonsFromMeshFilters(meshFilters);
-            capacity += GetNumPolygonsFromSkinModelRenderers(skinnedMeshRenderers);
+            var numPolygonsFromMeshFilters = GetNumPolygonsFromMeshFilters(meshFilters);
+            var numPolygonsFromSkinModelRenderers = GetNumPolygonsFromSkinModelRenderers(skinnedMeshRenderers);
+            // GetNumPolygonsFromMeshFilters and GetNumPolygonsFromSkinModelRenderers may return -1 if they cannot obtain the polygon count.
+            if (numPolygonsFromMeshFilters > 0) capacity += numPolygonsFromMeshFilters;
+            if( numPolygonsFromSkinModelRenderers > 0) capacity += numPolygonsFromSkinModelRenderers;
+            
             capacity += GetNumPolygonsFromTerrains(terrains, terrainMehResolutionScale);
             if (capacity > 0) convexPolygonInfos.Capacity = capacity;
         }
@@ -281,6 +296,10 @@ private IEnumerator BuildFromSkinMeshRenderer(SkinnedMeshRenderer[] skinnedMeshR
                     // The skinned mesh renderer is deleted, so process is terminated.
                     yield break;
                 var mesh = skinnedMeshRenderer.sharedMesh;
+                if (mesh.isReadable == false)
+                {
+                    yield break;
+                }
 
                 using var meshDataArray = Mesh.AcquireReadOnlyMeshData(mesh);
                 var meshData = meshDataArray[0];

Documentation/fig-016.png

@@ -218,5 +218,12 @@ void LaunchProjector(
 </p>
 
 
+### 4.4 Important Note
+Please note that the receiver model must have `Read/Write` enabled in its `Import Settings`.
+<p align="center">
+<img width="50%" src="Documentation/fig-016.png" alt="Model Import Settings"><br>
+<font color="grey">Model Import Settings</font>
+</p>
+
 
 

README.md

@@ -160,7 +160,7 @@ AirStickerProjectorコンポーネントには5つのパラメータを設定す
 |Width|Projector バウンディングボックスの幅です。URPのデカールプロジェクタの仕様に準拠しています。<br/>詳細は[URPデカールのマニュアル](https://docs.unity3d.com/ja/Packages/com.unity.render-pipelines.universal@14.0/manual/renderer-feature-decal.html)を参照してください。 |
 |Height|Projector バウンディングボックスの高さです。URPのデカールプロジェクタの仕様に準拠しています。<br/>詳細は[URPデカールのマニュアル](https://docs.unity3d.com/ja/Packages/com.unity.render-pipelines.universal@14.0/manual/renderer-feature-decal.html)を参照してください。|
 |Depth|Projector バウンディングボックスの深度です。URPのデカールプロジェクタの仕様に準拠しています。<br/>詳細は[URPデカールのマニュアル](https://docs.unity3d.com/ja/Packages/com.unity.render-pipelines.universal@14.0/manual/renderer-feature-decal.html)を参照してください。|
-|Receiver Objects| デカールテクスチャの貼り付け対象となるオブジェクト。<br/>AirStickerProjectorは設定されているレシーバーオブジェクトの子供(自身を含む)に貼られている全てのレンダラーを貼り付け対象とします。<br/><br/>そのため、レシーバーオブジェクトはMeshRendererやSkinMeshRendererなどのコンポーネントが貼られているオブジェクトを直接指定もできますし、レンダラーが貼られているオブジェクトを子供に含んでいるオブジェクトの指定でも構いません。<br/>処理するレンダラーの数が多いほど、デカールメッシュ生成の時間がかかるようになるため、貼り付ける範囲を限定できるときは、レンダラーが貼り付けられているオブジェクトの直接指定が推奨されます。<br/><br/>例えば、キャラエディットなどでキャラクターの顔にステッカーを貼り付けたい場合、キャラのルートオブジェクトを指定するよりも顔のレンダラーが貼られているオブジェクトを指定するとメッシュ生成の時間を短縮できます。|
+|Receiver Objects| デカールテクスチャの貼り付け対象となるオブジェクト。<br/>AirStickerProjectorは設定されているレシーバーオブジェクトの子供(自身を含む)に貼られている全てのレンダラーを貼り付け対象とします。<br/><br/>そのため、レシーバーオブジェクトはMeshRendererやSkinMeshRendererなどのコンポーネントが貼られているオブジェクトを直接指定もできますし、レンダラーが貼られているオブジェクトを子供に含んでいるオブジェクトの指定でも構いません。<br/>処理するレンダラーの数が多いほど、デカールメッシュ生成の時間がかかるようになるため、貼り付ける範囲を限定できるときは、レンダラーが貼り付けられているオブジェクトの直接指定が推奨されます。<br/><br/>例えば、キャラエディットなどでキャラクターの顔にステッカーを貼り付けたい場合、キャラのルートオブジェクトを指定するよりも顔のレンダラーが貼られているオブジェクトを指定するとメッシュ生成の時間を短縮できます。<br/>|
 |Z Offset In Decal Space|デカールを貼り付けるサーフェイスの空間でのZオフセットです。この値を調整することで、Zファイティングを軽減することができます。|
 |Decal Material| デカールマテリアル。<br/>URPのデカールマテリアルとは意味あいが違うので注意してください。<br/>URPデカールではShader Graphs/Decalシェーダーが割り当てられたマテリアルしか使えません。<br/>しかし、Air Stickerでは通常のマテリアルが使えます。<br/>つまり、ビルトインのLitシェーダー、Unlitシェーダー、そして、ユーザーカスタムの独自シェーダーも利用できます。|
 |Projection Backside|このチェックボックスにチェックが入っていると、裏面のメッシュにもデカールメッシュが投影されます。|
@@ -212,4 +212,11 @@ void LaunchProjector(
 © Unity Technologies Japan/UC
 </p>
 
+### 4.4 注意実行
+レシーバとなるモデルは`Import Settings`の`Read/Write`が有効になっている必要があるので注意してください。
+<p align="center">
+<img width="50%" src="Documentation/fig-016.png" alt="モデルのインポート設定"><br>
+<font color="grey">モデルのインポート設定</font>
+</p>
+