Abstract Class: TransformMatchingAbstractBase
Defined in: animation/transform/TransformMatchingBase.ts:54
Extends
Constructors
Constructor
new TransformMatchingAbstractBase(
source,target,options):TransformMatchingAbstractBase
Defined in: animation/transform/TransformMatchingBase.ts:73
Parameters
source
target
options
TransformMatchingBaseOptions = {}
Returns
TransformMatchingAbstractBase
Overrides
Properties
_fadeInParts
protected_fadeInParts:FadingPart[] =[]
Defined in: animation/transform/TransformMatchingBase.ts:71
Target parts that will fade in (no match in source)
_fadeOutParts
protected_fadeOutParts:FadingPart[] =[]
Defined in: animation/transform/TransformMatchingBase.ts:68
Source parts that will fade out (no match in target)
_hasBegun
protected_hasBegun:boolean=false
Defined in: animation/Animation.ts:47
Track if begin() has been called
Inherited from
_isFinished
protected_isFinished:boolean=false
Defined in: animation/Animation.ts:44
Whether the animation has finished
Inherited from
_matchedParts
protected_matchedParts:MatchedPart[] =[]
Defined in: animation/transform/TransformMatchingBase.ts:65
Matched parts that will transform
_startTime
protected_startTime:number=null
Defined in: animation/Animation.ts:41
Time when the animation started (set by Timeline)
Inherited from
duration
readonlyduration:number
Defined in: animation/Animation.ts:35
Duration of the animation in seconds
Inherited from
fadeRatio
readonlyfadeRatio:number
Defined in: animation/transform/TransformMatchingBase.ts:62
Fade duration ratio
keyFunc()?
readonlyoptionalkeyFunc: (vmobject) =>string
Defined in: animation/transform/TransformMatchingBase.ts:59
Optional key function for matching
Parameters
vmobject
Returns
string
mobject
readonlymobject:Mobject
Defined in: animation/Animation.ts:32
The mobject being animated
Inherited from
rateFunc
readonlyrateFunc:RateFunction
Defined in: animation/Animation.ts:38
Rate function controlling the animation's pacing
Inherited from
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
target
readonlytarget:VMobject
Defined in: animation/transform/TransformMatchingBase.ts:56
The target mobject to transform into
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
Methods
_addMatchedPart()
protected_addMatchedPart(source,target):void
Defined in: 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
target
Returns
void
_getKey()
abstractprotected_getKey(vmobject):string
Defined in: 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
Returns
string
_getSubmobjects()
abstractprotected_getSubmobjects(vmobject):VMobject[]
Defined in: 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
Returns
VMobject[]
_matchParts()
protected_matchParts():void
Defined in: 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: 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
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
finish()
finish():
void
Defined in: animation/transform/TransformMatchingBase.ts:252
Called when the animation ends. Subclasses can override to clean up or finalize state.
Returns
void
Overrides
interpolate()
interpolate(
alpha):void
Defined in: 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
isFinished()
isFinished():
boolean
Defined in: animation/Animation.ts:166
Check if the animation has finished
Returns
boolean
Inherited from
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
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