Class AnimationClip

Represents a timeline clip than plays back an Animation clip on an AnimationTrack

Inheritance

Object

DOTSClip

AnimationClip

Inherited Members

DOTSClip.Clip

DOTSClip.AnimatedFields

DOTSClip.CreatePlayable(PlayableGraph, GameObject)

DOTSClip.OnEnable()

DOTSClip.OnDisable()

DOTSClip.CreateClipEntity(ConversionContext)

DOTSClip.Convert(Entity, ConversionContext)

DOTSClip.OnCurvesModified(Entity, EntityManager)

DOTSClip.DeclareReferencedPrefabs(ConversionContext, List<GameObject>)

DOTSClip.ConvertCurves(AnimationClip)

DOTSClip.GetAnimationBlob<T>(String)

DOTSClip.GetAnimationBlob<T>(String, Func<AnimationCurve, AnimationCurve>)

DOTSClip.SetCurvesDirty()

DOTSClip.CheckAndClearCurvesDirtyFlag()

DOTSClip.GetClipWeightCurve(BlobAssetReference<AnimationCurveBlob>)

Namespace: Unity.Timeline.Animation

Syntax

[Serializable]
public class AnimationClip : DOTSClip, ITimelineClipAsset, IAnimationMixerRootMotionInput, IAnimationClipNodeElement

Fields

AdditiveClipOptions

Options for how to choose the reference pose when the track plays this clip back as additive

Declaration

public AdditiveClipOptions AdditiveClipOptions

Field Value

Type	Description
AdditiveClipOptions

Animation

The animation clip to play

Declaration

public UnityEngine.AnimationClip Animation

Field Value

Type	Description
UnityEngine.AnimationClip

OffsetMode

Options for how the offsets are applied

Declaration

public RootOffsetMode OffsetMode

Field Value

Type	Description
RootOffsetMode

PathColor

Root Motion Path Color

Declaration

public Color PathColor

Field Value

Type	Description
Color

PlaybackOptions

The options for how the clip plays back

Declaration

public AnimationClipPlaybackOptions PlaybackOptions

Field Value

Type	Description
AnimationClipPlaybackOptions

RootMotionOffsets

Root Motion offsets for this clip

Declaration

public RootMotionOffsets RootMotionOffsets

Field Value

Type	Description
RootMotionOffsets

RootMotionOptions

Options for playing back root transform

Declaration

public RootMotionOptions RootMotionOptions

Field Value

Type	Description
RootMotionOptions

Properties

AdditiveOffset

Declaration

public RigidTransform AdditiveOffset { get; }

Property Value

Type	Description
RigidTransform

Implements

IAnimationMixerRootMotionInput.AdditiveOffset

ClipConfiguration

Returns the UberNode clip configuration used when building

Declaration

public ClipConfiguration ClipConfiguration { get; }

Property Value

Type	Description
ClipConfiguration

duration

Declaration

public override double duration { get; }

Property Value

Type	Description
Double

HasAnimatedRootMotion

Whether the assigned clip has animated root motion

Declaration

public bool HasAnimatedRootMotion { get; }

Property Value

Type	Description
Boolean

Methods

BuildRootMotionInput(BlobAssetStore, BlobAssetReference<RigDefinition>, BlendingMode)

Given a rig definition and a blending mode, generate the root motion input for this clip

Declaration

public void BuildRootMotionInput(BlobAssetStore store, BlobAssetReference<RigDefinition> rig, BlendingMode blendingMode)

Parameters

Type	Name	Description
BlobAssetStore	store
BlobAssetReference<RigDefinition>	rig
BlendingMode	blendingMode

Implements

IAnimationMixerRootMotionInput.BuildRootMotionInput(BlobAssetStore, BlobAssetReference<RigDefinition>, BlendingMode)

GetAnimatedRootMotion(BlobAssetStore, out DiscreteTime, out BlobAssetReference<AnimatedRigidTransformBlob>)

Get the root motion animation clip

Declaration

public void GetAnimatedRootMotion(BlobAssetStore store, out DiscreteTime timeOffset, out BlobAssetReference<AnimatedRigidTransformBlob> clip)

Parameters

Type	Name	Description
BlobAssetStore	store
DiscreteTime	timeOffset
BlobAssetReference<AnimatedRigidTransformBlob>	clip

Implements

IAnimationMixerRootMotionInput.GetAnimatedRootMotion(BlobAssetStore, out DiscreteTime, out BlobAssetReference<AnimatedRigidTransformBlob>)

GetClipNodeDescription(BlobAssetStore, BlobAssetReference<RigDefinition>, BlendingMode)

Given a RigDefinition and a BlendingMode, returns a partially configured ClipNode buffer element representing this clip.

Declaration

public CreateAnimationClipNodeElement GetClipNodeDescription(BlobAssetStore store, BlobAssetReference<RigDefinition> rig, BlendingMode mode)

Parameters

Type	Name	Description
BlobAssetStore	store
BlobAssetReference<RigDefinition>	rig
BlendingMode	mode

Returns

Type	Description
CreateAnimationClipNodeElement

Implements

IAnimationClipNodeElement.GetClipNodeDescription(BlobAssetStore, BlobAssetReference<RigDefinition>, BlendingMode)

Explicit Interface Implementations

IAnimationMixerRootMotionInput.ClipOffset

The offset of the root motion

Declaration

RigidTransform IAnimationMixerRootMotionInput.ClipOffset { get; set; }

Returns

Type	Description
RigidTransform

Implements

IAnimationMixerRootMotionInput.ClipOffset

IAnimationMixerRootMotionInput.RootOffsetMode

Declaration

RootOffsetMode IAnimationMixerRootMotionInput.RootOffsetMode { get; set; }

Returns

Type	Description
RootOffsetMode

Implements

IAnimationMixerRootMotionInput.RootOffsetMode

IAnimationMixerRootMotionInput.TrackToClipOffset

The transformation offset from the track transform to the clip

Declaration

RigidTransform IAnimationMixerRootMotionInput.TrackToClipOffset { get; set; }

Returns

Type	Description
RigidTransform

Implements

IAnimationMixerRootMotionInput.TrackToClipOffset