Interface

AnimateComp

:

The animate component.

animate

(name: string, keys: T[], opts: AnimateOpt): void

Animates a property on this object.

param name- Name of the property to animate.

param keys- Keys determining the value at a certain point in time.

param opts- Options.

unanimate

(name: string): void

Removes the animation from the given property.

param name- Name of the property to remove the animation from.

unanimateAll

(): void

Removes the animations from all properties

onAnimateFinished

(cb: () => void): KEventController

Attaches an event handler which is called when all the animation channels have finished.

param cb- The event handler called when the animation finishes.

onAnimateChannelFinished

(cb: (name: string) => void): KEventController

Attaches an event handler which is called when an animation channels has finished.

param cb- The event handler called when an animation channel finishes.

base

: BaseValues

Base values for relative animation

animation

: {

paused
: boolean
Pauses playing

seek
(time: number): void
Move the animation to a specific point in time
param time- Time to move the animation to in seconds

duration
: number
Returns the duration of the animation

get
(name: string): Anim
Returns the animation with the specified name
param name- Name of the animation to retrieve

play
(name: string): void
Play the animation with the specified name
param name

stop
(): void
Stop playing the current animation

}

serializeAnimations

(): Record<string, AnimationChannels>

Serializes the animation of this object to plain Javascript types

serializeAnimationOptions

(): {

followMotion
?: boolean

relative
?: boolean
}

Serializes the options of this object to plain Javascript types