Class BabylonAnimation

Class used to store any kind of animation

Hierarchy

  • BabylonAnimation

Constructors

constructor

Properties

blendingSpeed dataType enableBlending? framePerSecond loopMode? name snippetId targetProperty targetPropertyPath uniqueId ANIMATIONLOOPMODE_CONSTANT ANIMATIONLOOPMODE_CYCLE ANIMATIONLOOPMODE_RELATIVE ANIMATIONLOOPMODE_YOYO ANIMATIONTYPE_COLOR3 ANIMATIONTYPE_COLOR4 ANIMATIONTYPE_FLOAT ANIMATIONTYPE_MATRIX ANIMATIONTYPE_QUATERNION ANIMATIONTYPE_SIZE ANIMATIONTYPE_VECTOR2 ANIMATIONTYPE_VECTOR3 AllowMatricesInterpolation AllowMatrixDecomposeForInterpolation CreateFromSnippetAsync SnippetUrl

Accessors

hasRunningRuntimeAnimations runtimeAnimations

Methods

addEvent clone color3InterpolateFunction color3InterpolateFunctionWithTangents color4InterpolateFunction color4InterpolateFunctionWithTangents createKeyForFrame createRange deleteRange evaluate floatInterpolateFunction floatInterpolateFunctionWithTangents getEasingFunction getEvents getHighestFrame getKeys getRange matrixInterpolateFunction quaternionInterpolateFunction quaternionInterpolateFunctionWithTangents removeEvents serialize setEasingFunction setKeys sizeInterpolateFunction toString vector2InterpolateFunction vector2InterpolateFunctionWithTangents vector3InterpolateFunction vector3InterpolateFunctionWithTangents AppendSerializedAnimations CreateAndStartAnimation CreateAndStartHierarchyAnimation CreateAnimation CreateMergeAndStartAnimation MakeAnimationAdditive Parse ParseFromFileAsync ParseFromSnippetAsync TransitionTo

Constructors

constructor

  • Initializes the animation

    Parameters

    • name: string

      Name of the animation

    • targetProperty: string

      Property to animate

    • framePerSecond: number

      The frames per second of the animation

    • dataType: number

      The data type of the animation

    • Optional loopMode: number

      The loop mode of the animation

    • Optional enableBlending: boolean

      Specifies if blending should be enabled

    Returns BabylonAnimation

Properties

blendingSpeed

blendingSpeed: number

Stores the blending speed of the animation

dataType

dataType: number

The data type of the animation

Optional enableBlending

enableBlending?: boolean

Specifies if blending should be enabled

framePerSecond

framePerSecond: number

The frames per second of the animation

Optional loopMode

loopMode?: number

The loop mode of the animation

name

name: string

Name of the animation

snippetId

snippetId: string

Snippet ID if the animation was created from the snippet server

targetProperty

targetProperty: string

Property to animate

targetPropertyPath

targetPropertyPath: string[]

Stores an array of target property paths

uniqueId

uniqueId: number

Gets or sets the unique id of the animation (the uniqueness is solely among other animations)

Static Readonly ANIMATIONLOOPMODE_CONSTANT

ANIMATIONLOOPMODE_CONSTANT: 2 = 2

Constant Loop Mode

Static Readonly ANIMATIONLOOPMODE_CYCLE

ANIMATIONLOOPMODE_CYCLE: 1 = 1

Cycle Loop Mode

Static Readonly ANIMATIONLOOPMODE_RELATIVE

ANIMATIONLOOPMODE_RELATIVE: 0 = 0

Relative Loop Mode

Static Readonly ANIMATIONLOOPMODE_YOYO

ANIMATIONLOOPMODE_YOYO: 4 = 4

Yoyo Loop Mode

Static Readonly ANIMATIONTYPE_COLOR3

ANIMATIONTYPE_COLOR3: 4 = 4

Color3 animation type

Static Readonly ANIMATIONTYPE_COLOR4

ANIMATIONTYPE_COLOR4: 7 = 7

