Animation | Babylon.js API documentation

Class Animation

Class used to store any kind of animation

Index

Constructors

Accessors

hasRunningRuntimeAnimations runtimeAnimations

Methods

Constructors

constructor

new Animation(
    name: string,
    targetProperty: string,
    framePerSecond: number,
    dataType: number,
    loopMode?: number,
    enableBlending?: boolean,
): Animation
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
- OptionalloopMode: number
  The loop mode of the animation
- OptionalenableBlending: boolean
  Specifies if blending should be enabled
Returns Animation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139099

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`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` `Readonly`ANIMATIONLOOPMODE_CONSTANT

ANIMATIONLOOPMODE_CONSTANT: 2

Constant Loop Mode

`Static` `Readonly`ANIMATIONLOOPMODE_CYCLE

ANIMATIONLOOPMODE_CYCLE: 1

Cycle Loop Mode

`Static` `Readonly`ANIMATIONLOOPMODE_RELATIVE

ANIMATIONLOOPMODE_RELATIVE: 0

Relative Loop Mode

`Static` `Readonly`ANIMATIONLOOPMODE_RELATIVE_FROM_CURRENT

ANIMATIONLOOPMODE_RELATIVE_FROM_CURRENT: 5

Relative Loop Mode (add to current value of animated object, unlike ANIMATIONLOOPMODE_RELATIVE)

`Static` `Readonly`ANIMATIONLOOPMODE_YOYO

ANIMATIONLOOPMODE_YOYO: 4

Yoyo Loop Mode

`Static` `Readonly`ANIMATIONTYPE_COLOR3

ANIMATIONTYPE_COLOR3: 4

Color3 animation type

`Static` `Readonly`ANIMATIONTYPE_COLOR4

ANIMATIONTYPE_COLOR4: 7

Color3 animation type

`Static` `Readonly`ANIMATIONTYPE_FLOAT

ANIMATIONTYPE_FLOAT: 0

Float animation type

`Static` `Readonly`ANIMATIONTYPE_MATRIX

ANIMATIONTYPE_MATRIX: 3

Matrix animation type

`Static` `Readonly`ANIMATIONTYPE_QUATERNION

ANIMATIONTYPE_QUATERNION: 2

Quaternion animation type

`Static` `Readonly`ANIMATIONTYPE_SIZE

ANIMATIONTYPE_SIZE: 6

Size animation type

`Static` `Readonly`ANIMATIONTYPE_VECTOR2

ANIMATIONTYPE_VECTOR2: 5

Vector2 animation type

`Static` `Readonly`ANIMATIONTYPE_VECTOR3

ANIMATIONTYPE_VECTOR3: 1

Vector3 animation type

`Static`CreateFromSnippetAsync

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

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

Type declaration

- (snippetId: string): Promise<Animation | Animation[]>
- Creates an animation or an array of animations from a snippet saved by the Inspector
  Parameters
  - snippetId: string
    defines the snippet to load
  Returns Promise<Animation | Animation[]>
  a promise that will resolve to the new animation or a new array of animations

Deprecated

Please use ParseFromSnippetAsync instead

Param: snippetId

defines the snippet to load

Returns

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

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

runtimeAnimations

get runtimeAnimations(): RuntimeAnimation[]
Return the array of runtime animations currently using this animation

Returns RuntimeAnimation[]
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139085

Methods

addEvent

addEvent(event: AnimationEvent): void
Add an event to this animation
Parameters
- event: AnimationEvent
  Event to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139122

clone

clone(): Animation
Makes a copy of the animation

Returns Animation
Cloned animation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139317

color3InterpolateFunction

color3InterpolateFunction(
    startValue: Color3,
    endValue: Color3,
    gradient: number,
): Color3
Interpolates a Color3 linearly
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
Interpolated Color3 value
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139259

color3InterpolateFunctionWithTangents

color3InterpolateFunctionWithTangents(
    startValue: Color3,
    outTangent: Color3,
    endValue: Color3,
    inTangent: Color3,
    gradient: number,
): Color3
Interpolates a Color3 cubically
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
interpolated value
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139269

color4InterpolateFunction

color4InterpolateFunction(
    startValue: Color4,
    endValue: Color4,
    gradient: number,
): Color4
Interpolates a Color4 linearly
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
Interpolated Color3 value
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139277

color4InterpolateFunctionWithTangents

color4InterpolateFunctionWithTangents(
    startValue: Color4,
    outTangent: Color4,
    endValue: Color4,
    inTangent: Color4,
    gradient: number,
): Color4
Interpolates a Color4 cubically
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
interpolated value
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139287

createKeyForFrame

createKeyForFrame(frame: number): number
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
Parameters
- frame: number
  Frame number
Returns number
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139329

createRange

