Class InstanceHandle

constructor

• new InstanceHandle(
      originalObject: Mesh,
      instancer: InstancedMeshRenderer,
  ): InstanceHandle

  Parameters

  • originalObject: Mesh
  • instancer: InstancedMeshRenderer

  Returns InstanceHandle

ReadonlymeshInformation

Readonlyobject

Readonlyrenderer

indexCount

• get indexCount(): number

  Returns number

isActive

• get isActive(): boolean

  Returns boolean

maxIndexCount

• get maxIndexCount(): number

  Returns number

maxVertexCount

• get maxVertexCount(): number

  Returns number

name

• get name(): string

  The name of the object

  Returns string

reservedIndexCount

• get reservedIndexCount(): number

  Returns number

reservedVertexCount

• get reservedVertexCount(): number

  Returns number

vertexCount

• get vertexCount(): number

  Returns number

add

• add(): void

  Adds this object to the instancing renderer (effectively activating instancing)

  Returns void

remove

• remove(delete_: boolean): void

  Removes this object from the instancing renderer

  Parameters

  • delete_: boolean

    If true, the instance handle will be removed from the global list

  Returns void

setGeometry

• setGeometry(geo: BufferGeometry): boolean

  Can be used to change the geometry of this instance

  Parameters

  • geo: BufferGeometry

  Returns boolean

setMatrix

• setMatrix(matrix: Matrix4): void

  Updates the matrix of the instance

  Parameters

  • matrix: Matrix4

  Returns void

updateInstanceMatrix

• updateInstanceMatrix(updateChildren?: boolean, updateMatrix?: boolean): void

  Updates the matrix from the rendered object. Will also call updateWorldMatrix internally

  Parameters

  • updateChildren: boolean = false
  • updateMatrix: boolean = true

  Returns void

updateMeshInformation

• updateMeshInformation(): boolean

  Calculates the mesh information again

  Returns boolean

  true if the vertex count or index count has changed