@combeenation/3d-viewer 12.4.1 → 12.4.3

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 (114) hide show
  1. package/README.md +9 -9
  2. package/dist/lib-cjs/api/classes/animationInterface.d.ts +8 -8
  3. package/dist/lib-cjs/api/classes/animationInterface.js +2 -2
  4. package/dist/lib-cjs/api/classes/dottedPath.d.ts +79 -79
  5. package/dist/lib-cjs/api/classes/dottedPath.js +166 -166
  6. package/dist/lib-cjs/api/classes/element.d.ts +153 -153
  7. package/dist/lib-cjs/api/classes/element.js +702 -702
  8. package/dist/lib-cjs/api/classes/event.d.ts +401 -401
  9. package/dist/lib-cjs/api/classes/event.js +424 -424
  10. package/dist/lib-cjs/api/classes/eventBroadcaster.d.ts +26 -26
  11. package/dist/lib-cjs/api/classes/eventBroadcaster.js +49 -49
  12. package/dist/lib-cjs/api/classes/fuzzyMap.d.ts +7 -7
  13. package/dist/lib-cjs/api/classes/fuzzyMap.js +21 -21
  14. package/dist/lib-cjs/api/classes/parameter.d.ts +410 -410
  15. package/dist/lib-cjs/api/classes/parameter.js +642 -642
  16. package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
  17. package/dist/lib-cjs/api/classes/parameterObservable.js +72 -72
  18. package/dist/lib-cjs/api/classes/parameterizable.d.ts +15 -15
  19. package/dist/lib-cjs/api/classes/parameterizable.js +102 -102
  20. package/dist/lib-cjs/api/classes/placementAnimation.d.ts +45 -45
  21. package/dist/lib-cjs/api/classes/placementAnimation.js +176 -176
  22. package/dist/lib-cjs/api/classes/variant.d.ts +261 -261
  23. package/dist/lib-cjs/api/classes/variant.js +872 -872
  24. package/dist/lib-cjs/api/classes/variantInstance.d.ts +53 -53
  25. package/dist/lib-cjs/api/classes/variantInstance.js +125 -125
  26. package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +17 -17
  27. package/dist/lib-cjs/api/classes/variantParameterizable.js +86 -86
  28. package/dist/lib-cjs/api/classes/viewer.d.ts +215 -215
  29. package/dist/lib-cjs/api/classes/viewer.js +708 -708
  30. package/dist/lib-cjs/api/classes/viewerError.d.ts +43 -43
  31. package/dist/lib-cjs/api/classes/viewerError.js +55 -55
  32. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
  33. package/dist/lib-cjs/api/classes/viewerLight.js +344 -344
  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 +227 -227
  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 +80 -80
  41. package/dist/lib-cjs/api/manager/gltfExportManager.js +300 -299
  42. package/dist/lib-cjs/api/manager/gltfExportManager.js.map +1 -1
  43. package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
  44. package/dist/lib-cjs/api/manager/sceneManager.js +128 -128
  45. package/dist/lib-cjs/api/manager/tagManager.d.ts +118 -118
  46. package/dist/lib-cjs/api/manager/tagManager.js +530 -530
  47. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
  48. package/dist/lib-cjs/api/manager/textureLoadManager.js +107 -107
  49. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +106 -106
  50. package/dist/lib-cjs/api/manager/variantInstanceManager.js +290 -290
  51. package/dist/lib-cjs/api/store/specStorage.d.ts +32 -32
  52. package/dist/lib-cjs/api/store/specStorage.js +65 -65
  53. package/dist/lib-cjs/api/util/babylonHelper.d.ts +238 -238
  54. package/dist/lib-cjs/api/util/babylonHelper.js +825 -825
  55. package/dist/lib-cjs/api/util/debugHelper.d.ts +9 -9
  56. package/dist/lib-cjs/api/util/debugHelper.js +93 -93
  57. package/dist/lib-cjs/api/util/deviceHelper.d.ts +9 -9
  58. package/dist/lib-cjs/api/util/deviceHelper.js +28 -28
  59. package/dist/lib-cjs/api/util/geometryHelper.d.ts +17 -17
  60. package/dist/lib-cjs/api/util/geometryHelper.js +112 -112
  61. package/dist/lib-cjs/api/util/globalTypes.d.ts +490 -490
  62. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  63. package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
  64. package/dist/lib-cjs/api/util/resourceHelper.js +214 -214
  65. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +58 -58
  66. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +228 -228
  67. package/dist/lib-cjs/api/util/stringHelper.d.ts +13 -13
  68. package/dist/lib-cjs/api/util/stringHelper.js +32 -32
  69. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
  70. package/dist/lib-cjs/api/util/structureHelper.js +57 -57
  71. package/dist/lib-cjs/buildinfo.json +3 -3
  72. package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
  73. package/dist/lib-cjs/index.d.ts +63 -63
  74. package/dist/lib-cjs/index.js +128 -128
  75. package/package.json +93 -92
  76. package/src/api/classes/animationInterface.ts +10 -10
  77. package/src/api/classes/dottedPath.ts +181 -181
  78. package/src/api/classes/element.ts +766 -766
  79. package/src/api/classes/event.ts +457 -457
  80. package/src/api/classes/eventBroadcaster.ts +52 -52
  81. package/src/api/classes/fuzzyMap.ts +21 -21
  82. package/src/api/classes/parameter.ts +686 -686
  83. package/src/api/classes/parameterObservable.ts +73 -73
  84. package/src/api/classes/parameterizable.ts +87 -87
  85. package/src/api/classes/placementAnimation.ts +162 -162
  86. package/src/api/classes/variant.ts +965 -965
  87. package/src/api/classes/variantInstance.ts +123 -123
  88. package/src/api/classes/variantParameterizable.ts +83 -83
  89. package/src/api/classes/viewer.ts +751 -751
  90. package/src/api/classes/viewerError.ts +63 -63
  91. package/src/api/classes/viewerLight.ts +335 -335
  92. package/src/api/internal/debugViewer.ts +90 -90
  93. package/src/api/internal/lensRendering.ts +9 -9
  94. package/src/api/internal/sceneSetup.ts +208 -208
  95. package/src/api/manager/animationManager.ts +143 -143
  96. package/src/api/manager/gltfExportManager.ts +337 -334
  97. package/src/api/manager/sceneManager.ts +134 -134
  98. package/src/api/manager/tagManager.ts +572 -572
  99. package/src/api/manager/textureLoadManager.ts +107 -107
  100. package/src/api/manager/variantInstanceManager.ts +306 -306
  101. package/src/api/store/specStorage.ts +68 -68
  102. package/src/api/util/babylonHelper.ts +915 -915
  103. package/src/api/util/debugHelper.ts +121 -121
  104. package/src/api/util/deviceHelper.ts +31 -31
  105. package/src/api/util/geometryHelper.ts +142 -142
  106. package/src/api/util/globalTypes.ts +566 -566
  107. package/src/api/util/resourceHelper.ts +201 -201
  108. package/src/api/util/sceneLoaderHelper.ts +247 -247
  109. package/src/api/util/stringHelper.ts +30 -30
  110. package/src/api/util/structureHelper.ts +62 -62
  111. package/src/buildinfo.json +3 -3
  112. package/src/dev.ts +70 -70
  113. package/src/index.ts +116 -116
  114. package/src/types.d.ts +49 -49
