@inweb/viewer-core 27.6.0 → 27.6.1

package/src/options/Options.ts

@@ -24,13 +24,36 @@
 import { IEventEmitter } from "@inweb/eventemitter2";
 import { CameraMode, defaultOptions, IOptions, RGB } from "./IOptions";
 
+function isColorRGB(value: unknown): boolean {
+  return (
+    typeof value === "object" &&
+    value !== null &&
+    typeof (value as { r?: unknown }).r === "number" &&
+    typeof (value as { g?: unknown }).g === "number" &&
+    typeof (value as { b?: unknown }).b === "number"
+  );
+}
+
+function isLegacyRGB(value: unknown): boolean {
+  return (
+    typeof value === "object" &&
+    value !== null &&
+    typeof (value as { red?: unknown }).red === "number" &&
+    typeof (value as { green?: unknown }).green === "number" &&
+    typeof (value as { blue?: unknown }).blue === "number"
+  );
+}
+
 export class Options implements IOptions {
   protected _emitter?: IEventEmitter;
   protected _data: IOptions;
+  protected _defaults: IOptions;
+  protected _updateCount = 0;
 
   constructor(emitter?: IEventEmitter) {
     this._emitter = emitter;
-    this._data = defaultOptions();
+    this._data = Options.defaults();
+    this._defaults = Options.defaults();
     this.loadFromStorage();
   }
 
@@ -39,12 +62,21 @@ export class Options implements IOptions {
   }
 
   change(): void {
-    if (this._emitter !== undefined) {
+    if (this._emitter !== undefined && this._updateCount === 0) {
       this.saveToStorage();
       this._emitter.emit({ type: "optionschange", data: this });
     }
   }
 
+  beginUpdate(): void {
+    this._updateCount++;
+  }
+
+  endUpdate(): void {
+    this._updateCount--;
+    this.change();
+  }
+
   saveToStorage(): void {
     if (typeof window !== "undefined")
       try {
@@ -58,10 +90,7 @@ export class Options implements IOptions {
     if (typeof window !== "undefined")
       try {
         const item = localStorage.getItem("od-client-settings");
-        if (item) {
-          const data = JSON.parse(item);
-          this.data = { ...data };
-        }
+        if (item) this.data = JSON.parse(item);
       } catch (error) {
         console.error("Cannot load client settings.", error);
       }
@@ -72,9 +101,8 @@ export class Options implements IOptions {
    *
    * @param fields - Name of fields to be reset. Specify `undefined` to reset all.
    */
-  resetToDefaults(fields?: string[]): void {
-    const defaults = Options.defaults();
-    if (fields !== undefined) {
+  resetToDefaults(fields?: string[], defaults: IOptions = this._defaults): void {
+    if (Array.isArray(fields)) {
       const resetData: Partial<IOptions> = {};
       for (const field of fields) {
         if (field in defaults) resetData[field] = defaults[field];
@@ -85,39 +113,47 @@ export class Options implements IOptions {
     }
   }
 
-  setProperty<K extends keyof IOptions>(key: K, value = Options.defaults()[key]): void {
-    // for object-valued fields any new literal counts as a change
+  setProperty<K extends keyof IOptions>(
+    key: K,
+    value: IOptions[K] = this._defaults[key],
+    accept: boolean = this.isValidValue(key, value)
+  ): void {
+    if (!accept) {
+      console.warn(`Options.${key}: Invalid value`, value);
+      return;
+    }
     if (this._data[key] !== value) {
       this._data[key] = value;
       this.change();
     }
   }
 
+  isValidValue(key: keyof IOptions, value: unknown): boolean {
+    return typeof value === typeof this._defaults[key];
+  }
+
   get data(): IOptions {
     return this._data;
   }
 
   set data(value: Partial<IOptions>) {
-    const defaults = Options.defaults();
-    const merged: IOptions = { ...defaults, ...this._data, ...value };
-    // replace undefined to default value for known properties
-    for (const key of Object.keys(defaults)) {
-      if (merged[key] === undefined) merged[key] = defaults[key];
-    }
-    this._data = merged;
-    // partial mode first
-    if (this._data.enablePartialMode) {
-      this._data.enableStreamingMode = true;
-      this._data.sceneGraph = false;
+    this.beginUpdate();
+    try {
+      for (const key of Object.keys(value)) {
+        if (key in this._defaults) this[key] = value[key];
+        else this._data[key] = value[key];
+      }
+      // partial streaming first
+      if ("enablePartialMode" in value) {
+        this.enablePartialMode = (value as IOptions).enablePartialMode;
+      }
+      // sectionFillColor since 27.5
+      if ("sectionFillColor" in value) {
+        this.sectionFillColor = (value as IOptions).sectionFillColor;
+      }
+    } finally {
+      this.endUpdate();
     }
-    // sectionFillColor since 27.5
-    if (!value.sectionFillColor && value.cuttingPlaneFillColor)
-      this._data.sectionFillColor = {
-        r: value.cuttingPlaneFillColor.red,
-        g: value.cuttingPlaneFillColor.green,
-        b: value.cuttingPlaneFillColor.blue,
-      };
-    this.change();
   }
 
   get showWCS(): boolean {
@@ -141,7 +177,7 @@ export class Options implements IOptions {
   }
 
   set antialiasing(value: boolean | string) {
-    this.setProperty("antialiasing", value);
+    this.setProperty("antialiasing", value, typeof value === "boolean" || typeof value === "string");
   }
 
   get groundShadow(): boolean {
@@ -190,9 +226,8 @@ export class Options implements IOptions {
 
   set enableStreamingMode(value: boolean) {
     this.setProperty("enableStreamingMode", value);
-    if (!value) {
-      this.setProperty("enablePartialMode", false);
-    }
+    // partial streaming is only used if streaming is enabled
+    this.setProperty("enablePartialMode", this.enablePartialMode && this.enableStreamingMode);
   }
 
   get enablePartialMode(): boolean {
@@ -201,10 +236,9 @@ export class Options implements IOptions {
 
   set enablePartialMode(value: boolean) {
     this.setProperty("enablePartialMode", value);
-    if (value) {
-      this.setProperty("enableStreamingMode", true);
-      this.setProperty("sceneGraph", false);
-    }
+    // partial streaming requires streaming enabled and disables scene graph
+    this.setProperty("enableStreamingMode", this.enableStreamingMode || this.enablePartialMode);
+    this.setProperty("sceneGraph", this.sceneGraph && !this.enablePartialMode);
   }
 
   get memoryLimit(): number {
@@ -216,25 +250,26 @@ export class Options implements IOptions {
   }
 
   get cuttingPlaneFillColor(): RGB {
-    console.warn(
-      "Options.cuttingPlaneFillColor has been deprecated since 27.5 and will be removed in a future release, use sectionFillColor instead"
-    );
-    return {
-      red: this._data.sectionFillColor.r,
-      green: this._data.sectionFillColor.g,
-      blue: this._data.sectionFillColor.b,
-    };
+    return this._data.cuttingPlaneFillColor;
   }
 
   set cuttingPlaneFillColor(value: RGB) {
-    console.warn(
-      "Options.cuttingPlaneFillColor has been deprecated since 27.5 and will be removed in a future release, use sectionFillColor instead"
+    if (this._updateCount === 0) {
+      console.warn(
+        "Options.cuttingPlaneFillColor has been deprecated since 27.5 and will be removed in a future release, use sectionFillColor instead"
+      );
+    }
+    this.setProperty("cuttingPlaneFillColor", value, isLegacyRGB(value));
+    // kept in sync with sectionFillColor (deprecated since 27.5)
+    this.setProperty(
+      "sectionFillColor",
+      {
+        r: this._data.cuttingPlaneFillColor.red,
+        g: this._data.cuttingPlaneFillColor.green,
+        b: this._data.cuttingPlaneFillColor.blue,
+      },
+      true
     );
-    this.setProperty("sectionFillColor", {
-      r: value.red,
-      g: value.green,
-      b: value.blue,
-    });
   }
 
   get enableSectionFill(): boolean {
@@ -250,7 +285,17 @@ export class Options implements IOptions {
   }
 
   set sectionFillColor(value: { r: number; g: number; b: number }) {
-    this.setProperty("sectionFillColor", value);
+    this.setProperty("sectionFillColor", value, isColorRGB(value));
+    // kept in sync with cuttingPlaneFillColor (deprecated since 27.5)
+    this.setProperty(
+      "cuttingPlaneFillColor",
+      {
+        red: this._data.sectionFillColor.r,
+        green: this._data.sectionFillColor.g,
+        blue: this._data.sectionFillColor.b,
+      },
+      true
+    );
   }
 
   get sectionUseObjectColor(): boolean {
@@ -274,7 +319,7 @@ export class Options implements IOptions {
   }
 
   set sectionHatchColor(value: { r: number; g: number; b: number }) {
-    this.setProperty("sectionHatchColor", value);
+    this.setProperty("sectionHatchColor", value, isColorRGB(value));
   }
 
   get sectionHatchScale(): number {
@@ -298,7 +343,7 @@ export class Options implements IOptions {
   }
 
   set sectionOutlineColor(value: { r: number; g: number; b: number }) {
-    this.setProperty("sectionOutlineColor", value);
+    this.setProperty("sectionOutlineColor", value, isColorRGB(value));
   }
 
   get sectionOutlineWidth(): number {
@@ -314,7 +359,7 @@ export class Options implements IOptions {
   }
 
   set edgesColor(value: { r: number; g: number; b: number }) {
-    this.setProperty("edgesColor", value);
+    this.setProperty("edgesColor", value, isColorRGB(value));
   }
 
   get facesColor(): { r: number; g: number; b: number } {
@@ -322,7 +367,7 @@ export class Options implements IOptions {
   }
 
   set facesColor(value: { r: number; g: number; b: number }) {
-    this.setProperty("facesColor", value);
+    this.setProperty("facesColor", value, isColorRGB(value));
   }
 
   get edgesVisibility(): boolean {
@@ -371,9 +416,8 @@ export class Options implements IOptions {
 
   set sceneGraph(value: boolean) {
     this.setProperty("sceneGraph", value);
-    if (value) {
-      this.setProperty("enablePartialMode", false);
-    }
+    // scene graph and partial streaming are mutually exclusive
+    this.setProperty("enablePartialMode", this.enablePartialMode && !this.sceneGraph);
   }
 
   get edgeModel(): boolean {
@@ -429,15 +473,15 @@ export class Options implements IOptions {
   }
 
   set rulerPrecision(value: "Default" | "Auto" | number) {
-    this.setProperty("rulerPrecision", value);
+    this.setProperty("rulerPrecision", value, typeof value === "number" || value === "Default" || value === "Auto");
   }
 
   get cameraMode(): CameraMode {
-    return this._data.cameraMode || "perspective";
+    return this._data.cameraMode;
   }
 
   set cameraMode(value: CameraMode) {
-    this.setProperty("cameraMode", value);
+    this.setProperty("cameraMode", value, value === "perspective" || value === "orthographic");
   }
 
   get snapshotMimeType(): string {