Version: 2019.1 (switch to 2018.3 or 2017.4)
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

AnimationPlayableOutputExtensions.SetAnimationStreamSource

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

public static void SetAnimationStreamSource(Animations.AnimationPlayableOutput output, Experimental.Animations.AnimationStreamSource streamSource);

Parameters

outputThe AnimationPlayableOutput instance that calls this method.
streamSourceThe AnimationStreamSource to apply on this output.

Description

Sets the stream source for the specified AnimationPlayableOutput.

When setting the AnimationStreamSource of the output to AnimationStreamSource.DefaultValues, the AnimationStream of this output initalizes every frame with the default values of the Animator.

When setting the AnimationStreamSource of the output to AnimationStreamSource.PreviousInputs, the AnimationStream of this output initalizes every frame with the result of any previously evaluated outputs on the same Animator.

If you use the graph connected to an AnimationPlayableOutput to post-process the result of other Animation graphs connected to the same Animator, you should use AnimationStreamSource.PreviousInputs. For example, if you use the AnimationStream to build an Inverse Kinematics constraint to post-process the built-in AnimatorController, your AnimationPlayableOutput should be set to AnimationStreamSource.PreviousInputs.

In order to start the AnimationStream from a blank slate, you should use AnimationStreamSource.DefaultValues. For example, to build a custom animation source starting from the default pose, the AnimationPlayableOutput should be set to AnimationStreamSource.DefaultValues.

See Also: AnimationStreamSource.

Did you find this page useful? Please give it a rating: