@combeenation/3d-viewer 5.2.0-alpha5 → 6.1.0-beta1

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 (191) 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 +149 -149
  7. package/dist/lib-cjs/api/classes/element.js +669 -669
  8. package/dist/lib-cjs/api/classes/element.js.map +1 -1
  9. package/dist/lib-cjs/api/classes/event.d.ts +342 -326
  10. package/dist/lib-cjs/api/classes/event.js +365 -349
  11. package/dist/lib-cjs/api/classes/event.js.map +1 -1
  12. package/dist/lib-cjs/api/classes/eventBroadcaster.d.ts +26 -26
  13. package/dist/lib-cjs/api/classes/eventBroadcaster.js +49 -49
  14. package/dist/lib-cjs/api/classes/parameter.d.ts +339 -339
  15. package/dist/lib-cjs/api/classes/parameter.js +464 -464
  16. package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
  17. package/dist/lib-cjs/api/classes/parameterObservable.js +97 -97
  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 +234 -234
  23. package/dist/lib-cjs/api/classes/variant.js +836 -836
  24. package/dist/lib-cjs/api/classes/variant.js.map +1 -1
  25. package/dist/lib-cjs/api/classes/variantInstance.d.ts +44 -44
  26. package/dist/lib-cjs/api/classes/variantInstance.js +105 -105
  27. package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +17 -17
  28. package/dist/lib-cjs/api/classes/variantParameterizable.js +88 -88
  29. package/dist/lib-cjs/api/classes/viewer.d.ts +187 -189
  30. package/dist/lib-cjs/api/classes/viewer.js +594 -594
  31. package/dist/lib-cjs/api/classes/viewer.js.map +1 -1
  32. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
  33. package/dist/lib-cjs/api/classes/viewerLight.js +348 -348
  34. package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
  35. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  36. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
  37. package/dist/lib-cjs/api/internal/sceneSetup.js +226 -226
  38. package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
  39. package/dist/lib-cjs/api/manager/animationManager.js +126 -126
  40. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +78 -65
  41. package/dist/lib-cjs/api/manager/gltfExportManager.js +241 -197
  42. package/dist/lib-cjs/api/manager/gltfExportManager.js.map +1 -1
  43. package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -31
  44. package/dist/lib-cjs/api/manager/sceneManager.js +130 -127
  45. package/dist/lib-cjs/api/manager/sceneManager.js.map +1 -1
  46. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -0
  47. package/dist/lib-cjs/api/manager/textureLoadManager.js +98 -0
  48. package/dist/lib-cjs/api/manager/textureLoadManager.js.map +1 -0
  49. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +92 -92
  50. package/dist/lib-cjs/api/manager/variantInstanceManager.js +260 -260
  51. package/dist/lib-cjs/api/store/specStorage.d.ts +24 -24
  52. package/dist/lib-cjs/api/store/specStorage.js +50 -50
  53. package/dist/lib-cjs/api/util/babylonHelper.d.ts +183 -174
  54. package/dist/lib-cjs/api/util/babylonHelper.js +596 -585
  55. package/dist/lib-cjs/api/util/babylonHelper.js.map +1 -1
  56. package/dist/lib-cjs/api/util/globalTypes.d.ts +383 -370
  57. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  58. package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
  59. package/dist/lib-cjs/api/util/resourceHelper.js +203 -203
  60. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +42 -35
  61. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +139 -139
  62. package/dist/lib-cjs/api/util/sceneLoaderHelper.js.map +1 -1
  63. package/dist/lib-cjs/api/util/stringHelper.d.ts +9 -9
  64. package/dist/lib-cjs/api/util/stringHelper.js +25 -25
  65. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
  66. package/dist/lib-cjs/api/util/structureHelper.js +48 -48
  67. package/dist/lib-cjs/buildinfo.json +3 -3
  68. package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
  69. package/dist/lib-cjs/index.d.ts +51 -51
  70. package/dist/lib-cjs/index.js +110 -110
  71. package/dist/webpack-stats.json +0 -0
  72. package/package.json +79 -79
  73. package/src/api/classes/animationInterface.ts +10 -10
  74. package/src/api/classes/dottedPath.ts +181 -181
  75. package/src/api/classes/element.ts +717 -717
  76. package/src/api/classes/event.ts +385 -367
  77. package/src/api/classes/eventBroadcaster.ts +52 -52
  78. package/src/api/classes/parameter.ts +497 -497
  79. package/src/api/classes/parameterObservable.ts +100 -100
  80. package/src/api/classes/parameterizable.ts +87 -87
  81. package/src/api/classes/placementAnimation.ts +162 -162
  82. package/src/api/classes/variant.ts +904 -904
  83. package/src/api/classes/variantInstance.ts +97 -97
  84. package/src/api/classes/variantParameterizable.ts +85 -85
  85. package/src/api/classes/viewer.ts +672 -670
  86. package/src/api/classes/viewerLight.ts +339 -339
  87. package/src/api/internal/debugViewer.ts +90 -90
  88. package/src/api/internal/lensRendering.ts +9 -9
  89. package/src/api/internal/sceneSetup.ts +205 -205
  90. package/src/api/manager/animationManager.ts +143 -143
  91. package/src/api/manager/gltfExportManager.ts +236 -192
  92. package/src/api/manager/sceneManager.ts +132 -127
  93. package/src/api/manager/textureLoadManager.ts +95 -0
  94. package/src/api/manager/variantInstanceManager.ts +265 -265
  95. package/src/api/store/specStorage.ts +51 -51
  96. package/src/api/util/babylonHelper.ts +658 -645
  97. package/src/api/util/globalTypes.ts +432 -417
  98. package/src/api/util/resourceHelper.ts +191 -191
  99. package/src/api/util/sceneLoaderHelper.ts +137 -144
  100. package/src/api/util/stringHelper.ts +23 -23
  101. package/src/api/util/structureHelper.ts +49 -49
  102. package/src/buildinfo.json +3 -3
  103. package/src/dev.ts +61 -61
  104. package/src/index.ts +96 -96
  105. package/src/types.d.ts +28 -28
  106. package/dist/lib-es6/api/classes/animationInterface.d.ts +0 -8
  107. package/dist/lib-es6/api/classes/animationInterface.js +0 -2
  108. package/dist/lib-es6/api/classes/animationInterface.js.map +0 -1
  109. package/dist/lib-es6/api/classes/dottedPath.d.ts +0 -79
  110. package/dist/lib-es6/api/classes/dottedPath.js +0 -163
  111. package/dist/lib-es6/api/classes/dottedPath.js.map +0 -1
  112. package/dist/lib-es6/api/classes/element.d.ts +0 -149
  113. package/dist/lib-es6/api/classes/element.js +0 -666
  114. package/dist/lib-es6/api/classes/element.js.map +0 -1
  115. package/dist/lib-es6/api/classes/event.d.ts +0 -326
  116. package/dist/lib-es6/api/classes/event.js +0 -346
  117. package/dist/lib-es6/api/classes/event.js.map +0 -1
  118. package/dist/lib-es6/api/classes/eventBroadcaster.d.ts +0 -26
  119. package/dist/lib-es6/api/classes/eventBroadcaster.js +0 -43
  120. package/dist/lib-es6/api/classes/eventBroadcaster.js.map +0 -1
  121. package/dist/lib-es6/api/classes/parameter.d.ts +0 -339
  122. package/dist/lib-es6/api/classes/parameter.js +0 -461
  123. package/dist/lib-es6/api/classes/parameter.js.map +0 -1
  124. package/dist/lib-es6/api/classes/parameterObservable.d.ts +0 -36
  125. package/dist/lib-es6/api/classes/parameterObservable.js +0 -94
  126. package/dist/lib-es6/api/classes/parameterObservable.js.map +0 -1
  127. package/dist/lib-es6/api/classes/parameterizable.d.ts +0 -15
  128. package/dist/lib-es6/api/classes/parameterizable.js +0 -99
  129. package/dist/lib-es6/api/classes/parameterizable.js.map +0 -1
  130. package/dist/lib-es6/api/classes/placementAnimation.d.ts +0 -45
  131. package/dist/lib-es6/api/classes/placementAnimation.js +0 -173
  132. package/dist/lib-es6/api/classes/placementAnimation.js.map +0 -1
  133. package/dist/lib-es6/api/classes/variant.d.ts +0 -234
  134. package/dist/lib-es6/api/classes/variant.js +0 -833
  135. package/dist/lib-es6/api/classes/variant.js.map +0 -1
  136. package/dist/lib-es6/api/classes/variantInstance.d.ts +0 -44
  137. package/dist/lib-es6/api/classes/variantInstance.js +0 -102
  138. package/dist/lib-es6/api/classes/variantInstance.js.map +0 -1
  139. package/dist/lib-es6/api/classes/variantParameterizable.d.ts +0 -17
  140. package/dist/lib-es6/api/classes/variantParameterizable.js +0 -85
  141. package/dist/lib-es6/api/classes/variantParameterizable.js.map +0 -1
  142. package/dist/lib-es6/api/classes/viewer.d.ts +0 -189
  143. package/dist/lib-es6/api/classes/viewer.js +0 -588
  144. package/dist/lib-es6/api/classes/viewer.js.map +0 -1
  145. package/dist/lib-es6/api/classes/viewerLight.d.ts +0 -66
  146. package/dist/lib-es6/api/classes/viewerLight.js +0 -322
  147. package/dist/lib-es6/api/classes/viewerLight.js.map +0 -1
  148. package/dist/lib-es6/api/internal/lensRendering.d.ts +0 -8
  149. package/dist/lib-es6/api/internal/lensRendering.js +0 -9
  150. package/dist/lib-es6/api/internal/lensRendering.js.map +0 -1
  151. package/dist/lib-es6/api/internal/sceneSetup.d.ts +0 -13
  152. package/dist/lib-es6/api/internal/sceneSetup.js +0 -199
  153. package/dist/lib-es6/api/internal/sceneSetup.js.map +0 -1
  154. package/dist/lib-es6/api/manager/animationManager.d.ts +0 -30
  155. package/dist/lib-es6/api/manager/animationManager.js +0 -123
  156. package/dist/lib-es6/api/manager/animationManager.js.map +0 -1
  157. package/dist/lib-es6/api/manager/gltfExportManager.d.ts +0 -65
  158. package/dist/lib-es6/api/manager/gltfExportManager.js +0 -194
  159. package/dist/lib-es6/api/manager/gltfExportManager.js.map +0 -1
  160. package/dist/lib-es6/api/manager/sceneManager.d.ts +0 -31
  161. package/dist/lib-es6/api/manager/sceneManager.js +0 -124
  162. package/dist/lib-es6/api/manager/sceneManager.js.map +0 -1
  163. package/dist/lib-es6/api/manager/variantInstanceManager.d.ts +0 -92
  164. package/dist/lib-es6/api/manager/variantInstanceManager.js +0 -257
  165. package/dist/lib-es6/api/manager/variantInstanceManager.js.map +0 -1
  166. package/dist/lib-es6/api/store/specStorage.d.ts +0 -24
  167. package/dist/lib-es6/api/store/specStorage.js +0 -47
  168. package/dist/lib-es6/api/store/specStorage.js.map +0 -1
  169. package/dist/lib-es6/api/util/babylonHelper.d.ts +0 -174
  170. package/dist/lib-es6/api/util/babylonHelper.js +0 -556
  171. package/dist/lib-es6/api/util/babylonHelper.js.map +0 -1
  172. package/dist/lib-es6/api/util/globalTypes.d.ts +0 -370
  173. package/dist/lib-es6/api/util/globalTypes.js +0 -2
  174. package/dist/lib-es6/api/util/globalTypes.js.map +0 -1
  175. package/dist/lib-es6/api/util/resourceHelper.d.ts +0 -58
  176. package/dist/lib-es6/api/util/resourceHelper.js +0 -194
  177. package/dist/lib-es6/api/util/resourceHelper.js.map +0 -1
  178. package/dist/lib-es6/api/util/sceneLoaderHelper.d.ts +0 -35
  179. package/dist/lib-es6/api/util/sceneLoaderHelper.js +0 -130
  180. package/dist/lib-es6/api/util/sceneLoaderHelper.js.map +0 -1
  181. package/dist/lib-es6/api/util/stringHelper.d.ts +0 -9
  182. package/dist/lib-es6/api/util/stringHelper.js +0 -22
  183. package/dist/lib-es6/api/util/stringHelper.js.map +0 -1
  184. package/dist/lib-es6/api/util/structureHelper.d.ts +0 -9
  185. package/dist/lib-es6/api/util/structureHelper.js +0 -46
  186. package/dist/lib-es6/api/util/structureHelper.js.map +0 -1
  187. package/dist/lib-es6/buildinfo.json +0 -3
  188. package/dist/lib-es6/es6.tsconfig.tsbuildinfo +0 -1
  189. package/dist/lib-es6/index.d.ts +0 -51
  190. package/dist/lib-es6/index.js +0 -49
  191. package/dist/lib-es6/index.js.map +0 -1
