@combeenation/3d-viewer 7.1.3 → 8.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. package/README.md +111 -111
  2. package/dist/lib-cjs/api/classes/animationInterface.d.ts +8 -8
  3. package/dist/lib-cjs/api/classes/animationInterface.js +2 -2
  4. package/dist/lib-cjs/api/classes/dottedPath.d.ts +79 -79
  5. package/dist/lib-cjs/api/classes/dottedPath.js +166 -166
  6. package/dist/lib-cjs/api/classes/element.d.ts +153 -153
  7. package/dist/lib-cjs/api/classes/element.js +672 -672
  8. package/dist/lib-cjs/api/classes/event.d.ts +401 -401
  9. package/dist/lib-cjs/api/classes/event.js +424 -424
  10. package/dist/lib-cjs/api/classes/eventBroadcaster.d.ts +26 -26
  11. package/dist/lib-cjs/api/classes/eventBroadcaster.js +49 -49
  12. package/dist/lib-cjs/api/classes/fuzzyMap.d.ts +7 -7
  13. package/dist/lib-cjs/api/classes/fuzzyMap.js +21 -21
  14. package/dist/lib-cjs/api/classes/parameter.d.ts +351 -351
  15. package/dist/lib-cjs/api/classes/parameter.js +524 -524
  16. package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
  17. package/dist/lib-cjs/api/classes/parameterObservable.js +72 -72
  18. package/dist/lib-cjs/api/classes/parameterizable.d.ts +15 -15
  19. package/dist/lib-cjs/api/classes/parameterizable.js +102 -102
  20. package/dist/lib-cjs/api/classes/placementAnimation.d.ts +45 -45
  21. package/dist/lib-cjs/api/classes/placementAnimation.js +176 -176
  22. package/dist/lib-cjs/api/classes/variant.d.ts +253 -253
  23. package/dist/lib-cjs/api/classes/variant.js +858 -858
  24. package/dist/lib-cjs/api/classes/variantInstance.d.ts +53 -53
  25. package/dist/lib-cjs/api/classes/variantInstance.js +125 -125
  26. package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +17 -17
  27. package/dist/lib-cjs/api/classes/variantParameterizable.js +86 -86
  28. package/dist/lib-cjs/api/classes/viewer.d.ts +213 -213
  29. package/dist/lib-cjs/api/classes/viewer.js +716 -716
  30. package/dist/lib-cjs/api/classes/viewer.js.map +1 -1
  31. package/dist/lib-cjs/api/classes/viewerError.d.ts +43 -43
  32. package/dist/lib-cjs/api/classes/viewerError.js +55 -55
  33. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
  34. package/dist/lib-cjs/api/classes/viewerLight.js +348 -348
  35. package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
  36. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  37. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
  38. package/dist/lib-cjs/api/internal/sceneSetup.js +226 -226
  39. package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
  40. package/dist/lib-cjs/api/manager/animationManager.js +126 -126
  41. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +102 -79
  42. package/dist/lib-cjs/api/manager/gltfExportManager.js +320 -242
  43. package/dist/lib-cjs/api/manager/gltfExportManager.js.map +1 -1
  44. package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
  45. package/dist/lib-cjs/api/manager/sceneManager.js +128 -128
  46. package/dist/lib-cjs/api/manager/tagManager.d.ts +116 -116
  47. package/dist/lib-cjs/api/manager/tagManager.js +444 -444
  48. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
  49. package/dist/lib-cjs/api/manager/textureLoadManager.js +97 -97
  50. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +106 -106
  51. package/dist/lib-cjs/api/manager/variantInstanceManager.js +292 -292
  52. package/dist/lib-cjs/api/store/specStorage.d.ts +32 -32
  53. package/dist/lib-cjs/api/store/specStorage.js +65 -65
  54. package/dist/lib-cjs/api/util/babylonHelper.d.ts +235 -235
  55. package/dist/lib-cjs/api/util/babylonHelper.js +753 -753
  56. package/dist/lib-cjs/api/util/globalTypes.d.ts +457 -455
  57. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  58. package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
  59. package/dist/lib-cjs/api/util/resourceHelper.js +203 -203
  60. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +44 -44
  61. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +175 -175
  62. package/dist/lib-cjs/api/util/stringHelper.d.ts +13 -13
  63. package/dist/lib-cjs/api/util/stringHelper.js +32 -32
  64. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
  65. package/dist/lib-cjs/api/util/structureHelper.js +57 -57
  66. package/dist/lib-cjs/buildinfo.json +3 -3
  67. package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
  68. package/dist/lib-cjs/index.d.ts +54 -54
  69. package/dist/lib-cjs/index.js +117 -117
  70. package/package.json +81 -81
  71. package/src/api/classes/animationInterface.ts +10 -10
  72. package/src/api/classes/dottedPath.ts +181 -181
  73. package/src/api/classes/element.ts +733 -733
  74. package/src/api/classes/event.ts +457 -457
  75. package/src/api/classes/eventBroadcaster.ts +52 -52
  76. package/src/api/classes/fuzzyMap.ts +21 -21
  77. package/src/api/classes/parameter.ts +561 -561
  78. package/src/api/classes/parameterObservable.ts +73 -73
  79. package/src/api/classes/parameterizable.ts +87 -87
  80. package/src/api/classes/placementAnimation.ts +162 -162
  81. package/src/api/classes/variant.ts +949 -949
  82. package/src/api/classes/variantInstance.ts +123 -123
  83. package/src/api/classes/variantParameterizable.ts +83 -83
  84. package/src/api/classes/viewer.ts +772 -772
  85. package/src/api/classes/viewerError.ts +63 -63
  86. package/src/api/classes/viewerLight.ts +339 -339
  87. package/src/api/internal/debugViewer.ts +90 -90
  88. package/src/api/internal/lensRendering.ts +9 -9
  89. package/src/api/internal/sceneSetup.ts +205 -205
  90. package/src/api/manager/animationManager.ts +143 -143
  91. package/src/api/manager/gltfExportManager.ts +297 -237
  92. package/src/api/manager/sceneManager.ts +134 -134
  93. package/src/api/manager/tagManager.ts +477 -477
  94. package/src/api/manager/textureLoadManager.ts +95 -95
  95. package/src/api/manager/variantInstanceManager.ts +309 -309
  96. package/src/api/store/specStorage.ts +68 -68
  97. package/src/api/util/babylonHelper.ts +823 -823
  98. package/src/api/util/globalTypes.ts +527 -525
  99. package/src/api/util/resourceHelper.ts +191 -191
  100. package/src/api/util/sceneLoaderHelper.ts +170 -170
  101. package/src/api/util/stringHelper.ts +30 -30
  102. package/src/api/util/structureHelper.ts +58 -58
  103. package/src/buildinfo.json +3 -3
  104. package/src/dev.ts +62 -62
  105. package/src/index.ts +103 -103
  106. package/src/types.d.ts +38 -38
