@combeenation/3d-viewer 4.3.0 → 5.0.0-beta4

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

@@ -2,39 +2,62 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GltfExportManager = void 0;
 var tslib_1 = require("tslib");
+var core_1 = require("@babylonjs/core");
+var pbrMaterial_1 = require("@babylonjs/core/Materials/PBR/pbrMaterial");
+var math_color_1 = require("@babylonjs/core/Maths/math.color");
+var abstractMesh_1 = require("@babylonjs/core/Meshes/abstractMesh");
 var serializers_1 = require("@babylonjs/serializers");
+var structureHelper_1 = require("api/util/structureHelper");
 var lodash_es_1 = require("lodash-es");
 var GltfExportManager = /** @class */ (function () {
     /**
      * Constructor.
      */
-    function GltfExportManager(scene) {
-        this.scene = scene;
+    function GltfExportManager(viewer) {
+        this.viewer = viewer;
     }
     /**
      * Creates an {@link GltfExportManager}.
      */
-    GltfExportManager.create = function (scene) {
+    GltfExportManager.create = function (viewer) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
             return tslib_1.__generator(this, function (_a) {
-                return [2 /*return*/, new GltfExportManager(scene)];
+                return [2 /*return*/, new GltfExportManager(viewer)];
             });
         });
     };
     /**
-     * Exports selected nodes to a {@link GlbExportResult} blob.
+     * 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. See {@link gltfExportOptions}.
+     * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export.
      */
-    GltfExportManager.prototype.exportGlb = function (exportOptions) {
+    GltfExportManager.prototype.exportGlb = function (filename, exportOptions, excluded) {
+        if (filename === void 0) { filename = 'glb-export.glb'; }
         if (exportOptions === void 0) { exportOptions = {}; }
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var glbData;
+            var glbData, resBlob;
             return tslib_1.__generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, serializers_1.GLTF2Export.GLBAsync(this.scene, 'dummy', this.gltfExportOptions(exportOptions))];
+                    case 0:
+                        this.exportPreProcess();
+                        return [4 /*yield*/, serializers_1.GLTF2Export.GLBAsync(this.viewer.scene, 'dummy', this.gltfExportOptions(exportOptions, excluded))];
                     case 1:
                         glbData = _a.sent();
-                        return [2 /*return*/, glbData.glTFFiles['dummy.glb']]; // should be only one file for glb
+                        this.exportPostProcess();
+                        resBlob = glbData.glTFFiles['dummy.glb'];
+                        // check if result is valid, according to the typings this could also be a string
+                        if (resBlob instanceof Blob) {
+                            if (!filename.endsWith('.glb')) {
+                                filename += '.glb';
+                            }
+                            return [2 /*return*/, new File([resBlob], filename)];
+                        }
+                        else {
+                            // result was not a valid blob
+                            return [2 /*return*/, undefined];
+                        }
+                        return [2 /*return*/];
                 }
             });
         });