@@ -1,2 +1,2 @@
1
- "use strict";
1
+ "use strict";
2
2
  //# sourceMappingURL=globalTypes.js.map
@@ -1,58 +1,58 @@
1
- /**
2
- * Sleeps for a certain amount of microseconds.
3
- */
4
- declare const sleep: (ms: number) => Promise<unknown>;
5
- /**
6
- * Loads a JSON from a given path.
7
- * @emits {@link Event.LOADING_START}
8
- * @emits {@link Event.LOADING_END}
9
- */
10
- declare const loadJson: <T>(path: string) => Promise<T>;
11
- /**
12
- * Loads a Text from a given path.
13
- * @emits {@link Event.LOADING_START}
14
- * @emits {@link Event.LOADING_END}
15
- */
16
- declare const loadText: (path: string) => Promise<string>;
17
- /**
18
- * Loads a Javascript ressource.\
19
- * Usefull for including packages via CDN (eg: BabylonJS Inspector)
20
- */
21
- declare const loadJavascript: (url: string) => Promise<void>;
22
- /**
23
- * Debounces: it limits the rate at which a function can fire.
24
- */
25
- declare const debounce: (func: Function, wait: number, immediate?: boolean) => () => void;
26
- /**
27
- * Merges multiple maps.
28
- */
29
- declare const mergeMaps: <TKey, TValue>(...maps: Map<TKey, TValue>[]) => Map<TKey, TValue>;
30
- /**
31
- * Creates a HTML image element based on a SVG string, whereas all the embedded assets in the SVG (eg: fonts, images)
32
- * are already loaded and exchanged by their base64 representation.\
33
- * There the output image can exist as "standalone" image and may be used for example as a paintable.
34
- *
35
- * !!CAUTION!!: The used functions within this code section are very well evaluated since most alternatives
36
- * somehow don't work in Safari, as mentioned in the following BJS forum entries:
37
- * - https://forum.babylonjs.com/t/drawing-svg-content-text-into-dynamictexture-doesnt-work-in-safari-v15/25048
38
- * - https://forum.babylonjs.com/t/texture-createfrombase64string-doesnt-seem-to-work-for-ios-devices-initially/25502
39
- */
40
- declare const createImageFromSvg: (svgSrc: string) => Promise<HTMLImageElement>;
41
- /**
42
- * Creates an HTML image element from a dedicated image source.\
43
- * Also waits until the image has loaded.
44
- *
45
- * !!CAUTION!!: The `setTimeout` after loading is finished is required due to a Safari bug:
46
- * - https://bugs.webkit.org/show_bug.cgi?id=39059
47
- * - https://bugs.webkit.org/show_bug.cgi?id=219770
48
- *
49
- * It's not 100% ensured that the timeout solves the issue in every case, but there is no other way unfortunately.\
50
- * => Keep an eye on it in future projects
51
- *
52
- * @param imgSrc Theoretically every source is valid which is also supported by
53
- * [HTMLImageElement.src](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/src).\
54
- * Known exceptions are SVGs with embedded assets that are provided as object URL. See comments in
55
- * {@link createImageFromSvg} for further details.
56
- */
57
- declare const createImageFromImgSrc: (imgSrc: string) => Promise<HTMLImageElement>;
58
- export { sleep, loadJson, loadText, loadJavascript, debounce, mergeMaps, createImageFromSvg, createImageFromImgSrc };
1
+ /**
2
+ * Sleeps for a certain amount of microseconds.
3
+ */
4
+ declare const sleep: (ms: number) => Promise<unknown>;
5
+ /**
6
+ * Loads a JSON from a given path.
7
+ * @emits {@link Event.LOADING_START}
8
+ * @emits {@link Event.LOADING_END}
9
+ */
10
+ declare const loadJson: <T>(path: string) => Promise<T>;
11
+ /**
12
+ * Loads a Text from a given path.
13
+ * @emits {@link Event.LOADING_START}
14
+ * @emits {@link Event.LOADING_END}
15
+ */
16
+ declare const loadText: (path: string) => Promise<string>;
17
+ /**
18
+ * Loads a Javascript ressource.\
19
+ * Usefull for including packages via CDN (eg: BabylonJS Inspector)
20
+ */
21
+ declare const loadJavascript: (url: string) => Promise<void>;
22
+ /**
23
+ * Debounces: it limits the rate at which a function can fire.
24
+ */
25
+ declare const debounce: (func: Function, wait: number, immediate?: boolean) => () => void;
26
+ /**
27
+ * Merges multiple maps.
28
+ */
29
+ declare const mergeMaps: <TKey, TValue>(...maps: Map<TKey, TValue>[]) => Map<TKey, TValue>;
30
+ /**
31
+ * Creates a HTML image element based on a SVG string, whereas all the embedded assets in the SVG (eg: fonts, images)
32
+ * are already loaded and exchanged by their base64 representation.\
33
+ * There the output image can exist as "standalone" image and may be used for example as a paintable.
34
+ *
35
+ * !!CAUTION!!: The used functions within this code section are very well evaluated since most alternatives
36
+ * somehow don't work in Safari, as mentioned in the following BJS forum entries:
37
+ * - https://forum.babylonjs.com/t/drawing-svg-content-text-into-dynamictexture-doesnt-work-in-safari-v15/25048
38
+ * - https://forum.babylonjs.com/t/texture-createfrombase64string-doesnt-seem-to-work-for-ios-devices-initially/25502
39
+ */
40
+ declare const createImageFromSvg: (svgSrc: string) => Promise<HTMLImageElement>;
41
+ /**
42
+ * Creates an HTML image element from a dedicated image source.\
43
+ * Also waits until the image has loaded.
44
+ *
45
+ * !!CAUTION!!: The `setTimeout` after loading is finished is required due to a Safari bug:
46
+ * - https://bugs.webkit.org/show_bug.cgi?id=39059
47
+ * - https://bugs.webkit.org/show_bug.cgi?id=219770
48
+ *
49
+ * It's not 100% ensured that the timeout solves the issue in every case, but there is no other way unfortunately.\
50
+ * => Keep an eye on it in future projects
51
+ *
52
+ * @param imgSrc Theoretically every source is valid which is also supported by
53
+ * [HTMLImageElement.src](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/src).\
54
+ * Known exceptions are SVGs with embedded assets that are provided as object URL. See comments in
55
+ * {@link createImageFromSvg} for further details.
56
+ */
57
+ declare const createImageFromImgSrc: (imgSrc: string) => Promise<HTMLImageElement>;
58
+ export { sleep, loadJson, loadText, loadJavascript, debounce, mergeMaps, createImageFromSvg, createImageFromImgSrc };
@@ -1,204 +1,204 @@
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
- Object.defineProperty(exports, "__esModule", { value: true });
12
- exports.createImageFromImgSrc = exports.createImageFromSvg = exports.mergeMaps = exports.debounce = exports.loadJavascript = exports.loadText = exports.loadJson = exports.sleep = void 0;
13
- const event_1 = require("../classes/event");
14
- /**
15
- * Sleeps for a certain amount of microseconds.
16
- */
17
- const sleep = (ms) => new Promise(resolve => window.setTimeout(resolve, ms));
18
- exports.sleep = sleep;
19
- /**
20
- * Loads any kind of response from given path.
21
- * @emits {@link Event.LOADING_START}
22
- * @emits {@link Event.LOADING_END}
23
- */
24
- const load = function (path) {
25
- return __awaiter(this, void 0, void 0, function* () {
26
- event_1.emitter.emit(event_1.Event.LOADING_START, path);
27
- const data = yield fetch(path);
28
- event_1.emitter.emit(event_1.Event.LOADING_END, path);
29
- return data;
30
- });
31
- };
32
- /**
33
- * Loads a JSON from a given path.
34
- * @emits {@link Event.LOADING_START}
35
- * @emits {@link Event.LOADING_END}
36
- */
37
- const loadJson = function (path) {
38
- return __awaiter(this, void 0, void 0, function* () {
39
- const response = yield load(path);
40
- return response.json();
41
- });
42
- };
43
- exports.loadJson = loadJson;
44
- /**
45
- * Loads a Text from a given path.
46
- * @emits {@link Event.LOADING_START}
47
- * @emits {@link Event.LOADING_END}
48
- */
49
- const loadText = function (path) {
50
- return __awaiter(this, void 0, void 0, function* () {
51
- const response = yield load(path);
52
- return response.text();
53
- });
54
- };
55
- exports.loadText = loadText;
56
- /**
57
- * Loads a Javascript ressource.\
58
- * Usefull for including packages via CDN (eg: BabylonJS Inspector)
59
- */
60
- const loadJavascript = (url) => new Promise(resolve => {
61
- const scriptEl = document.createElement('script');
62
- scriptEl.setAttribute('src', url);
63
- scriptEl.setAttribute('type', 'text/javascript');
64
- scriptEl.setAttribute('crossorigin', 'anonymous');
65
- scriptEl.onload = () => resolve();
66
- document.head.appendChild(scriptEl);
67
- });
68
- exports.loadJavascript = loadJavascript;
69
- /**
70
- * Debounces: it limits the rate at which a function can fire.
71
- */
72
- const debounce = function (func, wait, immediate = false) {
73
- let timeout;
74
- return function () {
75
- // @ts-ignore this function is not very "ESLint friendly", also see ESLint disable comment 2 lines below
76
- // => take some time to refactor this function when there is time
77
- const context = this;
78
- // eslint-disable-next-line prefer-rest-params
79
- const args = arguments;
80
- const later = function () {
81
- timeout = null;
82
- if (!immediate) {
83
- func.apply(context, args);
84
- }
85
- };
86
- const callNow = immediate && !timeout;
87
- clearTimeout(timeout);
88
- timeout = setTimeout(later, wait);
89
- if (callNow) {
90
- func.apply(context, args);
91
- }
92
- };
93
- };
94
- exports.debounce = debounce;
95
- /**
96
- * Merges multiple maps.
97
- */
98
- const mergeMaps = function (...maps) {
99
- const resultMap = new Map();
100
- maps.forEach(map => {
101
- map.forEach((v, k) => {
102
- resultMap.set(k, v);
103
- });
104
- });
105
- return resultMap;
106
- };
107
- exports.mergeMaps = mergeMaps;
108
- /**
109
- * Creates a HTML image element based on a SVG string, whereas all the embedded assets in the SVG (eg: fonts, images)
110
- * are already loaded and exchanged by their base64 representation.\
111
- * There the output image can exist as "standalone" image and may be used for example as a paintable.
112
- *
113
- * !!CAUTION!!: The used functions within this code section are very well evaluated since most alternatives
114
- * somehow don't work in Safari, as mentioned in the following BJS forum entries:
115
- * - https://forum.babylonjs.com/t/drawing-svg-content-text-into-dynamictexture-doesnt-work-in-safari-v15/25048
116
- * - https://forum.babylonjs.com/t/texture-createfrombase64string-doesnt-seem-to-work-for-ios-devices-initially/25502
117
- */
118
- const createImageFromSvg = function (svgSrc) {
119
- return __awaiter(this, void 0, void 0, function* () {
120
- // replace assets with their base64 versions in svg source code
121
- const svgWithAssetsEmbedded = yield _embedAssets(svgSrc);
122
- // create data string which can be used as an image source
123
- const svgEncoded = 'data:image/svg+xml,' + encodeURIComponent(svgWithAssetsEmbedded);
124
- return createImageFromImgSrc(svgEncoded);
125
- });
126
- };
127
- exports.createImageFromSvg = createImageFromSvg;
128
- /**
129
- * Creates an HTML image element from a dedicated image source.\
130
- * Also waits until the image has loaded.
131
- *
132
- * !!CAUTION!!: The `setTimeout` after loading is finished is required due to a Safari bug:
133
- * - https://bugs.webkit.org/show_bug.cgi?id=39059
134
- * - https://bugs.webkit.org/show_bug.cgi?id=219770
135
- *
136
- * It's not 100% ensured that the timeout solves the issue in every case, but there is no other way unfortunately.\
137
- * => Keep an eye on it in future projects
138
- *
139
- * @param imgSrc Theoretically every source is valid which is also supported by
140
- * [HTMLImageElement.src](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/src).\
141
- * Known exceptions are SVGs with embedded assets that are provided as object URL. See comments in
142
- * {@link createImageFromSvg} for further details.
143
- */
144
- const createImageFromImgSrc = function (imgSrc) {
145
- return __awaiter(this, void 0, void 0, function* () {
146
- const img = new Image();
147
- yield new Promise(resolve => {
148
- img.onload = () => {
149
- setTimeout(resolve, 0);
150
- };
151
- img.src = imgSrc;
152
- });
153
- return img;
154
- });
155
- };
156
- exports.createImageFromImgSrc = createImageFromImgSrc;
157
- /**
158
- * Replaces all supported image & font URLs in the given SVG with their base64 representation.
159
- */
160
- const _embedAssets = function (svgSrc) {
161
- return __awaiter(this, void 0, void 0, function* () {
162
- const _imageExtensions = ['png', 'gif', 'jpg', 'jpeg', 'svg', 'bmp'];
163
- const _fontExtensions = ['woff2', 'woff', 'ttf', 'otf'];
164
- const _assetExtensions = [..._imageExtensions, ..._fontExtensions];
165
- // Regex copied from https://stackoverflow.com/a/8943487/1273551, not "stress tested"...
166
- const urlRegex = /(\bhttps?:\/\/[-A-Z0-9+&@#/%?=~_|!:,.;]*[-A-Z0-9+&@#/%=~_|])/gi;
167
- const allUrls = svgSrc.match(urlRegex);
168
- const assetUrls = allUrls.filter(url => _assetExtensions.some(extension => url.toLowerCase().endsWith(`.${extension}`)));
169
- const assetBase64Fetcher = assetUrls.map(_fetchBase64AssetUrl);
170
- const assetFetcherResults = yield Promise.all(assetBase64Fetcher);
171
- return assetFetcherResults.reduce((svgSrc, x) => svgSrc.replace(x.url, x.base64), svgSrc);
172
- });
173
- };
174
- /**
175
- * Fetch asset (image or font) and convert it to base64 string representation.
176
- */
177
- const _fetchBase64AssetUrl = function (assetUrl) {
178
- return __awaiter(this, void 0, void 0, function* () {
179
- // TODO: Cache known base64 representation and only fetch/convert when not already known.
180
- // Usually the fetch shouldn't hit the network but the browser cache since the SVG was already drawn.
181
- // See comments of "createImageBitmapFromSvg" for some considerations...
182
- return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
183
- const resp = yield fetch(assetUrl);
184
- const blob = yield resp.blob();
185
- const reader = new FileReader();
186
- reader.onloadend = event => {
187
- const target = event.target;
188
- if (!target) {
189
- return reject(`Asset with URL "${assetUrl}" could not be loaded.`);
190
- }
191
- const result = target.result;
192
- if (!result) {
193
- return reject(`Asset with URL "${assetUrl}" returned an empty result.`);
194
- }
195
- resolve({
196
- url: assetUrl,
197
- base64: result.toString(),
198
- });
199
- };
200
- reader.readAsDataURL(blob);
201
- }));
202
- });
203
- };
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
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.createImageFromImgSrc = exports.createImageFromSvg = exports.mergeMaps = exports.debounce = exports.loadJavascript = exports.loadText = exports.loadJson = exports.sleep = void 0;
13
+ const event_1 = require("../classes/event");
14
+ /**
15
+ * Sleeps for a certain amount of microseconds.
16
+ */
17
+ const sleep = (ms) => new Promise(resolve => window.setTimeout(resolve, ms));
18
+ exports.sleep = sleep;
19
+ /**
20
+ * Loads any kind of response from given path.
21
+ * @emits {@link Event.LOADING_START}
22
+ * @emits {@link Event.LOADING_END}
23
+ */
24
+ const load = function (path) {
25
+ return __awaiter(this, void 0, void 0, function* () {
26
+ event_1.emitter.emit(event_1.Event.LOADING_START, path);
27
+ const data = yield fetch(path);
28
+ event_1.emitter.emit(event_1.Event.LOADING_END, path);
29
+ return data;
30
+ });
31
+ };
32
+ /**
33
+ * Loads a JSON from a given path.
34
+ * @emits {@link Event.LOADING_START}
35
+ * @emits {@link Event.LOADING_END}
36
+ */
37
+ const loadJson = function (path) {
38
+ return __awaiter(this, void 0, void 0, function* () {
39
+ const response = yield load(path);
40
+ return response.json();
41
+ });
42
+ };
43
+ exports.loadJson = loadJson;
44
+ /**
45
+ * Loads a Text from a given path.
46
+ * @emits {@link Event.LOADING_START}
47
+ * @emits {@link Event.LOADING_END}
48
+ */
49
+ const loadText = function (path) {
50
+ return __awaiter(this, void 0, void 0, function* () {
51
+ const response = yield load(path);
52
+ return response.text();
53
+ });
54
+ };
55
+ exports.loadText = loadText;
56
+ /**
57
+ * Loads a Javascript ressource.\
58
+ * Usefull for including packages via CDN (eg: BabylonJS Inspector)
59
+ */
60
+ const loadJavascript = (url) => new Promise(resolve => {
61
+ const scriptEl = document.createElement('script');
62
+ scriptEl.setAttribute('src', url);
63
+ scriptEl.setAttribute('type', 'text/javascript');
64
+ scriptEl.setAttribute('crossorigin', 'anonymous');
65
+ scriptEl.onload = () => resolve();
66
+ document.head.appendChild(scriptEl);
67
+ });
68
+ exports.loadJavascript = loadJavascript;
69
+ /**
70
+ * Debounces: it limits the rate at which a function can fire.
71
+ */
72
+ const debounce = function (func, wait, immediate = false) {
73
+ let timeout;
74
+ return function () {
75
+ // @ts-ignore this function is not very "ESLint friendly", also see ESLint disable comment 2 lines below
76
+ // => take some time to refactor this function when there is time
77
+ const context = this;
78
+ // eslint-disable-next-line prefer-rest-params
79
+ const args = arguments;
80
+ const later = function () {
81
+ timeout = null;
82
+ if (!immediate) {
83
+ func.apply(context, args);
84
+ }
85
+ };
86
+ const callNow = immediate && !timeout;
87
+ clearTimeout(timeout);
88
+ timeout = setTimeout(later, wait);
89
+ if (callNow) {
90
+ func.apply(context, args);
91
+ }
92
+ };
93
+ };
94
+ exports.debounce = debounce;
95
+ /**
96
+ * Merges multiple maps.
97
+ */
98
+ const mergeMaps = function (...maps) {
99
+ const resultMap = new Map();
100
+ maps.forEach(map => {
101
+ map.forEach((v, k) => {
102
+ resultMap.set(k, v);
103
+ });
104
+ });
105
+ return resultMap;
106
+ };
107
+ exports.mergeMaps = mergeMaps;
108
+ /**
109
+ * Creates a HTML image element based on a SVG string, whereas all the embedded assets in the SVG (eg: fonts, images)
110
+ * are already loaded and exchanged by their base64 representation.\
111
+ * There the output image can exist as "standalone" image and may be used for example as a paintable.
112
+ *
113
+ * !!CAUTION!!: The used functions within this code section are very well evaluated since most alternatives
114
+ * somehow don't work in Safari, as mentioned in the following BJS forum entries:
115
+ * - https://forum.babylonjs.com/t/drawing-svg-content-text-into-dynamictexture-doesnt-work-in-safari-v15/25048
116
+ * - https://forum.babylonjs.com/t/texture-createfrombase64string-doesnt-seem-to-work-for-ios-devices-initially/25502
117
+ */
118
+ const createImageFromSvg = function (svgSrc) {
119
+ return __awaiter(this, void 0, void 0, function* () {
120
+ // replace assets with their base64 versions in svg source code
121
+ const svgWithAssetsEmbedded = yield _embedAssets(svgSrc);
122
+ // create data string which can be used as an image source
123
+ const svgEncoded = 'data:image/svg+xml,' + encodeURIComponent(svgWithAssetsEmbedded);
124
+ return createImageFromImgSrc(svgEncoded);
125
+ });
126
+ };
127
+ exports.createImageFromSvg = createImageFromSvg;
128
+ /**
129
+ * Creates an HTML image element from a dedicated image source.\
130
+ * Also waits until the image has loaded.
131
+ *
132
+ * !!CAUTION!!: The `setTimeout` after loading is finished is required due to a Safari bug:
133
+ * - https://bugs.webkit.org/show_bug.cgi?id=39059
134
+ * - https://bugs.webkit.org/show_bug.cgi?id=219770
135
+ *
136
+ * It's not 100% ensured that the timeout solves the issue in every case, but there is no other way unfortunately.\
137
+ * => Keep an eye on it in future projects
138
+ *
139
+ * @param imgSrc Theoretically every source is valid which is also supported by
140
+ * [HTMLImageElement.src](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/src).\
141
+ * Known exceptions are SVGs with embedded assets that are provided as object URL. See comments in
142
+ * {@link createImageFromSvg} for further details.
143
+ */
144
+ const createImageFromImgSrc = function (imgSrc) {
145
+ return __awaiter(this, void 0, void 0, function* () {
146
+ const img = new Image();
147
+ yield new Promise(resolve => {
148
+ img.onload = () => {
149
+ setTimeout(resolve, 0);
150
+ };
151
+ img.src = imgSrc;
152
+ });
153
+ return img;
154
+ });
155
+ };
156
+ exports.createImageFromImgSrc = createImageFromImgSrc;
157
+ /**
158
+ * Replaces all supported image & font URLs in the given SVG with their base64 representation.
159
+ */
160
+ const _embedAssets = function (svgSrc) {
161
+ return __awaiter(this, void 0, void 0, function* () {
162
+ const _imageExtensions = ['png', 'gif', 'jpg', 'jpeg', 'svg', 'bmp'];
163
+ const _fontExtensions = ['woff2', 'woff', 'ttf', 'otf'];
164
+ const _assetExtensions = [..._imageExtensions, ..._fontExtensions];
165
+ // Regex copied from https://stackoverflow.com/a/8943487/1273551, not "stress tested"...
166
+ const urlRegex = /(\bhttps?:\/\/[-A-Z0-9+&@#/%?=~_|!:,.;]*[-A-Z0-9+&@#/%=~_|])/gi;
167
+ const allUrls = svgSrc.match(urlRegex);
168
+ const assetUrls = allUrls.filter(url => _assetExtensions.some(extension => url.toLowerCase().endsWith(`.${extension}`)));
169
+ const assetBase64Fetcher = assetUrls.map(_fetchBase64AssetUrl);
170
+ const assetFetcherResults = yield Promise.all(assetBase64Fetcher);
171
+ return assetFetcherResults.reduce((svgSrc, x) => svgSrc.replace(x.url, x.base64), svgSrc);
172
+ });
173
+ };
174
+ /**
175
+ * Fetch asset (image or font) and convert it to base64 string representation.
176
+ */
177
+ const _fetchBase64AssetUrl = function (assetUrl) {
178
+ return __awaiter(this, void 0, void 0, function* () {
179
+ // TODO: Cache known base64 representation and only fetch/convert when not already known.
180
+ // Usually the fetch shouldn't hit the network but the browser cache since the SVG was already drawn.
181
+ // See comments of "createImageBitmapFromSvg" for some considerations...
182
+ return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
183
+ const resp = yield fetch(assetUrl);
184
+ const blob = yield resp.blob();
185
+ const reader = new FileReader();
186
+ reader.onloadend = event => {
187
+ const target = event.target;
188
+ if (!target) {
189
+ return reject(`Asset with URL "${assetUrl}" could not be loaded.`);
190
+ }
191
+ const result = target.result;
192
+ if (!result) {
193
+ return reject(`Asset with URL "${assetUrl}" returned an empty result.`);
194
+ }
195
+ resolve({
196
+ url: assetUrl,
197
+ base64: result.toString(),
198
+ });
199
+ };
200
+ reader.readAsDataURL(blob);
201
+ }));
202
+ });
203
+ };
204
204
  //# sourceMappingURL=resourceHelper.js.map
