@roomle/embedding-lib 5.34.0-alpha.1 → 5.34.0-debug.1

package/packages/web-sdk/packages/planner-core/src/roomle-planner-ui-callback.d.ts

@@ -1,249 +0,0 @@
-import { UiCallback } from '../../common-core/src/utils/ui-callback';
-import { CancelSelectionReasons, PlanInteractionHandler, PlanObjectPosition } from '../../typings/planner';
-import { ConfiguratorKernelClass, ExternalModuleInformation, KernelPlanObjectComponent, UiPlanObject } from '../../typings/kernel';
-import { PlannerKernelContainer } from '../../typings/planner-kernel-container';
-import { CAMERA_TYPE } from '../../common-core/src/cameracontrol/camera-type';
-import { SELECTION_MODE } from '../../configurator-core/src/utils/selection-handler';
-import { RapiComponent, RapiConfiguration, RapiItem } from '../../typings/rapi-types';
-import { WallDimension, WallDimensionTransferable } from './view-model/wall-plan-element-view-model';
-import { default as PlanElementViewModel } from '../../common-core/src/view-model/plan-element-view-model';
-import { Enumify } from '../../common-core/src/types';
-import { CallbackObjectType } from './utils/planner-scene-utils';
-import { ObjectMeasurementsTransferable } from '../../common-core/src/view-model/plan-object-view-model';
-import { MeasurementLineDimension, MeasurementLineDimensionTransferable } from './view-model/measurement-line-plan-element-view-model';
-import { ConstructionMeasurementsTransferable } from './utils/measurements';
-import { FloorAreaDataTransferable } from './view-model/floor-plan-element-view-model';
-import { BASE_CONTEXT } from '../../common-core/src/main';
-import { ExternalObjectGroup, ExternalObjectUiCallback } from '../../homag-intelligence/src/external-object-api-callbacks';
-
-export interface SelectionPayload {
-    item?: RapiItem;
-    configuration?: RapiConfiguration;
-    component?: RapiComponent;
-    configurationRuntimeId?: number;
-    planElementId?: number;
-    wall?: WallDimension;
-    measurementLine?: MeasurementLineDimension;
-    staticItemRuntimeId?: number;
-    externalConfigurationType?: string;
-    objectComponent?: KernelPlanObjectComponent;
-    permissionToDelete?: number;
-}
-export declare const PLAN_ELEMENT_CHANGE_TYPES: {
-    readonly ADDED: "added";
-    readonly CHANGED: "changed";
-    readonly MOVED: "moved";
-    readonly REMOVED: "removed";
-};
-export default class RoomlePlannerUiCallback extends UiCallback implements ExternalObjectUiCallback {
-    constructor(creator: string);
-    onItemsLoaded: () => void;
-    onCameraChanged: (type: Enumify<typeof CAMERA_TYPE>) => void;
-    onCameraIdle: () => void;
-    onTotalFloorAreaChanged: (totalFloorArea: number) => void;
-    onPlanInteractionHandlerCreated: (planInteractionHandler: PlanInteractionHandler) => void;
-    /**
-     * is called when the planner kernel is ready. It returns the container and the instance
-     * @param kernelContainer
-     * @param kernelInstance
-     */
-    onPlannerKernelIsReady: (kernelContainer: PlannerKernelContainer) => void;
-    /**
-     * is called when the configurator kernel is ready. It returns the container and the instance
-     * @param kernelContainer
-     * @param kernelInstance
-     */
-    onConfiguratorKernelIsReady: (kernelContainer: PlannerKernelContainer, kernelInstance: ConfiguratorKernelClass) => void;
-    /**
-     * When an item has been selected
-     * @param selectionMode
-     * @param objectType currently only static items and configurations are supported
-     * @param payload returns the data which is available immediately (sync), currently this is catalogItemId and/or configurationRuntimeId
-     * @param payloadPromise this promise resolves when the data of an object is fetched
-     * @param planElementViewModel the plan element view model used internally, WARNING: this is a reference, use with caution
-     */
-    onSelectionChange: (selectionMode: SELECTION_MODE, objectType: CallbackObjectType, payload: SelectionPayload, payloadPromise: Promise<SelectionPayload>, planElementViewModel: PlanElementViewModel) => void;
-    /**
-     * When an item selection has been canceled
-     * @param reason why the selection was canceled
-     */
-    onSelectionCancel: (reason: CancelSelectionReasons) => void;
-    /**
-     * When something in the plan has changed
-     */
-    onPlanChanged: () => 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
-     */
-    onPlanElementChanged: (changeType: Enumify<typeof PLAN_ELEMENT_CHANGE_TYPES>, changedObject: UiPlanObject) => void;
-    /**
-     * When the plan has been completely loaded
-     */
-    onCompletelyLoaded: () => void;
-    /**
-     * When rotation mode has been canceled
-     */
-    onRotationCancel: () => void;
-    /**
-     * gets called if history changes
-     * @param undo true if undo is possible
-     * @param redo true if redo is possible
-     */
-    onHistoryChange: (undo: boolean, redo: boolean) => void;
-    /**
-     * This function gets called when the camera is no longer moving
-     * and the position of the wall dimensions can be calculated
-     * @param wallDimensions
-     */
-    onUpdateWallDimensions: (wallDimensions: WallDimensionTransferable[]) => void;
-    /**
-     * This function gets called when the camera is no longer moving
-     * and the position of the measurement line dimensions can be calculated
-     * @param measurementLineDimensions
-     */
-    onUpdateMeasurementLineDimensions: (measurementLineDimensions: MeasurementLineDimensionTransferable[]) => 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.
-     * @param constructionMeasurementsMeasurements The measurements of construction elements.
-     */
-    onUpdateConstructionElementsMeasurements: (constructionMeasurementsMeasurements: ConstructionMeasurementsTransferable) => 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.
-     * @param objectMeasurements The measurements of plan element related to the walls plus object dimensions.
-     */
-    onUpdateObjectMeasurements: (objectMeasurements: ObjectMeasurementsTransferable) => void;
-    /**
-     * This function gets called when the camera is moving and thus the wall dimensions should not be shown
-     */
-    disableWallDimensions: () => 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
-     * @param planObjectPositions
-     */
-    onUpdatePlanObjectPositions: (planObjectPositions: PlanObjectPosition[]) => void;
-    onDrawCancel: () => void;
-    /**
-     * This updates if the user started/stopped drawing a wall
-     * @param currentlyDrawing
-     */
-    onDrawingStateChanged: (currentlyDrawing: boolean) => void;
-    onHandlerSwitchedPlans: () => void;
-    /**
-     * This function gets called when a movable element begins to be dragged
-     * @param planElementId current id of the dragged element
-     */
-    onDragElementStart: (planElementId: number) => void;
-    /**
-     * This function gets called when a movable element was being dragged before and is now released
-     */
-    onDragElementEnd: () => 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
-     * @param planElement PlanElementViewModel instance of the clicked element
-     */
-    onClickElement: (planElement: PlanElementViewModel) => void;
-    onMultiSelectionChange: (selectedElements: PlanElementViewModel[]) => void;
-    onSelectionModeChange: (mode: SELECTION_MODE) => void;
-    onMeasurementLineStateChange: (isActive: boolean) => 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.
-     * @param floorAreasData An array of objects, each representing the area and related data for each room within the floor plan.
-     */
-    onFloorPlanAreasUpdated: (floorAreasData: FloorAreaDataTransferable[]) => void;
-    /**
-     * Callback invoked when the selection of a component has been canceled.
-     */
-    onComponentSelectionCancel: () => void;
-    /**
-     * Callback invoked when a plan snapshot is saved.
-     * @param planId The ID of the plan snapshot.
-     */
-    onPlanSnapshotCreated: (planId: string) => void;
-    /**
-     * Callback invoked when an object is started to be configured.
-     */
-    onStartConfiguring: () => Promise<void>;
-    /**
-     * Callback invoked when configuration is finished.
-     */
-    onBackToPlanner: () => Promise<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
-     * @param context
-     */
-    onContextChanged: (context: BASE_CONTEXT) => void;
-    /**
-     * documented in interface ExternalObjectUiCallback
-     */
-    onMergeExternalObjectGroup: (targetGroup: ExternalObjectGroup, idsOfGroupsMerged: string | string[], idOfTargetRootModule: string) => void;
-    /**
-     * documented in interface ExternalObjectUiCallback
-     */
-    onSplitExternalObjectGroup: (originalGroup: ExternalObjectGroup, newGroupedRootModules: ExternalObjectGroup | ExternalObjectGroup[]) => void;
-    /**
-     * documented in interface ExternalObjectUiCallback
-     */
-    onExternalObjectGroupArrangementChanged: (changedGroup: ExternalObjectGroup) => void;
-    /**
-     * documented in interface ExternalObjectUiCallback
-     */
-    onDeleteExternalObjectGroup: (groupIdToDelete: string) => void;
-    /**
-     * documented in interface ExternalObjectUiCallback
-     */
-    onDeleteExternalObjectRootModule: (_remainingGroup: ExternalObjectGroup, _rootModuleIdToDelete: string, _splitOffGroups?: ExternalObjectGroup[]) => void;
-    /**
-     * documented in interface ExternalObjectUiCallback
-     */
-    onDeleteExternalObjectSubModule: (rootModuleId: string, subModuleIdToDelete: string) => void;
-    /**
-     * documented in interface ExternalObjectUiCallback
-     */
-    onDuplicateExternalObjectGroup: (sourceGroupId: string, duplicatedGroup: ExternalObjectGroup) => void;
-    /**
-     * documented in interface ExternalObjectUiCallback
-     */
-    onChangedExternalObjectGroupPlan: (group: ExternalObjectGroup) => void;
-    /**
-     * documented in interface ExternalObjectUiCallback
-     */
-    onMovedExternalObjectGroup: (group: ExternalObjectGroup) => void;
-    /**
-     * documented in interface ExternalObjectUiCallback
-     */
-    onExternalObjectEnvironmentChanged: (affectedGroupIds: string[]) => void;
-    /**
-     * documented in interface ExternalObjectUiCallback
-     */
-    onExternalObjectGroupChanged: (stringifiedGroupData: string) => void;
-    /**
-     * documented in interface ExternalObjectUiCallback
-     */
-    onExternalObjectGroupLoaded: (stringifiedGroupData: string) => void;
-    /**
-     * documented in interface ExternalObjectUiCallback
-     */
-    onExternalObjectAttributeChanged: (groupId: string, moduleIds: string | ExternalModuleInformation[] | null, attributeId: string, value: string) => void;
-    /**
-     * documented in interface ExternalObjectUiCallback
-     */
-    onExternalObjectModuleSelected: (groupId: string, rootModuleId: string | null, subModuleId: string | null) => void;
-    /**
-     * documented in interface ExternalObjectUiCallback
-     * @param reason why the selection was canceled
-     */
-    onExternalObjectSelectionCancel: (reason: CancelSelectionReasons) => void;
-    /**
-     * documented in interface ExternalObjectUiCallback
-     */
-    onGetConfigurationForExternalObject: (_rootModuleId: string) => Promise<ExternalObjectGroup | null>;
-}