Class MultiMaterialBatchedLine

Hierarchy (View Summary)

MultiMaterialBatchedObject<
    BatchedLineGeometry,
    BatchedLineBasicMaterial,
    BatchedLine,
>
- MultiMaterialBatchedLine

Constructors

constructor

new MultiMaterialBatchedLine(
    count: number,
    geometry: BatchedLineGeometry,
    materialConfigs: MaterialConfig<BatchedLineBasicMaterial>[],
): MultiMaterialBatchedLine
Parameters
- count: number
- geometry: BatchedLineGeometry
- materialConfigs: MaterialConfig<BatchedLineBasicMaterial>[]
Returns MultiMaterialBatchedLine
Inherited from MultiMaterialBatchedObject.constructor
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:52

Properties

`Readonly`geometry

geometry: BatchedLineGeometry

`Readonly`isMultiMaterialBatchedObject

isMultiMaterialBatchedObject: true

Accessors

batchedObjects

get batchedObjects(): readonly TObject[]
Returns readonly TObject[]
Inherited from MultiMaterialBatchedObject.batchedObjects
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:104

count

get count(): number
Returns number
Inherited from MultiMaterialBatchedObject.count
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:100

Methods

dispose

dispose(): void
Returns void
Inherited from MultiMaterialBatchedObject.dispose
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:245

getActiveAt

getActiveAt(batchId: number): boolean
Parameters
- batchId: number
Returns boolean
Inherited from MultiMaterialBatchedObject.getActiveAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:183

getDiffuseColorAt

getDiffuseColorAt(batchId: number): ColorRepresentation
Parameters
- batchId: number
Returns ColorRepresentation
Inherited from MultiMaterialBatchedObject.getDiffuseColorAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:201

getEmissiveColorAt

getEmissiveColorAt(batchId: number): ColorRepresentation
Parameters
- batchId: number
Returns ColorRepresentation
Inherited from MultiMaterialBatchedObject.getEmissiveColorAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:211

getMaterialIndexAt

getMaterialIndexAt(batchId: number): number
Parameters
- batchId: number
Returns number
Inherited from MultiMaterialBatchedObject.getMaterialIndexAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:158

getMaterialIndexFromType

getMaterialIndexFromType(materialType: string): null | number
Parameters
- materialType: string
Returns null | number
Inherited from MultiMaterialBatchedObject.getMaterialIndexFromType
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:115

getMaterials

getMaterials(materialTypes?: string[]): Generator<BatchedLineBasicMaterial>
Returns a generator of materials used
Parameters
- materialTypes: string[] = []
Returns Generator<BatchedLineBasicMaterial>
Inherited from MultiMaterialBatchedObject.getMaterials
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:92

getMaterialTypeAt

getMaterialTypeAt(batchId: number): string
Parameters
- batchId: number
Returns string
Inherited from MultiMaterialBatchedObject.getMaterialTypeAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:138

getMetalnessAt

getMetalnessAt(batchId: number): number
Parameters
- batchId: number
Returns number
Inherited from MultiMaterialBatchedObject.getMetalnessAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:231

getOpacityAt

getOpacityAt(batchId: number): number
Parameters
- batchId: number
Returns number
Inherited from MultiMaterialBatchedObject.getOpacityAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:221

getRoughnessAt

getRoughnessAt(batchId: number): number
Parameters
- batchId: number
Returns number
Inherited from MultiMaterialBatchedObject.getRoughnessAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:241

getVisibleAt

getVisibleAt(batchId: number): boolean
Parameters
- batchId: number
Returns boolean
Inherited from MultiMaterialBatchedObject.getVisibleAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:171

newBatchedObject

newBatchedObject(
geometry: BatchedLineGeometry,
material: BatchedLineBasicMaterial,
): BatchedLine
Parameters
- geometry: BatchedLineGeometry
- material: BatchedLineBasicMaterial
Returns BatchedLine
Overrides MultiMaterialBatchedObject.newBatchedObject
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialBatchedLine.ts:11

removeBypassMaterial

removeBypassMaterial(): void
Returns void
Inherited from MultiMaterialBatchedObject.removeBypassMaterial
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:266

setActiveAt

