@inweb/viewer-core 27.5.0 → 27.6.1

package/lib/options/IOptions.d.ts

@@ -13,13 +13,13 @@ export interface IOptions {
      *
      * @defaultValue true
      */
-    showWCS?: boolean;
+    showWCS: boolean;
     /**
      * Enable camera animation.
      *
      * @defaultValue true
      */
-    cameraAnimation?: boolean;
+    cameraAnimation: boolean;
     /**
      * Enable anti-aliasing. Can be one of:
      *
@@ -31,72 +31,72 @@ export interface IOptions {
      *
      * @defaultValue true
      */
-    antialiasing?: boolean | string;
+    antialiasing: boolean | string;
     /**
      * Show ground shadows below the model.
      *
      * @defaultValue false
      */
-    groundShadow?: boolean;
+    groundShadow: boolean;
     /**
      * Enable ambient shadows.
      *
      * @defaultValue false
      */
-    shadows?: boolean;
+    shadows: boolean;
     /**
      * Camera speed on X axis.
      *
      * @defaultValue 4
      */
-    cameraAxisXSpeed?: number;
+    cameraAxisXSpeed: number;
     /**
      * Camera speed on Y axis.
      *
      * @defaultValue 1
      */
-    cameraAxisYSpeed?: number;
+    cameraAxisYSpeed: number;
     /**
      * Enable ambient occlusion.
      *
      * @defaultValue false
      */
-    ambientOcclusion?: boolean;
+    ambientOcclusion: boolean;
     /**
      * Enable streaming of drawings from the Open Cloud Server.
      *
      * If streaming is disabled, the file/assembly will be loaded in one go. The viewer will only update
      * once the loading is complete, which may take a while.
      *
-     * If streaming is enabled, {@link enablePartialMode | partial streaming} mode may be enabled as well.
+     * If streaming is enabled, {@link enablePartialMode | partial streaming} may be enabled as well.
      *
      * @defaultValue true
      */
-    enableStreamingMode?: boolean;
+    enableStreamingMode: boolean;
     /**
-     * Enable partial streaming mode to be able open large drawing.
+     * Enable partial streaming to be able open large drawing.
      *
-     * In partial streaming mode, the viewer keeps only visible objects in memory and loads other objects
-     * when the camera changes.
+     * In partial streaming, the viewer keeps only visible objects in memory and loads other objects when
+     * the camera changes.
      *
      * Only used if {@link enableStreamingMode | streaming} is enabled. If partial streaming is enabled,
      * then {@link sceneGraph | scene graph} will be disabled.
      *
      * @defaultValue false
      */
-    enablePartialMode?: boolean;
+    enablePartialMode: boolean;
     /**
      * The size of the memory buffer for graphics data, in bytes.
      *
      * @defaultValue 3294967296
      */
-    memoryLimit?: number;
+    memoryLimit: number;
     /**
      * Deprecated since `27.5`. Use {@link sectionFillColor} instead.
      *
      * @deprecated
      */
-    cuttingPlaneFillColor?: RGB;
+    cuttingPlaneFillColor: RGB;
     /**
      * Show solid fill on section caps.
      *
@@ -104,13 +104,13 @@ export interface IOptions {
      *
      * @defaultValue true
      */
-    enableSectionFill?: boolean;
+    enableSectionFill: boolean;
     /**
      * Section cap fill color.
      *
      * @defaultValue { red: 0xff, green: 0x98, blue: 0x00 }
      */
-    sectionFillColor?: {
+    sectionFillColor: {
         r: number;
         g: number;
         b: number;
@@ -123,19 +123,19 @@ export interface IOptions {
      *
      * @defaultValue false
      */
-    sectionUseObjectColor?: boolean;
+    sectionUseObjectColor: boolean;
     /**
      * Overlay a hatch pattern on top of the section fill.
      *
      * @defaultValue true
      */
-    enableSectionHatch?: boolean;
+    enableSectionHatch: boolean;
     /**
      * Hatch line color used on top of the section fill.
      *
      * @defaultValue { red: 0x4b, green: 0x4c, blue: 0x35 }
      */
-    sectionHatchColor?: {
+    sectionHatchColor: {
         r: number;
         g: number;
         b: number;
@@ -147,19 +147,19 @@ export interface IOptions {
      *
      * @defaultValue 8
      */
-    sectionHatchScale?: number;
+    sectionHatchScale: number;
     /**
      * Draw the outline contour along the section boundary.
      *
      * @defaultValue true
      */
-    enableSectionOutline?: boolean;
+    enableSectionOutline: boolean;
     /**
      * Color of the section outline contour.
      *
      * @defaultValue { red: 0, green: 0, blue: 0 }
      */
-    sectionOutlineColor?: {
+    sectionOutlineColor: {
         r: number;
         g: number;
         b: number;
@@ -169,11 +169,11 @@ export interface IOptions {
      *
      * @defaultValue 2
      */
-    sectionOutlineWidth?: number;
+    sectionOutlineWidth: number;
     /**
      * Edges highlight color.
      */
-    edgesColor?: {
+    edgesColor: {
         r: number;
         g: number;
         b: number;
@@ -181,7 +181,7 @@ export interface IOptions {
     /**
      * Faces highlight color.
      */
-    facesColor?: {
+    facesColor: {
         r: number;
         g: number;
         b: number;
@@ -189,28 +189,28 @@ export interface IOptions {
     /**
      * Show highlighted edges.
      */
-    edgesVisibility?: boolean;
+    edgesVisibility: boolean;
     /**
      * Show highlighted edges over drawing.
      */
-    edgesOverlap?: boolean;
+    edgesOverlap: boolean;
     /**
      * Show highlighted faces over drawing.
      */
-    facesOverlap?: boolean;
+    facesOverlap: boolean;
     /**
      * Highlighted faces transparency value, from 0 to 255.
      */
-    facesTransparancy?: number;
+    facesTransparancy: number;
     /**
      * Enable custom highlight settings.
      */
-    enableCustomHighlight?: boolean;
+    enableCustomHighlight: boolean;
     /**
      * Enable scene graph.
      *
      * Scene graph increases perfomance improvement, but consumes memory. If scene graph is enabled, then
-     * {@link enablePartialMode | partial streaming} mode will be disabled.
+     * {@link enablePartialMode | partial streaming} will be disabled.
      */
     sceneGraph: boolean;
     /**
@@ -244,7 +244,7 @@ export interface IOptions {
      * - `vsfx` - `VSFX` (default), for opening a file in `VisualizeJS` viewer.
      * - `gltf` - `glTF`, for opening a file in `Three.js` viewer.
      */
-    geometryType?: string;
+    geometryType: string;
     /**
      * Unit of measurement for the ruler tool (distance measurements).
      *
@@ -268,7 +268,7 @@ export interface IOptions {
      *
      * @defaultValue "Default"
      */
-    rulerUnit?: string;
+    rulerUnit: string;
     /**
      * Number of decimal places to display in ruler measurements.
      *
@@ -283,7 +283,7 @@ export interface IOptions {
      *
      * @defaultValue 2
      */
-    rulerPrecision?: any;
+    rulerPrecision: "Default" | "Auto" | number;
     /**
      * Camera projection mode:
      *
@@ -292,7 +292,7 @@ export interface IOptions {
      *
      * @defaultValue "perspective"
      */
-    cameraMode?: CameraMode;
+    cameraMode: CameraMode;
     /**
      * Default MIME type for snapshot images.
      *
@@ -304,7 +304,7 @@ export interface IOptions {
      *
      * @defaultValue "image/jpeg"
      */
-    snapshotMimeType?: string;
+    snapshotMimeType: string;
     /**
      * Default quality level for snapshot images when using lossy formats (JPEG, WebP).
      *
@@ -318,12 +318,6 @@ export interface IOptions {
      *
      * @defaultValue 0.25
      */
-    snapshotQuality?: number;
-    /**
-     * Resets options to default values.
-     *
-     * @param fields - Name of fields to be reset.
-     */
-    resetToDefaults?: (fields?: string[]) => void;
+    snapshotQuality: number;
 }
 export declare function defaultOptions(): IOptions;

package/lib/options/Options.d.ts

@@ -1,11 +1,15 @@
-import { EventEmitter2 } from "@inweb/eventemitter2";
+import { IEventEmitter } from "@inweb/eventemitter2";
 import { CameraMode, IOptions, RGB } from "./IOptions";
 export declare class Options implements IOptions {
-    protected _emitter?: EventEmitter2;
+    protected _emitter?: IEventEmitter;
     protected _data: IOptions;
-    constructor(emitter?: EventEmitter2);
+    protected _defaults: IOptions;
+    protected _updateCount: number;
+    constructor(emitter?: IEventEmitter);
     static defaults(): IOptions;
     change(): void;
+    beginUpdate(): void;
+    endUpdate(): void;
     saveToStorage(): void;
     loadFromStorage(): void;
     /**
@@ -13,9 +17,11 @@ export declare class Options implements IOptions {
      *
      * @param fields - Name of fields to be reset. Specify `undefined` to reset all.
      */
-    resetToDefaults(fields?: string[]): void;
+    resetToDefaults(fields?: string[], defaults?: IOptions): void;
+    setProperty<K extends keyof IOptions>(key: K, value?: IOptions[K], accept?: boolean): void;
+    isValidValue(key: keyof IOptions, value: unknown): boolean;
     get data(): IOptions;
-    set data(value: IOptions);
+    set data(value: Partial<IOptions>);
     get showWCS(): boolean;
     set showWCS(value: boolean);
     get cameraAnimation(): boolean;
@@ -126,8 +132,12 @@ export declare class Options implements IOptions {
     set geometryType(value: string);
     get rulerUnit(): string;
     set rulerUnit(value: string);
-    get rulerPrecision(): any;
-    set rulerPrecision(value: any);
+    get rulerPrecision(): "Default" | "Auto" | number;
+    set rulerPrecision(value: "Default" | "Auto" | number);
     get cameraMode(): CameraMode;
     set cameraMode(value: CameraMode);
+    get snapshotMimeType(): string;
+    set snapshotMimeType(value: string);
+    get snapshotQuality(): number;
+    set snapshotQuality(value: number);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/viewer-core",
-  "version": "27.5.0",
+  "version": "27.6.1",
   "description": "3D CAD and BIM data Viewer core",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -26,7 +26,7 @@
     "test": "karma start karma.conf.js"
   },
   "dependencies": {
-    "@inweb/client": "~27.5.0",
-    "@inweb/eventemitter2": "~27.5.0"
+    "@inweb/client": "~27.6.1",
+    "@inweb/eventemitter2": "~27.6.1"
   }
 }

package/src/loaders/Loader.ts

@@ -28,8 +28,7 @@ export class Loader implements ILoader {
   public abortController: AbortController = new AbortController();
 
   dispose(): void {
-    this.abortController.abort();
-    this.abortController = undefined;
+    this.cancel();
   }
 
   isSupport(file: FileSource, format?: string): boolean {
@@ -53,9 +52,9 @@ export class Loader implements ILoader {
   extractFileName(file: FileSource): string {
     const regex = /[^/\\?#:]+(?=\?|#|$)/;
 
-    if (typeof file === "string") return (file.match(regex) || [])[0];
-    else if (file instanceof globalThis.File) return (file.name.match(regex) || [])[0];
+    if (typeof file === "string") return (file.match(regex) || [])[0] || "";
+    else if (file instanceof globalThis.File) return (file.name.match(regex) || [])[0] || "";
 
-    return undefined;
+    return "";
   }
 }

package/src/loaders/Loaders.ts

@@ -42,7 +42,7 @@ class Loaders implements ILoadersRegistry {
   }
 
   createLoader(viewer: IViewer, file: FileSource, format?: string): ILoader | null {
-    let result: ILoader = null;
+    let result: ILoader | null = null;
     this._providers.forEach((provider, key) => {
       const loader = provider(viewer);
       if (loader.isSupport(file, format)) {

package/src/options/IOptions.ts

@@ -38,14 +38,14 @@ export interface IOptions {
    *
    * @defaultValue true
    */
-  showWCS?: boolean;
+  showWCS: boolean;
 
   /**
    * Enable camera animation.
    *
    * @defaultValue true
    */
-  cameraAnimation?: boolean;
+  cameraAnimation: boolean;
 
   /**
    * Enable anti-aliasing. Can be one of:
@@ -58,42 +58,42 @@ export interface IOptions {
    *
    * @defaultValue true
    */
-  antialiasing?: boolean | string;
+  antialiasing: boolean | string;
 
   /**
    * Show ground shadows below the model.
    *
    * @defaultValue false
    */
-  groundShadow?: boolean;
+  groundShadow: boolean;
 
   /**
    * Enable ambient shadows.
    *
    * @defaultValue false
    */
-  shadows?: boolean;
+  shadows: boolean;
 
   /**
    * Camera speed on X axis.
    *
    * @defaultValue 4
    */
-  cameraAxisXSpeed?: number;
+  cameraAxisXSpeed: number;
 
   /**
    * Camera speed on Y axis.
    *
    * @defaultValue 1
    */
-  cameraAxisYSpeed?: number;
+  cameraAxisYSpeed: number;
 
   /**
    * Enable ambient occlusion.
    *
    * @defaultValue false
    */
-  ambientOcclusion?: boolean;
+  ambientOcclusion: boolean;
 
   /**
    * Enable streaming of drawings from the Open Cloud Server.
@@ -101,38 +101,38 @@ export interface IOptions {
    * If streaming is disabled, the file/assembly will be loaded in one go. The viewer will only update
    * once the loading is complete, which may take a while.
    *
-   * If streaming is enabled, {@link enablePartialMode | partial streaming} mode may be enabled as well.
+   * If streaming is enabled, {@link enablePartialMode | partial streaming} may be enabled as well.
    *
    * @defaultValue true
    */
-  enableStreamingMode?: boolean;
+  enableStreamingMode: boolean;
 
   /**
-   * Enable partial streaming mode to be able open large drawing.
+   * Enable partial streaming to be able open large drawing.
    *
-   * In partial streaming mode, the viewer keeps only visible objects in memory and loads other objects
-   * when the camera changes.
+   * In partial streaming, the viewer keeps only visible objects in memory and loads other objects when
+   * the camera changes.
    *
    * Only used if {@link enableStreamingMode | streaming} is enabled. If partial streaming is enabled,
    * then {@link sceneGraph | scene graph} will be disabled.
    *
    * @defaultValue false
    */
-  enablePartialMode?: boolean;
+  enablePartialMode: boolean;
 
   /**
    * The size of the memory buffer for graphics data, in bytes.
    *
    * @defaultValue 3294967296
    */
-  memoryLimit?: number;
+  memoryLimit: number;
 
   /**
    * Deprecated since `27.5`. Use {@link sectionFillColor} instead.
    *
    * @deprecated
    */
-  cuttingPlaneFillColor?: RGB;
+  cuttingPlaneFillColor: RGB;
 
   /**
    * Show solid fill on section caps.
@@ -141,14 +141,14 @@ export interface IOptions {
    *
    * @defaultValue true
    */
-  enableSectionFill?: boolean;
+  enableSectionFill: boolean;
 
   /**
    * Section cap fill color.
    *
    * @defaultValue { red: 0xff, green: 0x98, blue: 0x00 }
    */
-  sectionFillColor?: { r: number; g: number; b: number };
+  sectionFillColor: { r: number; g: number; b: number };
 
   /**
    * Use the intersected object's color for the section cap fill.
@@ -158,21 +158,21 @@ export interface IOptions {
    *
    * @defaultValue false
    */
-  sectionUseObjectColor?: boolean;
+  sectionUseObjectColor: boolean;
 
   /**
    * Overlay a hatch pattern on top of the section fill.
    *
    * @defaultValue true
    */
-  enableSectionHatch?: boolean;
+  enableSectionHatch: boolean;
 
   /**
    * Hatch line color used on top of the section fill.
    *
    * @defaultValue { red: 0x4b, green: 0x4c, blue: 0x35 }
    */
-  sectionHatchColor?: { r: number; g: number; b: number };
+  sectionHatchColor: { r: number; g: number; b: number };
 
   /**
    * Distance between hatch lines, in screen-space pixels.
@@ -181,69 +181,69 @@ export interface IOptions {
    *
    * @defaultValue 8
    */
-  sectionHatchScale?: number;
+  sectionHatchScale: number;
 
   /**
    * Draw the outline contour along the section boundary.
    *
    * @defaultValue true
    */
-  enableSectionOutline?: boolean;
+  enableSectionOutline: boolean;
 
   /**
    * Color of the section outline contour.
    *
    * @defaultValue { red: 0, green: 0, blue: 0 }
    */
-  sectionOutlineColor?: { r: number; g: number; b: number };
+  sectionOutlineColor: { r: number; g: number; b: number };
 
   /**
    * Width of the section outline contour, in pixels.
    *
    * @defaultValue 2
    */
-  sectionOutlineWidth?: number;
+  sectionOutlineWidth: number;
 
   /**
    * Edges highlight color.
    */
-  edgesColor?: { r: number; g: number; b: number };
+  edgesColor: { r: number; g: number; b: number };
 
   /**
    * Faces highlight color.
    */
-  facesColor?: { r: number; g: number; b: number };
+  facesColor: { r: number; g: number; b: number };
 
   /**
    * Show highlighted edges.
    */
-  edgesVisibility?: boolean;
+  edgesVisibility: boolean;
 
   /**
    * Show highlighted edges over drawing.
    */
-  edgesOverlap?: boolean;
+  edgesOverlap: boolean;
 
   /**
    * Show highlighted faces over drawing.
    */
-  facesOverlap?: boolean;
+  facesOverlap: boolean;
 
   /**
    * Highlighted faces transparency value, from 0 to 255.
    */
-  facesTransparancy?: number;
+  facesTransparancy: number;
 
   /**
    * Enable custom highlight settings.
    */
-  enableCustomHighlight?: boolean;
+  enableCustomHighlight: boolean;
 
   /**
    * Enable scene graph.
    *
    * Scene graph increases perfomance improvement, but consumes memory. If scene graph is enabled, then
-   * {@link enablePartialMode | partial streaming} mode will be disabled.
+   * {@link enablePartialMode | partial streaming} will be disabled.
    */
   sceneGraph: boolean;
 
@@ -282,7 +282,7 @@ export interface IOptions {
    * - `vsfx` - `VSFX` (default), for opening a file in `VisualizeJS` viewer.
    * - `gltf` - `glTF`, for opening a file in `Three.js` viewer.
    */
-  geometryType?: string;
+  geometryType: string;
 
   /**
    * Unit of measurement for the ruler tool (distance measurements).
@@ -307,7 +307,7 @@ export interface IOptions {
    *
    * @defaultValue "Default"
    */
-  rulerUnit?: string;
+  rulerUnit: string;
 
   /**
    * Number of decimal places to display in ruler measurements.
@@ -323,7 +323,7 @@ export interface IOptions {
    *
    * @defaultValue 2
    */
-  rulerPrecision?: any;
+  rulerPrecision: "Default" | "Auto" | number;
 
   /**
    * Camera projection mode:
@@ -333,7 +333,7 @@ export interface IOptions {
    *
    * @defaultValue "perspective"
    */
-  cameraMode?: CameraMode;
+  cameraMode: CameraMode;
 
   /**
    * Default MIME type for snapshot images.
@@ -346,7 +346,7 @@ export interface IOptions {
    *
    * @defaultValue "image/jpeg"
    */
-  snapshotMimeType?: string;
+  snapshotMimeType: string;
 
   /**
    * Default quality level for snapshot images when using lossy formats (JPEG, WebP).
@@ -361,14 +361,7 @@ export interface IOptions {
    *
    * @defaultValue 0.25
    */
-  snapshotQuality?: number;
-
-  /**
-   * Resets options to default values.
-   *
-   * @param fields - Name of fields to be reset.
-   */
-  resetToDefaults?: (fields?: string[]) => void;
+  snapshotQuality: number;
 }
 
 export function defaultOptions(): IOptions {