Class BaseContainer<TMaterial>`Abstract`

Storage layer for one draw call's worth of logical objects (batched or instanced), addressed by numeric proxyId. Owns the single Object3D root, geometry and materials that back every proxy created against it; a BaseProxy only forwards calls here.

Type Parameters

TMaterial extends Material = Material

Hierarchy (View Summary)

BaseContainer
- InstancedWideLineContainer

Constructors

constructor

new BaseContainer<
TMaterial extends
Material<MaterialEventMap> = Material<MaterialEventMap>,
>(): BaseContainer<TMaterial>
Type Parameters
- TMaterial extends Material<MaterialEventMap> = Material<MaterialEventMap>
Returns BaseContainer<TMaterial>

Properties

`Readonly`isMeshContainer

isMeshContainer: true

`Abstract`visible

visible: boolean

Indicates the container visibility

Accessors

`Abstract`count

get count(): number
Returns number
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:63

`Abstract`geometry

get geometry(): BufferGeometry
Returns BufferGeometry
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:61

`Abstract`root

get root(): Object3D
Three.js object porting the container data (e.g. BatchMesh, or InstancedMesh)

Returns Object3D
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:59

Methods

`Abstract`clear

clear(): void
Removed all data from the container

Returns void
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:83

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
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:150

contains

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

dispose

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

`Abstract`getActiveAt

getActiveAt(proxyId: number): boolean
Parameters
- proxyId: number
Returns boolean
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:102

`Abstract`getBoundingBoxAt

getBoundingBoxAt(proxyId: number, target: Box3): Box3
Parameters
- proxyId: number
- target: Box3
Returns Box3
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:113

`Abstract`getBoundingSphereAt

getBoundingSphereAt(proxyId: number, target: Sphere): Sphere
Parameters
- proxyId: number
- target: Sphere
Returns Sphere
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:114

`Abstract`getDeepGeometryAt

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

`Abstract`getDiffuseColorAt

getDiffuseColorAt(proxyId: number): ColorRepresentation
Parameters
- proxyId: number
Returns ColorRepresentation
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:120

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>
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:137

`Abstract`getEmissiveColorAt

getEmissiveColorAt(proxyId: number): ColorRepresentation
Parameters
- proxyId: number
Returns ColorRepresentation
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:129

`Abstract`getGeometryAt

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

getGeometryBVH

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

`Abstract`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
- OptionalmaterialTypes: MaterialType[]
Returns Generator<TMaterial>
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:90

`Abstract`getMaterialTypeAt

getMaterialTypeAt(proxyId: number): MaterialType
Parameters
- proxyId: number
Returns MaterialType
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:98

`Abstract`getMatrixAt

getMatrixAt(proxyId: number, target: Matrix4): Matrix4
Parameters
- proxyId: number
- target: Matrix4
Returns Matrix4
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:111

`Abstract`getMetalnessAt

getMetalnessAt(proxyId: number): number
Parameters
- proxyId: number
Returns number
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:123

`Abstract`getOpacityAt

getOpacityAt(proxyId: number): number
Parameters
- proxyId: number
Returns number
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:117

`Abstract`getPositionAt

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

`Abstract`getRoughnessAt

getRoughnessAt(proxyId: number): number
Parameters
- proxyId: number
Returns number
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:126

`Abstract`getVisibilityAt

getVisibilityAt(proxyId: number): boolean
Parameters
- proxyId: number
Returns boolean
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:105

registerBVH

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

`Abstract`setActiveAt

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

`Abstract`setClippingPlanes

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

`Abstract`setDiffuseColorAt

setDiffuseColorAt(proxyId: number, value: ColorRepresentation): void
Parameters
- proxyId: number
- value: ColorRepresentation
Returns void
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:119

`Abstract`setEmissiveColorAt

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

`Abstract`setMaterialLayer

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

`Abstract`setMaterialTypeAt

setMaterialTypeAt(proxyId: number, value: MaterialType): void
Parameters
- proxyId: number
- value: MaterialType
Returns void
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:99

`Abstract`setMatrixAt

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

`Abstract`setMetalnessAt

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

`Abstract`setOpacityAt

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

`Abstract`setPositionAt

setPositionAt(proxyId: number, position: Vector3): Vector3
Parameters
- proxyId: number
- position: Vector3
Returns Vector3
- Defined in packages/viewer/src/scene/geometry/containers/base/BaseContainer.ts:107

`Abstract`setRoughnessAt

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

`Abstract`setVisibilityAt

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

Class BaseContainer<TMaterial>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns BaseContainer<TMaterial>

Properties

ReadonlyisMeshContainer

Abstractvisible

Accessors

Abstractcount

Returns number

Abstractgeometry

Returns BufferGeometry

Abstractroot

Returns Object3D

Methods

Abstractclear

Returns void

computeEdgeTree

Parameters

Returns BoxTree<Edge>

Parammesh

contains

Parameters

Returns boolean

dispose

Returns void

AbstractgetActiveAt

Parameters

Returns boolean

AbstractgetBoundingBoxAt

Parameters

Returns Box3

AbstractgetBoundingSphereAt

Parameters

Returns Sphere

AbstractgetDeepGeometryAt

Parameters

Returns BufferGeometry

AbstractgetDiffuseColorAt

Parameters

Returns ColorRepresentation

getEdgeBoxTree

Parameters

Returns BoxTree<Edge>

AbstractgetEmissiveColorAt

Parameters

Returns ColorRepresentation

AbstractgetGeometryAt

Parameters

Returns BufferGeometry

getGeometryBVH

Parameters

Returns MeshBVH | undefined

AbstractgetMaterials

Parameters

Returns Generator<TMaterial>

AbstractgetMaterialTypeAt

Parameters

Returns MaterialType

AbstractgetMatrixAt

Parameters

Returns Matrix4

AbstractgetMetalnessAt

Parameters

Returns number

AbstractgetOpacityAt

Parameters

Returns number

AbstractgetPositionAt

Parameters

Returns Vector3

AbstractgetRoughnessAt

Class BaseContainer<TMaterial>`Abstract`

`Readonly`isMeshContainer

`Abstract`visible

`Abstract`count

`Abstract`geometry

`Abstract`root

`Abstract`clear

`Abstract`getActiveAt

`Abstract`getBoundingBoxAt

`Abstract`getBoundingSphereAt

`Abstract`getDeepGeometryAt

`Abstract`getDiffuseColorAt

`Abstract`getEmissiveColorAt

`Abstract`getGeometryAt

`Abstract`getMaterials

`Abstract`getMaterialTypeAt

`Abstract`getMatrixAt

`Abstract`getMetalnessAt

`Abstract`getOpacityAt

`Abstract`getPositionAt

`Abstract`getRoughnessAt

`Abstract`getVisibilityAt

`Abstract`setActiveAt

`Abstract`setClippingPlanes

`Abstract`setDiffuseColorAt

`Abstract`setEmissiveColorAt

`Abstract`setMaterialLayer

`Abstract`setMaterialTypeAt

`Abstract`setMatrixAt

`Abstract`setMetalnessAt

`Abstract`setOpacityAt

`Abstract`setPositionAt

`Abstract`setRoughnessAt

`Abstract`setVisibilityAt