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に適した設計方法ってのをのんびり模索していきたい。上手く長所を活かせる方法が見つかるといいなぁ。

関連記事

Mask R-CNN:ディープラーニングによる一般物体検出・...

組み込み向けのWindows OS 『Windows Emb...

PyTorch3D:3Dコンピュータービジョンライブラリ

WordPress on Windows Azure

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

Mechanizeで要認証Webサイトをスクレイピング

書籍『仕事ではじめる機械学習』を読みました

手を動かしながら学ぶデータマイニング

Amazon Web ServicesでWordPress

Google Chromecast

VCG Library:C++のポリゴン操作ライブラリ

Iterator

html5のcanvasの可能性

UnityのuGUIチュートリアル

ZBrushのZScript入門

Raspberry Pi

フォトンの放射から格納までを可視化した動画

NumSharp:C#で使えるNumPyライクな数値計算ライ...

法線マップを用意してCanvas上でShadingするサンプ...

UnityからROSを利用できる『ROS#』

タマムシっぽい質感

Super Resolution:OpenCVの超解像処理モ...

オープンソースの物理ベースGIレンダラ『appleseed』

ブラウザ操作自動化ツール『Selenium』を試す

OpenVDB:3Dボリュームデータ処理ライブラリ

ドラマ『ファーストクラス』のモーショングラフィックス

クラスの基本

3D復元技術の情報リンク集

NeuralNetwork.NET:.NETで使えるTens...

Iridescence:プロトタイピング向け軽量3D可視化ラ...

Pythonの自然言語処理ライブラリ『NLTK(Natura...

機械学習手法『Random Forest』

オープンソースの物理ベースレンダラ『Mitsuba』をMay...

WebGL開発に関する情報が充実してきている

Kubric:機械学習用アノテーション付き動画生成パイプライ...

OpenCV 3.1のsfmモジュールのビルド再び

JavaScriptとかWebGLとかCanvasとか

OpenCVでカメラ画像から自己位置認識 (Visual O...

書籍『3次元コンピュータビジョン計算ハンドブック』を購入

Unite 2017 Tokyoに行ってきた

このブログのデザインに飽きてきた

UnityでPoint Cloudを表示する方法

コメント