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

関連記事

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

TensorFlowでCGを微分できる『TensorFlow Graphics』

OpenCV バージョン4がリリースされた!

Deep Fluids:流体シミュレーションをディープラーニングで近似する

3DCG Meetup #4に行ってきた

iOSデバイスと接続して連携するガジェットの開発方法

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

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

UnityでARKit2.0

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

OpenGVの用語

PyMC:Pythonのベイズ統計ライブラリ

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

OpenCVで動画の手ぶれ補正

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

GAN (Generative Adversarial Networks):敵対的生成ネットワーク

オープンソースの物理ベースレンダラ『Mitsuba』をMayaで使う

UnrealCLR:Unreal Engineで.NET Coreを利用できるプラグイン

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

ニューラルネットワークで画像分類

PythonでMayaのShapeノードプラグインを作る

SVM (Support Vector Machine)

OpenCVで顔のモーフィングを実装する

iOSデバイスのためのフィジカル・コンピューティングツールキット『konashi(こなし)』

Verilog HDL

OpenCVのバージョン3が正式リリースされたぞ

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

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

1枚の画像からマテリアルを作成できる無料ツール『Materialize』

Javaで作られたオープンソースの3DCGレンダラ『Sunflow』

WinSCP

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

OpenCV 3.1とopencv_contribモジュールをVisual Studio 2015で...

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

Unityの薄い本

Google App Engineのデプロイ失敗

cvui:OpenCVのための軽量GUIライブラリ

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

『手を動かしながら学ぶエンジニアのためのデータサイエンス』ハンズオンセミナーに行ってきた

Human Generator:Blenderの人体生成アドオン

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

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

コメント