Documentation

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

# Hierarchy

default

↳ default

# Implements

PlannerKernelCallbackI

# Table of contents

# Constructors

constructor

# 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

# Properties

# _creator_

• _creator_: string

# Inherited from

default.creator

# currentSelection

• currentSelection: SelectionPayload = null

# Methods

# _preparePerspectiveImage

▸ _preparePerspectiveImage(options?): Promise<Base64Image>

# Parameters

Name	Type
`options`	`PrepareImageOptionsPlanner`

# Returns

Promise<Base64Image>

# addComponentHandlers

▸ addComponentHandlers(component): void

# Parameters

Name	Type
`component`	`RoomleComponent`

# Returns

void

# Inherited from

default.addComponentHandlers

# addEventListener

▸ addEventListener(_listener): void

# Parameters

Name	Type
`_listener`	`LifeCycleCallbacks`

# Returns

void

# Inherited from

default.addEventListener

# addMesh

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

# Parameters

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

# Returns

void

# Implementation of

PlannerKernelCallbackI.addMesh

# addPlanMesh

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

# Parameters

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

# Returns

void

# Implementation of

PlannerKernelCallbackI.addPlanMesh

# addPlanObjectToScene

▸ addPlanObjectToScene(planViewModel): Promise<void>

# Parameters

Name	Type
`planViewModel`	`default`

# Returns

Promise<void>

# Implementation of

PlannerKernelCallbackI.addPlanObjectToScene

# addPreviewHandlers

▸ addPreviewHandlers(previewComponent): void

# Parameters

Name	Type
`previewComponent`	`PreviewComponent`

# Returns

void

# Inherited from

default.addPreviewHandlers

# addPreviewLineHandlers

▸ addPreviewLineHandlers(previewLineComponent): void

# Parameters

Name	Type
`previewLineComponent`	`PreviewLineComponent`

# Returns

void

# Inherited from

default.addPreviewLineHandlers

# backToPlanner

▸ backToPlanner(): void

# Returns

void

# beginPlanConstruction

▸ beginPlanConstruction(_plan): void

# Parameters

Name	Type
`_plan`	`Plan`

# Returns

void

# Implementation of

PlannerKernelCallbackI.beginPlanConstruction

# cameraBehaviourChanged

▸ cameraBehaviourChanged(): void

# Returns

void

# Overrides

default.cameraBehaviourChanged

# cancelComponentSelection

▸ cancelComponentSelection(resetCamera?): void

# Parameters

Name	Type
`resetCamera?`	`boolean`

# Returns

void

# Inherited from

default.cancelComponentSelection

# cancelDockings

▸ cancelDockings(): void

# Returns

void

# Inherited from

default.cancelDockings

# cancelPlanElementSelection

▸ cancelPlanElementSelection(reason): void

# Parameters

Name	Type
`reason`	`CancelSelectionReasons`

# Returns

void

# cancelPreviousDockings

▸ cancelPreviousDockings(): void

# Returns

void

# Inherited from

default.cancelPreviousDockings

# changeEnvironmentMapIntensity

▸ changeEnvironmentMapIntensity(intensity): void

# Parameters

Name	Type
`intensity`	`number`

# Returns

void

# Inherited from

default.changeEnvironmentMapIntensity

# changeExteriorWallsMaterial

▸ changeExteriorWallsMaterial(material): void

# Parameters

Name	Type
`material`	`BatchPaintMaterial`

# Returns

void

# changeFloorMaterial

▸ changeFloorMaterial(material): Promise<void>

# Parameters

Name	Type
`material`	`RapiMaterial`

# Returns

Promise<void>

# Inherited from

default.changeFloorMaterial

# changeFloorsMaterial

▸ changeFloorsMaterial(material): void

# Parameters

Name	Type
`material`	`BatchPaintMaterial`

# Returns

void

# changeInteriorWallsMaterial

▸ changeInteriorWallsMaterial(material): void

# Parameters

Name	Type
`material`	`BatchPaintMaterial`

# Returns

void

# changeOffset

▸ changeOffset(offset): void

# Parameters

Name	Type
`offset`	`CanvasOffset`

# Returns

void

# Inherited from

default.changeOffset

