@inweb/viewer-core 25.3.18 → 25.3.19

package/src/options/Options.ts

@@ -22,220 +22,30 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { EventEmitter2 } from "@inweb/eventemitter2";
+import { IOptions, RGB, defaultOptions } from "./IOptions";
 
-export interface RGB {
-  red: number;
-  green: number;
-  blue: number;
-}
-
-/**
- * `VisualizeJS` parameters.
- */
-export interface OptionsData {
-  /**
-   * Show WCS
-   *
-   * @defaultValue true
-   */
-  showWCS?: boolean;
-
-  /**
-   * Enable camera animation
-   *
-   * @defaultValue true
-   */
-  cameraAnimation?: boolean;
-
-  /**
-   * Enable antialiasing use FXAA
-   *
-   * @defaultValue true
-   */
-  antialiasing?: boolean;
-
-  /**
-   * Enable ground shadows
-   *
-   * @defaultValue false
-   */
-  groundShadow?: boolean;
-
-  /**
-   * Enable shadows
-   *
-   * @defaultValue false
-   */
-  shadows?: boolean;
-
-  /**
-   * Camera speed on X axis
-   *
-   * @defaultValue 4
-   */
-  cameraAxisXSpeed?: number;
-
-  /**
-   * Camera speed on Y axis
-   *
-   * @defaultValue 1
-   */
-  cameraAxisYSpeed?: number;
-
-  /**
-   * Ambient occlusion
-   *
-   * @defaultValue false
-   */
-  ambientOcclusion?: boolean;
-
-  /**
-   * Enable streaming mode
-   *
-   * If enableStreamingMode is true then enablePartialMode will be used, otherwise -
-   * enablePartialMode will be ignored and file / assembly will be loaded in one go
-   *
-   * @defaultValue true
-   */
-  enableStreamingMode?: boolean;
-
-  /**
-   * Enable partial load mode to be able open large drawing If enablePartialMode enabled, then
-   * sceneGraph will be switched off
-   *
-   * @defaultValue false
-   */
-  enablePartialMode?: boolean;
-
-  /**
-   * The size of the memory buffer that the Viewer can use for graphics data
-   *
-   * @defaultValue 3294967296
-   */
-  memoryLimit?: number;
-
-  /**
-   * Cutting plane fill color
-   *
-   * @defaultValue { red: 0xff, green: 0x98, blue: 0x00 }
-   */
-  cuttingPlaneFillColor?: RGB;
-
-  /**
-   * Outline edges color in RGB format.
-   */
-  edgesColor?: { r: number; g: number; b: number };
-
-  /**
-   * Faces color in the RGB format.
-   */
-  facesColor?: { r: number; g: number; b: number };
-
-  /**
-   * Show or hide edges.
-   */
-  edgesVisibility?: boolean;
-
-  /**
-   * Show edges over drawing.
-   */
-  edgesOverlap?: boolean;
-
-  /**
-   * Show faces over drawing.
-   */
-  facesOverlap?: boolean;
-
-  /**
-   * Faces transparency value from 0 to 255.
-   */
-  facesTransparancy?: number;
-
-  /**
-   * Enable custom highlight settings.
-   */
-  enableCustomHighlight?: boolean;
-
-  /**
-   * Enable or disable scene graph, it increases perfomance improvement, but consumes memory
-   * Large drawings can take up a lot of memory. If sceneGraph enabled, then enablePartialMode
-   * will be switched off
-   */
-  sceneGraph: boolean;
-
-  /**
-   * Edge display models. No edges is usefull for less memory consumption: `false` - no edges
-   * are displayed, `true` - display isolines.
-   */
-  edgeModel: boolean;
-
-  /**
-   * Reverse the mouse wheel direction for zooming: false - moving the wheel up zooms in,
-   * moving down zooms out, `true` - moving the wheel up zooms out, moving down zooms in.
-   */
-  reverseZoomWheel: boolean;
-
-  /**
-   * Enable mouse wheel zooming.
-   */
-  enableZoomWheel: boolean;
-
-  /**
-   * Enable touch gestures. This option will be ignored when enableZoomWheel is disabled, since
-   * gestures contains touch zoom.
-   */
-  enableGestures: boolean;
-
-  /**
-   * Default file geometry data type. Can be one of:
-   *
-   * - `vsfx` - `VSFX` (default), for opening a file in `VisualizeJS` viewer.
-   * - `gltf` - `glTF`, for opening a file in `Three.js` viewer.
-   */
-  geometryType?: string;
-}
-
-export class Options {
+export class Options implements IOptions {
   protected _emitter?: EventEmitter2;
-  protected _data: OptionsData;
+  protected _data: IOptions;
 
   constructor(emitter?: EventEmitter2) {
     this._emitter = emitter;
-    this._data = Options.defaults();
+    this._data = defaultOptions();
     this.loadFromStorage();
   }
 
-  static defaults(): OptionsData {
-    return {
-      showWCS: true,
-      cameraAnimation: true,
-      antialiasing: true,
-      groundShadow: false,
-      shadows: false,
-      cameraAxisXSpeed: 4,
-      cameraAxisYSpeed: 1,
-      ambientOcclusion: false,
-      enableStreamingMode: true,
-      enablePartialMode: false,
-      memoryLimit: 3294967296,
-      cuttingPlaneFillColor: { red: 0xff, green: 0x98, blue: 0x00 },
-      edgesColor: { r: 0xff, g: 0x98, b: 0x00 },
-      facesColor: { r: 0xff, g: 0x98, b: 0x00 },
-      edgesVisibility: true,
-      edgesOverlap: true,
-      facesOverlap: false,
-      facesTransparancy: 200,
-      enableCustomHighlight: true,
-      sceneGraph: false,
-      edgeModel: true,
-      reverseZoomWheel: false,
-      enableZoomWheel: true,
-      enableGestures: true,
-      geometryType: "vsfx",
-    };
+  static defaults(): IOptions {
+    return defaultOptions();
   }
 
   notifierChangeEvent(): void {
+    console.warn(
+      "Options.notifierChangeEvent() has been deprecated since 25.3 and will be removed in a future release, use Options.change() instead."
+    );
+    this.change();
+  }
+
+  change(): void {
     if (this._emitter !== undefined) {
       this.saveToStorage();
       this._emitter.emit({ type: "optionschange", data: this });
@@ -283,14 +93,15 @@ export class Options {
     }
   }
 
-  get data(): OptionsData {
+  get data(): IOptions {
     return this._data;
   }
 
-  set data(value: OptionsData) {
-    const sceneGraph = value.enablePartialMode ? false : value.sceneGraph;
-    this._data = { ...Options.defaults(), ...this._data, ...value, sceneGraph };
-    this.notifierChangeEvent();
+  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 };
+    this.change();
   }
 
   get showWCS(): boolean {
@@ -299,7 +110,7 @@ export class Options {
 
   set showWCS(value: boolean) {
     this._data.showWCS = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get cameraAnimation(): boolean {
@@ -308,7 +119,7 @@ export class Options {
 
   set cameraAnimation(value: boolean) {
     this._data.cameraAnimation = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get antialiasing(): boolean {
@@ -317,7 +128,7 @@ export class Options {
 
   set antialiasing(value: boolean) {
     this._data.antialiasing = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get groundShadow(): boolean {
@@ -326,7 +137,7 @@ export class Options {
 
   set groundShadow(value: boolean) {
     this._data.groundShadow = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get shadows(): boolean {
@@ -335,7 +146,7 @@ export class Options {
 
   set shadows(value: boolean) {
     this._data.shadows = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get cameraAxisXSpeed(): number {
@@ -344,7 +155,7 @@ export class Options {
 
   set cameraAxisXSpeed(value: number) {
     this._data.cameraAxisXSpeed = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get cameraAxisYSpeed(): number {
@@ -353,7 +164,7 @@ export class Options {
 
   set cameraAxisYSpeed(value: number) {
     this.cameraAxisYSpeed = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get ambientOcclusion(): boolean {
@@ -362,7 +173,7 @@ export class Options {
 
   set ambientOcclusion(value: boolean) {
     this._data.ambientOcclusion = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get enableStreamingMode(): boolean {
@@ -371,12 +182,8 @@ export class Options {
 
   set enableStreamingMode(value: boolean) {
     this._data.enableStreamingMode = value;
-
-    if (this._data.enableStreamingMode) {
-      this._data.enablePartialMode = false;
-    }
-
-    this.notifierChangeEvent();
+    if (!value) this._data.enablePartialMode = false;
+    this.change();
   }
 
   get enablePartialMode(): boolean {
@@ -385,8 +192,11 @@ export class Options {
 
   set enablePartialMode(value: boolean) {
     this._data.enablePartialMode = value;
-    if (value) this._data.sceneGraph = false;
-    this.notifierChangeEvent();
+    if (value) {
+      this._data.enableStreamingMode = true;
+      this._data.sceneGraph = false;
+    }
+    this.change();
   }
 
   get memoryLimit(): number {
@@ -395,7 +205,7 @@ export class Options {
 
   set memoryLimit(value: number) {
     this._data.memoryLimit = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get cuttingPlaneFillColor(): RGB {
@@ -404,7 +214,7 @@ export class Options {
 
   set cuttingPlaneFillColor(value: RGB) {
     this._data.cuttingPlaneFillColor = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get edgesColor() {
@@ -413,7 +223,7 @@ export class Options {
 
   set edgesColor(value) {
     this._data.edgesColor = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get facesColor() {
@@ -422,7 +232,7 @@ export class Options {
 
   set facesColor(value) {
     this._data.facesColor = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get edgesVisibility() {
@@ -431,7 +241,7 @@ export class Options {
 
   set edgesVisibility(value) {
     this._data.edgesVisibility = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get edgesOverlap() {
@@ -440,7 +250,7 @@ export class Options {
 
   set edgesOverlap(value) {
     this._data.edgesOverlap = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get facesOverlap() {
@@ -449,7 +259,7 @@ export class Options {
 
   set facesOverlap(value) {
     this._data.facesOverlap = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get facesTransparancy() {
@@ -458,7 +268,7 @@ export class Options {
 
   set facesTransparancy(value) {
     this._data.facesTransparancy = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get enableCustomHighlight() {
@@ -467,7 +277,7 @@ export class Options {
 
   set enableCustomHighlight(value) {
     this._data.enableCustomHighlight = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get sceneGraph() {
@@ -477,7 +287,7 @@ export class Options {
   set sceneGraph(value) {
     this._data.sceneGraph = value;
     if (value) this._data.enablePartialMode = false;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get edgeModel() {
@@ -486,7 +296,7 @@ export class Options {
 
   set edgeModel(value) {
     this._data.edgeModel = Boolean(value);
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get reverseZoomWheel() {
@@ -495,7 +305,7 @@ export class Options {
 
   set reverseZoomWheel(value: boolean) {
     this._data.reverseZoomWheel = !!value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get enableZoomWheel() {
@@ -504,7 +314,7 @@ export class Options {
 
   set enableZoomWheel(value: boolean) {
     this._data.enableZoomWheel = !!value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get enableGestures() {
@@ -513,7 +323,7 @@ export class Options {
 
   set enableGestures(value: boolean) {
     this._data.enableGestures = !!value;
-    this.notifierChangeEvent();
+    this.change();
   }
 
   get geometryType() {
@@ -522,6 +332,6 @@ export class Options {
 
   set geometryType(value: string) {
     this._data.geometryType = value;
-    this.notifierChangeEvent();
+    this.change();
   }
 }

package/src/options/OptionsEvents.ts

@@ -1,4 +1,4 @@
-import { Options } from "./Options";
+import { IOptions } from "./IOptions";
 
 /**
  * An event that fires when options has been changed.
@@ -14,7 +14,7 @@ export interface OptionsChangeEvent {
   /**
    * New parameters.
    */
-  data: Options;
+  data: IOptions;
 }
 
 /**

package/src/viewer/IViewer.ts

@@ -24,12 +24,12 @@
 import { IEventEmitter } from "@inweb/eventemitter2";
 import { Assembly, Client, File, Model } from "@inweb/client";
 import { ICommandService } from "../commands/ICommands";
-import { Options } from "../options/Options";
+import { IOptions } from "../options/IOptions";
 import { IViewpoint } from "./IViewpoint";
 
 export interface IViewer extends IEventEmitter, ICommandService {
   client: Client | undefined;
-  options: Options;
+  options: IOptions;
   canvas: HTMLCanvasElement | undefined;
   canvasEvents: string[];
   draggers: string[];