Skip to main content

Class: CameraAnimateProxy

Defined in: core/CameraFrame.ts:346

Fluent builder returned by CameraFrame.animate.

Each method records a target state change and returns this, so you can chain: frame.animate.incrementPhi(PI/4).setFieldOfView(60).

The proxy itself is used as the Animation argument to scene.play(). When play() calls .begin(), the proxy finalises the CameraAnimation.

Extends

Constructors

Constructor

new CameraAnimateProxy(frame, options): CameraAnimateProxy

Defined in: core/CameraFrame.ts:352

Parameters

frame

CameraFrame

options

AnimationOptions = {}

Returns

CameraAnimateProxy

Overrides

Animation.constructor

Properties

_hasBegun

protected _hasBegun: boolean = false

Defined in: animation/Animation.ts:49

Track if begin() has been called

Inherited from

Animation._hasBegun


_isFinished

protected _isFinished: boolean = false

Defined in: animation/Animation.ts:46

Whether the animation has finished

Inherited from

Animation._isFinished


_startTime

protected _startTime: number = null

Defined in: animation/Animation.ts:43

Time when the animation started (set by Timeline)

Inherited from

Animation._startTime


duration

readonly duration: number

Defined in: animation/Animation.ts:37

Duration of the animation in seconds

Inherited from

Animation.duration


mobject

readonly mobject: Mobject

Defined in: animation/Animation.ts:34

The mobject being animated

Inherited from

Animation.mobject


rateFunc

readonly rateFunc: RateFunction

Defined in: animation/Animation.ts:40

Rate function controlling the animation's pacing

Inherited from

Animation.rateFunc


remover

remover: boolean = false

Defined in: 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

Accessors

startTime

Get Signature

get startTime(): number

Defined in: animation/Animation.ts:220

Get the start time of this animation (set by Timeline)

Returns

number

Set Signature

set startTime(time): void

Defined in: animation/Animation.ts:227

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: core/CameraFrame.ts:420

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: 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: core/CameraFrame.ts:460

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

Returns

void

Overrides

Animation.finish


getFrame()

getFrame(): CameraFrame

Defined in: core/CameraFrame.ts:466

Get the CameraFrame this proxy animates.

Returns

CameraFrame


incrementGamma()

incrementGamma(delta): this

Defined in: core/CameraFrame.ts:383

Animate incrementing gamma by delta.

Parameters

delta

number

Returns

this


incrementPhi()

incrementPhi(delta): this

Defined in: core/CameraFrame.ts:377

Animate incrementing phi by delta.

Parameters

delta

number

Returns

this


incrementTheta()

incrementTheta(delta): this

Defined in: core/CameraFrame.ts:371

Animate incrementing theta by delta.

Parameters

delta

number

Returns

this


interpolate()

interpolate(alpha): void

Defined in: core/CameraFrame.ts:429

Interpolate camera state at the given alpha (0..1).

Parameters

alpha

number

Returns

void

Overrides

Animation.interpolate


isFinished()

isFinished(): boolean

Defined in: animation/Animation.ts:181

Check if the animation has finished

Returns

boolean

Inherited from

Animation.isFinished


moveTo()

moveTo(point): this

Defined in: core/CameraFrame.ts:401

Animate moving the look-at center.

Parameters

point

Vector3Tuple

Returns

this


reset()

reset(): void

Defined in: animation/Animation.ts:190

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


setDistance()

setDistance(value): this

Defined in: core/CameraFrame.ts:389

Animate setting distance.

Parameters

value

number

Returns

this


setEulerAngles()

setEulerAngles(opts): this

Defined in: core/CameraFrame.ts:363

Animate setting Euler angles (absolute targets).

Parameters

opts
gamma?

number

phi?

number

theta?

number

Returns

this


setFieldOfView()

setFieldOfView(fov): this

Defined in: core/CameraFrame.ts:395

Animate setting field of view.

Parameters

fov

number

Returns

this


update()

update(_dt, currentTime): void

Defined in: animation/Animation.ts:158

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


withDuration()

withDuration(seconds): this

Defined in: core/CameraFrame.ts:407

Override duration for this animation (builder-style).

Parameters

seconds

number

Returns

this


withRateFunc()

withRateFunc(fn): this

Defined in: core/CameraFrame.ts:413

Override rate function (builder-style).

Parameters

fn

RateFunction

Returns

this