Version: 2019.4
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

IAnimationWindowPreview

interface in UnityEngine.Experimental.Animations

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Allows a class to modify how an AnimationClip is sampled in the Animation window by providing its own Playable nodes to the Animation window PlayableGraph. The class must also inherit from MonoBehaviour.

using UnityEngine;
using UnityEngine.Animations;
using UnityEngine.Experimental.Animations;
using UnityEngine.Playables;

[RequireComponent(typeof(Animator))] public class ExampleScript : MonoBehaviour, IAnimationWindowPreview { public Vector3 offset = Vector3.zero;

private AnimationScriptPlayable m_Playable; private AnimationJob m_Job; private Vector3 m_CurrentOffset;

struct AnimationJob : IAnimationJob { public TransformStreamHandle transform; public Vector3 offset;

public void ProcessRootMotion(AnimationStream stream) { Vector3 position = transform.GetLocalPosition(stream); position += offset;

transform.SetLocalPosition(stream, position); }

public void ProcessAnimation(AnimationStream stream) { } }

public void StartPreview() { m_CurrentOffset = offset; }

public void StopPreview() { }

public void UpdatePreviewGraph(PlayableGraph graph) { if (m_CurrentOffset != offset) { m_Job.offset = offset; m_Playable.SetJobData(m_Job);

m_CurrentOffset = offset; } }

public Playable BuildPreviewGraph(PlayableGraph graph, Playable input) { Animator animator = GetComponent<Animator>();

m_Job = new AnimationJob(); m_Job.transform = animator.BindStreamTransform(transform); m_Job.offset = offset;

m_Playable = AnimationScriptPlayable.Create(graph, m_Job, 1);

graph.Connect(input, 0, m_Playable, 0);

return m_Playable; } }

Public Methods

BuildPreviewGraphAppends custom Playable nodes to the Animation window PlayableGraph.
StartPreviewNotification callback when the Animation window starts previewing an AnimationClip.
StopPreviewNotification callback when the Animation window stops previewing an AnimationClip.
UpdatePreviewGraphNotification callback when the Animation Window updates its PlayableGraph before sampling an AnimationClip.