VRアクションゲーム　ミニマップ機能の実装②

　２回の手順に分けてゲーム画面にミニマップを表示する機能の実装を行います。

＜完成時の Game ビュー画像＞

＜新しく学習する内容＞

　・ExecuteAlways 属性(旧 ExecuteInEditMode 属性)
　・MonoBehaviour クラスのコールバック・メソッド

設計

　ミニマップを画面内の邪魔にならない位置に表示し、ゲーム画面を上空から俯瞰して見えるようにする機能を実装します。
　
　今回の手順ではカメラに映ったゲーム画面を加工し、それを UI に表示するための制御処理の実装を行います。

　こちらのサイトを参考にしております。

https://qiita.com/CdecPGL/items/ce0b5c16caecd624d2...

シェーダーの作成

　こちらのサイトを参考にしております。

https://qiita.com/CdecPGL/items/ce0b5c16caecd624d2...

　MinimapCamera によって描画されたゲーム画面をそのまま利用するのではなく、
シェーダーを利用して加工し、その情報をマテリアルに書き込み、それをミニマップとして利用します。

　任意のフォルダ内で Create => Shader => Standard Surface Shader を選択します。
ファイルの名称を Minimap に変更してダブルクリックし、編集します。

Minimap.shader

<=　クリックすると開きます

Shader "Custom/Minimap" 
{
    Properties{
        _MainTex("Main Texture", 2D) = "white" {}  // 入力となるカメラ画像
        _MainTexRatio("Main Texture Ratio", Range(0, 1)) = 1  //マップにカメラ画像を混合する比率
        _BaseColor("Base Color", Color) = (0,0,0,1)  // マップに加算される基本色
        _MapColor("Map Color", Color) = (1,1,1,1)    // ステージの傾斜や輪郭などの色
        _MapMagnification("Map Magnification", Range(0.1, 100000)) = 10000  // ステージの傾斜や輪郭の強調度合い
        _Thick("Thick", Range(0.1, 5)) = 1  // 輪郭の太さ
    }

        SubShader{
            Tags { "RenderType" = "Opaque" }
            ZTest Off
            ZWrite Off
            Lighting Off
            AlphaTest Off

            Pass {
                CGPROGRAM
                #pragma vertex vert
                #pragma fragment frag
                #include "UnityCG.cginc"

                sampler2D _MainTex;
                float _MainTexRatio;
                float4  _MainTex_ST;
                float _MapMagnification;
                float4 _MapColor;
                float4 _BaseColor;
                float _Thick;

                sampler2D _CameraDepthTexture;
                float4  _CameraDepthTexture_TexelSize;

                struct appdata_t {
                    float4 vertex : POSITION;
                    float2 texcoord : TEXCOORD0;
                };
                struct v2f {
                    float4 vertex : SV_POSITION;
                    half2 texcoord : TEXCOORD0;
                };

                v2f vert(appdata_t v)
                {
                    v2f o;
                    o.vertex = UnityObjectToClipPos(v.vertex);
                    o.texcoord = TRANSFORM_TEX(v.texcoord, _MainTex);
                    return o;
                }

                fixed4 frag(v2f input) : Color
                {
                    float tx = _CameraDepthTexture_TexelSize.x * _Thick;
                    float ty = _CameraDepthTexture_TexelSize.y * _Thick;

                    float col00 = Linear01Depth(tex2D(_CameraDepthTexture, input.texcoord + half2(-tx, -ty)).r);
                    float col10 = Linear01Depth(tex2D(_CameraDepthTexture, input.texcoord + half2(0, -ty)).r);
                    float col01 = Linear01Depth(tex2D(_CameraDepthTexture, input.texcoord + half2(-tx,   0)).r);
                    float col11 = Linear01Depth(tex2D(_CameraDepthTexture, input.texcoord + half2(0,   0)).r);
                    float val = (abs(col00 - col11) + abs(col10 - col01)) / 2;

                    float4 main_col = tex2D(_MainTex, input.texcoord);
                    float map_ratio = min(val * _MapMagnification,1);
                    float4 map_color = _MapColor * map_ratio;
                    map_color.a = 1;
                    fixed4 col = (_BaseColor * (1 - _MainTexRatio) + main_col * _MainTexRatio) * (1 - map_ratio) + map_color * map_ratio;
                    return col;
                }
                ENDCG
            }
        }
}

