@combeenation/3d-viewer 6.5.0 → 7.0.0-beta2

package/dist/lib-cjs/api/classes/event.js

@@ -1,366 +1,420 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Event = exports.emitter = void 0;
-const eventemitter3_1 = require("eventemitter3");
-const lodash_es_1 = require("lodash-es");
-/** @internal **/
-exports.emitter = new eventemitter3_1.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();
- * ```
- */
-class Event {
-    /**
-     * Constructor.
-     */
-    constructor() { }
-    /**
-     * All events defined in this class.
-     */
-    static get all() {
-        const all = [];
-        for (const event in Event) {
-            const property = Object.getOwnPropertyDescriptor(Event, event);
-            if (event.toUpperCase() === event && property && (0, lodash_es_1.isString)(property.value)) {
-                all.push(property.value);
-            }
-        }
-        return all;
-    }
-    /**
-     * All events starting with 'variant'.
-     */
-    static get variant() {
-        return Event.all.filter(event => event.startsWith('variant'));
-    }
-    /**
-     * All events starting with 'element'.
-     */
-    static get element() {
-        return Event.all.filter(event => event.startsWith('element'));
-    }
-    /**
-     * All events starting with 'scene'.
-     */
-    static get scene() {
-        return Event.all.filter(event => event.startsWith('scene'));
-    }
-    /**
-     * All events starting with 'camera'.
-     */
-    static get camera() {
-        return Event.all.filter(event => event.startsWith('camera'));
-    }
-}
-exports.Event = Event;
-/**
- * Fired before bootstrapping of the {@link Viewer} starts.
- *
- * Scopes:
- * * Global
- * * {@link Viewer}
- *
- * Payload:
- * * viewer: {@link Viewer}
- */
-Event.BOOTSTRAP_START = 'bootstrapStart';
-/**
- * Fired after bootstrapping of the {@link Viewer} finished.
- *
- * Scopes:
- * * Global
- * * {@link Viewer}
- *
- * Payload:
- * * viewer: {@link Viewer}
- */
-Event.BOOTSTRAP_END = 'bootstrapEnd';
-/**
- * Fired before loading any type of JSON or resource.
- *
- * Scopes:
- * * Global
- *
- * Payload:
- * * path: string
- */
-Event.LOADING_START = 'loadingStart';
-/**
- * Fired after loading any type of JSON or resource finished.
- *
- * Scopes:
- * * Global
- *
- * Payload:
- * * path: string
- */
-Event.LOADING_END = 'loadingEnd';
-/**
- * Fired before loading an asset (e.g. glTF) onto the scene.
- *
- * Scopes:
- * * Global
- * * {@link Variant}
- *
- * Payload:
- * * variant: {@link Variant}
- */
-Event.ASSET_LOADING_START = 'assetLoadingStart';
-/**
- * Fired after loading an asset (e.g. glTF) onto the scene finished.
- *
- * Scopes:
- * * Global
- * * {@link Variant}
- *
- * Payload:
- * * variant: {@link Variant}
- */
-Event.ASSET_LOADING_END = 'assetLoadingEnd';
-/**
- * Fired before scene initialization starts when bootstrapping the {@link Viewer}.
- *
- * Scopes:
- * * Global
- * * {@link Viewer}
- *
- * Payload:
- * * sceneJson: {@link SceneJson}
- */
-Event.SCENE_PROCESSING_START = 'sceneProcessingStart';
-/**
- * Fired after scene initialization end when bootstrapping the {@link Viewer}.
- *
- * Scopes:
- * * Global
- * * {@link Viewer}
- *
- * Payload:
- * * scene: {@link Scene}
- */
-Event.SCENE_PROCESSING_END = 'sceneProcessingEnd';
-/**
- * Fired after a {@link Variant} has been created.
- *
- * Scopes:
- * * Global
- * * {@link Variant}
- *
- * Payload:
- * * variant: {@link Variant}
- */
-Event.VARIANT_CREATED = 'variantCreated';
-/**
- * Fired after a {@link Variant} has been destroyed.
- *
- * Scopes:
- * * Global
- * * {@link Variant}
- *
- * Payload:
- * * variant: {@link Variant}
- */
-Event.VARIANT_DESTROYED = 'variantDestroyed';
-/**
- * Fired after the {@link Variant} under the cursor has been picked/selected.
- *
- * Scopes:
- * * Global
- * * {@link Viewer}
- *
- * Payload:
- * * variant: {@link Variant}
- */
-Event.VARIANT_PICKED = 'variantPicked';
-/**
- * Fired after the {@link Element} under the cursor has been picked/selected.
- *
- * Scopes:
- * * Global
- * * {@link Viewer}
- *
- * Payload:
- * * element: {@link Element}
- */
-Event.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
- */
-Event.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[]
- */
-Event.VARIANT_PARAMETER_BAG_COMMITTED = 'variantParameterBagCommitted';
-/**
- * Fired after a {@link VariantInstance} has been created.
- *
- * Scopes:
- * * Global
- * * {@link VariantInstanceManager}
- *
- * Payload:
- * * variantInstance: {@link VariantInstance}
- */
-Event.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}
- */
-Event.VARIANT_INSTANCE_REGISTERED = 'variantInstanceRegistered';
-/**
- * Fired after a {@link VariantInstance} has been cloned.
- *
- * Scopes:
- * * Global
- * * {@link VariantInstanceManager}
- *
- * Payload:
- * * variantInstanceClone: {@link VariantInstance}
- */
-Event.VARIANT_INSTANCE_CLONED = 'variantInstanceCloned';
-/**
- * Fired after a {@link VariantInstance} has been destroyed.
- *
- * Scopes:
- * * Global
- * * {@link VariantInstanceManager}
- *
- * Payload:
- * * variantInstance: {@link VariantInstance}
- */
-Event.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
- */
-Event.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
- */
-Event.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
- */
-Event.SCENE_PARAMETER_COMMITTED = 'sceneParameterCommitted';
-/**
- * Fired after the active camera on the scene has been switched.
- *
- * Scopes:
- * * Global
- * * {@link Viewer}
- *
- * Payload:
- * * camera: Camera
- */
-Event.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}
- */
-Event.MESH_PICKED = 'meshPicked';
-/**
- * Fired when a bunch of {@link Texture}s start loading.
- *
- * Scopes:
- * * Global
- * * {@link SceneManager}
- */
-Event.TEXTURE_LOADING_START = 'textureLoadingStart';
-/**
- * Fired when the last {@link Texture} was successfully loaded.
- *
- * Scopes:
- * * Global
- * * {@link SceneManager}
- */
-Event.TEXTURE_LOADING_END = 'textureLoadingEnd';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Event = exports.emitter = void 0;
+const eventemitter3_1 = require("eventemitter3");
+const lodash_es_1 = require("lodash-es");
+/** @internal **/
+exports.emitter = new eventemitter3_1.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();
+ * ```
+ */
+class Event {
+    /**
+     * Constructor.
+     */
+    constructor() { }
+    /**
+     * All events defined in this class.
+     */
+    static get all() {
+        const all = [];
+        for (const event in Event) {
+            const property = Object.getOwnPropertyDescriptor(Event, event);
+            if (event.toUpperCase() === event && property && (0, lodash_es_1.isString)(property.value)) {
+                all.push(property.value);
+            }
+        }
+        return all;
+    }
+    /**
+     * All events starting with 'variant'.
+     */
+    static get variant() {
+        return Event.all.filter(event => event.startsWith('variant'));
+    }
+    /**
+     * All events starting with 'element'.
+     */
+    static get element() {
+        return Event.all.filter(event => event.startsWith('element'));
+    }
+    /**
+     * All events starting with 'scene'.
+     */
+    static get scene() {
+        return Event.all.filter(event => event.startsWith('scene'));
+    }
+    /**
+     * All events starting with 'camera'.
+     */
+    static get camera() {
+        return Event.all.filter(event => event.startsWith('camera'));
+    }
+}
+exports.Event = Event;
+/**
+ * Fired before bootstrapping of the {@link Viewer} starts.
+ *
+ * Scopes:
+ * * Global
+ * * {@link Viewer}
+ *
+ * Payload:
+ * * viewer: {@link Viewer}
+ */
+Event.BOOTSTRAP_START = 'bootstrapStart';
+/**
+ * Fired after bootstrapping of the {@link Viewer} finished.
+ *
+ * Scopes:
+ * * Global
+ * * {@link Viewer}
+ *
+ * Payload:
+ * * viewer: {@link Viewer}
+ */
+Event.BOOTSTRAP_END = 'bootstrapEnd';
+/**
+ * Fired before loading any type of JSON or resource.
+ *
+ * Scopes:
+ * * Global
+ *
+ * Payload:
+ * * path: string
+ */
+Event.LOADING_START = 'loadingStart';
+/**
+ * Fired after loading any type of JSON or resource finished.
+ *
+ * Scopes:
+ * * Global
+ *
+ * Payload:
+ * * path: string
+ */
+Event.LOADING_END = 'loadingEnd';
+/**
+ * Fired before loading an asset (e.g. glTF) onto the scene.
+ *
+ * Scopes:
+ * * Global
+ * * {@link Variant}
+ *
+ * Payload:
+ * * variant: {@link Variant}
+ */
+Event.ASSET_LOADING_START = 'assetLoadingStart';
+/**
+ * Fired after loading an asset (e.g. glTF) onto the scene finished.
+ *
+ * Scopes:
+ * * Global
+ * * {@link Variant}
+ *
+ * Payload:
+ * * variant: {@link Variant}
+ */
+Event.ASSET_LOADING_END = 'assetLoadingEnd';
+/**
+ * Fired before scene initialization starts when bootstrapping the {@link Viewer}.
+ *
+ * Scopes:
+ * * Global
+ * * {@link Viewer}
+ *
+ * Payload:
+ * * sceneJson: {@link SceneJson}
+ */
+Event.SCENE_PROCESSING_START = 'sceneProcessingStart';
+/**
+ * Fired after scene initialization end when bootstrapping the {@link Viewer}.
+ *
+ * Scopes:
+ * * Global
+ * * {@link Viewer}
+ *
+ * Payload:
+ * * scene: {@link Scene}
+ */
+Event.SCENE_PROCESSING_END = 'sceneProcessingEnd';
+/**
+ * Fired after a {@link Variant} has been created.
+ *
+ * Scopes:
+ * * Global
+ * * {@link Viewer}
+ *
+ * Payload:
+ * * variant: {@link Variant}
+ */
+Event.VARIANT_CREATED = 'variantCreated';
+/**
+ * Fired after a {@link Variant} has been destroyed.
+ *
+ * Scopes:
+ * * Global
+ * * {@link Variant}
+ *
+ * Payload:
+ * * variant: {@link Variant}
+ */
+Event.VARIANT_DESTROYED = 'variantDestroyed';
+/**
+ * Fired after the {@link Variant} under the cursor has been picked/selected.
+ *
+ * Scopes:
+ * * Global
+ * * {@link Viewer}
+ *
+ * Payload:
+ * * variant: {@link Variant}
+ */
+Event.VARIANT_PICKED = 'variantPicked';
+/**
+ * Fired after the {@link Element} under the cursor has been picked/selected.
+ *
+ * Scopes:
+ * * Global
+ * * {@link Viewer}
+ *
+ * Payload:
+ * * element: {@link Element}
+ */
+Event.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
+ */
+Event.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[]
+ */
+Event.VARIANT_PARAMETER_BAG_COMMITTED = 'variantParameterBagCommitted';
+/**
+ * Fired after a {@link VariantInstance} has been created.
+ *
+ * Scopes:
+ * * Global
+ * * {@link VariantInstanceManager}
+ *
+ * Payload:
+ * * variantInstance: {@link VariantInstance}
+ */
+Event.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}
+ */
+Event.VARIANT_INSTANCE_REGISTERED = 'variantInstanceRegistered';
+/**
+ * Fired after a {@link VariantInstance} has been cloned.
+ *
+ * Scopes:
+ * * Global
+ * * {@link VariantInstanceManager}
+ *
+ * Payload:
+ * * variantInstanceClone: {@link VariantInstance}
+ */
+Event.VARIANT_INSTANCE_CLONED = 'variantInstanceCloned';
+/**
+ * Fired after a {@link VariantInstance} has been destroyed.
+ *
+ * Scopes:
+ * * Global
+ * * {@link VariantInstanceManager}
+ *
+ * Payload:
+ * * variantInstance: {@link VariantInstance}
+ */
+Event.VARIANT_INSTANCE_DESTROYED = 'variantInstanceDestroyed';
+/**
+ * Fired after all {@link VariantInstance}s have been either created or registered.
+ *
+ * Scopes:
+ * * Global
+ * * {@link Viewer}
+ *
+ * Payload:
+ * * viewer: {@link viewer}
+ */
+Event.VARIANT_INSTANCES_READY = 'variantInstancesReady';
+/**
+ * Fired after the nodes of a {@link Variant} has been cloned to the {@link Element}.
+ *
+ * Scopes:
+ * * Global
+ * * {@link Variant}
+ *
+ * Payload:
+ * * element: {@link Element}
+ */
+Event.ELEMENT_NODES_CLONED = 'elementNodesCloned';
+/**
+ * Fired after an {@link Element} has been created.
+ *
+ * Scopes:
+ * * Global
+ * * {@link Variant}
+ *
+ * Payload:
+ * * element: {@link Element}
+ */
+Event.ELEMENT_CREATED = 'elementCreated';
+/**
+ * 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
+ */
+Event.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
+ */
+Event.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
+ */
+Event.SCENE_PARAMETER_COMMITTED = 'sceneParameterCommitted';
+/**
+ * Fired after the active camera on the scene has been switched.
+ *
+ * Scopes:
+ * * Global
+ * * {@link Viewer}
+ *
+ * Payload:
+ * * camera: Camera
+ */
+Event.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}
+ */
+Event.MESH_PICKED = 'meshPicked';
+/**
+ * Fired when a bunch of {@link Texture}s start loading.
+ *
+ * Scopes:
+ * * Global
+ * * {@link SceneManager}
+ */
+Event.TEXTURE_LOADING_START = 'textureLoadingStart';
+/**
+ * Fired when the last {@link Texture} was successfully loaded.
+ *
+ * Scopes:
+ * * Global
+ * * {@link SceneManager}
+ */
+Event.TEXTURE_LOADING_END = 'textureLoadingEnd';
+/**
+ * Fired after a {@link Material} has been applied to a {@link Mesh}.
+ *
+ * Scopes:
+ * * Global
+ *
+ * Payload:
+ * * mesh: {@link Mesh}
+ * * material: {@link Material}
+ */
+Event.MESH_MATERIAL_APPLIED = 'meshMaterialApplied';
+/**
+ * Fired after a {@link TagManagerParameterObserver} has been called.
+ *
+ * Scopes:
+ * * Global
+ *
+ * Payload:
+ * * payload: {@link ParameterObserverResult}
+ */
+Event.TAG_MANAGER_PARAMETER_COMMITTED = 'tagManagerParameterCommitted';
 //# sourceMappingURL=event.js.map