RoomlePlannerUiCallback.default
planner-core/src/roomle-planner-ui-callback.default
Hierarchy
↳
default
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new default(creator
)
Parameters
Name | Type |
---|---|
|
|
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
Parameters
Name | Type |
---|---|
| |
| keyof |
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
mute
▸ mute(): void
Returns
void
Inherited from
onCameraChanged
▸ onCameraChanged(type
): void
Parameters
Name | Type |
---|---|
|
|
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 |
---|---|---|
| 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 |
---|---|
| |
|
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
Name | Type |
---|---|
|
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 |
---|---|
|
|
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 |
---|---|---|
| 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 |
---|---|---|
|
| true if undo is possible |
|
| true if redo is possible |
Returns
void
onItemsLoaded
▸ onItemsLoaded(): void
Returns
void
onMeasurementLineStateChange
▸ onMeasurementLineStateChange(isActive
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
onMultiSelectionChange
▸ onMultiSelectionChange(selectedElements
): void
Parameters
Name | Type |
---|---|
|
|
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 |
---|---|
|
|
|
Returns
void
onPlanInteractionHandlerCreated
▸ onPlanInteractionHandlerCreated(planInteractionHandler
): void
Parameters
Name | Type |
---|---|
|
Returns
void
onPlannerKernelIsReady
▸ onPlannerKernelIsReady(kernelContainer
): void
is called when the planner kernel is ready. It returns the container and the instance
Parameters
Name | Type |
---|---|
|
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 |
---|---|
|
Returns
void
onSelectionChange
▸ onSelectionChange(selectionMode
, objectType
, payload
, payloadPromise
, planElementViewModel
): void
When an item has been selected
Parameters
Name | Type | Description |
---|---|---|
| ||
| 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 |
Returns
void
onSelectionModeChange
▸ onSelectionModeChange(mode
): void
Parameters
Name | Type |
---|---|
|
Returns
void
onTotalFloorAreaChanged
▸ onTotalFloorAreaChanged(totalFloorArea
): void
Parameters
Name | Type |
---|---|
|
|
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 |
---|---|---|
| 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 |
---|---|
|
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 |
---|---|---|
| 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 |
---|---|
|
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 |
---|---|
|
Returns
void
unmute
▸ unmute(): void
Returns
void
Inherited from
Last updated