@combeenation/3d-viewer 7.0.0 → 7.1.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 (105) 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 +670 -670
  8. package/dist/lib-cjs/api/classes/event.d.ts +396 -396
  9. package/dist/lib-cjs/api/classes/event.js +419 -419
  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 +517 -517
  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 +843 -843
  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 +88 -88
  28. package/dist/lib-cjs/api/classes/viewer.d.ts +199 -200
  29. package/dist/lib-cjs/api/classes/viewer.js +670 -671
  30. package/dist/lib-cjs/api/classes/viewer.js.map +1 -1
  31. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
  32. package/dist/lib-cjs/api/classes/viewerLight.js +348 -348
  33. package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
  34. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  35. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
  36. package/dist/lib-cjs/api/internal/sceneSetup.js +226 -226
  37. package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
  38. package/dist/lib-cjs/api/manager/animationManager.js +126 -126
  39. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +78 -78
  40. package/dist/lib-cjs/api/manager/gltfExportManager.js +241 -241
  41. package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
  42. package/dist/lib-cjs/api/manager/sceneManager.js +130 -130
  43. package/dist/lib-cjs/api/manager/tagManager.d.ts +108 -108
  44. package/dist/lib-cjs/api/manager/tagManager.js +419 -419
  45. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
  46. package/dist/lib-cjs/api/manager/textureLoadManager.js +97 -97
  47. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +102 -103
  48. package/dist/lib-cjs/api/manager/variantInstanceManager.js +284 -285
  49. package/dist/lib-cjs/api/manager/variantInstanceManager.js.map +1 -1
  50. package/dist/lib-cjs/api/store/specStorage.d.ts +32 -32
  51. package/dist/lib-cjs/api/store/specStorage.js +65 -65
  52. package/dist/lib-cjs/api/util/babylonHelper.d.ts +235 -235
  53. package/dist/lib-cjs/api/util/babylonHelper.js +753 -750
  54. package/dist/lib-cjs/api/util/babylonHelper.js.map +1 -1
  55. package/dist/lib-cjs/api/util/globalTypes.d.ts +436 -436
  56. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  57. package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
  58. package/dist/lib-cjs/api/util/resourceHelper.js +203 -203
  59. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +44 -44
  60. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +175 -173
  61. package/dist/lib-cjs/api/util/sceneLoaderHelper.js.map +1 -1
  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 +48 -48
  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 +53 -53
  69. package/dist/lib-cjs/index.js +114 -114
  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 +731 -731
  74. package/src/api/classes/event.ts +452 -452
  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 +554 -554
  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 +933 -933
  82. package/src/api/classes/variantInstance.ts +123 -123
  83. package/src/api/classes/variantParameterizable.ts +85 -85
  84. package/src/api/classes/viewer.ts +743 -744
  85. package/src/api/classes/viewerLight.ts +339 -339
  86. package/src/api/internal/debugViewer.ts +90 -90
  87. package/src/api/internal/lensRendering.ts +9 -9
  88. package/src/api/internal/sceneSetup.ts +205 -205
  89. package/src/api/manager/animationManager.ts +143 -143
  90. package/src/api/manager/gltfExportManager.ts +236 -236
  91. package/src/api/manager/sceneManager.ts +136 -136
  92. package/src/api/manager/tagManager.ts +451 -451
  93. package/src/api/manager/textureLoadManager.ts +95 -95
  94. package/src/api/manager/variantInstanceManager.ts +297 -298
  95. package/src/api/store/specStorage.ts +68 -68
  96. package/src/api/util/babylonHelper.ts +823 -822
  97. package/src/api/util/globalTypes.ts +503 -503
  98. package/src/api/util/resourceHelper.ts +191 -191
  99. package/src/api/util/sceneLoaderHelper.ts +170 -170
  100. package/src/api/util/stringHelper.ts +30 -30
  101. package/src/api/util/structureHelper.ts +49 -49
  102. package/src/buildinfo.json +3 -3
  103. package/src/dev.ts +62 -62
  104. package/src/index.ts +100 -100
  105. package/src/types.d.ts +38 -35
