VertexAnimationBaker

Class VertexAnimationBaker

Class to bake vertex animation textures.

since: 5.0

Hierarchy

VertexAnimationBaker

Index

Constructors

constructor

Methods

Constructors

constructor

new VertexAnimationBaker(scene: Scene, mesh: Mesh): VertexAnimationBaker

- Defined in .temp/docdirectory/doc.d.ts:5538
Create a new VertexAnimationBaker object which can help baking animations into a texture.

Parameters
- scene: Scene
  
  Defines the scene the VAT belongs to
- mesh: Mesh
  
  Defines the mesh the VAT belongs to
Returns VertexAnimationBaker

Methods

bakeVertexDataSearch playground for bakeVertexData

bakeVertexData(ranges: AnimationRange[]): Promise<Float32Array>

- Defined in .temp/docdirectory/doc.d.ts:5551
Bakes the animation into the texture. This should be called once, when the scene starts, so the VAT is generated and associated to the mesh.

Parameters
- ranges: AnimationRange[]
  
  Defines the ranges in the animation that will be baked.
Returns Promise<Float32Array>

The array of matrix transforms for each vertex (columns) and frame (rows), as a Float32Array.

loadBakedVertexDataFromJSONSearch playground for loadBakedVertexDataFromJSON

loadBakedVertexDataFromJSON(json: string): Float32Array

- Defined in .temp/docdirectory/doc.d.ts:5590
Loads previously baked data in string format.

Parameters
- json: string
  
  The json string as serialized by serializeBakedVertexDataToJSON().
Returns Float32Array

The array of matrix transforms for each vertex (columns) and frame (rows), as a Float32Array.

loadBakedVertexDataFromObjectSearch playground for loadBakedVertexDataFromObject

loadBakedVertexDataFromObject(data: Record<string, any>): Float32Array

- Defined in .temp/docdirectory/doc.d.ts:5577
Loads previously baked data.

Parameters
- data: Record<string, any>
  
  The object as serialized by serializeBakedVertexDataToObject()
Returns Float32Array

The array of matrix transforms for each vertex (columns) and frame (rows), as a Float32Array.

serializeBakedVertexDataToJSONSearch playground for serializeBakedVertexDataToJSON

serializeBakedVertexDataToJSON(vertexData: Float32Array): string

- Defined in .temp/docdirectory/doc.d.ts:5584
Serializes our vertexData to a JSON string, with a nice string for the vertexData. Should be called right after bakeVertexData().

Parameters
- vertexData: Float32Array
  
  The vertex array data.
Returns string

This object serialized to a safe string.

serializeBakedVertexDataToObjectSearch playground for serializeBakedVertexDataToObject

serializeBakedVertexDataToObject(vertexData: Float32Array): Record<string, any>

- Defined in .temp/docdirectory/doc.d.ts:5571
Serializes our vertexData to an object, with a nice string for the vertexData.

Parameters
- vertexData: Float32Array
  
  The vertex array data.
Returns Record<string, any>

This object serialized to a JS dict.

textureFromBakedVertexDataSearch playground for textureFromBakedVertexData

textureFromBakedVertexData(vertexData: Float32Array): RawTexture

- Defined in .temp/docdirectory/doc.d.ts:5565
Builds a vertex animation texture given the vertexData in an array.

Parameters
- vertexData: Float32Array
  
  The vertex animation data. You can generate it with bakeVertexData().
Returns RawTexture

The vertex animation texture to be used with BakedVertexAnimationManager.