RoomlePlannerUiCallback.default

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

Hierarchy

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new default(creator)

Parameters

Name
Type

creator

string

Overrides

UiCallback.constructor

Properties

_creator_

• _creator_: string

Inherited from

UiCallback.creator

Methods

cameraStartsMoving

â–¸ cameraStartsMoving(): void

Returns

void

Inherited from

UiCallback.cameraStartsMoving

disableWallDimensions

â–¸ disableWallDimensions(): void

This function gets called when the camera is moving and thus the wall dimensions should not be shown

Returns

void

get

â–¸ get(target, prop): string | (target: UiCallback, prop: keyof UiCallback) => string | (target: UiCallback, prop: keyof UiCallback) => string | ... | (() => void) | (() => void) | (() => void) | (() => void) | () => void | () => void | () => void | () => void | () => void | () => void | () => void | () => void

Parameters

Name
Type

target

UiCallback

prop

keyof UiCallback

Returns

string | (target: UiCallback, prop: keyof UiCallback) => string | (target: UiCallback, prop: keyof UiCallback) => string | ... | (() => void) | (() => void) | (() => void) | (() => void) | () => void | () => void | () => void | () => void | () => void | () => void | () => void | () => void

Inherited from

UiCallback.get

mute

â–¸ mute(): void

Returns

void

Inherited from

UiCallback.mute

onBackToPlanner

â–¸ onBackToPlanner(): Promise<void>

Callback invoked when configuration is finished.

Returns

Promise<void>

onCameraChanged

â–¸ onCameraChanged(type): void

Parameters

Name
Type

type

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

Returns

void

onCameraIdle

â–¸ onCameraIdle(): void

Returns

void

onChangedExternalObjectGroupPlan

â–¸ onChangedExternalObjectGroupPlan(group): void

documented in interface ExternalObjectUiCallback

Parameters

Name
Type

group

ExternalObjectGroup

Returns

void

Implementation of

ExternalObjectUiCallback.onChangedExternalObjectGroupPlan

onClickElement

â–¸ onClickElement(planElement): void

This function gets called when a selectable element has been clicked on. An equivalent function for component clicks is onClickComponent in the configurator-ui-callback.ts

Parameters

Name
Type
Description

planElement

default

PlanElementViewModel instance of the clicked element

Returns

void

onCompletelyLoaded

â–¸ onCompletelyLoaded(): void

When the plan has been completely loaded

Returns

void

onComponentSelectionCancel

â–¸ onComponentSelectionCancel(): void

Callback invoked when the selection of a component has been canceled.

Returns

void

onConfiguratorKernelIsReady

â–¸ onConfiguratorKernelIsReady(kernelContainer, kernelInstance): void

is called when the configurator kernel is ready. It returns the container and the instance

Parameters

Name
Type

kernelContainer

PlannerKernelContainer

kernelInstance

ConfiguratorKernelClass

Returns

void

onContextChanged

â–¸ onContextChanged(context): void

This callback is invoked when the context of the planner changes For example when it switches from planner to configurator, or from planner to viewer

Parameters

Name
Type

context

BASE_CONTEXT

Returns

void

onDeleteExternalObjectGroup

â–¸ onDeleteExternalObjectGroup(groupIdToDelete): void

documented in interface ExternalObjectUiCallback

Parameters

Name
Type

groupIdToDelete

string

Returns

void

Implementation of

ExternalObjectUiCallback.onDeleteExternalObjectGroup

onDeleteExternalObjectRootModule

â–¸ onDeleteExternalObjectRootModule(_remainingGroup, _rootModuleIdToDelete, _splitOffGroups?): void

documented in interface ExternalObjectUiCallback

Parameters

Name
Type

_remainingGroup

ExternalObjectGroup

_rootModuleIdToDelete

string

_splitOffGroups?

ExternalObjectGroup[]

Returns

void

Implementation of

ExternalObjectUiCallback.onDeleteExternalObjectRootModule

onDeleteExternalObjectSubModule

â–¸ onDeleteExternalObjectSubModule(rootModuleId, subModuleIdToDelete): void

documented in interface ExternalObjectUiCallback

Parameters

Name
Type

rootModuleId

string

subModuleIdToDelete

string

Returns

void

Implementation of

ExternalObjectUiCallback.onDeleteExternalObjectSubModule

onDragElementEnd

â–¸ onDragElementEnd(): void

This function gets called when a movable element was being dragged before and is now released

Returns

void

onDragElementStart

â–¸ onDragElementStart(planElementId): void

This function gets called when a movable element begins to be dragged

Parameters

Name
Type
Description

planElementId

number

current id of the dragged element

Returns

void

onDrawCancel

â–¸ onDrawCancel(): void

Returns

void

onDrawingStateChanged

â–¸ onDrawingStateChanged(currentlyDrawing): void

This updates if the user started/stopped drawing a wall

Parameters

Name
Type

currentlyDrawing

boolean

Returns

void

onDuplicateExternalObjectGroup

â–¸ onDuplicateExternalObjectGroup(sourceGroupId, newGroupPosition): void

documented in interface ExternalObjectUiCallback

