Animation
Defined in: animation/Animation.ts:18
A single animation that tweens a numeric property from start to end value.
Constructors
Sección titulada «Constructors»Constructor
Sección titulada «Constructor»new Animation(
from,to,callback,options?):Animation
Defined in: animation/Animation.ts:32
Parameters
Sección titulada «Parameters»Record<string, number>
Record<string, number>
callback
Sección titulada «callback»(values) => void
options?
Sección titulada «options?»AnimationOptions = {}
Returns
Sección titulada «Returns»Animation
Accessors
Sección titulada «Accessors»duration
Sección titulada «duration»Get Signature
Sección titulada «Get Signature»get duration():
number
Defined in: animation/Animation.ts:47
Duration in milliseconds.
Returns
Sección titulada «Returns»number
isFinished
Sección titulada «isFinished»Get Signature
Sección titulada «Get Signature»get isFinished():
boolean
Defined in: animation/Animation.ts:52
Whether the animation has finished.
Returns
Sección titulada «Returns»boolean
Methods
Sección titulada «Methods»cancel()
Sección titulada «cancel()»cancel():
void
Defined in: animation/Animation.ts:81
Cancel the animation.
Returns
Sección titulada «Returns»void
finishImmediately()
Sección titulada «finishImmediately()»finishImmediately():
void
Defined in: animation/Animation.ts:88
Jump directly to the final values and finish, without animating any frames.
Returns
Sección titulada «Returns»void
onCancelCallback()
Sección titulada «onCancelCallback()»onCancelCallback(
callback):this
Defined in: animation/Animation.ts:63
Set a callback for when the animation is cancelled.
Parameters
Sección titulada «Parameters»callback
Sección titulada «callback»() => void
Returns
Sección titulada «Returns»this
onDone()
Sección titulada «onDone()»onDone(
callback):this
Defined in: animation/Animation.ts:57
Set a callback for when the animation completes.
Parameters
Sección titulada «Parameters»callback
Sección titulada «callback»() => void
Returns
Sección titulada «Returns»this
pause()
Sección titulada «pause()»pause():
void
Defined in: animation/Animation.ts:69
Pause the animation.
Returns
Sección titulada «Returns»void
resume()
Sección titulada «resume()»resume():
void
Defined in: animation/Animation.ts:75
Resume a paused animation.
Returns
Sección titulada «Returns»void
start()
Sección titulada «start()»start():
void
Defined in: animation/Animation.ts:96
Start the animation. The start time is initialized on the first update call.
Returns
Sección titulada «Returns»void
update()
Sección titulada «update()»update(
now):boolean
Defined in: animation/Animation.ts:105
Advance the animation. Called each frame.
Parameters
Sección titulada «Parameters»number
Current timestamp in milliseconds.
Returns
Sección titulada «Returns»boolean
True if the animation is still running.