Skip to main content

SpringBone Runtime

VRM10Viewerを参照してください。

v0.127 import 時の Springbone Runtime 切り替えについて​

clss Vrm10Importer {
  public Vrm10Importer(
    Vrm10Data vrm,
    IReadOnlyDictionary<SubAssetKey, UnityEngine.Object> externalObjectMap = null,
    ITextureDeserializer textureDeserializer = null,
    IMaterialDescriptorGenerator materialGenerator = null,
    bool useControlRig = false,
    ImporterContextSettings settings = null,
    IVrm10SpringBoneRuntime springboneRuntime = null // 👈
  )
}

この引き数により SpringBone の Runtime をカスタマイズできます。

  • new Vrm10FastSpringboneRuntime (default)
  • new Vrm10FastSpringboneRuntimeStandalone

を渡してください。 null の場合は Vrm10FastSpringboneRuntime になります。

v0.127 scene 配置時の Springbone Runtime 切り替えについて​

  • Vrm10FastSpringboneRuntimeProvider
  • Vrm10FastSpringboneRuntimeStandaloneProvider

をアッタチしてください。

v0.128 editor の scene play 時は Standalone 版がデフォルトになります​

  • Vrm10FastSpringboneRuntimeStandalone

になります。

Vrm10FastSpringboneRuntime​

vrm-1.0 default の SpringBone Runtime です。

特徴​

  • Unity job system で実装されている
  • すべての Vrm の SpringBone を Singleton でまとめて処理する
    • 非play時に動作できません。DontDestroyOnLoad

FastSpringBoneService(シングルトン)について​

FastSpringBone が実行されると、FastSpringBone Service GameObject が DontDestroyOnLoad で生成されます。

[DefaultExecutionOrder(11010)]
public sealed class FastSpringBoneService : MonoBehaviour
{
  public static FastSpringBoneService Instance
  {
    get {
      DontDestroyOnLoad(gameObject);
    }
  }

  private void LateUpdate()
}

これは全 VRM の FastSpringBone を集め、バッファの構築や FastSpringBone の実行タイミングの制御などを行う GameObject です。

note

明示的に破棄を行いたい場合は FastSpringBoneService.Free を呼んでください。

Vrm10FastSpringboneRuntimeStandalone​

Vrm10FastSpringboneRuntime と同じ job を使用します。シングルトンでは無いバージョンです。

特徴​

  • Unity job system で実装されている
  • vrm-1.0 の update 処理の 6 番目に実行される
public class Vrm10Runtime : IDisposable
{
  public void Process()
  {
      // 1. Update From VrmAnimation
      // 2. Control Rig
      // 3. Constraints
      // 4. Gaze control
      // 5. Apply Expression
      // 6. SpringBone
      SpringBone.Process(); // 👈
  }
}

Runtime の操作​

v0.128.0

Runtime を取得する​

Vrm10Instance から取得してください。

Vrm10Instance vrm;
IVrm10SpringBoneRuntime springboneRuntime = vrm.Runtime.Springbone;

再構築する​

SpringBone の構成が変わったり、T-Poseが変わった場合に最初から再構築します。 重い処理となります。

Vrm10Instance vrm;
vrm.Runtime.Springbone.ReconstructSpringBone();
info

モデルのスケーリングを変更した場合は、呼び出しが必要です。 初期値の中にスケーリングの影響を受ける項目があるためで、最初期化が必要です。

初期姿勢にする​

すべての Joint の localRotation を初期化したときの値に戻します。

Vrm10Instance vrm;
vrm.Runtime.Springbone.RestoreInitialTransform();

model level​

namespace UniGLTF.SpringBoneJobs.Blittables
{
    public struct BlittableModelLevel
    {
        /// <summary>
        /// World 座標系の追加の力。風など。
        /// </summary>
        public Vector3 ExternalForce;

        /// <summary>
        /// 処理結果の Transform への書き戻しを停止する。
        /// </summary>
        public bool StopSpringBoneWriteback;

        /// <summary>
        /// スケール値に連動して SpringBone のパラメータを自動調整する。
        /// (見た目の角速度が同じになるようにする)
        /// </summary>
        public bool SupportsScalingAtRuntime;
    }
}

Vrm10Instance vrm;
vrm.Runtime.Springbone.SetModelLevel(vrm.transform, new {
  StopSpringBoneWriteback = true,
  SupportsScalingAtRuntime = true,
  ExternalForce = new Vector3(x, y, z),
});

StopSpringBoneWriteback: 一時停止する​

SpringBone の処理は継続しますが、結果を Transform に書き戻す処理を停止します。

ExternalForce: 外力​

風など一時的な外からのフォースを加えます。

note

world座標です。

note

gravity 設定と同じ効果です。 model 一体に対してまとめて force を加えることができます。

SupportsScalingAtRuntime: Scaling のモード変更​

joint level​

stiffness, dragForce などのパラメーター変更を反映します。 再構築より軽量です。

// TODO
Vrm10Instance vrm;
Vrm10SpringBoneJoint joint;
vrm.Runtime.Springbone.SetModelLevel(joint.transform, joint.Blittable);