@inweb/viewer-core 25.11.0 → 25.11.2

package/lib/viewer/IViewer.d.ts

@@ -50,7 +50,7 @@ export interface IViewer extends IEventEmitter, ICommandService {
      */
     canvasEvents: string[];
     /**
-     * List of names of registered draggers.
+     * List of names of available draggers.
      */
     draggers: string[];
     /**
@@ -114,16 +114,36 @@ export interface IViewer extends IEventEmitter, ICommandService {
     open(file: Model | File | Assembly): Promise<this>;
     /**
      * Cancels asynchronous file loading started by {@link open | open()}.
+     *
+     * Fires:
+     *
+     * - {@link CancelEvent | calcel}
      */
     cancel(): this;
     /**
      * Unloads an open file, clears the canvas and markups.
+     *
+     * Fires:
+     *
+     * - {@link ClearEvent | clear}
      */
     clear(): this;
     /**
      * Returns `true` if current opened model is 3D model.
      */
     is3D(): boolean;
+    /**
+     * Creates an overlay view. Overlay view is used to draw cutting planes and markups.
+     */
+    syncOverlay(): void;
+    /**
+     * Clears the overlay view.
+     */
+    clearOverlay(): void;
+    /**
+     * Removes all cutting planes.
+     */
+    clearSlices(): void;
     /**
      * Returns a list of original handles for the selected objects.
      */

package/lib/viewer/ViewerEvents.d.ts

@@ -1,4 +1,5 @@
 import { Assembly, File, Model } from "@inweb/client";
+import { IViewpoint } from "./IViewpoint";
 /**
  * Event that fires when model loading has been canceled.
  *
@@ -427,6 +428,21 @@ export interface VisualizeProgressEvent {
      */
     total: number;
 }
+/**
+ * Event that fires after viewer loads a viewpoint.
+ *
+ * @event
+ */
+export interface ViewpointEvent {
+    /**
+     * Event type.
+     */
+    type: "drawviewpoint" | "createviewpoint";
+    /**
+     * Viewpoint.
+     */
+    data: IViewpoint;
+}
 /**
  * Event that fires when walk speed changing.
  *
@@ -559,6 +575,10 @@ export interface ViewerEventMap {
      * Event that fires after viewer executes the command.
      */
     command: CommandEvent;
+    /**
+     * Event that fires after viewer creates a viewpoint.
+     */
+    createviewpoint: ViewpointEvent;
     /**
      * Event that fires when the model scene description file has been loaded.
      */
@@ -567,6 +587,10 @@ export interface ViewerEventMap {
      * Event that fires before viewer resources has been released.
      */
     dispose: DisposeEvent;
+    /**
+     * Event that fires after viewer loads a viewpoint.
+     */
+    drawviewpoint: ViewpointEvent;
     /**
      * Event that fires when model breaks into its component objects or collect objects back.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/viewer-core",
-  "version": "25.11.0",
+  "version": "25.11.2",
   "description": "3D CAD and BIM data Viewer core",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -26,9 +26,9 @@
     "test": "karma start karma.conf.js"
   },
   "devDependencies": {
-    "@inweb/eventemitter2": "~25.11.0"
+    "@inweb/eventemitter2": "~25.11.2"
   },
   "peerDependencies": {
-    "@inweb/eventemitter2": "~25.11.0"
+    "@inweb/eventemitter2": "~25.11.2"
   }
 }

package/src/viewer/IViewer.ts

@@ -78,7 +78,7 @@ export interface IViewer extends IEventEmitter, ICommandService {
   canvasEvents: string[];
 
   /**
-   * List of names of registered draggers.
+   * List of names of available draggers.
    */
   draggers: string[];
 
@@ -148,11 +148,19 @@ export interface IViewer extends IEventEmitter, ICommandService {
 
   /**
    * Cancels asynchronous file loading started by {@link open | open()}.
+   *
+   * Fires:
+   *
+   * - {@link CancelEvent | calcel}
    */
   cancel(): this;
 
   /**
    * Unloads an open file, clears the canvas and markups.
+   *
+   * Fires:
+   *
+   * - {@link ClearEvent | clear}
    */
   clear(): this;
 
@@ -161,6 +169,21 @@ export interface IViewer extends IEventEmitter, ICommandService {
    */
   is3D(): boolean;
 
+  /**
+   * Creates an overlay view. Overlay view is used to draw cutting planes and markups.
+   */
+  syncOverlay(): void;
+
+  /**
+   * Clears the overlay view.
+   */
+  clearOverlay(): void;
+
+  /**
+   * Removes all cutting planes.
+   */
+  clearSlices(): void;
+
   /**
    * Returns a list of original handles for the selected objects.
    */

package/src/viewer/ViewerEvents.ts

@@ -1,4 +1,5 @@
 import { Assembly, File, Model } from "@inweb/client";
+import { IViewpoint } from "./IViewpoint";
 
 /**
  * Event that fires when model loading has been canceled.
@@ -485,6 +486,23 @@ export interface VisualizeProgressEvent {
   total: number;
 }
 
+/**
+ * Event that fires after viewer loads a viewpoint.
+ *
+ * @event
+ */
+export interface ViewpointEvent {
+  /**
+   * Event type.
+   */
+  type: "drawviewpoint" | "createviewpoint";
+
+  /**
+   * Viewpoint.
+   */
+  data: IViewpoint;
+}
+
 /**
  * Event that fires when walk speed changing.
  *
@@ -638,6 +656,11 @@ export interface ViewerEventMap {
    */
   command: CommandEvent;
 
+  /**
+   * Event that fires after viewer creates a viewpoint.
+   */
+  createviewpoint: ViewpointEvent;
+
   /**
    * Event that fires when the model scene description file has been loaded.
    */
@@ -648,6 +671,11 @@ export interface ViewerEventMap {
    */
   dispose: DisposeEvent;
 
+  /**
+   * Event that fires after viewer loads a viewpoint.
+   */
+  drawviewpoint: ViewpointEvent;
+
   /**
    * Event that fires when model breaks into its component objects or collect objects back.
    */