Skip to main content

Class: AnimateProxy

Defined in: core/AnimateProxy.ts:20

Extends​

Constructors​

Constructor​

new AnimateProxy(mobject, options): AnimateProxy

Defined in: core/AnimateProxy.ts:27

Parameters​

mobject​

Mobject

options​

AnimationOptions = {}

Returns​

AnimateProxy

Overrides​

Animation.constructor

Properties​

_hasBegun​

protected _hasBegun: boolean = false

Defined in: animation/Animation.ts:47

Track if begin() has been called

Inherited from​

Animation._hasBegun

_isFinished​

protected _isFinished: boolean = false

Defined in: animation/Animation.ts:44

Whether the animation has finished

Inherited from​

Animation._isFinished

_startTime​

protected _startTime: number = null

Defined in: animation/Animation.ts:41

Time when the animation started (set by Timeline)

Inherited from​

Blink._startTime

duration​

readonly duration: number

Defined in: animation/Animation.ts:35

Duration of the animation in seconds

Inherited from​

Animation.duration

mobject​

readonly mobject: Mobject

Defined in: animation/Animation.ts:32

The mobject being animated

Inherited from​

Animation.mobject

rateFunc​

readonly rateFunc: RateFunction

Defined in: animation/Animation.ts:38

Rate function controlling the animation's pacing

Inherited from​

Animation.rateFunc

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

Inherited from​

Animation.remover

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

Inherited from​

Animation.startTime

Methods​

alignTo()​

alignTo(target, direction): this

Defined in: core/AnimateProxy.ts:122

Parameters​

target​

Mobject | Vector3Tuple

direction​

Vector3Tuple

Returns​

this

begin()​

begin(): void

Defined in: core/AnimateProxy.ts:149

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: core/AnimateProxy.ts:109

Returns​

this

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

Inherited from​

Animation.cleanUpFromScene

finish()​

finish(): void

Defined in: core/AnimateProxy.ts:205

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: core/AnimateProxy.ts:104

Parameters​

axis?​

Vector3Tuple

Returns​

this

interpolate()​

interpolate(alpha): void

Defined in: core/AnimateProxy.ts:195

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: animation/Animation.ts:166

Check if the animation has finished

Returns​

boolean

Inherited from​

Animation.isFinished

moveTo()​

moveTo(target, alignedEdge?): this

Defined in: core/AnimateProxy.ts:56

Parameters​

target​

Mobject | Vector3Tuple

alignedEdge?​

Vector3Tuple

Returns​

this

nextTo()​

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

Defined in: core/AnimateProxy.ts:114

Parameters​

target​

Mobject | Vector3Tuple

direction?​

Vector3Tuple

buff?​

number

Returns​

this

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

Inherited from​

Animation.reset

rotate()​

rotate(angle, axisOrOptions?): this

Defined in: core/AnimateProxy.ts:61

Parameters​

angle​

number

axisOrOptions?​

Vector3Tuple | { aboutPoint?: Vector3Tuple; axis?: Vector3Tuple; }

Returns​

this

scale()​

scale(factor): this

Defined in: core/AnimateProxy.ts:69

Parameters​

factor​

number | Vector3Tuple

Returns​

this

setColor()​

setColor(color): this

Defined in: core/AnimateProxy.ts:74

Parameters​

color​

string

Returns​

this

setFill()​

setFill(color?, opacity?): this

Defined in: core/AnimateProxy.ts:94

Parameters​

color?​

string

opacity?​

number

Returns​

this

setFillOpacity()​

setFillOpacity(opacity): this

Defined in: core/AnimateProxy.ts:89

Parameters​

opacity​

number

Returns​

this

setOpacity()​

setOpacity(opacity): this

Defined in: core/AnimateProxy.ts:79

Parameters​

opacity​

number

Returns​

this

setStrokeWidth()​

setStrokeWidth(width): this

Defined in: core/AnimateProxy.ts:84

Parameters​

width​

number

Returns​

this

setStyle()​

setStyle(style): this

Defined in: core/AnimateProxy.ts:99

Parameters​

style​

Partial<MobjectStyle>

Returns​

this

setX()​

setX(x): this

Defined in: core/AnimateProxy.ts:132

Parameters​

x​

number

Returns​

this

setY()​

setY(y): this

Defined in: core/AnimateProxy.ts:137

Parameters​

y​

number

Returns​

this

setZ()​

setZ(z): this

Defined in: core/AnimateProxy.ts:142

Parameters​

z​

number

Returns​

this

shift()​

shift(delta): this

Defined in: core/AnimateProxy.ts:51

Parameters​

delta​

Vector3Tuple

Returns​

this

toEdge()​

toEdge(direction, buff?): this

Defined in: core/AnimateProxy.ts:127

Parameters​

direction​

Vector3Tuple

buff?​

number

Returns​

this

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

Inherited from​

Animation.update

withDuration()​

withDuration(seconds): this

Defined in: core/AnimateProxy.ts:38

Override duration for this animation (builder-style).

Parameters​

seconds​

number

Returns​

this

withRateFunc()​

withRateFunc(fn): this

Defined in: core/AnimateProxy.ts:44

Override rate function (builder-style).

Parameters​

fn​

RateFunction

Returns​

this