@inweb/viewer-core 27.4.7 → 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,10 +97,26 @@ export class Options implements IOptions {
     return this._data;
   }
 
-  set data(value: IOptions) {
-    const enablePartialMode = value.enableStreamingMode ? value.enablePartialMode : false;
-    const sceneGraph = enablePartialMode ? false : value.sceneGraph;
-    this._data = { ...Options.defaults(), ...this._data, ...value, enablePartialMode, sceneGraph };
+  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;
+    }
+    // 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();
   }
 
@@ -101,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 {
@@ -110,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 {
@@ -119,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 {
@@ -128,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 {
@@ -137,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 {
@@ -146,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 {
@@ -155,8 +173,7 @@ export class Options implements IOptions {
   }
 
   set cameraAxisYSpeed(value: number) {
-    this.cameraAxisYSpeed = value;
-    this.change();
+    this.setProperty("cameraAxisYSpeed", value);
   }
 
   get ambientOcclusion(): boolean {
@@ -164,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 {
@@ -173,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 {
@@ -183,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 {
@@ -196,135 +212,208 @@ export class Options implements IOptions {
   }
 
   set memoryLimit(value: number) {
-    this._data.memoryLimit = value;
-    this.change();
+    this.setProperty("memoryLimit", value);
   }
 
   get cuttingPlaneFillColor(): RGB {
-    return this._data.cuttingPlaneFillColor;
+    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,
+    };
   }
 
   set cuttingPlaneFillColor(value: RGB) {
-    this._data.cuttingPlaneFillColor = value;
-    this.change();
+    console.warn(
+      "Options.cuttingPlaneFillColor has been deprecated since 27.5 and will be removed in a future release, use sectionFillColor instead"
+    );
+    this.setProperty("sectionFillColor", {
+      r: value.red,
+      g: value.green,
+      b: value.blue,
+    });
+  }
+
+  get enableSectionFill(): boolean {
+    return this._data.enableSectionFill;
+  }
+
+  set enableSectionFill(value: boolean) {
+    this.setProperty("enableSectionFill", value);
+  }
+
+  get sectionFillColor(): { r: number; g: number; b: number } {
+    return this._data.sectionFillColor;
+  }
+
+  set sectionFillColor(value: { r: number; g: number; b: number }) {
+    this.setProperty("sectionFillColor", value);
+  }
+
+  get sectionUseObjectColor(): boolean {
+    return this._data.sectionUseObjectColor;
+  }
+
+  set sectionUseObjectColor(value: boolean) {
+    this.setProperty("sectionUseObjectColor", value);
+  }
+
+  get enableSectionHatch(): boolean {
+    return this._data.enableSectionHatch;
+  }
+
+  set enableSectionHatch(value: boolean) {
+    this.setProperty("enableSectionHatch", value);
+  }
+
+  get sectionHatchColor(): { r: number; g: number; b: number } {
+    return this._data.sectionHatchColor;
+  }
+
+  set sectionHatchColor(value: { r: number; g: number; b: number }) {
+    this.setProperty("sectionHatchColor", value);
   }
 
-  get edgesColor() {
+  get sectionHatchScale(): number {
+    return this._data.sectionHatchScale;
+  }
+
+  set sectionHatchScale(value: number) {
+    this.setProperty("sectionHatchScale", value);
+  }
+
+  get enableSectionOutline(): boolean {
+    return this._data.enableSectionOutline;
+  }
+
+  set enableSectionOutline(value: boolean) {
+    this.setProperty("enableSectionOutline", value);
+  }
+
+  get sectionOutlineColor(): { r: number; g: number; b: number } {
+    return this._data.sectionOutlineColor;
+  }
+
+  set sectionOutlineColor(value: { r: number; g: number; b: number }) {
+    this.setProperty("sectionOutlineColor", value);
+  }
+
+  get sectionOutlineWidth(): number {
+    return this._data.sectionOutlineWidth;
+  }
+
+  set sectionOutlineWidth(value: number) {
+    this.setProperty("sectionOutlineWidth", value);
+  }
+
+  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 {
@@ -332,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 {
@@ -350,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);
   }
 }

package/src/viewer/IViewer.ts

@@ -167,10 +167,12 @@ export interface IViewer extends IEventEmitter, ICommandService {
    * - {@link UpdateEvent | update}
    * - {@link RenderEvent | render}
    *
-   * @param force - If `true` updates the viewer immidietly. Otherwise the update will be scheduled for
-   *   the next animation frame. Default is `false`.
+   * @param force - If `true` updates the viewer immidietly. If a `number` is specified and more than the
+   *   given amount of milliseconds has elapsed since the last rendering, the update is performed
+   *   immediately as well. Otherwise the update will be scheduled for the next animation frame. Default
+   *   is `false`.
    */
-  update(force?: boolean): void;
+  update(force?: boolean | number): void;
 
   /**
    * Loads a file into the viewer.

package/src/viewer/IViewpoint.ts

@@ -226,9 +226,10 @@ export interface IText {
   font_size?: number;
 
   /**
-   * Deprecated. Use {@link font_size} instead.
+   * Deprecated since `25.3`. Use {@link font_size} instead.
+   *
+   * @deprecated
    */
-
   text_size?: number;
 
   /**
@@ -373,12 +374,16 @@ export interface IImage {
   src: string;
 
   /**
-   * Deprecated. Use {@link position2} instead. Width of the image.
+   * Deprecated since `26.5`. Use {@link position2} instead. Width of the image.
+   *
+   * @deprecated
    */
   width?: number;
 
   /**
-   * Deprecated. Use {@link position2} instead. Height of the image.
+   * Deprecated since `26.5`. Use {@link position2} instead. Height of the image.
+   *
+   * @deprecated
    */
   height?: number;
 
@@ -403,12 +408,16 @@ export interface IRectangle {
   position2: IPoint;
 
   /**
-   * Deprecated. Use {@link position2} instead. Width of the rectangle.
+   * Deprecated since `26.5`. Use {@link position2} instead. Width of the rectangle.
+   *
+   * @deprecated
    */
   width?: number;
 
   /**
-   * Deprecated. Use {@link position2} instead. Height of the rectangle.
+   * Deprecated since `26.5`. Use {@link position2} instead. Height of the rectangle.
+   *
+   * @deprecated
    */
   height?: number;
 

package/src/viewer/ViewerEvents.ts

@@ -100,6 +100,20 @@ export interface ChangeCameraModeEvent {
   mode: string;
 }
 
+/**
+ * Event that fires when cutting planes (slices) have been changed.
+ *
+ * Fires when cutting planes are added, deleted, or transformed (moved/rotated).
+ *
+ * @event
+ */
+export interface ChangeCuttingPlanesEvent {
+  /**
+   * Event type.
+   */
+  type: "changecuttingplanes";
+}
+
 /**
  * Event that fires when the default color of new markup objects has been changed.
  *
@@ -807,6 +821,11 @@ export interface ViewerEventMap {
    */
   changecameramode: ChangeCameraModeEvent;
 
+  /**
+   * Event that fires when cutting planes (slices) have been changed.
+   */
+  changecuttingplanes: ChangeCuttingPlanesEvent;
+
   /**
    * Event that fires when the markup color has been changed.
    */