RoomlePlannerUiCallback.default
planner-core/src/roomle-planner-ui-callback.default
Hierarchy
↳
default
Implements
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new default(creator)
Parameters
creator
string
Overrides
Properties
_creator_
• _creator_: string
Inherited from
Methods
cameraStartsMoving
▸ cameraStartsMoving(): void
Returns
void
Inherited from
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
target
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
mute
▸ mute(): void
Returns
void
Inherited from
onBackToPlanner
▸ onBackToPlanner(): Promise<void>
Callback invoked when configuration is finished.
Returns
Promise<void>
onCameraChanged
▸ onCameraChanged(type): void
Parameters
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
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
kernelContainer
kernelInstance
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
context
Returns
void
onDeleteExternalObjectGroup
▸ onDeleteExternalObjectGroup(groupIdToDelete): void
documented in interface ExternalObjectUiCallback
Parameters
groupIdToDelete
string
Returns
void
Implementation of
ExternalObjectUiCallback.onDeleteExternalObjectGroup
onDeleteExternalObjectRootModule
▸ onDeleteExternalObjectRootModule(_remainingGroup, _rootModuleIdToDelete, _splitOffGroups?): void
documented in interface ExternalObjectUiCallback
Parameters
_remainingGroup
_rootModuleIdToDelete
string
_splitOffGroups?
Returns
void
Implementation of
ExternalObjectUiCallback.onDeleteExternalObjectRootModule
onDeleteExternalObjectSubModule
▸ onDeleteExternalObjectSubModule(rootModuleId, subModuleIdToDelete): void
documented in interface ExternalObjectUiCallback
Parameters
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(): 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
currentlyDrawing
boolean
Returns
void
onDuplicateExternalObjectGroup
▸ onDuplicateExternalObjectGroup(sourceGroupId, newGroupPosition): void
documented in interface ExternalObjectUiCallback
Parameters
sourceGroupId
string
newGroupPosition
Returns
void
Implementation of
ExternalObjectUiCallback.onDuplicateExternalObjectGroup
onExternalObjectAttributeChanged
▸ onExternalObjectAttributeChanged(rootModuleId, subModuleId, attributeId, value): void
documented in interface ExternalObjectUiCallback
Parameters
rootModuleId
string
subModuleId
string
attributeId
string
value
string
Returns
void
Implementation of
ExternalObjectUiCallback.onExternalObjectAttributeChanged
onExternalObjectEnvironmentChanged
▸ onExternalObjectEnvironmentChanged(affectedGroupIds): void
documented in interface ExternalObjectUiCallback
Parameters
affectedGroupIds
string[]
Returns
void
Implementation of
ExternalObjectUiCallback.onExternalObjectEnvironmentChanged
onExternalObjectGroupChanged
▸ onExternalObjectGroupChanged(stringifiedGroupData): void
documented in interface ExternalObjectUiCallback
Parameters
stringifiedGroupData
string
Returns
void
Implementation of
ExternalObjectUiCallback.onExternalObjectGroupChanged
onExternalObjectGroupLoaded
▸ onExternalObjectGroupLoaded(stringifiedGroupData): void
documented in interface ExternalObjectUiCallback
Parameters
stringifiedGroupData
string
Returns
void
Implementation of
ExternalObjectUiCallback.onExternalObjectGroupLoaded
onExternalObjectModuleSelected
▸ onExternalObjectModuleSelected(groupId, rootModuleId, subModuleId): void
documented in interface ExternalObjectUiCallback
Parameters
groupId
string
rootModuleId
string
subModuleId
string
Returns
void
Implementation of
ExternalObjectUiCallback.onExternalObjectModuleSelected
onExternalObjectSelectionCancel
▸ onExternalObjectSelectionCancel(): void
documented in interface ExternalObjectUiCallback
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
floorAreasData
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
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
isActive
boolean
Returns
void
onMergeExternalObjectGroup
▸ onMergeExternalObjectGroup(targetGroup, sourceGroupId): void
documented in interface ExternalObjectUiCallback
Parameters
targetGroup
sourceGroupId
string
Returns
void
Implementation of
ExternalObjectUiCallback.onMergeExternalObjectGroup
onMovedExternalObjectGroup
▸ onMovedExternalObjectGroup(group): void
documented in interface ExternalObjectUiCallback
Parameters
group
Returns
void
Implementation of
ExternalObjectUiCallback.onMovedExternalObjectGroup
onMultiSelectionChange
▸ onMultiSelectionChange(selectedElements): void
Parameters
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
changeType
Enumify<{ ADDED: "added" = 'added'; CHANGED: "changed" = 'changed'; REMOVED: "removed" = 'removed' }>
changedObject
Returns
void
onPlanInteractionHandlerCreated
▸ onPlanInteractionHandlerCreated(planInteractionHandler): void
Parameters
planInteractionHandler
Returns
void
onPlanSnapshotCreated
▸ onPlanSnapshotCreated(planId): void
Callback invoked when a plan snapshot is saved.
Parameters
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
kernelContainer
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
onRotationCancel
▸ onRotationCancel(): void
When rotation mode has been canceled
Returns
void
onSelectionCancel
▸ onSelectionCancel(reason): void
When an item selection has been canceled
Parameters
reason
Returns
void
onSelectionChange
▸ onSelectionChange(selectionMode, objectType, payload, payloadPromise, planElementViewModel): void
When an item has been selected
Parameters
payload
returns the data which is available immediately (sync), currently this is catalogItemId and/or configurationRuntimeId
planElementViewModel
the plan element view model used internally, WARNING: this is a reference, use with caution
Returns
void
onSelectionModeChange
▸ onSelectionModeChange(mode): void
Parameters
mode
Returns
void
onSplitExternalObjectGroup
▸ onSplitExternalObjectGroup(originalGroup, newGroupedRootModules): void
documented in interface ExternalObjectUiCallback
Parameters
originalGroup
newGroupedRootModules
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
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
constructionMeasurementsMeasurements
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
measurementLineDimensions
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
objectMeasurements
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
planObjectPositions
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
wallDimensions
Returns
void
unmute
▸ unmute(): void
Returns
void
Inherited from
Last updated