@combeenation/3d-viewer 13.0.1 → 14.0.1-rc1

package/dist/lib-cjs/manager/event-manager.d.ts

@@ -1,52 +1,52 @@
-import { Viewer } from '../index';
-import EventEmitter from 'eventemitter3';
-/**
- * Events that are fired by the viewer
- */
-export declare enum ViewerEvent {
-    /**
-     * Requested material is not available in the scene yet and is about to be created
-     * @param materialId
-     */
-    MaterialCreationStart = "MaterialCreationStart",
-    /**
-     * Material creation has been finished, that includes:
-     *   - Load definition from Combeenation server
-     *   - Load all textures
-     *   - Compile shader
-     * @param materialId
-     * @param allMaterialsCreated signalizes that no more materials are currently being created
-     */
-    MaterialCreationEnd = "MaterialCreationEnd",
-    /**
-     * Bounding sphere for autofocusing camera has been calculated.
-     * This is used internally for debugging purposes.
-     * @param boundingSphere
-     */
-    AutofocusStart = "AutofocusStart"
-}
-/**
- * Manager for eventing system, which ATM is only a slim wrapper about the "eventemitter3" library
- */
-export declare class EventManager {
-    protected viewer: Viewer;
-    protected _eventEmitter: EventEmitter;
-    /** @internal */
-    constructor(viewer: Viewer);
-    /**
-     * Used @internal to fire a viewer event
-     */
-    fireEvent(event: ViewerEvent, ...args: any[]): void;
-    /**
-     * Add listener to certain viewer event
-     */
-    addListener(event: ViewerEvent, fn: EventEmitter.ListenerFn): void;
-    /**
-     * Remove listener to viewer event
-     */
-    removeListener(event: ViewerEvent, fn: EventEmitter.ListenerFn): void;
-    /**
-     * Used @internal to clean eventing sytem before viewer destruction
-     */
-    removeAllListeners(event?: ViewerEvent): void;
-}
+import { Viewer } from '../index';
+import EventEmitter from 'eventemitter3';
+/**
+ * Events that are fired by the viewer
+ */
+export declare enum ViewerEvent {
+    /**
+     * Requested material is not available in the scene yet and is about to be created
+     * @param materialId
+     */
+    MaterialCreationStart = "MaterialCreationStart",
+    /**
+     * Material creation has been finished, that includes:
+     *   - Load definition from Combeenation server
+     *   - Load all textures
+     *   - Compile shader
+     * @param materialId
+     * @param allMaterialsCreated signalizes that no more materials are currently being created
+     */
+    MaterialCreationEnd = "MaterialCreationEnd",
+    /**
+     * Bounding sphere for autofocusing camera has been calculated.
+     * This is used internally for debugging purposes.
+     * @param boundingSphere
+     */
+    AutofocusStart = "AutofocusStart"
+}
+/**
+ * Manager for eventing system, which ATM is only a slim wrapper about the "eventemitter3" library
+ */
+export declare class EventManager {
+    protected viewer: Viewer;
+    protected _eventEmitter: EventEmitter;
+    /** @internal */
+    constructor(viewer: Viewer);
+    /**
+     * Used @internal to fire a viewer event
+     */
+    fireEvent(event: ViewerEvent, ...args: any[]): void;
+    /**
+     * Add listener to certain viewer event
+     */
+    addListener(event: ViewerEvent, fn: EventEmitter.ListenerFn): void;
+    /**
+     * Remove listener to viewer event
+     */
+    removeListener(event: ViewerEvent, fn: EventEmitter.ListenerFn): void;
+    /**
+     * Used @internal to clean eventing sytem before viewer destruction
+     */
+    removeAllListeners(event?: ViewerEvent): void;
+}

package/dist/lib-cjs/manager/event-manager.js

