Class BatchedLineContainer

Container for line-segment proxies stored in a batched BatchedLineGeometry, drawn through a MultiMaterialBatchedLine.

Hierarchy

BatchedContainer<
    BatchedLineGeometry,
    BatchedLineBasicMaterial,
    MultiMaterialBatchedLine,
>
- BatchedLineContainer

Constructors

constructor

new BatchedLineContainer(
    count: number,
    geometry: BatchedLineGeometry,
    materialConfig: MaterialConfig<BatchedLineBasicMaterial, number, string>[],
): BatchedLineContainer
Parameters
- count: number
- geometry: BatchedLineGeometry
- materialConfig: MaterialConfig<BatchedLineBasicMaterial, number, string>[]
Returns BatchedLineContainer
Overrides BatchedContainer< BatchedLineGeometry, BatchedLineBasicMaterial, MultiMaterialBatchedLine >.constructor
- Defined in packages/viewer/src/scene/geometry/containers/BatchedLineContainer.ts:18

Properties

`Protected` `Readonly`_batchObject

_batchObject: MultiMaterialBatchedLine

`Readonly`isMeshContainer

isMeshContainer: true

Accessors

count

get count(): number
Returns number
Inherited from BatchedContainer.count
- Defined in packages/viewer/src/scene/geometry/containers/base/BatchedContainer.ts:50

geometry

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

root

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

Returns Object3D<Object3DEventMap>
Inherited from BatchedContainer.root
- Defined in packages/viewer/src/scene/geometry/containers/base/BatchedContainer.ts:34

visible

get visible(): boolean
Indicates the container visibility

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

Methods

clear

clear(): void
Removed all data from the container

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

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

dispose

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

getActiveAt

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

getBoundingBoxAt

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

getBoundingSphereAt

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

getDeepGeometryAt

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

getDiffuseColorAt

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

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

getGeometryAt

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

getGeometryBVH

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

getMaterials

getMaterials(
materialTypes?: MaterialType[],
): Generator<BatchedLineBasicMaterial, any, any>
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<BatchedLineBasicMaterial, any, any>
Inherited from BatchedContainer.getMaterials
- Defined in packages/viewer/src/scene/geometry/containers/base/BatchedContainer.ts:66

getMaterialTypeAt

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

getMatrixAt

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

getMetalnessAt

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

getOpacityAt

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

getPositionAt

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

getRoughnessAt

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

getVisibilityAt

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

registerBVH

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

setActiveAt

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

setClippingPlanes

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

setDiffuseColorAt

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

setEmissiveColorAt

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

setMaterialLayer

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

setMaterialTypeAt

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

setMatrixAt

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

setMetalnessAt

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

setOpacityAt

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

setPositionAt

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

setRoughnessAt

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

setVisibilityAt

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

Class BatchedLineContainer

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BatchedLineContainer

Properties

Protected Readonly_batchObject

ReadonlyisMeshContainer

Accessors

count

Returns number

geometry

Returns TGeometry

root

Returns Object3D<Object3DEventMap>

visible

Returns boolean

Parameters

Returns void

Methods

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

getMaterials

Parameters

Returns Generator<BatchedLineBasicMaterial, any, any>

getMaterialTypeAt

Parameters

Returns MaterialType

getMatrixAt

Parameters

Returns Matrix4

getMetalnessAt

Parameters

Returns number

getOpacityAt

Parameters

Returns number

getPositionAt

`Protected` `Readonly`_batchObject

`Readonly`isMeshContainer