Color3 animation type

Static Readonly ANIMATIONTYPE_FLOAT

ANIMATIONTYPE_FLOAT: 0 = 0

Float animation type

Static Readonly ANIMATIONTYPE_MATRIX

ANIMATIONTYPE_MATRIX: 3 = 3

Matrix animation type

Static Readonly ANIMATIONTYPE_QUATERNION

ANIMATIONTYPE_QUATERNION: 2 = 2

Quaternion animation type

Static Readonly ANIMATIONTYPE_SIZE

ANIMATIONTYPE_SIZE: 6 = 6

Size animation type

Static Readonly ANIMATIONTYPE_VECTOR2

ANIMATIONTYPE_VECTOR2: 5 = 5

Vector2 animation type

Static Readonly ANIMATIONTYPE_VECTOR3

ANIMATIONTYPE_VECTOR3: 1 = 1

Vector3 animation type

Static AllowMatricesInterpolation

AllowMatricesInterpolation: boolean

Use matrix interpolation instead of using direct key value when animating matrices

Static AllowMatrixDecomposeForInterpolation

AllowMatrixDecomposeForInterpolation: boolean

When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower

Static CreateFromSnippetAsync

CreateFromSnippetAsync: ((snippetId: string) => Promise<BabylonAnimation | BabylonAnimation[]>)

Type declaration

    • (snippetId: string): Promise<BabylonAnimation | BabylonAnimation[]>

    • Creates an animation or an array of animations from a snippet saved by the Inspector

      Returns

      a promise that will resolve to the new animation or a new array of animations

      Parameters

      • snippetId: string

        defines the snippet to load

      Returns Promise<BabylonAnimation | BabylonAnimation[]>

Static SnippetUrl

SnippetUrl: string

Define the Url to load snippets

Accessors

hasRunningRuntimeAnimations

  • get hasRunningRuntimeAnimations(): boolean

  • Specifies if any of the runtime animations are currently running

    Returns boolean

runtimeAnimations

  • get runtimeAnimations(): RuntimeAnimation[]

  • Return the array of runtime animations currently using this animation

    Returns RuntimeAnimation[]

Methods

addEvent

  • Add an event to this animation

    Parameters

    • event: AnimationEvent

      Event to add

    Returns void

clone

  • Makes a copy of the animation

    Returns

    Cloned animation

    Returns BabylonAnimation

color3InterpolateFunction

  • Interpolates a Color3 linearly

    Returns

    Interpolated Color3 value

    Parameters

    • startValue: Color3

      Start value of the animation curve

    • endValue: Color3

      End value of the animation curve

    • gradient: number

      Scalar amount to interpolate

    Returns Color3

color3InterpolateFunctionWithTangents

  • Interpolates a Color3 cubically

    Returns

    interpolated value

    Parameters

    • startValue: Color3

      Start value of the animation curve

    • outTangent: Color3

      End tangent of the animation

    • endValue: Color3

      End value of the animation curve

    • inTangent: Color3

      Start tangent of the animation curve

    • gradient: number

      Scalar amount to interpolate

    Returns Color3

color4InterpolateFunction

  • Interpolates a Color4 linearly

    Returns

    Interpolated Color3 value

    Parameters

    • startValue: Color4

      Start value of the animation curve

    • endValue: Color4

      End value of the animation curve

    • gradient: number

      Scalar amount to interpolate

    Returns Color4

color4InterpolateFunctionWithTangents

  • Interpolates a Color4 cubically

    Returns

    interpolated value

    Parameters

    • startValue: Color4

      Start value of the animation curve

    • outTangent: Color4

      End tangent of the animation

    • endValue: Color4

      End value of the animation curve

    • inTangent: Color4

      Start tangent of the animation curve

    • gradient: number

      Scalar amount to interpolate

    Returns Color4

