Documentation

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

# Hierarchy

UiCallback

↳ default

# Table of contents

# Constructors

constructor

# Properties

_creator_

# 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

# Parameters

Name	Type
`target`	`UiCallback`
`prop`	keyof `UiCallback`

# Returns

# Inherited from

UiCallback.get

# mute

▸ mute(): void

# Returns

void

# Inherited from

UiCallback.mute

# 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

# 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

# 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

# onDragElementEnd

▸ onDragElementEnd(): void

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

# Returns

void

# onDragElementStart

▸ onDragElementStart(): void

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

# 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

# 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

# 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

# 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'; `REMOVED`: `"removed"` = 'removed' }>
`changedObject`	`UiPlanObject`

# Returns

void

# onPlanInteractionHandlerCreated

▸ onPlanInteractionHandlerCreated(planInteractionHandler): void

# Parameters

Name	Type
`planInteractionHandler`	`PlanInteractionHandler`

# 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

# 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
`reason`	`CancelSelectionReasons`

# 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

# 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