RuntimeAnimation | Babylon.js API documentation

Class RuntimeAnimation

Defines a runtime animation

Index

Constructors

constructor

new RuntimeAnimation(
    target: any,
    animation: Animation,
    scene: Scene,
    host: Animatable,
): RuntimeAnimation
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:137841

Properties

_animation

_animation: Animation

The animation used by the runtime animation

Accessors

animation

get animation(): Animation
Gets the animation from the runtime animation

Returns Animation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:137846

currentFrame

get currentFrame(): number
Gets the current frame of the runtime animation

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:137811

currentValue

get currentValue(): any
Gets the current value of the runtime animation

Returns any
- Defined in .temp/typedoc/docdirectory/doc.d.ts:137819

isAdditive

get isAdditive(): boolean
Gets the additive state of the runtime animation

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:137831

target

get target(): any
Gets the actual target of the runtime animation

Returns any
- Defined in .temp/typedoc/docdirectory/doc.d.ts:137827

targetPath

get targetPath(): string
Gets or sets the target path of the runtime animation

Returns string
- Defined in .temp/typedoc/docdirectory/doc.d.ts:137823

weight

get weight(): number
Gets the weight of the runtime animation

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:137815

Methods

animate

animate(
    elapsedTimeSinceAnimationStart: number,
    from: number,
    to: number,
    loop: boolean,
    speedRatio: number,
    weight?: number,
): boolean
Execute the current animation
Parameters
- elapsedTimeSinceAnimationStart: number
  defines the elapsed time (in milliseconds) since the animation was started
- from: number
  defines the lower frame of the animation range
- to: number
  defines the upper frame of the animation range
- loop: boolean
  defines if the current animation must loop
- speedRatio: number
  defines the current speed ratio
- Optionalweight: number
  defines the weight of the animation (default is -1 so no weight)
Returns boolean
a boolean indicating if the animation is running
- Defined in .temp/typedoc/docdirectory/doc.d.ts:137895

dispose

dispose(): void
Disposes of the runtime animation

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:137860

goToFrame

goToFrame(frame: number, weight?: number): void
Move the current animation to a given frame
Parameters
- frame: number
  defines the frame to move to
- Optionalweight: number
  defines the weight to apply to the animation (-1.0 by default)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:137880

isStopped

isStopped(): boolean
Specifies if the runtime animation is stopped

Returns boolean
Boolean specifying if the runtime animation is stopped
- Defined in .temp/typedoc/docdirectory/doc.d.ts:137856

reset

reset(restoreOriginal?: boolean): void
Resets the runtime animation to the beginning
Parameters
- OptionalrestoreOriginal: boolean
  defines whether to restore the target property to the original value
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:137851

setValue

setValue(currentValue: any, weight: number): void
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:137866

Class RuntimeAnimation

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RuntimeAnimation

Properties

_animation

Accessors

animation

Returns Animation

currentFrame

Returns number

currentValue

Returns any

isAdditive

Returns boolean

target

Returns any

targetPath

Returns string

weight

Returns number

Methods

animate

Parameters

Returns boolean

dispose

Returns void

goToFrame

Parameters

Returns void

isStopped

Returns boolean

reset

Parameters

Returns void

setValue

Parameters

Returns void

Settings

On This Page