@inweb/viewer-core 27.5.0 → 27.6.0

package/src/options/Options.ts

@@ -21,14 +21,14 @@
 // acknowledge and accept the above terms.
 ///////////////////////////////////////////////////////////////////////////////
 
-import { EventEmitter2 } from "@inweb/eventemitter2";
+import { IEventEmitter } from "@inweb/eventemitter2";
 import { CameraMode, defaultOptions, IOptions, RGB } from "./IOptions";
 
 export class Options implements IOptions {
-  protected _emitter?: EventEmitter2;
+  protected _emitter?: IEventEmitter;
   protected _data: IOptions;
 
-  constructor(emitter?: EventEmitter2) {
+  constructor(emitter?: IEventEmitter) {
     this._emitter = emitter;
     this._data = defaultOptions();
     this.loadFromStorage();
@@ -73,15 +73,23 @@ 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) {
-      const defaults = Options.defaults();
-      const resetData = fields.reduce((acc, field) => {
-        acc[field] = defaults[field];
-        return acc;
-      }, {});
-      this.data = { ...this.data, ...resetData };
+      const resetData: Partial<IOptions> = {};
+      for (const field of fields) {
+        if (field in defaults) resetData[field] = defaults[field];
+      }
+      this.data = resetData;
     } else {
-      this.data = { ...this.data, ...Options.defaults() };
+      this.data = defaults;
+    }
+  }
+
+  setProperty<K extends keyof IOptions>(key: K, value = Options.defaults()[key]): void {
+    // for object-valued fields any new literal counts as a change
+    if (this._data[key] !== value) {
+      this._data[key] = value;
+      this.change();
     }
   }
 
@@ -89,8 +97,14 @@ export class Options implements IOptions {
     return this._data;
   }
 
-  set data(value: IOptions) {
-    this._data = { ...Options.defaults(), ...this._data, ...value };
+  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;
@@ -111,8 +125,7 @@ export class Options implements IOptions {
   }
 
   set showWCS(value: boolean) {
-    this._data.showWCS = value;
-    this.change();
+    this.setProperty("showWCS", value);
   }
 
   get cameraAnimation(): boolean {
@@ -120,8 +133,7 @@ export class Options implements IOptions {
   }
 
   set cameraAnimation(value: boolean) {
-    this._data.cameraAnimation = value;
-    this.change();
+    this.setProperty("cameraAnimation", value);
   }
 
   get antialiasing(): boolean | string {
@@ -129,8 +141,7 @@ export class Options implements IOptions {
   }
 
   set antialiasing(value: boolean | string) {
-    this._data.antialiasing = value;
-    this.change();
+    this.setProperty("antialiasing", value);
   }
 
   get groundShadow(): boolean {
@@ -138,8 +149,7 @@ export class Options implements IOptions {
   }
 
   set groundShadow(value: boolean) {
-    this._data.groundShadow = value;
-    this.change();
+    this.setProperty("groundShadow", value);
   }
 
   get shadows(): boolean {
@@ -147,8 +157,7 @@ export class Options implements IOptions {
   }
 
   set shadows(value: boolean) {
-    this._data.shadows = value;
-    this.change();
+    this.setProperty("shadows", value);
   }
 
   get cameraAxisXSpeed(): number {
@@ -156,8 +165,7 @@ export class Options implements IOptions {
   }
 
   set cameraAxisXSpeed(value: number) {
-    this._data.cameraAxisXSpeed = value;
-    this.change();
+    this.setProperty("cameraAxisXSpeed", value);
   }
 
   get cameraAxisYSpeed(): number {
@@ -165,8 +173,7 @@ export class Options implements IOptions {
   }
 
   set cameraAxisYSpeed(value: number) {
-    this.cameraAxisYSpeed = value;
-    this.change();
+    this.setProperty("cameraAxisYSpeed", value);
   }
 
   get ambientOcclusion(): boolean {
@@ -174,8 +181,7 @@ export class Options implements IOptions {
   }
 
   set ambientOcclusion(value: boolean) {
-    this._data.ambientOcclusion = value;
-    this.change();
+    this.setProperty("ambientOcclusion", value);
   }
 
   get enableStreamingMode(): boolean {
@@ -183,9 +189,10 @@ export class Options implements IOptions {
   }
 
   set enableStreamingMode(value: boolean) {
-    this._data.enableStreamingMode = value;
-    if (!value) this._data.enablePartialMode = false;
-    this.change();
+    this.setProperty("enableStreamingMode", value);
+    if (!value) {
+      this.setProperty("enablePartialMode", false);
+    }
   }
 
   get enablePartialMode(): boolean {
@@ -193,12 +200,11 @@ export class Options implements IOptions {
   }
 
   set enablePartialMode(value: boolean) {
-    this._data.enablePartialMode = value;
+    this.setProperty("enablePartialMode", value);
     if (value) {
-      this._data.enableStreamingMode = true;
-      this._data.sceneGraph = false;
+      this.setProperty("enableStreamingMode", true);
+      this.setProperty("sceneGraph", false);
     }
-    this.change();
   }
 
   get memoryLimit(): number {
@@ -206,8 +212,7 @@ export class Options implements IOptions {
   }
 
   set memoryLimit(value: number) {
-    this._data.memoryLimit = value;
-    this.change();
+    this.setProperty("memoryLimit", value);
   }
 
   get cuttingPlaneFillColor(): RGB {
@@ -225,12 +230,11 @@ export class Options implements IOptions {
     console.warn(
       "Options.cuttingPlaneFillColor has been deprecated since 27.5 and will be removed in a future release, use sectionFillColor instead"
     );
-    this._data.sectionFillColor = {
+    this.setProperty("sectionFillColor", {
       r: value.red,
       g: value.green,
       b: value.blue,
-    };
-    this.change();
+    });
   }
 
   get enableSectionFill(): boolean {
@@ -238,17 +242,15 @@ export class Options implements IOptions {
   }
 
   set enableSectionFill(value: boolean) {
-    this._data.enableSectionFill = value;
-    this.change();
+    this.setProperty("enableSectionFill", value);
   }
 
-  get sectionFillColor() {
+  get sectionFillColor(): { r: number; g: number; b: number } {
     return this._data.sectionFillColor;
   }
 
-  set sectionFillColor(value) {
-    this._data.sectionFillColor = value;
-    this.change();
+  set sectionFillColor(value: { r: number; g: number; b: number }) {
+    this.setProperty("sectionFillColor", value);
   }
 
   get sectionUseObjectColor(): boolean {
@@ -256,8 +258,7 @@ export class Options implements IOptions {
   }
 
   set sectionUseObjectColor(value: boolean) {
-    this._data.sectionUseObjectColor = value;
-    this.change();
+    this.setProperty("sectionUseObjectColor", value);
   }
 
   get enableSectionHatch(): boolean {
@@ -265,17 +266,15 @@ export class Options implements IOptions {
   }
 
   set enableSectionHatch(value: boolean) {
-    this._data.enableSectionHatch = value;
-    this.change();
+    this.setProperty("enableSectionHatch", value);
   }
 
-  get sectionHatchColor() {
+  get sectionHatchColor(): { r: number; g: number; b: number } {
     return this._data.sectionHatchColor;
   }
 
-  set sectionHatchColor(value) {
-    this._data.sectionHatchColor = value;
-    this.change();
+  set sectionHatchColor(value: { r: number; g: number; b: number }) {
+    this.setProperty("sectionHatchColor", value);
   }
 
   get sectionHatchScale(): number {
@@ -283,8 +282,7 @@ export class Options implements IOptions {
   }
 
   set sectionHatchScale(value: number) {
-    this._data.sectionHatchScale = value;
-    this.change();
+    this.setProperty("sectionHatchScale", value);
   }
 
   get enableSectionOutline(): boolean {
@@ -292,17 +290,15 @@ export class Options implements IOptions {
   }
 
   set enableSectionOutline(value: boolean) {
-    this._data.enableSectionOutline = value;
-    this.change();
+    this.setProperty("enableSectionOutline", value);
   }
 
-  get sectionOutlineColor() {
+  get sectionOutlineColor(): { r: number; g: number; b: number } {
     return this._data.sectionOutlineColor;
   }
 
-  set sectionOutlineColor(value) {
-    this._data.sectionOutlineColor = value;
-    this.change();
+  set sectionOutlineColor(value: { r: number; g: number; b: number }) {
+    this.setProperty("sectionOutlineColor", value);
   }
 
   get sectionOutlineWidth(): number {
@@ -310,126 +306,114 @@ export class Options implements IOptions {
   }
 
   set sectionOutlineWidth(value: number) {
-    this._data.sectionOutlineWidth = value;
-    this.change();
+    this.setProperty("sectionOutlineWidth", value);
   }
 
-  get edgesColor() {
+  get edgesColor(): { r: number; g: number; b: number } {
     return this._data.edgesColor;
   }
 
-  set edgesColor(value) {
-    this._data.edgesColor = value;
-    this.change();
+  set edgesColor(value: { r: number; g: number; b: number }) {
+    this.setProperty("edgesColor", value);
   }
 
-  get facesColor() {
+  get facesColor(): { r: number; g: number; b: number } {
     return this._data.facesColor;
   }
 
-  set facesColor(value) {
-    this._data.facesColor = value;
-    this.change();
+  set facesColor(value: { r: number; g: number; b: number }) {
+    this.setProperty("facesColor", value);
   }
 
-  get edgesVisibility() {
+  get edgesVisibility(): boolean {
     return this._data.edgesVisibility;
   }
 
-  set edgesVisibility(value) {
-    this._data.edgesVisibility = value;
-    this.change();
+  set edgesVisibility(value: boolean) {
+    this.setProperty("edgesVisibility", value);
   }
 
-  get edgesOverlap() {
+  get edgesOverlap(): boolean {
     return this._data.edgesOverlap;
   }
 
-  set edgesOverlap(value) {
-    this._data.edgesOverlap = value;
-    this.change();
+  set edgesOverlap(value: boolean) {
+    this.setProperty("edgesOverlap", value);
   }
 
-  get facesOverlap() {
+  get facesOverlap(): boolean {
     return this._data.facesOverlap;
   }
 
-  set facesOverlap(value) {
-    this._data.facesOverlap = value;
-    this.change();
+  set facesOverlap(value: boolean) {
+    this.setProperty("facesOverlap", value);
   }
 
-  get facesTransparancy() {
+  get facesTransparancy(): number {
     return this._data.facesTransparancy;
   }
 
-  set facesTransparancy(value) {
-    this._data.facesTransparancy = value;
-    this.change();
+  set facesTransparancy(value: number) {
+    this.setProperty("facesTransparancy", value);
   }
 
-  get enableCustomHighlight() {
+  get enableCustomHighlight(): boolean {
     return this._data.enableCustomHighlight;
   }
 
-  set enableCustomHighlight(value) {
-    this._data.enableCustomHighlight = value;
-    this.change();
+  set enableCustomHighlight(value: boolean) {
+    this.setProperty("enableCustomHighlight", value);
   }
 
-  get sceneGraph() {
+  get sceneGraph(): boolean {
     return this._data.sceneGraph;
   }
 
-  set sceneGraph(value) {
-    this._data.sceneGraph = value;
-    if (value) this._data.enablePartialMode = false;
-    this.change();
+  set sceneGraph(value: boolean) {
+    this.setProperty("sceneGraph", value);
+    if (value) {
+      this.setProperty("enablePartialMode", false);
+    }
   }
 
-  get edgeModel() {
+  get edgeModel(): boolean {
     return Boolean(this._data.edgeModel);
   }
 
-  set edgeModel(value) {
-    this._data.edgeModel = Boolean(value);
-    this.change();
+  set edgeModel(value: boolean) {
+    this.setProperty("edgeModel", value);
   }
 
-  get reverseZoomWheel() {
+  get reverseZoomWheel(): boolean {
     return this._data.reverseZoomWheel;
   }
 
   set reverseZoomWheel(value: boolean) {
-    this._data.reverseZoomWheel = !!value;
-    this.change();
+    this.setProperty("reverseZoomWheel", value);
   }
 
-  get enableZoomWheel() {
+  get enableZoomWheel(): boolean {
     return this._data.enableZoomWheel;
   }
 
   set enableZoomWheel(value: boolean) {
-    this._data.enableZoomWheel = !!value;
-    this.change();
+    this.setProperty("enableZoomWheel", value);
   }
 
-  get enableGestures() {
+  get enableGestures(): boolean {
     return this._data.enableGestures;
   }
 
   set enableGestures(value: boolean) {
-    this._data.enableGestures = !!value;
-    this.change();
+    this.setProperty("enableGestures", value);
   }
 
-  get geometryType() {
+  get geometryType(): string {
     return this._data.geometryType;
   }
 
   set geometryType(value: string) {
-    this._data.geometryType = value;
-    this.change();
+    this.setProperty("geometryType", value);
   }
 
   get rulerUnit(): string {
@@ -437,17 +421,15 @@ export class Options implements IOptions {
   }
 
   set rulerUnit(value: string) {
-    this._data.rulerUnit = value;
-    this.change();
+    this.setProperty("rulerUnit", value);
   }
 
-  get rulerPrecision(): any {
+  get rulerPrecision(): "Default" | "Auto" | number {
     return this._data.rulerPrecision;
   }
 
-  set rulerPrecision(value: any) {
-    this._data.rulerPrecision = value;
-    this.change();
+  set rulerPrecision(value: "Default" | "Auto" | number) {
+    this.setProperty("rulerPrecision", value);
   }
 
   get cameraMode(): CameraMode {
@@ -455,7 +437,22 @@ export class Options implements IOptions {
   }
 
   set cameraMode(value: CameraMode) {
-    this._data.cameraMode = value;
-    this.change();
+    this.setProperty("cameraMode", value);
+  }
+
+  get snapshotMimeType(): string {
+    return this._data.snapshotMimeType;
+  }
+
+  set snapshotMimeType(value: string) {
+    this.setProperty("snapshotMimeType", value);
+  }
+
+  get snapshotQuality(): number {
+    return this._data.snapshotQuality;
+  }
+
+  set snapshotQuality(value: number) {
+    this.setProperty("snapshotQuality", value);
   }
 }