@@ -1,72 +1,72 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventManager = exports.ViewerEvent = void 0;
-const eventemitter3_1 = __importDefault(require("eventemitter3"));
-// NOTE: ATM we expose only very few events, due to the following reasons:
-// - Code is generally asynchronous and can be awaited by consumer
-// - We don't want to bloat the code with events that are never used
-/**
- * Events that are fired by the viewer
- */
-var ViewerEvent;
-(function (ViewerEvent) {
-    /**
-     * Requested material is not available in the scene yet and is about to be created
-     * @param materialId
-     */
-    ViewerEvent["MaterialCreationStart"] = "MaterialCreationStart";
-    /**
-     * Material creation has been finished, that includes:
-     *   - Load definition from Combeenation server
-     *   - Load all textures
-     *   - Compile shader
-     * @param materialId
-     * @param allMaterialsCreated signalizes that no more materials are currently being created
-     */
-    ViewerEvent["MaterialCreationEnd"] = "MaterialCreationEnd";
-    /**
-     * Bounding sphere for autofocusing camera has been calculated.
-     * This is used internally for debugging purposes.
-     * @param boundingSphere
-     */
-    ViewerEvent["AutofocusStart"] = "AutofocusStart";
-})(ViewerEvent = exports.ViewerEvent || (exports.ViewerEvent = {}));
-/**
- * Manager for eventing system, which ATM is only a slim wrapper about the "eventemitter3" library
- */
-class EventManager {
-    /** @internal */
-    constructor(viewer) {
-        this.viewer = viewer;
-        this._eventEmitter = new eventemitter3_1.default();
-    }
-    /**
-     * Used @internal to fire a viewer event
-     */
-    fireEvent(event, ...args) {
-        this._eventEmitter.emit(event, ...args);
-    }
-    /**
-     * Add listener to certain viewer event
-     */
-    addListener(event, fn) {
-        this._eventEmitter.addListener(event, fn);
-    }
-    /**
-     * Remove listener to viewer event
-     */
-    removeListener(event, fn) {
-        this._eventEmitter.removeListener(event, fn);
-    }
-    /**
-     * Used @internal to clean eventing sytem before viewer destruction
-     */
-    removeAllListeners(event) {
-        this._eventEmitter.removeAllListeners(event);
-    }
-}
-exports.EventManager = EventManager;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventManager = exports.ViewerEvent = void 0;
+const eventemitter3_1 = __importDefault(require("eventemitter3"));
+// NOTE: ATM we expose only very few events, due to the following reasons:
+// - Code is generally asynchronous and can be awaited by consumer
+// - We don't want to bloat the code with events that are never used
+/**
+ * Events that are fired by the viewer
+ */
+var ViewerEvent;
+(function (ViewerEvent) {
+    /**
+     * Requested material is not available in the scene yet and is about to be created
+     * @param materialId
+     */
+    ViewerEvent["MaterialCreationStart"] = "MaterialCreationStart";
+    /**
+     * Material creation has been finished, that includes:
+     *   - Load definition from Combeenation server
+     *   - Load all textures
+     *   - Compile shader
+     * @param materialId
+     * @param allMaterialsCreated signalizes that no more materials are currently being created
+     */
+    ViewerEvent["MaterialCreationEnd"] = "MaterialCreationEnd";
+    /**
+     * Bounding sphere for autofocusing camera has been calculated.
+     * This is used internally for debugging purposes.
+     * @param boundingSphere
+     */
+    ViewerEvent["AutofocusStart"] = "AutofocusStart";
+})(ViewerEvent = exports.ViewerEvent || (exports.ViewerEvent = {}));
+/**
+ * Manager for eventing system, which ATM is only a slim wrapper about the "eventemitter3" library
+ */
+class EventManager {
+    /** @internal */
+    constructor(viewer) {
+        this.viewer = viewer;
+        this._eventEmitter = new eventemitter3_1.default();
+    }
+    /**
+     * Used @internal to fire a viewer event
+     */
+    fireEvent(event, ...args) {
+        this._eventEmitter.emit(event, ...args);
+    }
+    /**
+     * Add listener to certain viewer event
+     */
+    addListener(event, fn) {
+        this._eventEmitter.addListener(event, fn);
+    }
+    /**
+     * Remove listener to viewer event
+     */
+    removeListener(event, fn) {
+        this._eventEmitter.removeListener(event, fn);
+    }
+    /**
+     * Used @internal to clean eventing sytem before viewer destruction
+     */
+    removeAllListeners(event) {
+        this._eventEmitter.removeAllListeners(event);
+    }
+}
+exports.EventManager = EventManager;
 //# sourceMappingURL=event-manager.js.map

