@combeenation/3d-viewer 7.1.3 → 8.0.0

package/dist/lib-cjs/api/manager/animationManager.js

@@ -1,127 +1,127 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AnimationManager = void 0;
-const placementAnimation_1 = require("../classes/placementAnimation");
-const animation_1 = require("@babylonjs/core/Animations/animation");
-//import { CustomEase } from 'gsap/CustomEase';
-//import { ExpoScaleEase, RoughEase, SlowMo } from 'gsap/EasePack';
-const lodash_es_1 = require("lodash-es");
-//gsap.registerPlugin( CustomEase, ExpoScaleEase, RoughEase, SlowMo );
-class AnimationManager {
-    /**
-     * Constructor.
-     */
-    constructor(scene) {
-        this.scene = scene;
-        this.animations = [];
-    }
-    /**
-     * Creates an {@link AnimationManager} based on given Babylon.js scene.
-     */
-    static create(scene) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return new AnimationManager(scene);
-        });
-    }
-    /**
-     * @deprecated Use viewer.moveCameraTo().
-     */
-    resetCamera(animate = false) {
-        //TODO currently only works for arcrotate. are there any other cameras?
-        const activeCamera = this.scene.activeCamera;
-        if (!activeCamera) {
-            throw new Error('There is no active camera');
-        }
-        const initAlpha = activeCamera.metadata.alpha;
-        const initBeta = activeCamera.metadata.beta;
-        const initRadius = activeCamera.metadata.radius;
-        if (animate) {
-            this.animateArcRotateCamera(initAlpha, initBeta, initRadius);
-        }
-        else {
-            activeCamera.alpha = initAlpha;
-            activeCamera.beta = initBeta;
-            activeCamera.radius = initRadius;
-        }
-    }
-    /**
-     * @deprecated Use viewer.moveCameraTo().
-     */
-    animateArcRotateCamera(targetAlpha, targetBeta, targetRadius) {
-        const activeCamera = this.scene.activeCamera;
-        if (!activeCamera) {
-            throw new Error('There is no active camera');
-        }
-        const alphaAnimation = new animation_1.Animation('alphaAnimation', 'alpha', 30, animation_1.Animation.ANIMATIONTYPE_FLOAT, animation_1.Animation.ANIMATIONLOOPMODE_CONSTANT);
-        const betaAnimation = new animation_1.Animation('betaAnimation', 'beta', 30, animation_1.Animation.ANIMATIONTYPE_FLOAT, animation_1.Animation.ANIMATIONLOOPMODE_CONSTANT);
-        const radiusAnimation = new animation_1.Animation('radiusAnimation', 'radius', 30, animation_1.Animation.ANIMATIONTYPE_FLOAT, animation_1.Animation.ANIMATIONLOOPMODE_CONSTANT);
-        alphaAnimation.setKeys([
-            {
-                frame: 0,
-                value: activeCamera.alpha,
-            },
-            {
-                frame: 100,
-                value: targetAlpha,
-            },
-        ]);
-        betaAnimation.setKeys([
-            {
-                frame: 0,
-                value: activeCamera.beta,
-            },
-            {
-                frame: 100,
-                value: targetBeta,
-            },
-        ]);
-        radiusAnimation.setKeys([
-            {
-                frame: 0,
-                value: activeCamera.radius,
-            },
-            {
-                frame: 100,
-                value: targetRadius,
-            },
-        ]);
-        activeCamera.animations.push(alphaAnimation);
-        activeCamera.animations.push(betaAnimation);
-        activeCamera.animations.push(radiusAnimation);
-        const animation = this.scene.beginAnimation(activeCamera, 0, 100, false, 10);
-        animation.disposeOnEnd = true;
-    }
-    /**
-     * Stops and kills all running animations.
-     */
-    killAllAnimations() {
-        this.animations.forEach(animation => animation.kill());
-        this.animations = [];
-    }
-    /**
-     * @see {@link PlacementAnimation.play}
-     */
-    animateToPlacement(mutable, placement, animation) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const _animation = new placementAnimation_1.PlacementAnimation(mutable, placement, animation);
-            this.animations.push(_animation);
-            const animationPromise = _animation.play();
-            animationPromise.then(a => {
-                (0, lodash_es_1.remove)(this.animations, _a => _a === a);
-                a.kill();
-            });
-            return yield animationPromise;
-        });
-    }
-}
-exports.AnimationManager = AnimationManager;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnimationManager = void 0;
+const placementAnimation_1 = require("../classes/placementAnimation");
+const animation_1 = require("@babylonjs/core/Animations/animation");
+//import { CustomEase } from 'gsap/CustomEase';
+//import { ExpoScaleEase, RoughEase, SlowMo } from 'gsap/EasePack';
+const lodash_es_1 = require("lodash-es");
+//gsap.registerPlugin( CustomEase, ExpoScaleEase, RoughEase, SlowMo );
+class AnimationManager {
+    /**
+     * Constructor.
+     */
+    constructor(scene) {
+        this.scene = scene;
+        this.animations = [];
+    }
+    /**
+     * Creates an {@link AnimationManager} based on given Babylon.js scene.
+     */
+    static create(scene) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new AnimationManager(scene);
+        });
+    }
+    /**
+     * @deprecated Use viewer.moveCameraTo().
+     */
+    resetCamera(animate = false) {
+        //TODO currently only works for arcrotate. are there any other cameras?
+        const activeCamera = this.scene.activeCamera;
+        if (!activeCamera) {
+            throw new Error('There is no active camera');
+        }
+        const initAlpha = activeCamera.metadata.alpha;
+        const initBeta = activeCamera.metadata.beta;
+        const initRadius = activeCamera.metadata.radius;
+        if (animate) {
+            this.animateArcRotateCamera(initAlpha, initBeta, initRadius);
+        }
+        else {
+            activeCamera.alpha = initAlpha;
+            activeCamera.beta = initBeta;
+            activeCamera.radius = initRadius;
+        }
+    }
+    /**
+     * @deprecated Use viewer.moveCameraTo().
+     */
+    animateArcRotateCamera(targetAlpha, targetBeta, targetRadius) {
+        const activeCamera = this.scene.activeCamera;
+        if (!activeCamera) {
+            throw new Error('There is no active camera');
+        }
+        const alphaAnimation = new animation_1.Animation('alphaAnimation', 'alpha', 30, animation_1.Animation.ANIMATIONTYPE_FLOAT, animation_1.Animation.ANIMATIONLOOPMODE_CONSTANT);
+        const betaAnimation = new animation_1.Animation('betaAnimation', 'beta', 30, animation_1.Animation.ANIMATIONTYPE_FLOAT, animation_1.Animation.ANIMATIONLOOPMODE_CONSTANT);
+        const radiusAnimation = new animation_1.Animation('radiusAnimation', 'radius', 30, animation_1.Animation.ANIMATIONTYPE_FLOAT, animation_1.Animation.ANIMATIONLOOPMODE_CONSTANT);
+        alphaAnimation.setKeys([
+            {
+                frame: 0,
+                value: activeCamera.alpha,
+            },
+            {
+                frame: 100,
+                value: targetAlpha,
+            },
+        ]);
+        betaAnimation.setKeys([
+            {
+                frame: 0,
+                value: activeCamera.beta,
+            },
+            {
+                frame: 100,
+                value: targetBeta,
+            },
+        ]);
+        radiusAnimation.setKeys([
+            {
+                frame: 0,
+                value: activeCamera.radius,
+            },
+            {
+                frame: 100,
+                value: targetRadius,
+            },
+        ]);
+        activeCamera.animations.push(alphaAnimation);
+        activeCamera.animations.push(betaAnimation);
+        activeCamera.animations.push(radiusAnimation);
+        const animation = this.scene.beginAnimation(activeCamera, 0, 100, false, 10);
+        animation.disposeOnEnd = true;
+    }
+    /**
+     * Stops and kills all running animations.
+     */
+    killAllAnimations() {
+        this.animations.forEach(animation => animation.kill());
+        this.animations = [];
+    }
+    /**
+     * @see {@link PlacementAnimation.play}
+     */
+    animateToPlacement(mutable, placement, animation) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const _animation = new placementAnimation_1.PlacementAnimation(mutable, placement, animation);
+            this.animations.push(_animation);
+            const animationPromise = _animation.play();
+            animationPromise.then(a => {
+                (0, lodash_es_1.remove)(this.animations, _a => _a === a);
+                a.kill();
+            });
+            return yield animationPromise;
+        });
+    }
+}
+exports.AnimationManager = AnimationManager;
 //# sourceMappingURL=animationManager.js.map