createKeyForFrame

  • Creates a key for the frame passed as a parameter and adds it to the animation IF a key doesn't already exist for that frame

    Returns

    The key index if the key was added or the index of the pre existing key if the frame passed as parameter already has a corresponding key

    Parameters

    • frame: number

      Frame number

    Returns number

createRange

  • Creates an animation range

    Parameters

    • name: string

      Name of the animation range

    • from: number

      Starting frame of the animation range

    • to: number

      Ending frame of the animation

    Returns void

deleteRange

  • Deletes an animation range by name

    Parameters

    • name: string

      Name of the animation range to delete

    • Optional deleteFrames: boolean

      Specifies if the key frames for the range should also be deleted (true) or not (false)

    Returns void

evaluate

  • Evaluate the animation value at a given frame

    Returns

    the animation value

    Parameters

    • currentFrame: number

      defines the frame where we want to evaluate the animation

    Returns any

floatInterpolateFunction

  • Interpolates a scalar linearly

    Returns

    Interpolated scalar value

    Parameters

    • startValue: number

      Start value of the animation curve

    • endValue: number

      End value of the animation curve

    • gradient: number

      Scalar amount to interpolate

    Returns number

floatInterpolateFunctionWithTangents

  • Interpolates a scalar cubically

    Returns

    Interpolated scalar value

    Parameters

    • startValue: number

      Start value of the animation curve

    • outTangent: number

      End tangent of the animation

    • endValue: number

      End value of the animation curve

    • inTangent: number

      Start tangent of the animation curve

    • gradient: number

      Scalar amount to interpolate

    Returns number

getEasingFunction

  • Gets the easing function of the animation

    Returns

    Easing function of the animation

    Returns Nullable<IEasingFunction>

getEvents

  • Retrieves all the events from the animation

    Returns

    Events from the animation

    Returns AnimationEvent[]

getHighestFrame

  • Gets the highest frame rate of the animation

    Returns

    Highest frame rate of the animation

    Returns number

getKeys

  • Gets the key frames from the animation

    Returns

    The key frames of the animation

    Returns IAnimationKey[]

getRange

  • Gets the animation range by name, or null if not defined

    Returns

    Nullable animation range

    Parameters

    • name: string

      Name of the animation range

    Returns Nullable<AnimationRange>

matrixInterpolateFunction

  • Defines the function to use to interpolate matrices

    Returns

    the interpolated matrix

    Parameters

    • startValue: Matrix

      defines the start matrix

    • endValue: Matrix

      defines the end matrix

    • gradient: number

      defines the gradient between both matrices

    • Optional result: Matrix

      defines an optional target matrix where to store the interpolation

    Returns Matrix

quaternionInterpolateFunction

  • Interpolates a quaternion using a spherical linear interpolation

    Returns

    Interpolated quaternion value

    Parameters

    • startValue: Quaternion

      Start value of the animation curve

    • endValue: Quaternion

      End value of the animation curve

    • gradient: number

      Scalar amount to interpolate

    Returns Quaternion

quaternionInterpolateFunctionWithTangents

  • Interpolates a quaternion cubically

    Returns

    Interpolated quaternion value

    Parameters

    • startValue: Quaternion

      Start value of the animation curve

    • outTangent: Quaternion

      End tangent of the animation curve

    • endValue: Quaternion

      End value of the animation curve

    • inTangent: Quaternion

      Start tangent of the animation curve

    • gradient: number

      Scalar amount to interpolate

    Returns Quaternion

removeEvents

  • Remove all events found at the given frame

    Parameters

    • frame: number

      The frame to remove events from

    Returns void

serialize

  • Serializes the animation to an object

    Returns

    Serialized object

    Returns any

setEasingFunction

  • Sets the easing function of the animation

    Parameters

    • easingFunction: Nullable<IEasingFunction>

      A custom mathematical formula for animation

    Returns void

setKeys

  • Sets the key frames of the animation

    Parameters

    • values: IAnimationKey[]

      The animation key frames to set

    • Optional dontClone: boolean

      Whether to clone the keys or not (default is false, so the array of keys is cloned)

    Returns void