createRange(name: string, from: number, to: number): void
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139139

deleteRange

deleteRange(name: string, deleteFrames?: boolean): void
Deletes an animation range by name
Parameters
- name: string
  Name of the animation range to delete
- OptionaldeleteFrames: boolean
  Specifies if the key frames for the range should also be deleted (true) or not (false)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139145

evaluate

evaluate(currentFrame: number): any
Evaluate the animation value at a given frame
Parameters
- currentFrame: number
  defines the frame where we want to evaluate the animation
Returns any
the animation value
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139297

floatInterpolateFunction

floatInterpolateFunction(
    startValue: number,
    endValue: number,
    gradient: number,
): number
Interpolates a scalar linearly
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
Interpolated scalar value
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139179

floatInterpolateFunctionWithTangents

floatInterpolateFunctionWithTangents(
    startValue: number,
    outTangent: number,
    endValue: number,
    inTangent: number,
    gradient: number,
): number
Interpolates a scalar cubically
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
Interpolated scalar value
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139189

getEasingFunction

getEasingFunction(): Nullable<IEasingFunction>
Gets the easing function of the animation

Returns Nullable<IEasingFunction>
Easing function of the animation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139166

getEvents

getEvents(): AnimationEvent[]
Retrieves all the events from the animation

Returns AnimationEvent[]
Events from the animation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139132

getHighestFrame

getHighestFrame(): number
Gets the highest frame of the animation

Returns number
Highest frame of the animation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139161

getKeys

getKeys(): IAnimationKey[]
Gets the key frames from the animation

Returns IAnimationKey[]
The key frames of the animation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139156

getRange

getRange(name: string): Nullable<AnimationRange>
Gets the animation range by name, or null if not defined
Parameters
- name: string
  Name of the animation range
Returns Nullable<AnimationRange>
Nullable animation range
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139151

matrixInterpolateFunction

matrixInterpolateFunction(
    startValue: Matrix,
    endValue: Matrix,
    gradient: number,
    result?: Matrix,
): Matrix
Defines the function to use to interpolate matrices
Parameters
- startValue: Matrix
  defines the start matrix
- endValue: Matrix
  defines the end matrix
- gradient: number
  defines the gradient between both matrices
- Optionalresult: Matrix
  defines an optional target matrix where to store the interpolation
Returns Matrix
the interpolated matrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139312

quaternionInterpolateFunction

quaternionInterpolateFunction(
    startValue: Quaternion,
    endValue: Quaternion,
    gradient: number,
): Quaternion
Interpolates a quaternion using a spherical linear interpolation
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
Interpolated quaternion value
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139197

quaternionInterpolateFunctionWithTangents

quaternionInterpolateFunctionWithTangents(
    startValue: Quaternion,
    outTangent: Quaternion,
    endValue: Quaternion,
    inTangent: Quaternion,
    gradient: number,
): Quaternion
Interpolates a quaternion cubically
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
Interpolated quaternion value
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139207

removeEvents

removeEvents(frame: number): void
Remove all events found at the given frame
Parameters
- frame: number
  The frame to remove events from
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139127

serialize

serialize(): any
Serializes the animation to an object

Returns any
Serialized object
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139334

setEasingFunction

setEasingFunction(easingFunction: Nullable<IEasingFunction>): void
Sets the easing function of the animation
Parameters
- easingFunction: Nullable<IEasingFunction>
  A custom mathematical formula for animation
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139171

setKeys

setKeys(values: IAnimationKey[], dontClone?: boolean): void
Sets the key frames of the animation
Parameters
- values: IAnimationKey[]
  The animation key frames to set
- OptionaldontClone: boolean
  Whether to clone the keys or not (default is false, so the array of keys is cloned)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139323

sizeInterpolateFunction

sizeInterpolateFunction(
    startValue: Size,
    endValue: Size,
    gradient: number,
): Size
Interpolates a size linearly
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
Interpolated Size value
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139251

toString

toString(fullDetails?: boolean): string
Converts the animation to a string
Parameters
- OptionalfullDetails: boolean
  support for multiple levels of logging within scene loading
Returns string
String form of the animation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139117

vector2InterpolateFunction

vector2InterpolateFunction(
    startValue: Vector2,
    endValue: Vector2,
    gradient: number,
): Vector2
Interpolates a Vector2 linearly
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
Interpolated Vector2 value
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139233

vector2InterpolateFunctionWithTangents

vector2InterpolateFunctionWithTangents(
    startValue: Vector2,
    outTangent: Vector2,
    endValue: Vector2,
    inTangent: Vector2,
    gradient: number,
): Vector2
Interpolates a Vector2 cubically
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
Interpolated Vector2 value
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139243

vector3InterpolateFunction

