@inweb/viewer-core 27.4.7 → 27.6.0

package/lib/options/Options.d.ts

@@ -1,9 +1,9 @@
-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);
+    constructor(emitter?: IEventEmitter);
     static defaults(): IOptions;
     change(): void;
     saveToStorage(): void;
@@ -14,8 +14,9 @@ export declare class Options implements IOptions {
      * @param fields - Name of fields to be reset. Specify `undefined` to reset all.
      */
     resetToDefaults(fields?: string[]): void;
+    setProperty<K extends keyof IOptions>(key: K, value?: IOptions[K]): void;
     get data(): IOptions;
-    set data(value: IOptions);
+    set data(value: Partial<IOptions>);
     get showWCS(): boolean;
     set showWCS(value: boolean);
     get cameraAnimation(): boolean;
@@ -40,6 +41,48 @@ export declare class Options implements IOptions {
     set memoryLimit(value: number);
     get cuttingPlaneFillColor(): RGB;
     set cuttingPlaneFillColor(value: RGB);
+    get enableSectionFill(): boolean;
+    set enableSectionFill(value: boolean);
+    get sectionFillColor(): {
+        r: number;
+        g: number;
+        b: number;
+    };
+    set sectionFillColor(value: {
+        r: number;
+        g: number;
+        b: number;
+    });
+    get sectionUseObjectColor(): boolean;
+    set sectionUseObjectColor(value: boolean);
+    get enableSectionHatch(): boolean;
+    set enableSectionHatch(value: boolean);
+    get sectionHatchColor(): {
+        r: number;
+        g: number;
+        b: number;
+    };
+    set sectionHatchColor(value: {
+        r: number;
+        g: number;
+        b: number;
+    });
+    get sectionHatchScale(): number;
+    set sectionHatchScale(value: number);
+    get enableSectionOutline(): boolean;
+    set enableSectionOutline(value: boolean);
+    get sectionOutlineColor(): {
+        r: number;
+        g: number;
+        b: number;
+    };
+    set sectionOutlineColor(value: {
+        r: number;
+        g: number;
+        b: number;
+    });
+    get sectionOutlineWidth(): number;
+    set sectionOutlineWidth(value: number);
     get edgesColor(): {
         r: number;
         g: number;
@@ -84,8 +127,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/lib/viewer/IViewer.d.ts

@@ -130,10 +130,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/lib/viewer/IViewpoint.d.ts

@@ -171,7 +171,9 @@ 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;
     /**
@@ -296,11 +298,15 @@ 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;
     /**
@@ -321,11 +327,15 @@ 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/lib/viewer/ViewerEvents.d.ts

@@ -68,6 +68,19 @@ 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.
  *
@@ -691,6 +704,10 @@ export interface ViewerEventMap {
      * Event that fires when camera projection mode changes.
      */
     changecameramode: ChangeCameraModeEvent;
+    /**
+     * Event that fires when cutting planes (slices) have been changed.
+     */
+    changecuttingplanes: ChangeCuttingPlanesEvent;
     /**
      * Event that fires when the markup color has been changed.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/viewer-core",
-  "version": "27.4.7",
+  "version": "27.6.0",
   "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.4.7",
-    "@inweb/eventemitter2": "~27.4.7"
+    "@inweb/client": "~27.6.0",
+    "@inweb/eventemitter2": "~27.6.0"
   }
 }

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.
@@ -105,7 +105,7 @@ export interface IOptions {
    *
    * @defaultValue true
    */
-  enableStreamingMode?: boolean;
+  enableStreamingMode: boolean;
 
   /**
    * Enable partial streaming mode to be able open large drawing.
@@ -118,56 +118,126 @@ export interface IOptions {
    *
    * @defaultValue false
    */
-  enablePartialMode?: boolean;
+  enablePartialMode: boolean;
 
   /**
    * The size of the memory buffer for graphics data, in bytes.
    *
    * @defaultValue 3294967296
    */
-  memoryLimit?: number;
+  memoryLimit: number;
 
   /**
-   * Cutting planes fill color.
+   * Deprecated since `27.5`. Use {@link sectionFillColor} instead.
+   *
+   * @deprecated
+   */
+  cuttingPlaneFillColor: RGB;
+
+  /**
+   * Show solid fill on section caps.
+   *
+   * When disabled, neither the fill nor the hatch is drawn (the outline, if enabled, is still shown).
+   *
+   * @defaultValue true
+   */
+  enableSectionFill: boolean;
+
+  /**
+   * Section cap fill color.
    *
    * @defaultValue { red: 0xff, green: 0x98, blue: 0x00 }
    */
-  cuttingPlaneFillColor?: RGB;
+  sectionFillColor: { r: number; g: number; b: number };
+
+  /**
+   * Use the intersected object's color for the section cap fill.
+   *
+   * When enabled, each section cap is filled with a color derived from the intersected object and
+   * `sectionFillColor` is ignored. The outline color is not affected.
+   *
+   * @defaultValue false
+   */
+  sectionUseObjectColor: boolean;
+
+  /**
+   * Overlay a hatch pattern on top of the section fill.
+   *
+   * @defaultValue true
+   */
+  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 };
+
+  /**
+   * Distance between hatch lines, in screen-space pixels.
+   *
+   * Larger values produce sparser hatching.
+   *
+   * @defaultValue 8
+   */
+  sectionHatchScale: number;
+
+  /**
+   * Draw the outline contour along the section boundary.
+   *
+   * @defaultValue true
+   */
+  enableSectionOutline: boolean;
+
+  /**
+   * Color of the section outline contour.
+   *
+   * @defaultValue { red: 0, green: 0, blue: 0 }
+   */
+  sectionOutlineColor: { r: number; g: number; b: number };
+
+  /**
+   * Width of the section outline contour, in pixels.
+   *
+   * @defaultValue 2
+   */
+  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.
@@ -212,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).
@@ -237,7 +307,7 @@ export interface IOptions {
    *
    * @defaultValue "Default"
    */
-  rulerUnit?: string;
+  rulerUnit: string;
 
   /**
    * Number of decimal places to display in ruler measurements.
@@ -253,7 +323,7 @@ export interface IOptions {
    *
    * @defaultValue 2
    */
-  rulerPrecision?: any;
+  rulerPrecision: "Default" | "Auto" | number;
 
   /**
    * Camera projection mode:
@@ -263,7 +333,7 @@ export interface IOptions {
    *
    * @defaultValue "perspective"
    */
-  cameraMode?: CameraMode;
+  cameraMode: CameraMode;
 
   /**
    * Default MIME type for snapshot images.
@@ -276,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).
@@ -291,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 {
@@ -315,6 +378,15 @@ export function defaultOptions(): IOptions {
     enablePartialMode: false,
     memoryLimit: 3294967296,
     cuttingPlaneFillColor: { red: 0xff, green: 0x98, blue: 0x00 },
+    enableSectionFill: true,
+    sectionFillColor: { r: 0xff, g: 0x98, b: 0x00 },
+    sectionUseObjectColor: false,
+    enableSectionHatch: true,
+    sectionHatchColor: { r: 0, g: 0, b: 0 },
+    sectionHatchScale: 8,
+    enableSectionOutline: true,
+    sectionOutlineColor: { r: 0, g: 0, b: 0 },
+    sectionOutlineWidth: 2,
     edgesColor: { r: 0xff, g: 0x98, b: 0x00 },
     facesColor: { r: 0xff, g: 0x98, b: 0x00 },
     edgesVisibility: true,