Spineイベント内でAnimationState.Applyをするとスタックオーバーフローが発生します

koyu2

こんにちは。いつもお世話になっています。

アニメ描画中にトラックの異なるアニメをSetAnimationしたり、別のアニメに遷移するイベントを作成して運用していました。
しかし、イベントが二重に発火するなど挙動が怪しい部分があり、調べてみるとAnimationState.Apply()がスタックオーバーフローを起こしていることが分かりました。

public class _TestSpine : MonoBehaviour
    {
        SkeletonAnimation skeletonAnimation;
        private TrackEntry track1;
        private TrackEntry track2;

        private void Start()
        {
            skeletonAnimation = GetComponent<SkeletonAnimation>();
            skeletonAnimation.AnimationState.Event += Spine_Event;
            SetSkin();
            StartCoroutine(TEST());
        }

        //-------------------------------------------------------------------------------------------

        public IEnumerator TEST()
        {
            yield return new WaitForSeconds(1f);
            track1 = skeletonAnimation.AnimationState.SetAnimation(1, "test", false);
        }

        private void Spine_Event(TrackEntry trackEntry, Spine.Event spineEvent)
        {
            switch (spineEvent.Data.Name)
            {
                case "_TEST":
                    Debug.Log("SpineEvent_:_TEST");
                    track2 = skeletonAnimation.AnimationState.SetAnimation(2, "Add/Breathing_High", true);
                    track2.MixBlend = MixBlend.Add;
                    skeletonAnimation.AnimationState.Apply(skeletonAnimation.Skeleton);

                    break;
            }
        }

    }

上記コードは検証用に最低限の処理に絞りました。この場合、一瞬動作が停止した後、スタックオーバーフローの赤エラーが出て、ゲームが続行します。
不思議なことに、処理を最低限に絞る前のゲーム用のメソッドでは赤エラーが発行されず、上記TESTイベントが二回実行されゲームが続行していました。
また、上記TESTイベントをskeletonAnimation.AnimationState.Apply(skeletonAnimation.Skeleton);のみとすると、赤エラーも出ず、Unityが完全にフリーズしてしまいます。

実際のゲーム内処理ではSetAnimation()だけでなく、SetToSetUpPose()なども使用したうえで最後にskeletonAnimation.AnimationState.Apply();を行っているため、正常に動作されず困っています。
なぜスタックオーバーフローが起こってしまうのでしょうか？

プロジェクトのスケジュール上、使用しているランタイムはspine-unity-4.2-2026-02-05.unitypackage
で、エディタのverは4.2.43です。

Spinebot

こんにちは。ご質問ありがとうございます。

スタックオーバーフローが発生している原因は、イベントハンドラー内で AnimationState.Apply() を呼び出しているためです。

問題の原因

AnimationState.Event は、AnimationState.Apply() の内部処理中に発火します。そのため、イベントハンドラー内で再び Apply() を呼び出すと、以下のような無限再帰が発生します:

Apply() → イベント発火 → イベントハンドラー実行 → Apply() → イベント発火 → ...

これがスタックオーバーフローの原因です。

解決方法

イベントハンドラー内では AnimationState.Apply() を呼び出さないでください。SetAnimation() などのアニメーション設定だけを行い、Apply() は通常のゲームループ(通常は SkeletonAnimation コンポーネントが自動的に行います)に任せてください。

修正後のコード例

private void Spine_Event(TrackEntry trackEntry, Spine.Event spineEvent)
{
    switch (spineEvent.Data.Name)
    {
        case "_TEST":
            Debug.Log("SpineEvent_:_TEST");
            track2 = skeletonAnimation.AnimationState.SetAnimation(2, "Add/Breathing_High", true);
            track2.MixBlend = MixBlend.Add;
            // Apply()は呼び出さない！
            break;
    }
}

SkeletonAnimation コンポーネントは自動的に毎フレーム以下の処理を行います:

AnimationState.Update(deltaTime)
AnimationState.Apply(skeleton)
Skeleton.UpdateWorldTransform()

そのため、イベントハンドラー内でアニメーション設定を変更すれば、次のフレームで自動的に反映されます。

注意事項

もし、どうしても即座に変更を反映させたい場合は、AnimationState.Update(0) を呼んでから Apply() を呼ぶ必要がありますが、イベントハンドラー内では推奨されません:

// イベントハンドラー内では使用しないでください
state.SetAnimation(0, "jump", false);
state.Update(0); // 内部状態を更新
state.Apply(skeleton);

この方法でも無限再帰のリスクがあるため、基本的にはイベントハンドラー内では SetAnimation() などの設定のみを行い、Apply() は呼び出さないことをお勧めします。

ご不明な点がございましたら、お気軽にお尋ねください。

Harald

@koyu2 Spinebot's reply is basically correct.

Do any of the animations have events at the first frame (time 0.0)? If so, calling state.Apply() will trigger the respective event, causing a potential stack overflow due to your code. You could either not call state.Apply(), or otherwise set some state which only ever calls state.SetAnimation() once per frame through the event callback.