Skip to main content

Class: Write

Defined in: animation/creation/Create.ts:501

Write animation specifically for Text and MathTex mobjects. Reveals text character by character with a pen-stroke effect.

Rendering paths:

  1. Glyph stroke mode — Text with loaded glyph group (via loadGlyphs()) gets stroke-draw of each character's outline, then cross-fades to the Canvas 2D texture.
  2. Dash-based reveal — for VMobjects that already have Line2 children.
  3. Opacity fallback.

Extends​

Extended by​

Constructors​

Constructor​

new Write(mobject, options): Write

Defined in: animation/creation/Create.ts:528

Parameters​

mobject​

Mobject

options​

WriteOptions = {}

Returns​

Write

Overrides​

Animation.constructor

Properties​

_hasBegun​

protected _hasBegun: boolean = false

Defined in: animation/Animation.ts:38

Track if begin() has been called

Inherited from​

Animation._hasBegun

_isFinished​

protected _isFinished: boolean = false

Defined in: animation/Animation.ts:35

Whether the animation has finished

Inherited from​

Animation._isFinished

_startTime​

protected _startTime: number = null

Defined in: animation/Animation.ts:32

Time when the animation started (set by Timeline)

Inherited from​

Animation._startTime

duration​

readonly duration: number

Defined in: animation/Animation.ts:26

Duration of the animation in seconds

Inherited from​

Animation.duration

lagRatio​

protected readonly lagRatio: number

Defined in: animation/creation/Create.ts:502

mobject​

readonly mobject: Mobject

Defined in: animation/Animation.ts:23

The mobject being animated

Inherited from​

Animation.mobject

rateFunc​

readonly rateFunc: RateFunction

Defined in: animation/Animation.ts:29

Rate function controlling the animation's pacing

Inherited from​

Animation.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​

Animation.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​

Animation.startTime

Methods​

begin()​

begin(): void

Defined in: animation/creation/Create.ts:536

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

finish()​

finish(): void

Defined in: animation/creation/Create.ts:854

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

Returns​

void

Overrides​

Animation.finish

interpolate()​

interpolate(alpha): void

Defined in: animation/creation/Create.ts:714

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

Check if the animation has finished

Returns​

boolean

Inherited from​

Animation.isFinished

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

Inherited from​

Animation.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​

Animation.update