MinimapMaterial

　ミニマップを描画する際に、専用のマテリアルを利用することにより、カメラに映った画像をそのまま MinimapRenderTexture に投影するのではなく、
画像を加工したものをミニマップとして利用させます。

　任意のフォルダ内で Create => Material を選択して、新しいマテリアルを作成します。
名前を MinimapMaterial に変更します。

　インスペクターの最上段にある Shader の設定を、先ほど作成した Custom/Minimap に設定してください。

MinimapCamera スクリプトを作成する

　カメラ(今回であれば MinimapCamera ゲームオブジェクトの Camera) が描画したゲーム画面の情報を Minimap シェーダーを利用して、
加工してからマテリアルに書き込みを行います。
　
　常にミニマップの情報を書き換えていると処理がとても重くなるため、ゲーム開始時と、ミニマップの画像を更新したいタイミングでのみ
マテリアルへの書き込みを行うように制御することで、ゲーム内の描画負荷を軽減しています。

　こちらのサイトを参考にしております。

https://qiita.com/CdecPGL/items/ce0b5c16caecd624d2...

MinimapCamera.cs

<=　クリックすると開きます

using System.Collections;
using UnityEngine;

/// <summary>
/// ミニマップ用
/// </summary>
[ExecuteAlways]　　　　　//　<=　デバッグが完了したら、コメントアウトしても問題ありません。
public class MinimapCamera : MonoBehaviour
{
    [SerializeField, Header("ミニマップに適用するマテリアル")]
    private Material minimapMaterial;

    private Camera myCamera;

    /// <summary>
    /// myCameraのプロパティ
    /// </summary>
    public Camera MyCamera
    {
        get {
            if (!myCamera) {
                TryGetComponent(out myCamera);
            }
            return myCamera;
        }
    }

    void Awake() {

        // Texture のモードを深度テクスチャを使用する設定に変更
        // こうすることで、シェーダー内で_CameraDepthTextureとそれに関連する変数が使用可能
        MyCamera.depthTextureMode = DepthTextureMode.Depth;
        Debug.Log(MyCamera.depthTextureMode);
    }

    /// <summary>
    /// ExcuteAlways 属性が付与されていると、ゲーム実行時に２回走るので注意
    /// </summary>
    void OnEnable() {

        // ミニマップのテクスチャを更新
        UpdateMinimapTextue();    
    }

    /// <summary>
    /// ミニマップのテクスチャを更新する
    /// １フレームだけ自分をカメラにして、カメラからテクスチャに書き込む
    /// </summary>
    public void UpdateMinimapTextue() {

        myCamera.enabled = true;
        StartCoroutine(CrtDisableCameraAfterAFrame());

        Debug.Log("描画更新");

        /// </summary>
        /// 一定時間後に Minimap カメラを無効にする
        /// そうしないと、OnRenderImage メソッドが走り続けてパフォーマンスが悪いため
        /// 形状が変わるマップの場合には定期的にカメラをオンにするなど、別の対策を考える
        /// </summary>
        /// <returns></returns>
        IEnumerator CrtDisableCameraAfterAFrame() {

            // 記事のように 1 フレームだと書き込みが終了しないので、ある程度待機させる
            yield return new WaitForSeconds(1.0f);

            myCamera.enabled = false;

            Debug.Log("カメラオフ");
        }
    }

    /// <summary>
    /// カメラにアタッチされたスクリプトにおいて描画が行われた直後に呼び出されるソッド
    /// カメラの描画における動作をカスタマイズすることができる
    /// URP は非サポート
    /// </summary>
    /// <param name="source"></param>
    /// <param name="destination"></param>
    private void OnRenderImage(RenderTexture source, RenderTexture destination) {

        // ミニマップシェーダーが設定されたマテリアルを使用して、マップカメラの画像からマップ画像を生成
        // このメソッドは指定されたマテリアルを使用して、
        // sourceとして指定されたテクスチャに描画を行いdestinationとして指定されたテクスチャにコピーする
        Graphics.Blit(source, destination, minimapMaterial);

        Debug.Log("Textrue 描画");
    }
}

