DirectionalClipTransition Class

Summary

A Animancer.ClipTransition which gets its clip from a Animancer.DirectionalAnimationSet.
Assembly
Animancer.dll
Namespace
Animancer
Interfaces
Base Types
graph BT Type-->Base0["ClipTransition"] click Base0 "/animancer-v7-4/api/Animancer/ClipTransition" Base0-->Base1["AnimancerTransition<ClipState>"] Base1-->Base2["Object"] Type-.->Interface0["ITransitionDetailed"] click Interface0 "/animancer-v7-4/api/Animancer/ITransitionDetailed" Type-.->Interface1["ITransitionWithEvents"] click Interface1 "/animancer-v7-4/api/Animancer/ITransitionWithEvents" Type-.->Interface2["IHasEvents"] click Interface2 "/animancer-v7-4/api/Animancer/IHasEvents" Type-.->Interface3["ICopyable<AnimancerTransition<ClipState>>"] Type-.->Interface4["ClipState.ITransition"] click Interface4 "/animancer-v7-4/api/Animancer/ITransition" Type-.->Interface5["ITransition<ClipState>"] Type-.->Interface6["ITransition"] click Interface6 "/animancer-v7-4/api/Animancer/ITransition" Type-.->Interface7["IHasKey"] click Interface7 "/animancer-v7-4/api/Animancer/IHasKey" Type-.->Interface8["IPolymorphic"] click Interface8 "/animancer-v7-4/api/Animancer/IPolymorphic" Type-.->Interface9["IMotion"] click Interface9 "/animancer-v7-4/api/Animancer/IMotion" Type-.->Interface10["IAnimationClipCollection"] click Interface10 "/animancer-v7-4/api/Animancer/IAnimationClipCollection" Type-.->Interface11["ICopyable<ClipTransition>"] Type-.->Interface12["ICopyable<DirectionalClipTransition>"] Type["DirectionalClipTransition"] class Type type-node

Syntax

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

Examples

// Leave the Clip field empty in the Inspector and assign its AnimationSet instead.
[SerializeField] private DirectionalClipTransition _Transition;

...

// Then you can just call SetDirection and Play it like any other transition.
// All of the transition's details like Fade Duration and Events will be applied to whichever clip is plays.
_Transition.SetDirection(Vector2.right);
_Animancer.Play(_Transition);

Remarks

Documentation: Directional Animation Sets

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
AnimationSet DirectionalAnimationSet
[UnityEngine.SerializeField] The Animancer.DirectionalAnimationSet used to determine the Animancer.ClipTransition.Clip.
AverageAngularSpeed float
The initial UnityEngine.Motion.averageAngularSpeed that the created state will have.
Inherited from ClipTransition
AverageVelocity Vector3
The initial UnityEngine.Motion.averageSpeed that the created state will have.
Inherited from ClipTransition
Clip AnimationClip
[UnityEngine.SerializeField] The animation to play.
Inherited from ClipTransition
FadeMode FadeMode
If this transition will set the Animancer.AnimancerState.Time, then it needs to use Animancer.FadeMode.FromStart.
Inherited from ClipTransition
IsLooping bool
[Animancer.ITransitionDetailed] Is the Animancer.ClipTransition.Clip looping?
Inherited from ClipTransition
IsValid bool
Can this transition create a valid Animancer.AnimancerState?
Inherited from ClipTransition
Key Object
Returns the Animancer.ClipTransition.Clip to use as the Animancer.AnimancerState.Key.
Inherited from ClipTransition
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).
Inherited from ClipTransition
MainObject Object
MaximumDuration float
The maximum amount of time the animation is expected to take (in seconds).
Inherited from ClipTransition
NormalizedStartTime float
The Animancer.AnimancerState.NormalizedTime to start the animation at.
Inherited from ClipTransition
Speed float
The Animancer.AnimancerNode.Speed to play the animation at.
Inherited from ClipTransition

Methods

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