ClipTransitionSequence Class

Summary

A group of Animancer.ClipTransitions which play one after the other.
graph BT Type-->Base0["ClipTransition"] click Base0 "/animancer/api/Animancer/ClipTransition" Base0-->Base1["Transition<ClipState>"] Base1-->Base2["Object"] Type-.->Interface0["ITransition<ClipState>"] Type-.->Interface1["ITransitionDetailed"] click Interface1 "/animancer/api/Animancer/ITransitionDetailed" Type-.->Interface2["ITransitionWithEvents"] click Interface2 "/animancer/api/Animancer/ITransitionWithEvents" Type-.->Interface3["ITransition"] click Interface3 "/animancer/api/Animancer/ITransition" Type-.->Interface4["IHasKey"] click Interface4 "/animancer/api/Animancer/IHasKey" Type-.->Interface5["IPolymorphic"] click Interface5 "/animancer/api/Animancer/IPolymorphic" Type-.->Interface6["IHasEvents"] click Interface6 "/animancer/api/Animancer/IHasEvents" Type-.->Interface7["ICopyable<Transition<ClipState>>"] Type-.->Interface8["ICloneable<Transition<ClipState>>"] Type-.->Interface9["IMotion"] click Interface9 "/animancer/api/Animancer/IMotion" Type-.->Interface10["IAnimationClipCollection"] click Interface10 "/animancer/api/Animancer/IAnimationClipCollection" Type-.->Interface11["ICopyable<ClipTransition>"] Type-.->Interface12["ISerializationCallbackReceiver"] Type-.->Interface13["ICopyable<ClipTransitionSequence>"] Type["ClipTransitionSequence"] class Type type-node

Syntax

[Serializable]
public class ClipTransitionSequence : ClipTransition, ITransition<ClipState>, ITransitionDetailed, 
    ITransitionWithEvents, ITransition, IHasKey, IPolymorphic, IHasEvents, 
    ICopyable<Transition<ClipState>>, ICloneable<Transition<ClipState>>, IMotion, 
    IAnimationClipCollection, ICopyable<ClipTransition>, ISerializationCallbackReceiver, 
    ICopyable<ClipTransitionSequence>

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.
Inherited from ClipTransition
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.
Inherited from ClipTransition
EndEvent AnimancerEvent
The Animancer.AnimancerEvent.Sequence.EndEvent of the last transition in this sequence.
FadeMode FadeMode
If this transition will set the Animancer.AnimancerState.Time, then it needs to use Animancer.FadeMode.FromStart.
Inherited from ClipTransition
IsLooping bool
Is the last animation in this sequence looping?
IsValid bool
Is everything in this sequence valid?
LastTransition ClipTransition
The last of the Animancer.ClipTransitionSequence.Others (or this if there are none).
Length float
The length of the Animancer.ClipTransition.Clip (in seconds), accounting for the Animancer.ClipTransition.NormalizedStartTime and Animancer.AnimancerEvent.Sequence.NormalizedEndTime (but not Speed).
MainObject Object
The Animancer.AnimancerState.MainObject that the created state will have.
Inherited from ClipTransition
MaximumDuration float
NormalizedStartTime float
The Animancer.AnimancerState.NormalizedTime to start the animation at.
Inherited from ClipTransition
OnEnd Action
The Animancer.AnimancerEvent.Sequence.OnEnd of the last transition in this sequence.
Others ClipTransition[]
[UnityEngine.SerializeField] The transitions to play in order after the first one.

Methods

Name Value Summary
AddEvent(float, bool, Action) void
Adds an event at the specified time relative to the entire sequence.
Apply(AnimancerState) void
Applies the details of this transition to the `state`.
Inherited from ClipTransition
Clone(CloneContext) Transition<ClipState>
CopyFrom(ClipTransition, CloneContext) void
Copies the contents of `copyFrom` into this object, replacing its previous contents.
CopyFrom(ClipTransitionSequence, CloneContext) void
Copies the contents of `copyFrom` into this object, replacing its previous contents.
CopyFrom(Transition<ClipState>, CloneContext) void
Copies the contents of `copyFrom` into this object, replacing its previous contents.
Inherited from ClipTransition
CreateState() ClipState
GatherAnimationClips(ICollection<AnimationClip>) void
Adds the Animancer.ClipTransition.Clip of everything in this sequence to the collection.
InitializeEndEventChain() void
Initializes the End Events of each of the Animancer.ClipTransitionSequence.Others to play the next one.
TryCreateTransition(Object) ITransitionDetailed
Returns a new Animancer.ClipTransition if the `target` is an UnityEngine.AnimationClip.
Inherited from ClipTransition
static
TryGetCumulativeTime(AnimancerState, float) bool
Tries to calculate the Animancer.AnimancerState.Time relative to the start of this sequence.