@inweb/viewer-core 27.4.6 → 27.5.0

package/src/options/IOptions.ts

@@ -128,12 +128,82 @@ export interface IOptions {
   memoryLimit?: number;
 
   /**
-   * Cutting planes fill color.
+   * Deprecated since `27.5`. Use {@link sectionFillColor} instead.
    *
-   * @defaultValue { red: 0xff, green: 0x98, blue: 0x00 }
+   * @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 }
+   */
+  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.
    */
@@ -315,6 +385,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,

package/src/options/Options.ts

@@ -90,9 +90,19 @@ export class Options implements IOptions {
   }
 
   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._data = { ...Options.defaults(), ...this._data, ...value };
+    // 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();
   }
 
@@ -201,11 +211,106 @@ export class Options implements IOptions {
   }
 
   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;
+    console.warn(
+      "Options.cuttingPlaneFillColor has been deprecated since 27.5 and will be removed in a future release, use sectionFillColor instead"
+    );
+    this._data.sectionFillColor = {
+      r: value.red,
+      g: value.green,
+      b: value.blue,
+    };
+    this.change();
+  }
+
+  get enableSectionFill(): boolean {
+    return this._data.enableSectionFill;
+  }
+
+  set enableSectionFill(value: boolean) {
+    this._data.enableSectionFill = value;
+    this.change();
+  }
+
+  get sectionFillColor() {
+    return this._data.sectionFillColor;
+  }
+
+  set sectionFillColor(value) {
+    this._data.sectionFillColor = value;
+    this.change();
+  }
+
+  get sectionUseObjectColor(): boolean {
+    return this._data.sectionUseObjectColor;
+  }
+
+  set sectionUseObjectColor(value: boolean) {
+    this._data.sectionUseObjectColor = value;
+    this.change();
+  }
+
+  get enableSectionHatch(): boolean {
+    return this._data.enableSectionHatch;
+  }
+
+  set enableSectionHatch(value: boolean) {
+    this._data.enableSectionHatch = value;
+    this.change();
+  }
+
+  get sectionHatchColor() {
+    return this._data.sectionHatchColor;
+  }
+
+  set sectionHatchColor(value) {
+    this._data.sectionHatchColor = value;
+    this.change();
+  }
+
+  get sectionHatchScale(): number {
+    return this._data.sectionHatchScale;
+  }
+
+  set sectionHatchScale(value: number) {
+    this._data.sectionHatchScale = value;
+    this.change();
+  }
+
+  get enableSectionOutline(): boolean {
+    return this._data.enableSectionOutline;
+  }
+
+  set enableSectionOutline(value: boolean) {
+    this._data.enableSectionOutline = value;
+    this.change();
+  }
+
+  get sectionOutlineColor() {
+    return this._data.sectionOutlineColor;
+  }
+
+  set sectionOutlineColor(value) {
+    this._data.sectionOutlineColor = value;
+    this.change();
+  }
+
+  get sectionOutlineWidth(): number {
+    return this._data.sectionOutlineWidth;
+  }
+
+  set sectionOutlineWidth(value: number) {
+    this._data.sectionOutlineWidth = value;
     this.change();
   }
 

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.
    */