@combeenation/3d-viewer 6.0.0 → 6.1.0-beta2

package/src/api/classes/event.ts

@@ -1,367 +1,385 @@
-import { EventEmitter } from 'eventemitter3';
-import { isString } from 'lodash-es';
-
-/** @internal **/
-export const emitter = new EventEmitter();
-
-/**
- * This `Event` class defines all events that can be consumed and fired by the {@link EventBroadcaster}. Use
- * {@link EventBroadcaster.addEventListener} or {@link EventBroadcaster.on} to register event handler on your objects.
- * You could also use the `Emitter` to globally register event handlers. Some events are fired in certain scopes. A
- * scope is also considered to be the object the event could be registered on. Those scopes are documented in the
- * events itself.
- *
- * Example using a bootstrapping event.
- * ```js
- * Emitter.on(Event.BOOTSTRAP_START, viewer => { ... });
- * ```
- *
- * Example using a variant parameter event.
- * ```js
- * const variantInstance = await viewer.variantInstances.get('my_instance');
- * const variant = variantInstance.variant;
- * variant.on(Event.VARIANT_PARAMETER_COMMITTED, (variant, parameter) => { ... });
- * ```
- *
- * Example using a scene processing event.
- * ```js
- * const canvas = document.getElementById('viewer-canvas');
- * const viewer = new Viewer(canvas, createSpec());
- * viewer.on(Event.SCENE_PROCESSING_END, scene => {
- *   scene.clearColor = new Color4(0, 0, 0, 0);
- * });
- * await viewer.bootstrap();
- * ```
- */
-export class Event {
-  /**
-   * Constructor.
-   */
-  private constructor() {}
-
-  /**
-   * Fired before bootstrapping of the {@link Viewer} starts.
-   *
-   * Scopes:
-   * * Global
-   * * {@link Viewer}
-   *
-   * Payload:
-   * * viewer: {@link Viewer}
-   */
-  public static readonly BOOTSTRAP_START = 'bootstrapStart';
-  /**
-   * Fired after bootstrapping of the {@link Viewer} finished.
-   *
-   * Scopes:
-   * * Global
-   * * {@link Viewer}
-   *
-   * Payload:
-   * * viewer: {@link Viewer}
-   */
-  public static readonly BOOTSTRAP_END = 'bootstrapEnd';
-
-  /**
-   * Fired before loading any type of JSON or resource.
-   *
-   * Scopes:
-   * * Global
-   *
-   * Payload:
-   * * path: string
-   */
-  public static readonly LOADING_START = 'loadingStart';
-  /**
-   * Fired after loading any type of JSON or resource finished.
-   *
-   * Scopes:
-   * * Global
-   *
-   * Payload:
-   * * path: string
-   */
-  public static readonly LOADING_END = 'loadingEnd';
-
-  /**
-   * Fired before loading an asset (e.g. glTF) onto the scene.
-   *
-   * Scopes:
-   * * Global
-   * * {@link Variant}
-   *
-   * Payload:
-   * * variant: {@link Variant}
-   */
-  public static readonly ASSET_LOADING_START = 'assetLoadingStart';
-  /**
-   * Fired after loading an asset (e.g. glTF) onto the scene finished.
-   *
-   * Scopes:
-   * * Global
-   * * {@link Variant}
-   *
-   * Payload:
-   * * variant: {@link Variant}
-   */
-  public static readonly ASSET_LOADING_END = 'assetLoadingEnd';
-
-  /**
-   * Fired before scene initialization starts when bootstrapping the {@link Viewer}.
-   *
-   * Scopes:
-   * * Global
-   * * {@link Viewer}
-   *
-   * Payload:
-   * * sceneJson: {@link SceneJson}
-   */
-  public static readonly SCENE_PROCESSING_START = 'sceneProcessingStart';
-  /**
-   * Fired after scene initialization end when bootstrapping the {@link Viewer}.
-   *
-   * Scopes:
-   * * Global
-   * * {@link Viewer}
-   *
-   * Payload:
-   * * scene: {@link Scene}
-   */
-  public static readonly SCENE_PROCESSING_END = 'sceneProcessingEnd';
-
-  /**
-   * Fired after a {@link Variant} has been created.
-   *
-   * Scopes:
-   * * Global
-   * * {@link Variant}
-   *
-   * Payload:
-   * * variant: {@link Variant}
-   */
-  public static readonly VARIANT_CREATED = 'variantCreated';
-  /**
-   * Fired after a {@link Variant} has been destroyed.
-   *
-   * Scopes:
-   * * Global
-   * * {@link Variant}
-   *
-   * Payload:
-   * * variant: {@link Variant}
-   */
-  public static readonly VARIANT_DESTROYED = 'variantDestroyed';
-
-  /**
-   * Fired after the {@link Variant} under the cursor has been picked/selected.
-   *
-   * Scopes:
-   * * Global
-   * * {@link Viewer}
-   *
-   * Payload:
-   * * variant: {@link Variant}
-   */
-  public static readonly VARIANT_PICKED = 'variantPicked';
-
-  /**
-   * Fired after the {@link Element} under the cursor has been picked/selected.
-   *
-   * Scopes:
-   * * Global
-   * * {@link Viewer}
-   *
-   * Payload:
-   * * element: {@link Element}
-   */
-  public static readonly ELEMENT_PICKED = 'elementPicked';
-
-  /**
-   * Fired after a parameter on a {@link Variant} has been committed.
-   *
-   * Scopes:
-   * * Global
-   * * {@link Variant}
-   *
-   * Payload:
-   * * variant: {@link Variant}
-   * * parameter: string
-   * * oldValue: string
-   * * newValue: string
-   */
-  public static readonly VARIANT_PARAMETER_COMMITTED = 'variantParameterCommitted';
-
-  /**
-   * Fired after a {@link ParameterBag} has been committed.
-   *
-   * Scopes:
-   * * Global
-   * * {@link Variant}
-   *
-   * Payload:
-   * * variant: {@link Variant}
-   * * parameters: {@link ParameterBag}
-   * * oldValues: string[]
-   * * newValues: string[]
-   */
-  public static readonly VARIANT_PARAMETER_BAG_COMMITTED = 'variantParameterBagCommitted';
-
-  /**
-   * Fired after a {@link VariantInstance} has been created.
-   *
-   * Scopes:
-   * * Global
-   * * {@link VariantInstanceManager}
-   *
-   * Payload:
-   * * variantInstance: {@link VariantInstance}
-   */
-  public static readonly VARIANT_INSTANCE_CREATED = 'variantInstanceCreated';
-  /**
-   * Fired after a {@link VariantInstance} has been registered. This is the case when the {@link VariantInstance} is
-   * considered "lazy".
-   *
-   * Scopes:
-   * * Global
-   * * {@link VariantInstanceManager}
-   *
-   * Payload:
-   * * variantInstanceDefinition: {@link VariantInstanceDefinition}
-   */
-  public static readonly VARIANT_INSTANCE_REGISTERED = 'variantInstanceRegistered';
-  /**
-   * Fired after a {@link VariantInstance} has been cloned.
-   *
-   * Scopes:
-   * * Global
-   * * {@link VariantInstanceManager}
-   *
-   * Payload:
-   * * variantInstanceClone: {@link VariantInstance}
-   */
-  public static readonly VARIANT_INSTANCE_CLONED = 'variantInstanceCloned';
-  /**
-   * Fired after a {@link VariantInstance} has been destroyed.
-   *
-   * Scopes:
-   * * Global
-   * * {@link VariantInstanceManager}
-   *
-   * Payload:
-   * * variantInstance: {@link VariantInstance}
-   */
-  public static readonly VARIANT_INSTANCE_DESTROYED = 'variantInstanceDestroyed';
-
-  /**
-   * Fired after a parameter on an {@link Element} has been committed.
-   *
-   * Scopes:
-   * * Global
-   * * {@link Element}
-   *
-   * Payload:
-   * * element: {@link Element}
-   * * parameter: string
-   * * oldValue: string
-   * * newValue: string
-   */
-  public static readonly ELEMENT_PARAMETER_COMMITTED = 'elementParameterCommitted';
-
-  /**
-   * Fired after a parameter on an {@link ViewerLight} has been committed.
-   *
-   * Scopes:
-   * * Global
-   * * {@link ViewerLight}
-   *
-   * Payload:
-   * * light: {@link ViewerLight}
-   * * parameter: string
-   * * oldValue: string
-   * * newValue: string
-   */
-  public static readonly VIEWER_LIGHT_PARAMETER_COMMITTED = 'viewerLightParameterCommitted';
-
-  /**
-   * Fired after a parameter on an {@link SceneManager} has been committed.
-   *
-   * Scopes:
-   * * Global
-   * * {@link SceneManager}
-   *
-   * Payload:
-   * * variant: {@link SceneManager}
-   * * parameter: string
-   * * oldValue: string
-   * * newValue: string
-   */
-  public static readonly SCENE_PARAMETER_COMMITTED = 'sceneParameterCommitted';
-
-  /**
-   * Fired after the active camera on the scene has been switched.
-   *
-   * Scopes:
-   * * Global
-   * * {@link Viewer}
-   *
-   * Payload:
-   * * camera: Camera
-   */
-  public static readonly CAMERA_SWITCHED = 'cameraSwitched';
-
-  /**
-   * Fired after the {@link Mesh} under the cursor has been picked/selected.
-   *
-   * Scopes:
-   * * Global
-   * * {@link Viewer}
-   *
-   * Payload:
-   * * mesh: {@link Mesh}
-   * * element: {@link Element}
-   * * variant: {@link Variant}
-   */
-  public static readonly MESH_PICKED = 'meshPicked';
-
-  /**
-   * All events defined in this class.
-   */
-  public static get all() {
-    const all: string[] = [];
-    for (const event in Event) {
-      const property = Object.getOwnPropertyDescriptor(Event, event);
-      if (event.toUpperCase() === event && property && isString(property.value)) {
-        all.push(property.value);
-      }
-    }
-    return all;
-  }
-
-  /**
-   * All events starting with 'variant'.
-   */
-  public static get variant() {
-    return Event.all.filter(event => event.startsWith('variant'));
-  }
-
-  /**
-   * All events starting with 'element'.
-   */
-  public static get element() {
-    return Event.all.filter(event => event.startsWith('element'));
-  }
-
-  /**
-   * All events starting with 'scene'.
-   */
-  public static get scene() {
-    return Event.all.filter(event => event.startsWith('scene'));
-  }
-
-  /**
-   * All events starting with 'camera'.
-   */
-  public static get camera() {
-    return Event.all.filter(event => event.startsWith('camera'));
-  }
-}
+import { EventEmitter } from 'eventemitter3';
+import { isString } from 'lodash-es';
+
+/** @internal **/
+export const emitter = new EventEmitter();
+
+/**
+ * This `Event` class defines all events that can be consumed and fired by the {@link EventBroadcaster}. Use
+ * {@link EventBroadcaster.addEventListener} or {@link EventBroadcaster.on} to register event handler on your objects.
+ * You could also use the `Emitter` to globally register event handlers. Some events are fired in certain scopes. A
+ * scope is also considered to be the object the event could be registered on. Those scopes are documented in the
+ * events itself.
+ *
+ * Example using a bootstrapping event.
+ * ```js
+ * Emitter.on(Event.BOOTSTRAP_START, viewer => { ... });
+ * ```
+ *
+ * Example using a variant parameter event.
+ * ```js
+ * const variantInstance = await viewer.variantInstances.get('my_instance');
+ * const variant = variantInstance.variant;
+ * variant.on(Event.VARIANT_PARAMETER_COMMITTED, (variant, parameter) => { ... });
+ * ```
+ *
+ * Example using a scene processing event.
+ * ```js
+ * const canvas = document.getElementById('viewer-canvas');
+ * const viewer = new Viewer(canvas, createSpec());
+ * viewer.on(Event.SCENE_PROCESSING_END, scene => {
+ *   scene.clearColor = new Color4(0, 0, 0, 0);
+ * });
+ * await viewer.bootstrap();
+ * ```
+ */
+export class Event {
+  /**
+   * Constructor.
+   */
+  private constructor() {}
+
+  /**
+   * Fired before bootstrapping of the {@link Viewer} starts.
+   *
+   * Scopes:
+   * * Global
+   * * {@link Viewer}
+   *
+   * Payload:
+   * * viewer: {@link Viewer}
+   */
+  public static readonly BOOTSTRAP_START = 'bootstrapStart';
+  /**
+   * Fired after bootstrapping of the {@link Viewer} finished.
+   *
+   * Scopes:
+   * * Global
+   * * {@link Viewer}
+   *
+   * Payload:
+   * * viewer: {@link Viewer}
+   */
+  public static readonly BOOTSTRAP_END = 'bootstrapEnd';
+
+  /**
+   * Fired before loading any type of JSON or resource.
+   *
+   * Scopes:
+   * * Global
+   *
+   * Payload:
+   * * path: string
+   */
+  public static readonly LOADING_START = 'loadingStart';
+  /**
+   * Fired after loading any type of JSON or resource finished.
+   *
+   * Scopes:
+   * * Global
+   *
+   * Payload:
+   * * path: string
+   */
+  public static readonly LOADING_END = 'loadingEnd';
+
+  /**
+   * Fired before loading an asset (e.g. glTF) onto the scene.
+   *
+   * Scopes:
+   * * Global
+   * * {@link Variant}
+   *
+   * Payload:
+   * * variant: {@link Variant}
+   */
+  public static readonly ASSET_LOADING_START = 'assetLoadingStart';
+  /**
+   * Fired after loading an asset (e.g. glTF) onto the scene finished.
+   *
+   * Scopes:
+   * * Global
+   * * {@link Variant}
+   *
+   * Payload:
+   * * variant: {@link Variant}
+   */
+  public static readonly ASSET_LOADING_END = 'assetLoadingEnd';
+
+  /**
+   * Fired before scene initialization starts when bootstrapping the {@link Viewer}.
+   *
+   * Scopes:
+   * * Global
+   * * {@link Viewer}
+   *
+   * Payload:
+   * * sceneJson: {@link SceneJson}
+   */
+  public static readonly SCENE_PROCESSING_START = 'sceneProcessingStart';
+  /**
+   * Fired after scene initialization end when bootstrapping the {@link Viewer}.
+   *
+   * Scopes:
+   * * Global
+   * * {@link Viewer}
+   *
+   * Payload:
+   * * scene: {@link Scene}
+   */
+  public static readonly SCENE_PROCESSING_END = 'sceneProcessingEnd';
+
+  /**
+   * Fired after a {@link Variant} has been created.
+   *
+   * Scopes:
+   * * Global
+   * * {@link Variant}
+   *
+   * Payload:
+   * * variant: {@link Variant}
+   */
+  public static readonly VARIANT_CREATED = 'variantCreated';
+  /**
+   * Fired after a {@link Variant} has been destroyed.
+   *
+   * Scopes:
+   * * Global
+   * * {@link Variant}
+   *
+   * Payload:
+   * * variant: {@link Variant}
+   */
+  public static readonly VARIANT_DESTROYED = 'variantDestroyed';
+
+  /**
+   * Fired after the {@link Variant} under the cursor has been picked/selected.
+   *
+   * Scopes:
+   * * Global
+   * * {@link Viewer}
+   *
+   * Payload:
+   * * variant: {@link Variant}
+   */
+  public static readonly VARIANT_PICKED = 'variantPicked';
+
+  /**
+   * Fired after the {@link Element} under the cursor has been picked/selected.
+   *
+   * Scopes:
+   * * Global
+   * * {@link Viewer}
+   *
+   * Payload:
+   * * element: {@link Element}
+   */
+  public static readonly ELEMENT_PICKED = 'elementPicked';
+
+  /**
+   * Fired after a parameter on a {@link Variant} has been committed.
+   *
+   * Scopes:
+   * * Global
+   * * {@link Variant}
+   *
+   * Payload:
+   * * variant: {@link Variant}
+   * * parameter: string
+   * * oldValue: string
+   * * newValue: string
+   */
+  public static readonly VARIANT_PARAMETER_COMMITTED = 'variantParameterCommitted';
+
+  /**
+   * Fired after a {@link ParameterBag} has been committed.
+   *
+   * Scopes:
+   * * Global
+   * * {@link Variant}
+   *
+   * Payload:
+   * * variant: {@link Variant}
+   * * parameters: {@link ParameterBag}
+   * * oldValues: string[]
+   * * newValues: string[]
+   */
+  public static readonly VARIANT_PARAMETER_BAG_COMMITTED = 'variantParameterBagCommitted';
+
+  /**
+   * Fired after a {@link VariantInstance} has been created.
+   *
+   * Scopes:
+   * * Global
+   * * {@link VariantInstanceManager}
+   *
+   * Payload:
+   * * variantInstance: {@link VariantInstance}
+   */
+  public static readonly VARIANT_INSTANCE_CREATED = 'variantInstanceCreated';
+  /**
+   * Fired after a {@link VariantInstance} has been registered. This is the case when the {@link VariantInstance} is
+   * considered "lazy".
+   *
+   * Scopes:
+   * * Global
+   * * {@link VariantInstanceManager}
+   *
+   * Payload:
+   * * variantInstanceDefinition: {@link VariantInstanceDefinition}
+   */
+  public static readonly VARIANT_INSTANCE_REGISTERED = 'variantInstanceRegistered';
+  /**
+   * Fired after a {@link VariantInstance} has been cloned.
+   *
+   * Scopes:
+   * * Global
+   * * {@link VariantInstanceManager}
+   *
+   * Payload:
+   * * variantInstanceClone: {@link VariantInstance}
+   */
+  public static readonly VARIANT_INSTANCE_CLONED = 'variantInstanceCloned';
+  /**
+   * Fired after a {@link VariantInstance} has been destroyed.
+   *
+   * Scopes:
+   * * Global
+   * * {@link VariantInstanceManager}
+   *
+   * Payload:
+   * * variantInstance: {@link VariantInstance}
+   */
+  public static readonly VARIANT_INSTANCE_DESTROYED = 'variantInstanceDestroyed';
+
+  /**
+   * Fired after a parameter on an {@link Element} has been committed.
+   *
+   * Scopes:
+   * * Global
+   * * {@link Element}
+   *
+   * Payload:
+   * * element: {@link Element}
+   * * parameter: string
+   * * oldValue: string
+   * * newValue: string
+   */
+  public static readonly ELEMENT_PARAMETER_COMMITTED = 'elementParameterCommitted';
+
+  /**
+   * Fired after a parameter on an {@link ViewerLight} has been committed.
+   *
+   * Scopes:
+   * * Global
+   * * {@link ViewerLight}
+   *
+   * Payload:
+   * * light: {@link ViewerLight}
+   * * parameter: string
+   * * oldValue: string
+   * * newValue: string
+   */
+  public static readonly VIEWER_LIGHT_PARAMETER_COMMITTED = 'viewerLightParameterCommitted';
+
+  /**
+   * Fired after a parameter on an {@link SceneManager} has been committed.
+   *
+   * Scopes:
+   * * Global
+   * * {@link SceneManager}
+   *
+   * Payload:
+   * * variant: {@link SceneManager}
+   * * parameter: string
+   * * oldValue: string
+   * * newValue: string
+   */
+  public static readonly SCENE_PARAMETER_COMMITTED = 'sceneParameterCommitted';
+
+  /**
+   * Fired after the active camera on the scene has been switched.
+   *
+   * Scopes:
+   * * Global
+   * * {@link Viewer}
+   *
+   * Payload:
+   * * camera: Camera
+   */
+  public static readonly CAMERA_SWITCHED = 'cameraSwitched';
+
+  /**
+   * Fired after the {@link Mesh} under the cursor has been picked/selected.
+   *
+   * Scopes:
+   * * Global
+   * * {@link Viewer}
+   *
+   * Payload:
+   * * mesh: {@link Mesh}
+   * * element: {@link Element}
+   * * variant: {@link Variant}
+   */
+  public static readonly MESH_PICKED = 'meshPicked';
+
+  /**
+   * Fired when a bunch of {@link Texture}s start loading.
+   *
+   * Scopes:
+   * * Global
+   * * {@link SceneManager}
+   */
+  public static readonly TEXTURE_LOADING_START = 'textureLoadingStart';
+
+  /**
+   * Fired when the last {@link Texture} was successfully loaded.
+   *
+   * Scopes:
+   * * Global
+   * * {@link SceneManager}
+   */
+  public static readonly TEXTURE_LOADING_END = 'textureLoadingEnd';
+
+  /**
+   * All events defined in this class.
+   */
+  public static get all() {
+    const all: string[] = [];
+    for (const event in Event) {
+      const property = Object.getOwnPropertyDescriptor(Event, event);
+      if (event.toUpperCase() === event && property && isString(property.value)) {
+        all.push(property.value);
+      }
+    }
+    return all;
+  }
+
+  /**
+   * All events starting with 'variant'.
+   */
+  public static get variant() {
+    return Event.all.filter(event => event.startsWith('variant'));
+  }
+
+  /**
+   * All events starting with 'element'.
+   */
+  public static get element() {
+    return Event.all.filter(event => event.startsWith('element'));
+  }
+
+  /**
+   * All events starting with 'scene'.
+   */
+  public static get scene() {
+    return Event.all.filter(event => event.startsWith('scene'));
+  }
+
+  /**
+   * All events starting with 'camera'.
+   */
+  public static get camera() {
+    return Event.all.filter(event => event.startsWith('camera'));
+  }
+}