Skip to main content

Abstract Class: TransformMatchingAbstractBase

Defined in: src/animation/transform/TransformMatchingBase.ts:54

Extends​

Constructors​

Constructor​

new TransformMatchingAbstractBase(source, target, options): TransformMatchingAbstractBase

Defined in: src/animation/transform/TransformMatchingBase.ts:73

Parameters​

source​

VMobject

target​

VMobject

options​

TransformMatchingBaseOptions = {}

Returns​

TransformMatchingAbstractBase

Overrides​

Animation.constructor

Properties​

_fadeInParts​

protected _fadeInParts: FadingPart[] = []

Defined in: src/animation/transform/TransformMatchingBase.ts:71

Target parts that will fade in (no match in source)

_fadeOutParts​

protected _fadeOutParts: FadingPart[] = []

Defined in: src/animation/transform/TransformMatchingBase.ts:68

Source parts that will fade out (no match in target)

_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

_matchedParts​

protected _matchedParts: MatchedPart[] = []

Defined in: src/animation/transform/TransformMatchingBase.ts:65

Matched parts that will transform

_startTime​

protected _startTime: number = null

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

Time when the animation started (set by Timeline)

Inherited from​

Animation._startTime

duration​

readonly duration: number

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

Duration of the animation in seconds

Inherited from​

Animation.duration

fadeRatio​

readonly fadeRatio: number

Defined in: src/animation/transform/TransformMatchingBase.ts:62

Fade duration ratio

keyFunc()?​

readonly optional keyFunc: (vmobject) => string

Defined in: src/animation/transform/TransformMatchingBase.ts:59

Optional key function for matching

Parameters​

vmobject​

VMobject

Returns​

string

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

target​

readonly target: VMobject

Defined in: src/animation/transform/TransformMatchingBase.ts:56

The target mobject to transform into

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​

_addMatchedPart()​

protected _addMatchedPart(source, target): void

Defined in: src/animation/transform/TransformMatchingBase.ts:173

Add a matched pair of source and target parts. Aligns their points so they can be smoothly interpolated.

Parameters​

source​

VMobject

target​

VMobject

Returns​

void

_getKey()​

abstract protected _getKey(vmobject): string

Defined in: src/animation/transform/TransformMatchingBase.ts:91

Get a matching key for a VMobject part. Parts with the same key will be matched together. Subclasses must implement this.

Parameters​

vmobject​

VMobject

Returns​

string

_getSubmobjects()​

abstract protected _getSubmobjects(vmobject): VMobject[]

Defined in: src/animation/transform/TransformMatchingBase.ts:84

Get the submobjects/parts to match from a given VMobject. Subclasses must implement this to define how mobjects are decomposed.

Parameters​

vmobject​

VMobject

Returns​

VMobject[]

_matchParts()​

protected _matchParts(): void

Defined in: src/animation/transform/TransformMatchingBase.ts:98

Match submobjects between source and target. Uses key-based exact matching by default. Subclasses can override to add additional matching strategies (e.g., similarity-based).

Returns​

void

begin()​

begin(): void

Defined in: src/animation/transform/TransformMatchingBase.ts:220

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

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/animation/transform/TransformMatchingBase.ts:252

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

Returns​

void

Overrides​

Animation.finish

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/animation/transform/TransformMatchingBase.ts:225

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

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

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