Class InstanceHandle

constructor

• new InstanceHandle(originalObject, instancer): InstanceHandle

• Parameters

  • originalObject: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
  • 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_): void

• Removes this object from the instancing renderer

  Parameters

  • delete_: boolean

  Returns void

setGeometry

• setGeometry(geo): boolean

• Can be used to change the geometry of this instance

  Parameters

  • geo: BufferGeometry<NormalBufferAttributes>

  Returns boolean

setMatrix

• setMatrix(matrix): void

• Updates the matrix of the instance

  Parameters

  • matrix: Matrix4

  Returns void

updateInstanceMatrix

• updateInstanceMatrix(updateChildren?, updateMatrix?): void

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

  Parameters

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

  Returns void