@@ -1,242 +1,242 @@
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 babylonHelper_1 = require("../util/babylonHelper");
25
- const structureHelper_1 = require("../util/structureHelper");
26
- const pbrMaterial_1 = require("@babylonjs/core/Materials/PBR/pbrMaterial");
27
- const math_color_1 = require("@babylonjs/core/Maths/math.color");
28
- const abstractMesh_1 = require("@babylonjs/core/Meshes/abstractMesh");
29
- const mesh_1 = require("@babylonjs/core/Meshes/mesh");
30
- const _2_0_1 = require("@babylonjs/serializers/glTF/2.0");
31
- const lodash_es_1 = require("lodash-es");
32
- class GltfExportManager {
33
- /**
34
- * Constructor.
35
- */
36
- constructor(viewer) {
37
- this.viewer = viewer;
38
- }
39
- /**
40
- * Creates an {@link GltfExportManager}.
41
- */
42
- static create(viewer) {
43
- return __awaiter(this, void 0, void 0, function* () {
44
- return new GltfExportManager(viewer);
45
- });
46
- }
47
- /**
48
- * Exports selected nodes to a file.
49
- * @param filename optional name of the exported .GLB file.
50
- * @param exportOptions export options to be merged with default options.\
51
- * `exportOptions.createUniqueMeshNames` defaults to `true` if not given.
52
- * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
53
- */
54
- exportGlb(filename = 'glb-export.glb', _a = {}, excluded) {
55
- var { createUniqueMeshNames = true } = _a, exportOptionsRest = __rest(_a, ["createUniqueMeshNames"]);
56
- return __awaiter(this, void 0, void 0, function* () {
57
- const exportOptions = Object.assign({ createUniqueMeshNames }, exportOptionsRest);
58
- this.exportPreProcess(exportOptions);
59
- const glbData = yield _2_0_1.GLTF2Export.GLBAsync(this.viewer.scene, 'dummy', this.gltfExportOptions(exportOptions, excluded));
60
- this.exportPostProcess();
61
- const resBlob = glbData.glTFFiles['dummy.glb']; // should be only one file for glb
62
- // check if result is valid, according to the typings this could also be a string
63
- if (resBlob instanceof Blob) {
64
- if (!filename.endsWith('.glb')) {
65
- filename += '.glb';
66
- }
67
- return new File([resBlob], filename);
68
- }
69
- else {
70
- // result was not a valid blob
71
- return undefined;
72
- }
73
- });
74
- }
75
- /**
76
- * Exports selected nodes to GLTF. This may result in more than one file, since textures are exported separately.
77
- * @param filename name of the main (text-based) .GLTF file referring to separate texture files.
78
- * @param exportOptions export options to be merged with default options.\
79
- * `exportOptions.createUniqueMeshNames` defaults to `true` if not given.
80
- * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
81
- */
82
- exportGltfToFile(filename, _a = {}, excluded) {
83
- var { createUniqueMeshNames = true } = _a, exportOptionsRest = __rest(_a, ["createUniqueMeshNames"]);
84
- return __awaiter(this, void 0, void 0, function* () {
85
- const exportOptions = Object.assign({ createUniqueMeshNames }, exportOptionsRest);
86
- this.exportPreProcess(exportOptions);
87
- yield _2_0_1.GLTF2Export.GLTFAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(glb => {
88
- glb.downloadFiles();
89
- });
90
- this.exportPostProcess();
91
- });
92
- }
93
- /**
94
- * Exports selected nodes to GLB. This results in one binary file.
95
- * @param filename name of the .GLB file.
96
- * @param exportOptions export options to be merged with default options.\
97
- * `exportOptions.createUniqueMeshNames` defaults to `true` if not given.
98
- * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
99
- */
100
- exportGlbToFile(filename, _a = {}, excluded) {
101
- var { createUniqueMeshNames = true } = _a, exportOptionsRest = __rest(_a, ["createUniqueMeshNames"]);
102
- return __awaiter(this, void 0, void 0, function* () {
103
- const exportOptions = Object.assign({ createUniqueMeshNames }, exportOptionsRest);
104
- this.exportPreProcess(exportOptions);
105
- yield _2_0_1.GLTF2Export.GLBAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(glb => {
106
- glb.downloadFiles();
107
- });
108
- this.exportPostProcess();
109
- });
110
- }
111
- /**
112
- * Gets predefined {@link IExportOptionsExtended } merged with given ones.
113
- */
114
- gltfExportOptions(mergeWithOptions = {}, excluded) {
115
- const defaultOptions = {
116
- // includeCoordinateSystemConversionNodes: true,
117
- shouldExportNode: function (node) {
118
- if (!node.isEnabled()) {
119
- return false;
120
- }
121
- if (node.name.startsWith('__bounding_box__')) {
122
- return false;
123
- }
124
- if (excluded && node instanceof mesh_1.Mesh && (0, structureHelper_1.isMeshIncludedInExclusionList)(node, excluded)) {
125
- return false;
126
- }
127
- return true;
128
- },
129
- };
130
- return (0, lodash_es_1.merge)({}, defaultOptions, mergeWithOptions);
131
- }
132
- /**
133
- * Stuff to be done before exporting to GLTF
134
- */
135
- exportPreProcess({ createUniqueMeshNames = true }) {
136
- this.viewer.pauseRendering();
137
- if (createUniqueMeshNames !== null && createUniqueMeshNames !== void 0 ? createUniqueMeshNames : true) {
138
- this.setUniqueMeshNames();
139
- }
140
- this.exchangeRefractionMaterials();
141
- }
142
- /**
143
- * Stuff to be done after the GLTF export
144
- */
145
- exportPostProcess() {
146
- this.restoreRefractionMaterials();
147
- this.restoreOriginalMeshNames();
148
- this.viewer.resumeRendering();
149
- }
150
- /**
151
- * Materials with refraction set are not exported properly.
152
- * Exchange all such (relevant) materials with a more export-friendly version
153
- */
154
- exchangeRefractionMaterials() {
155
- for (const n of this.viewer.scene.getNodes()) {
156
- if (!(n instanceof abstractMesh_1.AbstractMesh))
157
- continue;
158
- if (!(n.material instanceof pbrMaterial_1.PBRMaterial))
159
- continue;
160
- if (!n.material.subSurface.isRefractionEnabled)
161
- continue;
162
- if (n.material.transparencyMode !== pbrMaterial_1.PBRMaterial.PBRMATERIAL_OPAQUE)
163
- continue;
164
- // if we're here, we have a node holding a material with set refraction whose transparencyMode is set to
165
- // PBRMATERIAL_OPAQUE
166
- n.material = this.createRefractionMaterialReplacement(n.material);
167
- }
168
- }
169
- /**
170
- * Restore original materials with set refraction.
171
- */
172
- restoreRefractionMaterials() {
173
- for (const n of this.viewer.scene.getNodes()) {
174
- if (!(n instanceof abstractMesh_1.AbstractMesh))
175
- continue;
176
- if (!(n.material instanceof pbrMaterial_1.PBRMaterial))
177
- continue;
178
- if (!this.isMaterialClonedForExport(n.material))
179
- continue;
180
- // at this point we have a pbrmaterial tagged as cloned in its metadata that's set on a mesh
181
- // restore and dispose
182
- const currMaterial = n.material;
183
- const prevMaterial = this.viewer.scene.getMaterialByUniqueID(n.material.metadata.clonedFrom);
184
- if (prevMaterial) {
185
- n.material = prevMaterial; // restore previous material
186
- currMaterial.dispose(false, true); // dispose of clone
187
- }
188
- }
189
- }
190
- /**
191
- * Create an export-friendly replacement material for a material using refraction.
192
- * @param mat Material to be replaced
193
- */
194
- createRefractionMaterialReplacement(mat) {
195
- // if we're dealing with a clone already, return it instead of cloning
196
- if (this.isMaterialClonedForExport(mat))
197
- return mat;
198
- // change material according to https://www.notion.so/combeenation/Glas-materials-don-t-look-glasy-after-export-d5fda2c6515e4420a8772744d3e6b460
199
- const clonedMaterial = mat.clone(mat.name); // clone material. clone uses same name
200
- 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
201
- clonedMaterial.refractionTexture = null;
202
- clonedMaterial.metallicReflectanceTexture = null; // is this the correct one for metallic roughness?
203
- clonedMaterial.alpha = 0.7;
204
- clonedMaterial.albedoColor = new math_color_1.Color3(0.3, 0.3, 0.3);
205
- clonedMaterial.transparencyMode = pbrMaterial_1.PBRMaterial.PBRMATERIAL_ALPHABLEND;
206
- clonedMaterial.metallic = 0.65;
207
- clonedMaterial.roughness = 0.15;
208
- return clonedMaterial;
209
- }
210
- /**
211
- * Inspect if a material was temporarily cloned for GLB export
212
- * @param mat Material to be inspected
213
- */
214
- isMaterialClonedForExport(mat) {
215
- var _a;
216
- return !!((_a = mat.metadata) === null || _a === void 0 ? void 0 : _a.clonedFrom);
217
- }
218
- /**
219
- * Set unique mesh names for GLB export
220
- */
221
- setUniqueMeshNames() {
222
- this.viewer.scene.meshes.forEach(currMesh => {
223
- (0, babylonHelper_1.injectNodeMetadata)(currMesh, { [GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY]: currMesh.name }, false);
224
- currMesh.name = `${currMesh.name}_${currMesh.uniqueId}`;
225
- });
226
- }
227
- /**
228
- * Restore original mesh names for meshes that were
229
- * renamed with {@link setUniqueMeshNames()}
230
- */
231
- restoreOriginalMeshNames() {
232
- this.viewer.scene.meshes.forEach(currMesh => {
233
- if ((0, lodash_es_1.has)(currMesh.metadata, GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY)) {
234
- currMesh.name = currMesh.metadata[GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY];
235
- delete currMesh.metadata[GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY];
236
- }
237
- });
238
- }
239
- }
240
- exports.GltfExportManager = GltfExportManager;
241
- GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY = 'originalName';
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 babylonHelper_1 = require("../util/babylonHelper");
25
+ const structureHelper_1 = require("../util/structureHelper");
26
+ const pbrMaterial_1 = require("@babylonjs/core/Materials/PBR/pbrMaterial");
27
+ const math_color_1 = require("@babylonjs/core/Maths/math.color");
28
+ const abstractMesh_1 = require("@babylonjs/core/Meshes/abstractMesh");
29
+ const mesh_1 = require("@babylonjs/core/Meshes/mesh");
30
+ const _2_0_1 = require("@babylonjs/serializers/glTF/2.0");
31
+ const lodash_es_1 = require("lodash-es");
32
+ class GltfExportManager {
33
+ /**
34
+ * Constructor.
35
+ */
36
+ constructor(viewer) {
37
+ this.viewer = viewer;
38
+ }
39
+ /**
40
+ * Creates an {@link GltfExportManager}.
41
+ */
42
+ static create(viewer) {
43
+ return __awaiter(this, void 0, void 0, function* () {
44
+ return new GltfExportManager(viewer);
45
+ });
46
+ }
47
+ /**
48
+ * Exports selected nodes to a file.
49
+ * @param filename optional name of the exported .GLB file.
50
+ * @param exportOptions export options to be merged with default options.\
51
+ * `exportOptions.createUniqueMeshNames` defaults to `true` if not given.
52
+ * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
53
+ */
54
+ exportGlb(filename = 'glb-export.glb', _a = {}, excluded) {
55
+ var { createUniqueMeshNames = true } = _a, exportOptionsRest = __rest(_a, ["createUniqueMeshNames"]);
56
+ return __awaiter(this, void 0, void 0, function* () {
57
+ const exportOptions = Object.assign({ createUniqueMeshNames }, exportOptionsRest);
58
+ this.exportPreProcess(exportOptions);
59
+ const glbData = yield _2_0_1.GLTF2Export.GLBAsync(this.viewer.scene, 'dummy', this.gltfExportOptions(exportOptions, excluded));
60
+ this.exportPostProcess();
61
+ const resBlob = glbData.glTFFiles['dummy.glb']; // should be only one file for glb
62
+ // check if result is valid, according to the typings this could also be a string
63
+ if (resBlob instanceof Blob) {
64
+ if (!filename.endsWith('.glb')) {
65
+ filename += '.glb';
66
+ }
67
+ return new File([resBlob], filename);
68
+ }
69
+ else {
70
+ // result was not a valid blob
71
+ return undefined;
72
+ }
73
+ });
74
+ }
75
+ /**
76
+ * Exports selected nodes to GLTF. This may result in more than one file, since textures are exported separately.
77
+ * @param filename name of the main (text-based) .GLTF file referring to separate texture files.
78
+ * @param exportOptions export options to be merged with default options.\
79
+ * `exportOptions.createUniqueMeshNames` defaults to `true` if not given.
80
+ * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
81
+ */
82
+ exportGltfToFile(filename, _a = {}, excluded) {
83
+ var { createUniqueMeshNames = true } = _a, exportOptionsRest = __rest(_a, ["createUniqueMeshNames"]);
84
+ return __awaiter(this, void 0, void 0, function* () {
85
+ const exportOptions = Object.assign({ createUniqueMeshNames }, exportOptionsRest);
86
+ this.exportPreProcess(exportOptions);
87
+ yield _2_0_1.GLTF2Export.GLTFAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(glb => {
88
+ glb.downloadFiles();
89
+ });
90
+ this.exportPostProcess();
91
+ });
92
+ }
93
+ /**
94
+ * Exports selected nodes to GLB. This results in one binary file.
95
+ * @param filename name of the .GLB file.
96
+ * @param exportOptions export options to be merged with default options.\
97
+ * `exportOptions.createUniqueMeshNames` defaults to `true` if not given.
98
+ * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
99
+ */
100
+ exportGlbToFile(filename, _a = {}, excluded) {
101
+ var { createUniqueMeshNames = true } = _a, exportOptionsRest = __rest(_a, ["createUniqueMeshNames"]);
102
+ return __awaiter(this, void 0, void 0, function* () {
103
+ const exportOptions = Object.assign({ createUniqueMeshNames }, exportOptionsRest);
104
+ this.exportPreProcess(exportOptions);
105
+ yield _2_0_1.GLTF2Export.GLBAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(glb => {
106
+ glb.downloadFiles();
107
+ });
108
+ this.exportPostProcess();
109
+ });
110
+ }
111
+ /**
112
+ * Gets predefined {@link IExportOptionsExtended } merged with given ones.
113
+ */
114
+ gltfExportOptions(mergeWithOptions = {}, excluded) {
115
+ const defaultOptions = {
116
+ // includeCoordinateSystemConversionNodes: true,
117
+ shouldExportNode: function (node) {
118
+ if (!node.isEnabled()) {
119
+ return false;
120
+ }
121
+ if (node.name.startsWith('__bounding_box__')) {
122
+ return false;
123
+ }
124
+ if (excluded && node instanceof mesh_1.Mesh && (0, structureHelper_1.isMeshIncludedInExclusionList)(node, excluded)) {
125
+ return false;
126
+ }
127
+ return true;
128
+ },
129
+ };
130
+ return (0, lodash_es_1.merge)({}, defaultOptions, mergeWithOptions);
131
+ }
132
+ /**
133
+ * Stuff to be done before exporting to GLTF
134
+ */
135
+ exportPreProcess({ createUniqueMeshNames = true }) {
136
+ this.viewer.pauseRendering();
137
+ if (createUniqueMeshNames !== null && createUniqueMeshNames !== void 0 ? createUniqueMeshNames : true) {
138
+ this.setUniqueMeshNames();
139
+ }
140
+ this.exchangeRefractionMaterials();
141
+ }
142
+ /**
143
+ * Stuff to be done after the GLTF export
144
+ */
145
+ exportPostProcess() {
146
+ this.restoreRefractionMaterials();
147
+ this.restoreOriginalMeshNames();
148
+ this.viewer.resumeRendering();
149
+ }
150
+ /**
151
+ * Materials with refraction set are not exported properly.
152
+ * Exchange all such (relevant) materials with a more export-friendly version
153
+ */
154
+ exchangeRefractionMaterials() {
155
+ for (const n of this.viewer.scene.getNodes()) {
156
+ if (!(n instanceof abstractMesh_1.AbstractMesh))
157
+ continue;
158
+ if (!(n.material instanceof pbrMaterial_1.PBRMaterial))
159
+ continue;
160
+ if (!n.material.subSurface.isRefractionEnabled)
161
+ continue;
162
+ if (n.material.transparencyMode !== pbrMaterial_1.PBRMaterial.PBRMATERIAL_OPAQUE)
163
+ continue;
164
+ // if we're here, we have a node holding a material with set refraction whose transparencyMode is set to
165
+ // PBRMATERIAL_OPAQUE
166
+ n.material = this.createRefractionMaterialReplacement(n.material);
167
+ }
168
+ }
169
+ /**
170
+ * Restore original materials with set refraction.
171
+ */
172
+ restoreRefractionMaterials() {
173
+ for (const n of this.viewer.scene.getNodes()) {
174
+ if (!(n instanceof abstractMesh_1.AbstractMesh))
175
+ continue;
176
+ if (!(n.material instanceof pbrMaterial_1.PBRMaterial))
177
+ continue;
178
+ if (!this.isMaterialClonedForExport(n.material))
179
+ continue;
180
+ // at this point we have a pbrmaterial tagged as cloned in its metadata that's set on a mesh
181
+ // restore and dispose
182
+ const currMaterial = n.material;
183
+ const prevMaterial = this.viewer.scene.getMaterialByUniqueID(n.material.metadata.clonedFrom);
184
+ if (prevMaterial) {
185
+ n.material = prevMaterial; // restore previous material
186
+ currMaterial.dispose(false, true); // dispose of clone
187
+ }
188
+ }
189
+ }
190
+ /**
191
+ * Create an export-friendly replacement material for a material using refraction.
192
+ * @param mat Material to be replaced
193
+ */
194
+ createRefractionMaterialReplacement(mat) {
195
+ // if we're dealing with a clone already, return it instead of cloning
196
+ if (this.isMaterialClonedForExport(mat))
197
+ return mat;
198
+ // change material according to https://www.notion.so/combeenation/Glas-materials-don-t-look-glasy-after-export-d5fda2c6515e4420a8772744d3e6b460
199
+ const clonedMaterial = mat.clone(mat.name); // clone material. clone uses same name
200
+ 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
201
+ clonedMaterial.refractionTexture = null;
202
+ clonedMaterial.metallicReflectanceTexture = null; // is this the correct one for metallic roughness?
203
+ clonedMaterial.alpha = 0.7;
204
+ clonedMaterial.albedoColor = new math_color_1.Color3(0.3, 0.3, 0.3);
205
+ clonedMaterial.transparencyMode = pbrMaterial_1.PBRMaterial.PBRMATERIAL_ALPHABLEND;
206
+ clonedMaterial.metallic = 0.65;
207
+ clonedMaterial.roughness = 0.15;
208
+ return clonedMaterial;
209
+ }
210
+ /**
211
+ * Inspect if a material was temporarily cloned for GLB export
212
+ * @param mat Material to be inspected
213
+ */
214
+ isMaterialClonedForExport(mat) {
215
+ var _a;
216
+ return !!((_a = mat.metadata) === null || _a === void 0 ? void 0 : _a.clonedFrom);
217
+ }
218
+ /**
219
+ * Set unique mesh names for GLB export
220
+ */
221
+ setUniqueMeshNames() {
222
+ this.viewer.scene.meshes.forEach(currMesh => {
223
+ (0, babylonHelper_1.injectNodeMetadata)(currMesh, { [GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY]: currMesh.name }, false);
224
+ currMesh.name = `${currMesh.name}_${currMesh.uniqueId}`;
225
+ });
226
+ }
227
+ /**
228
+ * Restore original mesh names for meshes that were
229
+ * renamed with {@link setUniqueMeshNames()}
230
+ */
231
+ restoreOriginalMeshNames() {
232
+ this.viewer.scene.meshes.forEach(currMesh => {
233
+ if ((0, lodash_es_1.has)(currMesh.metadata, GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY)) {
234
+ currMesh.name = currMesh.metadata[GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY];
235
+ delete currMesh.metadata[GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY];
236
+ }
237
+ });
238
+ }
239
+ }
240
+ exports.GltfExportManager = GltfExportManager;
241
+ GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY = 'originalName';
242
242
  //# sourceMappingURL=gltfExportManager.js.map
