@babylonjs/core|

Class Lattice

Class used to represent a lattice

See

Index

Constructors

Accessors

cellSize data max min position resolutionX resolutionY resolutionZ size

Methods

deform deformMesh getClassName update updateInternals

Constructors

constructor

new Lattice(options?: Partial<ILatticeOptions>): Lattice
Creates a new Lattice
Parameters
- Optionaloptions: Partial<ILatticeOptions>
  options for creating
Returns Lattice
- Defined in packages/dev/core/src/Meshes/lattice.ts:127

Accessors

cellSize

get cellSize(): Vector3
Gets the size of each cell in the lattice

Returns Vector3
- Defined in packages/dev/core/src/Meshes/lattice.ts:105

data

get data(): Vector3[][][]
Gets the data of the lattice

Returns Vector3[][][]
- Defined in packages/dev/core/src/Meshes/lattice.ts:98

max

get max(): Vector3
Gets the max bounds of the lattice

Returns Vector3
- Defined in packages/dev/core/src/Meshes/lattice.ts:119

min

get min(): Vector3
Gets the min bounds of the lattice

Returns Vector3
- Defined in packages/dev/core/src/Meshes/lattice.ts:112

position

get position(): Vector3
Gets the lattice position in object space

Returns Vector3
- Defined in packages/dev/core/src/Meshes/lattice.ts:91

resolutionX

get resolutionX(): number
Gets the resolution on x axis

Returns number
- Defined in packages/dev/core/src/Meshes/lattice.ts:62

resolutionY

get resolutionY(): number
Gets the resolution on y axis

Returns number
- Defined in packages/dev/core/src/Meshes/lattice.ts:69

resolutionZ

get resolutionZ(): number
Gets the resolution on z axis

Returns number
- Defined in packages/dev/core/src/Meshes/lattice.ts:76

size

get size(): Vector3
Gets the size of the lattice along each axis in object space Updating the size requires you to call update afterwards

Returns Vector3
- Defined in packages/dev/core/src/Meshes/lattice.ts:84

Methods

deform

deform(positions: FloatArray, target?: any): void
Apply the lattice to a set of points
Parameters
- positions: FloatArray
  vertex data to deform
- Optionaltarget: any
  optional target array to store the result (operation will be done in place in not defined)
Returns void
- Defined in packages/dev/core/src/Meshes/lattice.ts:217

deformMesh

deformMesh(mesh: Mesh): void
Apply the lattice to a mesh
Parameters
- mesh: Mesh
  mesh to deform
Returns void
- Defined in packages/dev/core/src/Meshes/lattice.ts:182

getClassName

getClassName(): string
Returns string
the string "Lattice"
- Defined in packages/dev/core/src/Meshes/lattice.ts:55

update

update(): void
Update of the lattice data

Returns void
- Defined in packages/dev/core/src/Meshes/lattice.ts:164

updateInternals

updateInternals(): void
Update the lattice internals (like min, max and cell size)

Returns void
- Defined in packages/dev/core/src/Meshes/lattice.ts:199