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

　２回の手順に分けて学習します。
オブジェクトプールのベースとなる機能を汎用性のある設計で作成しておき、それを継承することで様々な用途に応用できる実装例です。

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

１．説明

　記事では、以下の内容に焦点を当てて解説します。

汎用性のあるクラスの基本設計

　オブジェクト指向の原則を適用して、共通の振る舞いを抽象クラスとして実装し、汎用性・再利用性を高めるアプローチを探ります。

２．PoolBase クラスの作成

　PoolBase クラスは抽象クラスであり、継承を前提とした、ゲームオブジェクトをオブジェクトプールに対応させるための親クラスとして設計されています。

　これにより、継承先の子クラスはオブジェクトプール機能を簡単に利用できるようになります。
いわば共通の機能を提供するために作成します。

PoolBase.cs

<= クリックしたら開きます。

using UnityEngine;
using UnityEngine.Pool;

/// <summary>
/// オブジェクトプール化するための汎用クラス
/// </summary>
public abstract class PoolBase : MonoBehaviour {

    protected IObjectPool<PoolBase> objectPool;

    // ObjectPool への参照を与えるプロパティ
    public IObjectPool<PoolBase> ObjectPool { get => objectPool; set => objectPool = value; }
}

　定義しているメソッドはありません。
IObjectPool 型の objectPool 変数と、同じく IObjectPool 型の ObjectPool プロパティの２つを定義しています。

　objectPool 変数は、このクラスを継承しているクラスに、オブジェクトプールの機能を対応出来るようにしています。

　ObjectPool プロパティは、オブジェクトプールへの参照を保持し、このゲームオブジェクトをオブジェクトプールへ返却する際に利用します。

１．オブジェクトプールへの対応

　PoolBase クラスは、IObjectPool<PoolBase> 型の objectPool 変数を持ち、そのプロパティを通じてオブジェクトプールへの参照を持つことができます。これにより、オブジェクトは簡単にプールから取得・返却されるようになります。

２．クラス間の共通性を確保

　PoolBase クラスを継承することで、異なる種類のゲームオブジェクトが共通のプール機能を持つことができます。これにより、例えばプレイヤーキャラクターや敵キャラクター、アイテムなどが容易にプールから生成・返却されるようになります。

３．クラス間の疎結合性の促進

　PoolBase クラスを利用することで、クラス間の依存性が低減されます。各クラスは共通のプール機能を利用するだけで、他のクラスと効率的に連携することができます。

４．拡張性と保守性の確保

　新しい種類のゲームオブジェクトを追加する際に、PoolBase クラスを継承するだけで簡単にプール機能を持たせることができます。これにより、新しいオブジェクトの追加が容易になり、新しい要素を簡単に統合しつつ、保守のしやすいコードが実現できます。

　総合すると、PoolBase クラスは、ゲーム内で共通のプール機能を提供し、コードの柔軟性と保守性を向上させるための基盤として重要な役割を果たしています。特に、大量のオブジェクト生成と破棄が発生するゲーム開発において、その有効性は顕著です。

３．GeneratorBase クラスの作成

　抽象クラスとして GeneratorBase クラスを作成します。

　実装にあたり、各メソッドを仮想(virtual)メソッドとして定義します。
仮想メソッドでは共通の振る舞いを実装していますが、具体的な振る舞いについてはサブクラスに委ねています。

GeneratorBase.cs

<= クリックしたら開きます。

using UnityEngine;
using UnityEngine.Pool;

/// <summary>
/// 生成用基底クラス
/// 敵、フロート表示、アイテムなどに汎用的に利用する設計
/// </summary>
public abstract class GeneratorBase : MonoBehaviour {

    protected IObjectPool<PoolBase> objectPool;                 // オブジェクトプール

#pragma warning disable 0649
    [SerializeField] protected int initialPoolSize = 5;         // オブジェクトプールの初期サイズ
    [SerializeField] protected PoolBase objectPoolPrefab;       // プールさせるプレハブ
#pragma warning restore 0649


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

