@inweb/viewer-core 26.5.0 → 26.5.1

package/src/viewer/ViewerEvents.ts

@@ -48,7 +48,7 @@ export interface ChangeMarkupColorEvent {
 }
 
 /**
- * Event that fires when the viewer has been cleared.
+ * Event that fires after an open file has been unloaded and the viewer canvas have been cleared.
  *
  * @event
  */
@@ -82,7 +82,7 @@ export interface CommandEvent {
 }
 
 /**
- * Event that fires when the model scene description file has been loaded.
+ * Event that fires when the file scene description has been loaded.
  *
  * @event
  */
@@ -93,17 +93,24 @@ export interface DatabaseChunkEvent {
   type: "databasechunk";
 
   /**
-   * Scene description file.
+   * Viewer depended data: scene description data (VisualizeJS) or scene object (Three.js).
    */
-  data?: Uint8Array;
+  data?: any;
+
+  /**
+   * File to load.
+   */
+  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
 
   /**
-   * Model instance to open.
+   * Model from file to load. Only defined when loading a file from the Open Cloud Server.
    */
   model?: Model;
 
   /**
-   * Buffer to open.
+   * Deprecated since `26.4`. Use {@link file} instead.
+   *
+   * @deprecated
    */
   buffer?: Uint8Array | ArrayBuffer;
 }
@@ -138,7 +145,7 @@ export interface ExplodeEvent {
 }
 
 /**
- * Event that fires when the model geometry data chunk has been loaded.
+ * Event that fires when the file geometry data chunk has been loaded.
  *
  * Note that small files are loaded in one chunk, and `geometrychunk` event does not fire, only the
  * `databasechink` event fires.
@@ -152,17 +159,24 @@ export interface GeometryChunkEvent {
   type: "geometrychunk";
 
   /**
-   * Geometry data chunk.
+   * Geometry data chunk. Only for VSFX.
+   */
+  data?: Uint8Array;
+
+  /**
+   * File to load.
    */
-  data: Uint8Array;
+  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
 
   /**
-   * Model instance to open.
+   * Model from file to load. Only defined when loading a file from the Open Cloud Server.
    */
   model?: Model;
 
   /**
-   * Buffer to open.
+   * Deprecated since `26.4`. Use {@link file} instead.
+   *
+   * @deprecated
    */
   buffer?: Uint8Array | ArrayBuffer;
 }
@@ -179,23 +193,25 @@ export interface GeometryEndEvent {
   type: "geometryend";
 
   /**
-   * Model instance to open.
+   * File to load.
    */
-  model?: Model;
+  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
 
   /**
-   * Buffer to open.
+   * Model from file to load. Only defined when loading a file from the Open Cloud Server.
    */
-  buffer?: Uint8Array | ArrayBuffer;
+  model?: Model;
 
   /**
-   * Loaded data (viewer depended).
+   * Deprecated since `26.4`. Use {@link file} instead.
+   *
+   * @deprecated
    */
-  data?: any;
+  buffer?: Uint8Array | ArrayBuffer;
 }
 
 /**
- * Event that fires when the model fails to load.
+ * Event that fires when the file fails to load.
  *
  * @event
  */
@@ -211,12 +227,19 @@ export interface GeometryErrorEvent {
   data: Error;
 
   /**
-   * Model instance to open.
+   * File to load.
+   */
+  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+
+  /**
+   * Model from file to load. Only defined when loading a file from the Open Cloud Server.
    */
   model?: Model;
 
   /**
-   * Buffer to open.
+   * Deprecated since `26.4`. Use {@link file} instead.
+   *
+   * @deprecated
    */
   buffer?: Uint8Array | ArrayBuffer;
 }
@@ -238,12 +261,19 @@ export interface GeometryProgressEvent {
   data: number;
 
   /**
-   * Model instance to open.
+   * File to load.
+   */
+  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+
+  /**
+   * Model from file to load. Only defined when loading a file from the Open Cloud Server.
    */
   model?: Model;
 
   /**
-   * Buffer to open.
+   * Deprecated since `26.4`. Use {@link file} instead.
+   *
+   * @deprecated
    */
   buffer?: Uint8Array | ArrayBuffer;
 }
@@ -260,12 +290,19 @@ export interface GeometryStartEvent {
   type: "geometrystart";
 
   /**
-   * Model instance to open.
+   * File to load.
+   */
+  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+
+  /**
+   * Model from file to load. Only defined when loading a file from the Open Cloud Server.
    */
   model?: Model;
 
   /**
-   * Buffer to open.
+   * Deprecated since `26.4`. Use {@link file} instead.
+   *
+   * @deprecated
    */
   buffer?: Uint8Array | ArrayBuffer;
 }
@@ -336,7 +373,7 @@ export interface IsolateEvent {
 }
 
 /**
- * Event that fires before model opens.
+ * Event that fires before model open.
  *
  * @event
  */
@@ -347,19 +384,19 @@ export interface OpenEvent {
   type: "open";
 
   /**
-   * File instance to open. Only defined when loading a file from the server.
+   * File to load.
    */
-  file?: File | Assembly | Model;
+  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
 
   /**
-   * Deprecated since `25.3`. Use `file` instead.
-   *
-   * @deprecated
+   * Model from file to load. Only defined when loading a file from the Open Cloud Server.
    */
-  model?: File | Assembly | Model;
+  model?: Model;
 
   /**
-   * Buffer to open. Only defined when loading a local file.
+   * Deprecated since `26.4`. Use {@link file} instead.
+   *
+   * @deprecated
    */
   buffer?: Uint8Array | ArrayBuffer;
 }
@@ -460,7 +497,7 @@ export interface UpdateEvent {
 }
 
 /**
- * Deprecated since `25.4`. Use `initializeprogress` instead.
+ * Deprecated since `25.4`. Use {@link InitializeProgressEvent | initializeprogress} instead.
  *
  * @deprecated
  * @event
@@ -660,7 +697,7 @@ export interface ViewerEventMap {
   createviewpoint: ViewpointEvent;
 
   /**
-   * Event that fires when the model scene description file has been loaded.
+   * Event that fires when the file scene description has been loaded.
    */
   databasechunk: DatabaseChunkEvent;
 
@@ -680,7 +717,7 @@ export interface ViewerEventMap {
   explode: ExplodeEvent;
 
   /**
-   * Event that fires when the model geometry data chunk has been loaded.
+   * Event that fires when the file geometry data chunk has been loaded.
    */
   geometrychunk: GeometryChunkEvent;
 
@@ -690,7 +727,7 @@ export interface ViewerEventMap {
   geometryend: GeometryEndEvent;
 
   /**
-   * Event that fires when the model fails to open.
+   * Event that fires when the file fails to open.
    */
   geometryerror: GeometryErrorEvent;
 
@@ -760,7 +797,7 @@ export interface ViewerEventMap {
   update: UpdateEvent;
 
   /**
-   * Deprecated since `25.4`. Use `initializeprogress` instead.
+   * Deprecated since `25.4`. Use {@link InitializeProgressEvent | initializeprogress} instead.
    *
    * @deprecated
    */