RoomleConfigurator.Internal.default-10

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

Hierarchy

• default

  ↳ default

  ↳↳ default

Implements

• ConfiguratorViewModelCallbackI

Table of contents

Constructors

• constructor

Properties

• _creator_

Methods

• addComponentHandlers

• addEventListener

• addPreviewHandlers

• addPreviewLineHandlers

• animateElement

• cameraBehaviourChanged

• cancelComponentSelection

• cancelDockings

• cancelPreviousDockings

• changeEnvironmentMapIntensity

• changeFloorMaterial

• changeOffset

• cleanUp

• clearScene

• componentDeleted

• componentUpdated

• configurationLoaded

• debugScene

• debugSceneGraph

• destroy

• disableConfiguratorEvents

• disableEvents

• display

• enableConfiguratorEvents

• enableDragIn

• enableEvents

• enableHD

• exportCanvasScreenshot

• exportImageFromCamera

• getBounds

• getCameraOffset

• getComponent

• getGeometryBounds

• getOrthographicOffsetCamera

• getScene

• getScreenXY

• getSelectedRuntimeComponentIds

• handleEvent

• hideDimensions

• highlightParts

• loadDynamicLightSetting

• loadEnvMap

• loadSceneSettings

• lockCamera

• moveCamera

• pause

• planObjectConstructionDone

• planObjectUpdated

• preparePartImage

• preparePerspectiveImage

• prepareTopImage

• previewConstructionDone

• removeEventListener

• renderImage

• requestDeleteSelectedComponent

• requestDockingsPreview

• resetCameraPositionToStart

• resetPreviews

• resume

• saveConfigToIdb

• sceneChanged

• sceneCleared

• selectComponent

• setBackgroundColor

• setBackgroundImage

• setCameraOffset

• setEnvironmentMap

• setSelectionMode

• showDimensions

• showGUI

• showStats

• unlockCamera

• updateCamera

• updateScene

• waitForMaterialQueue

• zoomIn

• zoomOut

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

Properties

_creator_

• _creator_: string

Overrides

default.creator

Methods

addComponentHandlers

▸ addComponentHandlers(component): void

Parameters

Name	Type
component	RoomleComponent

Returns

void

Implementation of

ConfiguratorViewModelCallbackI.addComponentHandlers

---

addEventListener

▸ addEventListener(_listener): void

Parameters

Name	Type
_listener	LifeCycleCallbacks

Returns

void

Inherited from

default.addEventListener

---

addPreviewHandlers

▸ addPreviewHandlers(previewComponent): void

Parameters

Name	Type
previewComponent	PreviewComponent

Returns

void

Implementation of

ConfiguratorViewModelCallbackI.addPreviewHandlers

---

addPreviewLineHandlers

▸ addPreviewLineHandlers(previewLineComponent): void

Parameters

Name	Type
previewLineComponent	PreviewLineComponent

Returns

void

Implementation of

ConfiguratorViewModelCallbackI.addPreviewLineHandlers

---

animateElement

▸ animateElement(elementId, parameterName, value, applyToChildren, animate): void

Parameters

Name	Type
elementId	number
parameterName	string
value	string
applyToChildren	boolean
animate	boolean

Returns

void

---

cameraBehaviourChanged

▸ cameraBehaviourChanged(): void

Returns

void

Overrides

default.cameraBehaviourChanged

---

cancelComponentSelection

▸ cancelComponentSelection(resetCamera?, reason?): void

Parameters

Name	Type
resetCamera?	boolean
reason?	CancelSelectionReasons

Returns

void

---

cancelDockings

▸ cancelDockings(): void

Returns

void

---

cancelPreviousDockings

▸ cancelPreviousDockings(): void

Returns

void

---

changeEnvironmentMapIntensity

▸ changeEnvironmentMapIntensity(intensity): void

Parameters

Name	Type
intensity	number

Returns

void

Inherited from

default.changeEnvironmentMapIntensity

---

changeFloorMaterial

▸ changeFloorMaterial(material): Promise<void>

Parameters

Name	Type
material	RapiMaterial

Returns

Promise<void>

---

changeOffset

▸ changeOffset(offset): void

Parameters

Name	Type
offset	CanvasOffset

Returns

void

---

cleanUp

▸ cleanUp(): void

Returns

void

Inherited from

default.cleanUp

---

clearScene

▸ clearScene(): void

Returns

void

Implementation of

ConfiguratorViewModelCallbackI.clearScene

Overrides

default.clearScene

---

componentDeleted

▸ componentDeleted(component): void

