@combeenation/3d-viewer 5.1.2 → 5.2.0-alpha1

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

@@ -0,0 +1,350 @@
+"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';
+//# sourceMappingURL=event.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"event.js","sourceRoot":"","sources":["../../../../../src/api/classes/event.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAC7C,yCAAqC;AAErC,iBAAiB;AACJ,QAAA,OAAO,GAAG,IAAI,4BAAY,EAAE,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAa,KAAK;IAChB;;OAEG;IACH,gBAAuB,CAAC;IA8RxB;;OAEG;IACI,MAAM,KAAK,GAAG;QACnB,MAAM,GAAG,GAAa,EAAE,CAAC;QACzB,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE;YACzB,MAAM,QAAQ,GAAG,MAAM,CAAC,wBAAwB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAC/D,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,KAAK,IAAI,QAAQ,IAAI,IAAA,oBAAQ,EAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBACzE,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;aAC1B;SACF;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,OAAO;QACvB,OAAO,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,OAAO;QACvB,OAAO,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,KAAK;QACrB,OAAO,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,MAAM;QACtB,OAAO,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC/D,CAAC;;AA1UH,sBA2UC;AArUC;;;;;;;;;GASG;AACoB,qBAAe,GAAG,gBAAgB,CAAC;AAC1D;;;;;;;;;GASG;AACoB,mBAAa,GAAG,cAAc,CAAC;AAEtD;;;;;;;;GAQG;AACoB,mBAAa,GAAG,cAAc,CAAC;AACtD;;;;;;;;GAQG;AACoB,iBAAW,GAAG,YAAY,CAAC;AAElD;;;;;;;;;GASG;AACoB,yBAAmB,GAAG,mBAAmB,CAAC;AACjE;;;;;;;;;GASG;AACoB,uBAAiB,GAAG,iBAAiB,CAAC;AAE7D;;;;;;;;;GASG;AACoB,4BAAsB,GAAG,sBAAsB,CAAC;AACvE;;;;;;;;;GASG;AACoB,0BAAoB,GAAG,oBAAoB,CAAC;AAEnE;;;;;;;;;GASG;AACoB,qBAAe,GAAG,gBAAgB,CAAC;AAC1D;;;;;;;;;GASG;AACoB,uBAAiB,GAAG,kBAAkB,CAAC;AAE9D;;;;;;;;;GASG;AACoB,oBAAc,GAAG,eAAe,CAAC;AAExD;;;;;;;;;GASG;AACoB,oBAAc,GAAG,eAAe,CAAC;AAExD;;;;;;;;;;;;GAYG;AACoB,iCAA2B,GAAG,2BAA2B,CAAC;AAEjF;;;;;;;;;;;;GAYG;AACoB,qCAA+B,GAAG,8BAA8B,CAAC;AAExF;;;;;;;;;GASG;AACoB,8BAAwB,GAAG,wBAAwB,CAAC;AAC3E;;;;;;;;;;GAUG;AACoB,iCAA2B,GAAG,2BAA2B,CAAC;AACjF;;;;;;;;;GASG;AACoB,6BAAuB,GAAG,uBAAuB,CAAC;AACzE;;;;;;;;;GASG;AACoB,gCAA0B,GAAG,0BAA0B,CAAC;AAE/E;;;;;;;;;;;;GAYG;AACoB,iCAA2B,GAAG,2BAA2B,CAAC;AAEjF;;;;;;;;;;;;GAYG;AACoB,sCAAgC,GAAG,+BAA+B,CAAC;AAE1F;;;;;;;;;;;;GAYG;AACoB,+BAAyB,GAAG,yBAAyB,CAAC;AAE7E;;;;;;;;;GASG;AACoB,qBAAe,GAAG,gBAAgB,CAAC;AAE1D;;;;;;;;;;;GAWG;AACoB,iBAAW,GAAG,YAAY,CAAC"}

package/dist/{lib-es6 → lib-cjs/src}/api/classes/eventBroadcaster.d.ts

