Skip to main content

Abstract Class: Animation

Defined in: animation/Animation.ts:21

Extended by

Constructors

Constructor

new Animation(mobject, options): Animation

Defined in: animation/Animation.ts:53

Parameters

mobject

Mobject

options

AnimationOptions = {}

Returns

Animation

Properties

_hasBegun

protected _hasBegun: boolean = false

Defined in: animation/Animation.ts:38

Track if begin() has been called


_isFinished

protected _isFinished: boolean = false

Defined in: animation/Animation.ts:35

Whether the animation has finished


_startTime

protected _startTime: number = null

Defined in: animation/Animation.ts:32

Time when the animation started (set by Timeline)


duration

readonly duration: number

Defined in: animation/Animation.ts:26

Duration of the animation in seconds


mobject

readonly mobject: Mobject

Defined in: animation/Animation.ts:23

The mobject being animated


rateFunc

readonly rateFunc: RateFunction

Defined in: animation/Animation.ts:29

Rate function controlling the animation's pacing


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).

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

Methods

begin()

begin(): void

Defined in: animation/Animation.ts:65

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


finish()

finish(): void

Defined in: animation/Animation.ts:107

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:115

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:145

Check if the animation has finished

Returns

boolean


reset()

reset(): void

Defined in: animation/Animation.ts:154

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: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