デリゲートの実装例④

　デリゲートの実装方法について、活用事例を含めて紹介します。
ダイアログ(ポップアップ)内から外部クラスにある処理を制御する際に、デリゲートを利用した実装例です。

　今回の場合、開いているダイアログを強制的に閉じる処理を作成しています。
例えば、スマホゲームであればフッター部にあるシーン切り替えボタンを押した際に、
次のシーン上に現在開いているダイアログが残らないようにするときなどに利用できます。

　前回の記事はこちらになります。

　　=>　デリゲートの実装例①
　　=>　デリゲートの実装例②
　　=>　デリゲートの実装例③

設計

　ダイアログ(ポップアップ)を制御する際にデリゲートを利用した実装例です。
最初の教材で提示した図を再掲載します。

　具体的な実装内容としては、メソッドの引数にデリゲートを活用することで、
ダイアログ側では管理側との依存関係を持たず、管理側のメソッドを実行することが可能になります。

　今回の場合、開いているダイアログを強制的に閉じる処理を作成しています。
このとき、メソッドの戻り値を活用することで、ダイアログが開いているかどうかを判定させる機能を利用しています。

動画ファイルへのリンク

DialogManager クラスの修正

　Start メソッド内にデバッグ用の処理を追加記述し、Esc キーを押すことでダイアログが開いている場合には強制的に非表示にする処理を行っています。

　ダイアログ側に渡す引数付の　CloseDialogAction メソッドについては、処理内部を修正し、引数の値によって表示されるログを分岐する処理に変更しています。
強制的にダイアログを非表示にする場合には引数の値が null として渡ってくるため、引数によってログ表示が変化するようになります。

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

using System.Collections;
using System.Collections.Generic;
using UniRx;
using UniRx.Triggers;
using UnityEngine;


public class DialogManager : MonoBehaviour
{
#pragma warning disable 0649
    [SerializeField] private DialogBase dialogPrefab;
    [SerializeField] private Transform dialogTran;
#pragma warning restore 0649
    
    private DialogBase dialogInstance;  // 生成済のダイアログを代入して保持しておく


    void Start() {
        this.UpdateAsObservable()
            .Where(_ => Input.GetKeyDown(KeyCode.A))
            .ThrottleFirst(System.TimeSpan.FromSeconds(1.0f))
            .Subscribe(_ => OpenDialog());


////*　処理を追加します　*////


        this.UpdateAsObservable()
            .Where(_ => Input.GetKeyDown(KeyCode.Escape))
            .Where(_ => dialogInstance)
            .ThrottleFirst(System.TimeSpan.FromSeconds(1.0f))
            .Subscribe(_ =>
            {
                if (dialogInstance.Hide()) {
                    Debug.Log($"Android 端末の BackKey が押されたので、ダイアログを閉じます {dialogInstance.name}");
                }
            });


////*　ここまで　*////


    }

    /// <summary>
    /// ダイアログ表示
    /// </summary>
    private void OpenDialog() {
        
        // ダイアログが生成されていない場合
        if (dialogInstance == null) {

            // 生成、初期設定
            dialogInstance = Instantiate(dialogPrefab, dialogTran, false);

　　　　　　// 引数として UnityAction 型のデリゲートを活用し、CloseDialogAction メソッドをダイアログ側に渡す
            //dialogInstance.SetUp(() => CloseDialogAction());

　　　　　　dialogInstance.SetUp(itemData => CloseDialogAction(itemData));  // 引数付の場合
        }
        
        // ダイアログ表示   
        dialogInstance.Show();
    }

    /// <summary>
    /// ダイアログが非表示になったときに実行されるコールバック
    /// </summary>
    private void CloseDialogAction() {
        Debug.Log("ダイアログが非表示になりました");
    }

    /// <summary>
    /// ダイアログが非表示になったときに実行されるコールバック
    /// 引数付
    /// </summary>
    /// <param name="chooseItemData"></param>
    private void CloseDialogAction(ItemData chooseItemData) {


////*　処理を修正します　*////


        if (chooseItemData == null) {
            Debug.Log("選択された情報はありません");
            return;
        }
        Debug.Log($"Dialog 内で選択された情報が届きました : {chooseItemData.id}");
        

        // 上記の if 文分岐処理を三項演算子で記述した場合
        Debug.Log(chooseItemData != null ? $"Dialog 内で選択された情報が届きました : {chooseItemData.id}" : "選択された情報はありません");


////*　ここまで　*////


    }
}

　キーボードの「Escape」キーを押すとダイアログを閉じるためのトリガーを設定します。
dialogInstance が存在し、ダイアログを非表示にすることができる場合、ダイアログを閉じます。
そして非表示すると Hide メソッドの戻り値が返ることにより、ログの表示処理を続けて実行する仕組みになっています。

　CloseDialogActionメソッドは、ダイアログが非表示になったときに呼び出されるコールバック処理です。
引数なしのバージョンと、ItemData を引数として受け取るバージョンが定義されています。
このメソッド内で、ダイアログが非表示になったことをログに記録しています。

　今回の修正により、ItemData が null でない場合、ItemData の id フィールドをログに表示します。
null の場合は「選択された情報はありません」と表示します。

まとめ

　if 文内で戻り値のあるメソッドを実行し、その戻り値を活用することで、ダイアログの表示状態を変更した上で処理を実行していくことが出来ます。

　コールバック処理の引数の値も変化するため、それに合わせて処理を作成しておくことで、null の場合であっても処理を停止させずに動くようにしています。

　このようにデリゲート、およびメソッドの戻り値を組み合わせると、大変柔軟な処理設計を行うことが出来るようになります。

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

印刷する

コメント（0）

デリゲートの実装例④ - i-school 先頭へ

コメントをかく

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

i-school