ClipTransition Class

Summary

A serializable Animancer.ITransition which can create a particular type of Animancer.AnimancerState when passed into Animancer.AnimancerPlayable.Play(Animancer.ITransition).
graph BT Type-->Base0["AnimancerTransition<ClipState>"] Base0-->Base1["Object"] Type-.->Interface0["ITransitionDetailed"] click Interface0 "/animancer/api/Animancer/ITransitionDetailed" Type-.->Interface1["ITransitionWithEvents"] click Interface1 "/animancer/api/Animancer/ITransitionWithEvents" Type-.->Interface2["IHasEvents"] click Interface2 "/animancer/api/Animancer/IHasEvents" Type-.->Interface3["ICopyable<AnimancerTransition<ClipState>>"] Type-.->Interface4["ClipState.ITransition"] click Interface4 "/animancer/api/Animancer/ITransition" Type-.->Interface5["ITransition<ClipState>"] Type-.->Interface6["ITransition"] click Interface6 "/animancer/api/Animancer/ITransition" Type-.->Interface7["IHasKey"] click Interface7 "/animancer/api/Animancer/IHasKey" Type-.->Interface8["IPolymorphic"] click Interface8 "/animancer/api/Animancer/IPolymorphic" Type-.->Interface9["IMotion"] click Interface9 "/animancer/api/Animancer/IMotion" Type-.->Interface10["IAnimationClipCollection"] click Interface10 "/animancer/api/Animancer/IAnimationClipCollection" Type-.->Interface11["ICopyable<ClipTransition>"] Type["ClipTransition"] class Type type-node Derived0["RootMotion.MotionTransition"]-->Type click Derived0 "/animancer/api/Animancer.Examples.Locomotion/MotionTransition" Derived1["DirectionalClipTransition"]-->Type click Derived1 "/animancer/api/Animancer/DirectionalClipTransition" Derived2["ClipTransitionSequence"]-->Type click Derived2 "/animancer/api/Animancer/ClipTransitionSequence"

Syntax

[Serializable]
public class ClipTransition : AnimancerTransition<ClipState>, ITransitionDetailed, 
    ITransitionWithEvents, IHasEvents, ICopyable<AnimancerTransition<ClipState>>, 
    ClipState.ITransition, ITransition<ClipState>, ITransition, IHasKey, IPolymorphic, IMotion, 
    IAnimationClipCollection, ICopyable<ClipTransition>

Remarks

Documentation: Transitions

Attributes

Type Description
SerializableAttribute

Fields

Name Constant Value Summary
ClipFieldName _Clip
The name of the serialized backing field of Animancer.ClipTransition.Clip.
static

Properties

Name Value Summary
AverageAngularSpeed float
The initial UnityEngine.Motion.averageAngularSpeed that the created state will have.
AverageVelocity Vector3
The initial UnityEngine.Motion.averageSpeed that the created state will have.
Clip AnimationClip
[UnityEngine.SerializeField] The animation to play.
FadeMode FadeMode
If this transition will set the Animancer.AnimancerState.Time, then it needs to use Animancer.FadeMode.FromStart.
IsLooping bool
[Animancer.ITransitionDetailed] Is the Animancer.ClipTransition.Clip looping?
IsValid bool
Can this transition create a valid Animancer.AnimancerState?
Key Object
Returns the Animancer.ClipTransition.Clip to use as the Animancer.AnimancerState.Key.
Length float
The length of the Animancer.ClipTransition.Clip (in seconds), accounting for the Animancer.ClipTransition.NormalizedStartTime and Animancer.AnimancerEvent.Sequence.NormalizedEndTime (but not Animancer.ClipTransition.Speed).
MainObject Object
The Animancer.AnimancerState.MainObject that the created state will have.
MaximumDuration float
The maximum amount of time the animation is expected to take (in seconds).
NormalizedStartTime float
The Animancer.AnimancerState.NormalizedTime to start the animation at.
Speed float
The Animancer.AnimancerNode.Speed to play the animation at.

Methods

Name Value Summary
Apply(AnimancerState) void
Called by Animancer.AnimancerPlayable.Play(Animancer.ITransition) to apply any modifications to the `state`.
CopyFrom(ClipTransition) void
Copies the contents of `copyFrom` into this object, replacing its previous contents.
CreateState() ClipState
Creates and returns a new TState.
GatherAnimationClips(ICollection<AnimationClip>) void
[Animancer.IAnimationClipCollection] Adds the Animancer.ClipTransition.Clip to the collection.