Animatable | Babylon.js API documentation

Class Animatable

Class used to store an actual running animation

Constructors

constructor

new Animatable(
    scene: Scene,
    target: any,
    fromFrame?: number,
    toFrame?: number,
    loopAnimation?: boolean,
    speedRatio?: number,
    onAnimationEnd?: Nullable<() => void>,
    animations?: Animation[],
    onAnimationLoop?: Nullable<() => void>,
    isAdditive?: boolean,
    playOrder?: number,
): Animatable
Creates a new Animatable
Parameters
- scene: Scene
  defines the hosting scene
- target: any
  defines the target object
- OptionalfromFrame: number
  defines the starting frame number (default is 0)
- OptionaltoFrame: number
  defines the ending frame number (default is 100)
- OptionalloopAnimation: boolean
  defines if the animation must loop (default is false)
- OptionalspeedRatio: number
  defines the factor to apply to animation speed (default is 1)
- OptionalonAnimationEnd: Nullable<() => void>
  defines a callback to call when animation ends if it is not looping
- Optionalanimations: Animation[]
  defines a group of animation to add to the new Animatable
- OptionalonAnimationLoop: Nullable<() => void>
  defines a callback to call when animation loops
- OptionalisAdditive: boolean
  defines whether the animation should be evaluated additively
- OptionalplayOrder: number
  defines the order in which this animatable should be processed in the list of active animatables (default: 0)
Returns Animatable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139642

Properties

animationStarted

animationStarted: boolean

Gets a boolean indicating if the animation has started

disposeOnEnd

disposeOnEnd: boolean

Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation. This will only apply for non looping animation (default is true)

fromFrame

fromFrame: number

[0] defines the starting frame number (default is 0)

isAdditive

isAdditive: boolean

[false] defines whether the animation should be evaluated additively

loopAnimation

loopAnimation: boolean

[false] defines if the animation must loop (default is false)

`Optional`onAnimationEnd

onAnimationEnd?: Nullable<() => void>

defines a callback to call when animation ends if it is not looping

onAnimationEndObservable

onAnimationEndObservable: Observable<Animatable>

Observer raised when the animation ends

`Optional`onAnimationLoop

onAnimationLoop?: Nullable<() => void>

defines a callback to call when animation loops

onAnimationLoopObservable

onAnimationLoopObservable: Observable<Animatable>

Observer raised when the animation loops

playOrder

playOrder: number

[0] defines the order in which this animatable should be processed in the list of active animatables (default: 0)

target

target: any

defines the target object

toFrame

toFrame: number

[100] defines the ending frame number (default is 100)

Accessors

elapsedTime

get elapsedTime(): number
Gets the elapsed time since the animatable started in milliseconds

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

masterFrame

get masterFrame(): number
Gets the current frame of the first RuntimeAnimation Used to synchronize Animatables

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

paused

get paused(): boolean
Returns true if the animations for this animatable are paused

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

speedRatio

get speedRatio(): number
Gets or sets the speed ratio to apply to the animatable (1.0 by default)

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139622
set speedRatio(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139623

syncRoot

get syncRoot(): Nullable<Animatable>
Gets the root Animatable used to synchronize and normalize animations

Returns Nullable<Animatable>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139608

weight

get weight(): number
Gets or sets the animatable weight (-1.0 by default meaning not weighted)

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139617
set weight(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139618

Methods

appendAnimations

appendAnimations(target: any, animations: Animation[]): void
Adds more animations to the current animatable
Parameters
- target: any
  defines the target of the animations
- animations: Animation[]
  defines the new animations to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139676

disableBlending

disableBlending(): void
Disable animation blending

Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/animation/advanced_animations#animation-blending
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139703

enableBlending

enableBlending(blendingSpeed: number): void
Allows the animatable to blend with current running animations
Parameters
- blendingSpeed: number
  defines the blending speed to use
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/animation/advanced_animations#animation-blending
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139698

getAnimationByTargetProperty

getAnimationByTargetProperty(property: string): Nullable<Animation>
Gets the source animation for a specific property
Parameters
- property: string
  defines the property to look for
Returns Nullable<Animation>
null or the source animation for the given property
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139682

getAnimations

getAnimations(): RuntimeAnimation[]
Gets the list of runtime animations

Returns RuntimeAnimation[]
an array of RuntimeAnimation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139670

getRuntimeAnimationByTargetProperty

getRuntimeAnimationByTargetProperty(
property: string,
): Nullable<RuntimeAnimation>
Gets the runtime animation for a specific property
Parameters
- property: string
  defines the property to look for
Returns Nullable<RuntimeAnimation>
null or the runtime animation for the given property
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139688

goToFrame

goToFrame(frame: number, useWeight?: boolean): void
Jump directly to a given frame
Parameters
- frame: number
  defines the frame to jump to
- OptionaluseWeight: boolean
  defines whether the animation weight should be applied to the image to be jumped to (false by default)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139709

pause

pause(): void
Pause the animation

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

reset

reset(): void
Resets the animatable to its original state

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

restart

restart(): void
Restart the animation

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

stop

stop(
    animationName?: string,
    targetMask?: (target: any) => boolean,
    useGlobalSplice?: boolean,
    skipOnAnimationEnd?: boolean,
): void
Stop and delete the current animation
Parameters
- OptionalanimationName: string
  defines a string used to only stop some of the runtime animations instead of all
- OptionaltargetMask: (target: any) => boolean
  a function that determines if the animation should be stopped based on its target (all animations will be stopped if both this and animationName are empty)
- OptionaluseGlobalSplice: boolean
  if true, the animatables will be removed by the caller of this function (false by default)
- OptionalskipOnAnimationEnd: boolean
  defines if the system should not raise onAnimationEnd. Default is false
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139730

syncWith

syncWith(root: Nullable<Animatable>): Animatable
Synchronize and normalize current Animatable with a source Animatable This is useful when using animation weights and when animations are not of the same length
Parameters
- root: Nullable<Animatable>
  defines the root Animatable to synchronize with (null to stop synchronizing)
Returns Animatable
the current Animatable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139665

waitAsync

waitAsync(): Promise<Animatable>
Wait asynchronously for the animation to end

Returns Promise<Animatable>
a promise which will be fulfilled when the animation ends
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139735

Class Animatable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Animatable

Properties

animationStarted

disposeOnEnd

fromFrame

isAdditive

loopAnimation

OptionalonAnimationEnd

onAnimationEndObservable

OptionalonAnimationLoop

onAnimationLoopObservable

playOrder

target

toFrame

Accessors

elapsedTime

Returns number

masterFrame

Returns number

paused

Returns boolean

speedRatio

Returns number

Parameters

Returns void

syncRoot

Returns Nullable<Animatable>

weight

Returns number

Parameters

Returns void

Methods

appendAnimations

Parameters

Returns void

disableBlending

Returns void

See

enableBlending

Parameters

Returns void

See

getAnimationByTargetProperty

Parameters

Returns Nullable<Animation>

getAnimations

Returns RuntimeAnimation[]

getRuntimeAnimationByTargetProperty

Parameters

Returns Nullable<RuntimeAnimation>

goToFrame

Parameters

Returns void

pause

Returns void

reset

Returns void

restart

Returns void

stop

Parameters

Returns void

syncWith

Parameters

Returns Animatable

waitAsync

Returns Promise<Animatable>

Settings

On This Page

`Optional`onAnimationEnd

`Optional`onAnimationLoop