@roomle/web-sdk 4.2.0 → 4.3.0-alpha.2

package/lib/roomle-sdk.d.ts

@@ -2016,6 +2016,7 @@ export declare class ConfiguratorViewModel implements ConfiguratorKernelCallback
     private _subPartObject;
     private _subPartGuard;
     protected _components: Map<number, RoomleComponent>;
+    private _componentsWithOutdatedGeometry;
     private _previews;
     protected _componentNumberOfPossibleChildren: Map<number, number>;
     protected _componentFactory: RoomleComponentFactory;
@@ -2064,6 +2065,7 @@ export declare class ConfiguratorViewModel implements ConfiguratorKernelCallback
     Editor3dGeometryReady(id: number): void;
     Editor3dGeometryNotReady(id: number): void;
     Editor3dPlanObjectConstructionDone(planObjectId: number): void;
+    private _finishPendingPlanObjectConstruction;
     Editor3dPreviewConstructionDone(componentId: number, _objectId: number): void;
     Editor3dSetPreviewAssociations(dockPairs: KernelDockPairPreview[], previewId: number): void;
     componentDeleted(componentId: number): void;
@@ -2097,6 +2099,7 @@ export declare class ConfiguratorViewModel implements ConfiguratorKernelCallback
     protected _generateMesh(runtimeComponentId: number | undefined, geometryId: string | null | undefined, materialId: string | null, 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): void;
     constructComponents(planObjectId: number): void;
+    private _takeOutdatedGeometryOf;
     requestSubPartConstruction(partId: number): Promise<Mesh>;
     protected getMeshGenerator(): MeshGenerator;
     setRequestRenderCallback(requestRenderCallback: () => void): void;
