Babylon.js API documentation|

RuntimeAnimation

Class RuntimeAnimation

Defines a runtime animation

Hierarchy

RuntimeAnimation

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new RuntimeAnimation(target: any, animation: Animation, scene: Scene, host: Animatable): RuntimeAnimation

- Defined in .temp/docdirectory/doc.d.ts:4234
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

get animation(): Animation

- Defined in .temp/docdirectory/doc.d.ts:4239
Gets the animation from the runtime animation

Returns Animation

currentFrame

get currentFrame(): number

- Defined in .temp/docdirectory/doc.d.ts:4204
Gets the current frame of the runtime animation

Returns number

currentValue

get currentValue(): any

- Defined in .temp/docdirectory/doc.d.ts:4212
Gets the current value of the runtime animation

Returns any

isAdditive

get isAdditive(): boolean

- Defined in .temp/docdirectory/doc.d.ts:4224
Gets the additive state of the runtime animation

Returns boolean

target

get target(): any

- Defined in .temp/docdirectory/doc.d.ts:4220
Gets the actual target of the runtime animation

Returns any

targetPath

get targetPath(): string

- Defined in .temp/docdirectory/doc.d.ts:4216
Gets or sets the target path of the runtime animation

Returns string

weight

get weight(): number

- Defined in .temp/docdirectory/doc.d.ts:4208
Gets the weight of the runtime animation

Returns number

Methods

animate Search playground for animate

animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean

- Defined in .temp/docdirectory/doc.d.ts:4287
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

dispose Search playground for dispose

dispose(): void

- Defined in .temp/docdirectory/doc.d.ts:4254
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

goToFrame Search playground for goToFrame

goToFrame(frame: number): void

- Defined in .temp/docdirectory/doc.d.ts:4272
Move the current animation to a given frame

Parameters
- frame: number
  
  defines the frame to move to
Returns void

isStopped Search playground for isStopped

isStopped(): boolean

- Defined in .temp/docdirectory/doc.d.ts:4249
Specifies if the runtime animation is stopped

Returns boolean
Boolean specifying if the runtime animation is stopped

reset Search playground for reset

reset(restoreOriginal?: boolean): void

- Defined in .temp/docdirectory/doc.d.ts:4244
Resets the runtime animation to the beginning

Parameters
- Optional restoreOriginal: boolean
  
  defines whether to restore the target property to the original value
Returns void

setValue Search playground for setValue

setValue(currentValue: any, weight: number): void

- Defined in .temp/docdirectory/doc.d.ts:4260
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