RoomlePlanner.Internal.default

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

Hierarchy

Implements

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

Parameters

Name
Type

creator

string

plannerCallback

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

Accessors

configuratorContext

• get configuratorContext(): default

Returns

default


hasSingleRoom

• get hasSingleRoom(): boolean

Returns

boolean

Methods

_preparePerspectiveImage

â–¸ _preparePerspectiveImage(options?, isolationMode?): Promise<Base64Image>

Parameters

Name
Type

isolationMode?

boolean

Returns

Promise<Base64Image>


addComponentHandlers

â–¸ addComponentHandlers(component): void

Parameters

Name
Type

Returns

void

Inherited from

default.addComponentHandlers


addEventListener

â–¸ addEventListener(_listener): void

Parameters

Name
Type

Returns

void

Inherited from

default.addEventListener


addMesh

â–¸ addMesh(_planElement, _material, _vertices, _indices, _uvCoords, _normals): void

Parameters

Name
Type

_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

_material

any

_vertices

Float32Array

_indices

Int32Array

_uvCoords

Float32Array

_normals

Float32Array

Returns

void

Implementation of

PlannerKernelCallbackI.addPlanMesh


addPlanObjectToScene

â–¸ addPlanObjectToScene(planViewModel): Promise<void>

Parameters

Name
Type

planViewModel

Returns

Promise<void>

Implementation of

PlannerKernelCallbackI.addPlanObjectToScene


addPreviewHandlers

â–¸ addPreviewHandlers(previewComponent): void

Parameters

Name
Type

previewComponent

Returns

void

Inherited from

default.addPreviewHandlers


addPreviewLineHandlers

â–¸ addPreviewLineHandlers(previewLineComponent): void

Parameters

Name
Type

previewLineComponent

Returns

void

Inherited from

default.addPreviewLineHandlers


animateElement

â–¸ animateElement(elementId, parameterName, value, applyToChildren, animate): void

Parameters

Name
Type

elementId

number

parameterName

string

value

string

applyToChildren

boolean

animate

boolean

Returns

void

Inherited from

default.animateElement


backToPlanner

â–¸ backToPlanner(): void

Returns

void


beginPlanConstruction

â–¸ beginPlanConstruction(_plan): void

Parameters

Name
Type

_plan

Returns

void

Implementation of

PlannerKernelCallbackI.beginPlanConstruction


cameraBehaviourChanged

â–¸ cameraBehaviourChanged(): void

Returns

void

Overrides

default.cameraBehaviourChanged


cancelComponentSelection

â–¸ cancelComponentSelection(resetCamera?, reason?): 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

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

Returns

void


changeFloorMaterial

â–¸ changeFloorMaterial(material): Promise<void>

Parameters

Name
Type

material

Returns

Promise<void>

Inherited from

default.changeFloorMaterial


changeFloorsMaterial

â–¸ changeFloorsMaterial(material): void

Parameters

Name
Type

Returns

void


changeInteriorWallsMaterial

â–¸ changeInteriorWallsMaterial(material): void

Parameters

Name
Type

Returns

void


changeOffset

â–¸ changeOffset(offset): void

Parameters

Name
Type

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

Returns

void

Inherited from

default.componentDeleted


componentUpdated

â–¸ componentUpdated(component, _kernelComponent): void

Parameters

Name
Type

_kernelComponent

Returns

void

Inherited from

default.componentUpdated


configurationLoaded

â–¸ configurationLoaded(component, isFreeFlying): void

Parameters

Name
Type

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


disableEvents

â–¸ disableEvents(): void

Returns

void

Overrides

default.disableEvents


disableMeasurementLineDrawing

â–¸ disableMeasurementLineDrawing(): void

Returns

void


disablePlannerEvents

â–¸ disablePlannerEvents(): void

Returns

void


disableRotation

â–¸ disableRotation(): void

Returns

void


disableShowChildrenOfPlanObject

â–¸ disableShowChildrenOfPlanObject(planElementViewModel): void

Parameters

Name
Type

planElementViewModel

