@roomle/web-sdk 2.94.0 → 2.95.1

package/lib/definitions/packages/planner-core/src/utils/planner-scene-manager.d.ts

@@ -3,5 +3,5 @@ import type { PlanObjectPosition } from '../../../typings/planner';
 import type { Camera } from 'three';
 import type PlanElementViewModel from '../../../common-core/src/view-model/plan-element-view-model';
 export declare const createTransferableObjectPosition: (planViewModel: PlanObjectViewModel | PlanElementViewModel, camera: Camera, clientWidth: number, clientHeight: number) => PlanObjectPosition;
-export type CallbackObjectType = 'static' | 'configuration' | 'wall' | 'measure' | 'door' | 'floor' | 'window' | 'unknown';
+export type CallbackObjectType = 'static' | 'configuration' | 'wall' | 'measure' | 'attic' | 'door' | 'floor' | 'window' | 'unknown' | 'external-configuration';
 export declare const getCallbackObjectType: (planElementViewModel: PlanElementViewModel) => CallbackObjectType;

package/lib/definitions/packages/planner-core/src/view-model/plan-view-model.d.ts

@@ -17,10 +17,12 @@ import type { Mesh } from 'three';
 import { Box3, Group } from 'three';
 import ConstructionPlanObjectViewModel from './construction-plan-object-view-model';
 import MeasurementLinePlanElementViewModel from './measurement-line-plan-element-view-model';
+import WallAtticPlanElementViewModel from './wall-attic-plan-element-view-model';
 export declare const GROUP_CONSTRUCTION = "Construction";
 export declare const GROUP_CEILING = "Ceiling";
 export declare const GROUP_FLOOR = "Floor";
 export declare const GROUP_MEASUREMENT_LINE = "Measurement Line";
