@combeenation/3d-viewer 9.0.1 → 9.0.2-alpha2
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.
- package/README.md +111 -111
- package/dist/lib-cjs/api/classes/animationInterface.d.ts +8 -8
- package/dist/lib-cjs/api/classes/animationInterface.js +2 -2
- package/dist/lib-cjs/api/classes/dottedPath.d.ts +79 -79
- package/dist/lib-cjs/api/classes/dottedPath.js +166 -166
- package/dist/lib-cjs/api/classes/element.d.ts +153 -153
- package/dist/lib-cjs/api/classes/element.js +667 -667
- package/dist/lib-cjs/api/classes/event.d.ts +401 -401
- package/dist/lib-cjs/api/classes/event.js +424 -424
- package/dist/lib-cjs/api/classes/eventBroadcaster.d.ts +26 -26
- package/dist/lib-cjs/api/classes/eventBroadcaster.js +49 -49
- package/dist/lib-cjs/api/classes/fuzzyMap.d.ts +7 -7
- package/dist/lib-cjs/api/classes/fuzzyMap.js +21 -21
- package/dist/lib-cjs/api/classes/parameter.d.ts +410 -410
- package/dist/lib-cjs/api/classes/parameter.js +642 -642
- package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
- package/dist/lib-cjs/api/classes/parameterObservable.js +72 -72
- package/dist/lib-cjs/api/classes/parameterizable.d.ts +15 -15
- package/dist/lib-cjs/api/classes/parameterizable.js +102 -102
- package/dist/lib-cjs/api/classes/placementAnimation.d.ts +45 -45
- package/dist/lib-cjs/api/classes/placementAnimation.js +176 -176
- package/dist/lib-cjs/api/classes/variant.d.ts +261 -261
- package/dist/lib-cjs/api/classes/variant.js +870 -870
- package/dist/lib-cjs/api/classes/variantInstance.d.ts +53 -53
- package/dist/lib-cjs/api/classes/variantInstance.js +125 -125
- package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +17 -17
- package/dist/lib-cjs/api/classes/variantParameterizable.js +86 -86
- package/dist/lib-cjs/api/classes/viewer.d.ts +213 -213
- package/dist/lib-cjs/api/classes/viewer.js +717 -717
- package/dist/lib-cjs/api/classes/viewerError.d.ts +43 -43
- package/dist/lib-cjs/api/classes/viewerError.js +55 -55
- package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
- package/dist/lib-cjs/api/classes/viewerLight.js +348 -348
- package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
- package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
- package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
- package/dist/lib-cjs/api/internal/sceneSetup.js +226 -226
- package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
- package/dist/lib-cjs/api/manager/animationManager.js +126 -126
- package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +103 -103
- package/dist/lib-cjs/api/manager/gltfExportManager.js +331 -325
- package/dist/lib-cjs/api/manager/gltfExportManager.js.map +1 -1
- package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
- package/dist/lib-cjs/api/manager/sceneManager.js +128 -128
- package/dist/lib-cjs/api/manager/tagManager.d.ts +118 -118
- package/dist/lib-cjs/api/manager/tagManager.js +535 -522
- package/dist/lib-cjs/api/manager/tagManager.js.map +1 -1
- package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
- package/dist/lib-cjs/api/manager/textureLoadManager.js +97 -97
- package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +106 -106
- package/dist/lib-cjs/api/manager/variantInstanceManager.js +290 -290
- package/dist/lib-cjs/api/store/specStorage.d.ts +32 -32
- package/dist/lib-cjs/api/store/specStorage.js +65 -65
- package/dist/lib-cjs/api/util/babylonHelper.d.ts +237 -237
- package/dist/lib-cjs/api/util/babylonHelper.js +825 -825
- package/dist/lib-cjs/api/util/globalTypes.d.ts +479 -479
- package/dist/lib-cjs/api/util/globalTypes.js +1 -1
- package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
- package/dist/lib-cjs/api/util/resourceHelper.js +214 -211
- package/dist/lib-cjs/api/util/resourceHelper.js.map +1 -1
- package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +44 -44
- package/dist/lib-cjs/api/util/sceneLoaderHelper.js +175 -175
- package/dist/lib-cjs/api/util/stringHelper.d.ts +13 -13
- package/dist/lib-cjs/api/util/stringHelper.js +32 -32
- package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
- package/dist/lib-cjs/api/util/structureHelper.js +60 -60
- package/dist/lib-cjs/buildinfo.json +3 -3
- package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
- package/dist/lib-cjs/index.d.ts +54 -54
- package/dist/lib-cjs/index.js +117 -117
- package/package.json +82 -82
- package/src/api/classes/animationInterface.ts +10 -10
- package/src/api/classes/dottedPath.ts +181 -181
- package/src/api/classes/element.ts +723 -723
- package/src/api/classes/event.ts +457 -457
- package/src/api/classes/eventBroadcaster.ts +52 -52
- package/src/api/classes/fuzzyMap.ts +21 -21
- package/src/api/classes/parameter.ts +686 -686
- package/src/api/classes/parameterObservable.ts +73 -73
- package/src/api/classes/parameterizable.ts +87 -87
- package/src/api/classes/placementAnimation.ts +162 -162
- package/src/api/classes/variant.ts +963 -963
- package/src/api/classes/variantInstance.ts +123 -123
- package/src/api/classes/variantParameterizable.ts +83 -83
- package/src/api/classes/viewer.ts +770 -770
- package/src/api/classes/viewerError.ts +63 -63
- package/src/api/classes/viewerLight.ts +339 -339
- package/src/api/internal/debugViewer.ts +90 -90
- package/src/api/internal/lensRendering.ts +9 -9
- package/src/api/internal/sceneSetup.ts +205 -205
- package/src/api/manager/animationManager.ts +143 -143
- package/src/api/manager/gltfExportManager.ts +310 -302
- package/src/api/manager/sceneManager.ts +134 -134
- package/src/api/manager/tagManager.ts +576 -564
- package/src/api/manager/textureLoadManager.ts +95 -95
- package/src/api/manager/variantInstanceManager.ts +306 -306
- package/src/api/store/specStorage.ts +68 -68
- package/src/api/util/babylonHelper.ts +913 -913
- package/src/api/util/globalTypes.ts +555 -555
- package/src/api/util/resourceHelper.ts +201 -198
- package/src/api/util/sceneLoaderHelper.ts +170 -170
- package/src/api/util/stringHelper.ts +30 -30
- package/src/api/util/structureHelper.ts +60 -60
- package/src/buildinfo.json +3 -3
- package/src/dev.ts +62 -62
- package/src/index.ts +103 -103
- package/src/types.d.ts +38 -38
|
@@ -1,302 +1,310 @@
|
|
|
1
|
-
import { Viewer } from '../classes/viewer';
|
|
2
|
-
import { injectMetadata } from '../util/babylonHelper';
|
|
3
|
-
import { isNodeIncludedInExclusionList } from '../util/structureHelper';
|
|
4
|
-
import { Engine } from '@babylonjs/core/Engines/engine';
|
|
5
|
-
import { SceneLoader } from '@babylonjs/core/Loading/sceneLoader';
|
|
6
|
-
import { PBRMaterial } from '@babylonjs/core/Materials/PBR/pbrMaterial';
|
|
7
|
-
import { Color3 } from '@babylonjs/core/Maths/math.color';
|
|
8
|
-
import { Vector3 } from '@babylonjs/core/Maths/math.vector';
|
|
9
|
-
import { AbstractMesh } from '@babylonjs/core/Meshes/abstractMesh';
|
|
10
|
-
import { Mesh } from '@babylonjs/core/Meshes/mesh';
|
|
11
|
-
import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
|
|
12
|
-
import { SceneSerializer } from '@babylonjs/core/Misc/sceneSerializer';
|
|
13
|
-
import { GLTF2Export, IExportOptions } from '@babylonjs/serializers/glTF/2.0';
|
|
14
|
-
import { has, merge } from 'lodash-es';
|
|
15
|
-
|
|
16
|
-
type MetadataMap = { [key: string]: any };
|
|
17
|
-
export class GltfExportManager {
|
|
18
|
-
protected static readonly _CLONED_FROM_MAT_METADATA_PROPERTY = 'clonedFrom';
|
|
19
|
-
public static readonly NAME_BEFORE_EXPORT_METADATA_PROPERTY = 'nameBeforeExport';
|
|
20
|
-
|
|
21
|
-
/**
|
|
22
|
-
* Constructor.
|
|
23
|
-
*/
|
|
24
|
-
protected constructor(protected viewer: Viewer) {}
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
* Creates an {@link GltfExportManager}.
|
|
28
|
-
*/
|
|
29
|
-
public static async create(viewer: Viewer): Promise<GltfExportManager> {
|
|
30
|
-
return new GltfExportManager(viewer);
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
/**
|
|
34
|
-
* Exports selected nodes to a file.
|
|
35
|
-
* @param filename optional name of the exported .GLB file.
|
|
36
|
-
* @param exportOptions export options to be merged with default options.\
|
|
37
|
-
* `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
|
|
38
|
-
* @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
|
|
39
|
-
* @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
|
|
40
|
-
*/
|
|
41
|
-
public async exportGlb(
|
|
42
|
-
filename = 'glb-export.glb',
|
|
43
|
-
{ exchangeRefractionMaterials = true, ...exportOptions }: IExportOptionsExtended = {},
|
|
44
|
-
optimizeForAR: boolean = false,
|
|
45
|
-
excluded?: ExcludedGeometryList
|
|
46
|
-
): Promise<File | undefined> {
|
|
47
|
-
const { scene, sceneCopied } = await this.exportPreProcess(exchangeRefractionMaterials, optimizeForAR);
|
|
48
|
-
const glbData = await GLTF2Export.GLBAsync(scene, 'dummy', this.gltfExportOptions(exportOptions, excluded));
|
|
49
|
-
this.exportPostProcess(scene, sceneCopied);
|
|
50
|
-
|
|
51
|
-
const resBlob = glbData.glTFFiles['dummy.glb'];
|
|
52
|
-
// check if result is valid, according to the typings this could also be a string
|
|
53
|
-
if (resBlob instanceof Blob) {
|
|
54
|
-
if (!filename.endsWith('.glb')) {
|
|
55
|
-
filename += '.glb';
|
|
56
|
-
}
|
|
57
|
-
return new File([resBlob], filename);
|
|
58
|
-
} else {
|
|
59
|
-
// result was not a valid blob
|
|
60
|
-
return undefined;
|
|
61
|
-
}
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
/**
|
|
65
|
-
* Exports selected nodes to GLTF. This may result in more than one file, since textures are exported separately.
|
|
66
|
-
* @param filename name of the main (text-based) .GLTF file referring to separate texture files.
|
|
67
|
-
* @param exportOptions export options to be merged with default options.\
|
|
68
|
-
* `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
|
|
69
|
-
* @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
|
|
70
|
-
* @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
|
|
71
|
-
*/
|
|
72
|
-
public async exportGltfToFile(
|
|
73
|
-
filename: string,
|
|
74
|
-
{ exchangeRefractionMaterials = true, ...exportOptions }: IExportOptionsExtended = {},
|
|
75
|
-
optimizeForAR: boolean = false,
|
|
76
|
-
excluded?: ExcludedGeometryList
|
|
77
|
-
) {
|
|
78
|
-
const { scene, sceneCopied } = await this.exportPreProcess(exchangeRefractionMaterials, optimizeForAR);
|
|
79
|
-
const gltf = await GLTF2Export.GLTFAsync(scene, filename, this.gltfExportOptions(exportOptions, excluded));
|
|
80
|
-
gltf.downloadFiles();
|
|
81
|
-
this.exportPostProcess(scene, sceneCopied);
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
/**
|
|
85
|
-
* Exports selected nodes to GLB. This results in one binary file.
|
|
86
|
-
* @param filename name of the .GLB file.
|
|
87
|
-
* @param exportOptions export options to be merged with default options.\
|
|
88
|
-
* `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
|
|
89
|
-
* @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
|
|
90
|
-
* @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
|
|
91
|
-
*/
|
|
92
|
-
public async exportGlbToFile(
|
|
93
|
-
filename: string,
|
|
94
|
-
{ exchangeRefractionMaterials = true, ...exportOptions }: IExportOptionsExtended = {},
|
|
95
|
-
optimizeForAR: boolean = false,
|
|
96
|
-
excluded?: ExcludedGeometryList
|
|
97
|
-
) {
|
|
98
|
-
const { scene, sceneCopied } = await this.exportPreProcess(exchangeRefractionMaterials, optimizeForAR);
|
|
99
|
-
const glb = await GLTF2Export.GLBAsync(scene, filename, this.gltfExportOptions(exportOptions, excluded));
|
|
100
|
-
glb.downloadFiles();
|
|
101
|
-
this.exportPostProcess(scene, sceneCopied);
|
|
102
|
-
}
|
|
103
|
-
|
|
104
|
-
/**
|
|
105
|
-
* Gets predefined {@link IExportOptions } merged with given ones.
|
|
106
|
-
*/
|
|
107
|
-
protected gltfExportOptions(mergeWithOptions: IExportOptions = {}, excluded?: ExcludedGeometryList): IExportOptions {
|
|
108
|
-
const defaultOptions: IExportOptions = {
|
|
109
|
-
shouldExportNode: function (node: any) {
|
|
110
|
-
if (!node.isEnabled()) {
|
|
111
|
-
return false;
|
|
112
|
-
}
|
|
113
|
-
if ((node.name as string).startsWith(Viewer.BOUNDING_BOX_NAME)) {
|
|
114
|
-
return false;
|
|
115
|
-
}
|
|
116
|
-
if (excluded && node instanceof TransformNode && isNodeIncludedInExclusionList(node, excluded)) {
|
|
117
|
-
return false;
|
|
118
|
-
}
|
|
119
|
-
return true;
|
|
120
|
-
},
|
|
121
|
-
};
|
|
122
|
-
return merge({}, defaultOptions, mergeWithOptions);
|
|
123
|
-
}
|
|
124
|
-
|
|
125
|
-
/**
|
|
126
|
-
* Stuff to be done before exporting to GLTF
|
|
127
|
-
*
|
|
128
|
-
* @returns Either the original scene if no adjustments have been made or a copied scene (which can be disposed after
|
|
129
|
-
* the export) if adjustments have been made
|
|
130
|
-
*/
|
|
131
|
-
protected async exportPreProcess(
|
|
132
|
-
exchangeRefractionMaterials: boolean,
|
|
133
|
-
optimizeForAR: boolean
|
|
134
|
-
): Promise<{ scene: Scene; sceneCopied: boolean }> {
|
|
135
|
-
if (!exchangeRefractionMaterials && !optimizeForAR) {
|
|
136
|
-
// no need to copy the scene if no adjustments have to be made
|
|
137
|
-
return { scene: this.viewer.scene, sceneCopied: false };
|
|
138
|
-
}
|
|
139
|
-
|
|
140
|
-
// copy the scene for the GLB export improvements, so that the original viewer scene remains untouched
|
|
141
|
-
const copiedScene = await this.copyViewerScene();
|
|
142
|
-
|
|
143
|
-
if (exchangeRefractionMaterials) {
|
|
144
|
-
this.exchangeRefractionMaterials(copiedScene);
|
|
145
|
-
}
|
|
146
|
-
|
|
147
|
-
if (optimizeForAR) {
|
|
148
|
-
this.setUniqueMeshNames(copiedScene);
|
|
149
|
-
this.bakeTransformations(copiedScene);
|
|
150
|
-
}
|
|
151
|
-
|
|
152
|
-
return { scene: copiedScene, sceneCopied: true };
|
|
153
|
-
}
|
|
154
|
-
|
|
155
|
-
/**
|
|
156
|
-
* Create a copy of the viewer scene, which can be further processed and optimized for the GLB export.
|
|
157
|
-
* There is no "scene.clone" function, therefore the scene is serialized and loaded again to achieve this result.
|
|
158
|
-
*/
|
|
159
|
-
protected async copyViewerScene(): Promise<Scene> {
|
|
160
|
-
// required by the scene serializer
|
|
161
|
-
await import(/* webpackChunkName: "physicsenginecomponent" */ '@babylonjs/core/Physics/physicsEngineComponent');
|
|
162
|
-
|
|
163
|
-
// copy scene function uses scene serializer, which can't handle "complex" data like classes, function or recursive
|
|
164
|
-
// data structures in metadata
|
|
165
|
-
// it basically does a `JSON.stringify` on the metadata
|
|
166
|
-
// therefore the metadata has to be removed from the nodes before the copy process
|
|
167
|
-
const metadataArr = this.extractMetadataOfAllNodes();
|
|
168
|
-
|
|
169
|
-
// serialize the scene
|
|
170
|
-
const serializedScene = await SceneSerializer.SerializeAsync(this.viewer.scene);
|
|
171
|
-
|
|
172
|
-
// set the cropped metadata back to the viewer scene nodes
|
|
173
|
-
this.restoreMetadataOfAllNodes(metadataArr);
|
|
174
|
-
|
|
175
|
-
// load the scene into an invisible "dummy" canvas
|
|
176
|
-
const offscreenCanvas = new
|
|
177
|
-
const engine = new Engine(offscreenCanvas);
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
newScene
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
clonedMaterial
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
return
|
|
265
|
-
}
|
|
266
|
-
|
|
267
|
-
/**
|
|
268
|
-
*
|
|
269
|
-
*
|
|
270
|
-
*/
|
|
271
|
-
protected
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
1
|
+
import { Viewer } from '../classes/viewer';
|
|
2
|
+
import { injectMetadata } from '../util/babylonHelper';
|
|
3
|
+
import { isNodeIncludedInExclusionList } from '../util/structureHelper';
|
|
4
|
+
import { Engine } from '@babylonjs/core/Engines/engine';
|
|
5
|
+
import { SceneLoader } from '@babylonjs/core/Loading/sceneLoader';
|
|
6
|
+
import { PBRMaterial } from '@babylonjs/core/Materials/PBR/pbrMaterial';
|
|
7
|
+
import { Color3 } from '@babylonjs/core/Maths/math.color';
|
|
8
|
+
import { Vector3 } from '@babylonjs/core/Maths/math.vector';
|
|
9
|
+
import { AbstractMesh } from '@babylonjs/core/Meshes/abstractMesh';
|
|
10
|
+
import { Mesh } from '@babylonjs/core/Meshes/mesh';
|
|
11
|
+
import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
|
|
12
|
+
import { SceneSerializer } from '@babylonjs/core/Misc/sceneSerializer';
|
|
13
|
+
import { GLTF2Export, IExportOptions } from '@babylonjs/serializers/glTF/2.0';
|
|
14
|
+
import { has, merge } from 'lodash-es';
|
|
15
|
+
|
|
16
|
+
type MetadataMap = { [key: string]: any };
|
|
17
|
+
export class GltfExportManager {
|
|
18
|
+
protected static readonly _CLONED_FROM_MAT_METADATA_PROPERTY = 'clonedFrom';
|
|
19
|
+
public static readonly NAME_BEFORE_EXPORT_METADATA_PROPERTY = 'nameBeforeExport';
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Constructor.
|
|
23
|
+
*/
|
|
24
|
+
protected constructor(protected viewer: Viewer) {}
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Creates an {@link GltfExportManager}.
|
|
28
|
+
*/
|
|
29
|
+
public static async create(viewer: Viewer): Promise<GltfExportManager> {
|
|
30
|
+
return new GltfExportManager(viewer);
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Exports selected nodes to a file.
|
|
35
|
+
* @param filename optional name of the exported .GLB file.
|
|
36
|
+
* @param exportOptions export options to be merged with default options.\
|
|
37
|
+
* `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
|
|
38
|
+
* @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
|
|
39
|
+
* @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
|
|
40
|
+
*/
|
|
41
|
+
public async exportGlb(
|
|
42
|
+
filename = 'glb-export.glb',
|
|
43
|
+
{ exchangeRefractionMaterials = true, ...exportOptions }: IExportOptionsExtended = {},
|
|
44
|
+
optimizeForAR: boolean = false,
|
|
45
|
+
excluded?: ExcludedGeometryList
|
|
46
|
+
): Promise<File | undefined> {
|
|
47
|
+
const { scene, sceneCopied } = await this.exportPreProcess(exchangeRefractionMaterials, optimizeForAR);
|
|
48
|
+
const glbData = await GLTF2Export.GLBAsync(scene, 'dummy', this.gltfExportOptions(exportOptions, excluded));
|
|
49
|
+
this.exportPostProcess(scene, sceneCopied);
|
|
50
|
+
|
|
51
|
+
const resBlob = glbData.glTFFiles['dummy.glb'];
|
|
52
|
+
// check if result is valid, according to the typings this could also be a string
|
|
53
|
+
if (resBlob instanceof Blob) {
|
|
54
|
+
if (!filename.endsWith('.glb')) {
|
|
55
|
+
filename += '.glb';
|
|
56
|
+
}
|
|
57
|
+
return new File([resBlob], filename);
|
|
58
|
+
} else {
|
|
59
|
+
// result was not a valid blob
|
|
60
|
+
return undefined;
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* Exports selected nodes to GLTF. This may result in more than one file, since textures are exported separately.
|
|
66
|
+
* @param filename name of the main (text-based) .GLTF file referring to separate texture files.
|
|
67
|
+
* @param exportOptions export options to be merged with default options.\
|
|
68
|
+
* `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
|
|
69
|
+
* @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
|
|
70
|
+
* @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
|
|
71
|
+
*/
|
|
72
|
+
public async exportGltfToFile(
|
|
73
|
+
filename: string,
|
|
74
|
+
{ exchangeRefractionMaterials = true, ...exportOptions }: IExportOptionsExtended = {},
|
|
75
|
+
optimizeForAR: boolean = false,
|
|
76
|
+
excluded?: ExcludedGeometryList
|
|
77
|
+
) {
|
|
78
|
+
const { scene, sceneCopied } = await this.exportPreProcess(exchangeRefractionMaterials, optimizeForAR);
|
|
79
|
+
const gltf = await GLTF2Export.GLTFAsync(scene, filename, this.gltfExportOptions(exportOptions, excluded));
|
|
80
|
+
gltf.downloadFiles();
|
|
81
|
+
this.exportPostProcess(scene, sceneCopied);
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
/**
|
|
85
|
+
* Exports selected nodes to GLB. This results in one binary file.
|
|
86
|
+
* @param filename name of the .GLB file.
|
|
87
|
+
* @param exportOptions export options to be merged with default options.\
|
|
88
|
+
* `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
|
|
89
|
+
* @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
|
|
90
|
+
* @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
|
|
91
|
+
*/
|
|
92
|
+
public async exportGlbToFile(
|
|
93
|
+
filename: string,
|
|
94
|
+
{ exchangeRefractionMaterials = true, ...exportOptions }: IExportOptionsExtended = {},
|
|
95
|
+
optimizeForAR: boolean = false,
|
|
96
|
+
excluded?: ExcludedGeometryList
|
|
97
|
+
) {
|
|
98
|
+
const { scene, sceneCopied } = await this.exportPreProcess(exchangeRefractionMaterials, optimizeForAR);
|
|
99
|
+
const glb = await GLTF2Export.GLBAsync(scene, filename, this.gltfExportOptions(exportOptions, excluded));
|
|
100
|
+
glb.downloadFiles();
|
|
101
|
+
this.exportPostProcess(scene, sceneCopied);
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* Gets predefined {@link IExportOptions } merged with given ones.
|
|
106
|
+
*/
|
|
107
|
+
protected gltfExportOptions(mergeWithOptions: IExportOptions = {}, excluded?: ExcludedGeometryList): IExportOptions {
|
|
108
|
+
const defaultOptions: IExportOptions = {
|
|
109
|
+
shouldExportNode: function (node: any) {
|
|
110
|
+
if (!node.isEnabled()) {
|
|
111
|
+
return false;
|
|
112
|
+
}
|
|
113
|
+
if ((node.name as string).startsWith(Viewer.BOUNDING_BOX_NAME)) {
|
|
114
|
+
return false;
|
|
115
|
+
}
|
|
116
|
+
if (excluded && node instanceof TransformNode && isNodeIncludedInExclusionList(node, excluded)) {
|
|
117
|
+
return false;
|
|
118
|
+
}
|
|
119
|
+
return true;
|
|
120
|
+
},
|
|
121
|
+
};
|
|
122
|
+
return merge({}, defaultOptions, mergeWithOptions);
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* Stuff to be done before exporting to GLTF
|
|
127
|
+
*
|
|
128
|
+
* @returns Either the original scene if no adjustments have been made or a copied scene (which can be disposed after
|
|
129
|
+
* the export) if adjustments have been made
|
|
130
|
+
*/
|
|
131
|
+
protected async exportPreProcess(
|
|
132
|
+
exchangeRefractionMaterials: boolean,
|
|
133
|
+
optimizeForAR: boolean
|
|
134
|
+
): Promise<{ scene: Scene; sceneCopied: boolean }> {
|
|
135
|
+
if (!exchangeRefractionMaterials && !optimizeForAR) {
|
|
136
|
+
// no need to copy the scene if no adjustments have to be made
|
|
137
|
+
return { scene: this.viewer.scene, sceneCopied: false };
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
// copy the scene for the GLB export improvements, so that the original viewer scene remains untouched
|
|
141
|
+
const copiedScene = await this.copyViewerScene();
|
|
142
|
+
|
|
143
|
+
if (exchangeRefractionMaterials) {
|
|
144
|
+
this.exchangeRefractionMaterials(copiedScene);
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
if (optimizeForAR) {
|
|
148
|
+
this.setUniqueMeshNames(copiedScene);
|
|
149
|
+
this.bakeTransformations(copiedScene);
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
return { scene: copiedScene, sceneCopied: true };
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
/**
|
|
156
|
+
* Create a copy of the viewer scene, which can be further processed and optimized for the GLB export.
|
|
157
|
+
* There is no "scene.clone" function, therefore the scene is serialized and loaded again to achieve this result.
|
|
158
|
+
*/
|
|
159
|
+
protected async copyViewerScene(): Promise<Scene> {
|
|
160
|
+
// required by the scene serializer
|
|
161
|
+
await import(/* webpackChunkName: "physicsenginecomponent" */ '@babylonjs/core/Physics/physicsEngineComponent');
|
|
162
|
+
|
|
163
|
+
// copy scene function uses scene serializer, which can't handle "complex" data like classes, function or recursive
|
|
164
|
+
// data structures in metadata
|
|
165
|
+
// it basically does a `JSON.stringify` on the metadata
|
|
166
|
+
// therefore the metadata has to be removed from the nodes before the copy process
|
|
167
|
+
const metadataArr = this.extractMetadataOfAllNodes();
|
|
168
|
+
|
|
169
|
+
// serialize the scene
|
|
170
|
+
const serializedScene = await SceneSerializer.SerializeAsync(this.viewer.scene);
|
|
171
|
+
|
|
172
|
+
// set the cropped metadata back to the viewer scene nodes
|
|
173
|
+
this.restoreMetadataOfAllNodes(metadataArr);
|
|
174
|
+
|
|
175
|
+
// load the scene into an invisible "dummy" canvas
|
|
176
|
+
const offscreenCanvas = new HTMLCanvasElement();
|
|
177
|
+
const engine = new Engine(offscreenCanvas);
|
|
178
|
+
|
|
179
|
+
// engine.getCaps().maxTextureSize = 1024;
|
|
180
|
+
console.log('!!! using HTML Canvas for Export !!!');
|
|
181
|
+
|
|
182
|
+
SceneLoader.ShowLoadingScreen = false;
|
|
183
|
+
const newScene = await SceneLoader.LoadAsync('', 'data:' + JSON.stringify(serializedScene), engine);
|
|
184
|
+
// this is required for offscreen canvas, otherwise the scene dispose code throws when trying to remove the cursor
|
|
185
|
+
// events
|
|
186
|
+
newScene.doNotHandleCursors = true;
|
|
187
|
+
|
|
188
|
+
console.log('old scene');
|
|
189
|
+
this.viewer.scene.textures.map(texture => console.log(texture._texture?.width));
|
|
190
|
+
console.log('new scene');
|
|
191
|
+
newScene.textures.map(texture => console.log(texture._texture?.width));
|
|
192
|
+
|
|
193
|
+
return newScene;
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
/**
|
|
197
|
+
* Stuff to be done after the GLTF export
|
|
198
|
+
*/
|
|
199
|
+
protected exportPostProcess(scene: Scene, disposeScene: boolean) {
|
|
200
|
+
if (disposeScene) {
|
|
201
|
+
// copied scene for GLB export is not needed anymore, therefore it can be removed
|
|
202
|
+
scene.getEngine().dispose();
|
|
203
|
+
}
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
/**
|
|
207
|
+
* Remove all node metadata and return them in a map
|
|
208
|
+
*/
|
|
209
|
+
protected extractMetadataOfAllNodes(): MetadataMap {
|
|
210
|
+
return this.viewer.scene.getNodes().reduce((accMetadataObj, curNode) => {
|
|
211
|
+
const metadata = curNode.metadata;
|
|
212
|
+
delete curNode.metadata;
|
|
213
|
+
return { ...accMetadataObj, [curNode.uniqueId.toString()]: metadata };
|
|
214
|
+
}, {});
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
/**
|
|
218
|
+
* Restore node metadata from previously cropped metadata map
|
|
219
|
+
*/
|
|
220
|
+
protected restoreMetadataOfAllNodes(metadataMap: MetadataMap) {
|
|
221
|
+
this.viewer.scene.getNodes().forEach(node => {
|
|
222
|
+
const metadata = metadataMap[node.uniqueId.toString()];
|
|
223
|
+
if (metadata) {
|
|
224
|
+
node.metadata = metadata;
|
|
225
|
+
}
|
|
226
|
+
});
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
/**
|
|
230
|
+
* Materials with refraction set are not exported properly.
|
|
231
|
+
* Exchange all such (relevant) materials with a more export-friendly version
|
|
232
|
+
*/
|
|
233
|
+
protected exchangeRefractionMaterials(scene: Scene) {
|
|
234
|
+
for (const n of scene.getNodes()) {
|
|
235
|
+
if (!(n instanceof AbstractMesh)) continue;
|
|
236
|
+
if (!(n.material instanceof PBRMaterial)) continue;
|
|
237
|
+
if (!(n.material as PBRMaterial).subSurface.isRefractionEnabled) continue;
|
|
238
|
+
if ((n.material as PBRMaterial).transparencyMode !== PBRMaterial.PBRMATERIAL_OPAQUE) continue;
|
|
239
|
+
// if we're here, we have a node holding a material with set refraction whose transparencyMode is set to
|
|
240
|
+
// PBRMATERIAL_OPAQUE
|
|
241
|
+
n.material = this.createRefractionMaterialReplacement(n.material);
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
/**
|
|
246
|
+
* Create an export-friendly replacement material for a material using refraction.
|
|
247
|
+
* @param mat Material to be replaced
|
|
248
|
+
*/
|
|
249
|
+
protected createRefractionMaterialReplacement(mat: PBRMaterial): PBRMaterial {
|
|
250
|
+
// if we're dealing with a clone already, return it instead of cloning
|
|
251
|
+
if (this.isMaterialClonedForExport(mat)) return mat;
|
|
252
|
+
|
|
253
|
+
// change material according to https://www.notion.so/combeenation/Glas-materials-don-t-look-glasy-after-export-d5fda2c6515e4420a8772744d3e6b460
|
|
254
|
+
const clonedMaterial = mat.clone(mat.name); // clone material. clone uses same name
|
|
255
|
+
clonedMaterial.metadata = { ...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
|
|
256
|
+
clonedMaterial.refractionTexture = null;
|
|
257
|
+
clonedMaterial.metallicReflectanceTexture = null; // is this the correct one for metallic roughness?
|
|
258
|
+
clonedMaterial.alpha = 0.7;
|
|
259
|
+
clonedMaterial.albedoColor = new Color3(0.3, 0.3, 0.3);
|
|
260
|
+
clonedMaterial.transparencyMode = PBRMaterial.PBRMATERIAL_ALPHABLEND;
|
|
261
|
+
clonedMaterial.metallic = 0.65;
|
|
262
|
+
clonedMaterial.roughness = 0.15;
|
|
263
|
+
|
|
264
|
+
return clonedMaterial;
|
|
265
|
+
}
|
|
266
|
+
|
|
267
|
+
/**
|
|
268
|
+
* Inspect if a material was temporarily cloned for GLB export
|
|
269
|
+
* @param mat Material to be inspected
|
|
270
|
+
*/
|
|
271
|
+
protected isMaterialClonedForExport(mat: PBRMaterial): boolean {
|
|
272
|
+
return has(mat.metadata, GltfExportManager._CLONED_FROM_MAT_METADATA_PROPERTY);
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* Set unique mesh names for GLB export.
|
|
277
|
+
* Duplicate names lead to problems in AR on iOS devices.
|
|
278
|
+
*/
|
|
279
|
+
protected setUniqueMeshNames(scene: Scene): void {
|
|
280
|
+
const allNodes = scene.getNodes().filter(node => node instanceof TransformNode) as TransformNode[];
|
|
281
|
+
allNodes.forEach(currMesh => {
|
|
282
|
+
injectMetadata(currMesh, { [GltfExportManager.NAME_BEFORE_EXPORT_METADATA_PROPERTY]: currMesh.name }, false);
|
|
283
|
+
currMesh.name = `${currMesh.name}_${currMesh.uniqueId}`;
|
|
284
|
+
});
|
|
285
|
+
}
|
|
286
|
+
|
|
287
|
+
/**
|
|
288
|
+
* Stores the effect of all mesh transformations in their geometry and reset the transformation afterwards.
|
|
289
|
+
* In this way negative scalings which lead to problems in AR on iOS devices can be eliminated.
|
|
290
|
+
*/
|
|
291
|
+
protected bakeTransformations(scene: Scene): void {
|
|
292
|
+
scene.meshes.forEach(mesh => {
|
|
293
|
+
if (mesh instanceof Mesh && mesh.geometry) {
|
|
294
|
+
// geometries can be shared across multiple meshes, first make them unique to avoid side-effects
|
|
295
|
+
mesh.makeGeometryUnique();
|
|
296
|
+
// this is the core functionality for storing the transformation data in the mesh geometry
|
|
297
|
+
mesh.bakeCurrentTransformIntoVertices();
|
|
298
|
+
}
|
|
299
|
+
});
|
|
300
|
+
|
|
301
|
+
// some nodes (mostly transform nodes), are not affected by the baking algorithm since they have no geometry
|
|
302
|
+
// => reset their transformation manually
|
|
303
|
+
const allNodes = scene.getNodes().filter(node => node instanceof TransformNode) as TransformNode[];
|
|
304
|
+
allNodes.forEach(node => {
|
|
305
|
+
node.position = new Vector3(0, 0, 0);
|
|
306
|
+
node.rotation = new Vector3(0, 0, 0);
|
|
307
|
+
node.scaling = new Vector3(1, 1, 1);
|
|
308
|
+
});
|
|
309
|
+
}
|
|
310
|
+
}
|