# cleanUp

▸ cleanUp(): void

# Returns

void

# Inherited from

default.cleanUp

# clearScene

▸ clearScene(): void

# Returns

void

# Overrides

default.clearScene

# componentDeleted

▸ componentDeleted(component): void

# Parameters

Name	Type
`component`	`RoomleComponent`

# Returns

void

# Inherited from

default.componentDeleted

# componentUpdated

▸ componentUpdated(component, _kernelComponent): void

# Parameters

Name	Type
`component`	`RoomleComponent`
`_kernelComponent`	`KernelComponent`

# Returns

void

# Inherited from

default.componentUpdated

# configurationLoaded

▸ configurationLoaded(component, isFreeFlying): void

# Parameters

Name	Type
`component`	`RoomleComponent`
`isFreeFlying`	`boolean`

# Returns

void

# Inherited from

default.configurationLoaded

# debugScene

▸ debugScene(): Scene

# Returns

Scene

# Inherited from

default.debugScene

# debugSceneGraph

▸ debugSceneGraph(id?): void

# Parameters

Name	Type
`id?`	`number`

# Returns

void

# Inherited from

default.debugSceneGraph

# deletePlanElementByIds

▸ deletePlanElementByIds(runtimeIds): Promise<void>

# Parameters

Name	Type
`runtimeIds`	`number`[]

# Returns

Promise<void>

# deletePlanElementSelection

▸ deletePlanElementSelection(): Promise<void>

# Returns

Promise<void>

# destroy

▸ destroy(): void

# Returns

void

# Overrides

default.destroy

# disableAdvancedDocking

▸ disableAdvancedDocking(): void

# Returns

void

# disableConfiguratorEvents

▸ disableConfiguratorEvents(): void

# Returns

void

# Inherited from

default.disableConfiguratorEvents

# disableMeasurementLineDrawing

▸ disableMeasurementLineDrawing(): void

# Returns

void

# disablePlannerEvents

▸ disablePlannerEvents(): void

# Returns

void

# disableRotation

▸ disableRotation(): void

# Returns

void

# disableShowChildrenOfPlanObject

▸ disableShowChildrenOfPlanObject(planElementViewModel): void

# Parameters

Name	Type
`planElementViewModel`	`default`

# Returns

void

# disableSnapping

▸ disableSnapping(): void

# Returns

void

# disableWallDrawing

▸ disableWallDrawing(): void

# Returns

void

# display

▸ display(component): void

# Parameters

Name	Type
`component`	`RoomleComponent`

# Returns

void

# Inherited from

default.display

# dragIn

▸ dragIn(dragEvent): void

# Parameters

Name	Type
`dragEvent`	`DragEvent`

# Returns

void

# enableAdvancedDocking

▸ enableAdvancedDocking(): void

# Returns

void

# enableConfiguratorEvents

▸ enableConfiguratorEvents(): void

# Returns

void

# Inherited from

default.enableConfiguratorEvents

# enableDragIn

▸ enableDragIn(dragEvent): void

# Parameters

Name	Type
`dragEvent`	`DragEvent`

# Returns

void

# Inherited from

default.enableDragIn

# enableHD

▸ enableHD(source?): void

# Parameters

Name	Type
`source?`	`DynamicLightSettingSource`

# Returns

void

# Inherited from

default.enableHD

# enableMeasurementLineDrawing

▸ enableMeasurementLineDrawing(): void

# Returns

void

# enablePlannerEvents

▸ enablePlannerEvents(): void

# Returns

void

# enableRotation

▸ enableRotation(): void

# Returns

void

# enableShowChildrenOfPlanObject

▸ enableShowChildrenOfPlanObject(planElementViewModel): void

# Parameters

Name	Type
`planElementViewModel`	`default`

# Returns

void

# enableSnapping

▸ enableSnapping(): void

# Returns

void

# enableWallDrawing

▸ enableWallDrawing(): void

# Returns

void

# endPlanConstruction

▸ endPlanConstruction(_plan): void

# Parameters

Name	Type
`_plan`	`Plan`

# Returns

void

# Implementation of

PlannerKernelCallbackI.endPlanConstruction

# escapeDrawing

