@combeenation/3d-viewer 5.1.2 → 5.2.0-alpha4

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 (221) 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 -1
  4. package/dist/lib-cjs/api/classes/dottedPath.d.ts +79 -79
  5. package/dist/lib-cjs/api/classes/dottedPath.js +166 -187
  6. package/dist/lib-cjs/api/classes/dottedPath.js.map +1 -1
  7. package/dist/lib-cjs/api/classes/element.d.ts +149 -149
  8. package/dist/lib-cjs/api/classes/element.js +668 -823
  9. package/dist/lib-cjs/api/classes/element.js.map +1 -1
  10. package/dist/lib-cjs/api/classes/event.d.ts +326 -326
  11. package/dist/lib-cjs/api/classes/event.js +349 -371
  12. package/dist/lib-cjs/api/classes/event.js.map +1 -1
  13. package/dist/lib-cjs/api/classes/eventBroadcaster.d.ts +26 -26
  14. package/dist/lib-cjs/api/classes/eventBroadcaster.js +49 -53
  15. package/dist/lib-cjs/api/classes/eventBroadcaster.js.map +1 -1
  16. package/dist/lib-cjs/api/classes/parameter.d.ts +336 -336
  17. package/dist/lib-cjs/api/classes/parameter.js +461 -471
  18. package/dist/lib-cjs/api/classes/parameter.js.map +1 -1
  19. package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
  20. package/dist/lib-cjs/api/classes/parameterObservable.js +97 -101
  21. package/dist/lib-cjs/api/classes/parameterObservable.js.map +1 -1
  22. package/dist/lib-cjs/api/classes/parameterizable.d.ts +15 -15
  23. package/dist/lib-cjs/api/classes/parameterizable.js +102 -149
  24. package/dist/lib-cjs/api/classes/parameterizable.js.map +1 -1
  25. package/dist/lib-cjs/api/classes/placementAnimation.d.ts +45 -44
  26. package/dist/lib-cjs/api/classes/placementAnimation.js +175 -163
  27. package/dist/lib-cjs/api/classes/placementAnimation.js.map +1 -1
  28. package/dist/lib-cjs/api/classes/variant.d.ts +234 -234
  29. package/dist/lib-cjs/api/classes/variant.js +836 -1203
  30. package/dist/lib-cjs/api/classes/variant.js.map +1 -1
  31. package/dist/lib-cjs/api/classes/variantInstance.d.ts +45 -45
  32. package/dist/lib-cjs/api/classes/variantInstance.js +101 -108
  33. package/dist/lib-cjs/api/classes/variantInstance.js.map +1 -1
  34. package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +17 -17
  35. package/dist/lib-cjs/api/classes/variantParameterizable.js +88 -99
  36. package/dist/lib-cjs/api/classes/variantParameterizable.js.map +1 -1
  37. package/dist/lib-cjs/api/classes/viewer.d.ts +187 -184
  38. package/dist/lib-cjs/api/classes/viewer.js +593 -731
  39. package/dist/lib-cjs/api/classes/viewer.js.map +1 -1
  40. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
  41. package/dist/lib-cjs/api/classes/viewerLight.js +343 -392
  42. package/dist/lib-cjs/api/classes/viewerLight.js.map +1 -1
  43. package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
  44. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  45. package/dist/lib-cjs/api/internal/lensRendering.js.map +1 -1
  46. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
  47. package/dist/lib-cjs/api/internal/sceneSetup.js +225 -238
  48. package/dist/lib-cjs/api/internal/sceneSetup.js.map +1 -1
  49. package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -29
  50. package/dist/lib-cjs/api/manager/animationManager.js +126 -130
  51. package/dist/lib-cjs/api/manager/animationManager.js.map +1 -1
  52. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +65 -65
  53. package/dist/lib-cjs/api/manager/gltfExportManager.js +196 -223
  54. package/dist/lib-cjs/api/manager/gltfExportManager.js.map +1 -1
  55. package/dist/lib-cjs/api/manager/sceneManager.d.ts +31 -31
  56. package/dist/lib-cjs/api/manager/sceneManager.js +127 -152
  57. package/dist/lib-cjs/api/manager/sceneManager.js.map +1 -1
  58. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +92 -92
  59. package/dist/lib-cjs/api/manager/variantInstanceManager.js +260 -335
  60. package/dist/lib-cjs/api/manager/variantInstanceManager.js.map +1 -1
  61. package/dist/lib-cjs/api/store/specStorage.d.ts +24 -24
  62. package/dist/lib-cjs/api/store/specStorage.js +50 -51
  63. package/dist/lib-cjs/api/store/specStorage.js.map +1 -1
  64. package/dist/lib-cjs/api/util/babylonHelper.d.ts +174 -174
  65. package/dist/lib-cjs/api/util/babylonHelper.js +591 -611
  66. package/dist/lib-cjs/api/util/babylonHelper.js.map +1 -1
  67. package/dist/lib-cjs/api/util/globalTypes.d.ts +366 -366
  68. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  69. package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
  70. package/dist/lib-cjs/api/util/resourceHelper.js +201 -257
  71. package/dist/lib-cjs/api/util/resourceHelper.js.map +1 -1
  72. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +35 -35
  73. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +141 -140
  74. package/dist/lib-cjs/api/util/sceneLoaderHelper.js.map +1 -1
  75. package/dist/lib-cjs/api/util/stringHelper.d.ts +9 -9
  76. package/dist/lib-cjs/api/util/stringHelper.js +23 -25
  77. package/dist/lib-cjs/api/util/stringHelper.js.map +1 -1
  78. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
  79. package/dist/lib-cjs/api/util/structureHelper.js +48 -48
  80. package/dist/lib-cjs/api/util/structureHelper.js.map +1 -1
  81. package/dist/lib-cjs/buildinfo.json +3 -3
  82. package/dist/lib-cjs/index.d.ts +51 -49
  83. package/dist/lib-cjs/index.js +110 -89
  84. package/dist/lib-cjs/index.js.map +1 -1
  85. package/dist/lib-es6/api/classes/animationInterface.d.ts +8 -8
  86. package/dist/lib-es6/api/classes/animationInterface.js +1 -1
  87. package/dist/lib-es6/api/classes/dottedPath.d.ts +79 -79
  88. package/dist/lib-es6/api/classes/dottedPath.js +162 -184
  89. package/dist/lib-es6/api/classes/dottedPath.js.map +1 -1
  90. package/dist/lib-es6/api/classes/element.d.ts +149 -149
  91. package/dist/lib-es6/api/classes/element.js +664 -820
  92. package/dist/lib-es6/api/classes/element.js.map +1 -1
  93. package/dist/lib-es6/api/classes/event.d.ts +326 -326
  94. package/dist/lib-es6/api/classes/event.js +345 -368
  95. package/dist/lib-es6/api/classes/event.js.map +1 -1
  96. package/dist/lib-es6/api/classes/eventBroadcaster.d.ts +26 -26
  97. package/dist/lib-es6/api/classes/eventBroadcaster.js +42 -50
  98. package/dist/lib-es6/api/classes/eventBroadcaster.js.map +1 -1
  99. package/dist/lib-es6/api/classes/parameter.d.ts +336 -336
  100. package/dist/lib-es6/api/classes/parameter.js +457 -468
  101. package/dist/lib-es6/api/classes/parameter.js.map +1 -1
  102. package/dist/lib-es6/api/classes/parameterObservable.d.ts +36 -36
  103. package/dist/lib-es6/api/classes/parameterObservable.js +93 -98
  104. package/dist/lib-es6/api/classes/parameterObservable.js.map +1 -1
  105. package/dist/lib-es6/api/classes/parameterizable.d.ts +15 -15
  106. package/dist/lib-es6/api/classes/parameterizable.js +98 -146
  107. package/dist/lib-es6/api/classes/parameterizable.js.map +1 -1
  108. package/dist/lib-es6/api/classes/placementAnimation.d.ts +45 -44
  109. package/dist/lib-es6/api/classes/placementAnimation.js +171 -160
  110. package/dist/lib-es6/api/classes/placementAnimation.js.map +1 -1
  111. package/dist/lib-es6/api/classes/variant.d.ts +234 -234
  112. package/dist/lib-es6/api/classes/variant.js +832 -1198
  113. package/dist/lib-es6/api/classes/variant.js.map +1 -1
  114. package/dist/lib-es6/api/classes/variantInstance.d.ts +45 -45
  115. package/dist/lib-es6/api/classes/variantInstance.js +97 -105
  116. package/dist/lib-es6/api/classes/variantInstance.js.map +1 -1
  117. package/dist/lib-es6/api/classes/variantParameterizable.d.ts +17 -17
  118. package/dist/lib-es6/api/classes/variantParameterizable.js +84 -96
  119. package/dist/lib-es6/api/classes/variantParameterizable.js.map +1 -1
  120. package/dist/lib-es6/api/classes/viewer.d.ts +187 -184
  121. package/dist/lib-es6/api/classes/viewer.js +586 -728
  122. package/dist/lib-es6/api/classes/viewer.js.map +1 -1
  123. package/dist/lib-es6/api/classes/viewerLight.d.ts +66 -66
  124. package/dist/lib-es6/api/classes/viewerLight.js +316 -389
  125. package/dist/lib-es6/api/classes/viewerLight.js.map +1 -1
  126. package/dist/lib-es6/api/internal/lensRendering.d.ts +8 -8
  127. package/dist/lib-es6/api/internal/lensRendering.js +8 -8
  128. package/dist/lib-es6/api/internal/lensRendering.js.map +1 -1
  129. package/dist/lib-es6/api/internal/sceneSetup.d.ts +13 -13
  130. package/dist/lib-es6/api/internal/sceneSetup.js +197 -233
  131. package/dist/lib-es6/api/internal/sceneSetup.js.map +1 -1
  132. package/dist/lib-es6/api/manager/animationManager.d.ts +30 -29
  133. package/dist/lib-es6/api/manager/animationManager.js +122 -127
  134. package/dist/lib-es6/api/manager/animationManager.js.map +1 -1
  135. package/dist/lib-es6/api/manager/gltfExportManager.d.ts +65 -65
  136. package/dist/lib-es6/api/manager/gltfExportManager.js +192 -220
  137. package/dist/lib-es6/api/manager/gltfExportManager.js.map +1 -1
  138. package/dist/lib-es6/api/manager/sceneManager.d.ts +31 -31
  139. package/dist/lib-es6/api/manager/sceneManager.js +123 -149
  140. package/dist/lib-es6/api/manager/sceneManager.js.map +1 -1
  141. package/dist/lib-es6/api/manager/variantInstanceManager.d.ts +92 -92
  142. package/dist/lib-es6/api/manager/variantInstanceManager.js +256 -332
  143. package/dist/lib-es6/api/manager/variantInstanceManager.js.map +1 -1
  144. package/dist/lib-es6/api/store/specStorage.d.ts +24 -24
  145. package/dist/lib-es6/api/store/specStorage.js +46 -48
  146. package/dist/lib-es6/api/store/specStorage.js.map +1 -1
  147. package/dist/lib-es6/api/util/babylonHelper.d.ts +174 -174
  148. package/dist/lib-es6/api/util/babylonHelper.js +561 -581
  149. package/dist/lib-es6/api/util/babylonHelper.js.map +1 -1
  150. package/dist/lib-es6/api/util/globalTypes.d.ts +366 -366
  151. package/dist/lib-es6/api/util/globalTypes.js +1 -1
  152. package/dist/lib-es6/api/util/resourceHelper.d.ts +58 -58
  153. package/dist/lib-es6/api/util/resourceHelper.js +191 -247
  154. package/dist/lib-es6/api/util/resourceHelper.js.map +1 -1
  155. package/dist/lib-es6/api/util/sceneLoaderHelper.d.ts +35 -35
  156. package/dist/lib-es6/api/util/sceneLoaderHelper.js +131 -133
  157. package/dist/lib-es6/api/util/sceneLoaderHelper.js.map +1 -1
  158. package/dist/lib-es6/api/util/stringHelper.d.ts +9 -9
  159. package/dist/lib-es6/api/util/stringHelper.js +19 -21
  160. package/dist/lib-es6/api/util/stringHelper.js.map +1 -1
  161. package/dist/lib-es6/api/util/structureHelper.d.ts +9 -9
  162. package/dist/lib-es6/api/util/structureHelper.js +45 -45
  163. package/dist/lib-es6/api/util/structureHelper.js.map +1 -1
  164. package/dist/lib-es6/buildinfo.json +3 -3
  165. package/dist/lib-es6/index.d.ts +51 -49
  166. package/dist/lib-es6/index.js +48 -50
  167. package/dist/lib-es6/index.js.map +1 -1
  168. package/dist/lib-full/lens-rendering.js +2 -0
  169. package/dist/lib-full/lens-rendering.js.map +1 -0
  170. package/dist/lib-full/main.js +3 -0
  171. package/dist/lib-full/main.js.LICENSE.txt +9 -0
  172. package/dist/lib-full/main.js.map +1 -0
  173. package/package.json +76 -88
  174. package/src/api/classes/animationInterface.ts +10 -10
  175. package/src/api/classes/dottedPath.ts +181 -181
  176. package/src/api/classes/element.ts +716 -716
  177. package/src/api/classes/event.ts +367 -367
  178. package/src/api/classes/eventBroadcaster.ts +52 -52
  179. package/src/api/classes/parameter.ts +494 -494
  180. package/src/api/classes/parameterObservable.ts +100 -100
  181. package/src/api/classes/parameterizable.ts +87 -87
  182. package/src/api/classes/placementAnimation.ts +161 -160
  183. package/src/api/classes/variant.ts +904 -905
  184. package/src/api/classes/variantInstance.ts +97 -97
  185. package/src/api/classes/variantParameterizable.ts +85 -85
  186. package/src/api/classes/viewer.ts +669 -668
  187. package/src/api/classes/viewerLight.ts +334 -334
  188. package/src/api/internal/debugViewer.ts +90 -90
  189. package/src/api/internal/lensRendering.ts +9 -10
  190. package/src/api/internal/sceneSetup.ts +204 -204
  191. package/src/api/manager/animationManager.ts +143 -142
  192. package/src/api/manager/gltfExportManager.ts +191 -191
  193. package/src/api/manager/sceneManager.ts +127 -127
  194. package/src/api/manager/variantInstanceManager.ts +265 -265
  195. package/src/api/store/specStorage.ts +51 -51
  196. package/src/api/util/babylonHelper.ts +663 -663
  197. package/src/api/util/globalTypes.ts +413 -413
  198. package/src/api/util/resourceHelper.ts +189 -189
  199. package/src/api/util/sceneLoaderHelper.ts +148 -147
  200. package/src/api/util/stringHelper.ts +23 -23
  201. package/src/api/util/structureHelper.ts +49 -49
  202. package/src/buildinfo.json +3 -3
  203. package/src/dev.ts +61 -64
  204. package/src/index.ts +96 -94
  205. package/src/types.d.ts +28 -28
  206. package/dist/lib-cjs/api/classes/elementParameterizable.d.ts +0 -14
  207. package/dist/lib-cjs/api/classes/elementParameterizable.js +0 -135
  208. package/dist/lib-cjs/api/classes/elementParameterizable.js.map +0 -1
  209. package/dist/lib-cjs/api/internal/debugViewer.d.ts +0 -13
  210. package/dist/lib-cjs/api/internal/debugViewer.js +0 -87
  211. package/dist/lib-cjs/api/internal/debugViewer.js.map +0 -1
  212. package/dist/lib-es6/api/internal/debugViewer.d.ts +0 -13
  213. package/dist/lib-es6/api/internal/debugViewer.js +0 -84
  214. package/dist/lib-es6/api/internal/debugViewer.js.map +0 -1
  215. package/dist/webpack-stats.json +0 -0
  216. package/src/commonjs.tsconfig.json +0 -10
  217. package/src/declaration.tsconfig.json +0 -8
  218. package/src/es6.tsconfig.json +0 -10
  219. package/src/pagesconfig.json +0 -81
  220. package/src/tsconfig.json +0 -33
  221. package/src/tsconfig.types.json +0 -9