sizeInterpolateFunction

  • Interpolates a size linearly

    Returns

    Interpolated Size value

    Parameters

    • startValue: Size

      Start value of the animation curve

    • endValue: Size

      End value of the animation curve

    • gradient: number

      Scalar amount to interpolate

    Returns Size

toString

  • Converts the animation to a string

    Returns

    String form of the animation

    Parameters

    • Optional fullDetails: boolean

      support for multiple levels of logging within scene loading

    Returns string

vector2InterpolateFunction

  • Interpolates a Vector2 linearly

    Returns

    Interpolated Vector2 value

    Parameters

    • startValue: Vector2

      Start value of the animation curve

    • endValue: Vector2

      End value of the animation curve

    • gradient: number

      Scalar amount to interpolate (value between 0 and 1)

    Returns Vector2

vector2InterpolateFunctionWithTangents

  • Interpolates a Vector2 cubically

    Returns

    Interpolated Vector2 value

    Parameters

    • startValue: Vector2

      Start value of the animation curve

    • outTangent: Vector2

      End tangent of the animation

    • endValue: Vector2

      End value of the animation curve

    • inTangent: Vector2

      Start tangent of the animation curve

    • gradient: number

      Scalar amount to interpolate (value between 0 and 1)

    Returns Vector2

vector3InterpolateFunction

  • Interpolates a Vector3 linearly

    Returns

    Interpolated scalar value

    Parameters

    • startValue: Vector3

      Start value of the animation curve

    • endValue: Vector3

      End value of the animation curve

    • gradient: number

      Scalar amount to interpolate (value between 0 and 1)

    Returns Vector3

vector3InterpolateFunctionWithTangents

  • Interpolates a Vector3 cubically

    Returns

    InterpolatedVector3 value

    Parameters

    • startValue: Vector3

      Start value of the animation curve

    • outTangent: Vector3

      End tangent of the animation

    • endValue: Vector3

      End value of the animation curve

    • inTangent: Vector3

      Start tangent of the animation curve

    • gradient: number

      Scalar amount to interpolate (value between 0 and 1)

    Returns Vector3

Static AppendSerializedAnimations

  • Appends the serialized animations from the source animations

    Parameters

    • source: IAnimatable

      Source containing the animations

    • destination: any

      Target to store the animations

    Returns void

Static CreateAndStartAnimation

  • Create and start an animation on a node

    Returns

    the animatable created for this animation

    Parameters

    • name: string

      defines the name of the global animation that will be run on all nodes

    • target: any

      defines the target where the animation will take place

    • targetProperty: string

      defines property to animate

    • framePerSecond: number

      defines the number of frame per second yo use

    • totalFrame: number

      defines the number of frames in total

    • from: any

      defines the initial value

    • to: any

      defines the final value

    • Optional loopMode: number

      defines which loop mode you want to use (off by default)

    • Optional easingFunction: EasingFunction

      defines the easing function to use (linear by default)

    • Optional onAnimationEnd: (() => void)

      defines the callback to call when animation end

        • (): void

        • Returns void

    • Optional scene: Scene

      defines the hosting scene

    Returns Nullable<Animatable>

Static CreateAndStartHierarchyAnimation

  • Create and start an animation on a node and its descendants

    Returns

    the list of animatables created for all nodes

    Example

    https://www.babylonjs-playground.com/#MH0VLI

    Parameters

    • name: string

      defines the name of the global animation that will be run on all nodes

    • node: Node

      defines the root node where the animation will take place

    • directDescendantsOnly: boolean

      if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used

    • targetProperty: string

      defines property to animate

    • framePerSecond: number

      defines the number of frame per second to use

    • totalFrame: number

      defines the number of frames in total

    • from: any

      defines the initial value

    • to: any

      defines the final value

    • Optional loopMode: number

      defines which loop mode you want to use (off by default)

    • Optional easingFunction: EasingFunction

      defines the easing function to use (linear by default)

    • Optional onAnimationEnd: (() => void)

      defines the callback to call when an animation ends (will be called once per node)

        • (): void

        • Returns void

    Returns Nullable<Animatable[]>