▸ escapeDrawing(cancelDrawing): void

# Parameters

Name	Type
`cancelDrawing`	`boolean`

# Returns

void

# exportGLB

▸ exportGLB(_exportObjects?, _id?): void

# Parameters

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

# Returns

void

# 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

# Inherited from

default.getCameraOffset

# getComponent

▸ getComponent(componentRuntimeId): KernelComponent

# Parameters

Name	Type
`componentRuntimeId`	`number`

# Returns

KernelComponent

# Inherited from

default.getComponent

# getGeometryBounds

▸ getGeometryBounds(): Box3

# Returns

Box3

# Overrides

default.getGeometryBounds

# getOrthographicOffsetCamera

▸ getOrthographicOffsetCamera(): OrthographicOffsetCamera

# Returns

OrthographicOffsetCamera

# Inherited from

default.getOrthographicOffsetCamera

# getPlanObject

▸ getPlanObject(id): KernelPlanObject

# Parameters

Name	Type
`id`	`number`

# Returns

KernelPlanObject

# getPlannerSceneEventHandler

▸ getPlannerSceneEventHandler(): default

# Returns

default

# getRootPlanObjectId

▸ getRootPlanObjectId(id): number

This is needed to get the root plan object id in case a plan element is selected which has been docked using advanced docking

# Parameters

Name	Type
`id`	`number`

# Returns

number

# getScene

▸ getScene(): Scene

# Returns

Scene

# Inherited from

default.getScene

# getScreenXY

▸ getScreenXY(position): Vector3

# Parameters

Name	Type
`position`	`Vector3`

# Returns

Vector3

# Inherited from

default.getScreenXY

# getWallAngleDegrees

▸ getWallAngleDegrees(wall): number

# Parameters

Name	Type
`wall`	`default`

# Returns

number

# handleEvent

▸ handleEvent(evt): void

# Parameters

Name	Type
`evt`	`Event`

# Returns

void

# Inherited from

default.handleEvent

# handlerSwitchedPlans

▸ handlerSwitchedPlans(fromPlan, toPlan): void

# Parameters

Name	Type
`fromPlan`	`Plan`
`toPlan`	`Plan`

# Returns

void

# Implementation of

PlannerKernelCallbackI.handlerSwitchedPlans

# hideDimensions

▸ hideDimensions(): void

# Returns

void

# Inherited from

default.hideDimensions

# highlightParts

▸ highlightParts(ids): void

# Parameters

Name	Type
`ids`	`number`[]

# Returns

void

# Inherited from

default.highlightParts

# importGLB

▸ importGLB(url): void

# Parameters

Name	Type
`url`	`string`

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

# Inherited from

default.loadSceneSettings

# loadStaticPlanObjects

▸ loadStaticPlanObjects(): void

# Returns

void

# lockCamera

▸ lockCamera(): void

# Returns

void

# Inherited from

default.lockCamera

# moveCamera

▸ moveCamera(cameraParameter): Promise<void>

# Parameters

Name	Type
`cameraParameter`	`CameraParameter`

# Returns

Promise<void>

# Overrides

default.moveCamera

# moveElementPosition

▸ moveElementPosition(selectedElement, position): void

# Parameters

Name	Type
`selectedElement`	`default`
`position`	`KernelVector3`

# Returns

void

# moveElementsPosition

▸ moveElementsPosition(selectedElements, position): void

# Parameters

Name	Type
`selectedElements`	`default`[]
`position`	`KernelVector3`

# Returns

void

# pause

▸ pause(): void

# Returns

void

# Inherited from

default.pause

# planBoundsChanged

▸ planBoundsChanged(): void

# Returns

void

# Implementation of

PlannerKernelCallbackI.planBoundsChanged

# planCleared

▸ planCleared(): void

# Returns

void

# Implementation of

PlannerKernelCallbackI.planCleared

# planCompletelyLoaded

▸ planCompletelyLoaded(_plan): void

# Parameters

Name	Type
`_plan`	`Plan`

# Returns

void

# Implementation of

PlannerKernelCallbackI.planCompletelyLoaded

# planElementChanged

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

# Parameters

Name	Type
`_plan`	`Plan`
`_planViewModel`	`default`

