パート3...シェーダーコードとその他のスクリプト、および実行結果
そして、マスキング処理を担当する下記2つのシェーダーを用意し、これらをインスペクター上で上記スクリプトのcarverMaskShader、carverMaskCleanerShaderにセットしておきます。セットしておかなくても名前で検索してセットするようにはしましたが、その時はビルドして実行する場合Graphics設定の「Always Included Shaders」にこれらを追加しておかないと見つからなくなるかと思います。
CarverMaskは、描画されるたびにステンシルバッファ上の値の下1桁を0から1に、1から0に切り替えます。Carver上での処理によって、マスキング用メッシュの穴の開いた部分は外周パスの内側に内包される形になっているので、穴はメッシュが偶数回重なって0となります。実際にオブジェクトを描画する際は1の部分だけに描画することで、マスクの形にオブジェクトがくり抜かれるだろうという目論見です。
ShaderLab
1 Shader "Hidden/CarverMask"
2 {
3 Properties
4 {
5 }
6 SubShader
7 {
8 Pass
9 {
10 ColorMask 0
11 Cull Back
12 ZTest Always
13 ZWrite Off
14 Stencil
15 {
16 Ref 1
17 WriteMask 1
18 Pass IncrWrap
19 }
20
21 CGPROGRAM
22 #pragma vertex vert
23 #pragma fragment frag
24 #include "UnityCG.cginc"
25
26 float4 vert(float3 vertex : POSITION) : SV_POSITION
27 {
28 return UnityObjectToClipPos(vertex);
29 }
30
31 fixed4 frag() : SV_Target
32 {
33 return 0;
34 }
35 ENDCG
36 }
37 }
38 }
CarverMaskCleanerはステンシルバッファ上の値の下1桁を0に書き換えるもので、一つのオブジェクトの描画が終わったら画面全体をこれで塗りつぶし、次のオブジェクトの描画に備えます。
ShaderLab
1 Shader "Hidden/CarverMaskCleaner"
2 {
3 Properties
4 {
5 }
6 SubShader
7 {
8 Pass
9 {
10 ColorMask 0
11 Cull Back
12 ZTest Always
13 ZWrite Off
14 Stencil
15 {
16 Ref 0
17 WriteMask 1
18 Pass Replace
19 }
20
21 CGPROGRAM
22 #pragma vertex vert
23 #pragma fragment frag
24 #include "UnityCG.cginc"
25
26 float4 vert(float3 vertex : POSITION) : SV_POSITION
27 {
28 return UnityObjectToClipPos(vertex);
29 }
30
31 fixed4 frag() : SV_Target
32 {
33 return 0;
34 }
35 ENDCG
36 }
37 }
38 }
そしてこれもまた不便な点で申しわけないですが、先に申し上げたように、くり抜き処理に参加させたいオブジェクトはステンシルバッファの値の下1桁が1の時だけ描画するようなシェーダーを使う必要があります。あとで図示しますCapsule、Torus、Teapotには下記のシェーダーを使ったマテリアルを割り当てています。
ShaderLab
1 Shader "Custom/CarverStandard"
2 {
3 Properties
4 {
5 _Color ("Color", Color) = (1,1,1,1)
6 _MainTex ("Albedo (RGB)", 2D) = "white" {}
7 _Glossiness ("Smoothness", Range(0,1)) = 0.5
8 _Metallic ("Metallic", Range(0,1)) = 0.0
9 }
10 SubShader
11 {
12 Tags { "RenderType"="Opaque" }
13 Stencil
14 {
15 Ref 1
16 ReadMask 1
17 Comp Equal
18 }
19 CGPROGRAM
20 #pragma surface surf Standard fullforwardshadows
21 #pragma target 3.0
22
23 sampler2D _MainTex;
24
25 struct Input
26 {
27 float2 uv_MainTex;
28 };
29
30 half _Glossiness;
31 half _Metallic;
32 fixed4 _Color;
33
34 void surf(Input IN, inout SurfaceOutputStandard o)
35 {
36 fixed4 c = tex2D(_MainTex, IN.uv_MainTex) * _Color;
37 o.Albedo = c.rgb;
38 o.Metallic = _Metallic;
39 o.Smoothness = _Glossiness;
40 o.Alpha = c.a;
41 }
42 ENDCG
43 }
44 FallBack "Diffuse"
45 }
ユニティちゃんのマテリアルについては省略しますが、変更点はそれぞれ単に
ShaderLab
1 Stencil
2 {
3 Ref 1
4 ReadMask 1
5 Comp Equal
6 }
を追加しただけです。
また、下記のスクリプトをアタッチした空オブジェクトをシーン上に配置しています。Awake時に自分自身を削除し、その機能を無効化するようにしました。
このスクリプトが有効化された時に一度だけ塗りつぶし処理の差し込みを行う仕様ですので、スクリプトを編集したりして再読み込みが発生した場合にタイミング的な問題で表示が消えてしまったり、2枚目のシーンビューを開いたりするとそちらには表示されなかったり...という風に不親切な点があります。一旦このスクリプトのチェックボックスを外して無効化し、再度チェックして有効化すれば復活するかと思います。
C#
1 using System . Linq ;
2 using UnityEngine ;
3 using UnityEngine . Rendering ;
4 # if UNITY_EDITOR
5 using UnityEditor ;
6 # endif
7
8 [ ExecuteAlways ]
9 [ DefaultExecutionOrder ( 1 ) ]
10 public class EditorModeStencilWriter : MonoBehaviour
11 {
12 # if UNITY_EDITOR
13 [ SerializeField ] private Shader maskShader ;
14 private static Material maskMaterial ;
15 private static CommandBuffer commands ;
16 private static Camera [ ] cameras ;
17
18 private void Awake ( )
19 {
20 if ( EditorApplication . isPlayingOrWillChangePlaymode )
21 {
22 Destroy ( this ) ;
23 }
24 }
25
26 private void OnEnable ( )
27 {
28 if ( maskMaterial == null )
29 {
30 if ( this . maskShader == null )
31 {
32 this . maskShader = Shader . Find ( "Hidden/CarverMask" ) ;
33 }
34
35 if ( this . maskShader != null )
36 {
37 maskMaterial = new Material ( this . maskShader ) ;
38 }
39 }
40
41 if ( commands != null )
42 {
43 return ;
44 }
45
46 commands = new CommandBuffer { name = "Fill Stencil Buffer" } ;
47 commands . Blit ( EditorGUIUtility . whiteTexture , BuiltinRenderTextureType . CameraTarget , maskMaterial ) ;
48 cameras = SceneView . GetAllSceneCameras ( ) . Concat ( Camera . allCameras ) . Select (
49 cam = >
50 {
51 cam . AddCommandBuffer ( CameraEvent . BeforeForwardOpaque , commands ) ;
52 return cam ;
53 } ) . ToArray ( ) ;
54 }
55
56 private void OnDisable ( )
57 {
58 if ( cameras == null )
59 {
60 return ;
61 }
62
63 foreach ( var cam in cameras )
64 {
65 if ( cam == null )
66 {
67 continue ;
68 }
69
70 cam . RemoveCommandBuffer ( CameraEvent . BeforeForwardOpaque , commands ) ;
71 }
72
73 cameras = null ;
74 commands = null ;
75 }
76
77 # else
78 private void Awake ( )
79 {
80 Destroy ( this ) ;
81 }
82 # endif
83 }
そして、動作確認のために下記スクリプトをアタッチしたオブジェクトをシーン上に配置しています。
C#
1 using System . Collections . Generic ;
2 using System . Linq ;
3 using UnityEngine ;
4
5 public class MouseAction : MonoBehaviour
6 {
7 private Camera mainCamera ;
8 private Transform dragTarget ;
9 private Vector3 dragTargetOrigin ;
10 private Vector3 dragOrigin ;
11 private bool carveWhenDrop ;
12
13 private void Start ( )
14 {
15 this . mainCamera = Camera . main ;
16 }
17
18 private void Update ( )
19 {
20 if ( this . dragTarget == null )
21 {
22 if ( Input . GetMouseButtonDown ( 0 ) )
23 {
24 var mouseRay = this . mainCamera . ScreenPointToRay ( Input . mousePosition ) ;
25 var hit = Physics2D . Raycast ( mouseRay . origin , mouseRay . direction ) ;
26 if ( hit . collider != null )
27 {
28 this . dragTarget = hit . transform ;
29 this . dragTargetOrigin = this . dragTarget . position ;
30 this . dragOrigin = hit . point ;
31 if ( Input . GetKey ( KeyCode . Space ) )
32 {
33 hit . collider . isTrigger = true ;
34 if ( hit . rigidbody != null )
35 {
36 hit . rigidbody . bodyType = RigidbodyType2D . Kinematic ;
37 }
38
39 this . carveWhenDrop = true ;
40 }
41 }
42 }
43 }
44 else
45 {
46 if ( Input . GetMouseButton ( 0 ) )
47 {
48 var mouseRay = this . mainCamera . ScreenPointToRay ( Input . mousePosition ) ;
49 var xyPlane = new Plane ( Vector3 . back , Vector3 . zero ) ;
50 if ( xyPlane . Raycast ( mouseRay , out var enter ) )
51 {
52 var deltaPosition = mouseRay . GetPoint ( enter ) - this . dragOrigin ;
53 this . dragTarget . position = this . dragTargetOrigin + deltaPosition ;
54 }
55 }
56 else if ( Input . GetMouseButtonUp ( 0 ) )
57 {
58 var targetRigidbody = this . dragTarget . GetComponent < Rigidbody2D > ( ) ;
59 if ( targetRigidbody != null )
60 {
61 targetRigidbody . velocity = Vector2 . zero ;
62 if ( this . carveWhenDrop )
63 {
64 targetRigidbody . bodyType = RigidbodyType2D . Dynamic ;
65 }
66 }
67
68 if ( this . carveWhenDrop )
69 {
70 var targetCollider = this . dragTarget . GetComponent < Collider2D > ( ) ;
71 if ( targetCollider != null )
72 {
73 targetCollider . isTrigger = false ;
74 var overlappingColliders = new List < Collider2D > ( ) ;
75 targetCollider . OverlapCollider ( new ContactFilter2D ( ) , overlappingColliders ) ;
76 var carvers = overlappingColliders . Select ( c = > c . GetComponentInChildren < Carver > ( ) )
77 . Where ( c = > c != null ) ;
78 var thisCarver = targetCollider . GetComponentInChildren < Carver > ( ) ;
79 if ( thisCarver != null )
80 {
81 Debug . Log (
82 $ "Carve {targetCollider.name} with {string.Join(" , ", carvers.Select(c => c.Collider2D.name))}." ) ;
83 Carver . Carve ( thisCarver , carvers ) ;
84 }
85 }
86
87 this . carveWhenDrop = false ;
88 }
89
90 this . dragTarget = null ;
91 }
92 }
93 }
94
95 private void OnGUI ( )
96 {
97 if ( this . carveWhenDrop )
98 {
99 using ( new GUILayout . AreaScope ( new Rect ( 0 , 0 , Screen . width , Screen . height ) ) )
100 {
101 using ( new GUILayout . HorizontalScope ( ) )
102 {
103 GUILayout . FlexibleSpace ( ) ;
104 GUILayout . Label ( "Let's Carve!" ) ;
105 GUILayout . FlexibleSpace ( ) ;
106 }
107 }
108 }
109 }
110 }
シーンの準備が終わると、非プレイモードでは下図のような状態になっています。
そこからプレイモードに移行すると下図のような状態に変わります。くり抜きに参加するオブジェクトにそれぞれ親オブジェクトが追加され、それにコライダーが付けられています。
動かすと下図のようになりました。SkinnedMeshRendererをいくつも持つオブジェクトに対してもくり抜けるか確認したかったためユニティちゃんを参加させましたが、ちょっとした残虐表現になってしまって彼女には悪く思います...
なるべく簡潔にしようと思ったものの、何だかんだで長くなってしまいすみません。また、実験は2019.3.8f1でやったのですが、Unityのバージョンが古いと使えない記述が混じっている可能性があります。たとえば描画の際にForwardBaseパスだけを選ぶのに使っているFindPassTagValue は、2018以前のバージョンには搭載されていないんじゃないかと思います。
Q&A
ベストアンサー