@@ -1,35 +1,42 @@
1
- import { ISceneLoaderPlugin } from '@babylonjs/core/Loading/sceneLoader';
2
- import { Material } from '@babylonjs/core/Materials/material';
3
- import { Node as BjsNode } from '@babylonjs/core/node';
4
- import { Scene } from '@babylonjs/core/scene';
5
- declare const missingMaterialMetadataName = "missingMaterial";
6
- /**
7
- * Create and return a custom loader plugin to be registered with SceneLoader, that allows
8
- * us to run our own code against the input data before using the standard procedure to
9
- * import.
10
- * @param previousLoaderPlugin the actual loader that's executed after manipulating the input data
11
- * @returns Custom loader plugin to be registered with SceneLoader.RegisterPlugin()
12
- */
13
- declare const getCustomCbnBabylonLoaderPlugin: (previousLoaderPlugin: ISceneLoaderPlugin) => ISceneLoaderPlugin;
14
- /**
15
- * Return an observer to be applied to meshes in order to post-load missing materials
16
- * upon set enabled/visible.
17
- * @param targetMeshOrInstance AbstractMesh the observer will be applied to
18
- * @param concerningMesh Mesh to look for missing materials on, and create/apply to (when found).
19
- * @returns observer
20
- */
21
- declare const getMaterialPostLoadObserver: (targetMeshOrInstance: AbstractMesh, concerningMesh: Mesh) => () => void;
22
- /**
23
- * Adds an "onEnabledStateChanged" observer to the given mesh and all its parents:
24
- * The added observer (`getMaterialPostLoadObserver`) handles creation of missing materials once the given node is
25
- * enabled.
26
- */
27
- declare const addMissingMaterialObserver: (node: BjsNode) => void;
28
- /**
29
- * Look up the provided materials (see library import) and create and return one if found.
30
- * @param materialId BabylonJs material-id. E.g. 'concrete".
31
- * @param scene BabylonJs scene
32
- * @returns PBRMaterial | null
33
- */
34
- export declare const createMaterialFromCbnAssets: (materialId: string, scene: Scene) => Material | null;
35
- export { getCustomCbnBabylonLoaderPlugin, getMaterialPostLoadObserver, missingMaterialMetadataName, addMissingMaterialObserver, };
1
+ import { ISceneLoaderPlugin } from '@babylonjs/core/Loading/sceneLoader';
2
+ import { Material } from '@babylonjs/core/Materials/material';
3
+ import { AssetContainer } from '@babylonjs/core/assetContainer';
4
+ import { Node as BjsNode } from '@babylonjs/core/node';
5
+ import { Scene } from '@babylonjs/core/scene';
6
+ export declare const missingMaterialMetadataName = "missingMaterial";
7
+ /**
8
+ * Create and return a custom loader plugin to be registered with SceneLoader, that allows
9
+ * us to run our own code against the input data before using the standard procedure to
10
+ * import.
11
+ * @param previousLoaderPlugin the actual loader that's executed after manipulating the input data
12
+ * @returns Custom loader plugin to be registered with SceneLoader.RegisterPlugin()
13
+ */
14
+ export declare const getCustomCbnBabylonLoaderPlugin: (previousLoaderPlugin: ISceneLoaderPlugin) => ISceneLoaderPlugin;
15
+ /**
16
+ * Return an observer to be applied to meshes in order to post-load missing materials
17
+ * upon set enabled/visible.
18
+ * @param targetMeshOrInstance AbstractMesh the observer will be applied to
19
+ * @param concerningMesh Mesh to look for missing materials on, and create/apply to (when found).
20
+ * @returns observer
21
+ */
22
+ export declare const getMaterialPostLoadObserver: (targetMeshOrInstance: AbstractMesh, concerningMesh: Mesh) => (eventData: any, eventState: any) => void;
23
+ /**
24
+ * Internal function that compares the original meshes on a .babylon file with what was loaded,
25
+ * and tags missing materials with respective metadata on respective meshes.
26
+ * @param dataParsed original data
27
+ * @param container loaded data
28
+ */
29
+ export declare const addMissingMaterialMetadata: (dataParsed: any, container: AssetContainer) => void;
30
+ /**
31
+ * Adds an "onEnabledStateChanged" observer to the given mesh and all its parents:
32
+ * The added observer (`getMaterialPostLoadObserver`) handles creation of missing materials once the given node is
33
+ * enabled.
34
+ */
35
+ export declare const addMissingMaterialObserver: (node: BjsNode) => void;
36
+ /**
37
+ * Look up the provided materials (see library import) and create and return one if found.
38
+ * @param materialId BabylonJs material-id. E.g. 'concrete".
39
+ * @param scene BabylonJs scene
40
+ * @returns PBRMaterial | null
41
+ */
42
+ export declare const createMaterialFromCbnAssets: (materialId: string, scene: Scene) => Material | null;