Class SceneMeshGroup<TMesh>

A SceneMesh whose visible geometry is the union of its sub-meshes: appearance and visibility setters (diffuseColor, opacity, xRay, visible…) propagate to every mesh in meshes, and getters read from the first one. See BimMesh for the loader's use of this to hold 2D/3D representations.

Type Parameters

TMesh extends SceneMesh = SceneMesh

Hierarchy (View Summary)

SceneMesh
- SceneMeshGroup

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:98

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 SceneMeshProxy.areEdgesTransparent
- Defined in packages/viewer/src/scene/objects/mesh/SceneMesh.ts:60

diffuseColor

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

edgesColor

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

edgesOpacity

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

edgesVisible

get edgesVisible(): boolean
Returns boolean
Overrides ClippingPlane.edgesVisible
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:243
set edgesVisible(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides ClippingPlane.edgesVisible
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:236

emissiveColor

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

hover

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

isTransparent

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

materialName

get materialName(): string
Returns string
Overrides SceneMeshProxy.materialName
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:32
set materialName(value: string): void
Parameters
- value: string
Returns void
Overrides SceneMeshProxy.materialName
- Defined in packages/viewer/src/scene/objects/mesh/SceneMeshGroup.ts:28

metalness

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

opacity

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

roughness

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

selected

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

type

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

visible

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

xRay

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

Methods

addChild

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

addSubMesh

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

applyMatrix

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

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:85

dispose

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

getBoundingBox

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

getBoundingSphere

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

getMatrix

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

getPosition

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

getStateController

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

parentsGenerator

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

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:253

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:247

removeFromParent

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

removeSubMesh

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

setMatrix

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

setPosition

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

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:85

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:91

toJson

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

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

edgesVisible

Returns boolean

Parameters

Returns void

emissiveColor

Returns ColorRepresentation

Parameters

Returns void

hover

Returns boolean

Parameters

Returns void

isTransparent

Returns boolean

materialName

Returns string

Parameters

Returns void

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

`Readonly`children

`Readonly`isDisplayable

`Readonly`isSceneMesh

`Readonly`isSceneMeshGroup

`Readonly`isSceneObject

`Readonly`meshes

`Readonly`signals

`Readonly`transformConfig

`Readonly`uuid

`Static` `Readonly`TRANSPARENCY_THRESHOLD