Returns

void


disableSnapping

â–¸ disableSnapping(): void

Returns

void


disableWallDrawing

â–¸ disableWallDrawing(): void

Returns

void


display

â–¸ display(component): void

Parameters

Name
Type

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


enableEvents

â–¸ enableEvents(): void

Returns

void

Overrides

default.enableEvents


enableHD

â–¸ enableHD(source?): void

Parameters

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

Returns

void


enableSnapping

â–¸ enableSnapping(): void

Returns

void


enableWallDrawing

â–¸ enableWallDrawing(): void

Returns

void


endPlanConstruction

â–¸ endPlanConstruction(_plan): void

Parameters

Name
Type

_plan

Returns

void

Implementation of

PlannerKernelCallbackI.endPlanConstruction


escapeDrawing

â–¸ escapeDrawing(cancelDrawing): void

Parameters

Name
Type

cancelDrawing

boolean

Returns

void


exportCanvasScreenshot

â–¸ exportCanvasScreenshot(quality?): Promise<string>

Parameters

Name
Type
Default value

quality

number

1

Returns

Promise<string>

Inherited from

default.exportCanvasScreenshot


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


getCameraParameters3d

â–¸ getCameraParameters3d(): CameraParameter

Returns

CameraParameter


getComponent

â–¸ getComponent(componentRuntimeId): KernelComponent

Parameters

Name
Type

componentRuntimeId

number

Returns

KernelComponent

Inherited from

default.getComponent


getGeometryBounds

â–¸ getGeometryBounds(): Box3

Returns

Box3

Overrides

default.getGeometryBounds


getObjectComponent

â–¸ getObjectComponent(id): KernelPlanObjectComponent

Parameters

Name
Type

id

number

Returns

KernelPlanObjectComponent


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


getSelectedRuntimeComponentIds

â–¸ getSelectedRuntimeComponentIds(): number[]

Returns

number[]

Inherited from

default.getSelectedRuntimeComponentIds


getWallAngleDegrees

â–¸ getWallAngleDegrees(wall): number

Parameters

Name
Type

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

toPlan

Returns

void

Implementation of

PlannerKernelCallbackI.handlerSwitchedPlans


hideDimensions

â–¸ hideDimensions(): void

Returns

void

Inherited from

default.hideDimensions


highlightExternalObject

â–¸ highlightExternalObject(planObjectComponent): void

Parameters

Name
Type

planObjectComponent

Returns

void


highlightParts

â–¸ highlightParts(ids): void

Parameters

Name
Type

ids

number[]

Returns

void

Inherited from

default.highlightParts


highlightPlanElementById

â–¸ highlightPlanElementById(runtimeId): void

Parameters

Name
Type

runtimeId

number

Returns

void


highlightPlanElementsById

â–¸ highlightPlanElementsById(runtimeIds): void

Parameters

Name
Type

runtimeIds

number[]

Returns

void


importGLB

â–¸ importGLB(url): void

Parameters

Name
Type

url

string

Returns

void


loadDynamicLightSetting

â–¸ loadDynamicLightSetting(source): Promise<void>

Parameters

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

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

Returns

Promise<void>

Overrides

default.moveCamera


moveElementPosition

â–¸ moveElementPosition(selectedElement, position): void

Parameters

Name
Type

selectedElement

Returns

void


moveElementsPosition

â–¸ moveElementsPosition(selectedElements, position): void

Parameters

Name
Type

selectedElements

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

Returns

void

Implementation of

PlannerKernelCallbackI.planCompletelyLoaded


planElementChanged

â–¸ planElementChanged(_plan, planElementViewModel): void

Parameters

Name
Type

_plan

planElementViewModel

Returns

void

Implementation of

PlannerKernelCallbackI.planElementChanged


planElementRemoved

â–¸ planElementRemoved(element): void

Parameters

Name
Type

Returns

void

Implementation of

PlannerKernelCallbackI.planElementRemoved


planHistoryStateChanged

â–¸ planHistoryStateChanged(): void

Returns

void

Implementation of

