@shapediver/viewer.viewport 3.16.7 → 3.16.9

package/dist/interfaces/lights/ILightApi.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=ILightApi.js.map

package/dist/interfaces/lights/ILightSceneApi.d.ts

@@ -1,139 +1,139 @@
-import { ITreeNode } from "@shapediver/viewer.shared.node-tree";
-import { Color } from "@shapediver/viewer.shared.types";
-import { vec3 } from "gl-matrix";
-import { ILightApi } from "./ILightApi";
-import { IAmbientLightApi } from "./types/IAmbientLightApi";
-import { IDirectionalLightApi } from "./types/IDirectionalLightApi";
-import { IHemisphereLightApi } from "./types/IHemisphereLightApi";
-import { IPointLightApi } from "./types/IPointLightApi";
-import { ISpotLightApi } from "./types/ISpotLightApi";
-/**
- * The api for a light scene.
- * A light scene is a collection of lights. Therefore multiple light scene can be used to switch between different lighting environments.
- * It can be created by calling the {@link createLightScene} method.
- */
-export interface ILightSceneApi {
-    /**
-     * The id of the light scene.
-     */
-    readonly id: string;
-    /**
-     * The node in which the lights are stored in the [scene tree]{@link ITree}.
-     */
-    readonly node: ITreeNode;
-    /**
-     * The collection of lights in the light scene.
-     */
-    lights: {
-        [key: string]: ILightApi;
-    };
-    /**
-     * The name of the light scene.
-     */
-    name?: string;
-    /**
-     * Create an ambient light and add it to the light scene.
-     *
-     * @param properties.color The color of the light.
-     * @param properties.intensity The intensity of the light. (0-Infinity, default: 0.5)
-     * @param properties.id The id of the light.
-     * @param properties.name The name of the light.
-     */
-    addAmbientLight(properties: {
-        color?: Color;
-        intensity?: number;
-        id?: string;
-        name?: string;
-    }): IAmbientLightApi;
-    /**
-     * Create a directional light and add it to the light scene.
-     *
-     * @param properties.color The color of the light.
-     * @param properties.intensity The intensity of the light. (0-Infinity, default: 0.5)
-     * @param properties.id The id of the light.
-     * @param properties.name The name of the light.
-     * @param properties.direction The direction of the light.
-     * @param properties.castShadow Option for the light to cast shadows.
-     * @param properties.shadowMapResolution The resolution of the shadow map. (default: 1024, has to be power of two)
-     * @param properties.shadowMapBias The bias of the shadow map. For more info on the shadow bias, see [here](https://digitalrune.github.io/DigitalRune-Documentation/html/3f4d959e-9c98-4a97-8d85-7a73c26145d7.htm).
-     */
-    addDirectionalLight(properties: {
-        color?: Color;
-        intensity?: number;
-        direction?: vec3;
-        castShadow?: boolean;
-        shadowMapResolution?: number;
-        shadowMapBias?: number;
-        id?: string;
-        name?: string;
-    }): IDirectionalLightApi;
-    /**
-     * Create an hemisphere light and add it to the light scene.
-     *
-     * @param properties.color The color of the light.
-     * @param properties.intensity The intensity of the light. (0-Infinity, default: 0.5)
-     * @param properties.id The id of the light.
-     * @param properties.name The name of the light.
-     * @param properties.groundColor The ground color of the light.
-     */
-    addHemisphereLight(properties: {
-        color?: Color;
-        intensity?: number;
-        groundColor?: Color;
-        id?: string;
-        name?: string;
-    }): IHemisphereLightApi;
-    /**
-     * Create a point light and add it to the light scene.
-     *
-     * @param properties.color The color of the light.
-     * @param properties.intensity The intensity of the light. (0-Infinity, default: 0.5)
-     * @param properties.id The id of the light.
-     * @param properties.name The name of the light.
-     * @param properties.position The position of the light.
-     * @param properties.distance The distance of the light.
-     * @param properties.decay The decay of the light.
-     */
-    addPointLight(properties: {
-        color?: Color;
-        intensity?: number;
-        position?: vec3;
-        distance?: number;
-        decay?: number;
-        id?: string;
-        name?: string;
-    }): IPointLightApi;
-    /**
-     * Create a point light and add it to the light scene.
-     *
-     * @param properties.color The color of the light.
-     * @param properties.intensity The intensity of the light. (0-Infinity, default: 0.5)
-     * @param properties.id The id of the light.
-     * @param properties.name The name of the light.
-     * @param properties.position The position of the light.
-     * @param properties.target The target of the light.
-     * @param properties.distance The distance of the light.
-     * @param properties.decay The decay of the light.
-     * @param properties.angle The angle of the light.
-     * @param properties.penumbra The penumbra of the light.
-     */
-    addSpotLight(properties: {
-        color?: Color;
-        intensity?: number;
-        position?: vec3;
-        target?: vec3;
-        distance?: number;
-        decay?: number;
-        angle?: number;
-        penumbra?: number;
-        id?: string;
-        name?: string;
-    }): ISpotLightApi;
-    /**
-     * Remove a light from the light scene with the specified id.
-     *
-     * @param id The id of the light to remove.
-     */
-    removeLight(id: string): boolean;
-}
+import { ITreeNode } from "@shapediver/viewer.shared.node-tree";
+import { Color } from "@shapediver/viewer.shared.types";
+import { vec3 } from "gl-matrix";
+import { ILightApi } from "./ILightApi";
+import { IAmbientLightApi } from "./types/IAmbientLightApi";
+import { IDirectionalLightApi } from "./types/IDirectionalLightApi";
+import { IHemisphereLightApi } from "./types/IHemisphereLightApi";
+import { IPointLightApi } from "./types/IPointLightApi";
+import { ISpotLightApi } from "./types/ISpotLightApi";
+/**
+ * The api for a light scene.
+ * A light scene is a collection of lights. Therefore multiple light scene can be used to switch between different lighting environments.
+ * It can be created by calling the {@link createLightScene} method.
+ */
+export interface ILightSceneApi {
+    /**
+     * The id of the light scene.
+     */
+    readonly id: string;
+    /**
+     * The node in which the lights are stored in the [scene tree]{@link ITree}.
+     */
+    readonly node: ITreeNode;
+    /**
+     * The collection of lights in the light scene.
+     */
+    lights: {
+        [key: string]: ILightApi;
+    };
+    /**
+     * The name of the light scene.
+     */
+    name?: string;
+    /**
+     * Create an ambient light and add it to the light scene.
+     *
+     * @param properties.color The color of the light.
+     * @param properties.intensity The intensity of the light. (0-Infinity, default: 0.5)
+     * @param properties.id The id of the light.
+     * @param properties.name The name of the light.
+     */
+    addAmbientLight(properties: {
+        color?: Color;
+        intensity?: number;
+        id?: string;
+        name?: string;
+    }): IAmbientLightApi;
+    /**
+     * Create a directional light and add it to the light scene.
+     *
+     * @param properties.color The color of the light.
+     * @param properties.intensity The intensity of the light. (0-Infinity, default: 0.5)
+     * @param properties.id The id of the light.
+     * @param properties.name The name of the light.
+     * @param properties.direction The direction of the light.
+     * @param properties.castShadow Option for the light to cast shadows.
+     * @param properties.shadowMapResolution The resolution of the shadow map. (default: 1024, has to be power of two)
+     * @param properties.shadowMapBias The bias of the shadow map. For more info on the shadow bias, see [here](https://digitalrune.github.io/DigitalRune-Documentation/html/3f4d959e-9c98-4a97-8d85-7a73c26145d7.htm).
+     */
+    addDirectionalLight(properties: {
+        color?: Color;
+        intensity?: number;
+        direction?: vec3;
+        castShadow?: boolean;
+        shadowMapResolution?: number;
+        shadowMapBias?: number;
+        id?: string;
+        name?: string;
+    }): IDirectionalLightApi;
+    /**
+     * Create an hemisphere light and add it to the light scene.
+     *
+     * @param properties.color The color of the light.
+     * @param properties.intensity The intensity of the light. (0-Infinity, default: 0.5)
+     * @param properties.id The id of the light.
+     * @param properties.name The name of the light.
+     * @param properties.groundColor The ground color of the light.
+     */
+    addHemisphereLight(properties: {
+        color?: Color;
+        intensity?: number;
+        groundColor?: Color;
+        id?: string;
+        name?: string;
+    }): IHemisphereLightApi;
+    /**
+     * Create a point light and add it to the light scene.
+     *
+     * @param properties.color The color of the light.
+     * @param properties.intensity The intensity of the light. (0-Infinity, default: 0.5)
+     * @param properties.id The id of the light.
+     * @param properties.name The name of the light.
+     * @param properties.position The position of the light.
+     * @param properties.distance The distance of the light.
+     * @param properties.decay The decay of the light.
+     */
+    addPointLight(properties: {
+        color?: Color;
+        intensity?: number;
+        position?: vec3;
+        distance?: number;
+        decay?: number;
+        id?: string;
+        name?: string;
+    }): IPointLightApi;
+    /**
+     * Create a point light and add it to the light scene.
+     *
+     * @param properties.color The color of the light.
+     * @param properties.intensity The intensity of the light. (0-Infinity, default: 0.5)
+     * @param properties.id The id of the light.
+     * @param properties.name The name of the light.
+     * @param properties.position The position of the light.
+     * @param properties.target The target of the light.
+     * @param properties.distance The distance of the light.
+     * @param properties.decay The decay of the light.
+     * @param properties.angle The angle of the light.
+     * @param properties.penumbra The penumbra of the light.
+     */
+    addSpotLight(properties: {
+        color?: Color;
+        intensity?: number;
+        position?: vec3;
+        target?: vec3;
+        distance?: number;
+        decay?: number;
+        angle?: number;
+        penumbra?: number;
+        id?: string;
+        name?: string;
+    }): ISpotLightApi;
+    /**
+     * Remove a light from the light scene with the specified id.
+     *
+     * @param id The id of the light to remove.
+     */
+    removeLight(id: string): boolean;
+}
 //# sourceMappingURL=ILightSceneApi.d.ts.map

