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

関連記事

Accord.NET Framework:C#で使える機械学...

Unityで画面タッチ・ジェスチャ入力を扱う無料Asset『...

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

Unityの各コンポーネント間でのやり取り

JavaScriptとかWebGLとかCanvasとか

OpenCVのfindEssentialMat関数を使ったサ...

機械学習で遊ぶ

AnacondaとTensorFlowをインストールしてVi...

UnityユーザーがUnreal Engineの使い方を学ぶ...

書籍『ROSプログラミング』

IronPythonを使ってUnity上でPythonのコー...

CGALDotNet:計算幾何学ライブラリ CGALのC#ラ...

Google App Engine上のWordPressでF...

3DCG Meetup #4に行ってきた

Unityで360度ステレオVR動画を作る

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

網元AMIで作ったWordpressサイトのインスタンスをt...

C#で使える遺伝的アルゴリズムライブラリ『GeneticSh...

Webサイトのワイヤーフレームが作成できるオンラインツール

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

Mayaのプラグイン開発

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

UnityのTransformクラスについて調べてみた

CGレンダラ研究開発のためのフレームワーク『Lightmet...

MVStudio:オープンソースのPhotogrammetr...

OpenMesh:オープンソースの3Dメッシュデータライブラ...

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

WordPress on Windows Azure

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

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

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

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

Dlib:C++の機械学習ライブラリ

Google App Engineのデプロイ失敗

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

konashiのサンプルコードを動かしてみた

Theia:オープンソースのStructure from M...

iPhoneアプリ開発 Xcode 5のお作法

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

Unity Scriptコーディング→Unreal Engi...

Kornia:微分可能なコンピュータービジョンライブラリ

OpenCVでiPhone6sのカメラをキャリブレーションす...

コメント