Documentation

# Class: default

planner-core/src/roomle-planner..default

# Hierarchy

# Implements

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

• new default(creator, offset, plannerCallback, mode)

# Parameters

Name Type
creator string
offset CanvasOffset
plannerCallback RoomlePlannerCallback
mode Enumify<{ CAMERA_2D: "2D" = '2D'; CAMERA_3D: "3D" = '3D'; CAMERA_FP: "FP" = 'FP' }>

# Overrides

default.constructor

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:243 (opens new window)

# Properties

# _creator_

• _creator_: string

# Inherited from

default.creator

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:101 (opens new window)

# currentSelection

• currentSelection: SelectionPayload = null

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:229 (opens new window)

# Methods

# _preparePerspectiveImage

▸ _preparePerspectiveImage(options?): Promise<Base64Image>

# Parameters

Name Type
options PrepareImageOptionsPlanner

# Returns

Promise<Base64Image>

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1921 (opens new window)

# addComponentHandlers

▸ addComponentHandlers(component): void

# Parameters

Name Type
component RoomleComponent

# Returns

void

# Inherited from

default.addComponentHandlers

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1473 (opens new window)

# addEventListener

▸ addEventListener(_listener): void

# Parameters

Name Type
_listener LifeCycleCallbacks

# Returns

void

# Inherited from

default.addEventListener

# Defined in

packages/common-core/src/webgl/scene-manager.ts:185 (opens new window)

# addMesh

▸ addMesh(_planElement, _material, _vertices, _indices, _uvCoords, _normals): void

# Parameters

Name Type
_planElement PlanElement
_material any
_vertices Int32Array
_indices Int32Array
_uvCoords Float32Array
_normals Float32Array

# Returns

void

# Implementation of

PlannerKernelCallbackI.addMesh

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1752 (opens new window)

# addPlanMesh

▸ addPlanMesh(_plan, _material, _vertices, _indices, _uvCoords, _normals, _type): void

# Parameters

Name Type
_plan Plan
_material any
_vertices Int32Array
_indices Int32Array
_uvCoords Float32Array
_normals Float32Array
_type KernelEnum

# Returns

void

# Implementation of

PlannerKernelCallbackI.addPlanMesh

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1121 (opens new window)

# addPlanObjectToScene

▸ addPlanObjectToScene(planViewModel): Promise<void>

# Parameters

Name Type
planViewModel default

# Returns

Promise<void>

# Implementation of

PlannerKernelCallbackI.addPlanObjectToScene

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1146 (opens new window)

# addPreviewHandlers

▸ addPreviewHandlers(previewComponent): void

# Parameters

Name Type
previewComponent PreviewComponent

# Returns

void

# Inherited from

default.addPreviewHandlers

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1477 (opens new window)

# addPreviewLineHandlers

▸ addPreviewLineHandlers(previewLineComponent): void

# Parameters

Name Type
previewLineComponent PreviewLineComponent

# Returns

void

# Inherited from

default.addPreviewLineHandlers

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1481 (opens new window)

# backToPlanner