Static CreateAnimation

  • Sets up an animation

    Returns

    The created animation

    Parameters

    • property: string

      The property to animate

    • animationType: number

      The animation type to apply

    • framePerSecond: number

      The frames per second of the animation

    • easingFunction: EasingFunction

      The easing function used in the animation

    Returns BabylonAnimation

Static CreateMergeAndStartAnimation

  • Creates a new animation, merges it with the existing animations and starts it

    Returns

    Nullable animation

    Parameters

    • name: string

      Name of the animation

    • node: Node

      Node which contains the scene that begins the animations

    • targetProperty: string

      Specifies which property to animate

    • framePerSecond: number

      The frames per second of the animation

    • totalFrame: number

      The total number of frames

    • from: any

      The frame at the beginning of the animation

    • to: any

      The frame at the end of the animation

    • Optional loopMode: number

      Specifies the loop mode of the animation

    • Optional easingFunction: EasingFunction

      (Optional) The easing function of the animation, which allow custom mathematical formulas for animations

    • Optional onAnimationEnd: (() => void)

      Callback to run once the animation is complete

        • (): void

        • Returns void

    Returns Nullable<Animatable>

Static MakeAnimationAdditive

  • Convert the keyframes of an animation to be relative to a given reference frame.

    Returns

    a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false

    Parameters

    • sourceAnimation: BabylonAnimation

      defines the Animation containing keyframes to convert

    • Optional referenceFrame: number

      defines the frame that keyframes in the range will be relative to (default: 0)

    • Optional range: string

      defines the name of the AnimationRange belonging to the Animation to convert

    • Optional cloneOriginal: boolean

      defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)

    • Optional clonedName: string

      defines the name of the resulting cloned Animation if cloneOriginal is true

    Returns BabylonAnimation

  • Convert the keyframes of an animation to be relative to a given reference frame.

    Returns

    a new Animation if options.cloneOriginalAnimation is true or the original Animation if options.cloneOriginalAnimation is false

    Parameters

    • sourceAnimation: BabylonAnimation

      defines the Animation containing keyframes to convert

    • Optional options: IMakeAnimationAdditiveOptions

      defines the options to use when converting ey keyframes

    Returns BabylonAnimation

Static Parse

  • Parses an animation object and creates an animation

    Returns

    Animation object

    Parameters

    • parsedAnimation: any

      Parsed animation object

    Returns BabylonAnimation

Static ParseFromFileAsync

  • Creates a new animation or an array of animations from a snippet saved in a remote file

    Returns

    a promise that will resolve to the new animation or an array of animations

    Parameters

    • name: Nullable<string>

      defines the name of the animation to create (can be null or empty to use the one from the json data)

    • url: string

      defines the url to load from

    Returns Promise<BabylonAnimation | BabylonAnimation[]>

Static ParseFromSnippetAsync

  • Creates an animation or an array of animations from a snippet saved by the Inspector

    Returns

    a promise that will resolve to the new animation or a new array of animations

    Parameters

    • snippetId: string

      defines the snippet to load

    Returns Promise<BabylonAnimation | BabylonAnimation[]>

Static TransitionTo

  • Transition property of an host to the target Value

    Returns

    Nullable animation

    Parameters

    • property: string

      The property to transition

    • targetValue: any

      The target Value of the property

    • host: any

      The object where the property to animate belongs

    • scene: Scene

      Scene used to run the animation

    • frameRate: number

      Framerate (in frame/s) to use

    • transition: BabylonAnimation

      The transition type we want to use

    • duration: number

      The duration of the animation, in milliseconds

    • Optional onAnimationEnd: Nullable<(() => void)>

      Callback trigger at the end of the animation

    Returns Nullable<Animatable>

Settings

Member Visibility

Theme

Generated using TypeDoc