@roomle/web-sdk 3.10.0-alpha.2 → 3.10.0-alpha.4

package/lib/roomle-renderer-BD3ZmpLS.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"roomle-renderer-BD3ZmpLS.mjs","names":[],"sources":["../../packages/common-core/src/utils/fps-counter.ts","../../packages/common-core/src/roomle-renderer.ts"],"sourcesContent":["const FPS_LIST_SIZE = 10;\nconst FPS_MEASUREMENT_INTERVAL_MS = 20;\n\nexport default class FpsCounter {\n  private _index: number = 0;\n  private _fpsList: number[];\n  private _prevTime: number = 0;\n  private _frames: number = 0;\n  private _fps: number = -1;\n\n  constructor() {\n    this._fpsList = Array(FPS_LIST_SIZE).fill(0);\n    this._prevTime = (performance || Date).now();\n    this.reset();\n  }\n\n  public update() {\n    this._frames++;\n    const time = (performance || Date).now();\n\n    if (time >= this._prevTime + FPS_MEASUREMENT_INTERVAL_MS) {\n      this._fpsList[this._index % FPS_LIST_SIZE] =\n        (this._frames * 1000) / (time - this._prevTime);\n\n      if (this._index >= FPS_LIST_SIZE) {\n        this._fps =\n          this._fpsList.reduce((pv, cv) => pv + cv) / this._fpsList.length;\n      }\n\n      this._prevTime = time;\n      this._frames = 0;\n      this._index++;\n    }\n  }\n\n  public start() {\n    this._prevTime = (performance || Date).now();\n    this._frames = 0;\n  }\n\n  public reset() {\n    this._fps = -1;\n    this._fpsList = Array(FPS_LIST_SIZE).fill(0);\n    this._index = 0;\n  }\n\n  public getFps() {\n    return this._fps;\n  }\n}\n","import type { Camera, Object3D, Scene, Vector2, WebGLRenderer } from 'three';\nimport { Box3 } from 'three';\nimport type { Enumify } from '#/common/src/utils/types';\nimport type { CAMERA_TYPE } from './cameracontrol/camera-type';\nimport type { WebGPURenderer } from 'three/webgpu';\nimport type { SceneShadingType } from './webgl/renderer/shading-settings';\nimport type {\n  LutImageDefinition,\n  OutlineCustomParameters,\n} from './webgl/renderer/scene-renderer';\n\nexport type GenericRoomleRenderer = RoomleRenderer<\n  WebGLRenderer | WebGPURenderer\n>;\n\nexport enum PlannerRenderMode {\n  Mode3D,\n  Mode2D,\n}\n\nexport abstract class RoomleRenderer<\n  RendererType extends WebGLRenderer | WebGPURenderer,\n> {\n  public _creator_: string;\n  public renderer: RendererType;\n  protected isConfiguratorMode: boolean = true;\n  protected isCameraMoving: boolean = false;\n  protected cameraType: Enumify<typeof CAMERA_TYPE>;\n  protected shadowNeedsUpdate: boolean = false;\n  protected boundingBox: Box3 = new Box3();\n  protected boundingBoxNeedsUpdate: boolean = false;\n\n  protected constructor(creator: string, renderer: RendererType) {\n    this._creator_ = creator;\n    this.renderer = renderer;\n  }\n\n  public get isConfiguring(): boolean {\n    return this.isConfiguratorMode;\n  }\n\n  public dispose(): void {\n    this.renderer.dispose();\n  }\n\n  public setSize(width: number, height: number): void {\n    this.renderer.setSize(width, height);\n  }\n\n  public getSize(target: Vector2): Vector2 {\n    return this.renderer.getSize(target);\n  }\n\n  public setCameraType(cameraType: Enumify<typeof CAMERA_TYPE>) {\n    this.cameraType = cameraType;\n  }\n\n  public movingCameraStarts(): void {\n    this.isCameraMoving = true;\n  }\n\n  public movingCameraStops(): void {\n    this.isCameraMoving = false;\n  }\n\n  public forceShadowUpdates(_updateBakedGroundShadow: boolean): void {\n    this.shadowNeedsUpdate = true;\n  }\n\n  public clear() {\n    this.renderer.clear();\n  }\n\n  public updateBounds(geometryBounds: Box3) {\n    this.boundingBox.copy(geometryBounds);\n    this.boundingBoxNeedsUpdate = true;\n  }\n\n  public switchToConfigurator(): void {\n    this.isConfiguratorMode = true;\n  }\n\n  public switchToPlanner(_renderMode: PlannerRenderMode) {\n    this.isConfiguratorMode = false;\n  }\n\n  public abstract setShadingType(shadingType: SceneShadingType): void;\n\n  public abstract setCustomOutlineParameters(\n    outlineCustomParameters: OutlineCustomParameters,\n  ): void;\n\n  public abstract loadLutImages(luts: LutImageDefinition[]): void;\n\n  public abstract render(scene: Scene, camera: Camera): void;\n\n  public abstract showGUI(updateCallback: () => void): void;\n\n  public abstract clearCache(): void;\n\n  public abstract highlightObjects(selectedMeshes: Object3D[]): void;\n\n  public abstract setGroundShadow(enabled: boolean, scene: Scene): void;\n\n  public abstract enableUiInteractionMode(): void;\n\n  public abstract disableUiInteractionMode(): void;\n}\n"],"mappings":";;AAAA,IAAM,IAAgB,IAChB,IAA8B,IAEf,IAArB,MAAgC;CAO9B,cAAc;AAGZ,gBATuB,oBAEG,kBACF,eACH,IAGrB,KAAK,WAAW,MAAM,EAAc,CAAC,KAAK,EAAE,EAC5C,KAAK,aAAa,eAAe,MAAM,KAAK,EAC5C,KAAK,OAAO;;CAGd,SAAgB;AACd,OAAK;EACL,IAAM,KAAQ,eAAe,MAAM,KAAK;AAExC,EAAI,KAAQ,KAAK,YAAY,MAC3B,KAAK,SAAS,KAAK,SAAS,KACzB,KAAK,UAAU,OAAS,IAAO,KAAK,YAEnC,KAAK,UAAU,MACjB,KAAK,OACH,KAAK,SAAS,QAAQ,GAAI,MAAO,IAAK,EAAG,GAAG,KAAK,SAAS,SAG9D,KAAK,YAAY,GACjB,KAAK,UAAU,GACf,KAAK;;CAIT,QAAe;AAEb,EADA,KAAK,aAAa,eAAe,MAAM,KAAK,EAC5C,KAAK,UAAU;;CAGjB,QAAe;AAGb,EAFA,KAAK,OAAO,IACZ,KAAK,WAAW,MAAM,EAAc,CAAC,KAAK,EAAE,EAC5C,KAAK,SAAS;;CAGhB,SAAgB;AACd,SAAO,KAAK;;GChCJ,IAAL,yBAAA,GAAA;QACL,EAAA,EAAA,SAAA,KAAA,UACA,EAAA,EAAA,SAAA,KAAA;KACD,EAEqB,IAAtB,MAEE;CAUA,YAAsB,GAAiB,GAAwB;AAE7D,4BATsC,0BACJ,6BAEG,uBACT,IAAI,GAAM,gCACI,IAG1C,KAAK,YAAY,GACjB,KAAK,WAAW;;CAGlB,IAAW,gBAAyB;AAClC,SAAO,KAAK;;CAGd,UAAuB;AACrB,OAAK,SAAS,SAAS;;CAGzB,QAAe,GAAe,GAAsB;AAClD,OAAK,SAAS,QAAQ,GAAO,EAAO;;CAGtC,QAAe,GAA0B;AACvC,SAAO,KAAK,SAAS,QAAQ,EAAO;;CAGtC,cAAqB,GAAyC;AAC5D,OAAK,aAAa;;CAGpB,qBAAkC;AAChC,OAAK,iBAAiB;;CAGxB,oBAAiC;AAC/B,OAAK,iBAAiB;;CAGxB,mBAA0B,GAAyC;AACjE,OAAK,oBAAoB;;CAG3B,QAAe;AACb,OAAK,SAAS,OAAO;;CAGvB,aAAoB,GAAsB;AAExC,EADA,KAAK,YAAY,KAAK,EAAe,EACrC,KAAK,yBAAyB;;CAGhC,uBAAoC;AAClC,OAAK,qBAAqB;;CAG5B,gBAAuB,GAAgC;AACrD,OAAK,qBAAqB"}