@@ -1,33 +1,33 @@
1
- import { ParameterObservable } from '../classes/parameterObservable';
2
- import { TextureLoadManager } from './textureLoadManager';
3
- import { Camera } from '@babylonjs/core/Cameras/camera';
4
- import { Scene as BabylonScene } from '@babylonjs/core/scene';
5
- export declare class SceneManager extends ParameterObservable {
6
- scene: BabylonScene;
7
- protected readonly _parameterObservers: Map<string, ParameterObserver[]>;
8
- protected _textureLoadManager: TextureLoadManager | null;
9
- /**
10
- * Constructor.
11
- */
12
- protected constructor(scene: BabylonScene);
13
- /**
14
- * Creates a {@link SceneManager} based on given Babylon.js scene.
15
- */
16
- static create(scene: BabylonScene): Promise<SceneManager>;
17
- /**
18
- * The active `Camera`.
19
- */
20
- get activeCamera(): Camera;
21
- /**
22
- * Places the given {@link ParameterBag} in the {@link SceneManager}'s parameters, replaces all patterns in the
23
- * {@link StructureJson} and broadcasts all {@link ParameterObserver}s.
24
- *
25
- * @emit {@link Event.SCENE_PARAMETER_COMMITTED}
26
- */
27
- commitParameters(parameters?: ParameterBag): Promise<SceneManager>;
28
- protected addParameterObservers(): SceneManager;
29
- /**
30
- * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
31
- */
32
- protected bootstrapParameters(parameters?: ParameterBag): Promise<SceneManager>;
33
- }
1
+ import { ParameterObservable } from '../classes/parameterObservable';
2
+ import { TextureLoadManager } from './textureLoadManager';
3
+ import { Camera } from '@babylonjs/core/Cameras/camera';
4
+ import { Scene as BabylonScene } from '@babylonjs/core/scene';
5
+ export declare class SceneManager extends ParameterObservable {
6
+ scene: BabylonScene;
7
+ protected readonly _parameterObservers: Map<string, ParameterObserver[]>;
8
+ protected _textureLoadManager: TextureLoadManager | null;
9
+ /**
10
+ * Constructor.
11
+ */
12
+ protected constructor(scene: BabylonScene);
13
+ /**
14
+ * Creates a {@link SceneManager} based on given Babylon.js scene.
15
+ */
16
+ static create(scene: BabylonScene): Promise<SceneManager>;
17
+ /**
18
+ * The active `Camera`.
19
+ */
20
+ get activeCamera(): Camera;
21
+ /**
22
+ * Places the given {@link ParameterBag} in the {@link SceneManager}'s parameters, replaces all patterns in the
23
+ * {@link StructureJson} and broadcasts all {@link ParameterObserver}s.
24
+ *
25
+ * @emit {@link Event.SCENE_PARAMETER_COMMITTED}
26
+ */
27
+ commitParameters(parameters?: ParameterBag): Promise<SceneManager>;
28
+ protected addParameterObservers(): SceneManager;
29
+ /**
30
+ * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
31
+ */
32
+ protected bootstrapParameters(parameters?: ParameterBag): Promise<SceneManager>;
33
+ }