Class InstancedMeshContainer<TMaterial>

Container for proxies sharing one repeated source geometry, drawn as a single instanced mesh per material. Builds a MeshBVH over the shared geometry for raycasting.

Type Parameters

TMaterial extends InstancedMaterial = InstancedMaterial

Hierarchy

InstancedContainer<BufferGeometry, TMaterial>
- InstancedMeshContainer

Constructors

constructor

new InstancedMeshContainer<
    TMaterial extends InstancedMaterial = InstancedMaterial,
>(
    geometry: BufferGeometry,
    materialConfigs: MaterialConfig<TMaterial, number, string>[],
    instanceCount: number,
): InstancedMeshContainer<TMaterial>
Type Parameters
- TMaterial extends InstancedMaterial = InstancedMaterial
Parameters
- geometry: BufferGeometry
- materialConfigs: MaterialConfig<TMaterial, number, string>[]
- instanceCount: number
Returns InstancedMeshContainer<TMaterial>
Overrides InstancedContainer<BufferGeometry, TMaterial>.constructor
- Defined in packages/viewer/src/scene/geometry/containers/InstancedMeshContainer.ts:17

Properties

`Protected` `Readonly`_meshes

_meshes: InstancedMesh<
BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
TMaterial,
>[]

`Readonly`isMeshContainer

isMeshContainer: true

`Readonly`maxInstance

maxInstance: number

Accessors

count

get count(): number
Total number of instances in the container

Returns number
Inherited from InstancedContainer.count
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:83

geometry

get geometry(): TGeometry
Returns TGeometry
Inherited from InstancedContainer.geometry
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:66

root

get root(): Group<Object3DEventMap>
Three.js object porting the container data (e.g. BatchMesh, or InstancedMesh)

Returns Group<Object3DEventMap>
Inherited from InstancedContainer.root
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:62

visible

get visible(): boolean
Indicates the container visibility

Returns boolean
Inherited from InstancedContainer.visible
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:76
set visible(value: boolean): void
Indicates the container visibility
Parameters
- value: boolean
Returns void
Inherited from InstancedContainer.visible
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:70

visibleCount

get visibleCount(): number
Number of visible instances in the container

Returns number
Inherited from InstancedContainer.visibleCount
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:90

Methods

addInstance

addInstance(proxy: BaseProxy): BaseProxy
Parameters
- proxy: BaseProxy
Returns BaseProxy
Inherited from InstancedContainer.addInstance
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:156

clear

clear(): void
Removed all data from the container

Returns void
Inherited from InstancedContainer.clear
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:94

computeEdgeTree

computeEdgeTree(lineSegmentsProxy: BaseProxy): BoxTree<Edge>
Compute the edge box tree to raycast the edges of the sceneMeshProxies in local space
Parameters
- lineSegmentsProxy: BaseProxy
Returns BoxTree<Edge>
Parammesh
Inherited from InstancedContainer.computeEdgeTree
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:150

contains

contains(proxy: BaseProxy): boolean
Parameters
- proxy: BaseProxy
Returns boolean
Inherited from InstancedContainer.contains
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:70

dispose

dispose(): void
Returns void
Inherited from InstancedContainer.dispose
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:76

getActiveAt

getActiveAt(proxyId: number): boolean
Parameters
- proxyId: number
Returns boolean
Inherited from InstancedContainer.getActiveAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:213

getBoundingBoxAt

getBoundingBoxAt(instancedId: number, target: Box3): Box3
Parameters
- instancedId: number
- target: Box3
Returns Box3
Inherited from InstancedContainer.getBoundingBoxAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:253

getBoundingSphereAt

getBoundingSphereAt(instancedId: number, target: Sphere): Sphere
Gets the instance boundingSphere
Parameters
- instancedId: number
- target: Sphere
Returns Sphere
Inherited from InstancedContainer.getBoundingSphereAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:269

getDeepGeometryAt

getDeepGeometryAt(proxyId: number, target: BufferGeometry): BufferGeometry
Parameters
- proxyId: number
- target: BufferGeometry
Returns BufferGeometry
Inherited from InstancedContainer.getDeepGeometryAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:286