package/dist/interfaces/lights/ILightSceneApi.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=ILightSceneApi.js.map

package/dist/interfaces/lights/types/IAmbientLightApi.d.ts

@@ -1,7 +1,7 @@
-import { ILightApi } from "../ILightApi";
-/**
- * The api for an ambient light.
- * An ambient light can be created by calling the {@link addAmbientLight} method.
- */
-export declare type IAmbientLightApi = ILightApi;
+import { ILightApi } from "../ILightApi";
+/**
+ * The api for an ambient light.
+ * An ambient light can be created by calling the {@link addAmbientLight} method.
+ */
+export type IAmbientLightApi = ILightApi;
 //# sourceMappingURL=IAmbientLightApi.d.ts.map

package/dist/interfaces/lights/types/IAmbientLightApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IAmbientLightApi.d.ts","sourceRoot":"","sources":["../../../../src/interfaces/lights/types/IAmbientLightApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,cAAc,CAAC;AAEvC;;;GAGG;AACH,oBAAY,gBAAgB,GAAG,SAAS,CAAC"}
+{"version":3,"file":"IAmbientLightApi.d.ts","sourceRoot":"","sources":["../../../../src/interfaces/lights/types/IAmbientLightApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,cAAc,CAAC;AAEvC;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,SAAS,CAAC"}

package/dist/interfaces/lights/types/IAmbientLightApi.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=IAmbientLightApi.js.map

package/dist/interfaces/lights/types/IDirectionalLightApi.d.ts

@@ -1,25 +1,25 @@
-import { vec3 } from "gl-matrix";
-import { ILightApi } from "../ILightApi";
-/**
- * The api for a directional light.
- * A directional light can be created by calling the {@link addDirectionalLight} method.
- */
-export interface IDirectionalLightApi extends ILightApi {
-    /**
-     * Option to cast shadows.
-     */
-    castShadow: boolean;
-    /**
-     * The direction of the light.
-     */
-    direction: vec3;
-    /**
-     * The bias of the shadow map.
-     */
-    shadowMapBias: number;
-    /**
-     * The resolution of the shadow map.
-     */
-    shadowMapResolution: number;
-}
+import { vec3 } from "gl-matrix";
+import { ILightApi } from "../ILightApi";
+/**
+ * The api for a directional light.
+ * A directional light can be created by calling the {@link addDirectionalLight} method.
+ */
+export interface IDirectionalLightApi extends ILightApi {
+    /**
+     * Option to cast shadows.
+     */
+    castShadow: boolean;
+    /**
+     * The direction of the light.
+     */
+    direction: vec3;
+    /**
+     * The bias of the shadow map.
+     */
+    shadowMapBias: number;
+    /**
+     * The resolution of the shadow map.
+     */
+    shadowMapResolution: number;
+}
 //# sourceMappingURL=IDirectionalLightApi.d.ts.map

package/dist/interfaces/lights/types/IDirectionalLightApi.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=IDirectionalLightApi.js.map

package/dist/interfaces/lights/types/IHemisphereLightApi.d.ts

@@ -1,13 +1,13 @@
-import { Color } from "@shapediver/viewer.shared.types";
-import { ILightApi } from "../ILightApi";
-/**
- * The api for an hemisphere light.
- * An hemisphere light can be created by calling the {@link addHemisphereLight} method.
- */
-export interface IHemisphereLightApi extends ILightApi {
-    /**
-     * The ground color of the light.
-     */
-    groundColor: Color;
-}
+import { Color } from "@shapediver/viewer.shared.types";
+import { ILightApi } from "../ILightApi";
+/**
+ * The api for an hemisphere light.
+ * An hemisphere light can be created by calling the {@link addHemisphereLight} method.
+ */
+export interface IHemisphereLightApi extends ILightApi {
+    /**
+     * The ground color of the light.
+     */
+    groundColor: Color;
+}
 //# sourceMappingURL=IHemisphereLightApi.d.ts.map

package/dist/interfaces/lights/types/IHemisphereLightApi.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=IHemisphereLightApi.js.map

package/dist/interfaces/lights/types/IPointLightApi.d.ts

@@ -1,21 +1,21 @@
-import { vec3 } from "gl-matrix";
-import { ILightApi } from "../ILightApi";
-/**
- * The api for a point light.
- * A point light can be created by calling the {@link addPointLight} method.
- */
-export interface IPointLightApi extends ILightApi {
-    /**
-     * The decay of the light.
-     */
-    decay: number;
-    /**
-     * The distance of the light.
-     */
-    distance: number;
-    /**
-     * The position of the light.
-     */
-    position: vec3;
-}
+import { vec3 } from "gl-matrix";
+import { ILightApi } from "../ILightApi";
+/**
+ * The api for a point light.
+ * A point light can be created by calling the {@link addPointLight} method.
+ */
+export interface IPointLightApi extends ILightApi {
+    /**
+     * The decay of the light.
+     */
+    decay: number;
+    /**
+     * The distance of the light.
+     */
+    distance: number;
+    /**
+     * The position of the light.
+     */
+    position: vec3;
+}
 //# sourceMappingURL=IPointLightApi.d.ts.map

package/dist/interfaces/lights/types/IPointLightApi.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=IPointLightApi.js.map

package/dist/interfaces/lights/types/ISpotLightApi.d.ts

@@ -1,33 +1,33 @@
-import { vec3 } from "gl-matrix";
-import { ILightApi } from "../ILightApi";
-/**
- * The api for a spot light.
- * A spot light can be created by calling the {@link addSpotLight} method.
- */
-export interface ISpotLightApi extends ILightApi {
-    /**
-     * The angle of the light.
-     */
-    angle: number;
-    /**
-     * The decay of the light.
-     */
-    decay: number;
-    /**
-     * The distance of the light.
-     */
-    distance: number;
-    /**
-     * The penumbra of the light.
-     */
-    penumbra: number;
-    /**
-     * The position of the light.
-     */
-    position: vec3;
-    /**
-     * The target of the light.
-     */
-    target: vec3;
-}
+import { vec3 } from "gl-matrix";
+import { ILightApi } from "../ILightApi";
+/**
+ * The api for a spot light.
+ * A spot light can be created by calling the {@link addSpotLight} method.
+ */
+export interface ISpotLightApi extends ILightApi {
+    /**
+     * The angle of the light.
+     */
+    angle: number;
+    /**
+     * The decay of the light.
+     */
+    decay: number;
+    /**
+     * The distance of the light.
+     */
+    distance: number;
+    /**
+     * The penumbra of the light.
+     */
+    penumbra: number;
+    /**
+     * The position of the light.
+     */
+    position: vec3;
+    /**
+     * The target of the light.
+     */
+    target: vec3;
+}
 //# sourceMappingURL=ISpotLightApi.d.ts.map

package/dist/interfaces/lights/types/ISpotLightApi.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=ISpotLightApi.js.map

package/dist/main.d.ts

@@ -1,31 +1,31 @@
-import { ViewportCreationDefinition } from "@shapediver/viewer.shared.types";
-import { IViewportApi } from "./interfaces/IViewportApi";
-/**
- * The viewports that are currently being used.
- */
-export declare const viewports: {
-    [key: string]: IViewportApi;
-};
-/**
- * Create and initialize a viewport with the provided type and canvas,
- * and return a viewport api object allowing to control it.
- *
- * An optional identifier for the viewport can be provided. This identifier can be used to retrieve the
- * viewport object from {@link viewports}. In case no identifier is provided, a unique one will be generated.
- *
- * By default a new viewport displays the complete scene tree. Viewports can be excluded from
- * displaying geometry for specific sessions by using the {@link excludeViewports} property of
- * {@link ISessionApi}.
- *
- * @param properties.visibility The visibility of the viewport.
- * @param properties.canvas The canvas that the viewport should use. A canvas element will be created if none is provided.
- * @param properties.id The unique identifier to use for the viewport.
- * @param properties.branding Optional branding options.
- * @param properties.visibilitySessionIds Optional list of session ids to be displayed in the viewport when the {@link VISIBILITY_MODE} is set to {@link VISIBILITY_MODE.SESSIONS}.
- * @param properties.sessionSettingsId Optional identifier of the session to be used for loading / persisting settings of the viewport when the {@link SESSION_SETTINGS_MODE} is set to MANUAL.
- * @param properties.sessionSettingsMode Allows to control which session to use for loading / persisting settings of the viewport. (default: {@link SESSION_SETTINGS_MODE.FIRST}).
- * @param properties.flags Optional flags that should be initially set on the viewport. The key is the token that is used to identify the flag, and the value is the type of the flag.
- * @returns
- */
-export declare const createViewport: (properties?: ViewportCreationDefinition) => Promise<IViewportApi>;
+import { ViewportCreationDefinition } from "@shapediver/viewer.shared.types";
+import { IViewportApi } from "./interfaces/IViewportApi";
+/**
+ * The viewports that are currently being used.
+ */
+export declare const viewports: {
+    [key: string]: IViewportApi;
+};
+/**
+ * Create and initialize a viewport with the provided type and canvas,
+ * and return a viewport api object allowing to control it.
+ *
+ * An optional identifier for the viewport can be provided. This identifier can be used to retrieve the
+ * viewport object from {@link viewports}. In case no identifier is provided, a unique one will be generated.
+ *
+ * By default a new viewport displays the complete scene tree. Viewports can be excluded from
+ * displaying geometry for specific sessions by using the {@link excludeViewports} property of
+ * {@link ISessionApi}.
+ *
+ * @param properties.visibility The visibility of the viewport.
+ * @param properties.canvas The canvas that the viewport should use. A canvas element will be created if none is provided.
+ * @param properties.id The unique identifier to use for the viewport.
+ * @param properties.branding Optional branding options.
+ * @param properties.visibilitySessionIds Optional list of session ids to be displayed in the viewport when the {@link VISIBILITY_MODE} is set to {@link VISIBILITY_MODE.SESSIONS}.
+ * @param properties.sessionSettingsId Optional identifier of the session to be used for loading / persisting settings of the viewport when the {@link SESSION_SETTINGS_MODE} is set to MANUAL.
+ * @param properties.sessionSettingsMode Allows to control which session to use for loading / persisting settings of the viewport. (default: {@link SESSION_SETTINGS_MODE.FIRST}).
+ * @param properties.flags Optional flags that should be initially set on the viewport. The key is the token that is used to identify the flag, and the value is the type of the flag.
+ * @returns
+ */
+export declare const createViewport: (properties?: ViewportCreationDefinition) => Promise<IViewportApi>;
 //# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAYA,OAAO,EAGN,0BAA0B,EAE1B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAC,YAAY,EAAC,MAAM,2BAA2B,CAAC;AAEvD;;GAEG;AACH,eAAO,MAAM,SAAS,EAAE;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;CAAM,CAAC;AAc3D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,cAAc,gBACb,0BAA0B,KACrC,QAAQ,YAAY,CAqItB,CAAC"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAYA,OAAO,EAGN,0BAA0B,EAE1B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAC,YAAY,EAAC,MAAM,2BAA2B,CAAC;AAEvD;;GAEG;AACH,eAAO,MAAM,SAAS,EAAE;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;CAAM,CAAC;AAc3D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,cAAc,GAC1B,aAAa,0BAA0B,KACrC,OAAO,CAAC,YAAY,CAqItB,CAAC"}