@@ -1,243 +1,321 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- var __rest = (this && this.__rest) || function (s, e) {
12
- var t = {};
13
- for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
14
- t[p] = s[p];
15
- if (s != null && typeof Object.getOwnPropertySymbols === "function")
16
- for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
17
- if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
18
- t[p[i]] = s[p[i]];
19
- }
20
- return t;
21
- };
22
- Object.defineProperty(exports, "__esModule", { value: true });
23
- exports.GltfExportManager = void 0;
24
- const viewer_1 = require("../classes/viewer");
25
- const babylonHelper_1 = require("../util/babylonHelper");
26
- const structureHelper_1 = require("../util/structureHelper");
27
- const pbrMaterial_1 = require("@babylonjs/core/Materials/PBR/pbrMaterial");
28
- const math_color_1 = require("@babylonjs/core/Maths/math.color");
29
- const abstractMesh_1 = require("@babylonjs/core/Meshes/abstractMesh");
30
- const mesh_1 = require("@babylonjs/core/Meshes/mesh");
31
- const _2_0_1 = require("@babylonjs/serializers/glTF/2.0");
32
- const lodash_es_1 = require("lodash-es");
33
- class GltfExportManager {
34
- /**
35
- * Constructor.
36
- */
37
- constructor(viewer) {
38
- this.viewer = viewer;
39
- }
40
- /**
41
- * Creates an {@link GltfExportManager}.
42
- */
43
- static create(viewer) {
44
- return __awaiter(this, void 0, void 0, function* () {
45
- return new GltfExportManager(viewer);
46
- });
47
- }
48
- /**
49
- * Exports selected nodes to a file.
50
- * @param filename optional name of the exported .GLB file.
51
- * @param exportOptions export options to be merged with default options.\
52
- * `exportOptions.createUniqueMeshNames` defaults to `true` if not given.
53
- * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
54
- */
55
- exportGlb(filename = 'glb-export.glb', _a = {}, excluded) {
56
- var { createUniqueMeshNames = true } = _a, exportOptionsRest = __rest(_a, ["createUniqueMeshNames"]);
57
- return __awaiter(this, void 0, void 0, function* () {
58
- const exportOptions = Object.assign({ createUniqueMeshNames }, exportOptionsRest);
59
- this.exportPreProcess(exportOptions);
60
- const glbData = yield _2_0_1.GLTF2Export.GLBAsync(this.viewer.scene, 'dummy', this.gltfExportOptions(exportOptions, excluded));
61
- this.exportPostProcess();
62
- const resBlob = glbData.glTFFiles['dummy.glb']; // should be only one file for glb
63
- // check if result is valid, according to the typings this could also be a string
64
- if (resBlob instanceof Blob) {
65
- if (!filename.endsWith('.glb')) {
66
- filename += '.glb';
67
- }
68
- return new File([resBlob], filename);
69
- }
70
- else {
71
- // result was not a valid blob
72
- return undefined;
73
- }
74
- });
75
- }
76
- /**
77
- * Exports selected nodes to GLTF. This may result in more than one file, since textures are exported separately.
78
- * @param filename name of the main (text-based) .GLTF file referring to separate texture files.
79
- * @param exportOptions export options to be merged with default options.\
80
- * `exportOptions.createUniqueMeshNames` defaults to `true` if not given.
81
- * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
82
- */
83
- exportGltfToFile(filename, _a = {}, excluded) {
84
- var { createUniqueMeshNames = true } = _a, exportOptionsRest = __rest(_a, ["createUniqueMeshNames"]);
85
- return __awaiter(this, void 0, void 0, function* () {
86
- const exportOptions = Object.assign({ createUniqueMeshNames }, exportOptionsRest);
87
- this.exportPreProcess(exportOptions);
88
- yield _2_0_1.GLTF2Export.GLTFAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(glb => {
89
- glb.downloadFiles();
90
- });
91
- this.exportPostProcess();
92
- });
93
- }
94
- /**
95
- * Exports selected nodes to GLB. This results in one binary file.
96
- * @param filename name of the .GLB file.
97
- * @param exportOptions export options to be merged with default options.\
98
- * `exportOptions.createUniqueMeshNames` defaults to `true` if not given.
99
- * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
100
- */
101
- exportGlbToFile(filename, _a = {}, excluded) {
102
- var { createUniqueMeshNames = true } = _a, exportOptionsRest = __rest(_a, ["createUniqueMeshNames"]);
103
- return __awaiter(this, void 0, void 0, function* () {
104
- const exportOptions = Object.assign({ createUniqueMeshNames }, exportOptionsRest);
105
- this.exportPreProcess(exportOptions);
106
- yield _2_0_1.GLTF2Export.GLBAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(glb => {
107
- glb.downloadFiles();
108
- });
109
- this.exportPostProcess();
110
- });
111
- }
112
- /**
113
- * Gets predefined {@link IExportOptionsExtended } merged with given ones.
114
- */
115
- gltfExportOptions(mergeWithOptions = {}, excluded) {
116
- const defaultOptions = {
117
- // includeCoordinateSystemConversionNodes: true,
118
- shouldExportNode: function (node) {
119
- if (!node.isEnabled()) {
120
- return false;
121
- }
122
- if (node.name.startsWith(viewer_1.Viewer.BOUNDING_BOX_NAME)) {
123
- return false;
124
- }
125
- if (excluded && node instanceof mesh_1.Mesh && (0, structureHelper_1.isMeshIncludedInExclusionList)(node, excluded)) {
126
- return false;
127
- }
128
- return true;
129
- },
130
- };
131
- return (0, lodash_es_1.merge)({}, defaultOptions, mergeWithOptions);
132
- }
133
- /**
134
- * Stuff to be done before exporting to GLTF
135
- */
136
- exportPreProcess({ createUniqueMeshNames = true }) {
137
- this.viewer.pauseRendering();
138
- if (createUniqueMeshNames !== null && createUniqueMeshNames !== void 0 ? createUniqueMeshNames : true) {
139
- this.setUniqueMeshNames();
140
- }
141
- this.exchangeRefractionMaterials();
142
- }
143
- /**
144
- * Stuff to be done after the GLTF export
145
- */
146
- exportPostProcess() {
147
- this.restoreRefractionMaterials();
148
- this.restoreOriginalMeshNames();
149
- this.viewer.resumeRendering();
150
- }
151
- /**
152
- * Materials with refraction set are not exported properly.
153
- * Exchange all such (relevant) materials with a more export-friendly version
154
- */
155
- exchangeRefractionMaterials() {
156
- for (const n of this.viewer.scene.getNodes()) {
157
- if (!(n instanceof abstractMesh_1.AbstractMesh))
158
- continue;
159
- if (!(n.material instanceof pbrMaterial_1.PBRMaterial))
160
- continue;
161
- if (!n.material.subSurface.isRefractionEnabled)
162
- continue;
163
- if (n.material.transparencyMode !== pbrMaterial_1.PBRMaterial.PBRMATERIAL_OPAQUE)
164
- continue;
165
- // if we're here, we have a node holding a material with set refraction whose transparencyMode is set to
166
- // PBRMATERIAL_OPAQUE
167
- n.material = this.createRefractionMaterialReplacement(n.material);
168
- }
169
- }
170
- /**
171
- * Restore original materials with set refraction.
172
- */
173
- restoreRefractionMaterials() {
174
- for (const n of this.viewer.scene.getNodes()) {
175
- if (!(n instanceof abstractMesh_1.AbstractMesh))
176
- continue;
177
- if (!(n.material instanceof pbrMaterial_1.PBRMaterial))
178
- continue;
179
- if (!this.isMaterialClonedForExport(n.material))
180
- continue;
181
- // at this point we have a pbrmaterial tagged as cloned in its metadata that's set on a mesh
182
- // restore and dispose
183
- const currMaterial = n.material;
184
- const prevMaterial = this.viewer.scene.getMaterialByUniqueID(n.material.metadata.clonedFrom);
185
- if (prevMaterial) {
186
- n.material = prevMaterial; // restore previous material
187
- currMaterial.dispose(false, true); // dispose of clone
188
- }
189
- }
190
- }
191
- /**
192
- * Create an export-friendly replacement material for a material using refraction.
193
- * @param mat Material to be replaced
194
- */
195
- createRefractionMaterialReplacement(mat) {
196
- // if we're dealing with a clone already, return it instead of cloning
197
- if (this.isMaterialClonedForExport(mat))
198
- return mat;
199
- // change material according to https://www.notion.so/combeenation/Glas-materials-don-t-look-glasy-after-export-d5fda2c6515e4420a8772744d3e6b460
200
- const clonedMaterial = mat.clone(mat.name); // clone material. clone uses same name
201
- clonedMaterial.metadata = Object.assign(Object.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
202
- clonedMaterial.refractionTexture = null;
203
- clonedMaterial.metallicReflectanceTexture = null; // is this the correct one for metallic roughness?
204
- clonedMaterial.alpha = 0.7;
205
- clonedMaterial.albedoColor = new math_color_1.Color3(0.3, 0.3, 0.3);
206
- clonedMaterial.transparencyMode = pbrMaterial_1.PBRMaterial.PBRMATERIAL_ALPHABLEND;
207
- clonedMaterial.metallic = 0.65;
208
- clonedMaterial.roughness = 0.15;
209
- return clonedMaterial;
210
- }
211
- /**
212
- * Inspect if a material was temporarily cloned for GLB export
213
- * @param mat Material to be inspected
214
- */
215
- isMaterialClonedForExport(mat) {
216
- var _a;
217
- return !!((_a = mat.metadata) === null || _a === void 0 ? void 0 : _a.clonedFrom);
218
- }
219
- /**
220
- * Set unique mesh names for GLB export
221
- */
222
- setUniqueMeshNames() {
223
- this.viewer.scene.meshes.forEach(currMesh => {
224
- (0, babylonHelper_1.injectNodeMetadata)(currMesh, { [GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY]: currMesh.name }, false);
225
- currMesh.name = `${currMesh.name}_${currMesh.uniqueId}`;
226
- });
227
- }
228
- /**
229
- * Restore original mesh names for meshes that were
230
- * renamed with {@link setUniqueMeshNames()}
231
- */
232
- restoreOriginalMeshNames() {
233
- this.viewer.scene.meshes.forEach(currMesh => {
234
- if ((0, lodash_es_1.has)(currMesh.metadata, GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY)) {
235
- currMesh.name = currMesh.metadata[GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY];
236
- delete currMesh.metadata[GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY];
237
- }
238
- });
239
- }
240
- }
241
- exports.GltfExportManager = GltfExportManager;
242
- GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY = 'originalName';
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || function (mod) {
19
+ if (mod && mod.__esModule) return mod;
20
+ var result = {};
21
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
+ __setModuleDefault(result, mod);
23
+ return result;
24
+ };
25
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
26
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
27
+ return new (P || (P = Promise))(function (resolve, reject) {
28
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
29
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
30
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
31
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
32
+ });
33
+ };
34
+ var __rest = (this && this.__rest) || function (s, e) {
35
+ var t = {};
36
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
37
+ t[p] = s[p];
38
+ if (s != null && typeof Object.getOwnPropertySymbols === "function")
39
+ for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
40
+ if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
41
+ t[p[i]] = s[p[i]];
42
+ }
43
+ return t;
44
+ };
45
+ Object.defineProperty(exports, "__esModule", { value: true });
46
+ exports.GltfExportManager = void 0;
47
+ const viewer_1 = require("../classes/viewer");
48
+ const structureHelper_1 = require("../util/structureHelper");
49
+ const engine_1 = require("@babylonjs/core/Engines/engine");
50
+ const sceneLoader_1 = require("@babylonjs/core/Loading/sceneLoader");
51
+ const pbrMaterial_1 = require("@babylonjs/core/Materials/PBR/pbrMaterial");
52
+ const math_color_1 = require("@babylonjs/core/Maths/math.color");
53
+ const math_vector_1 = require("@babylonjs/core/Maths/math.vector");
54
+ const abstractMesh_1 = require("@babylonjs/core/Meshes/abstractMesh");
55
+ const mesh_1 = require("@babylonjs/core/Meshes/mesh");
56
+ const transformNode_1 = require("@babylonjs/core/Meshes/transformNode");
57
+ const sceneSerializer_1 = require("@babylonjs/core/Misc/sceneSerializer");
58
+ const _2_0_1 = require("@babylonjs/serializers/glTF/2.0");
59
+ const lodash_es_1 = require("lodash-es");
60
+ class GltfExportManager {
61
+ /**
62
+ * Constructor.
63
+ */
64
+ constructor(viewer) {
65
+ this.viewer = viewer;
66
+ }
67
+ /**
68
+ * Creates an {@link GltfExportManager}.
69
+ */
70
+ static create(viewer) {
71
+ return __awaiter(this, void 0, void 0, function* () {
72
+ return new GltfExportManager(viewer);
73
+ });
74
+ }
75
+ /**
76
+ * Exports selected nodes to a file.
77
+ * @param filename optional name of the exported .GLB file.
78
+ * @param exportOptions export options to be merged with default options.\
79
+ * `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
80
+ * @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
81
+ * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
82
+ */
83
+ exportGlb(filename = 'glb-export.glb', _a = {}, optimizeForAR, excluded) {
84
+ var { exchangeRefractionMaterials = true } = _a, exportOptions = __rest(_a, ["exchangeRefractionMaterials"]);
85
+ if (optimizeForAR === void 0) { optimizeForAR = false; }
86
+ return __awaiter(this, void 0, void 0, function* () {
87
+ const { scene, sceneCopied } = yield this.exportPreProcess(exchangeRefractionMaterials, optimizeForAR);
88
+ const glbData = yield _2_0_1.GLTF2Export.GLBAsync(scene, 'dummy', this.gltfExportOptions(exportOptions, excluded));
89
+ this.exportPostProcess(scene, sceneCopied);
90
+ const resBlob = glbData.glTFFiles['dummy.glb'];
91
+ // check if result is valid, according to the typings this could also be a string
92
+ if (resBlob instanceof Blob) {
93
+ if (!filename.endsWith('.glb')) {
94
+ filename += '.glb';
95
+ }
96
+ return new File([resBlob], filename);
97
+ }
98
+ else {
99
+ // result was not a valid blob
100
+ return undefined;
101
+ }
102
+ });
103
+ }
104
+ /**
105
+ * Exports selected nodes to GLTF. This may result in more than one file, since textures are exported separately.
106
+ * @param filename name of the main (text-based) .GLTF file referring to separate texture files.
107
+ * @param exportOptions export options to be merged with default options.\
108
+ * `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
109
+ * @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
110
+ * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
111
+ */
112
+ exportGltfToFile(filename, _a = {}, optimizeForAR, excluded) {
113
+ var { exchangeRefractionMaterials = true } = _a, exportOptions = __rest(_a, ["exchangeRefractionMaterials"]);
114
+ if (optimizeForAR === void 0) { optimizeForAR = false; }
115
+ return __awaiter(this, void 0, void 0, function* () {
116
+ const { scene, sceneCopied } = yield this.exportPreProcess(exchangeRefractionMaterials, optimizeForAR);
117
+ const gltf = yield _2_0_1.GLTF2Export.GLTFAsync(scene, filename, this.gltfExportOptions(exportOptions, excluded));
118
+ gltf.downloadFiles();
119
+ this.exportPostProcess(scene, sceneCopied);
120
+ });
121
+ }
122
+ /**
123
+ * Exports selected nodes to GLB. This results in one binary file.
124
+ * @param filename name of the .GLB file.
125
+ * @param exportOptions export options to be merged with default options.\
126
+ * `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
127
+ * @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
128
+ * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
129
+ */
130
+ exportGlbToFile(filename, _a = {}, optimizeForAR, excluded) {
131
+ var { exchangeRefractionMaterials = true } = _a, exportOptions = __rest(_a, ["exchangeRefractionMaterials"]);
132
+ if (optimizeForAR === void 0) { optimizeForAR = false; }
133
+ return __awaiter(this, void 0, void 0, function* () {
134
+ const { scene, sceneCopied } = yield this.exportPreProcess(exchangeRefractionMaterials, optimizeForAR);
135
+ const glb = yield _2_0_1.GLTF2Export.GLBAsync(scene, filename, this.gltfExportOptions(exportOptions, excluded));
136
+ glb.downloadFiles();
137
+ this.exportPostProcess(scene, sceneCopied);
138
+ });
139
+ }
140
+ /**
141
+ * Gets predefined {@link IExportOptions } merged with given ones.
142
+ */
143
+ gltfExportOptions(mergeWithOptions = {}, excluded) {
144
+ const defaultOptions = {
145
+ shouldExportNode: function (node) {
146
+ if (!node.isEnabled()) {
147
+ return false;
148
+ }
149
+ if (node.name.startsWith(viewer_1.Viewer.BOUNDING_BOX_NAME)) {
150
+ return false;
151
+ }
152
+ if (excluded && node instanceof mesh_1.Mesh && (0, structureHelper_1.isMeshIncludedInExclusionList)(node, excluded)) {
153
+ return false;
154
+ }
155
+ return true;
156
+ },
157
+ };
158
+ return (0, lodash_es_1.merge)({}, defaultOptions, mergeWithOptions);
159
+ }
160
+ /**
161
+ * Stuff to be done before exporting to GLTF
162
+ *
163
+ * @returns Either the original scene if no adjustments have been made or a copied scene (which can be disposed after
164
+ * the export) if adjustments have been made
165
+ */
166
+ exportPreProcess(exchangeRefractionMaterials, optimizeForAR) {
167
+ return __awaiter(this, void 0, void 0, function* () {
168
+ if (!exchangeRefractionMaterials && !optimizeForAR) {
169
+ // no need to copy the scene if no adjustments have to be made
170
+ return { scene: this.viewer.scene, sceneCopied: false };
171
+ }
172
+ // copy the scene for the GLB export improvements, so that the original viewer scene remains untouched
173
+ const copiedScene = yield this.copyViewerScene();
174
+ if (exchangeRefractionMaterials) {
175
+ this.exchangeRefractionMaterials(copiedScene);
176
+ }
177
+ if (optimizeForAR) {
178
+ this.setUniqueMeshNames(copiedScene);
179
+ this.bakeTransformations(copiedScene);
180
+ }
181
+ return { scene: copiedScene, sceneCopied: true };
182
+ });
183
+ }
184
+ /**
185
+ * Create a copy of the viewer scene, which can be further processed and optimized for the GLB export.
186
+ * There is no "scene.clone" function, therefore the scene is serialized and loaded again to achieve this result.
187
+ */
188
+ copyViewerScene() {
189
+ return __awaiter(this, void 0, void 0, function* () {
190
+ // required by the scene serializer
191
+ yield Promise.resolve().then(() => __importStar(require(/* webpackChunkName: "physicsenginecomponent" */ '@babylonjs/core/Physics/physicsEngineComponent')));
192
+ // copy scene function uses scene serializer, which can't handle "complex" data like classes, function or recursive
193
+ // data structures in metadata
194
+ // it basically does a `JSON.stringify` on the metadata
195
+ // therefore the metadata has to be removed from the nodes before the copy process
196
+ const metadataArr = this.extractMetadataOfAllNodes();
197
+ // serialize the scene
198
+ const serializedScene = yield sceneSerializer_1.SceneSerializer.SerializeAsync(this.viewer.scene);
199
+ // set the cropped metadata back to the viewer scene nodes
200
+ this.restoreMetadataOfAllNodes(metadataArr);
201
+ // load the scene into an invisible "dummy" canvas
202
+ const offscreenCanvas = new OffscreenCanvas(0, 0);
203
+ const engine = new engine_1.Engine(offscreenCanvas);
204
+ sceneLoader_1.SceneLoader.ShowLoadingScreen = false;
205
+ const newScene = yield sceneLoader_1.SceneLoader.LoadAsync('', 'data:' + JSON.stringify(serializedScene), engine);
206
+ // this is required for offscreen canvas, otherwise the scene dispose code throws when trying to remove the cursor
207
+ // events
208
+ newScene.doNotHandleCursors = true;
209
+ return newScene;
210
+ });
211
+ }
212
+ /**
213
+ * Stuff to be done after the GLTF export
214
+ */
215
+ exportPostProcess(scene, disposeScene) {
216
+ if (disposeScene) {
217
+ // copied scene for GLB export is not needed anymore, therefore it can be removed
218
+ scene.getEngine().dispose();
219
+ }
220
+ }
221
+ /**
222
+ * Remove all node metadata and return them in a map
223
+ */
224
+ extractMetadataOfAllNodes() {
225
+ return this.viewer.scene.getNodes().reduce((accMetadataObj, curNode) => {
226
+ const metadata = curNode.metadata;
227
+ delete curNode.metadata;
228
+ return Object.assign(Object.assign({}, accMetadataObj), { [curNode.uniqueId.toString()]: metadata });
229
+ }, {});
230
+ }
231
+ /**
232
+ * Restore node metadata from previously cropped metadata map
233
+ */
234
+ restoreMetadataOfAllNodes(metadataMap) {
235
+ this.viewer.scene.getNodes().forEach(node => {
236
+ const metadata = metadataMap[node.uniqueId.toString()];
237
+ if (metadata) {
238
+ node.metadata = metadata;
239
+ }
240
+ });
241
+ }
242
+ /**
243
+ * Materials with refraction set are not exported properly.
244
+ * Exchange all such (relevant) materials with a more export-friendly version
245
+ */
246
+ exchangeRefractionMaterials(scene) {
247
+ for (const n of scene.getNodes()) {
248
+ if (!(n instanceof abstractMesh_1.AbstractMesh))
249
+ continue;
250
+ if (!(n.material instanceof pbrMaterial_1.PBRMaterial))
251
+ continue;
252
+ if (!n.material.subSurface.isRefractionEnabled)
253
+ continue;
254
+ if (n.material.transparencyMode !== pbrMaterial_1.PBRMaterial.PBRMATERIAL_OPAQUE)
255
+ continue;
256
+ // if we're here, we have a node holding a material with set refraction whose transparencyMode is set to
257
+ // PBRMATERIAL_OPAQUE
258
+ n.material = this.createRefractionMaterialReplacement(n.material);
259
+ }
260
+ }
261
+ /**
262
+ * Create an export-friendly replacement material for a material using refraction.
263
+ * @param mat Material to be replaced
264
+ */
265
+ createRefractionMaterialReplacement(mat) {
266
+ // if we're dealing with a clone already, return it instead of cloning
267
+ if (this.isMaterialClonedForExport(mat))
268
+ return mat;
269
+ // change material according to https://www.notion.so/combeenation/Glas-materials-don-t-look-glasy-after-export-d5fda2c6515e4420a8772744d3e6b460
270
+ const clonedMaterial = mat.clone(mat.name); // clone material. clone uses same name
271
+ clonedMaterial.metadata = Object.assign(Object.assign({}, mat.metadata), { [GltfExportManager._CLONED_FROM_MAT_METADATA_PROPERTY]: 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
272
+ clonedMaterial.refractionTexture = null;
273
+ clonedMaterial.metallicReflectanceTexture = null; // is this the correct one for metallic roughness?
274
+ clonedMaterial.alpha = 0.7;
275
+ clonedMaterial.albedoColor = new math_color_1.Color3(0.3, 0.3, 0.3);
276
+ clonedMaterial.transparencyMode = pbrMaterial_1.PBRMaterial.PBRMATERIAL_ALPHABLEND;
277
+ clonedMaterial.metallic = 0.65;
278
+ clonedMaterial.roughness = 0.15;
279
+ return clonedMaterial;
280
+ }
281
+ /**
282
+ * Inspect if a material was temporarily cloned for GLB export
283
+ * @param mat Material to be inspected
284
+ */
285
+ isMaterialClonedForExport(mat) {
286
+ return (0, lodash_es_1.has)(mat.metadata, GltfExportManager._CLONED_FROM_MAT_METADATA_PROPERTY);
287
+ }
288
+ /**
289
+ * Set unique mesh names for GLB export.
290
+ * Duplicate names lead to problems in AR on iOS devices.
291
+ */
292
+ setUniqueMeshNames(scene) {
293
+ const allNodes = scene.getNodes().filter(node => node instanceof transformNode_1.TransformNode);
294
+ allNodes.forEach(currMesh => (currMesh.name = `${currMesh.name}_${currMesh.uniqueId}`));
295
+ }
296
+ /**
297
+ * Stores the effect of all mesh transformations in their geometry and reset the transformation afterwards.
298
+ * In this way negative scalings which lead to problems in AR on iOS devices can be eliminated.
299
+ */
300
+ bakeTransformations(scene) {
301
+ scene.meshes.forEach(mesh => {
302
+ if (mesh instanceof mesh_1.Mesh && mesh.geometry) {
303
+ // geometries can be shared across multiple meshes, first make them unique to avoid side-effects
304
+ mesh.makeGeometryUnique();
305
+ // this is the core functionality for storing the transformation data in the mesh geometry
306
+ mesh.bakeCurrentTransformIntoVertices();
307
+ }
308
+ });
309
+ // some nodes (mostly transform nodes), are not affected by the baking algorithm since they have no geometry
310
+ // => reset their transformation manually
311
+ const allNodes = scene.getNodes().filter(node => node instanceof transformNode_1.TransformNode);
312
+ allNodes.forEach(node => {
313
+ node.position = new math_vector_1.Vector3(0, 0, 0);
314
+ node.rotation = new math_vector_1.Vector3(0, 0, 0);
315
+ node.scaling = new math_vector_1.Vector3(1, 1, 1);
316
+ });
317
+ }
318
+ }
319
+ exports.GltfExportManager = GltfExportManager;
320
+ GltfExportManager._CLONED_FROM_MAT_METADATA_PROPERTY = 'clonedFrom';
243
321
  //# sourceMappingURL=gltfExportManager.js.map