getDiffuseColorAt

getDiffuseColorAt(proxyId: number): ColorRepresentation
Parameters
- proxyId: number
Returns ColorRepresentation
Inherited from InstancedContainer.getDiffuseColorAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:299

getEdgeBoxTree

getEdgeBoxTree(lineSegmentsProxy: BaseProxy): BoxTree<Edge>
Returns the edge tree for the given lineSegmentsProxy. Computes it if not already available.
Parameters
- lineSegmentsProxy: BaseProxy
Returns BoxTree<Edge>
Inherited from InstancedContainer.getEdgeBoxTree
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:137

getEmissiveColorAt

getEmissiveColorAt(proxyId: number): ColorRepresentation
Parameters
- proxyId: number
Returns ColorRepresentation
Inherited from InstancedContainer.getEmissiveColorAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:350

getGeometryAt

getGeometryAt(proxyId: number, target: BufferGeometry): BufferGeometry
Parameters
- proxyId: number
- target: BufferGeometry
Returns BufferGeometry
Inherited from InstancedContainer.getGeometryAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:279

getGeometryBVH

getGeometryBVH(geometryUuid: string): MeshBVH | undefined
Parameters
- geometryUuid: string
Returns MeshBVH | undefined
Inherited from InstancedContainer.getGeometryBVH
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:174

getMaterialIndexAt

getMaterialIndexAt(proxyId: number): number
Parameters
- proxyId: number
Returns number
Inherited from InstancedContainer.getMaterialIndexAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:130

getMaterialIndexFromType

getMaterialIndexFromType(materialType: string): number | null
Parameters
- materialType: string
Returns number | null
Inherited from InstancedContainer.getMaterialIndexFromType
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:103

getMaterials

getMaterials(materialTypes?: MaterialType[]): Generator<TMaterial>
Returns the materials used by the container of the given types. If the array is empty, all materials are returned.
Parameters
- materialTypes: MaterialType[] = []
Returns Generator<TMaterial>
Inherited from InstancedContainer.getMaterials
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:148

getMaterialTypeAt

getMaterialTypeAt(proxyId: number): MaterialType
Parameters
- proxyId: number
Returns MaterialType
Inherited from InstancedContainer.getMaterialTypeAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:305

getMatrixAt

getMatrixAt(instancedId: number, target: Matrix4): Matrix4
Parameters
- instancedId: number
- target: Matrix4
Returns Matrix4
Inherited from InstancedContainer.getMatrixAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:247

getMetalnessAt

getMetalnessAt(proxyId: number): number
Parameters
- proxyId: number
Returns number
Inherited from InstancedContainer.getMetalnessAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:324

getOpacityAt

getOpacityAt(proxyId: number): number
Parameters
- proxyId: number
Returns number
Inherited from InstancedContainer.getOpacityAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:314

getPositionAt

getPositionAt(proxyId: number, target: Vector3): Vector3
Parameters
- proxyId: number
- target: Vector3
Returns Vector3
Inherited from InstancedContainer.getPositionAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:231

getRoughnessAt

getRoughnessAt(proxyId: number): number
Parameters
- proxyId: number
Returns number
Inherited from InstancedContainer.getRoughnessAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:337

getVisibilityAt

getVisibilityAt(proxyId: number): boolean
Parameters
- proxyId: number
Returns boolean
Inherited from InstancedContainer.getVisibilityAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:200

registerBVH

registerBVH(geometryUuid: string, bvh: MeshBVH): void
Parameters
- geometryUuid: string
- bvh: MeshBVH
Returns void
Inherited from InstancedContainer.registerBVH
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:178

removeInstance

removeInstance(proxy: BaseProxy): void
Parameters
- proxy: BaseProxy
Returns void
Inherited from InstancedContainer.removeInstance
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:185

setActiveAt

setActiveAt(proxyId: number, value: boolean): void
Parameters
- proxyId: number
- value: boolean
Returns void
Inherited from InstancedContainer.setActiveAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:206

setClippingPlanes

