@combeenation/3d-viewer 7.1.3 → 8.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. package/README.md +111 -111
  2. package/dist/lib-cjs/api/classes/animationInterface.d.ts +8 -8
  3. package/dist/lib-cjs/api/classes/animationInterface.js +2 -2
  4. package/dist/lib-cjs/api/classes/dottedPath.d.ts +79 -79
  5. package/dist/lib-cjs/api/classes/dottedPath.js +166 -166
  6. package/dist/lib-cjs/api/classes/element.d.ts +153 -153
  7. package/dist/lib-cjs/api/classes/element.js +672 -672
  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 +351 -351
  15. package/dist/lib-cjs/api/classes/parameter.js +524 -524
  16. package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
  17. package/dist/lib-cjs/api/classes/parameterObservable.js +72 -72
  18. package/dist/lib-cjs/api/classes/parameterizable.d.ts +15 -15
  19. package/dist/lib-cjs/api/classes/parameterizable.js +102 -102
  20. package/dist/lib-cjs/api/classes/placementAnimation.d.ts +45 -45
  21. package/dist/lib-cjs/api/classes/placementAnimation.js +176 -176
  22. package/dist/lib-cjs/api/classes/variant.d.ts +253 -253
  23. package/dist/lib-cjs/api/classes/variant.js +858 -858
  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 +213 -213
  29. package/dist/lib-cjs/api/classes/viewer.js +716 -716
  30. package/dist/lib-cjs/api/classes/viewer.js.map +1 -1
  31. package/dist/lib-cjs/api/classes/viewerError.d.ts +43 -43
  32. package/dist/lib-cjs/api/classes/viewerError.js +55 -55
  33. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
  34. package/dist/lib-cjs/api/classes/viewerLight.js +348 -348
  35. package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
  36. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  37. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
  38. package/dist/lib-cjs/api/internal/sceneSetup.js +226 -226
  39. package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
  40. package/dist/lib-cjs/api/manager/animationManager.js +126 -126
  41. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +102 -79
  42. package/dist/lib-cjs/api/manager/gltfExportManager.js +320 -242
  43. package/dist/lib-cjs/api/manager/gltfExportManager.js.map +1 -1
  44. package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
  45. package/dist/lib-cjs/api/manager/sceneManager.js +128 -128
  46. package/dist/lib-cjs/api/manager/tagManager.d.ts +116 -116
  47. package/dist/lib-cjs/api/manager/tagManager.js +444 -444
  48. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
  49. package/dist/lib-cjs/api/manager/textureLoadManager.js +97 -97
  50. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +106 -106
  51. package/dist/lib-cjs/api/manager/variantInstanceManager.js +292 -292
  52. package/dist/lib-cjs/api/store/specStorage.d.ts +32 -32
  53. package/dist/lib-cjs/api/store/specStorage.js +65 -65
  54. package/dist/lib-cjs/api/util/babylonHelper.d.ts +235 -235
  55. package/dist/lib-cjs/api/util/babylonHelper.js +753 -753
  56. package/dist/lib-cjs/api/util/globalTypes.d.ts +457 -455
  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 +44 -44
  61. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +175 -175
  62. package/dist/lib-cjs/api/util/stringHelper.d.ts +13 -13
  63. package/dist/lib-cjs/api/util/stringHelper.js +32 -32
  64. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
  65. package/dist/lib-cjs/api/util/structureHelper.js +57 -57
  66. package/dist/lib-cjs/buildinfo.json +3 -3
  67. package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
  68. package/dist/lib-cjs/index.d.ts +54 -54
  69. package/dist/lib-cjs/index.js +117 -117
  70. package/package.json +81 -81
  71. package/src/api/classes/animationInterface.ts +10 -10
  72. package/src/api/classes/dottedPath.ts +181 -181
  73. package/src/api/classes/element.ts +733 -733
  74. package/src/api/classes/event.ts +457 -457
  75. package/src/api/classes/eventBroadcaster.ts +52 -52
  76. package/src/api/classes/fuzzyMap.ts +21 -21
  77. package/src/api/classes/parameter.ts +561 -561
  78. package/src/api/classes/parameterObservable.ts +73 -73
  79. package/src/api/classes/parameterizable.ts +87 -87
  80. package/src/api/classes/placementAnimation.ts +162 -162
  81. package/src/api/classes/variant.ts +949 -949
  82. package/src/api/classes/variantInstance.ts +123 -123
  83. package/src/api/classes/variantParameterizable.ts +83 -83
  84. package/src/api/classes/viewer.ts +772 -772
  85. package/src/api/classes/viewerError.ts +63 -63
  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 +297 -237
  92. package/src/api/manager/sceneManager.ts +134 -134
  93. package/src/api/manager/tagManager.ts +477 -477
  94. package/src/api/manager/textureLoadManager.ts +95 -95
  95. package/src/api/manager/variantInstanceManager.ts +309 -309
  96. package/src/api/store/specStorage.ts +68 -68
  97. package/src/api/util/babylonHelper.ts +823 -823
  98. package/src/api/util/globalTypes.ts +527 -525
  99. package/src/api/util/resourceHelper.ts +191 -191
  100. package/src/api/util/sceneLoaderHelper.ts +170 -170
  101. package/src/api/util/stringHelper.ts +30 -30
  102. package/src/api/util/structureHelper.ts +58 -58
  103. package/src/buildinfo.json +3 -3
  104. package/src/dev.ts +62 -62
  105. package/src/index.ts +103 -103
  106. package/src/types.d.ts +38 -38
