API Reference / Modules / configurator-core/src/roomle-configurator / <internal> / default

# Class: default

configurator-core/src/roomle-configurator..default

# Hierarchy

# Implements

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

new default(creator, offset, mode)

# Parameters

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

# Overrides

SceneManager.constructor

# Defined in

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

# Properties

# _creator_

_creator_: string

# Overrides

default.creator

# Defined in

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

# Methods

# addComponentHandlers

addComponentHandlers(component): void

# Parameters

Name Type
component RoomleComponent

# Returns

void

# Implementation of

ConfiguratorViewModelCallbackI.addComponentHandlers

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1450 (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)


# addPreviewHandlers

addPreviewHandlers(previewComponent): void

# Parameters

Name Type
previewComponent PreviewComponent

# Returns

void

# Implementation of

ConfiguratorViewModelCallbackI.addPreviewHandlers

# Defined in

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


# addPreviewLineHandlers

addPreviewLineHandlers(previewLineComponent): void

# Parameters

Name Type
previewLineComponent PreviewLineComponent

# Returns

void

# Implementation of

ConfiguratorViewModelCallbackI.addPreviewLineHandlers

# Defined in

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


# cameraBehaviourChanged

cameraBehaviourChanged(): void

# Returns

void

# Overrides

default.cameraBehaviourChanged

# Defined in

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


# cancelComponentSelection

cancelComponentSelection(resetCamera?): void

# Parameters

Name Type
resetCamera? boolean

# Returns

void

# Defined in

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


# cancelDockings

cancelDockings(): void

# Returns

void

# Defined in

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


# cancelPreviousDockings

cancelPreviousDockings(): void

# Returns

void

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1037 (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)


# changeFloorMaterial

changeFloorMaterial(material): Promise<void>

# Parameters

Name Type
material RapiMaterial

# Returns

Promise<void>

# Defined in

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


# changeOffset

changeOffset(offset): void

# Parameters

Name Type
offset CanvasOffset

# Returns

void

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:949 (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

# Implementation of

ConfiguratorViewModelCallbackI.clearScene

# Overrides

default.clearScene

# Defined in

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


# componentDeleted

componentDeleted(component): void

# Parameters

Name Type
component RoomleComponent

# Returns

void

# Implementation of

ConfiguratorViewModelCallbackI.componentDeleted

# Defined in

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


# componentUpdated

componentUpdated(component, _kernelComponent): void

# Parameters

Name Type
component RoomleComponent
_kernelComponent KernelComponent

# Returns

void

# Implementation of

ConfiguratorViewModelCallbackI.componentUpdated

# Defined in

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


# configurationLoaded

configurationLoaded(component, isFreeFlying): void

# Parameters

Name Type
component RoomleComponent
isFreeFlying boolean

# Returns

void

# Implementation of

ConfiguratorViewModelCallbackI.configurationLoaded

# Defined in

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


# debugScene

debugScene(): Scene

# Returns

Scene

# 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

# Defined in

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


# destroy

destroy(): void

# Returns

void

# Inherited from

default.destroy

# Defined in

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


# disableConfiguratorEvents

disableConfiguratorEvents(): void

# Returns

void

# Defined in

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


# display

display(component): void

# Parameters

Name Type
component RoomleComponent

# Returns

void

# Implementation of

ConfiguratorViewModelCallbackI.display

# Defined in

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


# enableConfiguratorEvents

enableConfiguratorEvents(): void

# Returns

void

# 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

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:884 (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)


# 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/configurator-core/src/webgl/configurator-scene-manager.ts:1646 (opens new window)


# getCameraOffset

getCameraOffset(): CanvasOffset

# Returns

CanvasOffset

# Overrides

default.getCameraOffset

# Defined in

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


# getComponent

getComponent(componentRuntimeId): KernelComponent

# Parameters

Name Type
componentRuntimeId number

# Returns

KernelComponent

# Defined in

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


# getGeometryBounds

getGeometryBounds(): Box3

# Returns

Box3

# Overrides

default.getGeometryBounds

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1650 (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)


# 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

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1116 (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)


# hideDimensions

hideDimensions(): void

# Returns

void

# Defined in

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


# highlightParts

highlightParts(ids): void

# Parameters

Name Type
ids number[]

# Returns

void

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1555 (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>

# Overrides

default.loadSceneSettings

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1198 (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>

# Defined in

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


# pause

pause(): void

# Returns

void

# Overrides

default.pause

# Defined in

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


# planObjectConstructionDone

planObjectConstructionDone(_planObject): void

# Parameters

Name Type
_planObject PlanObject

# Returns

void

# Implementation of

ConfiguratorViewModelCallbackI.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

# Implementation of

ConfiguratorViewModelCallbackI.planObjectUpdated

# Defined in

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


# preparePartImage

preparePartImage(partId, options): Promise<any>

# Parameters

Name Type
partId number
options PrepareImageOptions

# Returns

Promise<any>

# Defined in

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


# preparePerspectiveImage

preparePerspectiveImage(options?): Promise<Base64Image>

# Parameters

Name Type
options PrepareImageOptions

# Returns

Promise<Base64Image>

# Defined in

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


# prepareTopImage

prepareTopImage(options?): Promise<Base64Image>

# Parameters

Name Type
options PrepareImageOptions

# Returns

Promise<Base64Image>

# Defined in

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


# previewConstructionDone

previewConstructionDone(_component, hasPreviews): void

# Parameters

Name Type
_component RoomleComponent
hasPreviews boolean

# Returns

void

# Implementation of

ConfiguratorViewModelCallbackI.previewConstructionDone

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1391 (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)


# renderImage

renderImage(renderOptions): Promise<Base64Image>

# Parameters

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

# Returns

Promise<Base64Image>

# Defined in

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


# requestDeleteSelectedComponent

requestDeleteSelectedComponent(): void

# Returns

void

# Defined in

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


# requestDockingsPreview

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

# Parameters

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

# Returns

void

# Defined in

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


# resetCameraPositionToStart

resetCameraPositionToStart(): void

# Returns

void

# Defined in

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


# resetPreviews

resetPreviews(): void

# Returns

void

# Defined in

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


# resume

resume(): void

# Returns

void

# Overrides

default.resume

# Defined in

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


# saveConfigToIdb

saveConfigToIdb(): void

# Returns

void

# Defined in

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


# sceneChanged

sceneChanged(): void

# Returns

void

# Overrides

default.sceneChanged

# Defined in

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


# sceneCleared

sceneCleared(shouldHardReset): void

# Parameters

Name Type
shouldHardReset boolean

# Returns

void

# 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

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1540 (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

# Overrides

default.setCameraOffset

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:956 (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)


# setSelectionMode

setSelectionMode(mode): void

# Parameters

Name Type
mode SELECTION_MODE

# Returns

void

# Defined in

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


# showDimensions

showDimensions(): Promise<void>

# Returns

Promise<void>

# Defined in

packages/configurator-core/src/webgl/configurator-scene-manager.ts:1161 (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)


# 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)


# 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

# Defined in

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


# zoomOut

zoomOut(value?): void

# Parameters

Name Type
value? number

# Returns

void

# Defined in

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