# Class: default
planner-core/src/roomle-planner-ui-callback.default
# Hierarchy
-
↳
default
# Table of contents
# Constructors
# Properties
# Methods
- cameraStartsMoving
- disableWallDimensions
- get
- mute
- onCameraChanged
- onCameraIdle
- onClickElement
- onCompletelyLoaded
- onConfiguratorKernelIsReady
- onDragElementEnd
- onDragElementStart
- onDrawCancel
- onFloorPlanAreasUpdated
- onHandlerSwitchedPlans
- onHistoryChange
- onItemsLoaded
- onMeasurementLineStateChange
- onMultiSelectionChange
- onPlanChanged
- onPlanElementChanged
- onPlanInteractionHandlerCreated
- onPlannerKernelIsReady
- onRotationCancel
- onSelectionCancel
- onSelectionChange
- onSelectionModeChange
- onTotalFloorAreaChanged
- onUpdateConstructionElementsMeasurements
- onUpdateMeasurementLineDimensions
- onUpdateObjectMeasurements
- onUpdatePlanObjectPositions
- onUpdateWallDimensions
- unmute
# Constructors
# constructor
• new default(creator)
# Parameters
| Name | Type |
|---|---|
creator | string |
# Overrides
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:53 (opens new window)
# Properties
# _creator_
• _creator_: string
# Inherited from
# Defined in
packages/common-core/src/utils/ui-callback.ts:8 (opens new window)
# Methods
# cameraStartsMoving
▸ cameraStartsMoving(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/utils/ui-callback.ts:57 (opens new window)
# disableWallDimensions
▸ disableWallDimensions(): void
This function gets called when the camera is moving and thus the wall dimensions should not be shown
# Returns
void
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:192 (opens new window)
# 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
# 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
# Inherited from
# Defined in
packages/common-core/src/utils/ui-callback.ts:43 (opens new window)
# mute
▸ mute(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/utils/ui-callback.ts:17 (opens new window)
# onCameraChanged
▸ onCameraChanged(type): void
# Parameters
| Name | Type |
|---|---|
type | Enumify<{ CAMERA_2D: "2D" = '2D'; CAMERA_3D: "3D" = '3D'; CAMERA_FP: "FP" = 'FP' }> |
# Returns
void
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:61 (opens new window)
# onCameraIdle
▸ onCameraIdle(): void
# Returns
void
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:65 (opens new window)
# 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
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:222 (opens new window)
# onCompletelyLoaded
▸ onCompletelyLoaded(): void
When the plan has been completely loaded
# Returns
void
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:137 (opens new window)
# 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
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:93 (opens new window)
# onDragElementEnd
▸ onDragElementEnd(): void
This function gets called when a movable element was being dragged before and is now released
# Returns
void
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:215 (opens new window)
# onDragElementStart
▸ onDragElementStart(): void
This function gets called when a movable element begins to be dragged
# Returns
void
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:210 (opens new window)
# onDrawCancel
▸ onDrawCancel(): void
# Returns
void
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:203 (opens new window)
# 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
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:249 (opens new window)
# onHandlerSwitchedPlans
▸ onHandlerSwitchedPlans(): void
# Returns
void
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:205 (opens new window)
# 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
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:149 (opens new window)
# onItemsLoaded
▸ onItemsLoaded(): void
# Returns
void
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:57 (opens new window)
# onMeasurementLineStateChange
▸ onMeasurementLineStateChange(isActive): void
# Parameters
| Name | Type |
|---|---|
isActive | boolean |
# Returns
void
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:242 (opens new window)
# onMultiSelectionChange
▸ onMultiSelectionChange(selectedElements): void
# Parameters
| Name | Type |
|---|---|
selectedElements | default[] |
# Returns
void
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:229 (opens new window)
# onPlanChanged
▸ onPlanChanged(): void
When something in the plan has changed
# Returns
void
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:123 (opens new window)
# 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
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:129 (opens new window)
# onPlanInteractionHandlerCreated
▸ onPlanInteractionHandlerCreated(planInteractionHandler): void
# Parameters
| Name | Type |
|---|---|
planInteractionHandler | PlanInteractionHandler |
# Returns
void
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:73 (opens new window)
# 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
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:84 (opens new window)
# onRotationCancel
▸ onRotationCancel(): void
When rotation mode has been canceled
# Returns
void
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:142 (opens new window)
# onSelectionCancel
▸ onSelectionCancel(reason): void
When an item selection has been canceled
# Parameters
| Name | Type |
|---|---|
reason | CancelSelectionReasons |
# Returns
void
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:117 (opens new window)
# 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
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:106 (opens new window)
# onSelectionModeChange
▸ onSelectionModeChange(mode): void
# Parameters
| Name | Type |
|---|---|
mode | SELECTION_MODE |
# Returns
void
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:237 (opens new window)
# onTotalFloorAreaChanged
▸ onTotalFloorAreaChanged(totalFloorArea): void
# Parameters
| Name | Type |
|---|---|
totalFloorArea | number |
# Returns
void
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:69 (opens new window)
# 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
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:175 (opens new window)
# 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
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:165 (opens new window)
# 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
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:185 (opens new window)
# 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
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:199 (opens new window)
# 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
# Defined in
packages/planner-core/src/roomle-planner-ui-callback.ts:156 (opens new window)
# unmute
▸ unmute(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/utils/ui-callback.ts:21 (opens new window)