汎用的なオブジェクトプールの実装例②

　前回に引き続き、オブジェクトプールのベースとなる機能を作成しておき、それを継承することで様々な用途に応用できる実装例です。

　敵の生成、アイテムの生成、ボタンの生成、フロート表示の生成など、オブジェクトプールの活用できる範囲は広いため、
それらに対して汎用的に実装を行うための設計になっています。

４．フロート表示用のゲームオブジェクトを作成し、プレハブにする

　それでは１つの例として、ゲーム内のフロート表示をオブジェクトプールで共通化して利用する方法の実装例です。
プレイヤーキャラや敵キャラの上に表示される、ダメージ値や回復値を表すものです。
一定時間後に画面から消え、次のダメージなどが発生した場合には再度生成処理が必要になるため、
このオブジェクトを再利用するためにオブジェクトプールの機能を利用します。

　フロート表示は利用頻度が高いため、オブジェクトプールの恩恵を存分に受けることが出来ます。

１．設計

　フロート表示では、文字の色やサイズを変えたり、数値を変える処理が必要になります。
例えば、通常ダメージは白字、敵からのダメージは赤字、などです。
オブジェクトプールを利用しない場合であっても、これらの設定処理は毎回必要になる処理になりますので、
再利用を考えていく際にも、どの部分を初期化して再設定をおこなっていけばよいか、わかりやすいオブジェクトでもあります。

＜オブジェクトを再利用の際に、その都度、再設定する必要のある要素＞

　１．数値　　　　　ダメージや回復値など
　２．文字色  　　　文字色を変える処理を入れている場合には、その都度、色を設定し直す
　３．文字サイズ　　同上
　４．位置　 　　　 配置する位置。プレイヤー上なのか、敵上なのか

　このようにリスト化して書き出しておくと管理しやすくなります。
他にもある場合には、リスト化(可視化)して管理するようにしておきましょう。

２．フロート表示用のゲームオブジェクトを作成し、プレハブにする

　下記は作成例です。

５．フロート表示用のクラスの作成を行う

１．設計

　フロート表示のプレハブの管理には、オブジェクトプールの機能を利用します。
生成されたプレハブはオブジェクトプールの機能を持たせ、繰り返し再利用できるようにします。

　１．ISetup インターフェース
　２．FloatingViewGenerator クラス
　３．IPoolable インターフェース
　４．TextViewBase クラス(PoolBase を継承したサブクラス)
　５．FloatingView クラス(TextViewBase クラスを継承したサブクラス)

　１と３はインターフェースですので、これらはゲームオブジェクトにはアタッチできません。
また４は親クラスとなり、フロート表示以外の TextMeshPro コンポーネントを利用した他の画面表示処理にも利用できるクラスです。

　そのため、２と５を作成し、これを適宜なゲームオブジェクトにアタッチします。
５については、フロート表示のプレハブにアタッチし、プレハブ内のコンポーネントの制御を行えるようにします。

２．ISetup インターフェースの作成

　各クラスの初期設定を強制・共通化させる目的のインターフェースです。
インターフェースですので、必ずほかのクラスに実装して利用します。

ISetup.cs

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

using UnityEngine;

/// <summary>
/// 初期設定共通化用のインターフェース
/// </summary>
public interface ISetup {
    void SetUp(GameObject entityObject = null);
}

３．FloatingViewGenerator クラスの作成

　ISetup インターフェースを実装し、Setup メソッドの実装の強制と共通処理が行える状態にします。
また MonoBehaviour クラスの代わりに GeneratorBase クラスを継承し、実装したクラスにオブジェクトプール用の共通メソッドを提供します。

FloatingViewGenerator.cs

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

using UnityEngine;

/// <summary>
/// フロート表示生成クラス
/// </summary>
public class FloatingViewGenerator : GeneratorBase, ISetup {

    public static FloatingViewGenerator instance;

    void Awake() {
        if (instance == null) {
            instance = this;
            DontDestroyOnLoad(gameObject);
        } else {
            Destroy(gameObject);
        }
    }

    /// <summary>
    /// 初期設定 
    /// </summary>
    /// <param name="entityObject"></param>
    public void SetUp(GameObject entityObject) {

        // ObjectPool の初期化
        InitObjectPool();

        //Debug.Log($"{this} Setup 完了");
    }
}

　
　フロート表示用のプレハブをオブジェクトプールを利用して管理するためのクラスです。

　GeneratorBase クラスにオブジェクトプールの基本的な挙動は定義済みです。
そのため、GeneratorBase を継承している子クラスは、必要なメソッドのみをオーバーロード、
あるいは新しいメソッドや変数を追加するだけで、指定したオブジェクトのオブジェクトプールとしての機能を作成することが可能になっています。