▸ backToPlanner(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:909 (opens new window)

# beginPlanConstruction

▸ beginPlanConstruction(_plan): void

# Parameters

Name Type
_plan Plan

# Returns

void

# Implementation of

PlannerKernelCallbackI.beginPlanConstruction

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1117 (opens new window)

# cameraBehaviourChanged

▸ cameraBehaviourChanged(): void

# Returns

void

# Overrides

default.cameraBehaviourChanged

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1561 (opens new window)

# cancelComponentSelection

▸ cancelComponentSelection(resetCamera?): void

# Parameters

Name Type
resetCamera? boolean

# Returns

void

# Inherited from

default.cancelComponentSelection

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1049 (opens new window)

# cancelDockings

▸ cancelDockings(): void

# Returns

void

# Inherited from

default.cancelDockings

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:400 (opens new window)

# cancelPlanElementSelection

▸ cancelPlanElementSelection(reason): void

# Parameters

Name Type
reason CancelSelectionReasons

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1789 (opens new window)

# cancelPreviousDockings

▸ cancelPreviousDockings(): void

# Returns

void

# Inherited from

default.cancelPreviousDockings

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1043 (opens new window)

# changeEnvironmentMapIntensity

▸ changeEnvironmentMapIntensity(intensity): void

# Parameters

Name Type
intensity number

# Returns

void

# Inherited from

default.changeEnvironmentMapIntensity

# Defined in

packages/common-core/src/webgl/scene-manager.ts:1099 (opens new window)

# changeExteriorWallsMaterial

▸ changeExteriorWallsMaterial(material): void

# Parameters

Name Type
material BatchPaintMaterial

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2753 (opens new window)

# changeFloorMaterial

▸ changeFloorMaterial(material): Promise<void>

# Parameters

Name Type
material RapiMaterial

# Returns

Promise<void>

# Inherited from

default.changeFloorMaterial

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1135 (opens new window)

# changeFloorsMaterial

▸ changeFloorsMaterial(material): void

# Parameters

Name Type
material BatchPaintMaterial

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2760 (opens new window)

# changeInteriorWallsMaterial

▸ changeInteriorWallsMaterial(material): void

# Parameters

Name Type
material BatchPaintMaterial

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2746 (opens new window)

# changeOffset

▸ changeOffset(offset): void

# Parameters

Name Type
offset CanvasOffset

# Returns

void

# Inherited from

default.changeOffset

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:955 (opens new window)

# cleanUp

▸ cleanUp(): void

# Returns

void

# Inherited from

default.cleanUp

# Defined in

packages/common-core/src/webgl/scene-manager.ts:580 (opens new window)

# clearScene

▸ clearScene(): void

# Returns

void

# Overrides

default.clearScene

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1294 (opens new window)

# componentDeleted

▸ componentDeleted(component): void

# Parameters

Name Type
component RoomleComponent

# Returns

void

# Inherited from

default.componentDeleted

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1403 (opens new window)

# componentUpdated

▸ componentUpdated(component, _kernelComponent): void

# Parameters

Name Type
component RoomleComponent
_kernelComponent KernelComponent

# Returns

void

# Inherited from

default.componentUpdated

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1348 (opens new window)

# configurationLoaded

▸ configurationLoaded(component, isFreeFlying): void

# Parameters

Name Type
component RoomleComponent
isFreeFlying boolean

# Returns

void

# Inherited from

default.configurationLoaded

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1452 (opens new window)

# debugScene

▸ debugScene(): Scene

# Returns

Scene

# Inherited from

default.debugScene

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:612 (opens new window)

# debugSceneGraph

▸ debugSceneGraph(id?): void

# Parameters

Name Type
id? number

# Returns

void

# Inherited from

default.debugSceneGraph

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:607 (opens new window)

# deletePlanElementByIds

▸ deletePlanElementByIds(runtimeIds): Promise<void>

# Parameters

Name Type
runtimeIds number[]

# Returns

Promise<void>

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1805 (opens new window)

# deletePlanElementSelection

▸ deletePlanElementSelection(): Promise<void>

# Returns

Promise<void>

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1795 (opens new window)

# destroy

▸ destroy(): void

# Returns

void

# Overrides

default.destroy

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1730 (opens new window)

# disableConfiguratorEvents

▸ disableConfiguratorEvents(): void

# Returns

void

# Inherited from

default.disableConfiguratorEvents

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:366 (opens new window)

# disableMeasurementLineDrawing

▸ disableMeasurementLineDrawing(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2857 (opens new window)

# disablePlannerEvents

▸ disablePlannerEvents(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2031 (opens new window)

# disableRotation

▸ disableRotation(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2011 (opens new window)

# disableSnapping

▸ disableSnapping(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2019 (opens new window)

# disableWallDrawing

▸ disableWallDrawing(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2600 (opens new window)

# display

▸ display(component): void

# Parameters

Name Type
component RoomleComponent

# Returns

void

# Inherited from

default.display

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:597 (opens new window)

# dragIn

▸ dragIn(dragEvent): void

# Parameters

Name Type
dragEvent DragEvent

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2023 (opens new window)

# enableConfiguratorEvents

▸ enableConfiguratorEvents(): void

# Returns

void

# Inherited from

default.enableConfiguratorEvents

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:362 (opens new window)

# enableDragIn

▸ enableDragIn(dragEvent): void

# Parameters

Name Type
dragEvent DragEvent

# Returns

void

# Inherited from

default.enableDragIn

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:890 (opens new window)

# enableHD

▸ enableHD(source?): void

# Parameters

Name Type
source? DynamicLightSettingSource

# Returns

void

# Inherited from

default.enableHD

# Defined in

packages/common-core/src/webgl/scene-manager.ts:609 (opens new window)

# enableMeasurementLineDrawing

▸ enableMeasurementLineDrawing(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2852 (opens new window)

# enablePlannerEvents

▸ enablePlannerEvents(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2035 (opens new window)

# enableRotation

▸ enableRotation(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2007 (opens new window)

# enableSnapping

▸ enableSnapping(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2015 (opens new window)

# enableWallDrawing

▸ enableWallDrawing(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2582 (opens new window)

# endPlanConstruction

▸ endPlanConstruction(_plan): void

# Parameters

Name Type
_plan Plan

# Returns

void

# Implementation of

PlannerKernelCallbackI.endPlanConstruction

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1133 (opens new window)

# escapeDrawing

▸ escapeDrawing(cancelDrawing): void

# Parameters

Name Type
cancelDrawing boolean

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2606 (opens new window)

# exportGLB

▸ exportGLB(_exportObjects?, _id?): void

# Parameters

Name Type
_exportObjects? Object3D<Object3DEventMap>[]
_id? string

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1253 (opens new window)

# exportImageFromCamera

▸ exportImageFromCamera(filename, shouldWaitForAssets?): Promise<void>

# Parameters

Name Type Default value
filename string undefined
shouldWaitForAssets boolean false

# Returns

Promise<void>

# Inherited from

default.exportImageFromCamera

# Defined in

packages/common-core/src/webgl/scene-manager.ts:1057 (opens new window)

# getBounds

▸ getBounds(): Box3

# Returns

Box3

# Overrides

default.getBounds

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1767 (opens new window)

# getCameraOffset

▸ getCameraOffset(): CanvasOffset

# Returns

CanvasOffset

# Inherited from

default.getCameraOffset

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:987 (opens new window)

# getComponent

▸ getComponent(componentRuntimeId): KernelComponent

# Parameters

Name Type
componentRuntimeId number

# Returns

KernelComponent

# Inherited from

default.getComponent

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1712 (opens new window)

# getGeometryBounds

▸ getGeometryBounds(): Box3

# Returns

Box3

# Overrides

default.getGeometryBounds

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1774 (opens new window)

# getOrthographicOffsetCamera

▸ getOrthographicOffsetCamera(): OrthographicOffsetCamera

# Returns

OrthographicOffsetCamera

# Inherited from

default.getOrthographicOffsetCamera

# Defined in

packages/common-core/src/webgl/scene-manager.ts:989 (opens new window)

# getPlanObject

▸ getPlanObject(id): KernelPlanObject

# Parameters

Name Type
id number

# Returns

KernelPlanObject

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1781 (opens new window)

# getPlannerSceneEventHandler

▸ getPlannerSceneEventHandler(): default

# Returns

default

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2027 (opens new window)

# getScene

▸ getScene(): Scene

# Returns

Scene

# Inherited from

default.getScene

# Defined in

packages/common-core/src/webgl/scene-manager.ts:936 (opens new window)

# getScreenXY

▸ getScreenXY(position): Vector3

# Parameters

Name Type
position Vector3

# Returns

Vector3

# Inherited from

default.getScreenXY

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1122 (opens new window)

# getWallAngleDegrees

▸ getWallAngleDegrees(wall): number

# Parameters

Name Type
wall default

# Returns

number

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2787 (opens new window)

# handleEvent

▸ handleEvent(evt): void

# Parameters

Name Type
evt Event

# Returns

void

# Inherited from

default.handleEvent

# Defined in

packages/common-core/src/webgl/scene-manager.ts:791 (opens new window)

# handlerSwitchedPlans

▸ handlerSwitchedPlans(fromPlan, toPlan): void

# Parameters

Name Type
fromPlan Plan
toPlan Plan

# Returns

void

# Implementation of

PlannerKernelCallbackI.handlerSwitchedPlans

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1049 (opens new window)

# hideDimensions

▸ hideDimensions(): void

# Returns

void

# Inherited from

default.hideDimensions

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1208 (opens new window)

# highlightParts

▸ highlightParts(ids): void

# Parameters

Name Type
ids number[]

# Returns

void

# Inherited from

default.highlightParts

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1584 (opens new window)

# importGLB

▸ importGLB(url): void

# Parameters

Name Type
url string

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1290 (opens new window)

# loadDynamicLightSetting

▸ loadDynamicLightSetting(source): Promise<void>

# Parameters

Name Type
source DynamicLightSettingSource

# Returns

Promise<void>

# Inherited from

default.loadDynamicLightSetting

# Defined in

packages/common-core/src/webgl/scene-manager.ts:897 (opens new window)

# loadEnvMap

▸ loadEnvMap(url): Promise<void>

# Parameters

Name Type
url string

# Returns

Promise<void>

# Inherited from

default.loadEnvMap

# Defined in

packages/common-core/src/webgl/scene-manager.ts:498 (opens new window)

# loadSceneSettings

▸ loadSceneSettings(sceneSetting): Promise<void>

# Parameters

Name Type
sceneSetting SceneSettings

# Returns

Promise<void>

# Inherited from

default.loadSceneSettings

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1221 (opens new window)

# loadStaticPlanObjects

▸ loadStaticPlanObjects(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:971 (opens new window)

# lockCamera

▸ lockCamera(): void

# Returns

void

# Inherited from

default.lockCamera

# Defined in

packages/common-core/src/webgl/scene-manager.ts:1103 (opens new window)

# moveCamera

▸ moveCamera(cameraParameter): Promise<void>

# Parameters

Name Type
cameraParameter CameraParameter

# Returns

Promise<void>

# Overrides

default.moveCamera

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2662 (opens new window)

# moveElementPosition

▸ moveElementPosition(selectedElement, position): void

# Parameters

Name Type
selectedElement default
position KernelVector3

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2807 (opens new window)

# moveElementsPosition

▸ moveElementsPosition(selectedElements, position): void

# Parameters

Name Type
selectedElements default[]
position KernelVector3

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2824 (opens new window)

# pause

▸ pause(): void

# Returns

void

# Inherited from

default.pause

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:516 (opens new window)

# planBoundsChanged

▸ planBoundsChanged(): void

# Returns

void

# Implementation of

PlannerKernelCallbackI.planBoundsChanged

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1853 (opens new window)

# planCleared

▸ planCleared(): void

# Returns

void

# Implementation of

PlannerKernelCallbackI.planCleared

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:501 (opens new window)

# planCompletelyLoaded

▸ planCompletelyLoaded(_plan): void

# Parameters

Name Type
_plan Plan

# Returns

void

# Implementation of

PlannerKernelCallbackI.planCompletelyLoaded

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1033 (opens new window)

# planElementChanged

▸ planElementChanged(_plan, _planViewModel): Promise<void>

# Parameters

Name Type
_plan Plan
_planViewModel default

# Returns

Promise<void>

# Implementation of

PlannerKernelCallbackI.planElementChanged

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1222 (opens new window)

# planElementRemoved

▸ planElementRemoved(_element): void

# Parameters

Name Type
_element PlanElement

# Returns

void

# Implementation of

PlannerKernelCallbackI.planElementRemoved

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1858 (opens new window)

# planHistoryStateChanged

▸ planHistoryStateChanged(): void

# Returns

void

# Implementation of

PlannerKernelCallbackI.planHistoryStateChanged

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:505 (opens new window)

# planObjectConfigurationLoaded

▸ planObjectConfigurationLoaded(plan, element, _success): void

# Parameters

Name Type
plan Plan
element PlanElement
_success boolean

# Returns

void

# Implementation of

PlannerKernelCallbackI.planObjectConfigurationLoaded

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1736 (opens new window)

# planObjectConstructionDone

▸ planObjectConstructionDone(_planObject): void

# Parameters

Name Type
_planObject PlanObject

# Returns

void

# Inherited from

default.planObjectConstructionDone

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:645 (opens new window)

# planObjectUpdated

▸ planObjectUpdated(planObject, geometryChanged, pendingDocking): void

# Parameters

Name Type
planObject PlanObject
geometryChanged boolean
pendingDocking boolean

# Returns

void

# Inherited from

default.planObjectUpdated

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1374 (opens new window)

# planXMLLoaded

▸ planXMLLoaded(plan): void

# Parameters

Name Type
plan Plan

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1028 (opens new window)

# preload

▸ preload(id): void

# Parameters

Name Type
id string

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1014 (opens new window)

# preparePartImage

▸ preparePartImage(partId, options): Promise<any>

# Parameters

Name Type
partId number
options PrepareImageOptions

# Returns

Promise<any>

# Inherited from

default.preparePartImage

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:794 (opens new window)

# preparePerspectiveImage

▸ preparePerspectiveImage(options?): Promise<Base64Image>

# Parameters

Name Type
options PrepareImageOptions

# Returns

Promise<Base64Image>

# Overrides

default.preparePerspectiveImage

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1994 (opens new window)

# preparePerspectiveImageOf

▸ preparePerspectiveImageOf(runtimeId, options?): Promise<Base64Image>

# Parameters

Name Type
runtimeId number
options PrepareImageOptions

# Returns

Promise<Base64Image>

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1900 (opens new window)

# prepareTopImage

▸ prepareTopImage(options?): Promise<Base64Image>

# Parameters

Name Type
options PrepareImageOptions

# Returns

Promise<Base64Image>

# Overrides

default.prepareTopImage

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1867 (opens new window)

# previewConstructionDone

▸ previewConstructionDone(_component, hasPreviews): void

# Parameters

Name Type
_component RoomleComponent
hasPreviews boolean

# Returns

void

# Inherited from

default.previewConstructionDone

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1414 (opens new window)

# removeEventListener

▸ removeEventListener(_listener): void

# Parameters

Name Type
_listener LifeCycleCallbacks

# Returns

void

# Inherited from

default.removeEventListener

# Defined in

packages/common-core/src/webgl/scene-manager.ts:188 (opens new window)

# removePlanObjectFromScene

▸ removePlanObjectFromScene(planViewModel): void

# Parameters

Name Type
planViewModel default

# Returns

void

# Implementation of

PlannerKernelCallbackI.removePlanObjectFromScene

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1198 (opens new window)

# renderImage

▸ renderImage(renderOptions): Promise<Base64Image>

# Parameters

Name Type
renderOptions Partial<{ useCurrentPerspective: boolean = false }>

# Returns

Promise<Base64Image>

# Inherited from

default.renderImage

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:749 (opens new window)

# requestDeleteSelectedComponent

▸ requestDeleteSelectedComponent(): void

# Returns

void

# Inherited from

default.requestDeleteSelectedComponent

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1321 (opens new window)

# requestDockingsPreview

▸ requestDockingsPreview(userInitiated, possibleChild?, dragEvent?, dragIn?): void

# Parameters

Name Type
userInitiated boolean
possibleChild? UiPossibleChild
dragEvent? DragEvent
dragIn? boolean

# Returns

void

# Inherited from

default.requestDockingsPreview

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1233 (opens new window)

# resetCameraPositionToStart

▸ resetCameraPositionToStart(): void

# Returns

void

# Overrides

default.resetCameraPositionToStart

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2656 (opens new window)

# resetConfiguratorContext

▸ resetConfiguratorContext(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:748 (opens new window)

# resetPreviews

▸ resetPreviews(): void

# Returns

void

# Inherited from

default.resetPreviews

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:950 (opens new window)

# resume

▸ resume(): void

# Returns

void

# Inherited from

default.resume

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:502 (opens new window)

# rotatePlanElementSelection

▸ rotatePlanElementSelection(rotateBy): void

# Parameters

Name Type
rotateBy number

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1829 (opens new window)

# saveConfigToIdb

▸ saveConfigToIdb(): void

# Returns

void

# Inherited from

default.saveConfigToIdb

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1611 (opens new window)

# sceneChanged

▸ sceneChanged(): void

# Returns

void

# Overrides

default.sceneChanged

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1583 (opens new window)

# sceneCleared

▸ sceneCleared(shouldHardReset): void

# Parameters

Name Type
shouldHardReset boolean

# Returns

void

# Inherited from

default.sceneCleared

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:593 (opens new window)

# selectComponent

▸ selectComponent(runtimeId): void

# Parameters

Name Type
runtimeId number

# Returns

void

# Inherited from

default.selectComponent

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1569 (opens new window)

# selectPlanObject

▸ selectPlanObject(runtimeId): Promise<void>

# Parameters

Name Type
runtimeId number

# Returns

Promise<void>

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:899 (opens new window)

# setBackgroundColor

▸ setBackgroundColor(hex): void

# Parameters

Name Type
hex string

# Returns

void

# Inherited from

default.setBackgroundColor

# Defined in

packages/common-core/src/webgl/scene-manager.ts:870 (opens new window)

# setBackgroundImage

▸ setBackgroundImage(url): void

# Parameters

Name Type
url string

# Returns

void

# Inherited from

default.setBackgroundImage

# Defined in

packages/common-core/src/webgl/scene-manager.ts:880 (opens new window)

# setCameraOffset

▸ setCameraOffset(offset): void

# Parameters

Name Type
offset CanvasOffset

# Returns

void

# Inherited from

default.setCameraOffset

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:962 (opens new window)

# setCompletelyLoaded

▸ setCompletelyLoaded(completelyLoaded): void

# Parameters

Name Type
completelyLoaded boolean

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2861 (opens new window)

# setEnvironmentMap

▸ setEnvironmentMap(url?, intensity?, rotation?, maxLightSources?): void

# Parameters

Name Type
url? string
intensity? number
rotation? number
maxLightSources? number

# Returns

void

# Inherited from

default.setEnvironmentMap

# Defined in

packages/common-core/src/webgl/scene-manager.ts:1111 (opens new window)

# setMeasurementLineLength

▸ setMeasurementLineLength(measurementId, length, wallDirection): void

# Parameters

Name Type
measurementId number
length number
wallDirection string

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2964 (opens new window)

# setMode

▸ setMode(mode): void

# Parameters

Name Type
mode Enumify<{ CAMERA_2D: "2D" = '2D'; CAMERA_3D: "3D" = '3D'; CAMERA_FP: "FP" = 'FP' }>

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1672 (opens new window)

# setObjectToWallMeasurementLength

▸ setObjectToWallMeasurementLength(planElementId, measurementId, length): void

# Parameters

Name Type
planElementId number
measurementId number
length number

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2877 (opens new window)

# setSceneEvents

▸ setSceneEvents(sceneEvents): void

# Parameters

Name Type
sceneEvents SceneEvents

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2610 (opens new window)

# setSelectionMode

▸ setSelectionMode(mode): void

# Parameters

Name Type
mode SELECTION_MODE

# Returns

void

# Inherited from

default.setSelectionMode

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1131 (opens new window)

# setWallMeasurementLength

▸ setWallMeasurementLength(measurementId, length, wallDirection): void

# Parameters

Name Type
measurementId number
length number
wallDirection EMSConstant

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2920 (opens new window)

# showDimensions

▸ showDimensions(): Promise<void>

# Returns

Promise<void>

# Inherited from

default.showDimensions

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1167 (opens new window)

# showGUI

▸ showGUI(): void

# Returns

void

# Inherited from

default.showGUI

# Defined in

packages/common-core/src/webgl/scene-manager.ts:671 (opens new window)

# showStats

▸ showStats(): void

# Returns

void

# Inherited from

default.showStats

# Defined in

packages/common-core/src/webgl/scene-manager.ts:750 (opens new window)

# startConfiguring

▸ startConfiguring(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:839 (opens new window)

# startViewing

▸ startViewing(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:799 (opens new window)

# startedDrawing

▸ startedDrawing(): void

called by kernel

# Returns

void

# Implementation of

PlannerKernelCallbackI.startedDrawing

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2629 (opens new window)

# stoppedDrawing

▸ stoppedDrawing(): void

called by kernel

# Returns

void

# Implementation of

PlannerKernelCallbackI.stoppedDrawing

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:2637 (opens new window)

# switchTo2D

▸ switchTo2D(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1355 (opens new window)

# switchTo3D

▸ switchTo3D(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1398 (opens new window)

# switchToFirstPerson

▸ switchToFirstPerson(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1432 (opens new window)

# unlockCamera

▸ unlockCamera(): void

# Returns

void

# Inherited from

default.unlockCamera

# Defined in

packages/common-core/src/webgl/scene-manager.ts:1107 (opens new window)

# updateCamera

▸ updateCamera(_changeCamera?): void

# Parameters

Name Type Default value
_changeCamera boolean true

# Returns

void

# Inherited from

default.updateCamera

# Defined in

packages/common-core/src/webgl/scene-manager.ts:553 (opens new window)

# updateCameraOnDrawWalls

▸ updateCameraOnDrawWalls(): void

# Returns

void

# Defined in

packages/planner-core/src/webgl/planner-scene-manager.ts:1763 (opens new window)

# updateScene

▸ updateScene(): void

# Returns

void

# Inherited from

default.updateScene

# Defined in

packages/common-core/src/webgl/scene-manager.ts:940 (opens new window)

# zoomIn

▸ zoomIn(value?): void

# Parameters

Name Type
value? number

# Returns

void

# Inherited from

default.zoomIn

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1157 (opens new window)

# zoomOut

▸ zoomOut(value?): void

# Parameters

Name Type
value? number

# Returns

void

# Inherited from

default.zoomOut

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1162 (opens new window)