Class SceneFloorPlan

Represents one floor plan with its different layers

Hierarchy (View Summary)

SceneMeshGroup<SceneFloorPlanLayer>
- SceneFloorPlan

Constructors

constructor

new SceneFloorPlan(id: number): SceneFloorPlan
Parameters
- id: number
Returns SceneFloorPlan
Overrides SceneMeshGroup.constructor
- Defined in plugins/src/FloorPlanPlugin/core/SceneFloorPlan.ts:20

Properties

`Readonly`children

children: SceneObject[] = ...

`Readonly`id

id: number

`Readonly`isDisplayable

isDisplayable: true

isRaycastable

isRaycastable: boolean = true

isSceneFloorPlan

isSceneFloorPlan: 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: SceneFloorPlanLayer[] = ...

name

name: string = ''

parent

parent: SceneObject | null = null

`Readonly`signals

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

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

diffuseColor

get diffuseColor(): ColorRepresentation
Returns ColorRepresentation
Inherited from SceneProjection.diffuseColor
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:173
set diffuseColor(color: ColorRepresentation): void
Parameters
- color: ColorRepresentation
Returns void
Inherited from SceneProjection.diffuseColor
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:167

edgesColor

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

edgesOpacity

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

emissiveColor

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

hover

get hover(): boolean
Returns boolean
Inherited from SceneMeshGroup.hover
- Defined in viewer/src/scene/objects/mesh/SceneMesh.ts:53
set hover(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SceneMeshGroup.hover
- Defined in viewer/src/scene/objects/mesh/SceneMesh.ts:47

isTransparent

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

materialName

get materialName(): string
Returns string
Inherited from SceneMeshGroup.materialName
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:24
set materialName(value: string): void
Parameters
- value: string
Returns void
Inherited from SceneMeshGroup.materialName
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:20

metalness

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

opacity

get opacity(): number
Returns number
Overrides SceneMeshGroup.opacity
- Defined in plugins/src/FloorPlanPlugin/core/SceneFloorPlan.ts:25
set opacity(opacity: number): void
Parameters
- opacity: number
Returns void
Overrides SceneMeshGroup.opacity
- Defined in plugins/src/FloorPlanPlugin/core/SceneFloorPlan.ts:29

roughness

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

selected

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

type

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

visible

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

xRay

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

Methods

addChild

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

addSubMesh

addSubMesh(mesh: SceneFloorPlanLayer): void
Parameters
- mesh: SceneFloorPlanLayer
Returns void
Inherited from SceneMeshGroup.addSubMesh
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:32

applyMatrix

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

copyMaterials

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

dispose

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

getBoundingBox

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

getBoundingSphere

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

getInitialMatrix

getInitialMatrix(matrix: Matrix4): Matrix4
Parameters
- matrix: Matrix4
Returns Matrix4
- Defined in plugins/src/FloorPlanPlugin/core/SceneFloorPlan.ts:33

getMatrix

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

getPosition

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

getStateController

getStateController(): MeshGroupStateController<SceneFloorPlan>
Returns MeshGroupStateController<SceneFloorPlan>
Inherited from SceneMeshGroup.getStateController
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:108

parentsGenerator

parentsGenerator(): Generator<SceneObject, void, unknown>
Returns Generator<SceneObject, void, unknown>
Inherited from SceneMeshGroup.parentsGenerator
- Defined in 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
Inherited from SceneMeshGroup.projectPointOnEdges
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:233

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 SceneMeshGroup.raycast
- Defined in plugins/src/FloorPlanPlugin/core/SceneFloorPlan.ts:37

removeFromParent

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

removeSubMesh

removeSubMesh(mesh: SceneFloorPlanLayer): void
Parameters
- mesh: SceneFloorPlanLayer
Returns void
Inherited from SceneMeshGroup.removeSubMesh
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:40

setMatrix

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

setPosition

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

showBoundingBoxHelper

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

showNormalsHelper

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

toJson

toJson(): Record<string, any>
Returns Record<string, any>
Inherited from SceneMeshGroup.toJson
- Defined in viewer/src/scene/objects/mesh/SceneMeshGroup.ts:250

Class SceneFloorPlan

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SceneFloorPlan

Properties

Readonlychildren

Readonlyid

ReadonlyisDisplayable

isRaycastable

isSceneFloorPlan

ReadonlyisSceneMesh

ReadonlyisSceneMeshGroup

ReadonlyisSceneObject

isSelectable

isTransformable

Readonlymeshes

name

parent

Readonlysignals

transformConfig

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

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

Returns string

visible

Returns boolean

Parameters

`Readonly`children

`Readonly`id

`Readonly`isDisplayable

`Readonly`isSceneMesh

`Readonly`isSceneMeshGroup

`Readonly`isSceneObject

`Readonly`meshes

`Readonly`signals

`Readonly`uuid

`Static` `Readonly`TRANSPARENCY_THRESHOLD