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

package/lib/roomle-sdk.d.ts

@@ -1177,6 +1177,7 @@ export declare interface ConfiguratorInitData {
     transparentHighlighting?: boolean;
     /**
      * @description If set to true, the background is transparent and allows elements behind the configurator to be visible through the scene.
+     * Not compatible with the WebGPU sky feature
      * usage: transparentBackground=true
      * @groups scene-settings
      */
@@ -1407,6 +1408,7 @@ export declare interface ConfiguratorKernelClass {
     getPlanObjectParameters(planObjectId: number): KernelParameter[];
     getCommonPlanObjectParameters(planObjectIds: EmsArray<number>): KernelParameter[];
     getPlanObjectAnimations(planObjectId: number): KernelAnimation[];
+    getPlanViews(planObjectId: number): KernelConfigurationPlanView[];
     setPlanObjectParameter(planObjectId: number, parameterKey: string, value: string): void;
     setPlanObjectsParameter(planObjectIds: any, parameterKey: string, value: string): void;
     dockComponent(childId: number, childDockId: number, parentId: number, parentDockId: number, position?: KernelVector3): void;
@@ -2673,6 +2675,7 @@ export declare interface Element_2 {
 export declare interface ElevationPlan {
     planSvg: string;
     viewType?: PlanViewType;
+    label: string;
 }
 
 export declare interface ElevationPlans {
@@ -4468,6 +4471,13 @@ export declare interface KernelConfiguration {
     children: KernelConfiguration[];
 }
 
+export declare interface KernelConfigurationPlanView {
+    viewType: PlanViewType;
+    lineOfSight: KernelVector3f;
+    enabled: boolean;
+    label: string | null;
+}
+
 export declare interface KernelCube {
     origin: KernelVector3;
     size: KernelVector3;
@@ -5232,7 +5242,7 @@ export declare class MeshGenerator implements Context {
     _creator_: string;
     materialQueue: PromiseQueue<void>;
     protected _geometryComponentMaterialCache: Map<string, string>;
-    private _initData;
+    protected _initData: InitData;
     protected _rapiAccess: RapiAccess;
     private _materialProvider;
     protected _dataSyncer: DataSyncer;
@@ -6239,7 +6249,6 @@ export declare class PlannerSceneManager extends ConfiguratorSceneManager implem
      * {@link awaitPendingConfigurationSaves}.
      */
     private _pendingConfigurationSaves;
-    private _sky;
     private _drawingEnabled;
     private _configureInRoom;
     private _keepWallsAndCeilingVisible;
@@ -6349,7 +6358,6 @@ export declare class PlannerSceneManager extends ConfiguratorSceneManager implem
     exportUSDZ(options?: ModelExportOptions): Promise<void>;
     importGLB(url: string): void;
     clearScene(): void;
-    private _addSky;
     toggleConfigureInRoom(): void;
     switchTo2D(): void;
     switchTo3D(): void;
@@ -6361,6 +6369,7 @@ export declare class PlannerSceneManager extends ConfiguratorSceneManager implem
     private _getHighestWallHeight;
     private _shouldShowCeiling;
     private _setCeiling;
+    private _setCeilingVisibility;
     cameraBehaviourChanged(updateDistance?: boolean): void;
     private _updatePaperBackground;
     sceneChanged(): void;
@@ -6667,7 +6676,14 @@ export declare interface PlanOverview {
     bounds: KernelCube;
     objects: KernelPlanObjectList;
     outsideWalls: PlanElement_2[];
-    rooms: PlanElement_2[];
+    rooms: PlanOverviewRoom[];
+}
+
+export declare interface PlanOverviewRoom {
+    runtimeId: RuntimeId;
+    area: number;
+    bounds: KernelCube;
+    objects: KernelPlanObjectList;
 }
 
 export declare type PlanRoomGeometryMode = (typeof PLAN_ROOM_GEOMETRY_MODE)[keyof typeof PLAN_ROOM_GEOMETRY_MODE];
@@ -8194,11 +8210,12 @@ export declare class RoomleConfigurator<P extends readonly PluginName[] = readon
     private _onInitDone;
     constructor(creator: string, activePlugins?: P);
     /**
-     * Creates the 2D plans of the current configuration: the floor plan, the front
-     * elevation and the side elevation seen from the left. Each plan is returned as
-     * raw SVG markup (wireframe rendering with dimensionings).
+     * Creates the 2D plans of the current configuration: the enabled plan views its root
+     * component defines, or the floor plan, the front elevation and the side elevation seen
+     * from the left when it defines none. Each plan is returned as raw SVG markup (wireframe
+     * rendering with dimensionings).
      *
-     * @returns the plans, each containing its SVG markup and its view type
+     * @returns the plans, each containing its SVG markup, its view type and its label
      */
     create2DPlanViews(): Promise<ElevationPlans>;
     /**
@@ -9306,6 +9323,12 @@ export declare class RoomlePlanner<P extends readonly PluginName[] = readonly []
      * this includes info about size, rotation, id and parts
      */
     getObjects(): Promise<UiPlanObject[]>;
+    /**
+     * returns the objects in the room of the given floor, without its doors and windows
+     * this includes info about size, rotation, id and parts, like getObjects
+     * @param floorId runtime id of the floor, e.g. the id of the selected floor
+     */
+    getObjectsInRoom(floorId: RuntimeId): Promise<UiPlanObject[]>;
     awaitPendingConfigurationSaves(): Promise<void>;
     /**
      * get all info available for the current plan, including objects, rooms and walls
@@ -9972,10 +9995,13 @@ export declare class RoomleWebGPURenderer extends RoomleRenderer<WebGPURenderer>
     private readonly debugRenderPass;
     private _domHelper;
     private _webGpuGroundShadowReflection;
+    private _webGpuSkyContainer;
+    private _skyStateTracker;
     private _initData;
     constructor(creator: string, renderer: WebGPURenderer, enableSSGI: boolean, outlineColors?: OutlineColors, enableTraa?: boolean);
     private enableDefaultRenderPasses;
     addGroundShadowLightAndFloor(scene: Scene_2): Promise<void>;
+    addSky(scene: Scene_2): Promise<void>;
     private addRenderPass;
     clearCache(): void;
     disableUiInteractionMode(): void;
@@ -10122,6 +10148,7 @@ export declare abstract class SceneManager implements Context, LifeCycleCallback
     protected _imageRenderer: ImageRenderer;
     protected _cameraBehaviourState: CameraBehaviourState;
     protected _cacheHolder: CacheHolder;
+    protected _skyStateTracker: SkyStateTracker;
     private _cameraControl3D;
     private _cameraControl2D;
     private _cameraControlFirstPerson;
@@ -10336,6 +10363,26 @@ export declare class SinglePromiseFactory implements Context {
 export declare class SizeTArray extends EmsArray<number> {
 }
 
+export declare const SKY_EVENT: {
+    readonly ENTERED_PLANNER: "sky:entered-planner";
+    readonly ENTERED_CONFIGURATOR: "sky:entered-configurator";
+};
+
+export declare type SkyEvent = ValuesFromObject<typeof SKY_EVENT>;
+
+export declare type SkyFeatureEventMap = Record<SkyEvent, void>;
+
+export declare class SkyStateTracker extends EventDispatcher<SkyFeatureEventMap> implements Context {
+    _creator_: string;
+    private readonly _isSkyEnabled;
+    private _isCurrentlyActive;
+    private _initData;
+    constructor(creator: string);
+    get isCurrentlyActive(): boolean;
+    notifyEnteredPlanner(): void;
+    notifyEnteredConfigurator(): void;
+}
+
 export declare const enum SnapMode {
     OFF = 0,
     ON_COLLISION = 1,
@@ -11071,6 +11118,7 @@ export declare class WebGpuConfig implements WebGpuConfigDefinition {
     topLight: WebGpuTopLightConfig;
     groundReflection: WebGpuGroundReflectionConfig;
     fog: WebGpuFogConfig;
+    sky: WebGpuSkyConfig;
     ssgi: WebGpuSSGIConfig;
     toneMapping: WebGpuToneMapping;
     toneMappingExposure: number;
@@ -11110,6 +11158,10 @@ export declare interface WebGpuConfigDefinition {
      * @description Visual configuration for the WebGPU fog.
      */
     fog?: WebGpuFogConfigDefinition;
+    /**
+     * @description Visual configuration for the WebGPU sky and sun.
+     */
+    sky?: WebGpuSkyConfigDefinition;
     /**
      * @description Visual configuration for the WebGPU screen space global illumination (SSGI) effect.
      */
@@ -11166,6 +11218,7 @@ export declare class WebGpuGroundReflectionConfig implements WebGpuGroundReflect
     intensity: number;
     startFadeout: number;
     endFadeout: number;
+    reflectionScale: number;
 }
 
 export declare interface WebGpuGroundReflectionConfigDefinition {
@@ -11192,6 +11245,128 @@ export declare interface WebGpuGroundReflectionConfigDefinition {
      * @default 0.15
      */
     endFadeout?: number;
+    /**
+     * @description How much the resolution of the scene is scaled by for the reflection resolution
+     * If transmissive objects are not in use, this can be set to a lower value like 0.5 to improve performance.
+     * @default 1
+     */
+    reflectionScale?: number;
+}
+
+export declare class WebGpuSkyConfig implements WebGpuSkyConfigDefinition {
+    enabled: boolean;
+    turbidity: number;
+    albedo: number;
+    azimuthAngle: number;
+    polarAngle: number;
+    sunLightIntensity: number;
+    sunRadius: number;
+    sunSoftness: number;
+    tonemapExposure: number;
+    tonemapWhite: number;
+    cloudCoverage: number;
+    cloudDensity: number;
+    cloudElevation: number;
+    overrideEnvironmentMapIntensity: number;
+}
+
+export declare interface WebGpuSkyConfigDefinition {
+    /**
+     * @description If true, adds a physically based (Hosek-Wilkie) sky and a matching
+     * sun providing light to the scene.
+     * @default false
+     */
+    enabled?: boolean;
+    /**
+     * @description Value determining the amount of aerosol particles in the sky. This
+     * very much impacts the sky's color and clearness.
+     * From the original paper: T = 2 yields a very clear, Arctic-like sky,
+     * T = 3 a clear sky in a temperate climate,
+     * T = 6 a sky on a warm, moist day,
+     * T = 10 a slightly hazy sky
+     * Valid range: `[1,10]`
+     * @default 2.5
+     */
+    turbidity?: number;
+    /**
+     * @description Represents how much light the ground bounces back into the atmosphere,
+     * which brightens the sky near the horizon if this value is high.
+     * Valid range: `[0,1]`
+     * @default 0.9
+     */
+    albedo?: number;
+    /**
+     * @description Horizontal orientation of the sun in radians.
+     * Changing this value rotates the sun clockwise around
+     * the scene without changing its height.
+     * Valid range: `[-pi, pi]`
+     * @default 0
+     */
+    azimuthAngle?: number;
+    /**
+     * @description Height of the sun measured as the angle
+     * from straight up (the zenith), in radians. Smaller values raise the sun toward
+     * noon; larger values lower it toward the horizon.
+     * Valid range: `[0,pi/2≈1.57]`.
+     * @default 1
+     */
+    polarAngle?: number;
+    /**
+     * @description Intensity of the sun that lights the scene and casts shadows.
+     * This does not influence how the sun disc looks in the sky.
+     * @default 10
+     */
+    sunLightIntensity?: number;
+    /**
+     * @description Radius of the visible sun disc in the sky.
+     * @default 0.03
+     */
+    sunRadius?: number;
+    /**
+     * @description Blurryness of the edge of the visible sun disc in the sky.
+     * @default 0.002
+     */
+    sunSoftness?: number;
+    /**
+     * @description Exposure multiplier applied during the sky-specific tone mapping.
+     * Higher values make the sky brighter.
+     * @default 0.5
+     */
+    tonemapExposure?: number;
+    /**
+     * @description The HDR brightness value which the sky-specific tone mapping considers as white.
+     * Lower values clip bright areas (like the sun) to white sooner, increasing contrast.
+     * Higher values preserve more detail in the brightest regions.
+     * @default 14
+     */
+    tonemapWhite?: number;
+    /**
+     * @description Fraction of the sky covered by clouds.
+     * At `0` no clouds are rendered. at `1` the sky is fully covered by clouds.
+     * @default 0.25
+     */
+    cloudCoverage?: number;
+    /**
+     * @description Opacity of the clouds when they are blended over the sky. At `0` clouds
+     * are invisible even if coverage is high; at `1` they fully replace the sky color
+     * beneath them.
+     * @default 0.3
+     */
+    cloudDensity?: number;
+    /**
+     * @description Height of the virtual cloud plane. A value of `0` places the plane
+     * very high (clouds appear small and distant); `1` pulls it down towards the horizon
+     * so clouds appear lower and larger.
+     * @default 0.7
+     */
+    cloudElevation?: number;
+    /**
+     * @description Intensity of the environment map lighting while the sky is
+     * enabled. Because the sky already contributes its own image-based lighting,
+     * the environment map is dimmed to this value to keep the overall scene brightness balanced.
+     * @default 0.5
+     */
+    overrideEnvironmentMapIntensity?: number;
 }
 
 export declare class WebGpuSSGIConfig implements WebGpuSSGIConfigDefinition {

package/lib/roomle-sdk.js

@@ -1,9 +1,9 @@
-import { a as e, i as t, n, r, t as i } from "./packages-3jOdcfbr.mjs";
+import { a as e, i as t, n, r, t as i } from "./packages-BXAZEcKa.mjs";
 import { i as a, t as o } from "./kernel-BWfRHWkW.mjs";
-import { bt as s, gt as c } from "./threejs-utils-WK7Uu2TS.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-CsSQAqQG.mjs";
-import { t as M } from "./configurator-CxlLvBCx.mjs";
-import { t as N } from "./planner-BeINcWRR.mjs";
-import { n as P, t as F } from "./glb-viewer-27e6wfY4.mjs";
-import { t as I } from "./api-B5wIZIHt.mjs";
-export { o as CONFIGURATION_TYPE, c as CORE_EDGE_TYPE, s 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 };
+import { ht as s, yt as c } from "./threejs-utils-v1uOvccg.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-CBwhwX_e.mjs";
+import { t as M } from "./configurator-CDw_c6tB.mjs";
+import { t as N } from "./planner-jvLAnYww.mjs";
+import { n as P, t as F } from "./glb-viewer-B-Zr743e.mjs";
+import { t as I } from "./api-Bznmr-xZ.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 };