Skip to main content

Class: ChangingDecimal

Defined in: animation/numbers/index.ts:46

ChangingDecimal - Animate a DecimalNumber's value changing from start to end.

This animation smoothly interpolates between two numeric values, updating the DecimalNumber's display on each frame. The number formatting (decimal places, sign, commas) is preserved throughout the animation.

Example

// Create a decimal number starting at 0
const num = new DecimalNumber({ value: 0, numDecimalPlaces: 2 });

// Animate from 0 to 100
timeline.add(new ChangingDecimal(num, { endValue: 100 }));

// Animate from a specific start value
timeline.add(new ChangingDecimal(num, {
startValue: 50,
endValue: 200,
duration: 2
}));

Extends

Constructors

Constructor

new ChangingDecimal(decimalNumber, options): ChangingDecimal

Defined in: animation/numbers/index.ts:59

Parameters

decimalNumber

DecimalNumber

options

ChangingDecimalOptions

Returns

ChangingDecimal

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


decimalNumber

readonly decimalNumber: DecimalNumber

Defined in: animation/numbers/index.ts:48

The DecimalNumber being animated


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

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

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

Inherited from

Animation.begin


finish()

finish(): void

Defined in: animation/numbers/index.ts:85

Called when the animation ends. Ensures the final value is set exactly.

Returns

void

Overrides

Animation.finish


getEndValue()

getEndValue(): number

Defined in: animation/numbers/index.ts:101

Get the end value of the animation

Returns

number


getStartValue()

getStartValue(): number

Defined in: animation/numbers/index.ts:94

Get the start value of the animation

Returns

number


interpolate()

interpolate(alpha): void

Defined in: animation/numbers/index.ts:72

Interpolate the decimal value at the given alpha.

Parameters

alpha

number

Progress from 0 (start) to 1 (end), after rate function applied

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