@@ -2280,6 +2283,12 @@ export declare const CORE_PLAN_COMPONENT_TYPE: {
 export declare const CORE_PLAN_ROOM_GEOMETRY_MODE: {
     readonly FLOOR: 0;
     readonly ROOM: 1;
+    readonly PLAN: 2;
+};
+
+export declare const CORE_PLAN_VIEW_TYPE: {
+    readonly FLOOR: 0;
+    readonly ELEVATION: 1;
 };
 
 export declare const CORE_SNAP_STATE: {
@@ -2636,6 +2645,11 @@ export declare interface DynamicLightSettingSource {
     ls?: PreDefinedLightSettings;
 }
 
+export declare interface EdgeDeflection {
+    connectionPosition: KernelVector3f;
+    deflectionAngleInRadians: number;
+}
+
 export declare interface EdgeType {
     value: Enumify<typeof CORE_EDGE_TYPE>;
 }
@@ -2648,6 +2662,7 @@ export declare interface Element_2 {
 
 export declare interface ElevationPlan {
     planSvg: string;
+    viewType?: PlanViewType;
 }
 
 export declare interface ElevationPlans {
@@ -2665,12 +2680,6 @@ export declare interface ElevationProfilePoint {
     slopeAngleInRadians: number;
 }
 
-export declare interface ElevationView {
-    lineOfSight: KernelVector3f;
-    objects: PlanObject[];
-    profile: ElevationProfile;
-}
-
 export declare class EmsArray<T> {
     get(index: number): T;
     push_back(element: T): void;
@@ -2948,9 +2957,13 @@ export declare interface ExternalObjectAPI {
      */
     loadExternalObjectGroups(groupJson: ExternalGroupData, options: LoadExternalObjectOptions): Promise<LoadExternalObjectGroupResult[]>;
     /**
-     * "loadExternalObjectGroupLayout" creates and loads a group of modules from an article layout.
-     * @param articleLayoutJson The article layout JSON as object.
-     * @param layoutType The article layout type. Only "nobila" is supported at the moment.
+     * "loadExternalObjectGroupLayout" creates and loads groups of modules from an article layout.
+     * @param articleLayoutJson The article layout JSON as object. The layout type "nobila" evaluates
+     * the "shapes" property, the layout type "posGroups" evaluates the "posGroups" property.
+     * For the layout type "posGroups" a group whose id matches a group already loaded in the plan
+     * completely replaces that group; root modules keep their ids when they already exist in the
+     * replaced group, all other ids are regenerated.
+     * @param layoutType The article layout type. "nobila" and "posGroups" are supported.
      * @param options Options for loading the external object group.
      */
     loadExternalObjectGroupLayout(articleLayoutJson: ExternalObjectGroupLayout, layoutType: string, options?: LoadExternalObjectOptions): Promise<LoadExternalObjectGroupResult[]>;
@@ -3047,6 +3060,13 @@ export declare interface ExternalObjectAPI {
      * "getExternalRoomInformation" returns the room information for currently loaded in the plan.
      */
     getExternalRoomInformation(mode?: PlanRoomGeometryMode): Promise<ExternalRoomInformation>;
+    /**
+     * "getExternalObjectPlanContext" returns a consistent snapshot of the external object state:
+     * the master data per library, the room information of all rooms, the articles that can be
+     * used, and all groups currently loaded in the plan.
+     * @param include The sections to include. All sections are returned when omitted or empty.
+     */
+    getExternalObjectPlanContext(include?: HiPlanContextSection[]): Promise<HiPlanContext>;
     /**
      * It generates a snapshot of the external object in the plan without saving any data.
      * By default, the snapshot includes order data, room information, the plan XML, GLBs of the complete scene,
@@ -3121,6 +3141,7 @@ export declare interface ExternalObjectGroup {
 export declare interface ExternalObjectGroupLayout {
     [key: string]: unknown;
     shapes?: ExternalObjectGroupLayoutShape[];
+    posGroups?: PosGroup[];
 }
 
 export declare interface ExternalObjectGroupLayoutArticle {
@@ -3387,6 +3408,18 @@ export declare class FloorMaterial extends BaseMaterial {
     rotation(): KernelVector3f;
 }
 
+export declare interface FloorPlanEdge {
+    id: number;
+    start: KernelVector3f;
+    end: KernelVector3f;
+    startDeflection?: EdgeDeflection | null;
+    endDeflection?: EdgeDeflection | null;
+}
+
+export declare interface FloorPlanEdges {
+    edges: FloorPlanEdge[];
+}
+
 export declare class FloorPlanElementViewModel extends PlanElementViewModel {
     constructor(planObject: PlanObject);
     addMesh(mesh: Mesh): void;
@@ -3640,8 +3673,9 @@ export declare interface GlueLogic {
     getSaveDataGroups(): Promise<PosGroup[] | null>;
     getSubArticleId(id: string): string | undefined;
     newPosDataFromId(id: string): Promise<PosGroup | undefined>;
-    newPosDataFromArticleLayout(articleLayoutJson: ExternalObjectGroupLayout, layoutType: string, posArticles?: PosArticle[]): Promise<PosGroup | undefined>;
+    createOrReplacePosDataFromArticleLayout(articleLayoutJson: ExternalObjectGroupLayout, layoutType: string, posArticles?: PosArticle[]): Promise<PosGroup | PosGroup[] | undefined>;
     newPosDataFromGroup(posDataJson: PosGroup): Promise<PosGroup>;
+    getPlanContext(include?: HiPlanContextSection[]): Promise<HiPlanContext>;
     getGroupDataForOrder(options: GetGroupDataForOrderOptions): Promise<HiOrderData | null>;
     getMaterialUrl(materialId: string, groupOrModuleId?: string): string | null;
 }
@@ -3873,6 +3907,15 @@ export declare interface HiObjectSelectionApi {
     selectionChanged(selectionMode: SELECTION_MODE, objectType: CallbackObjectType, payload: SelectionPayload, _payloadPromise: Promise<SelectionPayload>, _planElementViewModel: PlanElementViewModel): void;
 }
 
+export declare interface HiPlanContext {
+    masterData?: Record<string, MasterData>;
+    rooms?: ExternalRoomInformation;
+    articles?: PosArticle[];
+    groups?: PosGroup[];
+}
+
+export declare type HiPlanContextSection = 'masterData' | 'rooms' | 'articles' | 'groups';
+
 export declare class HiTagCatalogCallbacks implements Context {
     _creator_: string;
     private _glueLogic;
@@ -4902,6 +4945,7 @@ export declare interface LoadExternalObjectGroupResult {
 
 export declare interface LoadExternalObjectOptions {
     reason?: HiLoadObjectReason;
+    applyGroupPosition?: boolean;
     findFreeSpaceInPlan?: boolean;
     moduleIdMap?: Array<{
         originalModuleId: string;
@@ -5551,6 +5595,7 @@ export declare const PLAN_ELEMENT_CHANGE_TYPES: {
 export declare const PLAN_ROOM_GEOMETRY_MODE: {
     readonly FLOOR: "floor";
     readonly ROOM: "room";
+    readonly PLAN: "plan";
 };
 
 export declare abstract class PlanElement extends AbstractModelWrapper {
@@ -5698,7 +5743,7 @@ export declare interface PlanModelViewHelper_2 {
     getGroupedObjects(anObject: PlanObject): KernelPlanObject[];
     calculateLightSourceDistribution(plan: Plan_2, lightSourceConfiguration: LightSourceConfiguration): RoomLightSourceDistributionArray;
     getObjectSnapInformation(anObject: PlanObject, debugHelpLines: boolean): ObjectSnapInformation;
-    getElevationViews(plan: Plan_2): ElevationView[];
+    getPlanViews(plan: Plan_2): PlanView[];
 }
 
 export declare class Planner<P extends readonly PluginName[] = readonly []> extends Main {
@@ -6111,6 +6156,7 @@ export declare class PlannerSceneEventHandler extends SceneEventHandler<SceneEve
     private _move;
     hasSelection(): boolean;
     selectPlanElement(planElement: PlanElementViewModel): Promise<void>;
+    selectPlanElementAfterObjectModeChange(planElement: PlanElementViewModel): void;
     protected _interaction(_forceRender?: boolean): void;
     addComponentDragInHandler(planViewModel: PlanElementViewModel): void;
     enableSnapping(): void;
@@ -6245,6 +6291,7 @@ export declare class PlannerSceneManager extends ConfiguratorSceneManager implem
     private _setCameraPosition;
     private _resetCameraPosition;
     selectPlanObject(runtimeId: number): Promise<void>;
+    selectPlanObjectAfterObjectModeChange(runtimeId: number): void;
     backToPlanner(): void;
     private _getYRotationOfObject;
     loadStaticPlanObjects(): void;
@@ -6600,6 +6647,15 @@ export declare abstract class PlanText extends PlanElement {
     getText(): string;
 }
 
+export declare interface PlanView {
+    id: number;
+    viewType: PlanViewType;
+    lineOfSight: KernelVector3f;
+    objects: PlanObject[];
+    profile: ElevationProfile;
+    floorPlanEdges: FloorPlanEdges;
+}
+
 export declare class PlanViewModel extends ConfiguratorViewModel implements PlannerKernelCallbackI {
     private _plannerMeshGenerator;
     private _roomlePlannerUiCallback;
@@ -6753,6 +6809,10 @@ export declare class PlanViewModel extends ConfiguratorViewModel implements Plan
     externalObjectRemoveSubModule(_groupId: string, _subModuleId: string): void;
 }
 
+export declare interface PlanViewType {
+    value: Enumify<typeof CORE_PLAN_VIEW_TYPE>;
+}
+
 export declare interface PluginConfigMap {
     'external-objects': RapiConfigurationEnhanced | ExternalConfiguration;
 }
@@ -8023,6 +8083,7 @@ export declare interface RoomleComponent extends RoomleEventedObject3D {
     animationValueMap?: AnimationValueMap;
     get childComponents(): RoomleComponent[];
     get parentComponent(): RoomleComponent | null;
+    get rootComponent(): RoomleComponent;
     replaceMeshes(meshes: Mesh[]): void;
     addMesh(mesh: Mesh, transform?: Float32Array): void;
     removeMesh(mesh: Mesh): void;
@@ -9052,17 +9113,26 @@ export declare class RoomlePlanner<P extends readonly PluginName[] = readonly []
      * return the object runtime id
      */
     createPlanFromObject(id: RapiId, position?: Position3, rotation?: number): Promise<number>;
+    /**
+     * Creates a plan holding a single object built from a configuration string
+     * @param configuration configuration string (`{"componentId":"catalog:item",…}`).
+     * @param position XYZ
+     * @param rotation deg
+     */
+    createPlanFromConfigurationString(configuration: string, position?: Position3, rotation?: number): Promise<number>;
+    private _createPlanFromElement;
     loadPlanXml(xml: string, options?: InitDataDefinition & GlobalInitDataDefinition): Promise<void>;
     /**
-     * Creates 2D elevation plans of the current plan, one per elevation view.
-     * Each plan is returned as raw SVG markup (wireframe rendering with
+     * Creates the 2D plans of the current plan: the floor plan of the whole
+     * construction first, then one elevation plan per construction edge. Each
+     * plan is returned as raw SVG markup (wireframe rendering with
      * dimensionings).
      *
-     * @returns the elevation plans, each containing its SVG markup
+     * @returns the plans, each containing its SVG markup and its view type
      */
     create2DElevationPlan(): Promise<ElevationPlans>;
     /**
-     * Creates the 2D elevation plans of the current plan (see
+     * Creates the 2D plans of the current plan (see
      * {@link create2DElevationPlan}) and downloads each plan as an SVG file.
      */
     download2DElevationPlan(): Promise<void>;
@@ -9409,6 +9479,7 @@ export declare class RoomlePlanner<P extends readonly PluginName[] = readonly []
     private _loadExternalObjectGroupInConfigurator;
     private _loadExternalObjectGroupInPlanner;
     private _updateExternalObjectRootModuleSelection;
+    private _mergeAndSelectExternalObjectGroup;
     private _loadOrUpdateExternalObjectGroup;
     private _interactionBeforeLoadingExternalObjectGroups;
     private _interactionAfterLoadingExternalObjectGroups;
@@ -9430,6 +9501,7 @@ export declare class RoomlePlanner<P extends readonly PluginName[] = readonly []
     openOrCloseGeometryOfExternalObject(groupIdOrRootModuleId: string, _subModuleId: string | null, open: boolean, animate: boolean): void;
     _selectExternalObjectGroup(groupId: string, switchToPlanner: boolean): Promise<void>;
     getExternalObjectGroups(): Promise<object[]>;
+    getExternalObjectPlanContext(include?: HiPlanContextSection[]): Promise<HiPlanContext>;
     getExternalRoomInformation(mode?: PlanRoomGeometryMode): Promise<ExternalRoomInformation>;
     /**
      * Highlights a product in the planner.
@@ -10022,6 +10094,7 @@ export declare abstract class SceneManager implements Context, LifeCycleCallback
     private _clock;
     private _delta;
     protected _renderLoopFunction: (() => void) | null;
+    private _renderLoopFunctionApplied;
     protected _renderListener: (() => void) | null;
     protected _stopRendering: boolean;
     protected _roomleRenderer: GenericRoomleRenderer | null;
@@ -10038,6 +10111,12 @@ export declare abstract class SceneManager implements Context, LifeCycleCallback
     protected abstract createCameraControl(mode: Enumify_3<typeof CAMERA_TYPE>, offset: CanvasOffset): void;
     protected abstract _getInputManager(): InputManager;
     get cameraBehaviour(): CameraBehaviour;
+    protected _scheduleRenderLoopFunction(renderLoopFunction: () => void): void;
+    /**
+     * Resolves the next time the render loop applies a scheduled function, so arm
+     * it **before** triggering the work whose mutation you are waiting for.
+     */
+    whenRenderLoopFunctionApplied(): Promise<void>;
     abstract sceneChanged(): void;
     abstract getBounds(): Box3 | null;
     abstract getGeometryBounds(): Box3 | null;
@@ -10937,6 +11016,7 @@ export declare class WebGpuConfig implements WebGpuConfigDefinition {
     topLight: WebGpuTopLightConfig;
     groundReflection: WebGpuGroundReflectionConfig;
     fog: WebGpuFogConfig;
+    ssgi: WebGpuSSGIConfig;
     toneMapping: WebGpuToneMapping;
     toneMappingExposure: number;
 }
@@ -10975,6 +11055,10 @@ export declare interface WebGpuConfigDefinition {
      * @description Visual configuration for the WebGPU fog.
      */
     fog?: WebGpuFogConfigDefinition;
+    /**
+     * @description Visual configuration for the WebGPU screen space global illumination (SSGI) effect.
+     */
+    ssgi?: WebGpuSSGIConfigDefinition;
     /**
      * @description Tone mapping operator applied by the WebGPU renderer.
      * @default 'none'
@@ -11055,6 +11139,28 @@ export declare interface WebGpuGroundReflectionConfigDefinition {
     endFadeout?: number;
 }
 
+export declare class WebGpuSSGIConfig implements WebGpuSSGIConfigDefinition {
+    giDenoiseRadius: number;
+    aoDenoiseRadius: number;
+}
+
+export declare interface WebGpuSSGIConfigDefinition {
+    /**
+     * @description Radius of the denoising filter applied to the indirect lighting.
+     * Higher values produce a stronger denoising effect, which can help reduce noise
+     * in the indirect lighting but may also blur fine details.
+     * @default 20
+     */
+    giDenoiseRadius?: number;
+    /**
+     * @description Radius of the denoising filter applied to the ambient occlusion (AO) pass.
+     * Higher values produce a stronger denoising effect, which can help reduce noise
+     * in the AO but may also blur fine details.
+     * @default 10
+     */
+    aoDenoiseRadius?: number;
+}
+
 export declare type WebGpuToneMapping = Enumify_3<typeof WEBGPU_TONE_MAPPINGS>;
 
 export declare class WebGpuTopLightConfig implements WebGpuTopLightConfigDefinition {

package/lib/roomle-sdk.js

@@ -1,9 +1,9 @@
-import { a as e, i as t, n, r, t as i } from "./packages-BGVMQMZK.mjs";
+import { a as e, i as t, n, r, t as i } from "./packages-0GadOkxt.mjs";
 import { i as a, t as o } from "./kernel-BWfRHWkW.mjs";
-import { mt as s, vt as c } from "./threejs-utils-C9zED_Tu.mjs";
-import { F as l, G as u, J as d, K as f, M as p, N as m, P as h, S as g, W as _, b as v, ct as y, dt as b, j as x, k as S, lt as C, mt as w, q as T, t as E, u as D, ut as O, x as k, y as A, z as j } from "./roomle-sdk-B73VmWod.mjs";
-import { t as M } from "./configurator-Cbof6AET.mjs";
-import { t as N } from "./planner-DFa8uJOF.mjs";
-import { n as P, t as F } from "./glb-viewer-DmVh1uJg.mjs";
-import { t as I } from "./api-B6sLiuiL.mjs";
+import { mt as s, vt as c } from "./threejs-utils-DKJ0uer7.mjs";
+import { F as l, G as u, J as d, K as f, M as p, N as m, P as h, S as g, W as _, b as v, ct as y, dt as b, j as x, k as S, lt as C, mt as w, q as T, t as E, u as D, ut as O, x as k, y as A, z as j } from "./roomle-sdk-CpgzRTKP.mjs";
+import { t as M } from "./configurator-CUiTTJmW.mjs";
+import { t as N } from "./planner-CyQKj8Ok.mjs";
+import { n as P, t as F } from "./glb-viewer-DB5c3Qk5.mjs";
+import { t as I } from "./api-C430uhWG.mjs";
 export { o as CONFIGURATION_TYPE, s as CORE_EDGE_TYPE, c as CORE_OBJECT_CATEGORY, a as CORE_PERMISSION_TO_DELETE, M as Configurator, x as FloorPlanElementViewModel, F as GlbViewer, j as HI_CONTEXT_ACTION, g as MeasurementLinePlanElementViewModel, A as PLAN_ELEMENT_CHANGE_TYPES, l as PlanElementViewModel, h as PlanObjectViewModel, N as Planner, y as RapiAccess, C as RapiInvalidIdError, O as RapiOfflineError, I as RoomDesignerApi, S as RoomleConfigurator, P as RoomleGLBViewer, w as RoomleLightSource, D as RoomlePlanner, E as RoomleSdk, m as StaticPlanObjectViewModel, p as WallPlanElementViewModel, _ as createExtObj, d as createExtObjId, b as getCatalogIdFromConfigurationHash, u as isExtObjId, f as isExternalObject, v as isFirefox, i as isIdAComponent, n as isIdAConfigurationString, r as isIdAPlan, t as isIdAnItem, e as isPlanSnapshotId, k as isSafari, T as removeExtObjIdPrefix };