@combeenation/3d-viewer 3.0.0-rc2 → 4.0.0-alpha6

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

@@ -1,358 +1,372 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Event = exports.emitter = void 0;
-var eventemitter3_1 = require("eventemitter3");
-var 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();
- * ```
- */
-var Event = /** @class */ (function () {
-    /**
-     * Constructor.
-     */
-    function Event() {
-    }
-    Object.defineProperty(Event, "all", {
-        /**
-         * All events defined in this class.
-         */
-        get: function () {
-            var all = [];
-            for (var event_1 in Event) {
-                var property = Object.getOwnPropertyDescriptor(Event, event_1);
-                if (event_1.toUpperCase() === event_1 && property && lodash_es_1.isString(property.value)) {
-                    all.push(property.value);
-                }
-            }
-            return all;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(Event, "variant", {
-        /**
-         * All events starting with 'variant'.
-         */
-        get: function () {
-            return Event.all.filter(function (event) { return event.startsWith('variant'); });
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(Event, "element", {
-        /**
-         * All events starting with 'element'.
-         */
-        get: function () {
-            return Event.all.filter(function (event) { return event.startsWith('element'); });
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(Event, "scene", {
-        /**
-         * All events starting with 'scene'.
-         */
-        get: function () {
-            return Event.all.filter(function (event) { return event.startsWith('scene'); });
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(Event, "camera", {
-        /**
-         * All events starting with 'camera'.
-         */
-        get: function () {
-            return Event.all.filter(function (event) { return event.startsWith('camera'); });
-        },
-        enumerable: false,
-        configurable: true
-    });
-    /**
-     * 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:
-     * * variant: {@link Element}
-     * * parameter: string
-     * * oldValue: string
-     * * newValue: string
-     */
-    Event.ELEMENT_PARAMETER_COMMITTED = 'elementParameterCommitted';
-    /**
-     * 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';
-    return Event;
-}());
-exports.Event = Event;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Event = exports.emitter = void 0;
+var eventemitter3_1 = require("eventemitter3");
+var 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();
+ * ```
+ */
+var Event = /** @class */ (function () {
+    /**
+     * Constructor.
+     */
+    function Event() {
+    }
+    Object.defineProperty(Event, "all", {
+        /**
+         * All events defined in this class.
+         */
+        get: function () {
+            var all = [];
+            for (var event_1 in Event) {
+                var property = Object.getOwnPropertyDescriptor(Event, event_1);
+                if (event_1.toUpperCase() === event_1 && property && lodash_es_1.isString(property.value)) {
+                    all.push(property.value);
+                }
+            }
+            return all;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Event, "variant", {
+        /**
+         * All events starting with 'variant'.
+         */
+        get: function () {
+            return Event.all.filter(function (event) { return event.startsWith('variant'); });
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Event, "element", {
+        /**
+         * All events starting with 'element'.
+         */
+        get: function () {
+            return Event.all.filter(function (event) { return event.startsWith('element'); });
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Event, "scene", {
+        /**
+         * All events starting with 'scene'.
+         */
+        get: function () {
+            return Event.all.filter(function (event) { return event.startsWith('scene'); });
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Event, "camera", {
+        /**
+         * All events starting with 'camera'.
+         */
+        get: function () {
+            return Event.all.filter(function (event) { return event.startsWith('camera'); });
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * 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';
+    return Event;
+}());
+exports.Event = Event;
 //# sourceMappingURL=event.js.map