Parameters

Name
Type

sourceGroupId

string

newGroupPosition

ExternalObjectGroupPosition

Returns

void

Implementation of

ExternalObjectUiCallback.onDuplicateExternalObjectGroup

onExternalObjectAttributeChanged

â–¸ onExternalObjectAttributeChanged(groupId, moduleIds, attributeId, value): void

documented in interface ExternalObjectUiCallback

Parameters

Name
Type

groupId

string

moduleIds

string | ExternalModuleInformation[]

attributeId

string

value

string

Returns

void

Implementation of

ExternalObjectUiCallback.onExternalObjectAttributeChanged

onExternalObjectEnvironmentChanged

â–¸ onExternalObjectEnvironmentChanged(affectedGroupIds): void

documented in interface ExternalObjectUiCallback

Parameters

Name
Type

affectedGroupIds

string[]

Returns

void

Implementation of

ExternalObjectUiCallback.onExternalObjectEnvironmentChanged

onExternalObjectGroupArrangementChanged

â–¸ onExternalObjectGroupArrangementChanged(changedGroup): void

documented in interface ExternalObjectUiCallback

Parameters

Name
Type

changedGroup

ExternalObjectGroup

Returns

void

Implementation of

ExternalObjectUiCallback.onExternalObjectGroupArrangementChanged

onExternalObjectGroupChanged

â–¸ onExternalObjectGroupChanged(stringifiedGroupData): void

documented in interface ExternalObjectUiCallback

Parameters

Name
Type

stringifiedGroupData

string

Returns

void

Implementation of

ExternalObjectUiCallback.onExternalObjectGroupChanged

onExternalObjectGroupLoaded

â–¸ onExternalObjectGroupLoaded(stringifiedGroupData): void

documented in interface ExternalObjectUiCallback

Parameters

Name
Type

stringifiedGroupData

string

Returns

void

Implementation of

ExternalObjectUiCallback.onExternalObjectGroupLoaded

onExternalObjectModuleSelected

â–¸ onExternalObjectModuleSelected(groupId, rootModuleId, subModuleId): void

documented in interface ExternalObjectUiCallback

Parameters

Name
Type

groupId

string

rootModuleId

string

subModuleId

string

Returns

void

Implementation of

ExternalObjectUiCallback.onExternalObjectModuleSelected

onExternalObjectSelectionCancel

â–¸ onExternalObjectSelectionCancel(reason): void

documented in interface ExternalObjectUiCallback

Parameters

Name
Type
Description

reason

CancelSelectionReasons

why the selection was canceled

Returns

void

Implementation of

ExternalObjectUiCallback.onExternalObjectSelectionCancel

onFloorPlanAreasUpdated

â–¸ onFloorPlanAreasUpdated(floorAreasData): void

Callback invoked when the dimensions of rooms are updated. It receives an array containing the computed areas of all rooms and related data, which may be used to display or process the area information of each room.

Parameters

Name
Type
Description

floorAreasData

FloorAreaDataTransferable[]

An array of objects, each representing the area and related data for each room within the floor plan.

Returns

void

onGetConfigurationForExternalObject

â–¸ onGetConfigurationForExternalObject(_rootModuleId): Promise<ExternalObjectGroup>

documented in interface ExternalObjectUiCallback

Parameters

Name
Type

_rootModuleId

string

Returns

Promise<ExternalObjectGroup>

Implementation of

ExternalObjectUiCallback.onGetConfigurationForExternalObject

onHandlerSwitchedPlans

â–¸ onHandlerSwitchedPlans(): void

Returns

void

onHistoryChange

â–¸ onHistoryChange(undo, redo): void

gets called if history changes

Parameters

Name
Type
Description

undo

boolean

true if undo is possible

redo

boolean

true if redo is possible

Returns

void

onItemsLoaded

â–¸ onItemsLoaded(): void

Returns

void

onMeasurementLineStateChange

â–¸ onMeasurementLineStateChange(isActive): void

Parameters

Name
Type

isActive

boolean

Returns

void

onMergeExternalObjectGroup

â–¸ onMergeExternalObjectGroup(targetGroup, idsOfGroupsMerged, idOfTargetRootModule): void

documented in interface ExternalObjectUiCallback

Parameters

Name
Type

targetGroup

ExternalObjectGroup

idsOfGroupsMerged

string | string[]

idOfTargetRootModule

string

Returns

void

Implementation of

ExternalObjectUiCallback.onMergeExternalObjectGroup

onMovedExternalObjectGroup

â–¸ onMovedExternalObjectGroup(group): void

documented in interface ExternalObjectUiCallback

Parameters

Name
Type

group

ExternalObjectGroup

Returns

void

Implementation of

ExternalObjectUiCallback.onMovedExternalObjectGroup

onMultiSelectionChange

â–¸ onMultiSelectionChange(selectedElements): void

Parameters

Name
Type

selectedElements

default[]

Returns

void

onPlanChanged

â–¸ onPlanChanged(): void

When something in the plan has changed

Returns

void

onPlanElementChanged

â–¸ onPlanElementChanged(changeType, changedObject): void

