メインコンテンツへスキップ

イチから始める!MA式アバターギミック ベストプラクティス(後編)

    イチから始める!MA式ギミック ベストプラクティス(前編) では、そもそもの仕組みベースの解説となったため、殆ど公式ドキュメントの紹介になってしまいました。
    ここからは、実際にモジュール構造でアバターギミックを組む際の注意点を見ていきましょう。

    ギミック制御のモジュール化

    AnimationClip の相対パスと絶対パス

    Animator コンポーネントは1つの Animator Controller (以下 Controller)を持つ事ができて、この Controller の遷移条件に従って、どの AnimationClip を再生するかを制御する…という流れでアニメーションを実行します。
    そして AnimationClip は、"どの"オブジェクトの"何を"動かすのかがアニメーションキーとして記載されたファイルです。ここでオブジェクトの指定は、Hierarchy 上で Animator コンポーネントが付いたオブジェクトを基点(ルートオブジェクト)とした、オブジェクト名階層を元にしたパスで表記されます。

    画像
    参考:AnimationClip のパス(オブジェクト名階層)

    これが意味するところは、Animator でアニメーションさせられるのはAnimator の子孫オブジェクトのみ、という事です。元々 Animator 自体がモジュール構造的な考えで動くという訳ですね。
    参考:https://tsubakit1.hateblo.jp/entry/2018/02/08/203747

    一方 Avatars3.0 はというと、アバターのルートオブジェクト(VRC Avatar Descriptor が付いたオブジェクト)に一緒に付いている Animator に、Playable Layers にセットされた各種 Controller を"合体"させたものをセットして動かす、的な事をしています。つまり、アバターのルートを基点としたパスの AnimationClip でないと、正常にアバターギミックを動かせません。

    これを受けて、MA Marge Animator はパスモードという概念を持っています。
    パスモードが"相対的"の場合は、このコンポーネントが付いたオブジェクト(相対的パスのルートが指定されている場合は、指定したオブジェクト)からの相対パスとして AnimationClip を解釈したうえで、結合時にアバターのルートからのパスに変換します。これにより、MA Marge Animator を付けたオブジェクトより上のオブジェクト名階層を意識しなくても良い作りとなっています。
    パスモードが”絶対的”の場合、上記の変換処理はせずに Controller を結合します。これは既存ギミックの AnimationClip を流用するのには便利ですが、ギミックの Prefab を置く先のアバター階層やボーン名が異なると動かなくなる他、Prefab のリネームもできなくなる縛りが発生するため、配布ギミックには向かないので非推奨です。
    (なお MA Merge Animator のドキュメントにもあるとおり Humanoid アニメーションはパスが影響しません。いずれにせよ Playable Layers の仕様から FX 以外への組み込みになるため、どのみち別 Controller に分けて組み込む事になります。)

    画像
    絶対パス・相対パスの位置関係の例

    相対パスモードでアニメーションを録画するなら当然、アバターのルートでないオブジェクトがアニメーションの基点になります。 アニメーションを録画するときに、相対パスのルートにしたいオブジェクトに Animator を付けてギミック用の Controller をセットしたいわけです。
    MA Merge Animator はそのことも織り込み済みなので、「付属アニメーターを削除」にチェックを入れておけば、録画用に付けた Animator を付けっぱなしにしておけます。(この運用の場合、「相対的パスのルート」は空欄のまま使わないでおきましょう)

    Write Defaults への対応

    画像
    Write Defaults 設定はステートにある

    Unity の Animator にはアニメーションの設定を簡便にするために、ステートが遷移した等でアニメーションをやめたプロパティに対して、アニメーションする前(=デフォルト)の値に書き戻す機能を持ちます。そしてこれをステート単位で無効にする(アニメーションをやめたらやめた状態のままにする)事もできる項目として、Write Defaults (以下WD)という項目があります。
    一見便利機能なんですが、なんとこの機能、オンにしてもオフにしてもバグが存在します。
    また、Controller 内で WD が不揃いの場合も、別のレイヤーに跨がって期待する動作をしなくなるバグがあります。
    参考:https://tsubakit1.hateblo.jp/entry/2017/01/15/233000
    参考:https://x.com/bd_j/status/1638490749414301696

    ①初期状態(ビルド前)でシェープキーが0でないこと
    ②該当シェープキーを操作するアニメーションが存在する
    ③どのレイヤーでも操作していない状態になっている
    ④MirrorReflectionではない
    ⑤WriteDefaultsが使用されている(どのステートに必要かが未検証)

    — bd_ (@bd_j) March 22, 2023

    VRChat は Avatars3.0 実装当時、Write Defaults (以降 WD)をオンにして組んでいました。しかしすぐに WD オフで組むように方針変換、さらに現在では、アバター内(=全ての Playable Layers の Controller)で統一されていればオンかオフかは問わない(ただしデフォルトではオフ)、という方針になっています。

    これを受けて、MA Marge Animator には「アバターのWrite Defaults設定に合わせる」チェックボックスがあり、アバターの統合先レイヤー内の WD 設定状況に合わせて、組み込む Controller 内の WD 設定を一括で切り替える機能を持ちます。
    ここまでの話をまとめると、MA Merge Animator の設定は基本的に以下画像のようにして使うのが良いでしょう。

    画像
    参考:MA Merge Animator の設定

    上記に加えて、WD にまつわるバグは、WD がオンでもオフでも問題無い(=WD に依存しない)ようにアニメーションを組む事で回避できます。ギミックは WD 非依存で作りましょう。作るべきです。
    やる事は簡単で、ひとたびアニメーションさせたプロパティは、常に Controller 内のどこかのレイヤーのステートでアニメーションさせ続けるようになっていればOKです。例えば、

    • オブジェクトのアクティブを切り替えるギミックなら、"アクティブにする" AnimationClip とセットで"非アクティブにする" AnimationClip も用意する

    • 一つのレイヤー内(または BlendTree 内)の全ての AnimationClip が(値違いの)同じプロパティを持つようにする

    • 上段レイヤーに、下段レイヤーで扱う全てのプロパティの"デフォルト値"を再生し続けるだけのレイヤーを置いておき、下段レイヤーで値を変化させたいプロパティだけを持った AnimationClip を切り替える構造にする(簡易の表情制御でよく使われる手法)

    のような組み方が考えられます。

    Direct Blend Tree という例外

    WD に依存するなと言った直後に掌を返しますが、一部高度なアニメーションの組み方では WD オンに依存せざるを得ないものがあり、その一つに Direct Blend Tree を使ったレイヤー圧縮技術があります。
    他のレイヤーが WD オフでも、レイヤーに Direct Blend Tree のステートが一つだけの場合は WD オンにしても他レイヤーに影響しない、という事が知られています。
    https://vrc.school/docs/Other/DBT-Combining

    これを受けて MA でも Direct Blend Tree は特別扱いするようになっているほか、一つの Direct Blend Tree レイヤーに単発 Blend Tree や AnimationClip を詰め込むための専用コンポーネントとして MA Merge Motion (Blend Tree)も用意されています。
    扱う原理が中上級者向けになるため先述のコンポーネント紹介には書いてませんが、こういうのもあるよという事で、ここで紹介しておきます。

    どうしても WD に依存したい場合

    この記事ではアバターに後付けするギミックの話をしているワケですが、WD に依存したギミックを作るということは、WD の設定をギミックがアバターに合わせるのではなく、アバターがギミックに合わせる必要がある事になります。これではモジュール設計思想に合いません。
    それでもどうしても、という事もあるでしょう。そうすると次に立ちはだかるのが、「VRChat ではアバターカリングで消えている間、そのアバターの Animator (=Playable Layers)を停止させる」という仕様です。
    これもまた WD 非依存の組み方なら問題は半減しますが、依存するなら特に対策が必要です。そこで VRChat は、VRChat の定義済みパラメーターの一つに IsAnimatorEnabled を用意しています。これはアバターカリング等でアバターの Animator が停止する1フレーム前に false になり、再開すると true になるパラメーターです。Animator が停止する直前に Animator で事前対処が取れるワケです。

    ギミック操作のモジュール化

    Playable Layers (Animator Controller) が Ma Merge Animator で統合されるように、Expression Menu (以降 ExMenu)アセットファイルは MA Menu Installer で、Expression Parameters (以降 ExParams)アセットファイルは MA Parameters でアバターに統合することができます。

    画像
    ExParams を「アセットからインポートする」にセットする毎にパラメーターが追加される
    画像
    ExMenu は「インストールされるメニュー」にセットした Control が実行時に統合される

    一方、コンポーネント上の設定(= Hierarchy 上の構成)だけで完結できた方が、Prefab 化する時に便利です。MA はそのための機能を持ちます(どちらかというと、そっちを使うのが前提の機能となっています)。
    この記事ではギミックを新規に作りたいので、わざわざアセットファイルを作らず、直接 MA のコンポーネントから設定しましょう。

    MA Parameters を設定する

    MA Parameters は自身と同じか子孫オブジェクトにある Animator または MA Merge Animator の Controller 、または Physbone にあるパラメーターを「未登録パラメーター」に一覧してくれます。よって、基本的には MA Merge Animator と共に Prefab のルートオブジェクトに付けて設定していくのが良いでしょう。
    基本的には名称がちょっと違うだけで Expression Parameters アセットファイルに設定する事と同じ内容(型、初期値、同期する、保存する)を設定できます。

    MA Parameters は加えて、パラメーター名のリネーム機能を持ちます。これが非常に強力で、特に「自動リネーム」は基本チェックを付けた方が良い項目です。これによりアバターが元々持っていたり、別のギミックが持っているパラメーターとうっかり被って統合される事故を防げます。
    なんなら上手く設定されていれば、同じギミックの Prefab を二つ入れても個別に動かす事が可能になります。

    リネームしなければ同じパラメーターとして統合できるとも言えるので、連携できるようにあえて設定しない使い方も考えられます。
    逆に、統合目的で(型と)名前を別のギミックのパラメーター名と一致させるリネームをする事もできます。

    画像
    MA Parameters 設定イメージ

    MA Menu 系コンポーネントで ExMenu を組む

    MA Menu 系コンポーネント群を組み合わせる事で、Hierarchy 上でメニューの並び順やメニューの階層構造を編集できるため、ExMenu アセットで設定するのに比べて大幅に見通し良くできます。また、ExMenu アセットファイル単体だと Control のパラメーターを正しく設定しきれない(対になるExParams アセットファイルも必要)ところも気にしなくて良くなります。是非 MA Menu 系コンポーネントを使いこなしましょう。

    MA Menu Installer は最終的に組み合わせたメニュー構造をアバターに組み込むのに必要、という話は繰り返ししていますが、では他は…というと、実は  MA Menu Item だけを覚えればとりあえずOKです。
    MA Menu Item を Sub Menu タイプに設定すれば、子オブジェクトの MA Menu Item が Control として含まれるサブメニューを構成できます。もちろん、子オブジェクトの MA Menu Item を更に Sub Menu タイプにして孫オブジェクトに MA Menu Item を追加する事もできます。
    なお、MA Menu Item を付けたオブジェクトの名前が Control の名前(表示名)になります。
    あとの MA Menu Item の設定内容は ExMenu アセットのそれと同じです。(Radial Puppet 系でスライダー操作が反映されるのは「パラメーター名」ではなく「ラジアルメニュー用パラメーター名」の方、というのも含めて)
    結構なんかいい感じにプレビューしてくれるので、あとは実際に触って見て覚えていくのが早いと思います。

    画像
    MA Menu Item でメニューを組むイメージ

    ここまでのまとめ(ギミック制御の組み込みの基本形)

    ここまでで制御に関わるMAコンポーネント… MA Merge Animator, MA Parameters, MA Menu 系の説明をしてきました。ギミックを作るからにはこの三点セットはほぼほぼ必須かつ、Prefab ルートに付いている方が便利な事が多いでしょう。

    画像
    参考:ギミック制御の組み込みの基本形

    MA Menu 系だけオブジェクトを分けて、メニューだけの Prefab にしたものをギミックの主 Prefab に組み込む形を取るのもアリだと思います。このように Hierarchy 上だけで自由に組み立てられるのが MA の利点です。

    画像
    参考:MA Menu 系だけ別 Prefab にした形

    なお、MA Menu Group というコンポーネントを上手く使うことで、よりメニュー関連の設定が楽になります。詳しくは以下の記事を読んでみてください。

    オブジェクト(コンポーネント)のモジュール化

    ここからは、アニメーションで動かされる実体となるオブジェクトの構築手法を見ていきましょう。
    早速ですが、モジュール化(≒単独 Prefab 化)するなら、アバターに組み込んだあと Unpack して中身のオブジェクトをアバターの特定ボーンの子に移して…などという導入手順にするべきでは無いでしょう。

    基本は MA Bone Proxy

    Unpack しなくてもアバターのボーン側に組み込む事が出来ます。そう、MA Bone Proxy ならね。

    直接ボーンの子に入れたいもの…例えば手(Hand)に持たせたいだけの食器、頭の上(Head)に乗せたいだけのヘイロー。こういった物は直接 MA Bone Proxy を付けて設定すれば良いでしょう。
    当然ながら、アバターによってボーンの位置は大きく違います。よって配置モードも基本的には「子として・ワールド位置と向きを維持」にして、各々のアバターに合わせて位置と向きを微調整するようにすれば良いでしょう。

    Physbone Collider や Contact なども Root Transform を空にしたまま MA Bone Proxy を付けて、MA Bone Proxy の機能で直接ボーンの子に入れる方が良いでしょう。

    ただボーンの子に入れるだけでなく、持たせるボーンを切り替えたいだとか、ワールド固定したいだとかには Constraint を使います。
    VRChat アバターでは(Unity製の) Constraint と VRC Constraint が使えます…が、VRC クライアント側で全て VRC Constraint に変換されています。この変換処理はオンデマンドにやっているらしく、直に VRC Constraint を付けるより重いようです。よって特に事情が無ければ、最初から VRC Constraint で組んでしまえば良いでしょう。VRC Constraint の方が Unity Constraint より機能豊富というのもあります。
    https://creators.vrchat.com/avatars/avatar-dynamics/constraints/

    ※なお、MA には、ビルド時に変換する事で VRC クライアント上では既に VRC Constraint 状態にできるコンポーネントを持っています。
    あえてこれを利用して、Unity Constraint のみで組んでしまう手もあります。
    https://modular-avatar.nadena.dev/ja/docs/reference/convert-constraints

    閑話休題。Constraint で追従先を切り替える基本的な使い方は、切り替えたい先を一通り Sources に追加しておき、アニメーションから Weight 値を切り替える(追従させたいたった一つの Weight を1に、それ以外を0にする)形です。

    ここで Sources に直接アバターのボーンをセットしたくなりますが… 一工夫します。MA Bone Proxy を付けた空オブジェクト(以下 Pivot オブジェクト)を作り、更に子オブジェクト(以下 Offset オブジェクト)を作って、Offset オブジェクトを Source としてセットしましょう。
    ここで、Constraint 側はオフセット値を全て0にしたいので、[Zero] ボタンで設定するようにしましょう。
    MA Bone Proxy の配置モードはアバターのボーンにざっくり位置が合うように「子として・ワールド向きを維持」にします。
    ここまでの設定で、Pivot オブジェクトはアバターのターゲットボーンと同じ位置に重なったうえでターゲットボーンの子になります。その子である Offset オブジェクトの方に Constraint は重なり追従しにいくので、Offset オブジェクトの位置と向きを微調整することで、ターゲットボーンとの相対位置と向きを調整できます。
    (まさにプロキシー的な使い方ですね。)

    画像
    Constraint を組み込む基本形

    この使い方は、LookAt / Aim Constraint の World Up Object など、他に Humanoid ボーンを指定したいような項目にも応用が利きます。

    ワールド固定

    アバターギミックでワールド固定したい要求は、昔から一定の需要がありました。そのため様々な手法が存在しますが、現在主流なのは以下の二通り。
    割とどちらも一長一短ありますが、モジュール設計的にはどちらでも、ギミックに応じて好きな方採用すれば良いです。また、どの場合でも Constraint のモジュール的設定は先述の手法が使えます。

    • MA World Fixed Object を使うか、このコンポーネントが採用している理屈を自力で実装する

    • VRC Constraint の Freeze To World プロパティをアニメーションさせる

    MA World Fixed Object を採用する場合、このコンポーネントを付けたオブジェクトかその子孫オブジェクトにも Constraint を付けて、アニメーションで Constraint を無効にしている間にワールド固定される、というやり方になります。

    Freeze To World でワールド固定する場合は逆に VRC Constraint 自身がワールド座標を記憶して留まろうとする方式のため、VRC Constraint が有効である必要があります。

    主観視点の Head ボーン

    ローカルの(=自分が今着ている)アバターは、主観視点の邪魔にならないように Head ボーンのスケールを0にする特殊処理がされています。(実はミラーやカメラに映るローカルアバターは、Head のスケールを操作しない複製体です。)
    これが何を意味するかというと、主観視点では Head ボーンの子孫に移したボーン(オブジェクト)位置が全て Head ボーンと同じ位置になる、ということです。オフセットが重要なものには、必要に応じて MA Visible Head Accessory を付けましょう。VRC Head Chop を通じて、Head ボーンとの相対位置が維持されます。

    Contacts のモジュール化

    Contacts の Collision Tags はどちらかというと同ギミックの他アバターと共有したい傾向がある設定項目なので出番は薄いかもしれませんが、逆に言うとうっかりタグ名が被ったギミック同士が混線する可能性があります。
    ギミックのルートに MA Rename VRChat Collision Tags を付けて、名前被りを避けたい Collision Tag の「自動リネーム」にチェックを入れると良いでしょう。
    逆に名前を揃える目的でリネームするのにも使えます。

    音のモジュール化

    アバターで音の再生をしたいとき、基本的には VRC Spatial Audio Source のドキュメントにあるように、Play On Awake にチェックを入れておいた Audio Source の有効無効をアニメーションで切り替えることで管理すれば良く、モジュール設計的にも考えることは変わりません。

    しかし Audio Source コンポーネントを節約しつつより高度な制御ができる、VRC Animator Play Audio というステートビヘイビアを使いたいことがあると思います。これはステートビヘイビアでありながら、(今のところ)唯一、再生対象の Audio Source コンポーネントを指定する必要があります。
    このとき Audio Source はアバターのルートからの絶対パスでの指定になります。(Source Path で確認できます)

    画像
    VRC Animator Play Audio ステートビヘイビア

    MA Merge Animator は VRC Animator Play Audio をサポートしているため、相対パスモードなら Source Path も相対パスと解釈してアバターに統合します。ただし、(今のところ) Source Path の自動補正的な機能は無いので、Audio Source コンポーネントをセットしたら、Source Path を手動で相対パスに書き換えておく必要があります。
    https://github.com/bdunderscore/modular-avatar/releases/tag/1.10.0

    あとがき

    なかなかの文章量になってしまいましたが、それだけ VRChat のアバターギミックは奥が深く、後付けギミックとして"元アバターを壊さない"組み方をするのは難しいものです。この記事が、その一助となることを願って…

     
     
    Unityと和解したい… Unityと和解したくない?

    あなたへのおすすめ