Babylon.js API documentation|

BakedVertexAnimationManager

Class BakedVertexAnimationManager

This class is used to animate meshes using a baked vertex animation texture

see: https://doc.babylonjs.com/features/featuresDeepDive/animation/baked_texture_animations
since: 5.0

Hierarchy

BakedVertexAnimationManager

Implements

IBakedVertexAnimationManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BakedVertexAnimationManager(scene?: Nullable<Scene>): BakedVertexAnimationManager

- Defined in .temp/docdirectory/doc.d.ts:5742
Creates a new BakedVertexAnimationManager

Parameters
- Optional scene: Nullable<Scene>
  
  defines the current scene
Returns BakedVertexAnimationManager

Properties

animationParameters Search playground for animationParameters

animationParameters: Vector4

The animation parameters for the mesh. See setAnimationParameters()

isEnabled Search playground for isEnabled

isEnabled: boolean

Enable or disable the vertex animation manager

texture Search playground for texture

texture: Nullable<BaseTexture>

The vertex animation texture

time Search playground for time

time: number

The time counter, to pick the correct animation frame.

Methods

bind Search playground for bind

bind(effect: Effect, useInstances?: boolean): void

Implementation of IBakedVertexAnimationManager.bind
- Defined in .temp/docdirectory/doc.d.ts:5750
Binds to the effect.

Parameters
- effect: Effect
  
  The effect to bind to.
- Optional useInstances: boolean
  
  True when it's an instance.
Returns void

clone Search playground for clone

clone(): BakedVertexAnimationManager

- Defined in .temp/docdirectory/doc.d.ts:5755
Clone the current manager

Returns BakedVertexAnimationManager
a new BakedVertexAnimationManager

copyTo Search playground for copyTo

copyTo(vatMap: BakedVertexAnimationManager): void

- Defined in .temp/docdirectory/doc.d.ts:5778
Makes a duplicate of the current instance into another one.

Parameters
- vatMap: BakedVertexAnimationManager
  
  define the instance where to copy the info
Returns void

dispose Search playground for dispose

dispose(forceDisposeTextures?: boolean): void

Implementation of IBakedVertexAnimationManager.dispose
- Defined in .temp/docdirectory/doc.d.ts:5768
Disposes the resources of the manager.

Parameters
- Optional forceDisposeTextures: boolean
  
  Forces the disposal of all textures.
Returns void

getClassName Search playground for getClassName

getClassName(): string

Implementation of IBakedVertexAnimationManager.getClassName
- Defined in .temp/docdirectory/doc.d.ts:5773
Get the current class name useful for serialization or dynamic coding.

Returns string
"BakedVertexAnimationManager"

parse Search playground for parse

parse(source: any, scene: Scene, rootUrl: string): void

- Defined in .temp/docdirectory/doc.d.ts:5790
Parses a vertex animation setting from a serialized object.

Parameters
- source: any
  
  Serialized object.
- scene: Scene
  
  Defines the scene we are parsing for
- rootUrl: string
  
  Defines the rootUrl to load from
Returns void

serialize Search playground for serialize

serialize(): any

- Defined in .temp/docdirectory/doc.d.ts:5783
Serializes this vertex animation instance

Returns any
- An object with the serialized instance.

setAnimationParameters Search playground for setAnimationParameters

setAnimationParameters(startFrame: number, endFrame: number, offset?: number, speedFramesPerSecond?: number): void

Implementation of IBakedVertexAnimationManager.setAnimationParameters
- Defined in .temp/docdirectory/doc.d.ts:5763
Sets animation parameters.

Parameters
- startFrame: number
  
  The first frame of the animation.
- endFrame: number
  
  The last frame of the animation.
- Optional offset: number
  
  The offset when starting the animation.
- Optional speedFramesPerSecond: number
  
  The frame rate.
Returns void