@@ -1,477 +1,477 @@
1
- import { Event, emitter } from '../classes/event';
2
- import { FuzzyMap } from '../classes/fuzzyMap';
3
- import { Parameter } from '../classes/parameter';
4
- import { Viewer } from '../classes/viewer';
5
- import {
6
- assertMeshCapability,
7
- cloneTransformNodeMaterial,
8
- injectNodeMetadata,
9
- mapTags,
10
- setMaterial,
11
- setMaterialColor,
12
- setMaterialMetallness,
13
- setMaterialRoughness,
14
- } from '../util/babylonHelper';
15
- import { AbstractMesh } from '@babylonjs/core/Meshes/abstractMesh';
16
- import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
17
- import { Tags } from '@babylonjs/core/Misc/tags';
18
- import { clone, get, has, merge, uniq } from 'lodash-es';
19
-
20
- export class TagManager {
21
- public readonly parameters: TagManagerParameterBag = new FuzzyMap();
22
-
23
- public readonly parameterObservers: TagManagerParameterObserverBag = new Map();
24
-
25
- /**
26
- * Constructor.
27
- */
28
- public constructor(protected viewer: Viewer) {
29
- this.addParameterObservers();
30
- }
31
-
32
- /**
33
- * Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
34
- * nodes with given tagName.
35
- */
36
- public async setTagParameterValue(
37
- tagName: string,
38
- parameterName: string,
39
- value: ParameterValue
40
- ): Promise<ParameterObserverResult> {
41
- return await this.handleParameter({ tagName: tagName }, parameterName, value);
42
- }
43
-
44
- /**
45
- * Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
46
- * nodes with given nodeName.
47
- */
48
- public async setNodeParameterValue(
49
- nodeName: string,
50
- parameterName: string,
51
- value: ParameterValue
52
- ): Promise<ParameterObserverResult> {
53
- return await this.handleParameter({ nodeName: nodeName }, parameterName, value);
54
- }
55
-
56
- /**
57
- * Splits the passed {@link TagManagerParameterValue}s into individual values and calls all {@link ParameterObserver}s
58
- * of all {@link Parameter}s with the respective {@link TagManagerSubject} and {@link ParameterValue}. The result is a
59
- * map of passed {@link TagManagerParameterValue}s and the associated {@link ParameterObserverResult} of the
60
- * {@link ParameterObserver}.
61
- */
62
- public async setParameterValues(
63
- values: TagManagerParameterValue[]
64
- ): Promise<Map<TagManagerParameterValue, ParameterObserverResult>> {
65
- const observerResultMap: Map<TagManagerParameterValue, ParameterObserverResult> = new Map();
66
- const tagPromises: Promise<ParameterObserverResult>[] = [];
67
- const nodePromises: Promise<ParameterObserverResult>[] = [];
68
- for (const value of values) {
69
- const subject: TagManagerSubject = {};
70
- if (value.tagName) {
71
- subject.tagName = value.tagName;
72
- }
73
- if (value.nodeName) {
74
- subject.nodeName = value.nodeName;
75
- }
76
- const observerResultPromise = this.handleParameter(subject, value.parameterName, value.value);
77
- observerResultPromise.then(result => observerResultMap.set(value, result));
78
- if (value.tagName) {
79
- tagPromises.push(observerResultPromise);
80
- }
81
- if (value.nodeName) {
82
- nodePromises.push(observerResultPromise);
83
- }
84
- }
85
- await Promise.all(tagPromises);
86
- await Promise.all(nodePromises);
87
- return observerResultMap;
88
- }
89
-
90
- /**
91
- * Gets a list of {@link TagManagerSubject}s that are present in both the state of the {@link TagManager}'s
92
- * {@link parameters} and the given node.
93
- */
94
- public getSubjectsFor(node: TransformNode): TagManagerSubject[] {
95
- return [...this.parameters.keys()].filter(
96
- subject =>
97
- (subject.tagName && Tags.MatchesQuery(node, subject.tagName)) ||
98
- (subject.nodeName && node.name === subject.nodeName)
99
- );
100
- }
101
-
102
- /**
103
- * Gets a list of {@link TagManagerSubject}s that are present in both the state of the {@link TagManager}'s
104
- * {@link parameters} and the given nodes.
105
- */
106
- public getApplicableSubjectsFor(nodes: TransformNode[]): TagManagerSubject[] {
107
- let applicableSubjects: TagManagerSubject[] = [];
108
- for (const node of nodes) {
109
- const subjects = this.getSubjectsFor(node);
110
- applicableSubjects = [...applicableSubjects, ...subjects];
111
- }
112
- return uniq(applicableSubjects);
113
- }
114
-
115
- /**
116
- * Applies all existing states of the {@link TagManager}'s {@link parameters} for given {@link TagManagerSubject}s.
117
- */
118
- public async applyExistingParameterValuesFor(
119
- subjects: TagManagerSubject[]
120
- ): Promise<Map<TagManagerSubject, ParameterObserverResult>> {
121
- const observerResultMap: Map<TagManagerSubject, ParameterObserverResult> = new Map();
122
- let tagPromises: Promise<ParameterObserverResult>[] = [];
123
- let nodePromises: Promise<ParameterObserverResult>[] = [];
124
- for (const subject of subjects) {
125
- this.clearAppliedNodeMetadataParameters(this.getNodesBySubject(subject));
126
- const observerResultPromises = this.handleParameterBag(subject, this.parameters.get(subject)!);
127
- for (const observerResultPromise of observerResultPromises) {
128
- observerResultPromise.then(result => observerResultMap.set(subject, result));
129
- }
130
- if (subject.tagName) {
131
- tagPromises = [...tagPromises, ...observerResultPromises];
132
- }
133
- if (subject.nodeName) {
134
- nodePromises = [...nodePromises, ...observerResultPromises];
135
- }
136
- }
137
- await Promise.all(tagPromises);
138
- await Promise.all(nodePromises);
139
- return observerResultMap;
140
- }
141
-
142
- /**
143
- * Does the same as {@link setParameterValues} with the difference that all existing states of the
144
- * {@link TagManager}'s {@link parameters} are applied to all given nodes.
145
- */
146
- public async applyExistingParameterValuesTo(
147
- nodes: TransformNode[]
148
- ): Promise<Map<TagManagerSubject, ParameterObserverResult>> {
149
- return this.applyExistingParameterValuesFor(this.getApplicableSubjectsFor(nodes));
150
- }
151
-
152
- /**
153
- * Applies all existing states of the {@link TagManager}'s {@link parameters} for all {@link TagManagerSubject}s.
154
- */
155
- public async applyExistingParameterValues(): Promise<Map<TagManagerSubject, ParameterObserverResult>> {
156
- return this.applyExistingParameterValuesFor([...this.parameters.keys()]);
157
- }
158
-
159
- /**
160
- * Maps all tags on given nodes with the {@link TagMapping} and updates the state of the {@link TagManager}'s
161
- * {@link parameters} for all new tags.
162
- * Also updates the state of all nodes in the tag managers parameter state.
163
- */
164
- public mapNodesAndTags(nodes: TransformNode[], tagMapping: TagMapping): TagManager {
165
- this.updateParametersWithNodeAndTagMapping(nodes, tagMapping);
166
- mapTags(nodes, tagMapping);
167
- return this;
168
- }
169
-
170
- /**
171
- * Gets a distinct list of all tags within the current scene.
172
- */
173
- public getAllTags(): string[] {
174
- const tags: string[] = [];
175
- const nodes = this.viewer.scene.getNodes();
176
- for (const node of nodes) {
177
- tags.push(...Object.keys(Tags.GetTags(node, false) ?? {}));
178
- }
179
- return [...new Set(tags)];
180
- }
181
-
182
- /**
183
- * Prints the state of the {@link TagManager}'s {@link parameters} to the console.
184
- */
185
- public printAllTags(): void {
186
- const printable = [];
187
- for (const subject of this.parameters.keys()) {
188
- const parameterBag = this.parameters.get(subject);
189
- for (const parameter in parameterBag) {
190
- printable.push({
191
- subject: JSON.stringify(subject),
192
- parameter: parameter,
193
- value: parameterBag[parameter],
194
- nodes: this.getNodesBySubject(subject),
195
- });
196
- }
197
- }
198
- console.table(printable);
199
- }
200
-
201
- /**
202
- * Prints the state of the {@link TagManager}'s {@link parameters} for one tagName to the console.
203
- */
204
- public printTagInfo(tagName: string): void {
205
- const parameterBag = this.parameters.get({ tagName: tagName });
206
- const printable = [];
207
- for (const parameter in parameterBag) {
208
- printable.push({
209
- parameter: parameter,
210
- value: parameterBag[parameter],
211
- nodes: this.getNodesBySubject({ tagName: tagName }),
212
- });
213
- }
214
- console.table(printable);
215
- }
216
-
217
- /**
218
- * Sets a {@link ParameterObserver} for the given {@link Parameter}.
219
- *
220
- * The observer should return `false` in cases where the given value was not actually applied. E.g. when wanting to
221
- * apply a property on the given `node`s material which doesn't exist at the time the observer is called etc.
222
- */
223
- public setParameterObserver(parameter: string, observer: TagManagerParameterObserver): TagManager {
224
- this.parameterObservers.set(parameter, observer);
225
- return this;
226
- }
227
-
228
- /**
229
- * Gets all nodes for given {@link TagManagerSubject} on the Babylon.js scene.
230
- */
231
- public getNodesBySubject(subject: TagManagerSubject, predicate?: (node: TransformNode) => boolean): TransformNode[] {
232
- let nodes: TransformNode[] = [];
233
- if (subject.tagName) {
234
- nodes = [
235
- ...nodes,
236
- ...this.viewer.scene.getTransformNodesByTags(subject.tagName, predicate),
237
- ...this.viewer.scene.getMeshesByTags(subject.tagName, predicate),
238
- ];
239
- }
240
- if (subject.nodeName) {
241
- nodes = [
242
- ...nodes,
243
- this.viewer.scene.getTransformNodeByName(subject.nodeName),
244
- this.viewer.scene.getMeshByName(subject.nodeName),
245
- ].filter(t => !!t && (!predicate || predicate(t))) as TransformNode[];
246
- }
247
- return nodes;
248
- }
249
-
250
- /**
251
- * Registers observers that are called on every new node added to the Babylon.js scene. The observers ensure that each
252
- * new node gets the state of the {@link TagManager}'s {@link parameters} applied.
253
- */
254
- public registerNewTransformNodeObservers(scene: Scene) {
255
- const onNewTransformNodeAdded = (node: TransformNode) => {
256
- if (node.name === Viewer.BOUNDING_BOX_NAME || !this.viewer.variantInstances.areAllDefinitionsCreated) {
257
- // Avoid duplicate calls here. The parameter values are already applied when a variant instance has finished
258
- // creating (see event listener in viewer for VARIANT_INSTANCE_CREATED). This callback should only trigger when
259
- // a consumer "manually" clones a node.
260
- return;
261
- }
262
- this.applyExistingParameterValuesTo([node]).then();
263
- };
264
- scene.onNewTransformNodeAddedObservable.makeObserverBottomPriority(
265
- scene.onNewTransformNodeAddedObservable.add(onNewTransformNodeAdded)!
266
- );
267
- scene.onNewMeshAddedObservable.makeObserverBottomPriority(
268
- scene.onNewMeshAddedObservable.add(onNewTransformNodeAdded)!
269
- );
270
- }
271
-
272
- /**
273
- * Adds the default {@link ParameterObserver}s.
274
- * @protected
275
- */
276
- protected addParameterObservers(): TagManager {
277
- this.parameterObservers.set(Parameter.VISIBLE, async payload => {
278
- let visible;
279
- try {
280
- visible = Parameter.parseBoolean(payload.newValue);
281
- } catch (e) {
282
- return false;
283
- }
284
- if (visible === true) {
285
- for (const node of payload.nodes) {
286
- node.setEnabled(true);
287
- }
288
- } else if (visible === false) {
289
- for (const node of payload.nodes) {
290
- node.setEnabled(false);
291
- }
292
- }
293
- return true;
294
- });
295
- this.parameterObservers.set(Parameter.SCALING, async payload => {
296
- for (const node of payload.nodes) {
297
- node.scaling = Parameter.parseVector(payload.newValue);
298
- }
299
- return true;
300
- });
301
- this.parameterObservers.set(Parameter.POSITION, async payload => {
302
- for (const node of payload.nodes) {
303
- node.position = Parameter.parseVector(payload.newValue);
304
- }
305
- return true;
306
- });
307
- this.parameterObservers.set(Parameter.ROTATION, async payload => {
308
- for (const node of payload.nodes) {
309
- node.rotation = Parameter.parseRotation(payload.newValue);
310
- }
311
- return true;
312
- });
313
- this.parameterObservers.set(Parameter.MATERIAL, async payload => {
314
- for (const node of payload.nodes) {
315
- assertMeshCapability(node, Parameter.MATERIAL);
316
- setMaterial(node, payload.newValue.toString(), false);
317
- }
318
- return true;
319
- });
320
- this.parameterObservers.set(Parameter.MATERIAL_COLOR, async payload => {
321
- const parsedValue = Parameter.parseColor(payload.newValue);
322
- for (const node of payload.nodes) {
323
- assertMeshCapability(node, Parameter.MATERIAL_COLOR);
324
- if (this.viewer.cloneMaterialsOnMutation) {
325
- if (!has(node.metadata, 'dirty.material')) {
326
- cloneTransformNodeMaterial(node);
327
- }
328
- if (!has(node.metadata, 'dirty.material.color')) {
329
- // inject initial value and mark as dirty
330
- injectNodeMetadata(node, { dirty: { material: { color: payload.oldValue } } }, false);
331
- }
332
- }
333
- setMaterialColor(node, parsedValue, false);
334
- }
335
- return true;
336
- });
337
- this.parameterObservers.set(Parameter.MATERIAL_ROUGHNESS, async payload => {
338
- const parsedValue = Parameter.parseNumber(payload.newValue);
339
- for (const node of payload.nodes as AbstractMesh[]) {
340
- assertMeshCapability(node, Parameter.MATERIAL_ROUGHNESS);
341
- if (this.viewer.cloneMaterialsOnMutation) {
342
- if (!has(node.metadata, 'dirty.material')) {
343
- cloneTransformNodeMaterial(node);
344
- }
345
- if (!has(node.metadata, 'dirty.material.roughness')) {
346
- // inject initial value and mark as dirty
347
- injectNodeMetadata(node, { dirty: { material: { color: payload.oldValue } } }, false);
348
- }
349
- }
350
- setMaterialRoughness(node, parsedValue, false);
351
- }
352
- return true;
353
- });
354
- this.parameterObservers.set(Parameter.MATERIAL_METALLNESS, async payload => {
355
- const parsedValue = Parameter.parseNumber(payload.newValue);
356
- for (const node of payload.nodes as AbstractMesh[]) {
357
- assertMeshCapability(node, Parameter.MATERIAL_METALLNESS);
358
- if (this.viewer.cloneMaterialsOnMutation) {
359
- if (!has(node.metadata, 'dirty.material')) {
360
- cloneTransformNodeMaterial(node);
361
- }
362
- if (!has(node.metadata, 'dirty.material.metallness')) {
363
- // inject initial value and mark as dirty
364
- injectNodeMetadata(node, { dirty: { material: { color: payload.oldValue } } }, false);
365
- }
366
- }
367
- setMaterialMetallness(node, parsedValue, false);
368
- }
369
- return true;
370
- });
371
- return this;
372
- }
373
-
374
- /**
375
- * Passes all {@link ParameterValue}s of the given {@link ParameterBag} for given {@link TagManagerSubject} to
376
- * {@link handleParameter}.
377
- * @protected
378
- */
379
- protected handleParameterBag(
380
- subject: TagManagerSubject,
381
- parameters: ParameterBag
382
- ): Promise<ParameterObserverResult>[] {
383
- const observerPromises: Promise<ParameterObserverResult>[] = [];
384
- for (const parameter in parameters) {
385
- observerPromises.push(this.handleParameter(subject, parameter, parameters[parameter]));
386
- }
387
- return observerPromises;
388
- }
389
-
390
- /**
391
- * Asserts the given {@link Parameter} and its {@link ParameterValue}, stores the state in the {@link TagManager}'s
392
- * {@link parameters}, calculates the applicable nodes, injects the {@link ParameterValue} in the node's metadata,
393
- * calls the responsible {@link ParameterObserver}s and emits the event {@link Event.TAG_MANAGER_PARAMETER_COMMITTED}.
394
- * @protected
395
- */
396
- protected async handleParameter(
397
- subject: TagManagerSubject,
398
- parameter: string,
399
- parameterValue: ParameterValue
400
- ): Promise<ParameterObserverResult> {
401
- Parameter.assertParameter(Parameter.declarations, parameter, parameterValue);
402
- if (!this.parameterObservers.has(parameter)) {
403
- return Promise.resolve(false);
404
- }
405
- const parameterBag = this.parameters.get(subject) || {};
406
- const oldValue = parameterBag[parameter];
407
- if (oldValue === parameterValue) {
408
- return Promise.resolve(false);
409
- }
410
- this.parameters.set(subject, parameterBag);
411
- this.parameters.get(subject)![parameter] = parameterValue;
412
- const nodes = this.getNodesBySubject(subject);
413
- if (nodes.length === 0) {
414
- return Promise.resolve(false);
415
- }
416
- const observer = this.parameterObservers.get(parameter)!;
417
- const result = await observer({ subject: subject, nodes: nodes, newValue: parameterValue, oldValue: oldValue });
418
- if (result === false) {
419
- // reset to old value if observer was not successful
420
- this.parameters.get(subject)![parameter] = oldValue;
421
- }
422
- emitter.emit(Event.TAG_MANAGER_PARAMETER_COMMITTED, {
423
- subject: subject,
424
- parameter: parameter,
425
- nodes: nodes,
426
- oldValue: oldValue,
427
- newValue: parameterValue,
428
- result: result,
429
- });
430
- }
431
-
432
- /**
433
- * Updates the state of the {@link TagManager}'s {@link parameters} for all new nodes and tags given in
434
- * {@link TagMapping}.
435
- * @protected
436
- */
437
- protected updateParametersWithNodeAndTagMapping(nodes: TransformNode[], tagMapping: TagMapping): void {
438
- // create node mapping by linking the clone source name to the new node name
439
- const nodeMapping = nodes.reduce((accNodeMapping, curNode) => {
440
- const oldNode = get(curNode.metadata, 'cloneSource') as TransformNode;
441
- if (oldNode) {
442
- accNodeMapping[oldNode.name] = curNode.name;
443
- }
444
-
445
- return accNodeMapping;
446
- }, {} as TagMapping);
447
-
448
- for (const subject of this.parameters.keys()) {
449
- const isNode = subject.nodeName;
450
- const newName = isNode ? nodeMapping[subject.nodeName] : tagMapping[subject.tagName];
451
- if (!newName) {
452
- continue;
453
- }
454
-
455
- const newSubject = clone(subject);
456
- newSubject[isNode ? 'nodeName' : 'tagName'] = newName;
457
- const parameterBag = clone(this.parameters.get(subject)!);
458
- merge(parameterBag, this.parameters.get(newSubject));
459
- this.parameters.set(newSubject, parameterBag);
460
- }
461
- }
462
-
463
- /**
464
- * Clears the applied {@link ParameterBag} state of the node's metadata to ensure that observers trigger (once again).
465
- * This is necessary e.g. after mapping tags when a nodeName subject shall override the parameterValue of a mapped
466
- * tag.
467
- * @protected
468
- */
469
- protected clearAppliedNodeMetadataParameters(nodes: TransformNode[]): void {
470
- for (const node of nodes) {
471
- if (!node.metadata?.tagManager?.parameters) {
472
- continue;
473
- }
474
- node.metadata.tagManager.parameters = {};
475
- }
476
- }
477
- }
1
+ import { Event, emitter } from '../classes/event';
2
+ import { FuzzyMap } from '../classes/fuzzyMap';
3
+ import { Parameter } from '../classes/parameter';
4
+ import { Viewer } from '../classes/viewer';
5
+ import {
6
+ assertMeshCapability,
7
+ cloneTransformNodeMaterial,
8
+ injectNodeMetadata,
9
+ mapTags,
10
+ setMaterial,
11
+ setMaterialColor,
12
+ setMaterialMetallness,
13
+ setMaterialRoughness,
14
+ } from '../util/babylonHelper';
15
+ import { AbstractMesh } from '@babylonjs/core/Meshes/abstractMesh';
16
+ import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
17
+ import { Tags } from '@babylonjs/core/Misc/tags';
18
+ import { clone, get, has, merge, uniq } from 'lodash-es';
19
+
20
+ export class TagManager {
21
+ public readonly parameters: TagManagerParameterBag = new FuzzyMap();
22
+
23
+ public readonly parameterObservers: TagManagerParameterObserverBag = new Map();
24
+
25
+ /**
26
+ * Constructor.
27
+ */
28
+ public constructor(protected viewer: Viewer) {
29
+ this.addParameterObservers();
30
+ }
31
+
32
+ /**
33
+ * Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
34
+ * nodes with given tagName.
35
+ */
36
+ public async setTagParameterValue(
37
+ tagName: string,
38
+ parameterName: string,
39
+ value: ParameterValue
40
+ ): Promise<ParameterObserverResult> {
41
+ return await this.handleParameter({ tagName: tagName }, parameterName, value);
42
+ }
43
+
44
+ /**
45
+ * Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
46
+ * nodes with given nodeName.
47
+ */
48
+ public async setNodeParameterValue(
49
+ nodeName: string,
50
+ parameterName: string,
51
+ value: ParameterValue
52
+ ): Promise<ParameterObserverResult> {
53
+ return await this.handleParameter({ nodeName: nodeName }, parameterName, value);
54
+ }
55
+
56
+ /**
57
+ * Splits the passed {@link TagManagerParameterValue}s into individual values and calls all {@link ParameterObserver}s
58
+ * of all {@link Parameter}s with the respective {@link TagManagerSubject} and {@link ParameterValue}. The result is a
59
+ * map of passed {@link TagManagerParameterValue}s and the associated {@link ParameterObserverResult} of the
60
+ * {@link ParameterObserver}.
61
+ */
62
+ public async setParameterValues(
63
+ values: TagManagerParameterValue[]
64
+ ): Promise<Map<TagManagerParameterValue, ParameterObserverResult>> {
65
+ const observerResultMap: Map<TagManagerParameterValue, ParameterObserverResult> = new Map();
66
+ const tagPromises: Promise<ParameterObserverResult>[] = [];
67
+ const nodePromises: Promise<ParameterObserverResult>[] = [];
68
+ for (const value of values) {
69
+ const subject: TagManagerSubject = {};
70
+ if (value.tagName) {
71
+ subject.tagName = value.tagName;
72
+ }
73
+ if (value.nodeName) {
74
+ subject.nodeName = value.nodeName;
75
+ }
76
+ const observerResultPromise = this.handleParameter(subject, value.parameterName, value.value);
77
+ observerResultPromise.then(result => observerResultMap.set(value, result));
78
+ if (value.tagName) {
79
+ tagPromises.push(observerResultPromise);
80
+ }
81
+ if (value.nodeName) {
82
+ nodePromises.push(observerResultPromise);
83
+ }
84
+ }
85
+ await Promise.all(tagPromises);
86
+ await Promise.all(nodePromises);
87
+ return observerResultMap;
88
+ }
89
+
90
+ /**
91
+ * Gets a list of {@link TagManagerSubject}s that are present in both the state of the {@link TagManager}'s
92
+ * {@link parameters} and the given node.
93
+ */
94
+ public getSubjectsFor(node: TransformNode): TagManagerSubject[] {
95
+ return [...this.parameters.keys()].filter(
96
+ subject =>
97
+ (subject.tagName && Tags.MatchesQuery(node, subject.tagName)) ||
98
+ (subject.nodeName && node.name === subject.nodeName)
99
+ );
100
+ }
101
+
102
+ /**
103
+ * Gets a list of {@link TagManagerSubject}s that are present in both the state of the {@link TagManager}'s
104
+ * {@link parameters} and the given nodes.
105
+ */
106
+ public getApplicableSubjectsFor(nodes: TransformNode[]): TagManagerSubject[] {
107
+ let applicableSubjects: TagManagerSubject[] = [];
108
+ for (const node of nodes) {
109
+ const subjects = this.getSubjectsFor(node);
110
+ applicableSubjects = [...applicableSubjects, ...subjects];
111
+ }
112
+ return uniq(applicableSubjects);
113
+ }
114
+
115
+ /**
116
+ * Applies all existing states of the {@link TagManager}'s {@link parameters} for given {@link TagManagerSubject}s.
117
+ */
118
+ public async applyExistingParameterValuesFor(
119
+ subjects: TagManagerSubject[]
120
+ ): Promise<Map<TagManagerSubject, ParameterObserverResult>> {
121
+ const observerResultMap: Map<TagManagerSubject, ParameterObserverResult> = new Map();
122
+ let tagPromises: Promise<ParameterObserverResult>[] = [];
123
+ let nodePromises: Promise<ParameterObserverResult>[] = [];
124
+ for (const subject of subjects) {
125
+ this.clearAppliedNodeMetadataParameters(this.getNodesBySubject(subject));
126
+ const observerResultPromises = this.handleParameterBag(subject, this.parameters.get(subject)!);
127
+ for (const observerResultPromise of observerResultPromises) {
128
+ observerResultPromise.then(result => observerResultMap.set(subject, result));
129
+ }
130
+ if (subject.tagName) {
131
+ tagPromises = [...tagPromises, ...observerResultPromises];
132
+ }
133
+ if (subject.nodeName) {
134
+ nodePromises = [...nodePromises, ...observerResultPromises];
135
+ }
136
+ }
137
+ await Promise.all(tagPromises);
138
+ await Promise.all(nodePromises);
139
+ return observerResultMap;
140
+ }
141
+
142
+ /**
143
+ * Does the same as {@link setParameterValues} with the difference that all existing states of the
144
+ * {@link TagManager}'s {@link parameters} are applied to all given nodes.
145
+ */
146
+ public async applyExistingParameterValuesTo(
147
+ nodes: TransformNode[]
148
+ ): Promise<Map<TagManagerSubject, ParameterObserverResult>> {
149
+ return this.applyExistingParameterValuesFor(this.getApplicableSubjectsFor(nodes));
150
+ }
151
+
152
+ /**
153
+ * Applies all existing states of the {@link TagManager}'s {@link parameters} for all {@link TagManagerSubject}s.
154
+ */
155
+ public async applyExistingParameterValues(): Promise<Map<TagManagerSubject, ParameterObserverResult>> {
156
+ return this.applyExistingParameterValuesFor([...this.parameters.keys()]);
157
+ }
158
+
159
+ /**
160
+ * Maps all tags on given nodes with the {@link TagMapping} and updates the state of the {@link TagManager}'s
161
+ * {@link parameters} for all new tags.
162
+ * Also updates the state of all nodes in the tag managers parameter state.
163
+ */
164
+ public mapNodesAndTags(nodes: TransformNode[], tagMapping: TagMapping): TagManager {
165
+ this.updateParametersWithNodeAndTagMapping(nodes, tagMapping);
166
+ mapTags(nodes, tagMapping);
167
+ return this;
168
+ }
169
+
170
+ /**
171
+ * Gets a distinct list of all tags within the current scene.
172
+ */
173
+ public getAllTags(): string[] {
174
+ const tags: string[] = [];
175
+ const nodes = this.viewer.scene.getNodes();
176
+ for (const node of nodes) {
177
+ tags.push(...Object.keys(Tags.GetTags(node, false) ?? {}));
178
+ }
179
+ return [...new Set(tags)];
180
+ }
181
+
182
+ /**
183
+ * Prints the state of the {@link TagManager}'s {@link parameters} to the console.
184
+ */
185
+ public printAllTags(): void {
186
+ const printable = [];
187
+ for (const subject of this.parameters.keys()) {
188
+ const parameterBag = this.parameters.get(subject);
189
+ for (const parameter in parameterBag) {
190
+ printable.push({
191
+ subject: JSON.stringify(subject),
192
+ parameter: parameter,
193
+ value: parameterBag[parameter],
194
+ nodes: this.getNodesBySubject(subject),
195
+ });
196
+ }
197
+ }
198
+ console.table(printable);
199
+ }
200
+
201
+ /**
202
+ * Prints the state of the {@link TagManager}'s {@link parameters} for one tagName to the console.
203
+ */
204
+ public printTagInfo(tagName: string): void {
205
+ const parameterBag = this.parameters.get({ tagName: tagName });
206
+ const printable = [];
207
+ for (const parameter in parameterBag) {
208
+ printable.push({
209
+ parameter: parameter,
210
+ value: parameterBag[parameter],
211
+ nodes: this.getNodesBySubject({ tagName: tagName }),
212
+ });
213
+ }
214
+ console.table(printable);
215
+ }
216
+
217
+ /**
218
+ * Sets a {@link ParameterObserver} for the given {@link Parameter}.
219
+ *
220
+ * The observer should return `false` in cases where the given value was not actually applied. E.g. when wanting to
221
+ * apply a property on the given `node`s material which doesn't exist at the time the observer is called etc.
222
+ */
223
+ public setParameterObserver(parameter: string, observer: TagManagerParameterObserver): TagManager {
224
+ this.parameterObservers.set(parameter, observer);
225
+ return this;
226
+ }
227
+
228
+ /**
229
+ * Gets all nodes for given {@link TagManagerSubject} on the Babylon.js scene.
230
+ */
231
+ public getNodesBySubject(subject: TagManagerSubject, predicate?: (node: TransformNode) => boolean): TransformNode[] {
232
+ let nodes: TransformNode[] = [];
233
+ if (subject.tagName) {
234
+ nodes = [
235
+ ...nodes,
236
+ ...this.viewer.scene.getTransformNodesByTags(subject.tagName, predicate),
237
+ ...this.viewer.scene.getMeshesByTags(subject.tagName, predicate),
238
+ ];
239
+ }
240
+ if (subject.nodeName) {
241
+ nodes = [
242
+ ...nodes,
243
+ this.viewer.scene.getTransformNodeByName(subject.nodeName),
244
+ this.viewer.scene.getMeshByName(subject.nodeName),
245
+ ].filter(t => !!t && (!predicate || predicate(t))) as TransformNode[];
246
+ }
247
+ return nodes;
248
+ }
249
+
250
+ /**
251
+ * Registers observers that are called on every new node added to the Babylon.js scene. The observers ensure that each
252
+ * new node gets the state of the {@link TagManager}'s {@link parameters} applied.
253
+ */
254
+ public registerNewTransformNodeObservers(scene: Scene) {
255
+ const onNewTransformNodeAdded = (node: TransformNode) => {
256
+ if (node.name === Viewer.BOUNDING_BOX_NAME || !this.viewer.variantInstances.areAllDefinitionsCreated) {
257
+ // Avoid duplicate calls here. The parameter values are already applied when a variant instance has finished
258
+ // creating (see event listener in viewer for VARIANT_INSTANCE_CREATED). This callback should only trigger when
259
+ // a consumer "manually" clones a node.
260
+ return;
261
+ }
262
+ this.applyExistingParameterValuesTo([node]).then();
263
+ };
264
+ scene.onNewTransformNodeAddedObservable.makeObserverBottomPriority(
265
+ scene.onNewTransformNodeAddedObservable.add(onNewTransformNodeAdded)!
266
+ );
267
+ scene.onNewMeshAddedObservable.makeObserverBottomPriority(
268
+ scene.onNewMeshAddedObservable.add(onNewTransformNodeAdded)!
269
+ );
270
+ }
271
+
272
+ /**
273
+ * Adds the default {@link ParameterObserver}s.
274
+ * @protected
275
+ */
276
+ protected addParameterObservers(): TagManager {
277
+ this.parameterObservers.set(Parameter.VISIBLE, async payload => {
278
+ let visible;
279
+ try {
280
+ visible = Parameter.parseBoolean(payload.newValue);
281
+ } catch (e) {
282
+ return false;
283
+ }
284
+ if (visible === true) {
285
+ for (const node of payload.nodes) {
286
+ node.setEnabled(true);
287
+ }
288
+ } else if (visible === false) {
289
+ for (const node of payload.nodes) {
290
+ node.setEnabled(false);
291
+ }
292
+ }
293
+ return true;
294
+ });
295
+ this.parameterObservers.set(Parameter.SCALING, async payload => {
296
+ for (const node of payload.nodes) {
297
+ node.scaling = Parameter.parseVector(payload.newValue);
298
+ }
299
+ return true;
300
+ });
301
+ this.parameterObservers.set(Parameter.POSITION, async payload => {
302
+ for (const node of payload.nodes) {
303
+ node.position = Parameter.parseVector(payload.newValue);
304
+ }
305
+ return true;
306
+ });
307
+ this.parameterObservers.set(Parameter.ROTATION, async payload => {
308
+ for (const node of payload.nodes) {
309
+ node.rotation = Parameter.parseRotation(payload.newValue);
310
+ }
311
+ return true;
312
+ });
313
+ this.parameterObservers.set(Parameter.MATERIAL, async payload => {
314
+ for (const node of payload.nodes) {
315
+ assertMeshCapability(node, Parameter.MATERIAL);
316
+ setMaterial(node, payload.newValue.toString(), false);
317
+ }
318
+ return true;
319
+ });
320
+ this.parameterObservers.set(Parameter.MATERIAL_COLOR, async payload => {
321
+ const parsedValue = Parameter.parseColor(payload.newValue);
322
+ for (const node of payload.nodes) {
323
+ assertMeshCapability(node, Parameter.MATERIAL_COLOR);
324
+ if (this.viewer.cloneMaterialsOnMutation) {
325
+ if (!has(node.metadata, 'dirty.material')) {
326
+ cloneTransformNodeMaterial(node);
327
+ }
328
+ if (!has(node.metadata, 'dirty.material.color')) {
329
+ // inject initial value and mark as dirty
330
+ injectNodeMetadata(node, { dirty: { material: { color: payload.oldValue } } }, false);
331
+ }
332
+ }
333
+ setMaterialColor(node, parsedValue, false);
334
+ }
335
+ return true;
336
+ });
337
+ this.parameterObservers.set(Parameter.MATERIAL_ROUGHNESS, async payload => {
338
+ const parsedValue = Parameter.parseNumber(payload.newValue);
339
+ for (const node of payload.nodes as AbstractMesh[]) {
340
+ assertMeshCapability(node, Parameter.MATERIAL_ROUGHNESS);
341
+ if (this.viewer.cloneMaterialsOnMutation) {
342
+ if (!has(node.metadata, 'dirty.material')) {
343
+ cloneTransformNodeMaterial(node);
344
+ }
345
+ if (!has(node.metadata, 'dirty.material.roughness')) {
346
+ // inject initial value and mark as dirty
347
+ injectNodeMetadata(node, { dirty: { material: { color: payload.oldValue } } }, false);
348
+ }
349
+ }
350
+ setMaterialRoughness(node, parsedValue, false);
351
+ }
352
+ return true;
353
+ });
354
+ this.parameterObservers.set(Parameter.MATERIAL_METALLNESS, async payload => {
355
+ const parsedValue = Parameter.parseNumber(payload.newValue);
356
+ for (const node of payload.nodes as AbstractMesh[]) {
357
+ assertMeshCapability(node, Parameter.MATERIAL_METALLNESS);
358
+ if (this.viewer.cloneMaterialsOnMutation) {
359
+ if (!has(node.metadata, 'dirty.material')) {
360
+ cloneTransformNodeMaterial(node);
361
+ }
362
+ if (!has(node.metadata, 'dirty.material.metallness')) {
363
+ // inject initial value and mark as dirty
364
+ injectNodeMetadata(node, { dirty: { material: { color: payload.oldValue } } }, false);
365
+ }
366
+ }
367
+ setMaterialMetallness(node, parsedValue, false);
368
+ }
369
+ return true;
370
+ });
371
+ return this;
372
+ }
373
+
374
+ /**
375
+ * Passes all {@link ParameterValue}s of the given {@link ParameterBag} for given {@link TagManagerSubject} to
376
+ * {@link handleParameter}.
377
+ * @protected
378
+ */
379
+ protected handleParameterBag(
380
+ subject: TagManagerSubject,
381
+ parameters: ParameterBag
382
+ ): Promise<ParameterObserverResult>[] {
383
+ const observerPromises: Promise<ParameterObserverResult>[] = [];
384
+ for (const parameter in parameters) {
385
+ observerPromises.push(this.handleParameter(subject, parameter, parameters[parameter]));
386
+ }
387
+ return observerPromises;
388
+ }
389
+
390
+ /**
391
+ * Asserts the given {@link Parameter} and its {@link ParameterValue}, stores the state in the {@link TagManager}'s
392
+ * {@link parameters}, calculates the applicable nodes, injects the {@link ParameterValue} in the node's metadata,
393
+ * calls the responsible {@link ParameterObserver}s and emits the event {@link Event.TAG_MANAGER_PARAMETER_COMMITTED}.
394
+ * @protected
395
+ */
396
+ protected async handleParameter(
397
+ subject: TagManagerSubject,
398
+ parameter: string,
399
+ parameterValue: ParameterValue
400
+ ): Promise<ParameterObserverResult> {
401
+ Parameter.assertParameter(Parameter.declarations, parameter, parameterValue);
402
+ if (!this.parameterObservers.has(parameter)) {
403
+ return Promise.resolve(false);
404
+ }
405
+ const parameterBag = this.parameters.get(subject) || {};
406
+ const oldValue = parameterBag[parameter];
407
+ if (oldValue === parameterValue) {
408
+ return Promise.resolve(false);
409
+ }
410
+ this.parameters.set(subject, parameterBag);
411
+ this.parameters.get(subject)![parameter] = parameterValue;
412
+ const nodes = this.getNodesBySubject(subject);
413
+ if (nodes.length === 0) {
414
+ return Promise.resolve(false);
415
+ }
416
+ const observer = this.parameterObservers.get(parameter)!;
417
+ const result = await observer({ subject: subject, nodes: nodes, newValue: parameterValue, oldValue: oldValue });
418
+ if (result === false) {
419
+ // reset to old value if observer was not successful
420
+ this.parameters.get(subject)![parameter] = oldValue;
421
+ }
422
+ emitter.emit(Event.TAG_MANAGER_PARAMETER_COMMITTED, {
423
+ subject: subject,
424
+ parameter: parameter,
425
+ nodes: nodes,
426
+ oldValue: oldValue,
427
+ newValue: parameterValue,
428
+ result: result,
429
+ });
430
+ }
431
+
432
+ /**
433
+ * Updates the state of the {@link TagManager}'s {@link parameters} for all new nodes and tags given in
434
+ * {@link TagMapping}.
435
+ * @protected
436
+ */
437
+ protected updateParametersWithNodeAndTagMapping(nodes: TransformNode[], tagMapping: TagMapping): void {
438
+ // create node mapping by linking the clone source name to the new node name
439
+ const nodeMapping = nodes.reduce((accNodeMapping, curNode) => {
440
+ const oldNode = get(curNode.metadata, 'cloneSource') as TransformNode;
441
+ if (oldNode) {
442
+ accNodeMapping[oldNode.name] = curNode.name;
443
+ }
444
+
445
+ return accNodeMapping;
446
+ }, {} as TagMapping);
447
+
448
+ for (const subject of this.parameters.keys()) {
449
+ const isNode = subject.nodeName;
450
+ const newName = isNode ? nodeMapping[subject.nodeName] : tagMapping[subject.tagName];
451
+ if (!newName) {
452
+ continue;
453
+ }
454
+
455
+ const newSubject = clone(subject);
456
+ newSubject[isNode ? 'nodeName' : 'tagName'] = newName;
457
+ const parameterBag = clone(this.parameters.get(subject)!);
458
+ merge(parameterBag, this.parameters.get(newSubject));
459
+ this.parameters.set(newSubject, parameterBag);
460
+ }
461
+ }
462
+
463
+ /**
464
+ * Clears the applied {@link ParameterBag} state of the node's metadata to ensure that observers trigger (once again).
465
+ * This is necessary e.g. after mapping tags when a nodeName subject shall override the parameterValue of a mapped
466
+ * tag.
467
+ * @protected
468
+ */
469
+ protected clearAppliedNodeMetadataParameters(nodes: TransformNode[]): void {
470
+ for (const node of nodes) {
471
+ if (!node.metadata?.tagManager?.parameters) {
472
+ continue;
473
+ }
474
+ node.metadata.tagManager.parameters = {};
475
+ }
476
+ }
477
+ }