４．IPoolable インターフェースの作成

　インターフェースです。実装したクラスにオブジェクトプール用の共通メソッドを提供します。
そのためこのインターフェースは主に、オブジェクトプールによって再利用されるオブジェクト機能を有するクラスに実装します。

IPoolable.cs

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

/// <summary>
/// オブジェクトプールを利用して再利用されるクラスに実装するインターフェース
/// 使用用途としては、エフェクト、敵、弾、ドロップアイテム、フロート表示など
/// </summary>
public interface IPoolable {
    void Release();
}

５．TextViewBase クラスの作成(PoolBase クラスを継承したサブクラス)

　TextViewBase クラスは PoolBase を継承している子クラスです。
TextMeshPro(あるいは Text)コンポーネントの機能を制御し、文字を画面に表示するための機能を提供します。

　このクラスも親クラスとして利用しますので、さらに別の子クラスを作成し、それぞれの振る舞いを変えるように設計しておきます。

TextViewBase.cs

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

using UnityEngine;
using Cysharp.Threading.Tasks;
using TMPro;

/// <summary>
/// Text 表示の基底クラス
/// </summary>
public class TextViewBase : PoolBase {

#pragma warning disable 0649
    [SerializeField] protected TextMeshProUGUI txtView;
    [SerializeField] protected CanvasGroup canvasGroupTextView;
    [SerializeField] protected Canvas canvasView;
#pragma warning restore 0649


    /// <summary>
    /// Text 表示更新
    /// </summary>
    /// <param name="newMessage"></param>
    /// <returns></returns>
    public virtual async UniTask UpdateText(string newMessage) {
        ShowText();
        txtView.text = newMessage;
        await UniTask.Yield();
    }

    // public virtual void UpdateCounterText(float oldValue, float newValue) {
    //     txtView.DOCounter(oldValue, newValue, duration).SetEase(Ease.InQuart);
    // }

    /// <summary>
    /// 初期設定
    /// </summary>
    /// <param name="newMessage"></param>
    public virtual void SetUpView(string newMessage) {
        UpdateText(newMessage).Forget();

        if (canvasView.worldCamera == null) {
            canvasView.worldCamera = Camera.main;
        }
    }

    /// <summary>
    /// Text 表示
    /// </summary>
    public virtual void ShowText() {
        canvasGroupTextView.alpha = 1.0f;
        canvasView.enabled = true;
    }

    /// <summary>
    /// Text 非表示
    /// </summary>
    public virtual void HideText() {
        //canvasGroupTextView.alpha = 0f;
        canvasView.enabled = false;
    }
}

６．FloatingView クラスの作成(TextViewBase クラスを継承したサブクラス)

　TextViewBase クラスを継承したサブクラスになります。
親クラスに定義されている UpdateText メソッドをオーバーライドしていますが、
それ以外には必要な変数とメソッドを新しく定義しています。

　また IPoolable インターフェースを実装することで、
オブジェクトプールへ戻すための Release メソッドを定義し、オブジェクトプールへ戻る際の挙動を定義しています。

FloatingView.cs

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

using UnityEngine;
using DG.Tweening;
using Cysharp.Threading.Tasks;

/// <summary>
/// フロート表示用
/// </summary>
public class FloatingView : TextViewBase, IPoolable {

    [SerializeField] private bool isAnimOn;

    [SerializeField] private float moveScale;
    [SerializeField] private float moveDuration;
    [SerializeField] private Ease fadeOut = Ease.InOutExpo;

    [SerializeField] private float dodgeFontSize = 18.0f;
    [SerializeField] private float criticalFontSize = 24.0f;
    [SerializeField] private float normalFontSize = 24.0f;

    // アニメ設定用
    [SerializeField] private float minAngle = -45.0f;    // 上空方向の角度の最小値
    [SerializeField] private float maxangle = 45.0f;     // 上空方向の角度の最大値

    [SerializeField] private float launchForce = 2.0f;   // 上空方向への発射力
    [SerializeField] private float bounceWidth = 3.5f;   // 左右方向の距離
    [SerializeField] private float fallHeight = 0.5f;    // 落下距離
    [SerializeField] private float fallTime = 0.35f;     // 落下にかかる時間

    [SerializeField] private int numBounces = 2;         // バウンドの回数
    [SerializeField] private float bouncePower = 0.5f;   // バウンドの強さ
    [SerializeField] private float bounceRate = 1.25f;   // バウンドの補正倍率
    [SerializeField] private float duration = 0.35f;     // 落下後のバウンドの時間

    private float defaultScale = 0.1f;                   // フロート表示の初期サイズ

