Class BasicHierarchicalInstancer

constructor

• new BasicHierarchicalInstancer(
      device: GraphicsDevice,
      params?: IBasicHierarchicalInstancerParams,
  ): BasicHierarchicalInstancer

  Parameters

  • device: GraphicsDevice
  • params: IBasicHierarchicalInstancerParams = {}

  Returns BasicHierarchicalInstancer

colorsTexture

Readonlydevice

LODs

matricesTexture

capacity

• get capacity(): number

  The capacity of the instance buffers.

  Returns number

id

• get id(): number

  Unique id for the instancer.

  Returns number

addLOD

• addLOD(
      meshInstanceList: MeshInstance[] | null,
      root: Entity | null,
      distance?: number,
      hysteresis?: number,
  ): number

  Parameters

  • meshInstanceList: MeshInstance[] | null
  • root: Entity | null
  • distance: number = 0
  • hysteresis: number = 0

  Returns number

applyMatrixAtToSphere

• applyMatrixAtToSphere(
      index: number,
      sphere: BoundingSphere,
      center: Vec3,
      radius: number,
  ): void

  Parameters

  • index: number
  • sphere: BoundingSphere
  • center: Vec3
  • radius: number

  Returns void

applySortingIfNeeded

• applySortingIfNeeded(): void

  Returns void

computeMaxInstanceBoundingBox

• computeMaxInstanceBoundingBox(src?: BoundingBox): BoundingBox

  Parameters

  • Optionalsrc: BoundingBox

  Returns BoundingBox

destroy

• destroy(): void

  Destroys the instancer and all its resources.

  Returns void

getColorAt

• getColorAt(id: number, color?: Color): Color

  Gets the color of a specific instance.

  Parameters

  • id: number

    The index of the instance.

  • Optionalcolor: Color

    Optional Color to store the result.

  Returns Color

  The color of the instance.

getMatrixAt

• getMatrixAt(id: number, matrix?: Mat4): Mat4

  Gets the local transformation matrix of a specific instance.

  Parameters

  • id: number

    The index of the instance.

  • Optionalmatrix: Mat4

    Optional Mat4 to store the result.

  Returns Mat4

  The transformation matrix of the instance.

getObjectLODIndexForDistance

• getObjectLODIndexForDistance(lods: ILODLevel[], distance: number): number

  Retrieves the index of the LOD level for a given distance.

  Parameters

  • lods: ILODLevel[]

    The array of LODs.

  • distance: number

    The squared distance from the camera to the object.

  Returns number

  The index of the LOD that should be used.

getOpacityAt

• getOpacityAt(id: number): number

  Gets the opacity of a specific instance.

  Parameters

  • id: number

    The index of the instance.

  Returns number

  The opacity of the instance.

getPositionAndMaxScaleOnAxisAt

• getPositionAndMaxScaleOnAxisAt(index: number, position: Vec3): number

  Retrieves the position and max scale of a specific instance.

  Parameters

  • index: number

    The index of the instance.

  • position: Vec3

    The position of the instance as a Vec3 to store the result.

  Returns number

  The max scale

getPositionAt

• getPositionAt(index: number, target?: Vec3): Vec3

  Retrieves the position of a specific instance.

  Parameters

  • index: number

    The index of the instance.

  • Optionaltarget: Vec3

    Optional Vec3 to store the result.

  Returns Vec3

  The position of the instance as a Vec3.

removeLOD

• removeLOD(levelIndex: number, destroyObject?: boolean): ILODLevel

  Parameters

  • levelIndex: number
  • destroyObject: boolean = true

  Returns ILODLevel

resize

• resize(newCapacity: number): void

  Parameters

  • newCapacity: number

  Returns void

setColorAt

• setColorAt(id: number, color: Color): void

  Sets the color of a specific instance.

  Parameters

  • id: number

    The index of the instance.

  • color: Color

    The color to assign to the instance.

  Returns void

setMatrixAt

• setMatrixAt(id: number, matrix: Mat4): void

  Sets the local transformation matrix for a specific instance.

  Parameters

  • id: number

    The index of the instance.

  • matrix: Mat4

    A Mat4 representing the local transformation to apply to the instance.

  Returns void

setOpacityAt

• setOpacityAt(id: number, value: number): void

  Sets the opacity of a specific instance.

  Parameters

  • id: number

    The index of the instance.

  • value: number

    The opacity value to assign.

  Returns void

updateInstanceBoundingBox

• updateInstanceBoundingBox(): void

  Returns void

updateLOD

• updateLOD(levelIndex: number, distance: number, hysteresis: number): void

  Parameters

  • levelIndex: number
  • distance: number
  • hysteresis: number

  Returns void

updateMaterials

• updateMaterials(): void

  Returns void

StaticgetInstancerById

• getInstancerById(id: number): BasicHierarchicalInstancer | undefined

  Gets the instancer with the given id.

  Parameters

  • id: number

    The id of the instancer.

  Returns BasicHierarchicalInstancer | undefined

  The instancer with the given id.