Struct AnimationSequenceState

Namespace

Velvet

Assembly

Velvet.Docs.dll

Per-render snapshot of a sequence, returned by UseAnimationSequence(IReadOnlyList<AnimationSequenceStep>, object?[]?, bool, bool).

public readonly struct AnimationSequenceState

Properties

CurrentLabel

The label of the most recently activated AnimationSequenceStep To step, or null before the first one runs.

CurrentTransition

The transition that accompanied CurrentLabel: a copy of the step's own, equal to it in every setting, that also ties the Spring and Bezier plays a V.Motion handed it starts to this sequence's AnimationSequenceControls. A Spring with a DurationSec of exactly 0 and no RepeatDelaySec is the exception: it arrives with a duration of 0.01 s, the spring Framer Motion's sequence plays it on, so it plays rather than landing.

IsComplete

True once the cursor has advanced past the last step of the last pass, or a lowered iterations has ended the sequence, and from the mount render on for zero iterations or an empty steps list. A raised count clears it. Under loop, latches only for an empty list.

StepIndex

Index into the authored steps array of the step currently holding the cursor.