Class BimMesh

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

Hierarchy (View Summary)

SceneMeshGroup
- BimMesh

Constructors

constructor

new BimMesh(uuid?: string): BimMesh
Parameters
- uuid: string = ...
Returns BimMesh
Inherited from SceneMeshGroup.constructor
- Defined in src/viewer/core/objects/SceneObject.ts:41

Properties

`Readonly`children

children: SceneObject[] = ...

`Readonly`isBimMesh

isBimMesh: true

`Readonly`isMovable

isMovable: boolean = false

Indicates whether the object can be transformed in the scene

`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: SceneMesh[] = ...

name

name: string = ''

parent

parent: null | SceneObject = null

`Readonly`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>;
} = ...

userData

userData: Record<string, any> = {}

`Readonly`uuid

uuid: string

Unique identifier of the object

`Static` `Readonly`TRANSPARENCY_THRESHOLD

TRANSPARENCY_THRESHOLD: 0.95

Accessors

active

get active(): boolean
Returns boolean
Overrides SceneMeshGroup.active
- Defined in src/viewer/core/objects/bimMesh/BimMesh.ts:64
set active(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneMeshGroup.active
- Defined in src/viewer/core/objects/bimMesh/BimMesh.ts:52

areEdgesTransparent

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

diffuseColor

get diffuseColor(): ColorRepresentation
Returns ColorRepresentation
Inherited from SceneMeshGroup.diffuseColor
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:150
set diffuseColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Inherited from SceneMeshGroup.diffuseColor
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:144

edgesColor

get edgesColor(): ColorRepresentation
Returns ColorRepresentation
Inherited from SceneMeshGroup.edgesColor
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:190
set edgesColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Inherited from SceneMeshGroup.edgesColor
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:184

edgesOpacity

get edgesOpacity(): number
Returns number
Inherited from SceneMeshGroup.edgesOpacity
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:200
set edgesOpacity(value: number): void
Parameters
- value: number
Returns void
Inherited from SceneMeshGroup.edgesOpacity
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:194

emissiveColor

get emissiveColor(): ColorRepresentation
Returns ColorRepresentation
Inherited from SceneMeshGroup.emissiveColor
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:160
set emissiveColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Inherited from SceneMeshGroup.emissiveColor
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:154

has2dMeshes

get has2dMeshes(): boolean
Returns boolean
- Defined in src/viewer/core/objects/bimMesh/BimMesh.ts:68

has3dMeshes

get has3dMeshes(): boolean
Returns boolean
- Defined in src/viewer/core/objects/bimMesh/BimMesh.ts:72

isTransparent

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

metalness

get metalness(): number
Returns number
Inherited from SceneMeshGroup.metalness
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:180
set metalness(value: number): void
Parameters
- value: number
Returns void
Inherited from SceneMeshGroup.metalness
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:174

opacity

get opacity(): number
Returns number
Inherited from SceneMeshGroup.opacity
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:130
set opacity(value: number): void
Parameters
- value: number
Returns void
Inherited from SceneMeshGroup.opacity
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:124

roughness

get roughness(): number
Returns number
Inherited from SceneMeshGroup.roughness
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:170
set roughness(value: number): void
Parameters
- value: number
Returns void
Inherited from SceneMeshGroup.roughness
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:164

selected

get selected(): boolean
Returns boolean
Inherited from SceneMeshGroup.selected
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:109
set selected(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SceneMeshGroup.selected
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:102

type

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

visible

get visible(): boolean
Returns boolean
Inherited from SceneMeshGroup.visible
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:120
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SceneMeshGroup.visible
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:113

xRay

get xRay(): boolean
Returns boolean
Inherited from SceneMeshGroup.xRay
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:140
set xRay(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SceneMeshGroup.xRay
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:134

Methods

addChild

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

applyMatrix

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

copyMaterials

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

dispose

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

getBoundingBox

getBoundingBox(box: Box3): Box3
Parameters
- box: Box3
Returns Box3
Inherited from SceneMeshGroup.getBoundingBox
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:68

getBoundingSphere

getBoundingSphere(sphere: Sphere): Sphere
Parameters
- sphere: Sphere
Returns Sphere
Inherited from SceneMeshGroup.getBoundingSphere
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:77

getGizmoController

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

getMatrix

getMatrix(target: Matrix4): Matrix4
Parameters
- target: Matrix4
Returns Matrix4
Inherited from SceneMeshGroup.getMatrix
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:29

getPosition

getPosition(target: Vector3): Vector3
Parameters
- target: Vector3
Returns Vector3
Inherited from SceneMeshGroup.getPosition
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:43

getStateController

getStateController(): MeshGroupStateController<BimMesh>
Returns MeshGroupStateController<BimMesh>
Inherited from SceneMeshGroup.getStateController
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:86

getSubMeshes

getSubMeshes(): Generator<SceneMesh>
Returns Generator<SceneMesh>
- Defined in src/viewer/core/objects/bimMesh/BimMesh.ts:47

parentsGenerator

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

raycast

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

removeFromParent

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

setActiveType

setActiveType(type: MeshType): void
Parameters
- type: MeshType
Returns void
- Defined in src/viewer/core/objects/bimMesh/BimMesh.ts:76

setMatrix

setMatrix(matrix: Matrix4): Matrix4
Parameters
- matrix: Matrix4
Returns Matrix4
Inherited from SceneMeshGroup.setMatrix
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:36

setPosition

setPosition(position: Vector3): void
Parameters
- position: Vector3
Returns void
Inherited from SceneMeshGroup.setPosition
- Defined in src/viewer/core/objects/mesh/SceneMeshGroup.ts:50

showBoundingBoxHelper

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

showNormalsHelper

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

toJson

toJson(): {
    activeType: MeshType;
    meshes2d: Record<string, any>[];
    meshes3d: Record<string, any>[];
}
Returns {
    activeType: MeshType;
    meshes2d: Record<string, any>[];
    meshes3d: Record<string, any>[];
}
Overrides SceneMeshGroup.toJson
- Defined in src/viewer/core/objects/bimMesh/BimMesh.ts:101

Class BimMesh

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BimMesh

Properties

Readonlychildren

ReadonlyisBimMesh

ReadonlyisMovable

ReadonlyisRaycastable

ReadonlyisSceneMesh

ReadonlyisSceneMeshGroup

ReadonlyisSceneObject

isSelectable

Readonlymeshes

name

parent

ReadonlyshowInfoboxOnClick

Readonlysignals

userData

Readonlyuuid

Static ReadonlyTRANSPARENCY_THRESHOLD

Accessors

active

Returns boolean

Parameters

Returns void

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

has2dMeshes

Returns boolean

has3dMeshes

Returns boolean

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

`Readonly`children

`Readonly`isBimMesh

`Readonly`isMovable

`Readonly`isRaycastable

`Readonly`isSceneMesh

`Readonly`isSceneMeshGroup

`Readonly`isSceneObject

`Readonly`meshes

`Readonly`showInfoboxOnClick

`Readonly`signals

`Readonly`uuid

`Static` `Readonly`TRANSPARENCY_THRESHOLD

Returns {
activeType: MeshType;
meshes2d: Record<string, any>[];
meshes3d: Record<string, any>[];
}