@@ -1,457 +1,457 @@
1
- import { EventEmitter } from 'eventemitter3';
2
- import { isString } from 'lodash-es';
3
-
4
- /** @internal **/
5
- export const emitter = new EventEmitter();
6
-
7
- /**
8
- * This `Event` class defines all events that can be consumed and fired by the {@link EventBroadcaster}. Use
9
- * {@link EventBroadcaster.addEventListener} or {@link EventBroadcaster.on} to register event handler on your objects.
10
- * You could also use the `Emitter` to globally register event handlers. Some events are fired in certain scopes. A
11
- * scope is also considered to be the object the event could be registered on. Those scopes are documented in the
12
- * events itself.
13
- *
14
- * Example using a bootstrapping event.
15
- * ```js
16
- * Emitter.on(Event.BOOTSTRAP_START, viewer => { ... });
17
- * ```
18
- *
19
- * Example using a variant parameter event.
20
- * ```js
21
- * const variantInstance = await viewer.variantInstances.get('my_instance');
22
- * const variant = variantInstance.variant;
23
- * variant.on(Event.VARIANT_PARAMETER_COMMITTED, (variant, parameter) => { ... });
24
- * ```
25
- *
26
- * Example using a scene processing event.
27
- * ```js
28
- * const canvas = document.getElementById('viewer-canvas');
29
- * const viewer = new Viewer(canvas, createSpec());
30
- * viewer.on(Event.SCENE_PROCESSING_END, scene => {
31
- * scene.clearColor = new Color4(0, 0, 0, 0);
32
- * });
33
- * await viewer.bootstrap([]);
34
- * ```
35
- */
36
- export class Event {
37
- /**
38
- * Constructor.
39
- */
40
- private constructor() {}
41
-
42
- /**
43
- * Fired before bootstrapping of the {@link Viewer} starts.
44
- *
45
- * Scopes:
46
- * * Global
47
- * * {@link Viewer}
48
- *
49
- * Payload:
50
- * * viewer: {@link Viewer}
51
- */
52
- public static readonly BOOTSTRAP_START = 'bootstrapStart';
53
-
54
- /**
55
- * Fired after bootstrapping of the {@link Viewer} finished.
56
- *
57
- * Scopes:
58
- * * Global
59
- * * {@link Viewer}
60
- *
61
- * Payload:
62
- * * viewer: {@link Viewer}
63
- */
64
- public static readonly BOOTSTRAP_END = 'bootstrapEnd';
65
-
66
- /**
67
- * Fired before loading any type of JSON or resource.
68
- *
69
- * Scopes:
70
- * * Global
71
- *
72
- * Payload:
73
- * * path: string
74
- */
75
- public static readonly LOADING_START = 'loadingStart';
76
-
77
- /**
78
- * Fired after loading any type of JSON or resource finished.
79
- *
80
- * Scopes:
81
- * * Global
82
- *
83
- * Payload:
84
- * * path: string
85
- */
86
- public static readonly LOADING_END = 'loadingEnd';
87
-
88
- /**
89
- * Fired before loading an asset (e.g. glTF) onto the scene.
90
- *
91
- * Scopes:
92
- * * Global
93
- * * {@link Variant}
94
- *
95
- * Payload:
96
- * * variant: {@link Variant}
97
- */
98
- public static readonly ASSET_LOADING_START = 'assetLoadingStart';
99
-
100
- /**
101
- * Fired after loading an asset (e.g. glTF) onto the scene finished.
102
- *
103
- * Scopes:
104
- * * Global
105
- * * {@link Variant}
106
- *
107
- * Payload:
108
- * * variant: {@link Variant}
109
- */
110
- public static readonly ASSET_LOADING_END = 'assetLoadingEnd';
111
-
112
- /**
113
- * Fired before scene initialization starts when bootstrapping the {@link Viewer}.
114
- *
115
- * Scopes:
116
- * * Global
117
- * * {@link Viewer}
118
- *
119
- * Payload:
120
- * * sceneJson: {@link SceneJson}
121
- */
122
- public static readonly SCENE_PROCESSING_START = 'sceneProcessingStart';
123
-
124
- /**
125
- * Fired after scene initialization end when bootstrapping the {@link Viewer}.
126
- *
127
- * Scopes:
128
- * * Global
129
- * * {@link Viewer}
130
- *
131
- * Payload:
132
- * * scene: {@link Scene}
133
- */
134
- public static readonly SCENE_PROCESSING_END = 'sceneProcessingEnd';
135
-
136
- /**
137
- * Fired after a {@link Variant} has been created.
138
- *
139
- * Scopes:
140
- * * Global
141
- * * {@link Viewer}
142
- *
143
- * Payload:
144
- * * variant: {@link Variant}
145
- */
146
- public static readonly VARIANT_CREATED = 'variantCreated';
147
-
148
- /**
149
- * Fired after a {@link Variant} has been destroyed.
150
- *
151
- * Scopes:
152
- * * Global
153
- * * {@link Variant}
154
- *
155
- * Payload:
156
- * * variant: {@link Variant}
157
- */
158
- public static readonly VARIANT_DESTROYED = 'variantDestroyed';
159
-
160
- /**
161
- * Fired after the {@link Variant} under the cursor has been picked/selected.
162
- *
163
- * Scopes:
164
- * * Global
165
- * * {@link Viewer}
166
- *
167
- * Payload:
168
- * * variant: {@link Variant}
169
- */
170
- public static readonly VARIANT_PICKED = 'variantPicked';
171
-
172
- /**
173
- * Fired after the {@link Element} under the cursor has been picked/selected.
174
- *
175
- * Scopes:
176
- * * Global
177
- * * {@link Viewer}
178
- *
179
- * Payload:
180
- * * element: {@link Element}
181
- */
182
- public static readonly ELEMENT_PICKED = 'elementPicked';
183
-
184
- /**
185
- * Fired after a parameter on a {@link Variant} has been committed.
186
- *
187
- * Scopes:
188
- * * Global
189
- * * {@link Variant}
190
- *
191
- * Payload:
192
- * * variant: {@link Variant}
193
- * * parameter: string
194
- * * oldValue: string
195
- * * newValue: string
196
- */
197
- public static readonly VARIANT_PARAMETER_COMMITTED = 'variantParameterCommitted';
198
-
199
- /**
200
- * Fired after a {@link ParameterBag} has been committed.
201
- *
202
- * Scopes:
203
- * * Global
204
- * * {@link Variant}
205
- *
206
- * Payload:
207
- * * variant: {@link Variant}
208
- * * parameters: {@link ParameterBag}
209
- * * oldValues: string[]
210
- * * newValues: string[]
211
- */
212
- public static readonly VARIANT_PARAMETER_BAG_COMMITTED = 'variantParameterBagCommitted';
213
-
214
- /**
215
- * Fired after a {@link VariantInstance} has been created.
216
- *
217
- * Scopes:
218
- * * Global
219
- * * {@link VariantInstanceManager}
220
- *
221
- * Payload:
222
- * * variantInstance: {@link VariantInstance}
223
- */
224
- public static readonly VARIANT_INSTANCE_CREATED = 'variantInstanceCreated';
225
-
226
- /**
227
- * Fired after a {@link VariantInstance} has been registered. This is the case when the {@link VariantInstance} is
228
- * considered "lazy".
229
- *
230
- * Scopes:
231
- * * Global
232
- * * {@link VariantInstanceManager}
233
- *
234
- * Payload:
235
- * * variantInstanceDefinition: {@link VariantInstanceDefinition}
236
- */
237
- public static readonly VARIANT_INSTANCE_REGISTERED = 'variantInstanceRegistered';
238
-
239
- /**
240
- * Fired after a {@link VariantInstance} has been cloned.
241
- *
242
- * Scopes:
243
- * * Global
244
- * * {@link VariantInstanceManager}
245
- *
246
- * Payload:
247
- * * variantInstanceClone: {@link VariantInstance}
248
- */
249
- public static readonly VARIANT_INSTANCE_CLONED = 'variantInstanceCloned';
250
-
251
- /**
252
- * Fired after a {@link VariantInstance} has been destroyed.
253
- *
254
- * Scopes:
255
- * * Global
256
- * * {@link VariantInstanceManager}
257
- *
258
- * Payload:
259
- * * variantInstance: {@link VariantInstance}
260
- */
261
- public static readonly VARIANT_INSTANCE_DESTROYED = 'variantInstanceDestroyed';
262
-
263
- /**
264
- * Fired after all {@link VariantInstance}s have been either created or registered.
265
- *
266
- * Scopes:
267
- * * Global
268
- * * {@link Viewer}
269
- *
270
- * Payload:
271
- * * viewer: {@link Viewer}
272
- */
273
- public static readonly VARIANT_INSTANCES_READY = 'variantInstancesReady';
274
-
275
- /**
276
- * Fired after the nodes of a {@link Variant} has been cloned to the {@link Element}.
277
- *
278
- * Scopes:
279
- * * Global
280
- * * {@link Variant}
281
- *
282
- * Payload:
283
- * * element: {@link Element}
284
- */
285
- public static readonly ELEMENT_NODES_CLONED = 'elementNodesCloned';
286
-
287
- /**
288
- * Fired after an {@link Element} has been created.
289
- *
290
- * Scopes:
291
- * * Global
292
- * * {@link Variant}
293
- *
294
- * Payload:
295
- * * element: {@link Element}
296
- */
297
- public static readonly ELEMENT_CREATED = 'elementCreated';
298
-
299
- /**
300
- * Fired after a parameter on an {@link Element} has been committed.
301
- *
302
- * Scopes:
303
- * * Global
304
- * * {@link Element}
305
- *
306
- * Payload:
307
- * * element: {@link Element}
308
- * * parameter: string
309
- * * oldValue: string
310
- * * newValue: string
311
- */
312
- public static readonly ELEMENT_PARAMETER_COMMITTED = 'elementParameterCommitted';
313
-
314
- /**
315
- * Fired after a parameter on an {@link ViewerLight} has been committed.
316
- *
317
- * Scopes:
318
- * * Global
319
- * * {@link ViewerLight}
320
- *
321
- * Payload:
322
- * * light: {@link ViewerLight}
323
- * * parameter: string
324
- * * oldValue: string
325
- * * newValue: string
326
- */
327
- public static readonly VIEWER_LIGHT_PARAMETER_COMMITTED = 'viewerLightParameterCommitted';
328
-
329
- /**
330
- * Fired after a parameter on an {@link SceneManager} has been committed.
331
- *
332
- * Scopes:
333
- * * Global
334
- * * {@link SceneManager}
335
- *
336
- * Payload:
337
- * * variant: {@link SceneManager}
338
- * * parameter: string
339
- * * oldValue: string
340
- * * newValue: string
341
- */
342
- public static readonly SCENE_PARAMETER_COMMITTED = 'sceneParameterCommitted';
343
-
344
- /**
345
- * Fired after the active camera on the scene has been switched.
346
- *
347
- * Scopes:
348
- * * Global
349
- * * {@link Viewer}
350
- *
351
- * Payload:
352
- * * camera: Camera
353
- */
354
- public static readonly CAMERA_SWITCHED = 'cameraSwitched';
355
-
356
- /**
357
- * Fired after the {@link Mesh} under the cursor has been picked/selected.
358
- *
359
- * Scopes:
360
- * * Global
361
- * * {@link Viewer}
362
- *
363
- * Payload:
364
- * * mesh: {@link Mesh}
365
- * * element: {@link Element}
366
- * * variant: {@link Variant}
367
- */
368
- public static readonly MESH_PICKED = 'meshPicked';
369
-
370
- /**
371
- * Fired when a bunch of {@link Texture}s start loading.
372
- *
373
- * Scopes:
374
- * * Global
375
- * * {@link SceneManager}
376
- */
377
- public static readonly TEXTURE_LOADING_START = 'textureLoadingStart';
378
-
379
- /**
380
- * Fired when the last {@link Texture} was successfully loaded.
381
- *
382
- * Scopes:
383
- * * Global
384
- * * {@link SceneManager}
385
- */
386
- public static readonly TEXTURE_LOADING_END = 'textureLoadingEnd';
387
-
388
- /**
389
- * Fired after a {@link Material} has been applied to a {@link Mesh}.
390
- *
391
- * Scopes:
392
- * * Global
393
- *
394
- * Payload:
395
- * * mesh: {@link Mesh}
396
- * * material: {@link Material}
397
- */
398
- public static readonly MESH_MATERIAL_APPLIED = 'meshMaterialApplied';
399
-
400
- /**
401
- * Fired after a {@link TagManagerParameterObserver} has been called.
402
- *
403
- * Scopes:
404
- * * Global
405
- *
406
- * Payload:
407
- * * subject: {@link TagManagerSubject},
408
- * * parameter: string,
409
- * * nodes: {@link TransformNode}[],
410
- * * oldValue: {@link ParameterValue},
411
- * * newValue: {@link ParameterValue},
412
- * * result: {@link ParameterObserverResult},
413
- */
414
- public static readonly TAG_MANAGER_PARAMETER_COMMITTED = 'tagManagerParameterCommitted';
415
-
416
- /**
417
- * All events defined in this class.
418
- */
419
- public static get all() {
420
- const all: string[] = [];
421
- for (const event in Event) {
422
- const property = Object.getOwnPropertyDescriptor(Event, event);
423
- if (event.toUpperCase() === event && property && isString(property.value)) {
424
- all.push(property.value);
425
- }
426
- }
427
- return all;
428
- }
429
-
430
- /**
431
- * All events starting with 'variant'.
432
- */
433
- public static get variant() {
434
- return Event.all.filter(event => event.startsWith('variant'));
435
- }
436
-
437
- /**
438
- * All events starting with 'element'.
439
- */
440
- public static get element() {
441
- return Event.all.filter(event => event.startsWith('element'));
442
- }
443
-
444
- /**
445
- * All events starting with 'scene'.
446
- */
447
- public static get scene() {
448
- return Event.all.filter(event => event.startsWith('scene'));
449
- }
450
-
451
- /**
452
- * All events starting with 'camera'.
453
- */
454
- public static get camera() {
455
- return Event.all.filter(event => event.startsWith('camera'));
456
- }
457
- }
1
+ import { EventEmitter } from 'eventemitter3';
2
+ import { isString } from 'lodash-es';
3
+
4
+ /** @internal **/
5
+ export const emitter = new EventEmitter();
6
+
7
+ /**
8
+ * This `Event` class defines all events that can be consumed and fired by the {@link EventBroadcaster}. Use
9
+ * {@link EventBroadcaster.addEventListener} or {@link EventBroadcaster.on} to register event handler on your objects.
10
+ * You could also use the `Emitter` to globally register event handlers. Some events are fired in certain scopes. A
11
+ * scope is also considered to be the object the event could be registered on. Those scopes are documented in the
12
+ * events itself.
13
+ *
14
+ * Example using a bootstrapping event.
15
+ * ```js
16
+ * Emitter.on(Event.BOOTSTRAP_START, viewer => { ... });
17
+ * ```
18
+ *
19
+ * Example using a variant parameter event.
20
+ * ```js
21
+ * const variantInstance = await viewer.variantInstances.get('my_instance');
22
+ * const variant = variantInstance.variant;
23
+ * variant.on(Event.VARIANT_PARAMETER_COMMITTED, (variant, parameter) => { ... });
24
+ * ```
25
+ *
26
+ * Example using a scene processing event.
27
+ * ```js
28
+ * const canvas = document.getElementById('viewer-canvas');
29
+ * const viewer = new Viewer(canvas, createSpec());
30
+ * viewer.on(Event.SCENE_PROCESSING_END, scene => {
31
+ * scene.clearColor = new Color4(0, 0, 0, 0);
32
+ * });
33
+ * await viewer.bootstrap([]);
34
+ * ```
35
+ */
36
+ export class Event {
37
+ /**
38
+ * Constructor.
39
+ */
40
+ private constructor() {}
41
+
42
+ /**
43
+ * Fired before bootstrapping of the {@link Viewer} starts.
44
+ *
45
+ * Scopes:
46
+ * * Global
47
+ * * {@link Viewer}
48
+ *
49
+ * Payload:
50
+ * * viewer: {@link Viewer}
51
+ */
52
+ public static readonly BOOTSTRAP_START = 'bootstrapStart';
53
+
54
+ /**
55
+ * Fired after bootstrapping of the {@link Viewer} finished.
56
+ *
57
+ * Scopes:
58
+ * * Global
59
+ * * {@link Viewer}
60
+ *
61
+ * Payload:
62
+ * * viewer: {@link Viewer}
63
+ */
64
+ public static readonly BOOTSTRAP_END = 'bootstrapEnd';
65
+
66
+ /**
67
+ * Fired before loading any type of JSON or resource.
68
+ *
69
+ * Scopes:
70
+ * * Global
71
+ *
72
+ * Payload:
73
+ * * path: string
74
+ */
75
+ public static readonly LOADING_START = 'loadingStart';
76
+
77
+ /**
78
+ * Fired after loading any type of JSON or resource finished.
79
+ *
80
+ * Scopes:
81
+ * * Global
82
+ *
83
+ * Payload:
84
+ * * path: string
85
+ */
86
+ public static readonly LOADING_END = 'loadingEnd';
87
+
88
+ /**
89
+ * Fired before loading an asset (e.g. glTF) onto the scene.
90
+ *
91
+ * Scopes:
92
+ * * Global
93
+ * * {@link Variant}
94
+ *
95
+ * Payload:
96
+ * * variant: {@link Variant}
97
+ */
98
+ public static readonly ASSET_LOADING_START = 'assetLoadingStart';
99
+
100
+ /**
101
+ * Fired after loading an asset (e.g. glTF) onto the scene finished.
102
+ *
103
+ * Scopes:
104
+ * * Global
105
+ * * {@link Variant}
106
+ *
107
+ * Payload:
108
+ * * variant: {@link Variant}
109
+ */
110
+ public static readonly ASSET_LOADING_END = 'assetLoadingEnd';
111
+
112
+ /**
113
+ * Fired before scene initialization starts when bootstrapping the {@link Viewer}.
114
+ *
115
+ * Scopes:
116
+ * * Global
117
+ * * {@link Viewer}
118
+ *
119
+ * Payload:
120
+ * * sceneJson: {@link SceneJson}
121
+ */
122
+ public static readonly SCENE_PROCESSING_START = 'sceneProcessingStart';
123
+
124
+ /**
125
+ * Fired after scene initialization end when bootstrapping the {@link Viewer}.
126
+ *
127
+ * Scopes:
128
+ * * Global
129
+ * * {@link Viewer}
130
+ *
131
+ * Payload:
132
+ * * scene: {@link Scene}
133
+ */
134
+ public static readonly SCENE_PROCESSING_END = 'sceneProcessingEnd';
135
+
136
+ /**
137
+ * Fired after a {@link Variant} has been created.
138
+ *
139
+ * Scopes:
140
+ * * Global
141
+ * * {@link Viewer}
142
+ *
143
+ * Payload:
144
+ * * variant: {@link Variant}
145
+ */
146
+ public static readonly VARIANT_CREATED = 'variantCreated';
147
+
148
+ /**
149
+ * Fired after a {@link Variant} has been destroyed.
150
+ *
151
+ * Scopes:
152
+ * * Global
153
+ * * {@link Variant}
154
+ *
155
+ * Payload:
156
+ * * variant: {@link Variant}
157
+ */
158
+ public static readonly VARIANT_DESTROYED = 'variantDestroyed';
159
+
160
+ /**
161
+ * Fired after the {@link Variant} under the cursor has been picked/selected.
162
+ *
163
+ * Scopes:
164
+ * * Global
165
+ * * {@link Viewer}
166
+ *
167
+ * Payload:
168
+ * * variant: {@link Variant}
169
+ */
170
+ public static readonly VARIANT_PICKED = 'variantPicked';
171
+
172
+ /**
173
+ * Fired after the {@link Element} under the cursor has been picked/selected.
174
+ *
175
+ * Scopes:
176
+ * * Global
177
+ * * {@link Viewer}
178
+ *
179
+ * Payload:
180
+ * * element: {@link Element}
181
+ */
182
+ public static readonly ELEMENT_PICKED = 'elementPicked';
183
+
184
+ /**
185
+ * Fired after a parameter on a {@link Variant} has been committed.
186
+ *
187
+ * Scopes:
188
+ * * Global
189
+ * * {@link Variant}
190
+ *
191
+ * Payload:
192
+ * * variant: {@link Variant}
193
+ * * parameter: string
194
+ * * oldValue: string
195
+ * * newValue: string
196
+ */
197
+ public static readonly VARIANT_PARAMETER_COMMITTED = 'variantParameterCommitted';
198
+
199
+ /**
200
+ * Fired after a {@link ParameterBag} has been committed.
201
+ *
202
+ * Scopes:
203
+ * * Global
204
+ * * {@link Variant}
205
+ *
206
+ * Payload:
207
+ * * variant: {@link Variant}
208
+ * * parameters: {@link ParameterBag}
209
+ * * oldValues: string[]
210
+ * * newValues: string[]
211
+ */
212
+ public static readonly VARIANT_PARAMETER_BAG_COMMITTED = 'variantParameterBagCommitted';
213
+
214
+ /**
215
+ * Fired after a {@link VariantInstance} has been created.
216
+ *
217
+ * Scopes:
218
+ * * Global
219
+ * * {@link VariantInstanceManager}
220
+ *
221
+ * Payload:
222
+ * * variantInstance: {@link VariantInstance}
223
+ */
224
+ public static readonly VARIANT_INSTANCE_CREATED = 'variantInstanceCreated';
225
+
226
+ /**
227
+ * Fired after a {@link VariantInstance} has been registered. This is the case when the {@link VariantInstance} is
228
+ * considered "lazy".
229
+ *
230
+ * Scopes:
231
+ * * Global
232
+ * * {@link VariantInstanceManager}
233
+ *
234
+ * Payload:
235
+ * * variantInstanceDefinition: {@link VariantInstanceDefinition}
236
+ */
237
+ public static readonly VARIANT_INSTANCE_REGISTERED = 'variantInstanceRegistered';
238
+
239
+ /**
240
+ * Fired after a {@link VariantInstance} has been cloned.
241
+ *
242
+ * Scopes:
243
+ * * Global
244
+ * * {@link VariantInstanceManager}
245
+ *
246
+ * Payload:
247
+ * * variantInstanceClone: {@link VariantInstance}
248
+ */
249
+ public static readonly VARIANT_INSTANCE_CLONED = 'variantInstanceCloned';
250
+
251
+ /**
252
+ * Fired after a {@link VariantInstance} has been destroyed.
253
+ *
254
+ * Scopes:
255
+ * * Global
256
+ * * {@link VariantInstanceManager}
257
+ *
258
+ * Payload:
259
+ * * variantInstance: {@link VariantInstance}
260
+ */
261
+ public static readonly VARIANT_INSTANCE_DESTROYED = 'variantInstanceDestroyed';
262
+
263
+ /**
264
+ * Fired after all {@link VariantInstance}s have been either created or registered.
265
+ *
266
+ * Scopes:
267
+ * * Global
268
+ * * {@link Viewer}
269
+ *
270
+ * Payload:
271
+ * * viewer: {@link Viewer}
272
+ */
273
+ public static readonly VARIANT_INSTANCES_READY = 'variantInstancesReady';
274
+
275
+ /**
276
+ * Fired after the nodes of a {@link Variant} has been cloned to the {@link Element}.
277
+ *
278
+ * Scopes:
279
+ * * Global
280
+ * * {@link Variant}
281
+ *
282
+ * Payload:
283
+ * * element: {@link Element}
284
+ */
285
+ public static readonly ELEMENT_NODES_CLONED = 'elementNodesCloned';
286
+
287
+ /**
288
+ * Fired after an {@link Element} has been created.
289
+ *
290
+ * Scopes:
291
+ * * Global
292
+ * * {@link Variant}
293
+ *
294
+ * Payload:
295
+ * * element: {@link Element}
296
+ */
297
+ public static readonly ELEMENT_CREATED = 'elementCreated';
298
+
299
+ /**
300
+ * Fired after a parameter on an {@link Element} has been committed.
301
+ *
302
+ * Scopes:
303
+ * * Global
304
+ * * {@link Element}
305
+ *
306
+ * Payload:
307
+ * * element: {@link Element}
308
+ * * parameter: string
309
+ * * oldValue: string
310
+ * * newValue: string
311
+ */
312
+ public static readonly ELEMENT_PARAMETER_COMMITTED = 'elementParameterCommitted';
313
+
314
+ /**
315
+ * Fired after a parameter on an {@link ViewerLight} has been committed.
316
+ *
317
+ * Scopes:
318
+ * * Global
319
+ * * {@link ViewerLight}
320
+ *
321
+ * Payload:
322
+ * * light: {@link ViewerLight}
323
+ * * parameter: string
324
+ * * oldValue: string
325
+ * * newValue: string
326
+ */
327
+ public static readonly VIEWER_LIGHT_PARAMETER_COMMITTED = 'viewerLightParameterCommitted';
328
+
329
+ /**
330
+ * Fired after a parameter on an {@link SceneManager} has been committed.
331
+ *
332
+ * Scopes:
333
+ * * Global
334
+ * * {@link SceneManager}
335
+ *
336
+ * Payload:
337
+ * * variant: {@link SceneManager}
338
+ * * parameter: string
339
+ * * oldValue: string
340
+ * * newValue: string
341
+ */
342
+ public static readonly SCENE_PARAMETER_COMMITTED = 'sceneParameterCommitted';
343
+
344
+ /**
345
+ * Fired after the active camera on the scene has been switched.
346
+ *
347
+ * Scopes:
348
+ * * Global
349
+ * * {@link Viewer}
350
+ *
351
+ * Payload:
352
+ * * camera: Camera
353
+ */
354
+ public static readonly CAMERA_SWITCHED = 'cameraSwitched';
355
+
356
+ /**
357
+ * Fired after the {@link Mesh} under the cursor has been picked/selected.
358
+ *
359
+ * Scopes:
360
+ * * Global
361
+ * * {@link Viewer}
362
+ *
363
+ * Payload:
364
+ * * mesh: {@link Mesh}
365
+ * * element: {@link Element}
366
+ * * variant: {@link Variant}
367
+ */
368
+ public static readonly MESH_PICKED = 'meshPicked';
369
+
370
+ /**
371
+ * Fired when a bunch of {@link Texture}s start loading.
372
+ *
373
+ * Scopes:
374
+ * * Global
375
+ * * {@link SceneManager}
376
+ */
377
+ public static readonly TEXTURE_LOADING_START = 'textureLoadingStart';
378
+
379
+ /**
380
+ * Fired when the last {@link Texture} was successfully loaded.
381
+ *
382
+ * Scopes:
383
+ * * Global
384
+ * * {@link SceneManager}
385
+ */
386
+ public static readonly TEXTURE_LOADING_END = 'textureLoadingEnd';
387
+
388
+ /**
389
+ * Fired after a {@link Material} has been applied to a {@link Mesh}.
390
+ *
391
+ * Scopes:
392
+ * * Global
393
+ *
394
+ * Payload:
395
+ * * mesh: {@link Mesh}
396
+ * * material: {@link Material}
397
+ */
398
+ public static readonly MESH_MATERIAL_APPLIED = 'meshMaterialApplied';
399
+
400
+ /**
401
+ * Fired after a {@link TagManagerParameterObserver} has been called.
402
+ *
403
+ * Scopes:
404
+ * * Global
405
+ *
406
+ * Payload:
407
+ * * subject: {@link TagManagerSubject},
408
+ * * parameter: string,
409
+ * * nodes: {@link TransformNode}[],
410
+ * * oldValue: {@link ParameterValue},
411
+ * * newValue: {@link ParameterValue},
412
+ * * result: {@link ParameterObserverResult},
413
+ */
414
+ public static readonly TAG_MANAGER_PARAMETER_COMMITTED = 'tagManagerParameterCommitted';
415
+
416
+ /**
417
+ * All events defined in this class.
418
+ */
419
+ public static get all() {
420
+ const all: string[] = [];
421
+ for (const event in Event) {
422
+ const property = Object.getOwnPropertyDescriptor(Event, event);
423
+ if (event.toUpperCase() === event && property && isString(property.value)) {
424
+ all.push(property.value);
425
+ }
426
+ }
427
+ return all;
428
+ }
429
+
430
+ /**
431
+ * All events starting with 'variant'.
432
+ */
433
+ public static get variant() {
434
+ return Event.all.filter(event => event.startsWith('variant'));
435
+ }
436
+
437
+ /**
438
+ * All events starting with 'element'.
439
+ */
440
+ public static get element() {
441
+ return Event.all.filter(event => event.startsWith('element'));
442
+ }
443
+
444
+ /**
445
+ * All events starting with 'scene'.
446
+ */
447
+ public static get scene() {
448
+ return Event.all.filter(event => event.startsWith('scene'));
449
+ }
450
+
451
+ /**
452
+ * All events starting with 'camera'.
453
+ */
454
+ public static get camera() {
455
+ return Event.all.filter(event => event.startsWith('camera'));
456
+ }
457
+ }