【Unity】Animatorのプロパティやステートへのアクセスを容易にするエディタ拡張

f:id:tsubaki_t1:20150731001908p:plain

ふと思いついて、Animatorのステートやパラメータに定数でアクセスする為のコードを自動生成するエディター拡張を作成しました。

導入方法は

ファイルをインポートするだけです。

https://github.com/tsubaki/Unity-AnimatorAccessHelper/blob/master/AnimatorAccessHelper.unitypackage?raw=true

この機能を使用するモチベーション

Animatorがインポートされた際にAnimatorの持つステートやパラメータへアクセスする為のハッシュ値を持つクラスを作成します。パラメータへのアクセスにはプロパティ・トリガーへのアクセスはメソッドを使うようになり、typoの防止やアクセスが楽になります。

Animaotrを使用

animator.SetFloat ("FloatParameter", 32);
var result = animator.GetFloat ("FloatParameter");

自動生成コードの使用

controller.FloatParameter = 32;

var result = controller.FloatParameter;

もう一つのモチベーションはハッシュ値の使用です。Unity - マニュアル: パフォーマンスと最適化にも書かれている通り、Animatorの最適化要因の一つとしてハッシュ値の利用があります。このハッシュ値ですが実行時に文字列から生成するのも馬鹿らしいので、定数として格納しクラスから取得する形に変更します。

ランダムにメモリを格納するリストを含むクラスはGCが遅くなる傾向があるらしく、文字列のようなオブジェクトをクラスに文字列を含める気にならなかったのもモチベーションの一つです。

[Unite 2015 TOKYO]Unity パフォーマンス・チューニング on Vimeo

f:id:tsubaki_t1:20150731004020p:plain

機能の内容

ベースはImporterのエディタ拡張です。AnimationControllerのインポートが行われると自動的に無慈悲にコードを作成します。

コードは、パラメータへのアクセスはプロパティ、ステートへのアクセスは定数で格納されます。深い階層を持つ場合、「.」の部分が「_」に変換されます。

作成したコードは、Animatorと同じパスに作成されます。その後もAnimatorの位置に従って常に動き、Animatorが削除されるとファイルも削除されます。つまりAnimationControllerに対して１：１でコードが作成されます。

f:id:tsubaki_t1:20150731084226g:plain

クラス名もAnimationControllerと同じ名前になるので、名前の重複には注意が必要です。また、同じフォルダにコードが無かった場合プロジェクトを探して取得する関係上、同一AnimatorControllerがある場合は注意が必要です。

なおAnimationControllerの更新タイミングはAnimationControllerを更新したタイミングではなく「メタデータが更新されるタイミング」です。つまりProjectのSave時です。

Unity開発者が複数人で開発を進める上で覚えておくと幸せになる９つの事 - テラシュールブログ

f:id:tsubaki_t1:20150731004420p:plain

コンパイル済みコードではなく単純なコードを出力してる理由は、DOMが面倒だったのと、プロジェクト内で使用していないアセットを削除するエディタ拡張を試作中 - テラシュールブログがコンパイル済みコードを取り除けないという、凄く個人的な理由です。下の図ではSampleController.csはDemo2シーンでしか使ってないので、Demo2が含まれないプロジェクトでは削除対象になっています。

f:id:tsubaki_t1:20150731081727p:plain