vector3InterpolateFunction(
    startValue: Vector3,
    endValue: Vector3,
    gradient: number,
): Vector3
Interpolates a Vector3 linearly
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
Interpolated scalar value
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139215

vector3InterpolateFunctionWithTangents

vector3InterpolateFunctionWithTangents(
    startValue: Vector3,
    outTangent: Vector3,
    endValue: Vector3,
    inTangent: Vector3,
    gradient: number,
): Vector3
Interpolates a Vector3 cubically
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
InterpolatedVector3 value
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139225

`Static`AppendSerializedAnimations

AppendSerializedAnimations(source: IAnimatable, destination: any): void
Appends the serialized animations from the source animations
Parameters
- source: IAnimatable
  Source containing the animations
- destination: any
  Target to store the animations
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139402

`Static`CreateAndStartAnimation

CreateAndStartAnimation(
    name: string,
    target: any,
    targetProperty: string,
    framePerSecond: number,
    totalFrame: number,
    from: any,
    to: any,
    loopMode?: number,
    easingFunction?: EasingFunction,
    onAnimationEnd?: () => void,
    scene?: Scene,
): Nullable<Animatable>
Create and start an animation on a node
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
- OptionalloopMode: number
  defines which loop mode you want to use (off by default)
- OptionaleasingFunction: EasingFunction
  defines the easing function to use (linear by default)
- OptionalonAnimationEnd: () => void
  defines the callback to call when animation end
- Optionalscene: Scene
  defines the hosting scene
Returns Nullable<Animatable>
the animatable created for this animation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139019

`Static`CreateAndStartHierarchyAnimation

CreateAndStartHierarchyAnimation(
    name: string,
    node: Node,
    directDescendantsOnly: boolean,
    targetProperty: string,
    framePerSecond: number,
    totalFrame: number,
    from: any,
    to: any,
    loopMode?: number,
    easingFunction?: EasingFunction,
    onAnimationEnd?: () => void,
): Nullable<Animatable[]>
Create and start an animation on a node and its descendants
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
- OptionalloopMode: number
  defines which loop mode you want to use (off by default)
- OptionaleasingFunction: EasingFunction
  defines the easing function to use (linear by default)
- OptionalonAnimationEnd: () => void
  defines the callback to call when an animation ends (will be called once per node)
Returns Nullable<Animatable[]>
the list of animatables created for all nodes
Example
```
https://www.babylonjs-playground.com/#MH0VLI
```
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139036

`Static`CreateAnimation

CreateAnimation(
    property: string,
    animationType: number,
    framePerSecond: number,
    easingFunction: EasingFunction,
): Animation
Sets up an 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 Animation
The created animation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139003

`Static`CreateMergeAndStartAnimation

CreateMergeAndStartAnimation(
    name: string,
    node: Node,
    targetProperty: string,
    framePerSecond: number,
    totalFrame: number,
    from: any,
    to: any,
    loopMode?: number,
    easingFunction?: EasingFunction,
    onAnimationEnd?: () => void,
): Nullable<Animatable>
Creates a new animation, merges it with the existing animations and starts it
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
- OptionalloopMode: number
  Specifies the loop mode of the animation