@@ -43,17 +66,21 @@ var GltfExportManager = /** @class */ (function () {
      * 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. See {@link gltfExportOptions}.
+     * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export.
      */
-    GltfExportManager.prototype.exportGltfToFile = function (filename, exportOptions) {
+    GltfExportManager.prototype.exportGltfToFile = function (filename, exportOptions, excluded) {
         if (exportOptions === void 0) { exportOptions = {}; }
         return tslib_1.__awaiter(this, void 0, void 0, function () {
             return tslib_1.__generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, serializers_1.GLTF2Export.GLTFAsync(this.scene, filename, this.gltfExportOptions(exportOptions)).then(function (glb) {
-                            glb.downloadFiles();
-                        })];
+                    case 0:
+                        this.exportPreProcess();
+                        return [4 /*yield*/, serializers_1.GLTF2Export.GLTFAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(function (glb) {
+                                glb.downloadFiles();
+                            })];
                     case 1:
                         _a.sent();
+                        this.exportPostProcess();
                         return [2 /*return*/];
                 }
             });
@@ -63,17 +90,21 @@ var GltfExportManager = /** @class */ (function () {
      * 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. See {@link gltfExportOptions}.
+     * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
      */
-    GltfExportManager.prototype.exportGlbToFile = function (filename, exportOptions) {
+    GltfExportManager.prototype.exportGlbToFile = function (filename, exportOptions, excluded) {
         if (exportOptions === void 0) { exportOptions = {}; }
         return tslib_1.__awaiter(this, void 0, void 0, function () {
             return tslib_1.__generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, serializers_1.GLTF2Export.GLBAsync(this.scene, filename, this.gltfExportOptions(exportOptions)).then(function (glb) {
-                            glb.downloadFiles();
-                        })];
+                    case 0:
+                        this.exportPreProcess();
+                        return [4 /*yield*/, serializers_1.GLTF2Export.GLBAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(function (glb) {
+                                glb.downloadFiles();
+                            })];
                     case 1:
                         _a.sent();
+                        this.exportPostProcess();
                         return [2 /*return*/];
                 }
             });
@@ -81,9 +112,8 @@ var GltfExportManager = /** @class */ (function () {
     };
     /**
      * Gets predefined {@link IExportOptions } merged with given ones.
-     * @protected
      */
-    GltfExportManager.prototype.gltfExportOptions = function (mergeWithOptions) {
+    GltfExportManager.prototype.gltfExportOptions = function (mergeWithOptions, excluded) {
         if (mergeWithOptions === void 0) { mergeWithOptions = {}; }
         var defaultOptions = {
             // includeCoordinateSystemConversionNodes: true,
@@ -97,11 +127,96 @@ var GltfExportManager = /** @class */ (function () {
                 if (node.name === '__bounding_box__') {
                     return false;
                 }
+                if (excluded && node instanceof core_1.Mesh && structureHelper_1.isMeshIncludedInExclusionList(node, excluded)) {
+                    return false;
+                }
                 return true;
             },
         };
         return lodash_es_1.merge({}, defaultOptions, mergeWithOptions);
     };
+    /**
+     * Stuff to be done before exporting to GLTF
+     */
+    GltfExportManager.prototype.exportPreProcess = function () {
+        this.viewer.pauseRendering();
+        this.exchangeRefractionMaterials();
+    };
+    /**
+     * Stuff to be done after the GLTF export
+     */
+    GltfExportManager.prototype.exportPostProcess = function () {
+        this.restoreRefractionMaterials();
+        this.viewer.resumeRendering();
+    };
+    /**
+     * Materials with refraction set are not exported properly.
+     * Exchange all such (relevant) materials with a more export-friendly version
+     */
+    GltfExportManager.prototype.exchangeRefractionMaterials = function () {
+        for (var _i = 0, _a = this.viewer.scene.getNodes(); _i < _a.length; _i++) {
+            var n = _a[_i];
+            if (!(n instanceof abstractMesh_1.AbstractMesh))
+                continue;
+            if (!(n.material instanceof pbrMaterial_1.PBRMaterial))
+                continue;
+            if (!n.material.subSurface.isRefractionEnabled)
+                continue;
+            if (n.material.transparencyMode !== pbrMaterial_1.PBRMaterial.PBRMATERIAL_OPAQUE)
+                continue;
+            // if we're here, we have a node holding a material with set refraction whose transparencyMode is set to PBRMATERIAL_OPAQUE
+            n.material = this.createRefractionMaterialReplacement(n.material);
+        }
+    };
+    /**
+     * Restore original materials with set refraction.
+     */
+    GltfExportManager.prototype.restoreRefractionMaterials = function () {
+        for (var _i = 0, _a = this.viewer.scene.getNodes(); _i < _a.length; _i++) {
+            var n = _a[_i];
+            if (!(n instanceof abstractMesh_1.AbstractMesh))
+                continue;
+            if (!(n.material instanceof pbrMaterial_1.PBRMaterial))
+                continue;
+            if (!this.isMaterialClonedForExport(n.material))
+                continue;
+            // at this point we have a pbrmaterial tagged as cloned in its metadata that's set on a mesh
+            // restore and dispose
+            var currMaterial = n.material;
+            var prevMaterial = this.viewer.scene.getMaterialByUniqueID(n.material.metadata.clonedFrom);
+            if (prevMaterial) {
+                n.material = prevMaterial; // restore previous material
+                currMaterial.dispose(false, true); // dispose of clone
+            }
+        }
+    };
+    /**
+     * Create an export-friendly replacement material for a material using refraction.
+     * @param mat Material to be replaced
+     */
+    GltfExportManager.prototype.createRefractionMaterialReplacement = function (mat) {
+        // if we're dealing with a clone already, return it instead of cloning
+        if (this.isMaterialClonedForExport(mat))
+            return mat;
+        // change material according to https://www.notion.so/combeenation/Glas-materials-don-t-look-glasy-after-export-d5fda2c6515e4420a8772744d3e6b460
+        var clonedMaterial = mat.clone(mat.name); // clone material. clone uses same name
+        clonedMaterial.metadata = tslib_1.__assign(tslib_1.__assign({}, mat.metadata), { clonedFrom: mat.uniqueId }); // create shallow copy of metadata on clone. see https://forum.babylonjs.com/t/the-metadata-of-the-mesh-cloned-by-the-instantiatemodelstoscene-method-is-a-shallow-copy/21563
+        clonedMaterial.refractionTexture = null;
+        clonedMaterial.metallicReflectanceTexture = null; // is this the correct one for metallic roughness?
+        clonedMaterial.alpha = 0.7;
+        clonedMaterial.albedoColor = new math_color_1.Color3(0.3, 0.3, 0.3);
+        clonedMaterial.transparencyMode = pbrMaterial_1.PBRMaterial.PBRMATERIAL_ALPHABLEND;
+        clonedMaterial.metallic = 0.65;
+        clonedMaterial.roughness = 0.15;
+        return clonedMaterial;
+    };
+    /**
+     * Inspect if a material was temporarily cloned for GLB export
+     * @param mat Material to be inspected
+     */
+    GltfExportManager.prototype.isMaterialClonedForExport = function (mat) {
+        return mat.metadata.clonedFrom;
+    };
     return GltfExportManager;
 }());
 exports.GltfExportManager = GltfExportManager;

package/dist/lib-cjs/api/manager/gltfExportManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"gltfExportManager.js","sourceRoot":"","sources":["../../../../src/api/manager/gltfExportManager.ts"],"names":[],"mappings":";;;;AACA,sDAAqE;AACrE,uCAAkC;AAElC;IACE;;OAEG;IACH,2BAAgC,KAAY;QAAZ,UAAK,GAAL,KAAK,CAAO;IAAG,CAAC;IAEhD;;OAEG;IACiB,wBAAM,GAA1B,UAA2B,KAAY;;;gBACrC,sBAAO,IAAI,iBAAiB,CAAC,KAAK,CAAC,EAAC;;;KACrC;IAED;;;OAGG;IACU,qCAAS,GAAtB,UAAuB,aAAkC;QAAlC,8BAAA,EAAA,kBAAkC;;;;;4BACvC,qBAAM,yBAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,EAAA;;wBAAhG,OAAO,GAAG,SAAsF;wBACtG,sBAAO,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,EAAC,CAAC,kCAAkC;;;;KAC1E;IAED;;;;OAIG;IACU,4CAAgB,GAA7B,UAA8B,QAAgB,EAAE,aAAkC;QAAlC,8BAAA,EAAA,kBAAkC;;;;4BAChF,qBAAM,yBAAW,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,UAAA,GAAG;4BAC/F,GAAG,CAAC,aAAa,EAAE,CAAC;wBACtB,CAAC,CAAC,EAAA;;wBAFF,SAEE,CAAC;;;;;KACJ;IAED;;;;OAIG;IACU,2CAAe,GAA5B,UAA6B,QAAgB,EAAE,aAAkC;QAAlC,8BAAA,EAAA,kBAAkC;;;;4BAC/E,qBAAM,yBAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,UAAA,GAAG;4BAC9F,GAAG,CAAC,aAAa,EAAE,CAAC;wBACtB,CAAC,CAAC,EAAA;;wBAFF,SAEE,CAAC;;;;;KACJ;IAED;;;OAGG;IACO,6CAAiB,GAA3B,UAA4B,gBAAqC;QAArC,iCAAA,EAAA,qBAAqC;QAC/D,IAAM,cAAc,GAAG;YACrB,gDAAgD;YAChD,gBAAgB,EAAE,UAAU,IAAS;gBACnC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE;oBACrB,OAAO,KAAK,CAAC;iBACd;gBACD,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,EAAE;oBAC5B,OAAO,KAAK,CAAC;iBACd;gBACD,IAAI,IAAI,CAAC,IAAI,KAAK,kBAAkB,EAAE;oBACpC,OAAO,KAAK,CAAC;iBACd;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;SACF,CAAC;QACF,OAAO,iBAAK,CAAC,EAAE,EAAE,cAAc,EAAE,gBAAgB,CAAC,CAAC;IACrD,CAAC;IACH,wBAAC;AAAD,CAAC,AAlED,IAkEC;AAlEY,8CAAiB"}
+{"version":3,"file":"gltfExportManager.js","sourceRoot":"","sources":["../../../../src/api/manager/gltfExportManager.ts"],"names":[],"mappings":";;;;AAAA,wCAAuC;AACvC,yEAAwE;AACxE,+DAA0D;AAC1D,oEAAmE;AAEnE,sDAAqE;AACrE,4DAAyE;AACzE,uCAAkC;AAElC;IACE;;OAEG;IACH,2BAAgC,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;IAAG,CAAC;IAElD;;OAEG;IACiB,wBAAM,GAA1B,UAA2B,MAAc;;;gBACvC,sBAAO,IAAI,iBAAiB,CAAC,MAAM,CAAC,EAAC;;;KACtC;IAED;;;;;OAKG;IACU,qCAAS,GAAtB,UACE,QAA2B,EAC3B,aAAkC,EAClC,QAA2B;QAF3B,yBAAA,EAAA,2BAA2B;QAC3B,8BAAA,EAAA,kBAAkC;;;;;;wBAGlC,IAAI,CAAC,gBAAgB,EAAE,CAAC;wBACR,qBAAM,yBAAW,CAAC,QAAQ,CACxC,IAAI,CAAC,MAAM,CAAC,KAAK,EACjB,OAAO,EACP,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAChD,EAAA;;wBAJK,OAAO,GAAG,SAIf;wBACD,IAAI,CAAC,iBAAiB,EAAE,CAAC;wBACnB,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;wBAE/C,iFAAiF;wBACjF,IAAI,OAAO,YAAY,IAAI,EAAE;4BAC3B,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gCAC9B,QAAQ,IAAI,MAAM,CAAC;6BACpB;4BACD,sBAAO,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAC;yBACtC;6BAAM;4BACL,8BAA8B;4BAC9B,sBAAO,SAAS,EAAC;yBAClB;;;;;KACF;IAED;;;;;OAKG;IACU,4CAAgB,GAA7B,UAA8B,QAAgB,EAAE,aAAkC,EAAE,QAA2B;QAA/D,8BAAA,EAAA,kBAAkC;;;;;wBAChF,IAAI,CAAC,gBAAgB,EAAE,CAAC;wBACxB,qBAAM,yBAAW,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAC5G,UAAA,GAAG;gCACD,GAAG,CAAC,aAAa,EAAE,CAAC;4BACtB,CAAC,CACF,EAAA;;wBAJD,SAIC,CAAC;wBACF,IAAI,CAAC,iBAAiB,EAAE,CAAC;;;;;KAC1B;IAED;;;;;OAKG;IACU,2CAAe,GAA5B,UAA6B,QAAgB,EAAE,aAAkC,EAAE,QAA2B;QAA/D,8BAAA,EAAA,kBAAkC;;;;;wBAC/E,IAAI,CAAC,gBAAgB,EAAE,CAAC;wBACxB,qBAAM,yBAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAC3G,UAAA,GAAG;gCACD,GAAG,CAAC,aAAa,EAAE,CAAC;4BACtB,CAAC,CACF,EAAA;;wBAJD,SAIC,CAAC;wBACF,IAAI,CAAC,iBAAiB,EAAE,CAAC;;;;;KAC1B;IAED;;OAEG;IACO,6CAAiB,GAA3B,UAA4B,gBAAqC,EAAE,QAA2B;QAAlE,iCAAA,EAAA,qBAAqC;QAC/D,IAAM,cAAc,GAAG;YACrB,gDAAgD;YAChD,gBAAgB,EAAE,UAAU,IAAS;gBACnC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE;oBACrB,OAAO,KAAK,CAAC;iBACd;gBACD,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,EAAE;oBAC5B,OAAO,KAAK,CAAC;iBACd;gBACD,IAAI,IAAI,CAAC,IAAI,KAAK,kBAAkB,EAAE;oBACpC,OAAO,KAAK,CAAC;iBACd;gBACD,IAAI,QAAQ,IAAI,IAAI,YAAY,WAAI,IAAI,+CAA6B,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE;oBACrF,OAAO,KAAK,CAAC;iBACd;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;SACF,CAAC;QACF,OAAO,iBAAK,CAAC,EAAE,EAAE,cAAc,EAAE,gBAAgB,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACO,4CAAgB,GAA1B;QACE,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;QAC7B,IAAI,CAAC,2BAA2B,EAAE,CAAC;IACrC,CAAC;IAED;;OAEG;IACO,6CAAiB,GAA3B;QACE,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAClC,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;IAChC,CAAC;IAED;;;OAGG;IACO,uDAA2B,GAArC;QACE,KAAgB,UAA4B,EAA5B,KAAA,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,EAA5B,cAA4B,EAA5B,IAA4B,EAAE;YAAzC,IAAM,CAAC,SAAA;YACV,IAAI,CAAC,CAAC,CAAC,YAAY,2BAAY,CAAC;gBAAE,SAAS;YAC3C,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,YAAY,yBAAW,CAAC;gBAAE,SAAS;YACnD,IAAI,CAAE,CAAC,CAAC,QAAwB,CAAC,UAAU,CAAC,mBAAmB;gBAAE,SAAS;YAC1E,IAAK,CAAC,CAAC,QAAwB,CAAC,gBAAgB,KAAK,yBAAW,CAAC,kBAAkB;gBAAE,SAAS;YAC9F,2HAA2H;YAC3H,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC,mCAAmC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;SACnE;IACH,CAAC;IAED;;OAEG;IACO,sDAA0B,GAApC;QACE,KAAgB,UAA4B,EAA5B,KAAA,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,EAA5B,cAA4B,EAA5B,IAA4B,EAAE;YAAzC,IAAM,CAAC,SAAA;YACV,IAAI,CAAC,CAAC,CAAC,YAAY,2BAAY,CAAC;gBAAE,SAAS;YAC3C,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,YAAY,yBAAW,CAAC;gBAAE,SAAS;YACnD,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,QAAQ,CAAC;gBAAE,SAAS;YAC1D,4FAA4F;YAE5F,sBAAsB;YACtB,IAAM,YAAY,GAAG,CAAC,CAAC,QAAQ,CAAC;YAChC,IAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YAC7F,IAAI,YAAY,EAAE;gBAChB,CAAC,CAAC,QAAQ,GAAG,YAAY,CAAC,CAAC,4BAA4B;gBACvD,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,mBAAmB;aACvD;SACF;IACH,CAAC;IAED;;;OAGG;IACO,+DAAmC,GAA7C,UAA8C,GAAgB;QAC5D,sEAAsE;QACtE,IAAI,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC;YAAE,OAAO,GAAG,CAAC;QAEpD,gJAAgJ;QAChJ,IAAI,cAAc,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,uCAAuC;QACjF,cAAc,CAAC,QAAQ,yCAAQ,GAAG,CAAC,QAAQ,KAAE,UAAU,EAAE,GAAG,CAAC,QAAQ,GAAE,CAAC,CAAC,6KAA6K;QACtP,cAAc,CAAC,iBAAiB,GAAG,IAAI,CAAC;QACxC,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC,CAAC,kDAAkD;QACpG,cAAc,CAAC,KAAK,GAAG,GAAG,CAAC;QAC3B,cAAc,CAAC,WAAW,GAAG,IAAI,mBAAM,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QACvD,cAAc,CAAC,gBAAgB,GAAG,yBAAW,CAAC,sBAAsB,CAAC;QACrE,cAAc,CAAC,QAAQ,GAAG,IAAI,CAAC;QAC/B,cAAc,CAAC,SAAS,GAAG,IAAI,CAAC;QAEhC,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;OAGG;IACO,qDAAyB,GAAnC,UAAoC,GAAgB;QAClD,OAAO,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC;IACjC,CAAC;IACH,wBAAC;AAAD,CAAC,AAtLD,IAsLC;AAtLY,8CAAiB"}

package/dist/lib-cjs/api/util/globalTypes.d.ts

@@ -27,7 +27,7 @@ declare type ArcRotateCamera = import('@babylonjs/core/Cameras/arcRotateCamera')
 declare type IScreenshotSize = import('@babylonjs/core/Misc/interfaces/screenshotSize').IScreenshotSize;
 declare type BabylonAnimation = import('@babylonjs/core/Animations/animation').Animation;
 declare type CubeTexture = import('@babylonjs/core/Materials/Textures/cubeTexture').CubeTexture;
-declare type MeshBuilder = import('@babylonjs/core/Meshes/meshBuilder').MeshBuilder;
+declare type MeshBuilder = typeof import('@babylonjs/core/Meshes/meshBuilder').MeshBuilder;
 declare type Texture = import('@babylonjs/core/Materials/Textures/texture').Texture;
 declare type HemisphericLight = import('@babylonjs/core/Lights/hemisphericLight').HemisphericLight;
 declare type DirectionalLight = import('@babylonjs/core/Lights/directionalLight').DirectionalLight;
@@ -209,6 +209,10 @@ declare type ScreenshotSettings = {
     /** Default `false` */
     renderSprites?: boolean;
 };
+/**
+ * Use this to define geometry to be excluded from autofocus, GLB export, etc.
+ */
+declare type ExcludedGeometry = (Mesh | VariantInstance | Variant | VariantElement)[];
 declare type AutofocusSettings = {
     /**
      * Can be used to customize the margins shown around the 3d model when calling {@link autofocusActiveCamera}.\
@@ -224,6 +228,8 @@ declare type AutofocusSettings = {
     beta?: number;
     /** Optional animation for the focusing camera movement */
     animation?: string | AnimationDefinition;
+    /** Optional list of geometry to be excluded from consideration */
+    exclude?: ExcludedGeometry;
 };
 declare type LightDefinitions = {
     [name: string]: LightDefinition | string;

package/dist/lib-cjs/api/util/structureHelper.d.ts

@@ -0,0 +1,9 @@
+import { Mesh } from '@babylonjs/core/Meshes/mesh';
+/**
+ * Find out if a mesh is part of a list of excluded geometry
+ * @param mesh BJS mesh
+ * @param list list of excluded geometry
+ * @returns boolean based on whether mesh was found in list
+ */
+declare const isMeshIncludedInExclusionList: (mesh: Mesh, list: ExcludedGeometry) => boolean;
+export { isMeshIncludedInExclusionList };

package/dist/lib-cjs/api/util/structureHelper.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isMeshIncludedInExclusionList = void 0;
+var mesh_1 = require("@babylonjs/core/Meshes/mesh");
+var variant_1 = require("../classes/variant");
+var variantInstance_1 = require("../classes/variantInstance");
+var element_1 = require("../classes/element");
+/**
+ * Find out if a mesh is part of a list of excluded geometry
+ * @param mesh BJS mesh
+ * @param list list of excluded geometry
+ * @returns boolean based on whether mesh was found in list
+ */
+var isMeshIncludedInExclusionList = function (mesh, list) {
+    var checkMesh = function (inputMesh, meshToCheck) {
+        return inputMesh.uniqueId === meshToCheck.uniqueId;
+    };
+    var checkElement = function (inputEl, meshToCheck) {
+        return inputEl.meshesFlat.some(function (m) { return checkMesh(m, meshToCheck); });
+    };
+    var checkVariant = function (inputVariant, meshToCheck) {
+        return inputVariant.elements.some(function (el) { return checkElement(el, meshToCheck); });
+    };
+    var checkVariantInstance = function (inputVarInst, meshToCheck) {
+        return inputVarInst.variant.elements.some(function (el) { return checkElement(el, meshToCheck); });
+    };
+    var isExcluded = list.some(function (geometryToExclude) {
+        if (geometryToExclude instanceof variantInstance_1.VariantInstance) {
+            return checkVariantInstance(geometryToExclude, mesh);
+        }
+        if (geometryToExclude instanceof variant_1.Variant) {
+            return checkVariant(geometryToExclude, mesh);
+        }
+        if (geometryToExclude instanceof element_1.Element) {
+            return checkElement(geometryToExclude, mesh);
+        }
+        if (geometryToExclude instanceof mesh_1.Mesh) {
+            return checkMesh(geometryToExclude, mesh);
+        }
+        return false;
+    });
+    return isExcluded;
+};
+exports.isMeshIncludedInExclusionList = isMeshIncludedInExclusionList;
+//# sourceMappingURL=structureHelper.js.map

package/dist/lib-cjs/api/util/structureHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"structureHelper.js","sourceRoot":"","sources":["../../../../src/api/util/structureHelper.ts"],"names":[],"mappings":";;;AAAA,oDAAmD;AACnD,8CAA6C;AAC7C,8DAA6D;AAC7D,8CAA6C;AAE7C;;;;;GAKG;AACH,IAAM,6BAA6B,GAAG,UAAU,IAAU,EAAE,IAAsB;IAChF,IAAM,SAAS,GAAG,UAAC,SAAe,EAAE,WAAiB;QACnD,OAAO,SAAS,CAAC,QAAQ,KAAK,WAAW,CAAC,QAAQ,CAAC;IACrD,CAAC,CAAC;IACF,IAAM,YAAY,GAAG,UAAC,OAAgB,EAAE,WAAiB;QACvD,OAAO,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,UAAA,CAAC,IAAI,OAAA,SAAS,CAAC,CAAC,EAAE,WAAW,CAAC,EAAzB,CAAyB,CAAC,CAAC;IACjE,CAAC,CAAC;IACF,IAAM,YAAY,GAAG,UAAC,YAAqB,EAAE,WAAiB;QAC5D,OAAO,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAA,EAAE,IAAI,OAAA,YAAY,CAAC,EAAE,EAAE,WAAW,CAAC,EAA7B,CAA6B,CAAC,CAAC;IACzE,CAAC,CAAC;IACF,IAAM,oBAAoB,GAAG,UAAC,YAA6B,EAAE,WAAiB;QAC5E,OAAO,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAA,EAAE,IAAI,OAAA,YAAY,CAAC,EAAE,EAAE,WAAW,CAAC,EAA7B,CAA6B,CAAC,CAAC;IACjF,CAAC,CAAC;IACF,IAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAA,iBAAiB;QAC5C,IAAI,iBAAiB,YAAY,iCAAe,EAAE;YAChD,OAAO,oBAAoB,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;SACtD;QACD,IAAI,iBAAiB,YAAY,iBAAO,EAAE;YACxC,OAAO,YAAY,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;SAC9C;QACD,IAAI,iBAAiB,YAAY,iBAAO,EAAE;YACxC,OAAO,YAAY,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;SAC9C;QACD,IAAI,iBAAiB,YAAY,WAAI,EAAE;YACrC,OAAO,SAAS,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;SAC3C;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;IACH,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEO,sEAA6B"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@combeenation/3d-viewer",
   "description": "Combeenation 3D Viewer",
-  "version": "4.3.0",
+  "version": "5.0.0-beta4",
   "homepage": "https://github.com/Combeenation/3d-viewer#readme",
   "keywords": [],
   "author": "",
@@ -43,10 +43,10 @@
     "format": "prettier --write ."
   },
   "dependencies": {
-    "@babylonjs/core": "4.2.1",
-    "@babylonjs/inspector": "4.2.1",
-    "@babylonjs/loaders": "4.2.1",
-    "@babylonjs/materials": "4.2.1",
+    "@babylonjs/core": "^5.6.0",
+    "@babylonjs/inspector": "5.6.0",
+    "@babylonjs/loaders": "5.6.0",
+    "@babylonjs/materials": "5.6.0",
     "eventemitter3": "^4.0.0",
     "gsap": "^3.5.1",
     "lodash-es": "^4.17.15"

package/src/api/classes/element.ts

@@ -36,6 +36,8 @@ import { VariantParameterizable } from './../classes/variantParameterizable';
 import { DottedPath } from './dottedPath';
 import { Parameter } from './parameter';
 import { Variant } from './variant';
+import { BaseTexture } from '@babylonjs/core/Materials/Textures/baseTexture';
+import { Node } from '@babylonjs/core';
 
 /**
  * An {@link Element} of a {@link Variant}. Acts as a container for diverse definitions. Lives only in the context of a
@@ -133,6 +135,25 @@ export class Element extends VariantParameterizable {
     return merge({}, this.variant.inheritedParameters, this.parameters);
   }
 
+  /**
+   * The actual {@link Mesh}es that make up this {@link Element}.
+   * Handy for e.g. creating a bounding box around an entire element.
+   */
+  get meshesFlat(): Mesh[] {
+    const flatMeshes = this.nodes.reduce((accFlatMeshes, curNode) => {
+      const currMeshes = curNode.getChildMeshes(false, n => n instanceof Mesh) as Mesh[];
+      return [...accFlatMeshes, ...currMeshes];
+    }, [] as Mesh[]);
+    return flatMeshes;
+  }
+
+  /**
+   * The meshes of this {@link Element}.
+   */
+  get meshes(): Mesh[] {
+    return this.nodes.filter(node => node instanceof Mesh) as Mesh[];
+  }
+
   /**
    * @protected
    */

package/src/api/classes/viewer.ts

@@ -1,3 +1,4 @@
+import { AbstractMesh, IPointerEvent } from '@babylonjs/core';
 import { ArcRotateCamera } from '@babylonjs/core/Cameras/arcRotateCamera';
 import { PickingInfo } from '@babylonjs/core/Collisions/pickingInfo';
 import { BoundingInfo } from '@babylonjs/core/Culling/boundingInfo';
@@ -10,14 +11,17 @@ import { Vector3 } from '@babylonjs/core/Maths/math.vector';
 import { Mesh } from '@babylonjs/core/Meshes/mesh';
 import { ScreenshotTools } from '@babylonjs/core/Misc/screenshotTools';
 import { Scene } from '@babylonjs/core/scene';
+import { WebXRSessionManager } from '@babylonjs/core/XR/webXRSessionManager';
+import { isMeshIncludedInExclusionList } from 'api/util/structureHelper';
 import { isString } from 'lodash-es';
 import { version } from '../../buildinfo.json';
 import { sceneSetup } from '../internal/sceneSetup';
 import { AnimationManager } from '../manager/animationManager';
+import { GltfExportManager } from '../manager/gltfExportManager';
 import { SceneManager } from '../manager/sceneManager';
 import { VariantInstanceManager } from '../manager/variantInstanceManager';
 import { SpecStorage } from '../store/specStorage';
-import { debounce, loadJson, sleep } from '../util/resourceHelper';
+import { debounce, loadJson } from '../util/resourceHelper';
 import { Event } from './event';
 import { EventBroadcaster } from './eventBroadcaster';
 import { Parameter } from './parameter';
@@ -40,12 +44,16 @@ export class Viewer extends EventBroadcaster {
 
   protected _sceneManager: SceneManager | null = null;
 
+  protected _gltfExportManager: GltfExportManager | null = null;
+
   protected _variantInstances: VariantInstanceManager | null = null;
 
   // default value is `true` ATM for compatibility reasons
   // in the future material cloning should be the edge case
   protected _cloneMaterialsOnMutation: boolean = true;
 
+  protected _isRenderLoopPaused: boolean = false;
+
   static version = version;
 
   /**
@@ -67,13 +75,30 @@ export class Viewer extends EventBroadcaster {
     return this._scene;
   }
 
+  /**
+   * Gets the {@link SceneManager} attached to the viewer.
+   *
+   * @throws Error if the {@link SceneManager} has not been initialized.
+   */
   get sceneManager(): SceneManager {
     if (!this._sceneManager) {
-      throw new Error(`Environment has not been initialized.`);
+      throw new Error(`SceneManager has not been initialized.`);
     }
     return this._sceneManager;
   }
 
+  /**
+   * Gets the {@link GltfExportManager} attached to the viewer.
+   *
+   * @throws Error if the {@link GltfExportManager} has not been initialized.
+   */
+  get gltfExportManager(): GltfExportManager {
+    if (!this._gltfExportManager) {
+      throw new Error(`GltfExportManager has not been initialized.`);
+    }
+    return this._gltfExportManager;
+  }
+
   /**
    * Gets the BabylonJS Engine that is attached to the viewer.
    */
@@ -154,6 +179,8 @@ export class Viewer extends EventBroadcaster {
       }
       await this.createVariantInstances();
     }
+    // create gltf export manager
+    this._gltfExportManager = await GltfExportManager.create(this);
     // resize handler
     window.addEventListener('resize', debounce(this.resize.bind(this), 100));
     // wait until scene is completely ready
@@ -162,7 +189,7 @@ export class Viewer extends EventBroadcaster {
     this.broadcastEvent(Event.BOOTSTRAP_END, this);
     // render loop
     this.engine.runRenderLoop(() => {
-      this.scene.render();
+      if (!this._isRenderLoopPaused) this.scene.render();
     });
     return this;
   }
@@ -285,10 +312,17 @@ export class Viewer extends EventBroadcaster {
     });
   }
 
+  /**
+   * Checks whether the browser is capable of handling XR.
+   */
+  public async isBrowserARCapable(): Promise<boolean> {
+    return await WebXRSessionManager.IsSessionSupportedAsync('immersive-ar');
+  }
+
   /**
    * Calculates the bounding box from all visible meshes on the scene.
    */
-  public async calculateBoundingBox(): Promise<Mesh> {
+  public async calculateBoundingBox(excludeGeometry?: ExcludedGeometry): Promise<Mesh> {
     if (this.scene.meshes.length === 0) {
       throw new Error('There are currently no meshes on the scene.');
     }
@@ -302,7 +336,9 @@ export class Viewer extends EventBroadcaster {
         const isNotBBoxMesh = bbName !== mesh.id;
         // ignore meshes with invalid bounding infos
         const hasValidBBoxInfo = mesh.getBoundingInfo().boundingSphere.radius > 0;
-        return isEnabled && isNotBBoxMesh && hasValidBBoxInfo;
+        // ignore excluded meshes
+        const isExcluded = excludeGeometry ? isMeshIncludedInExclusionList(mesh as Mesh, excludeGeometry) : false;
+        return isEnabled && isNotBBoxMesh && hasValidBBoxInfo && !isExcluded;
       })
       .reduce(
         (accBBoxMinMax, curMesh, idx) => {
@@ -323,6 +359,9 @@ export class Viewer extends EventBroadcaster {
     return boundingBox;
   }
 
+  /**
+   * Focuses the camera to see every visible mesh in scene and tries to optimize wheel precision and panning
+   */
   public async autofocusActiveCamera(settings?: AutofocusSettings) {
     // first check some preconditions
     const activeCamera = this.scene.activeCamera;
@@ -335,7 +374,7 @@ export class Viewer extends EventBroadcaster {
     }
 
     // get bounding box of all visible meshes, this is the base for the autofocus algorithm
-    const boundingBox = await this.calculateBoundingBox();
+    const boundingBox = await this.calculateBoundingBox(settings?.exclude);
 
     // focus the helper camera and set the calculated camera data to the real camera
     const helperCamera = this.getFocusedHelperCamera(boundingBox, settings);
@@ -385,6 +424,7 @@ export class Viewer extends EventBroadcaster {
       plane.material.diffuseTexture = dynamicTexture;
       return plane;
     };
+
     const axisX = Mesh.CreateLines(
       'axisX',
       [
@@ -394,7 +434,8 @@ export class Viewer extends EventBroadcaster {
         new Vector3(dimension, 0, 0),
         new Vector3(dimension * 0.95, -0.05 * dimension, 0),
       ],
-      scene
+      scene,
+      false
     );
     axisX.color = new Color3(1, 0, 0);
     const xChar = makeTextPlane('X', 'red', dimension / 10);
@@ -408,7 +449,8 @@ export class Viewer extends EventBroadcaster {
         new Vector3(0, dimension, 0),
         new Vector3(0.05 * dimension, dimension * 0.95, 0),
       ],
-      scene
+      scene,
+      false
     );
     axisY.color = new Color3(0, 1, 0);
     const yChar = makeTextPlane('Y', 'green', dimension / 10);
@@ -422,13 +464,28 @@ export class Viewer extends EventBroadcaster {
         new Vector3(0, 0, dimension),
         new Vector3(0, 0.05 * dimension, dimension * 0.95),
       ],
-      scene
+      scene,
+      false
     );
     axisZ.color = new Color3(0, 0, 1);
     const zChar = makeTextPlane('Z', 'blue', dimension / 10);
     zChar.position = new Vector3(0, 0.05 * dimension, 0.9 * dimension);
   }
 
+  /**
+   * Pause render loop.
+   */
+  public pauseRendering() {
+    this._isRenderLoopPaused = true;
+  }
+
+  /**
+   * Resume render loop when paused.
+   */
+  public resumeRendering() {
+    this._isRenderLoopPaused = false;
+  }
+
   /**
    * @emits {@link Event.SCENE_PROCESSING_START}
    * @emits {@link Event.SCENE_PROCESSING_END}
@@ -444,7 +501,7 @@ export class Viewer extends EventBroadcaster {
     const scene = await sceneSetup(engine, sceneJson);
     if (sceneJson.meshPicking) {
       new HighlightLayer('default', scene);
-      scene.onPointerPick = (pointerEvent: PointerEvent, pickInfo: PickingInfo) => {
+      scene.onPointerPick = (pointerEvent: IPointerEvent, pickInfo: PickingInfo) => {
         if (!pickInfo.hit) {
           return;
         }