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