@@ -1,191 +1,191 @@
1
- import { PBRMaterial } from '@babylonjs/core/Materials/PBR/pbrMaterial';
2
- import { Color3 } from '@babylonjs/core/Maths/math.color';
3
- import { AbstractMesh } from '@babylonjs/core/Meshes/abstractMesh';
4
- import { GLTF2Export, IExportOptions } from '@babylonjs/serializers/glTF/2.0';
5
- import { isMeshIncludedInExclusionList } from '../util/structureHelper';
6
- import { merge } from 'lodash-es';
7
- import { Mesh } from '@babylonjs/core/Meshes/mesh';
8
-
9
- export class GltfExportManager {
10
- /**
11
- * Constructor.
12
- */
13
- protected constructor(protected viewer: Viewer) {}
14
-
15
- /**
16
- * Creates an {@link GltfExportManager}.
17
- */
18
- public static async create(viewer: Viewer): Promise<GltfExportManager> {
19
- return new GltfExportManager(viewer);
20
- }
21
-
22
- /**
23
- * Exports selected nodes to a file.
24
- * @param filename optional name of the exported .GLB file.
25
- * @param exportOptions export options to be merged with default options.
26
- * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export.
27
- */
28
- public async exportGlb(
29
- filename = 'glb-export.glb',
30
- exportOptions: IExportOptions = {},
31
- excluded?: ExcludedGeometryList
32
- ): Promise<File | undefined> {
33
- this.exportPreProcess();
34
- const glbData = await GLTF2Export.GLBAsync(
35
- this.viewer.scene,
36
- 'dummy',
37
- this.gltfExportOptions(exportOptions, excluded)
38
- );
39
- this.exportPostProcess();
40
- const resBlob = glbData.glTFFiles['dummy.glb']; // should be only one file for glb
41
-
42
- // check if result is valid, according to the typings this could also be a string
43
- if (resBlob instanceof Blob) {
44
- if (!filename.endsWith('.glb')) {
45
- filename += '.glb';
46
- }
47
- return new File([resBlob], filename);
48
- } else {
49
- // result was not a valid blob
50
- return undefined;
51
- }
52
- }
53
-
54
- /**
55
- * Exports selected nodes to GLTF. This may result in more than one file, since textures are exported separately.
56
- * @param filename name of the main (text-based) .GLTF file referring to separate texture files.
57
- * @param exportOptions export options to be merged with default options.
58
- * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export.
59
- */
60
- public async exportGltfToFile(filename: string, exportOptions: IExportOptions = {}, excluded?: ExcludedGeometryList) {
61
- this.exportPreProcess();
62
- await GLTF2Export.GLTFAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(
63
- glb => {
64
- glb.downloadFiles();
65
- }
66
- );
67
- this.exportPostProcess();
68
- }
69
-
70
- /**
71
- * Exports selected nodes to GLB. This results in one binary file.
72
- * @param filename name of the .GLB file.
73
- * @param exportOptions export options to be merged with default options.
74
- * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
75
- */
76
- public async exportGlbToFile(filename: string, exportOptions: IExportOptions = {}, excluded?: ExcludedGeometryList) {
77
- this.exportPreProcess();
78
- await GLTF2Export.GLBAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(
79
- glb => {
80
- glb.downloadFiles();
81
- }
82
- );
83
- this.exportPostProcess();
84
- }
85
-
86
- /**
87
- * Gets predefined {@link IExportOptions } merged with given ones.
88
- */
89
- protected gltfExportOptions(mergeWithOptions: IExportOptions = {}, excluded?: ExcludedGeometryList): IExportOptions {
90
- const defaultOptions = {
91
- // includeCoordinateSystemConversionNodes: true,
92
- shouldExportNode: function (node: any) {
93
- if (!node.isEnabled()) {
94
- return false;
95
- }
96
- if (node.isVisible === false) {
97
- return false;
98
- }
99
- if (node.name === '__bounding_box__') {
100
- return false;
101
- }
102
- if (excluded && node instanceof Mesh && isMeshIncludedInExclusionList(node, excluded)) {
103
- return false;
104
- }
105
- return true;
106
- },
107
- };
108
- return merge({}, defaultOptions, mergeWithOptions);
109
- }
110
-
111
- /**
112
- * Stuff to be done before exporting to GLTF
113
- */
114
- protected exportPreProcess() {
115
- this.viewer.pauseRendering();
116
- this.exchangeRefractionMaterials();
117
- }
118
-
119
- /**
120
- * Stuff to be done after the GLTF export
121
- */
122
- protected exportPostProcess() {
123
- this.restoreRefractionMaterials();
124
- this.viewer.resumeRendering();
125
- }
126
-
127
- /**
128
- * Materials with refraction set are not exported properly.
129
- * Exchange all such (relevant) materials with a more export-friendly version
130
- */
131
- protected exchangeRefractionMaterials() {
132
- for (const n of this.viewer.scene.getNodes()) {
133
- if (!(n instanceof AbstractMesh)) continue;
134
- if (!(n.material instanceof PBRMaterial)) continue;
135
- if (!(n.material as PBRMaterial).subSurface.isRefractionEnabled) continue;
136
- if ((n.material as PBRMaterial).transparencyMode !== PBRMaterial.PBRMATERIAL_OPAQUE) continue;
137
- // if we're here, we have a node holding a material with set refraction whose transparencyMode is set to PBRMATERIAL_OPAQUE
138
- n.material = this.createRefractionMaterialReplacement(n.material);
139
- }
140
- }
141
-
142
- /**
143
- * Restore original materials with set refraction.
144
- */
145
- protected restoreRefractionMaterials() {
146
- for (const n of this.viewer.scene.getNodes()) {
147
- if (!(n instanceof AbstractMesh)) continue;
148
- if (!(n.material instanceof PBRMaterial)) continue;
149
- if (!this.isMaterialClonedForExport(n.material)) continue;
150
- // at this point we have a pbrmaterial tagged as cloned in its metadata that's set on a mesh
151
-
152
- // restore and dispose
153
- const currMaterial = n.material;
154
- const prevMaterial = this.viewer.scene.getMaterialByUniqueID(n.material.metadata.clonedFrom);
155
- if (prevMaterial) {
156
- n.material = prevMaterial; // restore previous material
157
- currMaterial.dispose(false, true); // dispose of clone
158
- }
159
- }
160
- }
161
-
162
- /**
163
- * Create an export-friendly replacement material for a material using refraction.
164
- * @param mat Material to be replaced
165
- */
166
- protected createRefractionMaterialReplacement(mat: PBRMaterial): PBRMaterial {
167
- // if we're dealing with a clone already, return it instead of cloning
168
- if (this.isMaterialClonedForExport(mat)) return mat;
169
-
170
- // change material according to https://www.notion.so/combeenation/Glas-materials-don-t-look-glasy-after-export-d5fda2c6515e4420a8772744d3e6b460
171
- let clonedMaterial = mat.clone(mat.name); // clone material. clone uses same name
172
- clonedMaterial.metadata = { ...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
173
- clonedMaterial.refractionTexture = null;
174
- clonedMaterial.metallicReflectanceTexture = null; // is this the correct one for metallic roughness?
175
- clonedMaterial.alpha = 0.7;
176
- clonedMaterial.albedoColor = new Color3(0.3, 0.3, 0.3);
177
- clonedMaterial.transparencyMode = PBRMaterial.PBRMATERIAL_ALPHABLEND;
178
- clonedMaterial.metallic = 0.65;
179
- clonedMaterial.roughness = 0.15;
180
-
181
- return clonedMaterial;
182
- }
183
-
184
- /**
185
- * Inspect if a material was temporarily cloned for GLB export
186
- * @param mat Material to be inspected
187
- */
188
- protected isMaterialClonedForExport(mat: PBRMaterial): boolean {
189
- return !!mat.metadata?.clonedFrom;
190
- }
191
- }
1
+ import { isMeshIncludedInExclusionList } from '../util/structureHelper';
2
+ import { PBRMaterial } from '@babylonjs/core/Materials/PBR/pbrMaterial';
3
+ import { Color3 } from '@babylonjs/core/Maths/math.color';
4
+ import { AbstractMesh } from '@babylonjs/core/Meshes/abstractMesh';
5
+ import { Mesh } from '@babylonjs/core/Meshes/mesh';
6
+ import { GLTF2Export, IExportOptions } from '@babylonjs/serializers/glTF/2.0';
7
+ import { merge } from 'lodash-es';
8
+
9
+ export class GltfExportManager {
10
+ /**
11
+ * Constructor.
12
+ */
13
+ protected constructor(protected viewer: Viewer) {}
14
+
15
+ /**
16
+ * Creates an {@link GltfExportManager}.
17
+ */
18
+ public static async create(viewer: Viewer): Promise<GltfExportManager> {
19
+ return new GltfExportManager(viewer);
20
+ }
21
+
22
+ /**
23
+ * Exports selected nodes to a file.
24
+ * @param filename optional name of the exported .GLB file.
25
+ * @param exportOptions export options to be merged with default options.
26
+ * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export.
27
+ */
28
+ public async exportGlb(
29
+ filename = 'glb-export.glb',
30
+ exportOptions: IExportOptions = {},
31
+ excluded?: ExcludedGeometryList
32
+ ): Promise<File | undefined> {
33
+ this.exportPreProcess();
34
+ const glbData = await GLTF2Export.GLBAsync(
35
+ this.viewer.scene,
36
+ 'dummy',
37
+ this.gltfExportOptions(exportOptions, excluded)
38
+ );
39
+ this.exportPostProcess();
40
+ const resBlob = glbData.glTFFiles['dummy.glb']; // should be only one file for glb
41
+
42
+ // check if result is valid, according to the typings this could also be a string
43
+ if (resBlob instanceof Blob) {
44
+ if (!filename.endsWith('.glb')) {
45
+ filename += '.glb';
46
+ }
47
+ return new File([resBlob], filename);
48
+ } else {
49
+ // result was not a valid blob
50
+ return undefined;
51
+ }
52
+ }
53
+
54
+ /**
55
+ * Exports selected nodes to GLTF. This may result in more than one file, since textures are exported separately.
56
+ * @param filename name of the main (text-based) .GLTF file referring to separate texture files.
57
+ * @param exportOptions export options to be merged with default options.
58
+ * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export.
59
+ */
60
+ public async exportGltfToFile(filename: string, exportOptions: IExportOptions = {}, excluded?: ExcludedGeometryList) {
61
+ this.exportPreProcess();
62
+ await GLTF2Export.GLTFAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(
63
+ glb => {
64
+ glb.downloadFiles();
65
+ }
66
+ );
67
+ this.exportPostProcess();
68
+ }
69
+
70
+ /**
71
+ * Exports selected nodes to GLB. This results in one binary file.
72
+ * @param filename name of the .GLB file.
73
+ * @param exportOptions export options to be merged with default options.
74
+ * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
75
+ */
76
+ public async exportGlbToFile(filename: string, exportOptions: IExportOptions = {}, excluded?: ExcludedGeometryList) {
77
+ this.exportPreProcess();
78
+ await GLTF2Export.GLBAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(
79
+ glb => {
80
+ glb.downloadFiles();
81
+ }
82
+ );
83
+ this.exportPostProcess();
84
+ }
85
+
86
+ /**
87
+ * Gets predefined {@link IExportOptions } merged with given ones.
88
+ */
89
+ protected gltfExportOptions(mergeWithOptions: IExportOptions = {}, excluded?: ExcludedGeometryList): IExportOptions {
90
+ const defaultOptions = {
91
+ // includeCoordinateSystemConversionNodes: true,
92
+ shouldExportNode: function (node: any) {
93
+ if (!node.isEnabled()) {
94
+ return false;
95
+ }
96
+ if (node.isVisible === false) {
97
+ return false;
98
+ }
99
+ if (node.name === '__bounding_box__') {
100
+ return false;
101
+ }
102
+ if (excluded && node instanceof Mesh && isMeshIncludedInExclusionList(node, excluded)) {
103
+ return false;
104
+ }
105
+ return true;
106
+ },
107
+ };
108
+ return merge({}, defaultOptions, mergeWithOptions);
109
+ }
110
+
111
+ /**
112
+ * Stuff to be done before exporting to GLTF
113
+ */
114
+ protected exportPreProcess() {
115
+ this.viewer.pauseRendering();
116
+ this.exchangeRefractionMaterials();
117
+ }
118
+
119
+ /**
120
+ * Stuff to be done after the GLTF export
121
+ */
122
+ protected exportPostProcess() {
123
+ this.restoreRefractionMaterials();
124
+ this.viewer.resumeRendering();
125
+ }
126
+
127
+ /**
128
+ * Materials with refraction set are not exported properly.
129
+ * Exchange all such (relevant) materials with a more export-friendly version
130
+ */
131
+ protected exchangeRefractionMaterials() {
132
+ for (const n of this.viewer.scene.getNodes()) {
133
+ if (!(n instanceof AbstractMesh)) continue;
134
+ if (!(n.material instanceof PBRMaterial)) continue;
135
+ if (!(n.material as PBRMaterial).subSurface.isRefractionEnabled) continue;
136
+ if ((n.material as PBRMaterial).transparencyMode !== PBRMaterial.PBRMATERIAL_OPAQUE) continue;
137
+ // if we're here, we have a node holding a material with set refraction whose transparencyMode is set to PBRMATERIAL_OPAQUE
138
+ n.material = this.createRefractionMaterialReplacement(n.material);
139
+ }
140
+ }
141
+
142
+ /**
143
+ * Restore original materials with set refraction.
144
+ */
145
+ protected restoreRefractionMaterials() {
146
+ for (const n of this.viewer.scene.getNodes()) {
147
+ if (!(n instanceof AbstractMesh)) continue;
148
+ if (!(n.material instanceof PBRMaterial)) continue;
149
+ if (!this.isMaterialClonedForExport(n.material)) continue;
150
+ // at this point we have a pbrmaterial tagged as cloned in its metadata that's set on a mesh
151
+
152
+ // restore and dispose
153
+ const currMaterial = n.material;
154
+ const prevMaterial = this.viewer.scene.getMaterialByUniqueID(n.material.metadata.clonedFrom);
155
+ if (prevMaterial) {
156
+ n.material = prevMaterial; // restore previous material
157
+ currMaterial.dispose(false, true); // dispose of clone
158
+ }
159
+ }
160
+ }
161
+
162
+ /**
163
+ * Create an export-friendly replacement material for a material using refraction.
164
+ * @param mat Material to be replaced
165
+ */
166
+ protected createRefractionMaterialReplacement(mat: PBRMaterial): PBRMaterial {
167
+ // if we're dealing with a clone already, return it instead of cloning
168
+ if (this.isMaterialClonedForExport(mat)) return mat;
169
+
170
+ // change material according to https://www.notion.so/combeenation/Glas-materials-don-t-look-glasy-after-export-d5fda2c6515e4420a8772744d3e6b460
171
+ let clonedMaterial = mat.clone(mat.name); // clone material. clone uses same name
172
+ clonedMaterial.metadata = { ...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
173
+ clonedMaterial.refractionTexture = null;
174
+ clonedMaterial.metallicReflectanceTexture = null; // is this the correct one for metallic roughness?
175
+ clonedMaterial.alpha = 0.7;
176
+ clonedMaterial.albedoColor = new Color3(0.3, 0.3, 0.3);
177
+ clonedMaterial.transparencyMode = PBRMaterial.PBRMATERIAL_ALPHABLEND;
178
+ clonedMaterial.metallic = 0.65;
179
+ clonedMaterial.roughness = 0.15;
180
+
181
+ return clonedMaterial;
182
+ }
183
+
184
+ /**
185
+ * Inspect if a material was temporarily cloned for GLB export
186
+ * @param mat Material to be inspected
187
+ */
188
+ protected isMaterialClonedForExport(mat: PBRMaterial): boolean {
189
+ return !!mat.metadata?.clonedFrom;
190
+ }
191
+ }
@@ -1,127 +1,127 @@
1
- import { Camera } from '@babylonjs/core/Cameras/camera';
2
- import { Scene as BabylonScene } from '@babylonjs/core/scene';
3
- import { cloneDeep, concat, merge } from 'lodash-es';
4
- import { ParameterObservable } from '../classes/parameterObservable';
5
- import { Event } from '../classes/event';
6
- import { SpecStorage } from '../store/specStorage';
7
- import { mergeMaps } from '../util/resourceHelper';
8
- import { Parameter } from '../classes/parameter';
9
- import { changeEnvironment } from '../util/babylonHelper';
10
-
11
- export class SceneManager extends ParameterObservable {
12
- protected readonly _parameterObservers: Map<string, ParameterObserver[]> = new Map();
13
-
14
- /**
15
- * Constructor.
16
- */
17
- protected constructor(public scene: BabylonScene) {
18
- super();
19
- this.addParameterObservers();
20
- }
21
-
22
- /**
23
- * Creates a {@link SceneManager} based on given BabylonJS scene.
24
- */
25
- public static async create(scene: BabylonScene): Promise<SceneManager> {
26
- const sceneManager = new SceneManager(scene);
27
- await sceneManager.bootstrapParameters(SpecStorage.get<ParameterBag>('scene.parameters'));
28
- return sceneManager;
29
- }
30
-
31
- /**
32
- * The active `Camera`.
33
- */
34
- get activeCamera(): Camera {
35
- if (!this.scene.activeCamera) {
36
- throw new Error('Scene has no active camera.');
37
- }
38
- return this.scene.activeCamera;
39
- }
40
-
41
- /**
42
- * Places the given {@link ParameterBag} in the {@link SceneManager}'s parameters, replaces all patterns in the
43
- * {@link StructureJson} and broadcasts all {@link ParameterObserver}s.
44
- *
45
- * @emit {@link Event.SCENE_PARAMETER_COMMITTED}
46
- */
47
- public async commitParameters(parameters?: ParameterBag): Promise<SceneManager> {
48
- if (!parameters) {
49
- parameters = {};
50
- }
51
- const oldParameters = cloneDeep(this.parameters);
52
- merge(this.parameters, parameters);
53
-
54
- // handle parameter observers
55
- let observerPromises: Promise<void | ParameterObserver>[] = [];
56
- for (const parameter in this.parameters) {
57
- const oldParameterValue = oldParameters[parameter];
58
- const newParameterValue = this.parameters[parameter];
59
- this.assertParameter(Parameter.declarations, parameter, newParameterValue);
60
- if (oldParameterValue === newParameterValue) {
61
- continue;
62
- }
63
- // parameter changed
64
- const parameterObservers = mergeMaps(this._parameterObservers, this.parameterObservers);
65
- if (parameterObservers.has(parameter)) {
66
- const observers = parameterObservers.get(parameter)!;
67
- observerPromises = concat(
68
- observerPromises,
69
- observers.map(observer => {
70
- const observerResult = observer(this, oldParameterValue, newParameterValue);
71
- const observerPromise = Promise.resolve(observerResult);
72
- observerPromise.then(() => {
73
- this.broadcastEvent(
74
- Event.SCENE_PARAMETER_COMMITTED,
75
- this,
76
- parameter,
77
- oldParameterValue,
78
- newParameterValue
79
- );
80
- });
81
- return observerPromise;
82
- })
83
- );
84
- }
85
- }
86
- await Promise.all(observerPromises);
87
- return this;
88
- }
89
-
90
- protected addParameterObservers(): SceneManager {
91
- const handleEnvParamChange = (manager: SceneManager, oldValue: ParameterValue, newValue: ParameterValue) => {
92
- const params = {
93
- color: manager.parameters[Parameter.ENVIRONMENT_COLOR],
94
- intensity: manager.parameters[Parameter.ENVIRONMENT_INTENSITY],
95
- env: manager.parameters[Parameter.ENVIRONMENT],
96
- background: manager.parameters[Parameter.ENVIRONMENT_BACKGROUND],
97
- rotation: manager.parameters[Parameter.ENVIRONMENT_ROTATION],
98
- useDefault: manager.parameters[Parameter.ENVIRONMENT_USEDEFAULT],
99
- };
100
- const envDef: EnvironmentDefinition = {
101
- environmentColor: params.color ? Parameter.parseColor(params.color) : undefined,
102
- environmentIntensity: params.intensity !== undefined ? Parameter.parseNumber(params.intensity) : undefined,
103
- environment: params.env ? (params.env as string) : undefined,
104
- environmentBackground: params.background ? (params.background as string) : undefined,
105
- environmentRotation: params.rotation !== undefined ? Parameter.parseNumber(params.rotation) : undefined,
106
- environmentUseDefault: params.useDefault ? Parameter.parseBoolean(params.useDefault) : undefined,
107
- };
108
- changeEnvironment(manager.scene, envDef);
109
- };
110
-
111
- this._parameterObservers.set(Parameter.ENVIRONMENT_COLOR, [handleEnvParamChange]);
112
- this._parameterObservers.set(Parameter.ENVIRONMENT_ROTATION, [handleEnvParamChange]);
113
- this._parameterObservers.set(Parameter.ENVIRONMENT_USEDEFAULT, [handleEnvParamChange]);
114
- this._parameterObservers.set(Parameter.ENVIRONMENT, [handleEnvParamChange]);
115
- this._parameterObservers.set(Parameter.ENVIRONMENT_BACKGROUND, [handleEnvParamChange]);
116
- this._parameterObservers.set(Parameter.ENVIRONMENT_INTENSITY, [handleEnvParamChange]);
117
- return this;
118
- }
119
-
120
- /**
121
- * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
122
- */
123
- protected async bootstrapParameters(parameters?: ParameterBag): Promise<SceneManager> {
124
- await this.commitParameters(merge(cloneDeep(this.parameters), parameters));
125
- return this;
126
- }
127
- }
1
+ import { Event } from '../classes/event';
2
+ import { Parameter } from '../classes/parameter';
3
+ import { ParameterObservable } from '../classes/parameterObservable';
4
+ import { SpecStorage } from '../store/specStorage';
5
+ import { changeEnvironment } from '../util/babylonHelper';
6
+ import { mergeMaps } from '../util/resourceHelper';
7
+ import { Camera } from '@babylonjs/core/Cameras/camera';
8
+ import { Scene as BabylonScene } from '@babylonjs/core/scene';
9
+ import { cloneDeep, concat, merge } from 'lodash-es';
10
+
11
+ export class SceneManager extends ParameterObservable {
12
+ protected readonly _parameterObservers: Map<string, ParameterObserver[]> = new Map();
13
+
14
+ /**
15
+ * Constructor.
16
+ */
17
+ protected constructor(public scene: BabylonScene) {
18
+ super();
19
+ this.addParameterObservers();
20
+ }
21
+
22
+ /**
23
+ * Creates a {@link SceneManager} based on given BabylonJS scene.
24
+ */
25
+ public static async create(scene: BabylonScene): Promise<SceneManager> {
26
+ const sceneManager = new SceneManager(scene);
27
+ await sceneManager.bootstrapParameters(SpecStorage.get<ParameterBag>('scene.parameters'));
28
+ return sceneManager;
29
+ }
30
+
31
+ /**
32
+ * The active `Camera`.
33
+ */
34
+ get activeCamera(): Camera {
35
+ if (!this.scene.activeCamera) {
36
+ throw new Error('Scene has no active camera.');
37
+ }
38
+ return this.scene.activeCamera;
39
+ }
40
+
41
+ /**
42
+ * Places the given {@link ParameterBag} in the {@link SceneManager}'s parameters, replaces all patterns in the
43
+ * {@link StructureJson} and broadcasts all {@link ParameterObserver}s.
44
+ *
45
+ * @emit {@link Event.SCENE_PARAMETER_COMMITTED}
46
+ */
47
+ public async commitParameters(parameters?: ParameterBag): Promise<SceneManager> {
48
+ if (!parameters) {
49
+ parameters = {};
50
+ }
51
+ const oldParameters = cloneDeep(this.parameters);
52
+ merge(this.parameters, parameters);
53
+
54
+ // handle parameter observers
55
+ let observerPromises: Promise<void | ParameterObserver>[] = [];
56
+ for (const parameter in this.parameters) {
57
+ const oldParameterValue = oldParameters[parameter];
58
+ const newParameterValue = this.parameters[parameter];
59
+ this.assertParameter(Parameter.declarations, parameter, newParameterValue);
60
+ if (oldParameterValue === newParameterValue) {
61
+ continue;
62
+ }
63
+ // parameter changed
64
+ const parameterObservers = mergeMaps(this._parameterObservers, this.parameterObservers);
65
+ if (parameterObservers.has(parameter)) {
66
+ const observers = parameterObservers.get(parameter)!;
67
+ observerPromises = concat(
68
+ observerPromises,
69
+ observers.map(observer => {
70
+ const observerResult = observer(this, oldParameterValue, newParameterValue);
71
+ const observerPromise = Promise.resolve(observerResult);
72
+ observerPromise.then(() => {
73
+ this.broadcastEvent(
74
+ Event.SCENE_PARAMETER_COMMITTED,
75
+ this,
76
+ parameter,
77
+ oldParameterValue,
78
+ newParameterValue
79
+ );
80
+ });
81
+ return observerPromise;
82
+ })
83
+ );
84
+ }
85
+ }
86
+ await Promise.all(observerPromises);
87
+ return this;
88
+ }
89
+
90
+ protected addParameterObservers(): SceneManager {
91
+ const handleEnvParamChange = (manager: SceneManager, oldValue: ParameterValue, newValue: ParameterValue) => {
92
+ const params = {
93
+ color: manager.parameters[Parameter.ENVIRONMENT_COLOR],
94
+ intensity: manager.parameters[Parameter.ENVIRONMENT_INTENSITY],
95
+ env: manager.parameters[Parameter.ENVIRONMENT],
96
+ background: manager.parameters[Parameter.ENVIRONMENT_BACKGROUND],
97
+ rotation: manager.parameters[Parameter.ENVIRONMENT_ROTATION],
98
+ useDefault: manager.parameters[Parameter.ENVIRONMENT_USEDEFAULT],
99
+ };
100
+ const envDef: EnvironmentDefinition = {
101
+ environmentColor: params.color ? Parameter.parseColor(params.color) : undefined,
102
+ environmentIntensity: params.intensity !== undefined ? Parameter.parseNumber(params.intensity) : undefined,
103
+ environment: params.env ? (params.env as string) : undefined,
104
+ environmentBackground: params.background ? (params.background as string) : undefined,
105
+ environmentRotation: params.rotation !== undefined ? Parameter.parseNumber(params.rotation) : undefined,
106
+ environmentUseDefault: params.useDefault ? Parameter.parseBoolean(params.useDefault) : undefined,
107
+ };
108
+ changeEnvironment(manager.scene, envDef);
109
+ };
110
+
111
+ this._parameterObservers.set(Parameter.ENVIRONMENT_COLOR, [handleEnvParamChange]);
112
+ this._parameterObservers.set(Parameter.ENVIRONMENT_ROTATION, [handleEnvParamChange]);
113
+ this._parameterObservers.set(Parameter.ENVIRONMENT_USEDEFAULT, [handleEnvParamChange]);
114
+ this._parameterObservers.set(Parameter.ENVIRONMENT, [handleEnvParamChange]);
115
+ this._parameterObservers.set(Parameter.ENVIRONMENT_BACKGROUND, [handleEnvParamChange]);
116
+ this._parameterObservers.set(Parameter.ENVIRONMENT_INTENSITY, [handleEnvParamChange]);
117
+ return this;
118
+ }
119
+
120
+ /**
121
+ * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
122
+ */
123
+ protected async bootstrapParameters(parameters?: ParameterBag): Promise<SceneManager> {
124
+ await this.commitParameters(merge(cloneDeep(this.parameters), parameters));
125
+ return this;
126
+ }
127
+ }