+export declare const GROUP_WALL_ATTICS = "Wall Attics";
 export default class PlanViewModel extends ConfiguratorViewModel implements PlannerKernelCallbackI {
     private _plannerMeshGenerator;
     private _roomlePlannerUiCallback;
@@ -31,12 +33,14 @@ export default class PlanViewModel extends ConfiguratorViewModel implements Plan
     private _constructionPlanObjectViewModels;
     private _wallPlanObjectViewModels;
     private _measurementLinePlanObjectViewModels;
+    private _wallAtticsPlanObjectViewModels;
     private _floorPlanObjectViewModels;
     private _nodePlanObjectViewModels;
     private _constructionGroup;
     private _ceilingGroup;
     private _floorGroup;
     private _measurementLineGroup;
+    private _wallAtticsGroup;
     private _plannerSceneEventHandler;
     private _cameraType;
     private _nodeZoom;
@@ -54,10 +58,12 @@ export default class PlanViewModel extends ConfiguratorViewModel implements Plan
     addPlanElementViewModel(planElementViewModel: PlanElementViewModel): void;
     private _handleConfiguratorPlanObjectViewModel;
     private _linkPlanObjectViewModelAndComponent;
+    private _detachPlanObjectViewModelFromComponent;
     private _handleConfiguratorConstructionPlanObjectViewModel;
     private _handleConstructionPlanObjectViewModel;
     private _handleStaticPlanObjectViewModel;
     private _handleMeasurementLinePlanElementViewModel;
+    private _handleWallAtticPlanElementViewModel;
     private _handleWallPlanElementViewModel;
     private _handleFloorPlanElementViewModel;
     private _handleCeilingPlanElementViewModel;
@@ -77,6 +83,7 @@ export default class PlanViewModel extends ConfiguratorViewModel implements Plan
     getCeilingGroup(): Group;
     getFloorGroup(): Group;
     getMeasurementLineGroup(): Group;
+    getWallAtticsGroup(): Group;
     getBoundingBox(): Box3;
     getBoundingBoxOfGeometry(): Box3;
     /**
@@ -101,6 +108,7 @@ export default class PlanViewModel extends ConfiguratorViewModel implements Plan
     getNodePlanObjectViewModels(): NodePlanElementViewModel[];
     getFloorPlanObjectViewModels(): FloorPlanElementViewModel[];
     getMeasurementLineObjectViewModels(): MeasurementLinePlanElementViewModel[];
+    getWallAtticsObjectViewModels(): WallAtticPlanElementViewModel[];
     protected _generateMesh(runtimeComponentId: number, geometryId: string, material: any, vertices: Float32Array, indices: Int32Array, uvCoords: Float32Array, normals: Float32Array, type?: KernelEnum, newGeometryInstance?: boolean, materialAttributes?: Record<string, string>): Mesh;
     protected _setMaterial(mesh: Mesh, material: any, _type?: KernelEnum, materialAttributes?: Record<string, string>): void;
     Editor3dComponentCreated(id: number, position: KernelVector3, eulerAngles: KernelVector3, isRootComponent: boolean, parentObjectRuntimeId: number): void;

package/lib/definitions/packages/planner-core/src/view-model/wall-attic-plan-element-view-model.d.ts

@@ -0,0 +1,9 @@
+import type { Mesh } from 'three';
+import type { KernelAttic, PlanObject } from '../../../typings/planner';
+import PlanElementViewModel from '../../../common-core/src/view-model/plan-element-view-model';
+export default class WallAtticPlanElementViewModel extends PlanElementViewModel {
+    constructor(planObject: PlanObject);
+    addMesh(mesh: Mesh): void;
+    getKernelAttic(): KernelAttic;
+    update(): void;
+}

package/lib/definitions/packages/planner-core/src/view-model/wall-plan-element-view-model.d.ts

@@ -10,12 +10,16 @@ export declare const wallDimensionToTransferable: (wallDimension: WallDimension)
 export declare const getTopViewMaterial: () => MeshPhysicalMaterial;
 export default class WallPlanElementViewModel extends PlanElementViewModel {
     private _lineForInvisibleWall?;
+    private _hasAttachedAttic;
+    private _visible;
     constructor(planObject: PlanObject);
     get isSelected(): boolean;
+    private _checkHasAttachedAttic;
     getWallDimension(zoomFactor: number, clientWidth: number, clientHeight: number): WallDimension;
     addMesh(mesh: Mesh): void;
     show(): void;
     hide(): void;
+    setContainerVisibility(isVisible: boolean): void;
     private _enableTopView;
     private _setTopMaterial;
     private _disableTopView;

package/lib/definitions/packages/planner-core/src/webgl/planner-scene-event-handler.d.ts

@@ -92,6 +92,7 @@ export default class PlannerSceneEventHandler extends SceneEventHandler<SceneEve
     addConstructionPlanObjectHandlers(planObjectViewModel: PlanObjectViewModel, object?: RoomleEventedObject3D): void;
     addPlanObjectHandlers(planObjectViewModel: PlanObjectViewModel, object?: RoomleEventedObject3D): void;
     addWallHandlers(planElementViewModel: PlanElementViewModel): void;
+    addWallAtticHandlers(planElementViewModel: PlanElementViewModel): void;
     addMeasurementLineHandlers(planElementViewModel: MeasurementLinePlanElementViewModel): void;
     addFloorHandlers(planElementViewModel: PlanElementViewModel): void;
     addNodeHandlers(planElementViewModel: PlanElementViewModel): void;

package/lib/definitions/packages/planner-core/src/webgl/planner-scene-manager.d.ts

@@ -1,6 +1,7 @@
 import type { Base64Image, CanvasOffset } from '../../../common-core/src/common-interfaces';
 import type { PlannerKernelCallbackI } from '../services/planner-kernel-access';
 import type { CancelSelectionReasons, Plan, PlanElement } from '../../../typings/planner';
+import type { KernelPlanObjectComponent } from '../../../typings/kernel';
 import { type KernelEnum, type KernelPlanObject, type KernelVector3, type RuntimeId } from '../../../typings/kernel';
 import PlannerSceneEventHandler from './planner-scene-event-handler';
 import type { BatchPaintMaterial, RoomlePlannerCallback, SceneEvents } from '../roomle-planner';
@@ -56,6 +57,7 @@ export default class PlannerSceneManager extends ConfiguratorSceneManager implem
     private _debugSpheres;
     constructor(creator: string, offset: CanvasOffset, plannerCallback: RoomlePlannerCallback, mode: Enumify<typeof CAMERA_TYPE>);
     get configuratorContext(): import("../../../common-core/src/webgl/configurator-context").default;
+    get hasSingleRoom(): boolean;
     private _activateElement;
     planCleared(): void;
     planHistoryStateChanged(): void;
@@ -205,5 +207,9 @@ export default class PlannerSceneManager extends ConfiguratorSceneManager implem
     protected setEventHandlerObject(object: Object3D): void;
     protected _readyForRender(): void;
     protected notifyPlannerOnComponentSelectionCancel(isExternalObject: boolean, reason: CancelSelectionReasons): void;
+    private _planObjectSelectionChanged;
+    highlightExternalObject(planObjectComponent: KernelPlanObjectComponent): void;
+    private _selectExternalObjectModule;
+    getObjectComponent(id: number): KernelPlanObjectComponent;
 }
 export {};

package/lib/definitions/packages/typings/kernel.d.ts

@@ -90,6 +90,20 @@ export interface KernelPartListPrice {
     totalSum: number;
     partMap: Map<PriceId, KernelPart>;
 }
+export declare const PARAMETER_VIEW_TYPE: {
+    readonly EMPTY: 0;
+    readonly TOGGLE: 1;
+    readonly IMAGELIST: 2;
+    readonly IMAGEBIG: 3;
+    readonly IMAGESMALL: 4;
+    readonly INPUTFIELD: 5;
+    readonly DROPDOWN: 6;
+    readonly SLIDER: 7;
+    readonly BUTTON: 8;
+};
+export interface KernelViewType {
+    value: Enumify<typeof PARAMETER_VIEW_TYPE>;
+}
 export interface KernelParameter {
     enabled: boolean;
     key: string;
@@ -103,6 +117,7 @@ export interface KernelParameter {
     validValues: KernelValue[];
     group: string;
     visibleInPlanner?: boolean;
+    viewType: KernelViewType;
 }
 export interface KernelParameterGroup {
     key: string;

package/lib/definitions/packages/typings/planner.d.ts

@@ -26,7 +26,7 @@ export interface Plan extends KernelObject {
     getTotalFloorArea(): number;
     getPlanXML(includeRuntimeId: boolean, xmlVersion: number /** current version is 2 */): string;
     createPlanXmlWithSingleObject(object: PlanObject, includeRuntimeId: boolean, version: number): string;
