@inweb/viewer-core 25.3.23 → 25.3.25

package/lib/viewer/ViewerEvents.d.ts

@@ -181,7 +181,7 @@ export interface GeometryErrorEvent {
     buffer?: Uint8Array | ArrayBuffer;
 }
 /**
- * Event measuring progress of the model loading process.
+ * Event that measures the progress of the model loading.
  *
  * @event
  */
@@ -222,6 +222,43 @@ export interface GeometryStartEvent {
      */
     buffer?: Uint8Array | ArrayBuffer;
 }
+/**
+ * Event that fires after the viewer initialized.
+ *
+ * @event
+ */
+export interface InitializeEvent {
+    /**
+     * Event type.
+     */
+    type: "initialize";
+}
+/**
+ * Event that measures the progress of the viewer's initialization.
+ *
+ * @event
+ */
+export interface InitializeProgressEvent {
+    /**
+     * Event type.
+     */
+    type: "initializeprogress";
+    /**
+     * The non-rounded progress value from 0 to 1. To get a percentage (%), multiply the `data` by 100.
+     */
+    data: number;
+    /**
+     * A 64-bit unsigned integer value indicating the amount of work already performed by the
+     * underlying process. The ratio of work done can be calculated by dividing total by the
+     * value of this property.
+     */
+    loaded: number;
+    /**
+     * A 64-bit unsigned integer representing the total amount of work that the underlying
+     * process is in the progress of performing.
+     */
+    total: number;
+}
 /**
  * Event that fires before model opens.
  *
@@ -318,7 +355,7 @@ export interface UpdateEvent {
     data: boolean;
 }
 /**
- * Event measuring progress of loading a `VisualizeJS` library.
+ * Deprecated since `25.4`. Use `initializeprogress` instead.
  *
  * @event
  */
@@ -482,17 +519,29 @@ export interface ViewerEventMap extends CanvasEventMap {
      */
     geometryerror: GeometryErrorEvent;
     /**
-     * Event measuring progress of the model loading process.
+     * Event that measures the progress of the model loading.
      */
     geometryprogress: GeometryProgressEvent;
     /**
      * Event that fires before the model opens.
      */
     geometrystart: GeometryStartEvent;
+    /**
+     * Event that fires after the viewer initialized.
+     */
+    initialize: InitializeEvent;
+    /**
+     * Event that measures the progress of the viewer's initialization.
+     */
+    initializeprogress: InitializeProgressEvent;
     /**
      * Event that fires before model opens.
      */
     open: OpenEvent;
+    /**
+     * Event that fires when camera panning.
+     */
+    pan: PanEvent;
     /**
      * Event that fires when an rendering occurs.
      */
@@ -510,7 +559,7 @@ export interface ViewerEventMap extends CanvasEventMap {
      */
     update: UpdateEvent;
     /**
-     * Event measuring progress of loading a `VisualizeJS` library.
+     * Deprecated since `25.4`. Use `initializeprogress` instead.
      */
     visualizeprogress: VisualizeProgressEvent;
     /**
@@ -521,10 +570,6 @@ export interface ViewerEventMap extends CanvasEventMap {
      * Event that fires when walk started.
      */
     walkstart: WalkStartEvent;
-    /**
-     * Event that fires when camera panning.
-     */
-    pan: PanEvent;
     /**
      * Event that fires when zooming of the camera.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/viewer-core",
-  "version": "25.3.23",
+  "version": "25.3.25",
   "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.3.19"
+    "@inweb/eventemitter2": "^25.3.25"
   },
   "peerDependencies": {
-    "@inweb/eventemitter2": "^25.3.19"
+    "@inweb/eventemitter2": "^25.3.25"
   }
 }

package/src/viewer/ViewerEvents.ts

@@ -204,7 +204,7 @@ export interface GeometryErrorEvent {
 }
 
 /**
- * Event measuring progress of the model loading process.
+ * Event that measures the progress of the model loading.
  *
  * @event
  */
@@ -252,6 +252,48 @@ export interface GeometryStartEvent {
   buffer?: Uint8Array | ArrayBuffer;
 }
 
+/**
+ * Event that fires after the viewer initialized.
+ *
+ * @event
+ */
+export interface InitializeEvent {
+  /**
+   * Event type.
+   */
+  type: "initialize";
+}
+
+/**
+ * Event that measures the progress of the viewer's initialization.
+ *
+ * @event
+ */
+export interface InitializeProgressEvent {
+  /**
+   * Event type.
+   */
+  type: "initializeprogress";
+
+  /**
+   * The non-rounded progress value from 0 to 1. To get a percentage (%), multiply the `data` by 100.
+   */
+  data: number;
+
+  /**
+   * A 64-bit unsigned integer value indicating the amount of work already performed by the
+   * underlying process. The ratio of work done can be calculated by dividing total by the
+   * value of this property.
+   */
+  loaded: number;
+
+  /**
+   * A 64-bit unsigned integer representing the total amount of work that the underlying
+   * process is in the progress of performing.
+   */
+  total: number;
+}
+
 /**
  * Event that fires before model opens.
  *
@@ -363,7 +405,7 @@ export interface UpdateEvent {
 }
 
 /**
- * Event measuring progress of loading a `VisualizeJS` library.
+ * Deprecated since `25.4`. Use `initializeprogress` instead.
  *
  * @event
  */
@@ -551,7 +593,7 @@ export interface ViewerEventMap extends CanvasEventMap {
   geometryerror: GeometryErrorEvent;
 
   /**
-   * Event measuring progress of the model loading process.
+   * Event that measures the progress of the model loading.
    */
   geometryprogress: GeometryProgressEvent;
 
@@ -560,11 +602,26 @@ export interface ViewerEventMap extends CanvasEventMap {
    */
   geometrystart: GeometryStartEvent;
 
+  /**
+   * Event that fires after the viewer initialized.
+   */
+  initialize: InitializeEvent;
+
+  /**
+   * Event that measures the progress of the viewer's initialization.
+   */
+  initializeprogress: InitializeProgressEvent;
+
   /**
    * Event that fires before model opens.
    */
   open: OpenEvent;
 
+  /**
+   * Event that fires when camera panning.
+   */
+  pan: PanEvent;
+
   /**
    * Event that fires when an rendering occurs.
    */
@@ -586,7 +643,7 @@ export interface ViewerEventMap extends CanvasEventMap {
   update: UpdateEvent;
 
   /**
-   * Event measuring progress of loading a `VisualizeJS` library.
+   * Deprecated since `25.4`. Use `initializeprogress` instead.
    */
   visualizeprogress: VisualizeProgressEvent;
 
@@ -600,11 +657,6 @@ export interface ViewerEventMap extends CanvasEventMap {
    */
   walkstart: WalkStartEvent;
 
-  /**
-   * Event that fires when camera panning.
-   */
-  pan: PanEvent;
-
   /**
    * Event that fires when zooming of the camera.
    */