    [Header("プレイヤーに表示する文字の色")]
    [SerializeField] private Color playerNormalDamageColor;
    [SerializeField] private Color playerDodgeColor;
    [SerializeField] private Color playerCriticalColor;

    [Header("敵に表示する文字の色")]
    [SerializeField] private Color enemyNormalDamageColor;
    [SerializeField] private Color enemyDodgeColor;
    [SerializeField] private Color enemyCriticalColor;


    /// <summary>
    /// フロート表示更新
    /// </summary>
    /// <param name="newMessage"></param>
    /// <returns></returns>
    public override async UniTask UpdateText(string newMessage) {
        base.UpdateText(newMessage).Forget();

        // アニメさせる場合
        if (isAnimOn) {
            Bounce();
        }

        await UniTask.Delay(System.TimeSpan.FromSeconds(moveDuration));

        //// オブジェクトプールへ戻す
        Release();
    }

    /// <summary>
    /// 文字の色を設定
    /// </summary>
    /// <param name="entityType"></param>
    /// <param name="viewType"></param>
    public void SetColor(EntityType entityType, FloatingViewType viewType) {

        // EntityType と FloatingViewType の組み合わせで文字の色を変える
        txtView.color = (entityType, viewType) switch {
            (EntityType.Player, FloatingViewType.normalDamage) => playerNormalDamageColor,
            (EntityType.Player, FloatingViewType.dodge) => playerDodgeColor,
            (EntityType.Player, FloatingViewType.critical) => playerCriticalColor,
            (EntityType.Enemy, FloatingViewType.normalDamage) => enemyNormalDamageColor,
            (EntityType.Enemy, FloatingViewType.dodge) => enemyDodgeColor,
            (EntityType.Enemy, FloatingViewType.critical) => enemyCriticalColor,
            _ => Color.white
        }; ;
    }

    /// <summary>
    /// 文字の色を初期色(白)に戻す
    /// </summary>
    private void SetDefaultColor() {
        txtView.color = Color.white;
    }

    /// <summary>
    /// フォントサイズの変更
    /// </summary>
    /// <param name="viewType"></param>
    public void SetViewFontSize(FloatingViewType viewType)
    {
        switch (viewType)
        {

            case FloatingViewType.dodge:
                txtView.fontSize = dodgeFontSize;
                break;

            case FloatingViewType.critical:
                txtView.fontSize = criticalFontSize;
                break;

            case FloatingViewType.normalDamage:
                txtView.fontSize = normalFontSize;
                break;

            default:
                break;
        }
    }

    /// <summary>
    /// オブジェクトプールへ戻す
    /// </summary>
    public void Release() {
        // 文字の色を白に戻す
        SetDefaultColor();

        // フェードアウトした後に初期値に戻す
        canvasGroupTextView.alpha = 1.0f;
        transform.localScale = Vector3.one * defaultScale;

        //Debug.Log(objectPool);
        ObjectPool.Release(this);
    }

    private void Bounce() {
        // プレイヤーの位置を中心にランダムな角度を生成
        float randomAngle = Random.Range(minAngle, maxangle);

        // ランダムな角度を UI の発射方向として設定
        Vector3 launchDirection = Quaternion.Euler(0, 0, randomAngle) * Vector3.up;

        Sequence sequence = DOTween.Sequence();

        // UI の移動先の設定(放物線になるように順番にセット)
        Vector3[] path = {
            new(transform.position.x, transform.position.y, 0),  // スタート地点
            transform.position + launchDirection * launchForce,  // 発射方向と最大地点
            new(transform.position.x + (launchForce * launchDirection.x) * 2, transform.position.y - (launchForce * launchDirection.y), 0)  // 落下地点
        };

        // UI の放物線移動
        sequence.Append(transform.DOPath(path, fallTime));

        // 落下後の移動とサイズ
        sequence.Append(transform.DOJump(
            new Vector3(transform.position.x + (bounceWidth * launchDirection.x) * 1.25f, transform.position.y - fallHeight, 0),
            bouncePower, numBounces, duration));

        sequence.Join(transform.DOScale(Vector3.zero, duration));
    }
}

６．フロート表示用のプレハブに FloatingView クラスをアタッチする

　フロート表示用のプレハブに FloatingView クラスをアタッチします。
色や DOTween 用のアニメ数値の設定は任意に設定してください。

　下記にサンプル値を掲載しておきます。

７．実装する

　フロート表示用を利用したいタイミングで FloatingViewGenerator の GetObjectFromPool メソッドを実行します。

　以上でこの手順は終了です。

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

印刷する

コメント（0）

汎用的なオブジェクトプールの実装例② - i-school 先頭へ

コメントをかく

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

i-school