setActiveAt(batchId: number, active: boolean): void
Parameters
- batchId: number
- active: boolean
Returns void
Inherited from MultiMaterialBatchedObject.setActiveAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:177

setAllDiffuseColor

setAllDiffuseColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Inherited from MultiMaterialBatchedObject.setAllDiffuseColor
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:195

setBypassMaterial

setBypassMaterial(materialType: string): void
Parameters
- materialType: string
Returns void
Inherited from MultiMaterialBatchedObject.setBypassMaterial
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:249

setClippingPlanes

setClippingPlanes(planes: Plane[]): void
Parameters
- planes: Plane[]
Returns void
Inherited from MultiMaterialBatchedObject.setClippingPlanes
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:124

setDiffuseColorAt

setDiffuseColorAt(batchId: number, color: ColorRepresentation): void
Parameters
- batchId: number
- color: ColorRepresentation
Returns void
Inherited from MultiMaterialBatchedObject.setDiffuseColorAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:189

setEmissiveColorAt

setEmissiveColorAt(batchId: number, color: ColorRepresentation): void
Parameters
- batchId: number
- color: ColorRepresentation
Returns void
Inherited from MultiMaterialBatchedObject.setEmissiveColorAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:205

setMaterialIndexAt

setMaterialIndexAt(batchId: number, materialIndex: number): void
Parameters
- batchId: number
- materialIndex: number
Returns void
Inherited from MultiMaterialBatchedObject.setMaterialIndexAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:145

setMaterialLayer

setMaterialLayer(materialType: string, layer: number): void
Parameters
- materialType: string
- layer: number
Returns void
Inherited from MultiMaterialBatchedObject.setMaterialLayer
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:108

setMaterialTypeAt

setMaterialTypeAt(batchId: number, materialType: string): void
Parameters
- batchId: number
- materialType: string
Returns void
Inherited from MultiMaterialBatchedObject.setMaterialTypeAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:131

setMetalnessAt

setMetalnessAt(batchId: number, metalness: number): void
Parameters
- batchId: number
- metalness: number
Returns void
Inherited from MultiMaterialBatchedObject.setMetalnessAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:225

setOpacityAt

setOpacityAt(batchId: number, opacity: number): void
Parameters
- batchId: number
- opacity: number
Returns void
Inherited from MultiMaterialBatchedObject.setOpacityAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:215

setRoughnessAt

setRoughnessAt(batchId: number, roughness: number): void
Parameters
- batchId: number
- roughness: number
Returns void
Inherited from MultiMaterialBatchedObject.setRoughnessAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:235

setVisibleAt

setVisibleAt(batchId: number, visible: boolean): void
Parameters
- batchId: number
- visible: boolean
Returns void
Inherited from MultiMaterialBatchedObject.setVisibleAt
- Defined in src/viewer/core/objects/batching/multiMaterial/MultiMaterialObject.ts:166

Class MultiMaterialBatchedLine

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MultiMaterialBatchedLine

Properties

Readonlygeometry

ReadonlyisMultiMaterialBatchedObject

Accessors

batchedObjects

Returns readonly TObject[]

count

Returns number

Methods

dispose

Returns void

getActiveAt

Parameters

Returns boolean

getDiffuseColorAt

Parameters

Returns ColorRepresentation

getEmissiveColorAt

Parameters

Returns ColorRepresentation

getMaterialIndexAt

Parameters

Returns number

getMaterialIndexFromType

Parameters

Returns null | number

getMaterials

Parameters

Returns Generator<BatchedLineBasicMaterial>

getMaterialTypeAt

Parameters

Returns string

getMetalnessAt

Parameters

Returns number

getOpacityAt

Parameters

Returns number

getRoughnessAt

Parameters

Returns number

getVisibleAt

Parameters

Returns boolean

newBatchedObject

Parameters

Returns BatchedLine

removeBypassMaterial

Returns void

setActiveAt

Parameters

Returns void

setAllDiffuseColor

Parameters

Returns void

setBypassMaterial

Parameters

Returns void

setClippingPlanes

Parameters

Returns void

setDiffuseColorAt

Parameters

Returns void

setEmissiveColorAt

Parameters

Returns void

setMaterialIndexAt

Parameters

`Readonly`geometry

`Readonly`isMultiMaterialBatchedObject