@combeenation/3d-viewer 5.1.0-rc2 → 5.1.0-rc4

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

@@ -0,0 +1,369 @@
+import { EventEmitter } from 'eventemitter3';
+import { isString } from 'lodash-es';
+/** @internal **/
+export var 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();
+ * ```
+ */
+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 && 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;
+}());
+export { Event };
+//# sourceMappingURL=event.js.map

package/dist/lib-es6/api/classes/event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.js","sourceRoot":"","sources":["../../../../src/api/classes/event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC,iBAAiB;AACjB,MAAM,CAAC,IAAM,OAAO,GAAG,IAAI,YAAY,EAAE,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH;IACE;;OAEG;IACH;IAAuB,CAAC;IAiSxB,sBAAkB,YAAG;QAHrB;;WAEG;aACH;YACE,IAAM,GAAG,GAAa,EAAE,CAAC;YACzB,KAAK,IAAM,OAAK,IAAI,KAAK,EAAE;gBACzB,IAAM,QAAQ,GAAG,MAAM,CAAC,wBAAwB,CAAC,KAAK,EAAE,OAAK,CAAC,CAAC;gBAC/D,IAAI,OAAK,CAAC,WAAW,EAAE,KAAK,OAAK,IAAI,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;oBACzE,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;iBAC1B;aACF;YACD,OAAO,GAAG,CAAC;QACb,CAAC;;;OAAA;IAKD,sBAAkB,gBAAO;QAHzB;;WAEG;aACH;YACE,OAAO,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,EAA3B,CAA2B,CAAC,CAAC;QAChE,CAAC;;;OAAA;IAKD,sBAAkB,gBAAO;QAHzB;;WAEG;aACH;YACE,OAAO,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,EAA3B,CAA2B,CAAC,CAAC;QAChE,CAAC;;;OAAA;IAKD,sBAAkB,cAAK;QAHvB;;WAEG;aACH;YACE,OAAO,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,EAAzB,CAAyB,CAAC,CAAC;QAC9D,CAAC;;;OAAA;IAKD,sBAAkB,eAAM;QAHxB;;WAEG;aACH;YACE,OAAO,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,EAA1B,CAA0B,CAAC,CAAC;QAC/D,CAAC;;;OAAA;IApUD;;;;;;;;;OASG;IACoB,qBAAe,GAAG,gBAAgB,CAAC;IAC1D;;;;;;;;;OASG;IACoB,mBAAa,GAAG,cAAc,CAAC;IAEtD;;;;;;;;OAQG;IACoB,mBAAa,GAAG,cAAc,CAAC;IACtD;;;;;;;;OAQG;IACoB,iBAAW,GAAG,YAAY,CAAC;IAElD;;;;;;;;;OASG;IACoB,yBAAmB,GAAG,mBAAmB,CAAC;IACjE;;;;;;;;;OASG;IACoB,uBAAiB,GAAG,iBAAiB,CAAC;IAE7D;;;;;;;;;OASG;IACoB,4BAAsB,GAAG,sBAAsB,CAAC;IACvE;;;;;;;;;OASG;IACoB,0BAAoB,GAAG,oBAAoB,CAAC;IAEnE;;;;;;;;;OASG;IACoB,qBAAe,GAAG,gBAAgB,CAAC;IAC1D;;;;;;;;;OASG;IACoB,uBAAiB,GAAG,kBAAkB,CAAC;IAE9D;;;;;;;;;OASG;IACoB,oBAAc,GAAG,eAAe,CAAC;IAExD;;;;;;;;;OASG;IACoB,oBAAc,GAAG,eAAe,CAAC;IAExD;;;;;;;;;;;;OAYG;IACoB,iCAA2B,GAAG,2BAA2B,CAAC;IAEjF;;;;;;;;;;;;OAYG;IACoB,qCAA+B,GAAG,8BAA8B,CAAC;IAExF;;;;;;;;;OASG;IACoB,8BAAwB,GAAG,wBAAwB,CAAC;IAC3E;;;;;;;;;;OAUG;IACoB,iCAA2B,GAAG,2BAA2B,CAAC;IACjF;;;;;;;;;OASG;IACoB,6BAAuB,GAAG,uBAAuB,CAAC;IACzE;;;;;;;;;OASG;IACoB,gCAA0B,GAAG,0BAA0B,CAAC;IAE/E;;;;;;;;;;;;OAYG;IACoB,iCAA2B,GAAG,2BAA2B,CAAC;IAEjF;;;;;;;;;;;;OAYG;IACoB,sCAAgC,GAAG,+BAA+B,CAAC;IAE1F;;;;;;;;;;;;OAYG;IACoB,+BAAyB,GAAG,yBAAyB,CAAC;IAE7E;;;;;;;;;OASG;IACoB,qBAAe,GAAG,gBAAgB,CAAC;IAE1D;;;;;;;;;;;OAWG;IACoB,iBAAW,GAAG,YAAY,CAAC;IA2CpD,YAAC;CAAA,AA3UD,IA2UC;SA3UY,KAAK"}

package/dist/lib-es6/api/classes/eventBroadcaster.d.ts

@@ -0,0 +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;
+}

package/dist/lib-es6/api/classes/eventBroadcaster.js

@@ -0,0 +1,51 @@
+import { __spreadArrays } from "tslib";
+import * as EventEmitter from 'eventemitter3';
+import { emitter } from './event';
+var EventBroadcaster = /** @class */ (function () {
+    function EventBroadcaster() {
+        this.eventEmitter = emitter;
+        this._eventEmitter = new EventEmitter();
+    }
+    /**
+     * Adds a listener function for the given event.
+     */
+    EventBroadcaster.prototype.addEventListener = function (event, fn) {
+        this._eventEmitter.addListener(event, fn);
+        return this;
+    };
+    /**
+     * Removes all `eventListeners` for given event.
+     */
+    EventBroadcaster.prototype.removeEventListener = function (event) {
+        this._eventEmitter.removeListener(event);
+        return this;
+    };
+    /**
+     * Broadcasts the given event with given arguments to all listeners and emitters.
+     */
+    EventBroadcaster.prototype.broadcastEvent = function (event) {
+        var _a, _b;
+        var args = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            args[_i - 1] = arguments[_i];
+        }
+        (_a = this._eventEmitter).emit.apply(_a, __spreadArrays([event], args));
+        (_b = this.eventEmitter).emit.apply(_b, __spreadArrays([event], args));
+        return this;
+    };
+    /**
+     * Alias for {@link addEventListener}.
+     */
+    EventBroadcaster.prototype.on = function (event, fn) {
+        return this.addEventListener(event, fn);
+    };
+    /**
+     * Alias for {@link removeEventListener}.
+     */
+    EventBroadcaster.prototype.off = function (event) {
+        return this.removeEventListener(event);
+    };
+    return EventBroadcaster;
+}());
+export { EventBroadcaster };
+//# sourceMappingURL=eventBroadcaster.js.map

package/dist/lib-es6/api/classes/eventBroadcaster.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventBroadcaster.js","sourceRoot":"","sources":["../../../../src/api/classes/eventBroadcaster.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,YAAY,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC;IAKE;QACE,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,YAAY,EAAE,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,2CAAgB,GAAvB,UAAwB,KAAa,EAAE,EAA2B;QAChE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,8CAAmB,GAA1B,UAA2B,KAAa;QACtC,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,yCAAc,GAArB,UAAsB,KAAa;;QAAE,cAAc;aAAd,UAAc,EAAd,qBAAc,EAAd,IAAc;YAAd,6BAAc;;QACjD,CAAA,KAAA,IAAI,CAAC,aAAa,CAAA,CAAC,IAAI,2BAAC,KAAK,GAAK,IAAI,GAAE;QACxC,CAAA,KAAA,IAAI,CAAC,YAAY,CAAA,CAAC,IAAI,2BAAC,KAAK,GAAK,IAAI,GAAE;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,6BAAE,GAAT,UAAU,KAAa,EAAE,EAA2B;QAClD,OAAO,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,8BAAG,GAAV,UAAW,KAAa;QACtB,OAAO,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IACH,uBAAC;AAAD,CAAC,AAhDD,IAgDC"}