Skip to main content

Class: TransformAnimations

Defined in: animation/transform/SpecialTransforms.ts:275

TransformAnimations - A meta-animation that transforms one animation into another

This is a higher-order animation that interpolates between the effects of two different animations. It runs both animations internally and blends their results.

At alpha=0, the mobject shows the state from animation1 At alpha=1, the mobject shows the state from animation2 In between, it blends the two states

Example

import { Circle, Transform, FadeIn, TransformAnimations } from 'manimweb';

const circle = new Circle({ radius: 1 });
const target = new Square({ sideLength: 2 });

// Create two animations
const anim1 = new Transform(circle, target);
const anim2 = new FadeIn(circle);

// Meta-animation that transitions between the effects of the two animations
const metaAnim = new TransformAnimations(anim1, anim2, { duration: 2 });

Extends

Constructors

Constructor

new TransformAnimations(animation1, animation2, options): TransformAnimations

Defined in: animation/transform/SpecialTransforms.ts:296

Parameters

animation1

Animation

animation2

Animation

options

TransformAnimationsOptions = {}

Returns

TransformAnimations

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


animation1

readonly animation1: Animation

Defined in: animation/transform/SpecialTransforms.ts:277

The first animation (source animation)


animation2

readonly animation2: Animation

Defined in: animation/transform/SpecialTransforms.ts:280

The second animation (target animation)


duration

readonly duration: number

Defined in: animation/Animation.ts:26

Duration of the animation in seconds

Inherited from

Animation.duration


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


transformRateFunc()

readonly transformRateFunc: (t) => number

Defined in: animation/transform/SpecialTransforms.ts:283

Optional rate function for the transform interpolation

Parameters

t

number

Returns

number

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/transform/SpecialTransforms.ts:308

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/transform/SpecialTransforms.ts:397

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/transform/SpecialTransforms.ts:351

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