@@ -1,26 +1,26 @@
-import * as EventEmitter from 'eventemitter3';
-export declare abstract class EventBroadcaster {
-    readonly eventEmitter: EventEmitter;
-    protected readonly _eventEmitter: EventEmitter;
-    protected constructor();
-    /**
-     * Adds a listener function for the given event.
-     */
-    addEventListener(event: string, fn: EventEmitter.ListenerFn): EventBroadcaster;
-    /**
-     * Removes all `eventListeners` for given event.
-     */
-    removeEventListener(event: string): EventBroadcaster;
-    /**
-     * Broadcasts the given event with given arguments to all listeners and emitters.
-     */
-    broadcastEvent(event: string, ...args: any[]): EventBroadcaster;
-    /**
-     * Alias for {@link addEventListener}.
-     */
-    on(event: string, fn: EventEmitter.ListenerFn): EventBroadcaster;
-    /**
-     * Alias for {@link removeEventListener}.
-     */
-    off(event: string): EventBroadcaster;
-}
+import EventEmitter from 'eventemitter3';
+export declare abstract class EventBroadcaster {
+    readonly eventEmitter: EventEmitter;
+    protected readonly _eventEmitter: EventEmitter;
+    protected constructor();
+    /**
+     * Adds a listener function for the given event.
+     */
+    addEventListener(event: string, fn: EventEmitter.ListenerFn): EventBroadcaster;
+    /**
+     * Removes all `eventListeners` for given event.
+     */
+    removeEventListener(event: string): EventBroadcaster;
+    /**
+     * Broadcasts the given event with given arguments to all listeners and emitters.
+     */
+    broadcastEvent(event: string, ...args: any[]): EventBroadcaster;
+    /**
+     * Alias for {@link addEventListener}.
+     */
+    on(event: string, fn: EventEmitter.ListenerFn): EventBroadcaster;
+    /**
+     * Alias for {@link removeEventListener}.
+     */
+    off(event: string): EventBroadcaster;
+}

package/dist/lib-cjs/src/api/classes/eventBroadcaster.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventBroadcaster = void 0;
+const event_1 = require("./event");
+const eventemitter3_1 = __importDefault(require("eventemitter3"));
+class EventBroadcaster {
+    constructor() {
+        this.eventEmitter = event_1.emitter;
+        this._eventEmitter = new eventemitter3_1.default();
+    }
+    /**
+     * Adds a listener function for the given event.
+     */
+    addEventListener(event, fn) {
+        this._eventEmitter.addListener(event, fn);
+        return this;
+    }
+    /**
+     * Removes all `eventListeners` for given event.
+     */
+    removeEventListener(event) {
+        this._eventEmitter.removeListener(event);
+        return this;
+    }
+    /**
+     * Broadcasts the given event with given arguments to all listeners and emitters.
+     */
+    broadcastEvent(event, ...args) {
+        this._eventEmitter.emit(event, ...args);
+        this.eventEmitter.emit(event, ...args);
+        return this;
+    }
+    /**
+     * Alias for {@link addEventListener}.
+     */
+    on(event, fn) {
+        return this.addEventListener(event, fn);
+    }
+    /**
+     * Alias for {@link removeEventListener}.
+     */
+    off(event) {
+        return this.removeEventListener(event);
+    }
+}
+exports.EventBroadcaster = EventBroadcaster;
+//# sourceMappingURL=eventBroadcaster.js.map

package/dist/lib-cjs/src/api/classes/eventBroadcaster.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventBroadcaster.js","sourceRoot":"","sources":["../../../../../src/api/classes/eventBroadcaster.ts"],"names":[],"mappings":";;;;;;AAAA,mCAAkC;AAClC,kEAAyC;AAEzC,MAAsB,gBAAgB;IAKpC;QACE,IAAI,CAAC,YAAY,GAAG,eAAO,CAAC;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,uBAAY,EAAE,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,KAAa,EAAE,EAA2B;QAChE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,mBAAmB,CAAC,KAAa;QACtC,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,KAAa,EAAE,GAAG,IAAW;QACjD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,EAAE,CAAC,KAAa,EAAE,EAA2B;QAClD,OAAO,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,KAAa;QACtB,OAAO,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;CACF;AAhDD,4CAgDC"}