Skip to main content

Class: AnimateProxy

Defined in: src/core/AnimateProxy.ts:26

Extends​

Constructors​

Constructor​

new AnimateProxy(mobject, options): AnimateProxy

Defined in: src/core/AnimateProxy.ts:33

Parameters​

mobject​

Mobject

options​

AnimationOptions = {}

Returns​

AnimateProxy

Overrides​

Animation.constructor

Properties​

_hasBegun​

protected _hasBegun: boolean = false

Defined in: src/animation/Animation.ts:49

Track if begin() has been called

Inherited from​

Animation._hasBegun

_isFinished​

protected _isFinished: boolean = false

Defined in: src/animation/Animation.ts:46

Whether the animation has finished

Inherited from​

Animation._isFinished

_startTime​

protected _startTime: number = null

Defined in: src/animation/Animation.ts:43

Time when the animation started (set by Timeline)

Inherited from​

Blink._startTime

duration​

readonly duration: number

Defined in: src/animation/Animation.ts:37

Duration of the animation in seconds

Inherited from​

Animation.duration

mobject​

readonly mobject: Mobject

Defined in: src/animation/Animation.ts:34

The mobject being animated

Inherited from​

Animation.mobject

rateFunc​

readonly rateFunc: RateFunction

Defined in: src/animation/Animation.ts:40

Rate function controlling the animation's pacing

Inherited from​

Animation.rateFunc

remover​

remover: boolean = false

Defined in: src/animation/Animation.ts:55

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

Inherited from​

Animation.remover

Accessors​

startTime​

Get Signature​

get startTime(): number

Defined in: src/animation/Animation.ts:236

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

Returns​

number

Set Signature​

set startTime(time): void

Defined in: src/animation/Animation.ts:243

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

Parameters​
time​

number

Returns​

void

Inherited from​

Animation.startTime

Methods​

alignTo()​

alignTo(target, direction): this

Defined in: src/core/AnimateProxy.ts:125

Parameters​

target​

Vector3Tuple | Mobject

direction​

Vector3Tuple

Returns​

this

begin()​

begin(): void

Defined in: src/core/AnimateProxy.ts:152

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

Overrides​

Animation.begin

center()​

center(): this

Defined in: src/core/AnimateProxy.ts:112

Returns​

this

cleanUpFromScene()​

cleanUpFromScene(scene): void

Defined in: src/animation/Animation.ts:141

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

Inherited from​

Animation.cleanUpFromScene

finish()​

finish(): void

Defined in: src/core/AnimateProxy.ts:208

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

Returns​

void

Overrides​

Animation.finish

flip()​

flip(axis?): this

Defined in: src/core/AnimateProxy.ts:107

Parameters​

axis?​

Vector3Tuple

Returns​

this

getSubAlpha()​

protected getSubAlpha(alpha, index, count, lagRatio): number

Defined in: src/animation/Animation.ts:161

Manim CE's get_sub_alpha: remaps a global progress alpha into the local progress of family member index (of count) under a lagRatio stagger. With lagRatio <= 0 (or a single member), every member tracks alpha directly. Subclasses that stagger across a mobject's family (e.g. Create) should index this by familyMembersWithPoints(), never by rendering-layer primitives.

Parameters​

alpha​

number

index​

number

count​

number

lagRatio​

number

Returns​

number

Inherited from​

Animation.getSubAlpha

interpolate()​

interpolate(alpha): void

Defined in: src/core/AnimateProxy.ts:198

Apply the animation at a given progress value.

Parameters​

alpha​

number

Progress from 0 (start) to 1 (end)

Returns​

void

Overrides​

Animation.interpolate

isFinished()​

isFinished(): boolean

Defined in: src/animation/Animation.ts:197

Check if the animation has finished

Returns​

boolean

Inherited from​

Animation.isFinished

moveTo()​

moveTo(target, alignedEdge?): this

Defined in: src/core/AnimateProxy.ts:62

Parameters​

target​

Vector3Tuple | Mobject

alignedEdge?​

Vector3Tuple

Returns​

this

nextTo()​

nextTo(target, direction?, buff?): this

Defined in: src/core/AnimateProxy.ts:117

Parameters​

target​

Vector3Tuple | Mobject

direction?​

Vector3Tuple

buff?​

number

Returns​

this

reset()​

reset(): void

Defined in: src/animation/Animation.ts:206

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

Inherited from​

Animation.reset

rotate()​

rotate(angle, axisOrOptions?): this

Defined in: src/core/AnimateProxy.ts:67

Parameters​

angle​

number

axisOrOptions?​

Vector3Tuple | AxisOrOptions

Returns​

this

scale()​

scale(factor): this

Defined in: src/core/AnimateProxy.ts:72

Parameters​

factor​

number | Vector3Tuple

Returns​

this

setColor()​

setColor(color): this

Defined in: src/core/AnimateProxy.ts:77

Parameters​

color​

string

Returns​

this

setFill()​

setFill(color?, opacity?): this

Defined in: src/core/AnimateProxy.ts:97

Parameters​

color?​

string

opacity?​

number

Returns​

this

setFillOpacity()​

setFillOpacity(opacity): this

Defined in: src/core/AnimateProxy.ts:92

Parameters​

opacity​

number

Returns​

this

setOpacity()​

setOpacity(opacity): this

Defined in: src/core/AnimateProxy.ts:82

Parameters​

opacity​

number

Returns​

this

setStrokeWidth()​

setStrokeWidth(width): this

Defined in: src/core/AnimateProxy.ts:87

Parameters​

width​

number

Returns​

this

setStyle()​

setStyle(style): this

Defined in: src/core/AnimateProxy.ts:102

Parameters​

style​

Partial<MobjectStyle>

Returns​

this

setX()​

setX(x): this

Defined in: src/core/AnimateProxy.ts:135

Parameters​

x​

number

Returns​

this

setY()​

setY(y): this

Defined in: src/core/AnimateProxy.ts:140

Parameters​

y​

number

Returns​

this

setZ()​

setZ(z): this

Defined in: src/core/AnimateProxy.ts:145

Parameters​

z​

number

Returns​

this

shift()​

shift(delta): this

Defined in: src/core/AnimateProxy.ts:57

Parameters​

delta​

Vector3Tuple

Returns​

this

toEdge()​

toEdge(direction, buff?): this

Defined in: src/core/AnimateProxy.ts:130

Parameters​

direction​

Vector3Tuple

buff?​

number

Returns​

this

update()​

update(_dt, currentTime): void

Defined in: src/animation/Animation.ts:174

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​

Animation.update

withDuration()​

withDuration(seconds): this

Defined in: src/core/AnimateProxy.ts:44

Override duration for this animation (builder-style).

Parameters​

seconds​

number

Returns​

this

withRateFunc()​

withRateFunc(fn): this

Defined in: src/core/AnimateProxy.ts:50

Override rate function (builder-style).

Parameters​

fn​

RateFunction

Returns​

this