package/dist/lib-cjs/manager/gltf-export-manager.d.ts

@@ -1,75 +1,84 @@
-import { ExcludedGeometryList, IExportOptions, Material, Node, TransformNode, Viewer } from '../index';
-/**
- * Manager for gltf export and augmented reality features
- */
-export declare class GltfExportManager {
-    protected viewer: Viewer;
-    protected static readonly _EXPORT_ROOT_NAME = "__export_root__";
-    protected _maxTextureSize: number;
-    /**
-     * Defines options for the export.
-     * We don't allow the user to overwrite certain settings, since we rely on properties like `removeNoopRootNodes` to
-     * stay `true` in order to make the AR export work.
-     * We could theoretically allow it if AR optimization is not desired, but this may confuse the user.
-     */
-    protected static _gltfExportOptions(optimizeForAR: boolean, excluded?: ExcludedGeometryList): IExportOptions;
-    /**
-     * Checks if a node should be available in the export
-     */
-    protected static _shouldExportNode(node: Node, excluded?: ExcludedGeometryList): boolean;
-    /**
-     * Creates a clone of the material which should be used for the export.
-     * This is mostly required for recreating textures with lower sizes.
-     * CAUTION: Material exchanging is not supported for materials that contain certain texture types:
-     * - Dynamic textures (Paintables): Cloning dynamic textures doesn't clone the canvas context
-     *   => so the clone is just empty
-     * - Render target textures: Disposing the clone will leave the scene in a "not ready" state
-     *   => this scenario is not fully analyzed yet, but it's not really worth the effort right now, since this kind of
-     *      of texture is not really used ATM
-     */
-    protected static _exchangeMaterial(material: Material): void;
-    /** @internal */
-    constructor(viewer: Viewer);
-    /**
-     * Exports selected nodes to a file.
-     * @param filename Optional name of the exported .GLB file.
-     * @param optimizeForAR Adjusts the exported GLB so that known issues get automatically fixed, this
-     *                      is mostly targeting Apples .usdz format.
-     * @param excluded Optional list of geometry (meshes, elements, variants,...) to be excluded from the export.
-     */
-    exportGlb(filename?: string, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<File | undefined>;
-    /**
-     * Exports selected nodes to GLTF. This may result in more than one file, since textures are exported seperately.
-     * @param filename Name of the main (text-based) .GLTF file referring to separate texture files.
-     * @param optimizeForAR Adjusts the exported GLB so that known issues get automatically fixed, this
-     *                      is mostly targeting Apples .usdz format.
-     * @param excluded Optional list of geometry (meshes, elements, variants,...) to be excluded from the export.
-     */
-    exportGltfToFile(filename: string, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<void>;
-    /**
-     * Exports selected nodes to GLB. This results in one binary file.
-     * @param filename Name of the main (text-based) .GLTF file referring to seperate texture files.
-     * @param optimizeForAR Adjusts the exported GLB so that known issues get automatically fixed, this
-     *                      is mostly targeting Apples .usdz format.
-     * @param excluded Optional list of geometry (meshes, elements, variants,...) to be excluded from the export.
-     */
-    exportGlbToFile(filename: string, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<void>;
-    /**
-     * Prepares scene for GLB export.
-     * This is very important for AR exports, since we have to do a lot of conversions to satisfy Apples .usdz format.
-     */
-    protected _exportPreProcess(optimizeForAR: boolean, excluded?: ExcludedGeometryList): Promise<void>;
-    /**
-     * Cleans up scene after export
-     */
-    protected _exportPostProcess(optimizeForAR: boolean): Promise<void>;
-    /**
-     * Creates a clone of the node which should be used for the export.
-     * Also switches to the cloned material if required.
-     */
-    protected _prepareNodeForExport(node: Node, clonedParent: TransformNode, excluded?: ExcludedGeometryList): void;
-    /**
-     * Help function for receiving all nodes that are marked for the export
-     */
-    protected _getNodesMarkedForExport(meshesOnly?: boolean): TransformNode[];
-}
+import { ExcludedGeometryList, IExportOptions, Material, Node, TransformNode, Viewer } from '../index';
+import type { AnimationGroup } from '@babylonjs/core/Animations/animationGroup';
+/**
+ * Manager for gltf export and augmented reality features
+ */
+export declare class GltfExportManager {
+    protected viewer: Viewer;
+    protected static readonly _EXPORT_ROOT_NAME = "__export_root__";
+    protected _maxTextureSize: number;
+    /**
+     * Animation groups which have been removed from the scene before export for AR and which need to be re-added
+     * afterwards.
+     *
+     * AR does not work on Android (i.e. the modelviewer) when animation groups are present in the scene.
+     * See CB-10055 for more details.
+     */
+    protected _animationGroupsToRestore: AnimationGroup[];
+    /**
+     * Defines options for the export.
+     * We don't allow the user to overwrite certain settings, since we rely on properties like `removeNoopRootNodes` to
+     * stay `true` in order to make the AR export work.
+     * We could theoretically allow it if AR optimization is not desired, but this may confuse the user.
+     */
+    protected static _gltfExportOptions(optimizeForAR: boolean, excluded?: ExcludedGeometryList): IExportOptions;
+    /**
+     * Checks if a node should be available in the export
+     */
+    protected static _shouldExportNode(node: Node, excluded?: ExcludedGeometryList): boolean;
+    /**
+     * Creates a clone of the material which should be used for the export.
+     * This is mostly required for recreating textures with lower sizes.
+     * CAUTION: Material exchanging is not supported for materials that contain certain texture types:
+     * - Dynamic textures (Paintables): Cloning dynamic textures doesn't clone the canvas context
+     *   => so the clone is just empty
+     * - Render target textures: Disposing the clone will leave the scene in a "not ready" state
+     *   => this scenario is not fully analyzed yet, but it's not really worth the effort right now, since this kind of
+     *      of texture is not really used ATM
+     */
+    protected static _exchangeMaterial(material: Material): void;
+    /** @internal */
+    constructor(viewer: Viewer);
+    /**
+     * Exports selected nodes to a file.
+     * @param filename Optional name of the exported .GLB file.
+     * @param optimizeForAR Adjusts the exported GLB so that known issues get automatically fixed, this
+     *                      is mostly targeting Apples .usdz format.
+     * @param excluded Optional list of geometry (meshes, elements, variants,...) to be excluded from the export.
+     */
+    exportGlb(filename?: string, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<File | undefined>;
+    /**
+     * Exports selected nodes to GLTF. This may result in more than one file, since textures are exported seperately.
+     * @param filename Name of the main (text-based) .GLTF file referring to separate texture files.
+     * @param optimizeForAR Adjusts the exported GLB so that known issues get automatically fixed, this
+     *                      is mostly targeting Apples .usdz format.
+     * @param excluded Optional list of geometry (meshes, elements, variants,...) to be excluded from the export.
+     */
+    exportGltfToFile(filename: string, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<void>;
+    /**
+     * Exports selected nodes to GLB. This results in one binary file.
+     * @param filename Name of the main (text-based) .GLTF file referring to seperate texture files.
+     * @param optimizeForAR Adjusts the exported GLB so that known issues get automatically fixed, this
+     *                      is mostly targeting Apples .usdz format.
+     * @param excluded Optional list of geometry (meshes, elements, variants,...) to be excluded from the export.
+     */
+    exportGlbToFile(filename: string, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<void>;
+    /**
+     * Prepares scene for GLB export.
+     * This is very important for AR exports, since we have to do a lot of conversions to satisfy Apples .usdz format.
+     */
+    protected _exportPreProcess(optimizeForAR: boolean, excluded?: ExcludedGeometryList): Promise<void>;
+    /**
+     * Cleans up scene after export
+     */
+    protected _exportPostProcess(optimizeForAR: boolean): Promise<void>;
+    /**
+     * Creates a clone of the node which should be used for the export.
+     * Also switches to the cloned material if required.
+     */
+    protected _prepareNodeForExport(node: Node, clonedParent: TransformNode, excluded?: ExcludedGeometryList): void;
+    /**
+     * Help function for receiving all nodes that are marked for the export
+     */
+    protected _getNodesMarkedForExport(meshesOnly?: boolean): TransformNode[];
+}