- OptionaleasingFunction: EasingFunction
  (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
- OptionalonAnimationEnd: () => void
  Callback to run once the animation is complete
Returns Nullable<Animatable>
Nullable animation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139051

`Static`MakeAnimationAdditive

MakeAnimationAdditive(
    sourceAnimation: Animation,
    referenceFrame?: number,
    range?: string,
    cloneOriginal?: boolean,
    clonedName?: string,
): Animation
Convert the keyframes of an animation to be relative to a given reference frame.
Parameters
- sourceAnimation: Animation
  defines the Animation containing keyframes to convert
- OptionalreferenceFrame: number
  defines the frame that keyframes in the range will be relative to (default: 0)
- Optionalrange: string
  defines the name of the AnimationRange belonging to the Animation to convert
- OptionalcloneOriginal: boolean
  defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
- OptionalclonedName: string
  defines the name of the resulting cloned Animation if cloneOriginal is true
Returns Animation
a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139061
MakeAnimationAdditive(
sourceAnimation: Animation,
options?: IMakeAnimationAdditiveOptions,
): Animation
Convert the keyframes of an animation to be relative to a given reference frame.
Parameters
- sourceAnimation: Animation
  defines the Animation containing keyframes to convert
- Optionaloptions: IMakeAnimationAdditiveOptions
  defines the options to use when converting ey keyframes
Returns Animation
a new Animation if options.cloneOriginalAnimation is true or the original Animation if options.cloneOriginalAnimation is false
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139068

`Static`Parse

Parse(parsedAnimation: any): Animation
Parses an animation object and creates an animation
Parameters
- parsedAnimation: any
  Parsed animation object
Returns Animation
Animation object
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139396

`Static`ParseFromFileAsync

ParseFromFileAsync(
name: Nullable<string>,
url: string,
): Promise<Animation | Animation[]>
Creates a new animation or an array of animations from a snippet saved in a remote file
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<Animation | Animation[]>
a promise that will resolve to the new animation or an array of animations
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139409

`Static`ParseFromSnippetAsync

ParseFromSnippetAsync(snippetId: string): Promise<Animation | Animation[]>
Creates an animation or an array of animations from a snippet saved by the Inspector
Parameters
- snippetId: string
  defines the snippet to load
Returns Promise<Animation | Animation[]>
a promise that will resolve to the new animation or a new array of animations
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139415

`Static`TransitionTo

TransitionTo(
    property: string,
    targetValue: any,
    host: any,
    scene: Scene,
    frameRate: number,
    transition: Animation,
    duration: number,
    onAnimationEnd?: Nullable<() => void>,
): Nullable<Animatable>
Transition property of an host to the target Value
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: Animation
  The transition type we want to use
- duration: number
  The duration of the animation, in milliseconds
- OptionalonAnimationEnd: Nullable<() => void>
  Callback trigger at the end of the animation
Returns Nullable<Animatable>
Nullable animation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139081

Class Animation

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Animation

Properties

blendingSpeed

dataType

OptionalenableBlending

framePerSecond

OptionalloopMode

name

snippetId

targetProperty

targetPropertyPath

uniqueId

StaticAllowMatricesInterpolation

StaticAllowMatrixDecomposeForInterpolation

Static ReadonlyANIMATIONLOOPMODE_CONSTANT

Static ReadonlyANIMATIONLOOPMODE_CYCLE

Static ReadonlyANIMATIONLOOPMODE_RELATIVE

Static ReadonlyANIMATIONLOOPMODE_RELATIVE_FROM_CURRENT

Static ReadonlyANIMATIONLOOPMODE_YOYO

Static ReadonlyANIMATIONTYPE_COLOR3

Static ReadonlyANIMATIONTYPE_COLOR4

Static ReadonlyANIMATIONTYPE_FLOAT

Static ReadonlyANIMATIONTYPE_MATRIX

Static ReadonlyANIMATIONTYPE_QUATERNION

Static ReadonlyANIMATIONTYPE_SIZE

Static ReadonlyANIMATIONTYPE_VECTOR2

Static ReadonlyANIMATIONTYPE_VECTOR3

StaticCreateFromSnippetAsync

Type declaration

Parameters

Returns Promise<Animation | Animation[]>

Deprecated

Param: snippetId

Returns

StaticSnippetUrl

Accessors

hasRunningRuntimeAnimations

Returns boolean

runtimeAnimations

Returns RuntimeAnimation[]

Methods

addEvent

Parameters

Returns void

clone

Returns Animation

color3InterpolateFunction

Parameters

Returns Color3

color3InterpolateFunctionWithTangents

Parameters

Returns Color3

color4InterpolateFunction

Parameters

Returns Color4

color4InterpolateFunctionWithTangents

Parameters

Returns Color4

createKeyForFrame

Parameters

Returns number

createRange

Parameters

Returns void

deleteRange

Parameters

Returns void

evaluate

Parameters

Returns any

floatInterpolateFunction

`Optional`enableBlending

`Optional`loopMode

`Static`AllowMatricesInterpolation

`Static`AllowMatrixDecomposeForInterpolation

`Static` `Readonly`ANIMATIONLOOPMODE_CONSTANT

`Static` `Readonly`ANIMATIONLOOPMODE_CYCLE

`Static` `Readonly`ANIMATIONLOOPMODE_RELATIVE

`Static` `Readonly`ANIMATIONLOOPMODE_RELATIVE_FROM_CURRENT

`Static` `Readonly`ANIMATIONLOOPMODE_YOYO

`Static` `Readonly`ANIMATIONTYPE_COLOR3

`Static` `Readonly`ANIMATIONTYPE_COLOR4

`Static` `Readonly`ANIMATIONTYPE_FLOAT

`Static` `Readonly`ANIMATIONTYPE_MATRIX

`Static` `Readonly`ANIMATIONTYPE_QUATERNION

`Static` `Readonly`ANIMATIONTYPE_SIZE

`Static` `Readonly`ANIMATIONTYPE_VECTOR2

`Static` `Readonly`ANIMATIONTYPE_VECTOR3

`Static`CreateFromSnippetAsync

`Static`SnippetUrl

`Static`AppendSerializedAnimations

`Static`CreateAndStartAnimation

`Static`CreateAndStartHierarchyAnimation

`Static`CreateAnimation

`Static`CreateMergeAndStartAnimation