        // ObjectPool の初期化
        objectPool = new ObjectPool<PoolBase>(
            createFunc: () => Create(),
            actionOnGet: OnGetFromPool,
            actionOnRelease: target => target.gameObject.SetActive(false),
            actionOnDestroy: target => Destroy(target.gameObject),
            collectionCheck: true,
            defaultCapacity: 10,
            maxSize: 1000);
    }

    /// <summary>
    /// Get() メソッドにより、createFunc として実行される
    /// </summary>
    /// <returns></returns>
    protected virtual PoolBase Create() {
        PoolBase objectPoolInstance = Instantiate(objectPoolPrefab);

        // 参照を与えておく(依存性注入する)ことで、フロート表示側で Release できる
        objectPoolInstance.ObjectPool = objectPool;

        //Debug.Log("生成");
        return objectPoolInstance;
    }

    /// <summary>
    /// bulletPool.Get() メソッドにより、actionOnGet として実行される
    /// </summary>
    /// <param name="target"></param>
    protected virtual void OnGetFromPool(PoolBase target) => target.gameObject.SetActive(true);

    /// <summary>
    /// 外部クラスより実行する
    /// Get() メソッドにより、オブジェクトプールから弾を取り出して戻す → OnGetFromPool メソッドが実行される
    /// プール内に弾がない場合には新しく生成して戻す → Create メソッドが実行される
    /// </summary>
    /// <param name="position"></param>
    /// <param name="rotation"></param>
    /// <returns></returns>
    public virtual PoolBase GetObjectFromPool(Vector3 position, Quaternion rotation) {
        PoolBase pooledObject = objectPool.Get();
        pooledObject.transform.position = position;
        pooledObject.transform.rotation = rotation;

        //Debug.Log("取得");
        return pooledObject;
    }

    /// <summary>
    /// 上記メソッドの UI オブジェクト生成用
    /// </summary>
    /// <param name="parentTran"></param>
    /// <returns></returns>
    public virtual PoolBase GetObjectFromPool(Transform parentTran) {
        PoolBase pooledObject = objectPool.Get();
        pooledObject.transform.SetParent(parentTran, false);
        pooledObject.transform.localScale = Vector3.one;

        //Debug.Log("取得");
        return pooledObject;
    }
}

　GeneratorBase クラスは抽象クラスであり、敵キャラクターやフロート表示、アイテムなど、さまざまな目的で使用されるオブジェクトの生成に利用されます。このクラスを継承することで、オブジェクトプールを利用した効率的なオブジェクト生成が可能となります。

　つまり、オブジェクトプールの基盤となる親クラスです。

　以下はその設計と実装についての説明です。

１．抽象クラスとしての GeneratorBase

　GeneratorBase クラスは抽象クラスであり、各メソッドは仮想メソッドとして定義されています。これにより、必要に応じてサブクラスでの実装がオーバーライドできる状態になっています。共通の生成処理を持ちながら、サブクラスごとの特別な処理については、サブクラスに委ねることができます。

　この設計により、共通の振る舞いを仮想クラスで定義しておき、必要に応じて、個別の振る舞いをサブクラスでカスタマイズすることができます。

２．オブジェクトプールの初期化

　GeneratorBase クラスには、オブジェクトプールを初期化するための InitObjectPool メソッドが含まれています。このメソッドは、オブジェクトプールの生成、取得、解放、破壊の各処理を設定します。

３．プール用オブジェクトの生成

　Create メソッドは、オブジェクトプールを利用した新しいオブジェクトの生成を行います。このメソッドは仮想メソッドとして定義されており、サブクラスでのオーバーライドが可能です。

４．オブジェクトの取得とリリース

　GetObjectFromPool メソッドは、オブジェクトプールからオブジェクトを取得して位置と回転を設定します。また、UIオブジェクト生成用のオーバーロードも提供されています。
　

　GeneratorBase クラスは、ゲーム内で共通のオブジェクト生成機能を提供し、コードの再利用性と保守性を向上させるための基盤として重要な役割を果たしています。抽象クラスとすることで、サブクラスでの柔軟な実装を可能にし、オブジェクトプールを利用した効率的なオブジェクト生成が実現できます。

　以上で完成です。

　次の手順では、エフェクト機能を汎用的なオブジェクトプールとして利用する場合の実装例を学習します。

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

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

印刷する

コメント（0）

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

コメントをかく

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

i-school