package/dist/lib-cjs/api/manager/gltfExportManager.d.ts

@@ -1,79 +1,102 @@
-import { Viewer } from '../classes/viewer';
-import { PBRMaterial } from '@babylonjs/core/Materials/PBR/pbrMaterial';
-import { IExportOptions } from '@babylonjs/serializers/glTF/2.0';
-export declare class GltfExportManager {
-    protected viewer: Viewer;
-    static readonly UNIQUE_MESH_METADATA_PROPERTY = "originalName";
-    /**
-     * Constructor.
-     */
-    protected constructor(viewer: Viewer);
-    /**
-     * Creates an {@link GltfExportManager}.
-     */
-    static create(viewer: Viewer): Promise<GltfExportManager>;
-    /**
-     * Exports selected nodes to a file.
-     * @param filename optional name of the exported .GLB file.
-     * @param exportOptions export options to be merged with default options.\
-     *                      `exportOptions.createUniqueMeshNames` defaults to `true` if not given.
-     * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
-     */
-    exportGlb(filename?: string, { createUniqueMeshNames, ...exportOptionsRest }?: IExportOptionsExtended, excluded?: ExcludedGeometryList): Promise<File | undefined>;
-    /**
-     * Exports selected nodes to GLTF. This may result in more than one file, since textures are exported separately.
-     * @param filename name of the main (text-based) .GLTF file referring to separate texture files.
-     * @param exportOptions export options to be merged with default options.\
-     *                      `exportOptions.createUniqueMeshNames` defaults to `true` if not given.
-     * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
-     */
-    exportGltfToFile(filename: string, { createUniqueMeshNames, ...exportOptionsRest }?: IExportOptionsExtended, excluded?: ExcludedGeometryList): Promise<void>;
-    /**
-     * Exports selected nodes to GLB. This results in one binary file.
-     * @param filename name of the .GLB file.
-     * @param exportOptions export options to be merged with default options.\
-     *                      `exportOptions.createUniqueMeshNames` defaults to `true` if not given.
-     * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
-     */
-    exportGlbToFile(filename: string, { createUniqueMeshNames, ...exportOptionsRest }?: IExportOptionsExtended, excluded?: ExcludedGeometryList): Promise<void>;
-    /**
-     * Gets predefined {@link IExportOptionsExtended } merged with given ones.
-     */
-    protected gltfExportOptions(mergeWithOptions?: IExportOptionsExtended, excluded?: ExcludedGeometryList): IExportOptions;
-    /**
-     * Stuff to be done before exporting to GLTF
-     */
-    protected exportPreProcess({ createUniqueMeshNames }: IExportOptionsExtended): void;
-    /**
-     * Stuff to be done after the GLTF export
-     */
-    protected exportPostProcess(): void;
-    /**
-     * Materials with refraction set are not exported properly.
-     * Exchange all such (relevant) materials with a more export-friendly version
-     */
-    protected exchangeRefractionMaterials(): void;
-    /**
-     * Restore original materials with set refraction.
-     */
-    protected restoreRefractionMaterials(): void;
-    /**
-     * Create an export-friendly replacement material for a material using refraction.
-     * @param mat Material to be replaced
-     */
-    protected createRefractionMaterialReplacement(mat: PBRMaterial): PBRMaterial;
-    /**
-     * Inspect if a material was temporarily cloned for GLB export
-     * @param mat Material to be inspected
-     */
-    protected isMaterialClonedForExport(mat: PBRMaterial): boolean;
-    /**
-     * Set unique mesh names for GLB export
-     */
-    protected setUniqueMeshNames(): void;
-    /**
-     * Restore original mesh names for meshes that were
-     * renamed with {@link setUniqueMeshNames()}
-     */
-    protected restoreOriginalMeshNames(): void;
-}
+import { Viewer } from '../classes/viewer';
+import { PBRMaterial } from '@babylonjs/core/Materials/PBR/pbrMaterial';
+import { IExportOptions } from '@babylonjs/serializers/glTF/2.0';
+declare type MetadataMap = {
+    [key: string]: any;
+};
+export declare class GltfExportManager {
+    protected viewer: Viewer;
+    protected static readonly _CLONED_FROM_MAT_METADATA_PROPERTY = "clonedFrom";
+    /**
+     * Constructor.
+     */
+    protected constructor(viewer: Viewer);
+    /**
+     * Creates an {@link GltfExportManager}.
+     */
+    static create(viewer: Viewer): Promise<GltfExportManager>;
+    /**
+     * Exports selected nodes to a file.
+     * @param filename optional name of the exported .GLB file.
+     * @param exportOptions export options to be merged with default options.\
+     *                      `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
+     * @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
+     * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
+     */
+    exportGlb(filename?: string, { exchangeRefractionMaterials, ...exportOptions }?: IExportOptionsExtended, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<File | undefined>;
+    /**
+     * Exports selected nodes to GLTF. This may result in more than one file, since textures are exported separately.
+     * @param filename name of the main (text-based) .GLTF file referring to separate texture files.
+     * @param exportOptions export options to be merged with default options.\
+     *                      `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
+     * @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
+     * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
+     */
+    exportGltfToFile(filename: string, { exchangeRefractionMaterials, ...exportOptions }?: IExportOptionsExtended, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<void>;
+    /**
+     * Exports selected nodes to GLB. This results in one binary file.
+     * @param filename name of the .GLB file.
+     * @param exportOptions export options to be merged with default options.\
+     *                      `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
+     * @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
+     * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
+     */
+    exportGlbToFile(filename: string, { exchangeRefractionMaterials, ...exportOptions }?: IExportOptionsExtended, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<void>;
+    /**
+     * Gets predefined {@link IExportOptions } merged with given ones.
+     */
+    protected gltfExportOptions(mergeWithOptions?: IExportOptions, excluded?: ExcludedGeometryList): IExportOptions;
+    /**
+     * Stuff to be done before exporting to GLTF
+     *
+     * @returns Either the original scene if no adjustments have been made or a copied scene (which can be disposed after
+     * the export) if adjustments have been made
+     */
+    protected exportPreProcess(exchangeRefractionMaterials: boolean, optimizeForAR: boolean): Promise<{
+        scene: Scene;
+        sceneCopied: boolean;
+    }>;
+    /**
+     * Create a copy of the viewer scene, which can be further processed and optimized for the GLB export.
+     * There is no "scene.clone" function, therefore the scene is serialized and loaded again to achieve this result.
+     */
+    protected copyViewerScene(): Promise<Scene>;
+    /**
+     * Stuff to be done after the GLTF export
+     */
+    protected exportPostProcess(scene: Scene, disposeScene: boolean): void;
+    /**
+     * Remove all node metadata and return them in a map
+     */
+    protected extractMetadataOfAllNodes(): MetadataMap;
+    /**
+     * Restore node metadata from previously cropped metadata map
+     */
+    protected restoreMetadataOfAllNodes(metadataMap: MetadataMap): void;
+    /**
+     * Materials with refraction set are not exported properly.
+     * Exchange all such (relevant) materials with a more export-friendly version
+     */
+    protected exchangeRefractionMaterials(scene: Scene): void;
+    /**
+     * Create an export-friendly replacement material for a material using refraction.
+     * @param mat Material to be replaced
+     */
+    protected createRefractionMaterialReplacement(mat: PBRMaterial): PBRMaterial;
+    /**
+     * Inspect if a material was temporarily cloned for GLB export
+     * @param mat Material to be inspected
+     */
+    protected isMaterialClonedForExport(mat: PBRMaterial): boolean;
+    /**
+     * Set unique mesh names for GLB export.
+     * Duplicate names lead to problems in AR on iOS devices.
+     */
+    protected setUniqueMeshNames(scene: Scene): void;
+    /**
+     * Stores the effect of all mesh transformations in their geometry and reset the transformation afterwards.
+     * In this way negative scalings which lead to problems in AR on iOS devices can be eliminated.
+     */
+    protected bakeTransformations(scene: Scene): void;
+}
+export {};