# Returns

Promise<void>

# Implementation of

PlannerKernelCallbackI.planElementChanged

# planElementRemoved

▸ planElementRemoved(element): void

# Parameters

Name	Type
`element`	`PlanElement`

# Returns

void

# Implementation of

PlannerKernelCallbackI.planElementRemoved

# planHistoryStateChanged

▸ planHistoryStateChanged(): void

# Returns

void

# Implementation of

PlannerKernelCallbackI.planHistoryStateChanged

# planObjectConfigurationLoaded

▸ planObjectConfigurationLoaded(plan, element, _success): void

# Parameters

Name	Type
`plan`	`Plan`
`element`	`PlanElement`
`_success`	`boolean`

# Returns

void

# Implementation of

PlannerKernelCallbackI.planObjectConfigurationLoaded

# planObjectConstructionDone

▸ planObjectConstructionDone(_planObject): void

# Parameters

Name	Type
`_planObject`	`PlanObject`

# Returns

void

# Inherited from

default.planObjectConstructionDone

# planObjectUpdated

▸ planObjectUpdated(planObject, geometryChanged, pendingDocking): void

# Parameters

Name	Type
`planObject`	`PlanObject`
`geometryChanged`	`boolean`
`pendingDocking`	`boolean`

# Returns

void

# Inherited from

default.planObjectUpdated

# planXMLLoaded

▸ planXMLLoaded(plan): void

# Parameters

Name	Type
`plan`	`Plan`

# Returns

void

# preload

▸ preload(id): void

# Parameters

Name	Type
`id`	`string`

# Returns

void

# preparePartImage

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

# Parameters

Name	Type
`partId`	`number`
`options`	`PrepareImageOptions`

# Returns

Promise<any>

# Inherited from

default.preparePartImage

# preparePerspectiveImage

▸ preparePerspectiveImage(options?): Promise<Base64Image>

# Parameters

Name	Type
`options`	`PrepareImageOptions`

# Returns

Promise<Base64Image>

# Overrides

default.preparePerspectiveImage

# preparePerspectiveImageOf

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

# Parameters

Name	Type
`runtimeId`	`number`
`options`	`PrepareImageOptions`

# Returns

Promise<Base64Image>

# prepareTopImage

▸ prepareTopImage(options?): Promise<Base64Image>

# Parameters

Name	Type
`options`	`PrepareImageOptions`

# Returns

Promise<Base64Image>

# Overrides

default.prepareTopImage

# previewConstructionDone

▸ previewConstructionDone(_component, hasPreviews): void

# Parameters

Name	Type
`_component`	`RoomleComponent`
`hasPreviews`	`boolean`

# Returns

void

# Inherited from

default.previewConstructionDone

# removeEventListener

▸ removeEventListener(_listener): void

# Parameters

Name	Type
`_listener`	`LifeCycleCallbacks`

# Returns

void

# Inherited from

default.removeEventListener

# removePlanObjectFromScene

▸ removePlanObjectFromScene(planViewModel): void

# Parameters

Name	Type
`planViewModel`	`default`

# Returns

void

# Implementation of

PlannerKernelCallbackI.removePlanObjectFromScene

# renderImage

▸ renderImage(renderOptions): Promise<Base64Image>

# Parameters

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

# Returns

Promise<Base64Image>

# Inherited from

default.renderImage

# requestDeleteSelectedComponent

▸ requestDeleteSelectedComponent(): void

# Returns

void

# Inherited from

default.requestDeleteSelectedComponent

# requestDockingsPreview

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

# Parameters

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

# Returns

void

# Inherited from

default.requestDockingsPreview

# resetCameraPositionToStart

▸ resetCameraPositionToStart(): void

# Returns

void

# Overrides

default.resetCameraPositionToStart

# resetConfiguratorContext

▸ resetConfiguratorContext(): void

# Returns

void

# resetPreviews

▸ resetPreviews(): void

# Returns

void

# Inherited from

default.resetPreviews

# resume

▸ resume(): void

# Returns

void

# Inherited from

default.resume

# rotatePlanElementSelection

▸ rotatePlanElementSelection(rotateBy): void

# Parameters

