UnityのMonoBehaviourクラスをシングルトン化する

何を隠そう、ここ2年ほど仕事でUnityを使っているオイラです。

UnityでC#のScriptを作成しようとすると、デフォルトでMonoBehaviourクラスを継承したクラスが作成される。このMonoBehaviourクラスはUnityとやり取りするための様々な機能がすでに実装されていてとても便利。ただ、個々のGameObjectが独立して動作させるような時には自由度が高くて良いんだけど、この自由度が逆に管理しづらいこともあるのです。

例えば、ゲーム全体を一元管理する情報を扱うような場合、あるいは外部のアプリケーションやKinectみたいなセンサーとやり取りするインターフェイスを作る場合、そのクラスのインスタンスは唯一にしておきたい。知らないうちに複数出来ちゃったら大混乱だ。

ということで、MonoBehaviourクラスの便利さを保ったままシングルトンにする方法を探したら、良い方法を見つけた。

Unity Technologies Japanの元エバンジェリスト伊藤さんが翻訳したこの記事↓
http://warapuri.tumblr.com/post/28972633000/unity-50-tips

29、シングルトンは便利だ

こんな感じで自動的にシングルトンが作られるようにしておくといい。

public class Singleton<T> : MonoBehaviour where T : MonoBehaviour
{
   protected static T instance;
 
   /**
      Returns the instance of this singleton.
   */
   public static T Instance
   {
      get
      {
         if(instance == null)
         {
            instance = (T) FindObjectOfType(typeof(T));
 
            if (instance == null)
            {
               Debug.LogError("An instance of " + typeof(T) + 
                  " is needed in the scene, but there is none.");
            }
         }
 
         return instance;
      }
   }
}

シングルトンはParticleManager とか AudioManager とか GUIManager.とかマネージャーに役に立つ。

  • マネージャーではない固有インスタンス(プレイヤーとか)にシングルトンを使うのは止めよう。(以下略)
  • クラスの外側から利用されるために、staticなプロパティと関数を定義しておこう。こうしておくと、GameManager.Playerと書けるようになる(GameManager.Instance.playerという書き方ではなく)

あとはこれを継承して任意のクラスを作るだけ。例えばこんな感じ。

using UnityEngine;
 
public class GameManager : SingletonMonoBehaviour<GameManager> {
     
    public void Awake(){
        if(this != Instance){
            Destroy(this);
            return;
        }
 
        DontDestroyOnLoad(this.gameObject);//シーン遷移しても破棄されない設定
    }    
     
}

そして、同じような要件でシーン遷移後もMonoBehaviourクラスを破棄せずに存続させたい場合は、上記のようにAwake()メソッドでの初期化時に

 DontDestroyOnLoad(this.gameObject);

という記述を加えれば、Script(MonoBehaviourクラス)の親となるGameObjectがシーン遷移後も存続するようになる。

Unityは、ささっと動く物を作るには本当に便利だけど、ややカチッとしたものを作ろうとするとMonoBehaviourクラスの特殊さが壁になっちゃったりもする。
システム開発してた人間からすると、MVCにならない時点で頭を抱えちゃうんだけど、Unityに適した設計方法ってのをのんびり模索していきたい。上手く長所を活かせる方法が見つかるといいなぁ。

関連記事

3分の動画でプログラミングを学習できるサイト『ドットインストール』

Open3D:3Dデータ処理ライブラリ

SDカードサイズのコンピューター『Intel Edison』

OpenCV 3.3.0-RCでsfmモジュールをビルド

PythonでBlenderのAdd-on開発

ブログのデザイン変えました

Raspberry Piでセンサーの常時稼働を検討する

Math Inspector:科学計算向けビジュアルプログラミングツール

オープンソースのロボットアプリケーションフレームワーク『ROS (Robot Operating S...

書籍『ゼロから作るDeep Learning』で自分なりに学ぶ

ディープラーニング

OpenMVSのサンプルを動かしてみる

Pythonのソースコードに特化した検索エンジン『Nullege』

ポリゴンジオメトリ処理ライブラリ『pmp-library (Polygon Mesh Process...

WordPressの表示を高速化する

PeopleSansPeople:機械学習用の人物データをUnityで生成する

OpenAR:OpenCVベースのマーカーARライブラリ

OANDAのfxTrade API

OpenGVのライブラリ構成

OpenCVで顔のランドマークを検出する『Facemark API』

ZScript

3DCG Meetup #4に行ってきた

Unity Scriptコーディング→Unreal Engine Scriptコーディング

Structure from Motion (多視点画像からの3次元形状復元)

Unity MonoBehaviourクラスのオーバーライド関数が呼び出される順番

TensorSpace.js:ニューラルネットワークの構造を可視化するフレームワーク

openMVGをWindows10 Visual Studio 2015環境でビルドする

Windows10でPyTorchをインストールしてVSCodeで使う

WordPressのサーバ引っ越し方法を考える

OpenMVS:Multi-View Stereoによる3次元復元ライブラリ

SONY製のニューラルネットワークライブラリ『NNabla』

iPhone x ロボットハッカソン~RomoのiPhone用SDKで目覚ましアプリを作る~

Zibra Liquids:Unity向け流体シミュレーションプラグイン

LuxCoreRender:オープンソースの物理ベースレンダラ

OpenCV

まだ続くブログの不調

Google製オープンソース機械学習ライブラリ『TensorFlow』のWindows版が公開された

オープンソースの顔認識フレームワーク『OpenBR』

OpenCVで平均顔を作るチュートリアル

株式会社ヘキサドライブの研究室ページ

DensePose:画像中の人物表面のUV座標を推定する

WordPressプラグインによるサイトマップの自動生成

コメント