Class SceneMeshGroup<TMesh>

SceneMesh can contain triangles and/or lines representing the edges.

Type Parameters

TMesh extends SceneMesh = SceneMesh

Hierarchy (View Summary)

SceneMesh
- SceneMeshGroup
  - BimMesh

Constructors

constructor

new SceneMeshGroup<TMesh extends SceneMesh = SceneMesh>(
uuid?: string,
): SceneMeshGroup<TMesh>
Type Parameters
- TMesh extends SceneMesh = SceneMesh
Parameters
- uuid: string = ...
Returns SceneMeshGroup<TMesh>
Inherited from SceneMesh.constructor
- Defined in src/viewer/core/objects/SceneObject.ts:50

Properties

`Readonly`availableTransforms

availableTransforms: {
    rotation: boolean;
    scaling: boolean;
    translation: boolean;
} = ...

Indicates which gizmo controls are available for the object

`Readonly`children

children: SceneObject[] = ...

`Readonly`isDisplayable

isDisplayable: true

`Readonly`isRaycastable

isRaycastable: true

`Readonly`isSceneMesh

isSceneMesh: true

`Readonly`isSceneMeshGroup

isSceneMeshGroup: true

`Readonly`isSceneObject

isSceneObject: true

isSelectable

isSelectable: boolean = true

Indicates whether the object is selectable in the scene

`Readonly`meshes

meshes: TMesh[] = ...

name

name: string = ''

parent

parent: null | SceneObject = null

showInfoboxOnClick

showInfoboxOnClick: boolean = true

Indicates whether the object should open an infobox on click

`Readonly`signals

signals: {
onSelectedChanged: ViewerSignal<(...args: any[]) => any>;
onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
} = ...

transformable

transformable: boolean = false

Indicates whether the object can be transformed in the scene

userData

userData: Record<string, any> = {}

`Readonly`uuid

uuid: string

Unique identifier of the object

`Static` `Readonly`TRANSPARENCY_THRESHOLD

TRANSPARENCY_THRESHOLD: 0.95

Accessors

areEdgesTransparent

get areEdgesTransparent(): boolean
Returns boolean
Inherited from SceneMesh.areEdgesTransparent
- Defined in src/viewer/core/objects/mesh/SceneMesh.ts:42

diffuseColor

get diffuseColor(): ColorRepresentation
Returns ColorRepresentation
Overrides SceneMesh.diffuseColor
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:158
set diffuseColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Overrides SceneMesh.diffuseColor
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:152

edgesColor

get edgesColor(): ColorRepresentation
Returns ColorRepresentation
Overrides SceneMesh.edgesColor
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:198
set edgesColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Overrides SceneMesh.edgesColor
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:192

edgesOpacity

get edgesOpacity(): number
Returns number
Overrides SceneMesh.edgesOpacity
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:208
set edgesOpacity(value: number): void
Parameters
- value: number
Returns void
Overrides SceneMesh.edgesOpacity
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:202

emissiveColor

get emissiveColor(): ColorRepresentation
Returns ColorRepresentation
Overrides SceneMesh.emissiveColor
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:168
set emissiveColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Overrides SceneMesh.emissiveColor
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:162

hover

