Skip to main content

Class: Succession

Defined in: animation/Succession.ts:27

Succession class for cases where class instantiation is preferred.

Extends​

Constructors​

Constructor​

new Succession(animations, options): Succession

Defined in: animation/Succession.ts:28

Parameters​

animations​

Animation[]

options​

SuccessionOptions = {}

Returns​

Succession

Overrides​

AnimationGroup.constructor

Properties​

_hasBegun​

protected _hasBegun: boolean = false

Defined in: animation/Animation.ts:38

Track if begin() has been called

Inherited from​

AnimationGroup._hasBegun

_isFinished​

protected _isFinished: boolean = false

Defined in: animation/Animation.ts:35

Whether the animation has finished

Inherited from​

AnimationGroup._isFinished

_startTime​

protected _startTime: number = null

Defined in: animation/Animation.ts:32

Time when the animation started (set by Timeline)

Inherited from​

AnimationGroup._startTime

animations​

readonly animations: Animation[]

Defined in: animation/AnimationGroup.ts:65

Child animations

Inherited from​

AnimationGroup.animations

duration​

readonly duration: number

Defined in: animation/Animation.ts:26

Duration of the animation in seconds

Inherited from​

AnimationGroup.duration

lagRatio​

readonly lagRatio: number

Defined in: animation/AnimationGroup.ts:68

Lag ratio

Inherited from​

AnimationGroup.lagRatio

mobject​

readonly mobject: Mobject

Defined in: animation/Animation.ts:23

The mobject being animated

Inherited from​

AnimationGroup.mobject

rateFunc​

readonly rateFunc: RateFunction

Defined in: animation/Animation.ts:29

Rate function controlling the animation's pacing

Inherited from​

AnimationGroup.rateFunc

remover​

remover: boolean = false

Defined in: animation/Animation.ts:44

If true, the scene will remove this mobject after the animation finishes. Used by FadeOut (like Python manim's remover=True).

Inherited from​

AnimationGroup.remover

Accessors​

startTime​

Get Signature​

get startTime(): number

Defined in: animation/Animation.ts:184

Get the start time of this animation (set by Timeline)

Returns​

number

Set Signature​

set startTime(time): void

Defined in: animation/Animation.ts:191

Set the start time of this animation (used by Timeline)

Parameters​
time​

number

Returns​

void

Inherited from​

AnimationGroup.startTime

Methods​

begin()​

begin(): void

Defined in: animation/AnimationGroup.ts:96

Set up the animation - compute start/end times and call begin on all children

Returns​

void

Inherited from​

AnimationGroup.begin

finish()​

finish(): void

Defined in: animation/AnimationGroup.ts:164

Finish all child animations

Returns​

void

Inherited from​

AnimationGroup.finish

interpolate()​

interpolate(alpha): void

Defined in: animation/AnimationGroup.ts:130

Interpolate all child animations based on group alpha

Parameters​

alpha​

number

Returns​

void

Inherited from​

AnimationGroup.interpolate

isFinished()​

isFinished(): boolean

Defined in: animation/AnimationGroup.ts:174

Check if all child animations have finished

Returns​

boolean

Inherited from​

AnimationGroup.isFinished

reset()​

reset(): void

Defined in: animation/AnimationGroup.ts:181

Reset the animation group

Returns​

void

Inherited from​

AnimationGroup.reset

update()​

update(_dt, currentTime): void

Defined in: animation/Animation.ts:122

Update the animation for the current frame.

Parameters​

_dt​

number

Time delta since last frame (unused, but available for subclasses)

currentTime​

number

Current time in the timeline

Returns​

void

Inherited from​

AnimationGroup.update