Parameters

Name	Type
component	RoomleComponent

Returns

void

Implementation of

ConfiguratorViewModelCallbackI.componentDeleted

---

componentUpdated

▸ componentUpdated(component, _kernelComponent): void

Parameters

Name	Type
component	RoomleComponent
_kernelComponent	KernelComponent

Returns

void

Implementation of

ConfiguratorViewModelCallbackI.componentUpdated

---

configurationLoaded

▸ configurationLoaded(component, isFreeFlying): void

Parameters

Name	Type
component	RoomleComponent
isFreeFlying	boolean

Returns

void

Implementation of

ConfiguratorViewModelCallbackI.configurationLoaded

---

debugScene

▸ debugScene(): Scene

Returns

Scene

---

debugSceneGraph

▸ debugSceneGraph(id?): void

Parameters

Name	Type
id?	number

Returns

void

---

destroy

▸ destroy(): void

Returns

void

Inherited from

default.destroy

---

disableConfiguratorEvents

▸ disableConfiguratorEvents(): void

Returns

void

---

disableEvents

▸ disableEvents(): void

Returns

void

---

display

▸ display(component): void

Parameters

Name	Type
component	RoomleComponent

Returns

void

Implementation of

ConfiguratorViewModelCallbackI.display

---

enableConfiguratorEvents

▸ enableConfiguratorEvents(): void

Returns

void

---

enableDragIn

▸ enableDragIn(dragEvent): void

Parameters

Name	Type
dragEvent	DragEvent

Returns

void

---

enableEvents

▸ enableEvents(): void

Returns

void

---

enableHD

▸ enableHD(source?): void

Parameters

Name	Type
source?	DynamicLightSettingSource

Returns

void

Inherited from

default.enableHD

---

exportCanvasScreenshot

▸ exportCanvasScreenshot(quality?): Promise<string>

Parameters

Name	Type	Default value
quality	number	1

Returns

Promise<string>

Inherited from

default.exportCanvasScreenshot

---

exportImageFromCamera

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

Parameters

Name	Type	Default value
filename	string	undefined
shouldWaitForAssets	boolean	false

Returns

Promise<void>

Inherited from

default.exportImageFromCamera

---

getBounds

▸ getBounds(): Box3

Returns

Box3

Overrides

default.getBounds

---

getCameraOffset

▸ getCameraOffset(): CanvasOffset

Returns

CanvasOffset

Overrides

default.getCameraOffset

---

getComponent

▸ getComponent(componentRuntimeId): KernelComponent

Parameters

Name	Type
componentRuntimeId	number

Returns

KernelComponent

---

getGeometryBounds

▸ getGeometryBounds(): Box3

Returns

Box3

Overrides

default.getGeometryBounds

---

getOrthographicOffsetCamera

▸ getOrthographicOffsetCamera(): OrthographicOffsetCamera

Returns

OrthographicOffsetCamera

Inherited from

default.getOrthographicOffsetCamera

---

getScene

▸ getScene(): Scene

Returns

Scene

Inherited from

default.getScene

---

getScreenXY

▸ getScreenXY(position): Vector3

Parameters

Name	Type
position	Vector3

Returns

Vector3

---

getSelectedRuntimeComponentIds

▸ getSelectedRuntimeComponentIds(): number[]

Returns

number[]

---

handleEvent

▸ handleEvent(evt): void

Parameters

Name	Type
evt	Event

Returns

void

Inherited from

default.handleEvent

---

hideDimensions

▸ hideDimensions(): void

Returns

void

---

highlightParts

▸ highlightParts(ids): void

Parameters

Name	Type
ids	number[]

Returns

void

---

loadDynamicLightSetting

▸ loadDynamicLightSetting(source): Promise<void>

Parameters

Name	Type
source	DynamicLightSettingSource

Returns

Promise<void>

Inherited from

default.loadDynamicLightSetting

---

loadEnvMap

▸ loadEnvMap(url): Promise<void>

Parameters

Name	Type
url	string

Returns

Promise<void>

Inherited from

default.loadEnvMap

---

loadSceneSettings

▸ loadSceneSettings(sceneSetting): Promise<void>

Parameters

Name	Type
sceneSetting	SceneSettings

Returns

Promise<void>

Overrides

default.loadSceneSettings

---

lockCamera

▸ lockCamera(): void

Returns

void

Inherited from

default.lockCamera

---

moveCamera

▸ moveCamera(cameraParameter): Promise<void>

Parameters

Name	Type
cameraParameter	CameraParameter

Returns

Promise<void>

---