-    createPlanXmlWithSingleObjectFromId(objectId: string, includeRuntimeId: boolean, version: number): string;
+    createPlanXmlWithObjects(objectId: string | string[], includeRuntimeId: boolean, version: number): string;
     createObjWithPlanContours(levels: number[]): string;
     getWallCount(): number;
     getId(): number;
@@ -111,6 +111,7 @@ export interface WallPlanObject extends PlanObject {
     getLength(preferredSide: WallSide): number;
     getFrom(): NodePlanObject;
     getTo(): NodePlanObject;
+    getAttachedAttics(): KernelAtticArray;
     readonly thickness: number;
     readonly height: number;
 }
@@ -148,6 +149,12 @@ export declare const CORE_CHILD_ENTITY_MODE: {
 export interface ChildEntityMode {
     value: Enumify<typeof CORE_CHILD_ENTITY_MODE>;
 }
+export interface ExternalObjectLoadConfiguration {
+    applyGlobalChildMode: boolean;
+    correctArrangement: boolean;
+    findFreeSpaceInPlan: boolean;
+    isVisible: boolean;
+}
 export interface PlanInteractionHandler {
     init(reference: PlanInteractionHandler, zoomFactor: number, viewSnapDist: number, wallSnapMode: any, objectSnapMode: any, shouldSnap: boolean, drawingType: any): PlanInteractionHandler;
     getConfiguratorKernel(): ConfiguratorKernelClass;
@@ -164,7 +171,7 @@ export interface PlanInteractionHandler {
     setObjectRotation(planObject: KernelObject, angleInRad: number): void;
     addPlanObjects(list: KernelObjectPtrList, findFreeSpaceInPlan: boolean): PlanObject[];
     addPlanObjectFromItem(object: KernelObject, position: KernelVector3, type: number, findFreeSpaceInPlan: boolean): PlanObject;
-    addOrUpdateExternalPlanObjects(serialzedConfiguration: string, position: KernelVector3, rotationInRad: number, findFreeSpaceInPlan: boolean, applyGlobalChildMode: boolean, isVisible: boolean, verifyArrangement: boolean): PlanObject[];
+    addOrUpdateExternalPlanObjects(serialzedConfiguration: string | string[], position: KernelVector3, rotationInRad: number, updateConfiguration: ExternalObjectLoadConfiguration, mergedGroupIds: string | string[]): PlanObject[];
     catalogItemLoaded(catalogItem: KernelCatalogItem): void;
     removeElement(planObject: KernelObject): void;
     removeObjectWithId(objectId: string): void;
@@ -201,7 +208,7 @@ export interface PlanInteractionHandler {
     setWallHeight(wall: KernelWall, height: number): void;
     setLengthOfWall(wall: KernelWall, length: number, preferredSide: WallSide, direction: EMSConstant, moveOrthogonalWalls: boolean): void;
     setWallThickness(wall: KernelWall, thickness: number): void;
-    addAttic(wall: KernelWall, side: WallSide, kneeHeight: number, width: number): KernelAttic;
+    addAttic(wall: KernelWall, kneeHeight: number, width: number, side: WallSide | null | undefined): KernelAttic;
     setAtticSide(attic: KernelAttic, side: WallSide): void;
     setAtticKneeHeight(attic: KernelAttic, kneeHeight: number): void;
     setAtticWidth(attic: KernelAttic, width: number): void;
@@ -264,6 +271,26 @@ export interface PlanOverview {
     outsideWalls: PlanElement[];
     rooms: PlanElement[];
 }
+export interface KernelObjectConfiguration {
+    runtimeId: number;
+    serializedDefinition: string;
+    uniqueId: string;
+}
+declare class KernelObjectConfigurationArray extends EmsArray<KernelObjectConfiguration> {
+}
+export interface LightSourceConfiguration {
+    lightSourceAreaInSquareMeters: number;
+    minimumRoomSizeInSquareMeters: number;
+    maximumNumberOfLightSources: number;
+}
+export interface RoomLightSourceDistribution {
+    ceilingId: number;
+    floorId: number;
+    positionsInPlan: PointArray;
+    positionsRelativeToFloor: PointArray;
+}
+declare class RoomLightSourceDistributionArray extends EmsArray<RoomLightSourceDistribution> {
+}
 export interface PlanModelViewHelper {
     getPlanOverview(planObject: KernelObject): PlanOverview;
     getPlanObject(plan: Plan, aRuntimeId: number): KernelPlanObject;
@@ -272,6 +299,8 @@ export interface PlanModelViewHelper {
     getExternalObjectComponent(plan: Plan, groupId: string, moduleId: string): KernelPlanObjectComponent;
     getExternalComponentModuleIdsForSelection(plan: Plan, groupOrRootModuleId: string, subModuleId: string): ExternalModuleInformation;
     requestMesh3d(element: PlanElement): void;
+    getExternalObjectGroups(plan: Plan): KernelObjectConfigurationArray;
+    calculateLightSourceDistribution(plan: Plan, lightSourceConfiguration: LightSourceConfiguration): RoomLightSourceDistributionArray;
 }
 export interface PlanNode extends KernelObject {
     getMaxWallHeight(): number;
@@ -295,6 +324,9 @@ export declare const enum KernelWallType {
     InnerWall = 3
 }
 export interface KernelWall extends KernelObject {
+    getFrom(): Node;
+    getTo(): Node;
+    getAttachedAttics(): KernelAtticArray;
     readonly thickness: number;
     readonly meshThickness: number;
     readonly isVectorWall: boolean;
@@ -306,9 +338,12 @@ export interface KernelWall extends KernelObject {
     readonly rightNormal: KernelVector3;
     getAngle: () => number;
 }
+declare class KernelAtticArray extends EmsArray<KernelAttic> {
+}
 export interface KernelAttic extends KernelObject {
     getFrom(): Node;
     getTo(): Node;
+    getAssociatedWall(): KernelWall;
     get2dPolygon(): PointArray;
     getRidgePoints(): PointArray;
     getPointsWithHeight(height: number): PointArray;
@@ -327,5 +362,5 @@ export interface PlanObjectPosition {
     runtimeId: RuntimeId;
     position2d: Position2;
 }
-export type CancelSelectionReasons = 'swap_object' | 'click_outside' | 'select_other' | 'double_click_wall' | 'unknown' | 'dock_component' | 'delete_object' | 'selection_mode_changed';
+export type CancelSelectionReasons = 'swap_object' | 'dragIn' | 'click_outside' | 'select_other' | 'double_click_wall' | 'unknown' | 'dock_component' | 'delete_object' | 'selection_mode_changed' | 'dock_preview' | 'reset_scene' | 'delete_component' | 'isolation_mode_cancelled' | 'isolation_mode_started' | 'duplicate' | 'undo' | 'redo';
 export {};

package/lib/definitions/planner-core/src/camera-control/camera-control-first-person.d.ts

@@ -14,6 +14,7 @@ export default class CameraControlFirstPerson extends CameraControl {
     minPolarAngle: number;
     maxPolarAngle: number;
     constructor(creator: string, inputManager: InputManager, initialCameraParameters?: CameraParameter, camera?: PerspectiveCamera);
+    setUp(): void;
     private _gamepadConnected;
     private _gamepadDisconnected;
     private startButtonPressListener;

package/lib/definitions/planner-core/src/external-object-api-callbacks.d.ts

@@ -1,23 +1,30 @@
 import type { CancelSelectionReasons } from '../../typings/planner';
-export interface ExternalObjectGroupPosition {
-    pos: number[];
-    rotation?: number;
+export interface ExternalObjectSegment {
+    cmd: string;
+    x: number;
+    y: number;
+    type: string;
 }
-export interface ExternalObjectGroup {
-    groupId: string;
+export interface ExternalObjectContour {
+    level: number;
+    segments: ExternalObjectSegment[];
+}
+export interface ExternalObjectGroupPosition {
     pos: number[];
     rotation?: number;
+    contours?: ExternalObjectContour[];
 }
 export interface ExternalObjectRootModule {
     moduleId: string;
     pos: number[];
     rotation?: number;
 }
-export interface ExternalObjectGroupAndModules {
+export interface ExternalObjectGroup {
     groupId?: string;
     pos: number[];
     rotation?: number;
-    rootModules: ExternalObjectRootModule[];
+    rootModules?: ExternalObjectRootModule[];
+    contours?: ExternalObjectContour[];
 }
 export interface ExternalObjectUiCallback {
     /** "onMergeExternalObjectGroup" is invoked when a group of root modules is merged into another group of root modules.
@@ -27,8 +34,9 @@ export interface ExternalObjectUiCallback {
      * "idsOfGroupsMerged" are the IDs of the groups whose modules must be merged into the target group and therefore the groups that must be deleted.
      * @param targetGroup The target group of root modules.
      * @param idsOfGroupsMerged The IDs of the groups merged into the target group.
+     * @param idOfTargetRootModule The ID of the root module which is the target of the merge operation.
      */
-    onMergeExternalObjectGroup(targetGroup: ExternalObjectGroupAndModules, idsOfGroupsMerged: string | string[]): void;
+    onMergeExternalObjectGroup(targetGroup: ExternalObjectGroup, idsOfGroupsMerged: string | string[], idOfTargetRootModule: string): void;
     /**
      * "onSplitExternalObjectGroup" is invoked when one or more root modules are split from a group of root modules.
      * The split root modules form a new group, which must be assigned a new ID.
@@ -37,13 +45,13 @@ export interface ExternalObjectUiCallback {
      * @param splitGroup The original group of root modules.
      * @param newGroupedRootModules The new group of root modules.
      */
-    onSplitExternalObjectGroup(splitGroup: ExternalObjectGroupAndModules, newGroupedRootModules: ExternalObjectGroupAndModules | ExternalObjectGroupAndModules[]): void;
+    onSplitExternalObjectGroup(splitGroup: ExternalObjectGroup, newGroupedRootModules: ExternalObjectGroup | ExternalObjectGroup[]): void;
     /**
      * "onExternalObjectGroupArrangementChanged" is invoked when the arrangement (position and rotation) of the root modules of a group has changed .
      * "changedGroup" contains the information about the root modules of the group.
      * @param changedGroup The new arranged group and its root modules .
      */
-    onExternalObjectGroupArrangementChanged(changedGroup: ExternalObjectGroupAndModules): void;
+    onExternalObjectGroupArrangementChanged(changedGroup: ExternalObjectGroup): void;
     /**
      * "onDeleteExternalObjectGroup" is invoked when a group of root modules and all the root modules it contains are deleted.
      * The group with the ID "groupIdToDelete" is removed from the plan and is completely deleted.
@@ -62,7 +70,7 @@ export interface ExternalObjectUiCallback {
      * @param rootModuleIdToDelete The ID of the root module.
      * @param splitGroups The new groups of root modules that have been split off.
      */
-    onDeleteExternalObjectRootModule(remainingGroup: ExternalObjectGroupAndModules, rootModuleIdToDelete: string, splitOffGroups?: ExternalObjectGroupAndModules[]): void;
+    onDeleteExternalObjectRootModule(remainingGroup: ExternalObjectGroup, rootModuleIdToDelete: string, splitOffGroups?: ExternalObjectGroup[]): void;
     /**
      * "onDeleteExternalObjectSubModule" is invoked when a sub module is deleted from a root module.
      * The sub module with the ID "subModuleIdToDelete" is removed from the root module with the ID "rootModuleId"
@@ -81,10 +89,16 @@ export interface ExternalObjectUiCallback {
      */
     onDuplicateExternalObjectGroup(sourceGroupId: string, newGroupPosition: ExternalObjectGroupPosition): void;
     /**
-     * “onMovedExternalObjectGroup” is invoked when a group of root modules is moved or rotated to a new position.
+     * “onChangedExternalObjectGroupPlan” is invoked when a group of root modules is moved or rotated to a new position
+     * or when the plan itself is changed.
      * The group with the ID "group.id" is moved to the new position and orientation defined in "group".
      * @param group The group of root modules.
      */
+    onChangedExternalObjectGroupPlan(group: ExternalObjectGroup): void;
+    /**
+     * @deprecated and replaced by “onChangedExternalObjectGroupPlan”.
+     * @param group The group of root modules.
+     */
     onMovedExternalObjectGroup(group: ExternalObjectGroup): void;
     /**
      * "onExternalObjectEnvironmentChanged" is invoked when the plan (walls, doors, windows, etc.) has changed.

package/lib/definitions/planner-core/src/external-object-api.d.ts

@@ -1,4 +1,5 @@
 export interface ExternalObjectUiConfiguration {
+    userRight?: string;
     attributeGroupsVisibleInPlanner?: string | string[];
     showPossibleSubModules?: boolean;
     animatedOpenClose?: boolean;
@@ -45,20 +46,22 @@ export interface ExternalObjectAPI {
      * @param groupJson The group JSON as string or object.
      * @param findFreeSpaceInPlan A free space is automatically searched for in the plane.
      * @param verifyArrangement Verify whether the root modules of the group need to be rearranged as they have changed in size.
+     * @param mergedGroups Groups that were merged into another group and have to be delete (this is required to generate correct undo/redo steps).
      */
-    loadExternalObjectGroup(groupJson: string | object, findFreeSpaceInPlan: boolean, verifyArrangement?: boolean): Promise<void>;
+    loadExternalObjectGroup(groupJson: object | string | string[], findFreeSpaceInPlan: boolean, verifyArrangement?: boolean, mergedGroups?: string[]): Promise<void>;
     /**
      * "renderImagesOfExternalObjectGroups" renders images of groups of modules.
      * @param groupJson The group JSON as string or object.
      */
-    renderImagesOfExternalObjectGroup(groupsJson: string | object): Promise<{
+    renderImagesOfExternalObjectGroup(groupsJson: object): Promise<{
         [key: string]: string;
     }>;
     /**
      * "removeExternalObjectGroup" removes a group and all its modules from the plan.
      * @param groupId The ID of the group of modules.
+     * @param wasMerged Should be set to true if the group has been merged with another group (this is required to generate correct undo/redo steps).
      */
-    removeExternalObjectGroup(groupId: string): Promise<void>;
+    removeExternalObjectGroup(groupId: string, wasMerged: boolean): Promise<void>;
     /**
      * "removeExternalObjectRootModule" removes a root module from a group and splits the remaining group if the removed root module is located between other root modules.
      * If the group consists of only one root module, the group is removed.
@@ -95,5 +98,9 @@ export interface ExternalObjectAPI {
      * @param animate If true the opening or closing is animated else the geometry is switched instantly.
      */
     openOrCloseGeometryOfExternalObject(groupIdOrRootModuleId: string, subModuleId: string | null, open: boolean, animate: boolean): Promise<void>;
+    /**
+     * "getExternalObjectGroups" returns all groups of external objects modules (PosData) that are currently loaded in the plan.
+     */
+    getExternalObjectGroups(): Promise<object[]>;
 }
 export declare const getDefaultExternalObjectApiConfiguration: () => Promise<ExternalObjectApiConfiguration>;

package/lib/definitions/planner-core/src/roomle-planner-ui-callback.d.ts

@@ -14,7 +14,7 @@ import type { MeasurementLineDimension, MeasurementLineDimensionTransferable } f
 import type { ConstructionMeasurementsTransferable } from './utils/measurements';
 import type { FloorAreaDataTransferable } from './view-model/floor-plan-element-view-model';
 import { type BASE_CONTEXT } from '../../common-core/src/main';
-import type { ExternalObjectGroup, ExternalObjectGroupAndModules, ExternalObjectGroupPosition, ExternalObjectUiCallback } from './external-object-api-callbacks';
+import type { ExternalObjectGroup, ExternalObjectGroupPosition, ExternalObjectUiCallback } from './external-object-api-callbacks';
 export interface SelectionPayload {
     item?: RapiItem;
     configuration?: RapiConfiguration;
@@ -24,6 +24,7 @@ export interface SelectionPayload {
     wall?: WallDimension;
     measurementLine?: MeasurementLineDimension;
     staticItemRuntimeId?: number;
+    externalConfigurationType?: string;
 }
 export declare const PLAN_ELEMENT_CHANGE_TYPES: {
     readonly ADDED: "added";
@@ -179,15 +180,15 @@ export default class RoomlePlannerUiCallback extends UiCallback implements Exter
     /**
      * documented in interface ExternalObjectUiCallback
      */
-    onMergeExternalObjectGroup: (targetGroup: ExternalObjectGroupAndModules, idsOfGroupsMerged: string | string[]) => void;
+    onMergeExternalObjectGroup: (targetGroup: ExternalObjectGroup, idsOfGroupsMerged: string | string[], idOfTargetRootModule: string) => void;
     /**
      * documented in interface ExternalObjectUiCallback
      */
-    onSplitExternalObjectGroup: (originalGroup: ExternalObjectGroupAndModules, newGroupedRootModules: ExternalObjectGroupAndModules | ExternalObjectGroupAndModules[]) => void;
+    onSplitExternalObjectGroup: (originalGroup: ExternalObjectGroup, newGroupedRootModules: ExternalObjectGroup | ExternalObjectGroup[]) => void;
     /**
      * documented in interface ExternalObjectUiCallback
      */
-    onExternalObjectGroupArrangementChanged: (changedGroup: ExternalObjectGroupAndModules) => void;
+    onExternalObjectGroupArrangementChanged: (changedGroup: ExternalObjectGroup) => void;
     /**
      * documented in interface ExternalObjectUiCallback
      */
@@ -195,7 +196,7 @@ export default class RoomlePlannerUiCallback extends UiCallback implements Exter
     /**
      * documented in interface ExternalObjectUiCallback
      */
-    onDeleteExternalObjectRootModule: (_remainingGroup: ExternalObjectGroupAndModules, _rootModuleIdToDelete: string, _splitOffGroups?: ExternalObjectGroupAndModules[]) => void;
+    onDeleteExternalObjectRootModule: (_remainingGroup: ExternalObjectGroup, _rootModuleIdToDelete: string, _splitOffGroups?: ExternalObjectGroup[]) => void;
     /**
      * documented in interface ExternalObjectUiCallback
      */
@@ -204,6 +205,10 @@ export default class RoomlePlannerUiCallback extends UiCallback implements Exter
      * documented in interface ExternalObjectUiCallback
      */
     onDuplicateExternalObjectGroup: (sourceGroupId: string, newGroupPosition: ExternalObjectGroupPosition) => void;
+    /**
+     * documented in interface ExternalObjectUiCallback
+     */
+    onChangedExternalObjectGroupPlan: (group: ExternalObjectGroup) => void;
     /**
      * documented in interface ExternalObjectUiCallback
      */

package/lib/definitions/planner-core/src/roomle-planner.d.ts

@@ -6,7 +6,7 @@ import type { Configurator } from '../../configurator-core/src/configurator';
 import type { GlobalInitDataDefinition, InitDataDefinition } from '../../common-core/src/utils/shims';
 import type { ConfigurationString, RapiConfiguration, RapiId, RapiItem, RapiPlan, RapiPlanSnapshotGetData } from '../../typings/rapi-types';
 import type { Context } from '../../common-core/src/di/context';
-import type { CancelSelectionReasons, KernelObject, KernelWall, PlanInteractionHandler, PlanModelViewHelper, PlanOverview } from '../../typings/planner';
+import { type CancelSelectionReasons, type KernelObject, type KernelWall, type PlanInteractionHandler, type PlanModelViewHelper, type PlanOverview } from '../../typings/planner';
 import type { KernelAccessCallbackI } from '../../common-core/src/kernel-access-callback';
 import type InitData from '../../common-core/src/utils/init-data';
 import type { CanvasOffset, Position3 } from '../../common-core/src/common-interfaces';
@@ -20,7 +20,7 @@ import type { CameraParameter } from '../../common-core/src/cameracontrol/camera
 import type PlanElementViewModel from '../../common-core/src/view-model/plan-element-view-model';
 import type WallPlanElementViewModel from './view-model/wall-plan-element-view-model';
 import type ConfiguratorContext from '../../common-core/src/webgl/configurator-context';
-import type { PlanObject } from '../../typings/planner';
+import type { KernelAttic, PlanObject, WallSide } from '../../typings/planner';
 import type IdbManager from '../../common-core/src/services/idb-manager';
 import type { ExternalObjectAPI, ExternalObjectApiConfiguration } from './external-object-api';
 import type { GlobalCallback } from '../../common-core/src/services/global-callback';
@@ -28,7 +28,7 @@ export type ID_TYPE = 'rml_id' | 'tc_id' | 'rml_serialized' | 'tc_serialized';
 export interface RoomlePlannerCallback {
     switchToConfigurator: () => Promise<Configurator>;
     switchToViewer: () => Promise<GlbViewer>;
-    cancelSelection: () => void;
+    cancelSelection: (reason: CancelSelectionReasons) => void;
     deleteSelection: () => void;
     rotateSelection: (rotateBy: number) => void;
 }
@@ -158,6 +158,11 @@ export default class RoomlePlanner implements KernelAccessCallbackI, RoomlePlann
     update(): void;
     get callbacks(): RoomlePlannerUiCallback;
     set callbacks(callback: RoomlePlannerUiCallback);
+    /**
+     * Check if the 3D scene contains only one room
+     * @returns {boolean} True if there is only one room, false otherwise
+     */
+    get hasSingleRoom(): boolean;
     showStats(): void;
     onCloseHSC(): void;
     back(): void;
@@ -376,14 +381,19 @@ export default class RoomlePlanner implements KernelAccessCallbackI, RoomlePlann
     resolveShortUrl(shortUrl: string): Promise<string>;
     enableEvents(): void;
     disableEvents(): void;
+    downloadHomagIxExportPoC(): Promise<any>;
     configureExternalObjectApi(configurationJson: string | ExternalObjectApiConfiguration): Promise<void>;
     loadExternalObjectLibrary(libraryJson: string | object): void;
-    loadExternalObjectGroup(groupJson: string | object, findFreeSpaceInPlan: boolean, verifyArrangement?: boolean): Promise<void>;
+    loadExternalObjectGroup(groupData: object | string | string[], findFreeSpaceInPlan: boolean, verifyArrangement?: boolean, mergedGroups?: string[]): Promise<void>;
     private _loadExternalObjectGroup;
-    renderImagesOfExternalObjectGroup(groupsJson: string | object): Promise<{
+    private _loadExternalObjectGroupInConfigurator;
+    private _loadExternalObjectGroupInPlanner;
+    private _loadOrUpdateExternalObjectGroup;
+    private _createSerializedGroupCollection;
+    renderImagesOfExternalObjectGroup(groups: object): Promise<{
         [key: string]: string;
     }>;
-    removeExternalObjectGroup(groupId: string): Promise<void>;
+    removeExternalObjectGroup(groupId: string, wasMerged?: boolean): Promise<void>;
     removeExternalObjectRootModule(rootModuleId: string): void;
     selectExternalObjectGroup(groupId: string): Promise<void>;
     selectExternalObjectRootModule(rootModuleId: string): Promise<void>;
@@ -391,10 +401,56 @@ export default class RoomlePlanner implements KernelAccessCallbackI, RoomlePlann
     openOrCloseGeometryOfExternalObject(groupIdOrRootModuleId: string, subModuleId: string | null, open: boolean, animate: boolean): Promise<void>;
     private _selectKernelComponent;
     _selectExternalObjectGroup(groupId: string, switchToPlanner: boolean): Promise<void>;
-    _selectExternalObjectModule(rootModuleId: string, subModuleId: string | null, selectPlanObject: boolean, switchToConfigurator: boolean, selectComponent: boolean): Promise<void>;
+    _selectExternalObjectModule(rootModuleId: string, subModuleId: string | null, selectPlanObject: boolean, switchToConfigurator: boolean, selectComponent: boolean, highlightSelection: boolean): Promise<void>;
+    private _selectPlanObject;
+    private _getSelectedPlanObjectComponent;
+    getExternalObjectGroups(): Promise<object[]>;
     /**
      * @internal
      * Use this callbacks to hook in your functionality
      */
     get globalCallbacks(): GlobalCallback;
+    /**
+     * Handles interaction with the planner kernel, ensuring start and end interaction are tracked.
+     * @param action A function representing the action to perform.
+     * @returns The result of the action, if any.
+     */
+    private _executeWithInteraction;
+    /**
+     * Creates a sloping roof attic on a given wall.
+     * @param wall The wall to add an attic to.
+     * @param kneeHeight Height of the attic knee wall.
+     * @param width Width of the sloping roof.
+     * @param preferredSide The side where the attic should be added.
+     * @returns The newly created attic.
+     */
+    addAtticToWall(wall: KernelWall, kneeHeight: number, width: number, preferredSide?: WallSide): KernelAttic | null;
+    /**
+     * Removes an attic from a wall.
+     * @param attic The attic to be removed.
+     */
+    removeAttic(attic: KernelAttic): void;
+    /**
+     * Set the attic direction from a wall.
+     * @param attic The attic to be removed.
+     */
+    setAtticSide(attic: KernelAttic, side: WallSide): void;
+    /**
+     * Gets the attached attic from a wall.
+     * @param wall The wall to retrieve the attic from.
+     * @returns The first attached attic or null.
+     */
+    getAttachedAttic(wall: KernelWall): KernelAttic | null;
+    /**
+     * Updates the knee height of an attic.
+     * @param attic The attic to update.
+     * @param kneeHeight The new knee height value.
+     */
+    updateAtticKneeHeight(attic: KernelAttic, kneeHeight: number): void;
+    /**
+     * Updates the width of an attic.
+     * @param attic The attic to update.
+     * @param width The new width value.
+     */
+    updateAtticWidth(attic: KernelAttic, width: number): void;
 }

package/lib/definitions/planner-core/src/services/planner-kernel-access.d.ts

@@ -6,7 +6,7 @@ import type RoomlePlannerUiCallback from '../roomle-planner-ui-callback';
 import type PlanElementViewModel from '../../../common-core/src/view-model/plan-element-view-model';
 import type { Position3 } from '../../../common-core/src/common-interfaces';
 import ConfiguratorKernelAccess from '../../../common-core/src/configurator-kernel-access';
-import type { ExternalObjectGroup, ExternalObjectGroupAndModules, ExternalObjectGroupPosition } from '../external-object-api-callbacks';
+import type { ExternalObjectGroup, ExternalObjectGroupPosition } from '../external-object-api-callbacks';
 export interface PlannerKernelCallbackI {
     handlerSwitchedPlans(fromPlan: Plan, toPlan: Plan): void;
     planCompletelyLoaded(plan: Plan): void;
@@ -67,12 +67,12 @@ export default class PlannerKernelAccess extends ConfiguratorKernelAccess {
     externalObjectConfigurationChanged(plan: Plan, planObject: PlanObject, configuration: string): void;
     externalObjectConfigurationLoaded(plan: Plan, planObject: PlanObject, configuration: string): void;
     externalObjectConfigurationDeleted(plan: Plan, planObject: PlanObject, uniqueId: string): void;
-    externalObjectComponentDeleted(plan: Plan, planObject: PlanObject, remainingGroupOrGroups: ExternalObjectGroupAndModules | ExternalObjectGroupAndModules[], deletedRootModuleId: string): void;
+    externalObjectComponentDeleted(plan: Plan, planObject: PlanObject, remainingGroupOrGroups: ExternalObjectGroup | ExternalObjectGroup[], deletedRootModuleId: string): void;
     externalObjectConfigurationDuplicated(plan: Plan, planObject: PlanObject, sourceGroupId: string, newGroupPosition: ExternalObjectGroupPosition): void;
-    externalObjectConfigurationMoved(plan: Plan, planObject: PlanObject, movedGroup: ExternalObjectGroup): void;
-    externalObjectConfigurationsMerged(plan: Plan, planObject: PlanObject, mergedGroup: ExternalObjectGroupAndModules, sourceGroupId: string): void;
-    externalObjectComponentSplitOff(plan: Plan, planObject: PlanObject, splitGroups: ExternalObjectGroupAndModules[]): void;
-    externalObjectArrangementChanged(plan: Plan, planObject: PlanObject, changedGroup: ExternalObjectGroupAndModules): void;
+    externalObjectPlanChanged(plan: Plan, planObject: PlanObject, movedGroup: ExternalObjectGroup): void;
+    externalObjectConfigurationsMerged(plan: Plan, planObject: PlanObject, mergedGroup: ExternalObjectGroup, idsOfGroupsMerged: string | string[], targetRootModuleId: string): void;
+    externalObjectComponentSplitOff(plan: Plan, planObject: PlanObject, splitGroups: ExternalObjectGroup[]): void;
+    externalObjectArrangementChanged(plan: Plan, planObject: PlanObject, changedGroup: ExternalObjectGroup): void;
     planObjectConfigurationLoaded(plan: Plan, element: PlanElement, success: boolean): Promise<void>;
     requestCatalogItem(catalogItemId: string): void;
     startedDrawing(): void;
@@ -95,12 +95,12 @@ export default class PlannerKernelAccess extends ConfiguratorKernelAccess {
     protected _externalObjectConfigurationChanged(objectId: number, configuration: string): void;
     protected _externalObjectConfigurationLoaded(objectId: number, configuration: string): void;
     protected _externalObjectConfigurationDeleted(groupId: string): void;
-    protected _externalObjectComponentDeleted(remainingGroupOrGroups: ExternalObjectGroupAndModules | ExternalObjectGroupAndModules[], deletedRootModuleId: string): void;
+    protected _externalObjectComponentDeleted(remainingGroupOrGroups: ExternalObjectGroup | ExternalObjectGroup[], deletedRootModuleId: string): void;
     _externalObjectConfigurationDuplicated(sourceGroupId: string, newGroupPosition: ExternalObjectGroupPosition): void;
-    _externalObjectConfigurationsMoved(movedGroup: ExternalObjectGroup): void;
-    _externalObjectConfigurationsMerged(mergedGroup: ExternalObjectGroupAndModules, sourceGroupId: string): void;
-    _externalObjectComponentSplitOff(splitGroups: ExternalObjectGroupAndModules[]): void;
-    _externalObjectArrangementChanged(changedGroup: ExternalObjectGroupAndModules): void;
+    _externalObjectPlanChanged(movedGroup: ExternalObjectGroup): void;
+    _externalObjectConfigurationsMerged(mergedGroup: ExternalObjectGroup, idsOfGroupsMerged: string | string[], targetRootModuleId: string): void;
+    _externalObjectComponentSplitOff(splitGroups: ExternalObjectGroup[]): void;
+    _externalObjectArrangementChanged(changedGroup: ExternalObjectGroup): void;
     planSnapshotCreated(planSnapshot: RapiPlanSnapshotPostData): void;
     requestDeleteComponents(componentIds: number[]): void;
     requestDeleteComponent(componentId: number): void;