When an element in the plan has been added, removed or changed null if changed, added or removed object is not a item or configuration, such as a wall or construction element

Parameters

Name
Type

changeType

Enumify<{ ADDED: "added" = 'added'; CHANGED: "changed" = 'changed'; MOVED: "moved" = 'moved'; REMOVED: "removed" = 'removed' }>

changedObject

UiPlanObject

Returns

void

onPlanInteractionHandlerCreated

â–¸ onPlanInteractionHandlerCreated(planInteractionHandler): void

Parameters

Name
Type

planInteractionHandler

PlanInteractionHandler

Returns

void

onPlanSnapshotCreated

â–¸ onPlanSnapshotCreated(planId): void

Callback invoked when a plan snapshot is saved.

Parameters

Name
Type
Description

planId

string

The ID of the plan snapshot.

Returns

void

onPlannerKernelIsReady

â–¸ onPlannerKernelIsReady(kernelContainer): void

is called when the planner kernel is ready. It returns the container and the instance

Parameters

Name
Type

kernelContainer

PlannerKernelContainer

Returns

void

onReadyForRender

â–¸ onReadyForRender(): void

Deprecated

has been moved to global callbacks is called the scene is ready for rendering it as an image

Returns

void

Inherited from

UiCallback.onReadyForRender

onRotationCancel

â–¸ onRotationCancel(): void

When rotation mode has been canceled

Returns

void

onSelectionCancel

â–¸ onSelectionCancel(reason): void

When an item selection has been canceled

Parameters

Name
Type
Description

reason

CancelSelectionReasons

why the selection was canceled

Returns

void

onSelectionChange

â–¸ onSelectionChange(selectionMode, objectType, payload, payloadPromise, planElementViewModel): void

When an item has been selected

Parameters

Name
Type
Description

selectionMode

SELECTION_MODE

objectType

CallbackObjectType

currently only static items and configurations are supported

payload

SelectionPayload

returns the data which is available immediately (sync), currently this is catalogItemId and/or configurationRuntimeId

payloadPromise

Promise<SelectionPayload>

this promise resolves when the data of an object is fetched

planElementViewModel

default

the plan element view model used internally, WARNING: this is a reference, use with caution

Returns

void

onSelectionModeChange

â–¸ onSelectionModeChange(mode): void

Parameters

Name
Type

mode

SELECTION_MODE

Returns

void

onSplitExternalObjectGroup

â–¸ onSplitExternalObjectGroup(originalGroup, newGroupedRootModules): void

documented in interface ExternalObjectUiCallback

Parameters

Name
Type

originalGroup

ExternalObjectGroup

newGroupedRootModules

ExternalObjectGroup | ExternalObjectGroup[]

Returns

void

Implementation of

ExternalObjectUiCallback.onSplitExternalObjectGroup

onStartConfiguring

â–¸ onStartConfiguring(): Promise<void>

Callback invoked when an object is started to be configured.

Returns

Promise<void>

onTotalFloorAreaChanged

â–¸ onTotalFloorAreaChanged(totalFloorArea): void

Parameters

Name
Type

totalFloorArea

number

Returns

void

onUpdateConstructionElementsMeasurements

â–¸ onUpdateConstructionElementsMeasurements(constructionMeasurementsMeasurements): void

This function gets called when the camera has stopped moving, allowing for the calculation of the dimensions of construction elements' positions. It is also called when an element is selected or dragged on the plan.

Parameters

Name
Type
Description

constructionMeasurementsMeasurements

ConstructionMeasurementsTransferable

The measurements of construction elements.

Returns

void

onUpdateMeasurementLineDimensions

â–¸ onUpdateMeasurementLineDimensions(measurementLineDimensions): void

This function gets called when the camera is no longer moving and the position of the measurement line dimensions can be calculated

Parameters

Name
Type

measurementLineDimensions

MeasurementLineDimensionTransferable[]

Returns

void

onUpdateObjectMeasurements

â–¸ onUpdateObjectMeasurements(objectMeasurements): void

This function gets called when the camera has stopped moving, allowing for the calculation of the dimensions of plan element position. It is also called when the element is selected or dragged on the plan.

Parameters

Name
Type
Description

objectMeasurements

ObjectMeasurementsTransferable

The measurements of plan element related to the walls plus object dimensions.

Returns

void

onUpdatePlanObjectPositions

â–¸ onUpdatePlanObjectPositions(planObjectPositions): void

This function gets called when the camera is no longer moving it delivers all the positions of items in the plan normalized to the screen coordinates

Parameters

Name
Type

planObjectPositions

PlanObjectPosition[]

Returns

void

onUpdateWallDimensions

â–¸ onUpdateWallDimensions(wallDimensions): void

This function gets called when the camera is no longer moving and the position of the wall dimensions can be calculated

Parameters

Name
Type

wallDimensions

WallDimensionTransferable[]

Returns

void

unmute

â–¸ unmute(): void

Returns

void

Inherited from

UiCallback.unmute

PreviousRoomlePlanner.defaultNextTypingsKernel.Internal.BindingError

Last updated