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分の動画でプログラミングを学習できるサイト『ドットインストール』

Blendify:コンピュータービジョン向けBlenderラッパー

Unity ARKitプラグインサンプルのドキュメントを読む

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

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

ZBrushのZScript入門

OpenCVのfindEssentialMat関数を使ったサンプルを読んでみる

3Dモデルを立体視で確認できるVRアプリを作っている

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

ZScript

Amazon EC2ログイン用の秘密鍵を無くした場合の対処方法

UnityでOpenCVを使うには?

SVM (Support Vector Machine)

openMVG:複数視点画像から3次元形状を復元するライブラリ

HD画質の無駄遣い

Quartus II

Theia:オープンソースのStructure from Motionライブラリ

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

OpenCVの三角測量関数『cv::triangulatepoints』

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

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

CGレンダラ研究開発のためのフレームワーク『Lightmetrica (ライトメトリカ)』

viser:Pythonで使える3D可視化ライブラリ

まだ続くブログの不調

3Dスキャンしたテクスチャから照明を除去するUnityツール『De Lighting tool』

Raspberry Pi

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

機械学習で遊ぶ

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

Mean Stack開発の最初の一歩

Python拡張モジュールのWindows用インストーラー配布サイト

hloc:SuperGlueで精度を向上させたSfM・Visual Localization

NeuralNetwork.NET:.NETで使えるTensorFlowライクなニューラルネットワー...

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

Iterator

網元AMIで作ったWordpressサイトのインスタンスをt1microからt2microへ移行した

AnacondaとTensorFlowをインストールしてVisual Studio 2015で使う

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

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

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

iOSで使えるJetpac社の物体認識SDK『DeepBelief』

コメント