PlannerKernelCallbackI.planHistoryStateChanged


planObjectConfigurationChanged

â–¸ planObjectConfigurationChanged(plan, element): Promise<void>

Parameters

Name
Type

plan

element

Returns

Promise<void>

Implementation of

PlannerKernelCallbackI.planObjectConfigurationChanged


planObjectConfigurationLoaded

â–¸ planObjectConfigurationLoaded(plan, element, success): void

Parameters

Name
Type

plan

success

boolean

Returns

void

Implementation of

PlannerKernelCallbackI.planObjectConfigurationLoaded


planObjectConstructionDone

â–¸ planObjectConstructionDone(_planObject): void

Parameters

Name
Type

_planObject

Returns

void

Inherited from

default.planObjectConstructionDone


planObjectUpdated

â–¸ planObjectUpdated(planObject, geometryChanged, pendingDocking): void

Parameters

Name
Type

planObject

geometryChanged

boolean

pendingDocking

boolean

Returns

void

Inherited from

default.planObjectUpdated


planXMLLoaded

â–¸ planXMLLoaded(plan): void

Parameters

Name
Type

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

Returns

Promise<any>

Inherited from

default.preparePartImage


preparePerspectiveImage

â–¸ preparePerspectiveImage(options?, isolationMode?): Promise<Base64Image>

Parameters

Name
Type

isolationMode?

boolean

Returns

Promise<Base64Image>

Overrides

default.preparePerspectiveImage


preparePerspectiveImageOf

â–¸ preparePerspectiveImageOf(runtimeId, options?): Promise<Base64Image>

Parameters

Name
Type

runtimeId

number

Returns

Promise<Base64Image>


prepareTopImage

â–¸ prepareTopImage(options?, isolationMode?): Promise<Base64Image>

Parameters

Name
Type

isolationMode?

boolean

Returns

Promise<Base64Image>

Overrides

default.prepareTopImage


previewConstructionDone

â–¸ previewConstructionDone(_component, hasPreviews): void

Parameters

Name
Type

_component

hasPreviews

boolean

Returns

void

Inherited from

default.previewConstructionDone


removeEventListener

â–¸ removeEventListener(_listener): void

Parameters

Name
Type

Returns

void

Inherited from

default.removeEventListener


removePlanObjectFromScene

â–¸ removePlanObjectFromScene(planViewModel): void

Parameters

Name
Type

planViewModel

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


requestCatalogItem

â–¸ requestCatalogItem(catalogItemId): void

Parameters

Name
Type

catalogItemId

string

Returns

void

Implementation of

PlannerKernelCallbackI.requestCatalogItem


requestDeleteSelectedComponent

â–¸ requestDeleteSelectedComponent(): void

Returns

void

Inherited from

default.requestDeleteSelectedComponent


requestDockingsPreview

â–¸ requestDockingsPreview(userInitiated, possibleChild?, dragEvent?, dragIn?): void

Parameters

Name
Type

userInitiated

boolean

possibleChild?

dragEvent?

DragEvent

dragIn?

boolean

Returns

void

Inherited from

default.requestDockingsPreview


resetCameraPositionToStart

â–¸ resetCameraPositionToStart(): void

Returns

void

Overrides

default.resetCameraPositionToStart


resetConfiguratorContext

â–¸ resetConfiguratorContext(reason): void

Parameters

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, triggerClickCallback?): void

Parameters

Name
Type
Default value

runtimeId

number

undefined

triggerClickCallback

boolean

true

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

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

Returns

void


setSelectionMode

â–¸ setSelectionMode(mode): void

Parameters

Name
Type

Returns

void

Inherited from

default.setSelectionMode


setWallMeasurementLength

â–¸ setWallMeasurementLength(measurementId, length, wallDirection): void

Parameters

Name
Type

measurementId

number

length

number

wallDirection

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

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


waitForMaterialQueue

â–¸ waitForMaterialQueue(): Promise<void>

Returns

Promise<void>

Inherited from

default.waitForMaterialQueue


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

Last updated