Class SimpleHierarchicalInstancer

Hierarchy (View Summary)

BasicHierarchicalInstancer
- SimpleHierarchicalInstancer
  - HierarchicalInstancer

Constructors

constructor

new SimpleHierarchicalInstancer(
device: GraphicsDevice,
params?: ISimpleHierarchicalInstancerParams,
): SimpleHierarchicalInstancer
Parameters
- device: GraphicsDevice
- params: ISimpleHierarchicalInstancerParams = {}
Returns SimpleHierarchicalInstancer
Overrides BasicHierarchicalInstancer.constructor
- Defined in Instancer/SimpleHierarchicalInstancer.ts:40

Properties

colorsTexture

colorsTexture: ColorDataTexture = ...

Texture storing colors for instances.

`Readonly`device

device: GraphicsDevice

Instanced mesh graphics device

lodFadeTime

lodFadeTime: number

Time at which the LOD disappears before switching to another LOD.

LODs

LODs: ILODLevel[] = []

LODs

matricesTexture

matricesTexture: Mat4DataTexture

Texture storing matrices for instances.

Accessors

capacity

get capacity(): number
The capacity of the instance buffers.

Returns number
Inherited from BasicHierarchicalInstancer.capacity
- Defined in Instancer/BasicHierarchicalInstancer.ts:105

id

get id(): number
Unique id for the instancer.

Returns number
Inherited from BasicHierarchicalInstancer.id
- Defined in Instancer/BasicHierarchicalInstancer.ts:85

instancesArrayCount

get instancesArrayCount(): number
The number of active instances array.

Returns number
- Defined in Instancer/SimpleHierarchicalInstancer.ts:38

instancesCount

get instancesCount(): number
The number of active instances.

Returns number
- Defined in Instancer/SimpleHierarchicalInstancer.ts:33

Methods

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
Overrides BasicHierarchicalInstancer.addLOD
- Defined in Instancer/SimpleHierarchicalInstancer.ts:67

applyMatrixAtToSphere

applyMatrixAtToSphere(
    index: number,
    sphere: BoundingSphere,
    center: Vec3,
    radius: number,
): void
Parameters
- index: number
- sphere: BoundingSphere
- center: Vec3
- radius: number
Returns void
Inherited from BasicHierarchicalInstancer.applyMatrixAtToSphere
- Defined in Instancer/BasicHierarchicalInstancer.ts:533

applySortingIfNeeded

applySortingIfNeeded(): void
Returns void
Overrides BasicHierarchicalInstancer.applySortingIfNeeded
- Defined in Instancer/SimpleHierarchicalInstancer.ts:63

computeMaxInstanceBoundingBox

computeMaxInstanceBoundingBox(src?: BoundingBox): BoundingBox
Parameters
- Optionalsrc: BoundingBox
Returns BoundingBox
Inherited from BasicHierarchicalInstancer.computeMaxInstanceBoundingBox
- Defined in Instancer/BasicHierarchicalInstancer.ts:207

destroy

destroy(): void
Destroys the instancer and all its resources.

Returns void
Inherited from BasicHierarchicalInstancer.destroy
- Defined in Instancer/BasicHierarchicalInstancer.ts:655

frustumCulling

frustumCulling(
    camera: Camera,
    cameraPosition: Vec3,
    onFrustumEnter: TOnFrustumEnter,
): void
Parameters
- camera: Camera
- cameraPosition: Vec3
- onFrustumEnter: TOnFrustumEnter
Returns void
- Defined in Instancer/SimpleHierarchicalInstancer.ts:137

getActiveAndVisibilityAt

getActiveAndVisibilityAt(id: number): boolean
Indicates if a specific instance is visible and active.
Parameters
- id: number
  The index of the instance.
Returns boolean
Whether the instance is visible and active.
- Defined in Instancer/SimpleHierarchicalInstancer.ts:133

getActiveAt

getActiveAt(id: number): boolean
Gets the availability of a specific instance.
Parameters
- id: number
  The index of the instance.
Returns boolean
Whether the instance is active (not deleted).
- Defined in Instancer/SimpleHierarchicalInstancer.ts:115

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.
Inherited from BasicHierarchicalInstancer.getColorAt
- Defined in Instancer/BasicHierarchicalInstancer.ts:557

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.
Inherited from BasicHierarchicalInstancer.getMatrixAt
- Defined in Instancer/BasicHierarchicalInstancer.ts:509

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.
Inherited from BasicHierarchicalInstancer.getObjectLODIndexForDistance
- Defined in Instancer/BasicHierarchicalInstancer.ts:643

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.
Inherited from BasicHierarchicalInstancer.getOpacityAt
- Defined in Instancer/BasicHierarchicalInstancer.ts:587

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
Inherited from BasicHierarchicalInstancer.getPositionAndMaxScaleOnAxisAt
- Defined in Instancer/BasicHierarchicalInstancer.ts:529

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.
Inherited from BasicHierarchicalInstancer.getPositionAt
- Defined in Instancer/BasicHierarchicalInstancer.ts:519