pause

▸ pause(): void

Returns

void

Overrides

default.pause

---

planObjectConstructionDone

▸ planObjectConstructionDone(_planObject): void

Parameters

Name	Type
_planObject	PlanObject

Returns

void

Implementation of

ConfiguratorViewModelCallbackI.planObjectConstructionDone

---

planObjectUpdated

▸ planObjectUpdated(planObject, geometryChanged, pendingDocking): void

Parameters

Name	Type
planObject	PlanObject
geometryChanged	boolean
pendingDocking	boolean

Returns

void

Implementation of

ConfiguratorViewModelCallbackI.planObjectUpdated

---

preparePartImage

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

Parameters

Name	Type
partId	number
options	PrepareImageOptions

Returns

Promise<any>

---

preparePerspectiveImage

▸ preparePerspectiveImage(options?, _isolationMode?): Promise<Base64Image>

Parameters

Name	Type
options	PrepareImageOptions
_isolationMode?	boolean

Returns

Promise<Base64Image>

---

prepareTopImage

▸ prepareTopImage(options?, _isolationMode?): Promise<Base64Image>

Parameters

Name	Type
options	PrepareImageOptions
_isolationMode?	boolean

Returns

Promise<Base64Image>

---

previewConstructionDone

▸ previewConstructionDone(_component, hasPreviews): void

Parameters

Name	Type
_component	RoomleComponent
hasPreviews	boolean

Returns

void

Implementation of

ConfiguratorViewModelCallbackI.previewConstructionDone

---

removeEventListener

▸ removeEventListener(_listener): void

Parameters

Name	Type
_listener	LifeCycleCallbacks

Returns

void

Inherited from

default.removeEventListener

---

renderImage

▸ renderImage(renderOptions): Promise<Base64Image>

Parameters

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

Returns

Promise<Base64Image>

---

requestDeleteSelectedComponent

▸ requestDeleteSelectedComponent(): void

Returns

void

---

requestDockingsPreview

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

Parameters

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

Returns

void

---

resetCameraPositionToStart

▸ resetCameraPositionToStart(): void

Returns

void

---

resetPreviews

▸ resetPreviews(): void

Returns

void

---

resume

▸ resume(): void

Returns

void

Overrides

default.resume

---

saveConfigToIdb

▸ saveConfigToIdb(): void

Returns

void

---

sceneChanged

▸ sceneChanged(): void

Returns

void

Overrides

default.sceneChanged

---

sceneCleared

▸ sceneCleared(shouldHardReset): void

Parameters

Name	Type
shouldHardReset	boolean

Returns

void

---

selectComponent

▸ selectComponent(runtimeId, triggerClickCallback?): void

Parameters

Name	Type	Default value
runtimeId	number	undefined
triggerClickCallback	boolean	true

Returns

void

---

setBackgroundColor

▸ setBackgroundColor(hex): void

Parameters

Name	Type
hex	string

Returns

void

Inherited from

default.setBackgroundColor

---

setBackgroundImage

▸ setBackgroundImage(url): void

Parameters

Name	Type
url	string

Returns

void

Inherited from

default.setBackgroundImage

---

setCameraOffset

▸ setCameraOffset(offset): void

Parameters

Name	Type
offset	CanvasOffset

Returns

void

Overrides

default.setCameraOffset

---

setEnvironmentMap

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

Parameters

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

Returns

void

Inherited from

default.setEnvironmentMap

---

setSelectionMode

▸ setSelectionMode(mode): void

Parameters

Name	Type
mode	SELECTION_MODE

Returns

void

---

showDimensions

▸ showDimensions(): Promise<void>

Returns

Promise<void>

---

showGUI

▸ showGUI(): void

Returns

void

Inherited from

default.showGUI

---

showStats

▸ showStats(): void

Returns

void

Inherited from

default.showStats

---

unlockCamera

▸ unlockCamera(): void

Returns

void

Inherited from

default.unlockCamera

---

updateCamera

▸ updateCamera(_changeCamera?): void

Parameters

Name	Type	Default value
_changeCamera	boolean	true

Returns

void

Inherited from

default.updateCamera

---

updateScene

▸ updateScene(): void

Returns

void

Inherited from

default.updateScene

---

waitForMaterialQueue

▸ waitForMaterialQueue(): Promise<void>

Returns

Promise<void>

---

zoomIn

▸ zoomIn(value?): void

Parameters

Name	Type
value?	number

Returns

void

---

zoomOut

▸ zoomOut(value?): void

Parameters

Name	Type
value?	number

Returns

void