Name	Type
`rotateBy`	`number`

# Returns

void

# saveConfigToIdb

▸ saveConfigToIdb(): void

# Returns

void

# Inherited from

default.saveConfigToIdb

# sceneChanged

▸ sceneChanged(): void

# Returns

void

# Overrides

default.sceneChanged

# sceneCleared

▸ sceneCleared(shouldHardReset): void

# Parameters

Name	Type
`shouldHardReset`	`boolean`

# Returns

void

# Inherited from

default.sceneCleared

# selectComponent

▸ selectComponent(runtimeId): void

# Parameters

Name	Type
`runtimeId`	`number`

# Returns

void

# Inherited from

default.selectComponent

# selectPlanObject

▸ selectPlanObject(runtimeId): Promise<void>

# Parameters

Name	Type
`runtimeId`	`number`

# Returns

Promise<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

# Inherited from

default.setCameraOffset

# setCompletelyLoaded

▸ setCompletelyLoaded(completelyLoaded): void

# Parameters

Name	Type
`completelyLoaded`	`boolean`

# Returns

void

# setEnvironmentMap

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

# Parameters

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

# Returns

void

# Inherited from

default.setEnvironmentMap

# setMeasurementLineLength

▸ setMeasurementLineLength(measurementId, length, wallDirection): void

# Parameters

Name	Type
`measurementId`	`number`
`length`	`number`
`wallDirection`	`string`

# Returns

void

# setMode

▸ setMode(mode): void

# Parameters

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

# Returns

void

# setObjectToWallMeasurementLength

▸ setObjectToWallMeasurementLength(planElementId, measurementId, length): void

# Parameters

Name	Type
`planElementId`	`number`
`measurementId`	`number`
`length`	`number`

# Returns

void

# setSceneEvents

▸ setSceneEvents(sceneEvents): void

# Parameters

Name	Type
`sceneEvents`	`SceneEvents`

# Returns

void

# setSelectionMode

▸ setSelectionMode(mode): void

# Parameters

Name	Type
`mode`	`SELECTION_MODE`

# Returns

void

# Inherited from

default.setSelectionMode

# setWallMeasurementLength

▸ setWallMeasurementLength(measurementId, length, wallDirection): void

# Parameters

Name	Type
`measurementId`	`number`
`length`	`number`
`wallDirection`	`EMSConstant`

# Returns

void

# showDimensions

▸ showDimensions(): Promise<void>

# Returns

Promise<void>

# Inherited from

default.showDimensions

# showGUI

▸ showGUI(): void

# Returns

void

# Inherited from

default.showGUI

# showStats

▸ showStats(): void

# Returns

void

# Inherited from

default.showStats

# showsChildrenOfPlanObject

▸ showsChildrenOfPlanObject(planElementViewModel): boolean

# Parameters

Name	Type
`planElementViewModel`	`default`

# Returns

boolean

# startConfiguring

▸ startConfiguring(): void

# Returns

void

# startViewing

▸ startViewing(): void

# Returns

void

# startedDrawing

▸ startedDrawing(): void

called by kernel

# Returns

void

# Implementation of

PlannerKernelCallbackI.startedDrawing

# stoppedDrawing

▸ stoppedDrawing(): void

called by kernel

# Returns

void

# Implementation of

PlannerKernelCallbackI.stoppedDrawing

# switchTo2D

▸ switchTo2D(): void

# Returns

void

# switchTo3D

▸ switchTo3D(): void

# Returns

void

# switchToFirstPerson

▸ switchToFirstPerson(): void

# Returns

void

# toggleConfigureInRoom

▸ toggleConfigureInRoom(): void

# Returns

void

# 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

# updateCameraOnDrawWalls

▸ updateCameraOnDrawWalls(): void

# Returns

void

# updateScene

▸ updateScene(): void

# Returns

void

# Inherited from

default.updateScene

# zoomIn

▸ zoomIn(value?): void

# Parameters

Name	Type
`value?`	`number`

# Returns

void

# Inherited from

default.zoomIn

# zoomOut

▸ zoomOut(value?): void

# Parameters

Name	Type
`value?`	`number`

# Returns

void

# Inherited from

default.zoomOut