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
  - SceneProjection

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 packages/viewer/src/scene/objects/SceneObject.ts:82

Properties

`Readonly`children

children: SceneObject[] = ...

`Readonly`isDisplayable

isDisplayable: true

isRaycastable

isRaycastable: boolean = 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

isTransformable

isTransformable: boolean = true

`Readonly`meshes

meshes: TMesh[] = ...

name

name: string = ''

parent

parent: SceneObject | null = null

`Readonly`signals

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

`Readonly`transformConfig

transformConfig: ObjectTransformConfig = ...

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 packages/viewer/src/scene/objects/mesh/SceneMesh.ts:42

diffuseColor

get diffuseColor(): ColorRepresentation
Returns ColorRepresentation
Overrides SceneMesh.diffuseColor
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:159
set diffuseColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Overrides SceneMesh.diffuseColor
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:153

edgesColor

get edgesColor(): ColorRepresentation
Returns ColorRepresentation
Overrides SceneMesh.edgesColor
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:199
set edgesColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Overrides SceneMesh.edgesColor
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:193

edgesOpacity

get edgesOpacity(): number
Returns number
Overrides SceneMesh.edgesOpacity
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:209
set edgesOpacity(value: number): void
Parameters
- value: number
Returns void
Overrides SceneMesh.edgesOpacity
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:203

emissiveColor

get emissiveColor(): ColorRepresentation
Returns ColorRepresentation
Overrides SceneMesh.emissiveColor
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:169
set emissiveColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Overrides SceneMesh.emissiveColor
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:163

hover

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

isTransparent

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

metalness

get metalness(): number
Returns number
Overrides SceneMesh.metalness
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:189
set metalness(value: number): void
Parameters
- value: number
Returns void
Overrides SceneMesh.metalness
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:183

opacity

get opacity(): number
Returns number
Overrides SceneMesh.opacity
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:139
set opacity(value: number): void
Parameters
- value: number
Returns void
Overrides SceneMesh.opacity
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:133

roughness

get roughness(): number
Returns number
Overrides SceneMesh.roughness
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:179
set roughness(value: number): void
Parameters
- value: number
Returns void
Overrides SceneMesh.roughness
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:173

selected

get selected(): boolean
Returns boolean
Overrides DrawableSceneObject.selected
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:118
set selected(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides DrawableSceneObject.selected
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:111

type

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

visible

get visible(): boolean
Returns boolean
Overrides SceneMesh.visible
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:129
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneMesh.visible
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:122

xRay

get xRay(): boolean
Returns boolean
Overrides SceneMesh.xRay
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:149
set xRay(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneMesh.xRay
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:143

Methods

addChild

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

addSubMesh

addSubMesh(mesh: TMesh): void
Parameters
- mesh: TMesh
Returns void
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:18

applyMatrix

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

copyMaterials

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

dispose

dispose(): void
Returns void
Inherited from SceneMesh.dispose
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:196

getBoundingBox

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

getBoundingSphere

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

getMatrix

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

getPosition

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

getStateController

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

parentsGenerator

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

projectPointOnEdges

projectPointOnEdges(
    point: Vector3,
    target: Vector3,
    maxEdgeDistance: number,
): boolean
Parameters
- point: Vector3
- target: Vector3
- maxEdgeDistance: number
Returns boolean
Overrides SceneMesh.projectPointOnEdges
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:219

raycast

raycast(raycaster: Raycaster, intersections: SceneIntersection[]): void
Performs raycasting on the mesh.
Parameters
- raycaster: Raycaster
  The raycaster to use
- intersections: SceneIntersection[]
  The array of resulting intersections
Returns void
Overrides SceneMesh.raycast
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:213

removeFromParent

removeFromParent(): void
Returns void
Inherited from SceneMesh.removeFromParent
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:132

removeSubMesh

removeSubMesh(mesh: TMesh): void
Parameters
- mesh: TMesh
Returns void
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:26

setMatrix

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

setPosition

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

showBoundingBoxHelper

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

showNormalsHelper

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

toJson

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

Class SceneMeshGroup<TMesh>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SceneMeshGroup<TMesh>

Properties

Readonlychildren

ReadonlyisDisplayable

isRaycastable

ReadonlyisSceneMesh

ReadonlyisSceneMeshGroup

ReadonlyisSceneObject

isSelectable

isTransformable

Readonlymeshes

name

parent

Readonlysignals

ReadonlytransformConfig

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

Parameters

`Readonly`children

`Readonly`isDisplayable

`Readonly`isSceneMesh

`Readonly`isSceneMeshGroup

`Readonly`isSceneObject

`Readonly`meshes

`Readonly`signals

`Readonly`transformConfig

`Readonly`uuid

`Static` `Readonly`TRANSPARENCY_THRESHOLD