getVisibilityAt

getVisibilityAt(id: number): boolean
Gets the visibility of a specific instance.
Parameters
- id: number
  The index of the instance.
Returns boolean
Whether the instance is visible.
- Defined in Instancer/SimpleHierarchicalInstancer.ts:97

removeLOD

removeLOD(levelIndex: number, destroyObject?: boolean): ILODLevel
Parameters
- levelIndex: number
- destroyObject: boolean = true
Returns ILODLevel
Inherited from BasicHierarchicalInstancer.removeLOD
- Defined in Instancer/BasicHierarchicalInstancer.ts:259

resize

resize(newCapacity: number): void
Parameters
- newCapacity: number
Returns void
Overrides BasicHierarchicalInstancer.resize
- Defined in Instancer/SimpleHierarchicalInstancer.ts:53

setActiveAndVisibilityAt

setActiveAndVisibilityAt(id: number, value: boolean): void
Set if a specific instance is visible and active.
Parameters
- id: number
  The index of the instance.
- value: boolean
  Whether the instance is active and active (not deleted).
Returns void
- Defined in Instancer/SimpleHierarchicalInstancer.ts:124

setActiveAt

setActiveAt(id: number, active: boolean): void
Sets the availability of a specific instance.
Parameters
- id: number
  The index of the instance.
- active: boolean
  Whether the instance is active (not deleted).
Returns void
- Defined in Instancer/SimpleHierarchicalInstancer.ts:106

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
Inherited from BasicHierarchicalInstancer.setColorAt
- Defined in Instancer/BasicHierarchicalInstancer.ts:542

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
Inherited from BasicHierarchicalInstancer.setMatrixAt
- Defined in Instancer/BasicHierarchicalInstancer.ts:499

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
Inherited from BasicHierarchicalInstancer.setOpacityAt
- Defined in Instancer/BasicHierarchicalInstancer.ts:566

setVisibilityAt

setVisibilityAt(id: number, visible: boolean): void
Sets the visibility of a specific instance.
Parameters
- id: number
  The index of the instance.
- visible: boolean
  Whether the instance should be visible.
Returns void
- Defined in Instancer/SimpleHierarchicalInstancer.ts:88

update

update(
    dt: number,
    camera: Camera,
    cameraPosition: Vec3,
    onFrustumEnter?: TOnFrustumEnterThenUpdate,
): void
Parameters
- dt: number
- camera: Camera
- cameraPosition: Vec3
- OptionalonFrustumEnter: TOnFrustumEnterThenUpdate
Returns void
- Defined in Instancer/SimpleHierarchicalInstancer.ts:160

updateInstanceBoundingBox

updateInstanceBoundingBox(): void
Returns void
Inherited from BasicHierarchicalInstancer.updateInstanceBoundingBox
- Defined in Instancer/BasicHierarchicalInstancer.ts:363

updateLOD

updateLOD(levelIndex: number, distance: number, hysteresis: number): void
Parameters
- levelIndex: number
- distance: number
- hysteresis: number
Returns void
Inherited from BasicHierarchicalInstancer.updateLOD
- Defined in Instancer/BasicHierarchicalInstancer.ts:249

updateMaterials

updateMaterials(): void
Returns void
Inherited from BasicHierarchicalInstancer.updateMaterials
- Defined in Instancer/BasicHierarchicalInstancer.ts:348

`Static`getInstancerById

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.
Inherited from BasicHierarchicalInstancer.getInstancerById
- Defined in Instancer/BasicHierarchicalInstancer.ts:53

Class SimpleHierarchicalInstancer

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SimpleHierarchicalInstancer

Properties

colorsTexture

Readonlydevice

lodFadeTime

LODs

matricesTexture

Accessors

capacity

Returns number

id

Returns number

instancesArrayCount

Returns number

instancesCount

Returns number

Methods

addLOD

Parameters

Returns number

applyMatrixAtToSphere

Parameters

Returns void

applySortingIfNeeded

Returns void

computeMaxInstanceBoundingBox

Parameters

Returns BoundingBox

destroy

Returns void

frustumCulling

Parameters

Returns void

getActiveAndVisibilityAt

Parameters

Returns boolean

getActiveAt

Parameters

Returns boolean

getColorAt

Parameters

Returns Color

getMatrixAt

Parameters

Returns Mat4

getObjectLODIndexForDistance

Parameters

Returns number

getOpacityAt

Parameters

Returns number

getPositionAndMaxScaleOnAxisAt

Parameters

Returns number

getPositionAt

Parameters

Returns Vec3

getVisibilityAt

Parameters

Returns boolean

removeLOD

Parameters

Returns ILODLevel

resize

Parameters

Returns void

setActiveAndVisibilityAt

Parameters

Returns void

setActiveAt

`Readonly`device

`Static`getInstancerById