planner-core/src/roomle-planner-ui-callback.default
Table of contents
• new default(creator)
UiCallback.constructor
• _creator_: string
UiCallback.creator
cameraStartsMoving
â–¸ cameraStartsMoving(): void
void
UiCallback.cameraStartsMoving
disableWallDimensions
â–¸ disableWallDimensions(): void
This function gets called when the camera is moving and thus the wall dimensions should not be shown
void
â–¸ 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
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
UiCallback.get
â–¸ mute(): void
void
UiCallback.mute
onBackToPlanner
â–¸ onBackToPlanner(): Promise<void>
Callback invoked when configuration is finished.
Promise<void>
onCameraChanged
â–¸ onCameraChanged(type): void
Enumify<{ CAMERA_2D: "2D" = '2D'; CAMERA_3D: "3D" = '3D'; CAMERA_FP: "FP" = 'FP' }>
void
â–¸ onCameraIdle(): void
void
onChangedExternalObjectGroupPlan
â–¸ onChangedExternalObjectGroupPlan(group): void
documented in interface ExternalObjectUiCallback
void
Implementation of
ExternalObjectUiCallback.onChangedExternalObjectGroupPlan
â–¸ 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
PlanElementViewModel instance of the clicked element
void
onCompletelyLoaded
â–¸ onCompletelyLoaded(): void
When the plan has been completely loaded
void
onComponentSelectionCancel
â–¸ onComponentSelectionCancel(): void
Callback invoked when the selection of a component has been canceled.
void
onConfiguratorKernelIsReady
â–¸ onConfiguratorKernelIsReady(kernelContainer, kernelInstance): void
is called when the configurator kernel is ready. It returns the container and the instance
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
void
onDeleteExternalObjectGroup
â–¸ onDeleteExternalObjectGroup(groupIdToDelete): void
documented in interface ExternalObjectUiCallback
void
Implementation of
ExternalObjectUiCallback.onDeleteExternalObjectGroup
onDeleteExternalObjectRootModule
â–¸ onDeleteExternalObjectRootModule(_remainingGroup, _rootModuleIdToDelete, _splitOffGroups?): void
documented in interface ExternalObjectUiCallback
void
Implementation of
ExternalObjectUiCallback.onDeleteExternalObjectRootModule
onDeleteExternalObjectSubModule
â–¸ onDeleteExternalObjectSubModule(rootModuleId, subModuleIdToDelete): void
documented in interface ExternalObjectUiCallback
void
Implementation of
ExternalObjectUiCallback.onDeleteExternalObjectSubModule
onDragElementEnd
â–¸ onDragElementEnd(): void
This function gets called when a movable element was being dragged before and is now released
void
onDragElementStart
â–¸ onDragElementStart(planElementId): void
This function gets called when a movable element begins to be dragged
current id of the dragged element
void
â–¸ onDrawCancel(): void
void
onDrawingStateChanged
â–¸ onDrawingStateChanged(currentlyDrawing): void
This updates if the user started/stopped drawing a wall
void
onDuplicateExternalObjectGroup
â–¸ onDuplicateExternalObjectGroup(sourceGroupId, newGroupPosition): void
documented in interface ExternalObjectUiCallback
void
Implementation of
ExternalObjectUiCallback.onDuplicateExternalObjectGroup
onExternalObjectAttributeChanged
â–¸ onExternalObjectAttributeChanged(groupId, moduleIds, attributeId, value): void
documented in interface ExternalObjectUiCallback
void
Implementation of
ExternalObjectUiCallback.onExternalObjectAttributeChanged
onExternalObjectEnvironmentChanged
â–¸ onExternalObjectEnvironmentChanged(affectedGroupIds): void
documented in interface ExternalObjectUiCallback
void
Implementation of
ExternalObjectUiCallback.onExternalObjectEnvironmentChanged
onExternalObjectGroupArrangementChanged
â–¸ onExternalObjectGroupArrangementChanged(changedGroup): void
documented in interface ExternalObjectUiCallback
void
Implementation of
ExternalObjectUiCallback.onExternalObjectGroupArrangementChanged
onExternalObjectGroupChanged
â–¸ onExternalObjectGroupChanged(stringifiedGroupData): void
documented in interface ExternalObjectUiCallback
void
Implementation of
ExternalObjectUiCallback.onExternalObjectGroupChanged
onExternalObjectGroupLoaded
â–¸ onExternalObjectGroupLoaded(stringifiedGroupData): void
documented in interface ExternalObjectUiCallback
void
Implementation of
ExternalObjectUiCallback.onExternalObjectGroupLoaded
onExternalObjectModuleSelected
â–¸ onExternalObjectModuleSelected(groupId, rootModuleId, subModuleId): void
documented in interface ExternalObjectUiCallback
void
Implementation of
ExternalObjectUiCallback.onExternalObjectModuleSelected
onExternalObjectSelectionCancel
â–¸ onExternalObjectSelectionCancel(reason): void
documented in interface ExternalObjectUiCallback
why the selection was canceled
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.
An array of objects, each representing the area and related data for each room within the floor plan.
void
onGetConfigurationForExternalObject
â–¸ onGetConfigurationForExternalObject(_rootModuleId): Promise<ExternalObjectGroup>
documented in interface ExternalObjectUiCallback
Promise<ExternalObjectGroup>
Implementation of
ExternalObjectUiCallback.onGetConfigurationForExternalObject
onHandlerSwitchedPlans
â–¸ onHandlerSwitchedPlans(): void
void
onHistoryChange
â–¸ onHistoryChange(undo, redo): void
gets called if history changes
void
â–¸ onItemsLoaded(): void
void
onMeasurementLineStateChange
â–¸ onMeasurementLineStateChange(isActive): void
void
onMergeExternalObjectGroup
â–¸ onMergeExternalObjectGroup(targetGroup, idsOfGroupsMerged, idOfTargetRootModule): void
documented in interface ExternalObjectUiCallback
void
Implementation of
ExternalObjectUiCallback.onMergeExternalObjectGroup
onMovedExternalObjectGroup
â–¸ onMovedExternalObjectGroup(group): void
documented in interface ExternalObjectUiCallback
void
Implementation of
ExternalObjectUiCallback.onMovedExternalObjectGroup
onMultiSelectionChange
â–¸ onMultiSelectionChange(selectedElements): void
void
â–¸ onPlanChanged(): void
When something in the plan has changed
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
Enumify<{ ADDED: "added" = 'added'; CHANGED: "changed" = 'changed'; MOVED: "moved" = 'moved'; REMOVED: "removed" = 'removed' }>
void
onPlanInteractionHandlerCreated
â–¸ onPlanInteractionHandlerCreated(planInteractionHandler): void
void
onPlanSnapshotCreated
â–¸ onPlanSnapshotCreated(planId): void
Callback invoked when a plan snapshot is saved.
The ID of the plan snapshot.
void
onPlannerKernelIsReady
â–¸ onPlannerKernelIsReady(kernelContainer): void
is called when the planner kernel is ready. It returns the container and the instance
void
onReadyForRender
â–¸ onReadyForRender(): void
Deprecated
has been moved to global callbacks
is called the scene is ready for rendering it as an image
void
UiCallback.onReadyForRender
onRotationCancel
â–¸ onRotationCancel(): void
When rotation mode has been canceled
void
onSelectionCancel
â–¸ onSelectionCancel(reason): void
When an item selection has been canceled
why the selection was canceled
void
onSelectionChange
â–¸ onSelectionChange(selectionMode, objectType, payload, payloadPromise, planElementViewModel): void
When an item has been selected
currently only static items and configurations are supported
returns the data which is available immediately (sync), currently this is catalogItemId and/or configurationRuntimeId
this promise resolves when the data of an object is fetched
the plan element view model used internally, WARNING: this is a reference, use with caution
void
onSelectionModeChange
â–¸ onSelectionModeChange(mode): void
void
onSplitExternalObjectGroup
â–¸ onSplitExternalObjectGroup(originalGroup, newGroupedRootModules): void
documented in interface ExternalObjectUiCallback
void
Implementation of
ExternalObjectUiCallback.onSplitExternalObjectGroup
onStartConfiguring
â–¸ onStartConfiguring(): Promise<void>
Callback invoked when an object is started to be configured.
Promise<void>
onTotalFloorAreaChanged
â–¸ onTotalFloorAreaChanged(totalFloorArea): void
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.
constructionMeasurementsMeasurements
The measurements of construction elements.
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
measurementLineDimensions
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.
The measurements of plan element related to the walls plus object dimensions.
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
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
void
â–¸ unmute(): void
void
UiCallback.unmute
