Version: 1.10
LanguageEnglish
  • C#

AnimationClipEvaluator

struct in UnityEngine.Animations

/

Implemented in:UnityEngine.AnimationModule


Implements interfaces:IPlayable

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

An AnimationClipEvaluator that evaluates an AnimationClip at an explicit time, without auto-advancing.

Use AnimationClipEvaluator when you need precise control over the evaluation time, such as distance matching or frame-accurate scrubbing. Unlike AnimationClipPlayable, this playable does not advance time automatically and requires explicit time or frame values to be set via SetExplicitTime or SetExplicitFrame.

Public Methods

FindTimeFromDistanceFinds the time (in seconds) on the specified curve that corresponds to the given distance. Used for distance matching.
GetAnimationClipReturns the AnimationClip currently assigned to this evaluator.
GetApplyFootIKReturns the state of the ApplyFootIK flag.
GetApplyPlayableIKReturns the state of the ApplyPlayableIK flag.
GetExplicitFrameGets the explicit evaluation frame index.
GetExplicitTimeGets the explicit evaluation time in seconds.
GetUseFrameInsteadOfTimeGets whether frame-based evaluation is being used instead of time-based evaluation.
SetAnimationClipSets the AnimationClip that will be evaluated by this evaluator.
SetApplyFootIKSets the value of the ApplyFootIK flag.
SetApplyPlayableIKSets the value of the ApplyPlayableIK flag.
SetClipWithInertializationBlendSets the AnimationClip and blends from the current pose to the new clip using inertialization.
SetExplicitFrameSets the explicit evaluation frame index. The frame is internally converted to time using the clip's sample rate.
SetExplicitTimeSets the explicit evaluation time in seconds, replacing auto-advancing time with a user-controlled value.
SetUseFrameInsteadOfTimeSets whether to use frame-based evaluation instead of time-based evaluation.

Static Methods

CreateCreates an AnimationClipEvaluator in the PlayableGraph.