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

関連記事

openMVGをWindows10 Visual Studi...

geometry3Sharp:Unity C#で使えるポリゴ...

UnityのuGUIチュートリアル

OpenCVの顔検出過程を可視化した動画

マルコフ連鎖モンテカルロ法

OpenCVの三角測量関数『cv::triangulatep...

C++の抽象クラス

ブログの復旧が難航してた話

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

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

PyDataTokyo主催のDeep Learning勉強会

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

ディープラーニング

C++始めようと思うんだ

書籍『OpenCV 3 プログラミングブック』を購入

畳み込みニューラルネットワーク (CNN: Convolut...

Multi-View Environment:複数画像から3...

続・ディープラーニングの資料

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

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

Swark:コードからアーキテクチャ図を作成できるVSCod...

pythonの機械学習ライブラリ『scikit-learn』

iOSで使えるJetpac社の物体認識SDK『DeepBel...

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

ドットインストールのWordPress入門レッスン

SVM (Support Vector Machine)

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

Geogram:C++の3D幾何アルゴリズムライブラリ

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

C++ 標準テンプレートライブラリ (STL)

ManuelBastioniLAB:人体モデリングできるBl...

hloc:SuperGlueで精度を向上させたSfM・Vis...

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

BGSLibrary:OpenCVベースの背景差分ライブラリ

HerokuでMEAN stack

クラスの基本

ArUco:OpenCVベースのコンパクトなARライブラリ

CycleGAN:ドメイン関係を学習した画像変換

MPFB2:Blenderの人体モデリングアドオン

Mean Stack開発の最初の一歩

まだ続くブログの不調

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

コメント