Version: 2021.1
LanguageEnglish
  • C#

AnimatorJobExtensions

class in UnityEngine.Animations

/

Implemented in:UnityEngine.AnimationModule

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

Static class providing extension methods for Animator and the animation C# jobs.

The extension methods in this class can directly be used on an Animator.

See Also: IAnimationJobPlayable.

Static Methods

AddJobDependencyCreates a dependency between animator jobs and the job represented by the supplied job handle. To add multiple job dependencies, call this method for each job that need to run before the Animator's jobs.
BindCustomStreamPropertyCreate a custom property in the AnimationStream to pass extra data to downstream animation jobs in your graph. Custom properties created in the AnimationStream do not exist in the scene.
BindScenePropertyCreate a PropertySceneHandle representing the new binding on the Component property of a Transform in the Scene.
BindSceneTransformCreate a TransformSceneHandle representing the new binding between the Animator and a Transform in the Scene.
BindStreamPropertyCreate a PropertyStreamHandle representing the new binding on the Component property of a Transform already bound to the Animator.
BindStreamTransformCreate a TransformStreamHandle representing the new binding between the Animator and a Transform already bound to the Animator.
CloseAnimationStreamClose a stream that has been opened using OpenAnimationStream.
OpenAnimationStreamOpen a new stream on the Animator.
ResolveAllSceneHandlesNewly created handles are always resolved lazily on the next access when the jobs are run. To avoid a cpu spike while evaluating the jobs you can manually resolve all handles from the main thread.
ResolveAllStreamHandlesNewly created handles are always resolved lazily on the next access when the jobs are run. To avoid a cpu spike while evaluating the jobs you can manually resolve all handles from the main thread.
UnbindAllSceneHandlesRemoves all PropertySceneHandles and TransformSceneHandles associated with the Animator instance. Use this method to manage the lifecycle of scene handles when the animated hierarchy changes.
UnbindAllStreamHandlesRemoves all PropertyStreamHandles and TransformStreamHandles associated with the Animator instance. Use this method to manage the lifecycle of stream handles when the animated hierarchy changes.