Skip to main content

Abstract Class: Animation

Defined in: animation/Animation.ts:30

Extended by​

Constructors​

Constructor​

new Animation(mobject, options): Animation

Defined in: animation/Animation.ts:62

Parameters​

mobject​

Mobject

options​

AnimationOptions = {}

Returns​

Animation

Properties​

_hasBegun​

protected _hasBegun: boolean = false

Defined in: animation/Animation.ts:47

Track if begin() has been called

_isFinished​

protected _isFinished: boolean = false

Defined in: animation/Animation.ts:44

Whether the animation has finished

_startTime​

protected _startTime: number = null

Defined in: animation/Animation.ts:41

Time when the animation started (set by Timeline)

duration​

readonly duration: number

Defined in: animation/Animation.ts:35

Duration of the animation in seconds

mobject​

readonly mobject: Mobject

Defined in: animation/Animation.ts:32

The mobject being animated

rateFunc​

readonly rateFunc: RateFunction

Defined in: animation/Animation.ts:38

Rate function controlling the animation's pacing

remover​

remover: boolean = false

Defined in: animation/Animation.ts:53

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

Accessors​

startTime​

Get Signature​

get startTime(): number

Defined in: animation/Animation.ts:205

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

Returns​

number

Set Signature​

set startTime(time): void

Defined in: animation/Animation.ts:212

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

Parameters​
time​

number

Returns​

void

Methods​

begin()​

begin(): void

Defined in: animation/Animation.ts:74

Called when the animation starts. Subclasses can override to set up initial state. On the very first call, captures a snapshot of the mobject so that reset() can restore it for clean backward seeking.

Returns​

void

cleanUpFromScene()​

cleanUpFromScene(scene): void

Defined in: animation/Animation.ts:126

Hook called by Scene after the animation finishes, before the next play(). Default: removes mobject if remover is set (FadeOut, Write({remover:true})). Override for animations that need to mutate scene membership — e.g. ReplacementTransform swaps source for target.

Parameters​

scene​

AnimationScene

Returns​

void

finish()​

finish(): void

Defined in: animation/Animation.ts:116

Called when the animation ends. Subclasses can override to clean up or finalize state.

Returns​

void

interpolate()​

abstract interpolate(alpha): void

Defined in: animation/Animation.ts:136

Apply the animation at a given progress value.

Parameters​

alpha​

number

Progress from 0 (start) to 1 (end)

Returns​

void

isFinished()​

isFinished(): boolean

Defined in: animation/Animation.ts:166

Check if the animation has finished

Returns​

boolean

reset()​

reset(): void

Defined in: animation/Animation.ts:175

Reset the animation to its initial state. Restores the mobject to its pre-animation visual state so that re-seeking (especially backward) produces correct results.

Returns​

void

update()​

update(_dt, currentTime): void

Defined in: animation/Animation.ts:143

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