Class RuntimeAnimation
Hierarchy
- RuntimeAnimation
Index
Constructors
constructor
Create a new RuntimeAnimation object
Parameters
target: any
defines the target of the animation
animation: Animation
defines the source animation object
scene: Scene
defines the hosting scene
host: Animatable
defines the initiating Animatable
Returns RuntimeAnimation
Accessors
animation
Gets the animation from the runtime animation
Returns Animation
current Frame
Gets the current frame of the runtime animation
Returns number
current Value
Gets the current value of the runtime animation
Returns any
is Additive
Gets the additive state of the runtime animation
Returns boolean
target
Gets the actual target of the runtime animation
Returns any
target Path
Gets or sets the target path of the runtime animation
Returns string
weight
Gets the weight of the runtime animation
Returns number
Methods
animateSearch playground for animate
Execute the current animation
Parameters
delay: number
defines the delay to add to the current frame
from: number
defines the lower bound of the animation range
to: number
defines the upper bound of the animation range
loop: boolean
defines if the current animation must loop
speedRatio: number
defines the current speed ratio
Optional weight: number
defines the weight of the animation (default is -1 so no weight)
Returns boolean
a boolean indicating if the animation is running
disposeSearch playground for dispose
Disposes of the runtime animation Note: No hard dispose should happen here as this method is skipped for performance reason (look at animatable.stop())
Returns void
go To FrameSearch playground for goToFrame
Move the current animation to a given frame
Parameters
frame: number
defines the frame to move to
Returns void
is StoppedSearch playground for isStopped
Specifies if the runtime animation is stopped
Returns boolean
Boolean specifying if the runtime animation is stopped
resetSearch playground for reset
Resets the runtime animation to the beginning
Parameters
Optional restoreOriginal: boolean
defines whether to restore the target property to the original value
Returns void
set ValueSearch playground for setValue
Apply the interpolated value to the target
Parameters
currentValue: any
defines the value computed by the animation
weight: number
defines the weight to apply to this value (Defaults to 1.0)
Returns void
Defines a runtime animation