package/lib/roomle-sdk.d.ts

@@ -642,9 +642,9 @@ export declare class CeilingLight extends PointLight {
     private _shouldCastShadow;
     getContainer(): Mesh | null;
     get shouldCastShadow(): boolean;
-    constructor(debug: boolean | undefined, maxQualityLevel: QualityLevel);
+    constructor(debug?: boolean);
     recalculatePower(amountOfLights: number): void;
-    update(qualityLevel: QualityLevel): void;
+    update(): void;
     addDebugUI(ceilingLightsParameters: GenericGUIParamFolder): void;
 }
 
@@ -2666,6 +2666,14 @@ export declare interface Element_2 {
     perspectiveImage: AssetUrl;
 }
 
+export declare interface ElevationPlan {
+    planSvg: string;
+}
+
+export declare interface ElevationPlans {
+    plans: ElevationPlan[];
+}
+
 export declare interface ElevationProfile {
     profileContour: ElevationProfilePoint[];
 }
@@ -2679,7 +2687,7 @@ export declare interface ElevationProfilePoint {
 
 export declare interface ElevationView {
     lineOfSight: KernelVector3f;
-    objects: KernelPlanObject[];
+    objects: PlanObject[];
     profile: ElevationProfile;
 }
 
@@ -3328,6 +3336,7 @@ export declare interface FeatureFlags {
     /* Excluded from this release type: interiorLights */
     /* Excluded from this release type: advancedDimensioning */
     /* Excluded from this release type: webGpu */
+    /* Excluded from this release type: webGpuConfig */
     /* Excluded from this release type: advancedHighlighting */
     /* Excluded from this release type: fence */
 }
@@ -6546,7 +6555,7 @@ export declare class PlanViewModel extends ConfiguratorViewModel implements Plan
     private _handleCeilingPlanElementViewModel;
     private _handleNodePlanElementViewModel;
     private _getCeilingLightsDistribution;
-    handleInitialCeilingLights(ceilingLightsParameters: GenericGUIParamFolder | undefined, qualityLevel: QualityLevel): void;
+    handleInitialCeilingLights(ceilingLightsParameters: GenericGUIParamFolder | undefined): void;
     handleCeilingLights(): void;
     handleLampLight(lamp: StaticPlanObjectViewModel, options: {
         targetPos: KernelVector3f;
@@ -7054,17 +7063,6 @@ export declare class PromiseQueue<T> {
     get length(): number;
 }
 
-export declare const QUALITY_LEVELS: {
-    readonly HIGHEST: "highest";
-    readonly HIGH: "high";
-    readonly MEDIUM: "medium";
-    readonly LOW: "low";
-};
-
-export declare type QualityLevel = Enumify_2<typeof QUALITY_LEVELS>;
-
-export declare type QualityMap = Map<QualityLevel, any>;
-
 export declare class RangeArray extends EmsArray<KernelRange> {
 }
 
@@ -7988,7 +7986,18 @@ export declare class RoomleConfigurator<P extends readonly PluginName[] = readon
     private _checkInitDone;
     private _onInitDone;
     constructor(creator: string, activePlugins?: P);
-    create2DElevationPlan(): Promise<void>;
+    /**
+     * Creates a 2D elevation plan of the current configuration, returned as raw
+     * SVG markup (wireframe rendering with measurements).
+     *
+     * @returns the elevation plans, containing one plan with its SVG markup
+     */
+    create2DElevationPlan(): ElevationPlans;
+    /**
+     * Creates the 2D elevation plan of the current configuration (see
+     * {@link create2DElevationPlan}) and downloads it as an SVG file.
+     */
+    download2DElevationPlan(): void;
     private createCameraForElevationPlan;
     exportCanvasScreenshot(quality?: number): Promise<string>;
     initSceneManager(sceneManager?: ConfiguratorSceneManager): void;
@@ -8935,7 +8944,19 @@ export declare class RoomlePlanner<P extends readonly PluginName[] = readonly []
      */
     createPlanFromObject(id: RapiId, position?: Position3, rotation?: number): Promise<number>;
     loadPlanXml(xml: string, options?: InitDataDefinition & GlobalInitDataDefinition): Promise<void>;
-    create2DElevationPlan(): 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
+     * dimensionings).
+     *
+     * @returns the elevation plans, each containing its SVG markup
+     */
+    create2DElevationPlan(): ElevationPlans;
+    /**
+     * Creates the 2D elevation plans of the current plan (see
+     * {@link create2DElevationPlan}) and downloads each plan as an SVG file.
+     */
+    download2DElevationPlan(): void;
     loadPlan(id: string, options?: InitDataDefinition & GlobalInitDataDefinition): Promise<RapiPlan | RapiPlanSnapshotGetData>;
     /**
      * Set general configuration parameter
@@ -9631,16 +9652,10 @@ export declare abstract class RoomleRenderer<RendererType extends WebGLRenderer
     switchToConfigurator(): void;
     switchToPlanner(_renderMode: PlannerRenderMode): void;
     abstract setShadingType(shadingType: SceneShadingType): void;
-    abstract setAutoQuality(autoQuality: boolean): void;
-    abstract setQualityLevel(qualityLevel: QualityLevel): void;
-    abstract getQualityLevel(): QualityLevel;
-    abstract setQualityMap(qualityMap: QualityMap): void;
-    abstract setCustomShadingParameters(customShadingParameters?: CustomShadingParameters, customShadingParametersMoc?: CustomShadingParameters): void;
     abstract setCustomOutlineParameters(outlineCustomParameters: OutlineCustomParameters): void;
     abstract loadLutImages(luts: LutImageDefinition[]): void;
     abstract render(scene: Scene, camera: Camera): void;
     abstract showGUI(updateCallback: () => void): void;
-    abstract setOnQualityLevelChangeCallback(callback: (qualityLevel: QualityLevel) => void): void;
     abstract clearCache(): void;
     abstract highlightObjects(selectedMeshes: Object3D[]): void;
     abstract setGroundShadow(enabled: boolean, scene: Scene): void;
@@ -9715,8 +9730,12 @@ export declare class RoomleWebGPURenderer extends RoomleRenderer<WebGPURenderer>
     private readonly renderPasses;
     private readonly guiParameterGroups;
     private lastRenderCamera;
+    private readonly qualityManager;
+    private freezeFrames;
+    private readonly freezeRenderTarget;
     private _domHelper;
     private _webGpuGroundShadowReflection;
+    private _initData;
     constructor(creator: string, renderer: WebGPURenderer, enableSSGI: boolean, outlineColors?: OutlineColors);
     private enableRenderPasses;
     addGroundShadowLightAndFloor(scene: Scene): Promise<void>;
@@ -9724,26 +9743,23 @@ export declare class RoomleWebGPURenderer extends RoomleRenderer<WebGPURenderer>
     clearCache(): void;
     disableUiInteractionMode(): void;
     enableUiInteractionMode(): void;
-    getQualityLevel(): QualityLevel;
     setCameraType(cameraType: Enumify_3<typeof CAMERA_TYPE>): void;
     switchToConfigurator(): void;
     switchToPlanner(renderMode: PlannerRenderMode): void;
     highlightObjects(selectedMeshes: Object3D[]): void;
     loadLutImages(_luts: LutImageDefinition[]): void;
     render(scene: Scene, camera: Camera): void;
+    private renderToFreezeTarget;
     private updateCameraProjectionMatrix;
     private assembleRenderPasses;
-    setAutoQuality(_autoQuality: boolean): void;
-    setCustomShadingParameters(_customShadingParameters: CustomShadingParameters | undefined, _customShadingParametersMoc: CustomShadingParameters | undefined): void;
     setCustomOutlineParameters(customOutlineParameters: OutlineCustomParameters): void;
     setGroundShadow(enabled: boolean, _scene: Scene): void;
-    setOnQualityLevelChangeCallback(_callback: (qualityLevel: QualityLevel) => void): void;
     private enableOutline;
     private getOutlinePassOrUndefined;
     private enableSsgiPass;
     private enableTraaPass;
-    setQualityLevel(_qualityLevel: QualityLevel): void;
-    setQualityMap(_qualityMap: QualityMap): void;
+    private applyQualityParameters;
+    private getSsgiPassOrUndefined;
     setShadingType(shadingType: SceneShadingType): void;
     showGUI(updateCallback: () => void): void;
     private addDebugGUI;
@@ -10755,6 +10771,30 @@ export declare interface WallSide {
     value: Enumify<typeof WALL_SIDES>;
 }
 
+export declare interface WebGpuConfig {
+    /**
+     * @description If true, the initial webgpu quality level is autodetected based on
+     * a benchmark of the graphics hardware. If false, the default quality level is used.
+     * @default true
+     */
+    autoDetectQualityLevel?: boolean;
+    /**
+     * @description This can be used to configure the lower bound of webgpu auto quality
+     * meaning the fps bound which, when hit, will set the quality setting lower
+     * To disable: set to 0
+     * @default 24
+     */
+    autoQualityMinFps?: number;
+    /**
+     * @description This can be used to configure the upper bound of webgpu auto quality
+     * meaning the fps bound which, when hit, will set the quality setting higher
+     * This should be sufficiently larger than the minFps to not cause the quality to go up and down all the time
+     * To disable: set to something very high
+     * @default 59
+     */
+    autoQualityMaxFps?: number;
+}
+
 export declare class ZoomChangeEvent {
     minZoom: boolean;
     maxZoom: boolean;

package/lib/roomle-sdk.js

@@ -1,9 +1,9 @@
 import { i as e, t } from "./kernel-C7YDLxq8.mjs";
-import { _t as n, mt as r } from "./threejs-utils-C4J_TZ0o.mjs";
-import { B as i, F as a, G as o, H as s, I as c, J as l, K as u, M as d, N as f, P as p, S as m, U as h, W as g, a as _, b as v, c as y, ct as b, dt as x, k as S, l as C, n as w, ot as T, pt as E, st as D, ut as O, v as k, x as A, y as j } from "./main-D2BulNeN.mjs";
-import { t as M } from "./configurator-BwxEIDv7.mjs";
-import { t as N } from "./planner-OgIPgZ1m.mjs";
-import { n as P, t as F } from "./glb-viewer-C0Et5SO6.mjs";
-import { t as I } from "./api-BXU3pZnX.mjs";
-import "./packages-BtLLQZLz.mjs";
+import { _t as n, mt as r } from "./threejs-utils-E4yVZATI.mjs";
+import { B as i, F as a, G as o, H as s, I as c, J as l, K as u, M as d, N as f, P as p, S as m, U as h, W as g, a as _, b as v, c as y, ct as b, dt as x, k as S, l as C, n as w, ot as T, pt as E, st as D, ut as O, v as k, x as A, y as j } from "./main-KSs3XdXO.mjs";
+import { t as M } from "./configurator-D6lTTIlU.mjs";
+import { t as N } from "./planner-ykpwnVZa.mjs";
+import { n as P, t as F } from "./glb-viewer-CuRDCxVq.mjs";
+import { t as I } from "./api-ckpzIPty.mjs";
+import "./packages-oEzg5zoT.mjs";
 export { t as CONFIGURATION_TYPE, r as CORE_EDGE_TYPE, n as CORE_OBJECT_CATEGORY, e as CORE_PERMISSION_TO_DELETE, M as Configurator, _ as ConfiguratorUiCallbacks, d as FloorPlanElementViewModel, F as GlbViewer, l as GlobalCallback, i as HI_CONTEXT_ACTION, O as IdbManager, w as Main, m as MeasurementLinePlanElementViewModel, k as PLAN_ELEMENT_CHANGE_TYPES, c as PlanElementViewModel, a as PlanObjectViewModel, N as Planner, T as RapiAccess, D as RapiInvalidIdError, b as RapiOfflineError, I as RoomDesignerApi, S as RoomleConfigurator, P as RoomleGLBViewer, E as RoomleLightSource, y as RoomlePlanner, j as RoomlePlannerUiCallback, C as RoomleSdk, p as StaticPlanObjectViewModel, f as WallPlanElementViewModel, s as createExtObj, u as createExtObjId, x as getCatalogIdFromConfigurationHash, h as isExtObjId, g as isExternalObject, v as isFirefox, A as isSafari, o as removeExtObjIdPrefix };