＜ExecuteAlways 属性(旧 ExecuteInEditMode 属性)＞

　Unity エディターの拡張機能の１つです。

　MonoBehaviour クラスを継承しているクラスに対して ExcuteAlways 属性の付与が行えます。

[ExecuteAlways]
public class MinimapCamera : MonoBehaviour
{

　ExcuteAlways 属性が付与されているクラスは、MonoBehaviour 実装されているコールバック・メソッドの処理を
エディターで編集中にも実行するようになります。よって、ゲームを再生してないときでも、コールバック・メソッドを自動的に実行してくれるようになります。
この機能は、Prefab モードにおいても実行されます。

　今回の場合では、OnEnable メソッド、OnRenderImage メソッドが該当しますので、これらのメソッドはゲームを実行していなくても実行されるようになります。
ゲームを実行していない状態でも、どのような挙動になるかを確認できるため、主にデバッグする目的に利用されます。

　なお、ExecuteInEditMode 属性も同じ機能を持っていますが、ExecuteInEditMode 属性は旧式であり、Prefab モードにも対応していません。
今後は廃止の予定ですので、ExecuteInEditMode 属性ではなく、ExcuteAlways 属性を利用するようにしてください。

　またデバッグが不要になったら、ExcuteAlways 属性をコメントアウトしておいても問題ありません。

　
参考サイト

Unity 公式スクリプトリファレンス
https://docs.unity3d.com/ScriptReference/ExecuteAl...

Qiita @okuhiiro(株式会社 gumi) 様
スクリプトを Edit モードで実行
https://qiita.com/okuhiiro/items/0121fc26c0b80a467...

Qiita @su10
【Unity】Inspectorから値を変更したときにコールバック処理を実行する簡単な方法【エディター拡張】
https://qiita.com/su10/items/35be3e8f323975800de8

＜MonoBehaviour クラスのコールバック・メソッド＞

　Unity の MonoBehaviour クラスには、所定の条件を満たした際に実行されるコールバック・メソッドが多数用意されています。
よく利用するものとしては、OnTrigger ～系や OnCollision ～系のメソッドです。

　MonoBehaviour クラス内においては、On ～の名称で始まるメソッドはすべてコールバック・メソッドになります。

　今回の実装では、OnEnable メソッドと OnRenderImage メソッドを利用しています。
こちらでは詳細な説明は割愛し、公式スクリプトリファレンスのみを記載しています。
是非、自分で調べて、どのような条件の際に起動し、どのような引数を利用できるのかを確認しておいてください。

　他も良記事がありますので、自分で検索してみて、理解を深めてみてください。

Unity 公式スクリプトリファレンス
OnEneble
https://docs.unity3d.com/ja/current/ScriptReferenc...

Unity 公式スクリプトリファレンス
OnRenderImage
https://docs.unity3d.com/ja/current/ScriptReferenc...

MinimapCamera ゲームオブジェクトにアタッチして設定を行う

　作成した MinimapCamera スクリプトを MinimapCamera ゲームオブジェクトにアタッチします。

　インスペクターを確認し、MinimapMaterial の変数には、作成した MinimapMaterial をドラッグアンドドロップしてアサインしてください。

ゲームを実行して動作を確認する

　以上で完成です。

　MinimapCamera スクリプトには ExecuteAlways 属性がアタッチされていますので、
ゲームを実行していなくても、各コールバック・メソッドが実行されて、マテリアルに加工された情報が書き込まれて、
それを RawImage が表示することで、ゲーム画面に加工された状態のミニマップが表示されます。

　その後、実際にゲームを実行し、そのまま同じように加工されたミニマップが画面に表示されるかを確認します。

このページを編集するこのページを元に新規ページを作成

印刷する

コメント（0）

VRアクションゲーム　ミニマップ機能の実装② - i-school 先頭へ

コメントをかく

名前	ユーザIDを使用しないで書き込む	ユーザーIDを使う	ログインする
画像コード	画像に記載されている文字を下のフォームに入力してください。
備考	「http://」を含む投稿は禁止されています。
本文
利用規約をご確認のうえご記入下さい

i-school