get hover(): boolean
Returns boolean
Inherited from SceneMesh.hover
- Defined in src/viewer/core/objects/mesh/SceneMesh.ts:52
set hover(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SceneMesh.hover
- Defined in src/viewer/core/objects/mesh/SceneMesh.ts:46

isTransparent

get isTransparent(): boolean
Returns boolean
Inherited from SceneMesh.isTransparent
- Defined in src/viewer/core/objects/mesh/SceneMesh.ts:38

metalness

get metalness(): number
Returns number
Overrides SceneMesh.metalness
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:188
set metalness(value: number): void
Parameters
- value: number
Returns void
Overrides SceneMesh.metalness
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:182

opacity

get opacity(): number
Returns number
Overrides SceneMesh.opacity
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:138
set opacity(value: number): void
Parameters
- value: number
Returns void
Overrides SceneMesh.opacity
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:132

roughness

get roughness(): number
Returns number
Overrides SceneMesh.roughness
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:178
set roughness(value: number): void
Parameters
- value: number
Returns void
Overrides SceneMesh.roughness
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:172

selected

get selected(): boolean
Returns boolean
Overrides SceneMesh.selected
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:117
set selected(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneMesh.selected
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:110

type

get type(): string
Returns string
Inherited from SceneMesh.type
- Defined in src/viewer/core/objects/SceneObject.ts:54

visible

get visible(): boolean
Returns boolean
Overrides SceneMesh.visible
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:128
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneMesh.visible
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:121

xRay

get xRay(): boolean
Returns boolean
Overrides SceneMesh.xRay
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:148
set xRay(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneMesh.xRay
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:142

Methods

addChild

addChild(child: SceneObject): void
Parameters
- child: SceneObject
Returns void
Inherited from SceneMesh.addChild
- Defined in src/viewer/core/objects/SceneObject.ts:80

addSubMesh

addSubMesh(mesh: TMesh): void
Parameters
- mesh: TMesh
Returns void
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:17

applyMatrix

applyMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Inherited from SceneMesh.applyMatrix
- Defined in src/viewer/core/objects/SceneObject.ts:74

copyMaterials

copyMaterials(src: SceneMesh): void
Copies the
Parameters
- src: SceneMesh
Returns void
Inherited from SceneMesh.copyMaterials
- Defined in src/viewer/core/objects/mesh/SceneMesh.ts:59

dispose

dispose(): void
Returns void
Inherited from SceneMesh.dispose
- Defined in src/viewer/core/objects/SceneObject.ts:168

getBoundingBox

getBoundingBox(box: Box3): Box3
Parameters
- box: Box3
Returns Box3
Overrides SceneMesh.getBoundingBox
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:73

getBoundingSphere

getBoundingSphere(sphere: Sphere): Sphere
Parameters
- sphere: Sphere
Returns Sphere
Overrides SceneMesh.getBoundingSphere
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:83

getGizmoController

getGizmoController(
viewer: Viewer,
transformGroup: TransformGroup,
): ObjectGizmoController<SceneObject>
Parameters
- viewer: Viewer
- transformGroup: TransformGroup
Returns ObjectGizmoController<SceneObject>
Inherited from SceneMesh.getGizmoController
- Defined in src/viewer/core/objects/SceneObject.ts:107

getMatrix

getMatrix(target: Matrix4): Matrix4
Parameters
- target: Matrix4
Returns Matrix4
Overrides SceneMesh.getMatrix
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:31

getPosition

getPosition(target: Vector3): Vector3
Parameters
- target: Vector3
Returns Vector3
Overrides SceneMesh.getPosition
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:47

getStateController

getStateController(): MeshGroupStateController<SceneMeshGroup<TMesh>>
Returns MeshGroupStateController<SceneMeshGroup<TMesh>>
Overrides SceneMesh.getStateController
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:93

parentsGenerator

parentsGenerator(): Generator<SceneObject, void, unknown>
Returns Generator<SceneObject, void, unknown>
Inherited from SceneMesh.parentsGenerator
- Defined in src/viewer/core/objects/SceneObject.ts:92

raycast

raycast(raycaster: Raycaster, intersections: SceneIntersection[]): void
Parameters
- raycaster: Raycaster
- intersections: SceneIntersection[]
Returns void
Overrides SceneMesh.raycast
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:212

removeFromParent

removeFromParent(): void
Returns void
Inherited from SceneMesh.removeFromParent
- Defined in src/viewer/core/objects/SceneObject.ts:100

removeSubMesh

removeSubMesh(mesh: TMesh): void
Parameters
- mesh: TMesh
Returns void
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:25

setMatrix

setMatrix(matrix: Matrix4): Matrix4
Parameters
- matrix: Matrix4
Returns Matrix4
Overrides SceneMesh.setMatrix
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:39

setPosition

setPosition(position: Vector3): void
Parameters
- position: Vector3
Returns void
Overrides SceneMesh.setPosition
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:55

showBoundingBoxHelper

showBoundingBoxHelper(helperGroup: Group, value: boolean): void
Parameters
- helperGroup: Group
- value: boolean
Returns void
Overrides SceneMesh.showBoundingBoxHelper
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:61

showNormalsHelper

showNormalsHelper(helperGroup: Group, value: boolean): void
Parameters
- helperGroup: Group
- value: boolean
Returns void
Overrides SceneMesh.showNormalsHelper
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:67

toJson

toJson(): Record<string, any>
Returns Record<string, any>
Overrides SceneMesh.toJson
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:218

Class SceneMeshGroup<TMesh>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SceneMeshGroup<TMesh>

Properties

ReadonlyavailableTransforms

Readonlychildren

ReadonlyisDisplayable

ReadonlyisRaycastable

ReadonlyisSceneMesh

ReadonlyisSceneMeshGroup

ReadonlyisSceneObject

isSelectable

Readonlymeshes

name

parent

showInfoboxOnClick

Readonlysignals

transformable

userData

Readonlyuuid

Static ReadonlyTRANSPARENCY_THRESHOLD

Accessors

areEdgesTransparent

Returns boolean

diffuseColor

Returns ColorRepresentation

Parameters

Returns void

edgesColor

Returns ColorRepresentation

Parameters

Returns void

edgesOpacity

Returns number

Parameters

Returns void

emissiveColor

Returns ColorRepresentation

Parameters

Returns void

hover

Returns boolean

Parameters

Returns void

isTransparent

Returns boolean

metalness

Returns number

Parameters

Returns void

opacity

Returns number

Parameters

Returns void

roughness

Returns number

Parameters

Returns void

selected

Returns boolean

Parameters

Returns void

type

Returns string

visible

Returns boolean

Parameters

Returns void

xRay

Returns boolean

`Readonly`availableTransforms

`Readonly`children

`Readonly`isDisplayable

`Readonly`isRaycastable

`Readonly`isSceneMesh

`Readonly`isSceneMeshGroup

`Readonly`isSceneObject

`Readonly`meshes

`Readonly`signals

`Readonly`uuid

`Static` `Readonly`TRANSPARENCY_THRESHOLD