setClippingPlanes(planes: Plane[]): void
Parameters
- planes: Plane[]
Returns void
Inherited from InstancedContainer.setClippingPlanes
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:134

setDiffuseColorAt

setDiffuseColorAt(proxyId: number, color: ColorRepresentation): void
Parameters
- proxyId: number
- color: ColorRepresentation
Returns void
Inherited from InstancedContainer.setDiffuseColorAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:292

setEmissiveColorAt

setEmissiveColorAt(proxyId: number, value: ColorRepresentation): void
Parameters
- proxyId: number
- value: ColorRepresentation
Returns void
Inherited from InstancedContainer.setEmissiveColorAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:346

setMaterialIndexAt

setMaterialIndexAt(proxyId: number, materialIndex: number): void
Parameters
- proxyId: number
- materialIndex: number
Returns void
Inherited from InstancedContainer.setMaterialIndexAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:119

setMaterialLayer

setMaterialLayer(materialType: MaterialType, layer: number): void
Parameters
- materialType: MaterialType
- layer: number
Returns void
Inherited from InstancedContainer.setMaterialLayer
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:141

setMaterialTypeAt

setMaterialTypeAt(proxyId: number, materialType: string): void
Parameters
- proxyId: number
- materialType: string
Returns void
Inherited from InstancedContainer.setMaterialTypeAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:112

setMatrixAt

setMatrixAt(proxyId: number, matrix: Matrix4): Matrix4
Parameters
- proxyId: number
- matrix: Matrix4
Returns Matrix4
Inherited from InstancedContainer.setMatrixAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:237

setMetalnessAt

setMetalnessAt(proxyId: number, value: number): void
Parameters
- proxyId: number
- value: number
Returns void
Inherited from InstancedContainer.setMetalnessAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:320

setOpacityAt

setOpacityAt(proxyId: number, value: number): void
Parameters
- proxyId: number
- value: number
Returns void
Inherited from InstancedContainer.setOpacityAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:310

setPositionAt

setPositionAt(instanceId: number, position: Vector3): Vector3
Parameters
- instanceId: number
- position: Vector3
Returns Vector3
Inherited from InstancedContainer.setPositionAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:219

setRoughnessAt

setRoughnessAt(proxyId: number, value: number): void
Parameters
- proxyId: number
- value: number
Returns void
Inherited from InstancedContainer.setRoughnessAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:333

setVisibilityAt

setVisibilityAt(proxyId: number, value: boolean): void
Parameters
- proxyId: number
- value: boolean
Returns void
Inherited from InstancedContainer.setVisibilityAt
- Defined in packages/viewer/src/scene/geometry/containers/base/InstancedContainer.ts:196

Class InstancedMeshContainer<TMaterial>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns InstancedMeshContainer<TMaterial>

Properties

Protected Readonly_meshes

ReadonlyisMeshContainer

ReadonlymaxInstance

Accessors

count

Returns number

geometry

Returns TGeometry

root

Returns Group<Object3DEventMap>

visible

Returns boolean

Parameters

Returns void

visibleCount

Returns number

Methods

addInstance

Parameters

Returns BaseProxy

clear

Returns void

computeEdgeTree

Parameters

Returns BoxTree<Edge>

Parammesh

contains

Parameters

Returns boolean

dispose

Returns void

getActiveAt

Parameters

Returns boolean

getBoundingBoxAt

Parameters

Returns Box3

getBoundingSphereAt

Parameters

Returns Sphere

getDeepGeometryAt

Parameters

Returns BufferGeometry

getDiffuseColorAt

Parameters

Returns ColorRepresentation

getEdgeBoxTree

Parameters

Returns BoxTree<Edge>

getEmissiveColorAt

Parameters

Returns ColorRepresentation

getGeometryAt

Parameters

Returns BufferGeometry

getGeometryBVH

Parameters

Returns MeshBVH | undefined

getMaterialIndexAt

Parameters

Returns number

getMaterialIndexFromType

Parameters

Returns number | null

getMaterials

Parameters

`Protected` `Readonly`_meshes

`Readonly`isMeshContainer

`Readonly`maxInstance