@combeenation/3d-viewer 7.1.3 → 8.1.0-alpha1

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 (111) 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 +378 -351
  15. package/dist/lib-cjs/api/classes/parameter.js +551 -524
  16. package/dist/lib-cjs/api/classes/parameter.js.map +1 -1
  17. package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
  18. package/dist/lib-cjs/api/classes/parameterObservable.js +72 -72
  19. package/dist/lib-cjs/api/classes/parameterizable.d.ts +15 -15
  20. package/dist/lib-cjs/api/classes/parameterizable.js +102 -102
  21. package/dist/lib-cjs/api/classes/placementAnimation.d.ts +45 -45
  22. package/dist/lib-cjs/api/classes/placementAnimation.js +176 -176
  23. package/dist/lib-cjs/api/classes/variant.d.ts +261 -253
  24. package/dist/lib-cjs/api/classes/variant.js +870 -858
  25. package/dist/lib-cjs/api/classes/variant.js.map +1 -1
  26. package/dist/lib-cjs/api/classes/variantInstance.d.ts +53 -53
  27. package/dist/lib-cjs/api/classes/variantInstance.js +125 -125
  28. package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +17 -17
  29. package/dist/lib-cjs/api/classes/variantParameterizable.js +86 -86
  30. package/dist/lib-cjs/api/classes/viewer.d.ts +213 -213
  31. package/dist/lib-cjs/api/classes/viewer.js +717 -716
  32. package/dist/lib-cjs/api/classes/viewer.js.map +1 -1
  33. package/dist/lib-cjs/api/classes/viewerError.d.ts +43 -43
  34. package/dist/lib-cjs/api/classes/viewerError.js +55 -55
  35. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
  36. package/dist/lib-cjs/api/classes/viewerLight.js +348 -348
  37. package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
  38. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  39. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
  40. package/dist/lib-cjs/api/internal/sceneSetup.js +226 -226
  41. package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
  42. package/dist/lib-cjs/api/manager/animationManager.js +126 -126
  43. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +103 -79
  44. package/dist/lib-cjs/api/manager/gltfExportManager.js +325 -242
  45. package/dist/lib-cjs/api/manager/gltfExportManager.js.map +1 -1
  46. package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
  47. package/dist/lib-cjs/api/manager/sceneManager.js +128 -128
  48. package/dist/lib-cjs/api/manager/tagManager.d.ts +118 -116
  49. package/dist/lib-cjs/api/manager/tagManager.js +508 -444
  50. package/dist/lib-cjs/api/manager/tagManager.js.map +1 -1
  51. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
  52. package/dist/lib-cjs/api/manager/textureLoadManager.js +97 -97
  53. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +106 -106
  54. package/dist/lib-cjs/api/manager/variantInstanceManager.js +290 -292
  55. package/dist/lib-cjs/api/manager/variantInstanceManager.js.map +1 -1
  56. package/dist/lib-cjs/api/store/specStorage.d.ts +32 -32
  57. package/dist/lib-cjs/api/store/specStorage.js +65 -65
  58. package/dist/lib-cjs/api/util/babylonHelper.d.ts +235 -235
  59. package/dist/lib-cjs/api/util/babylonHelper.js +753 -753
  60. package/dist/lib-cjs/api/util/globalTypes.d.ts +469 -455
  61. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  62. package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
  63. package/dist/lib-cjs/api/util/resourceHelper.js +203 -203
  64. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +44 -44
  65. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +175 -175
  66. package/dist/lib-cjs/api/util/stringHelper.d.ts +13 -13
  67. package/dist/lib-cjs/api/util/stringHelper.js +32 -32
  68. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
  69. package/dist/lib-cjs/api/util/structureHelper.js +60 -57
  70. package/dist/lib-cjs/api/util/structureHelper.js.map +1 -1
  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 +54 -54
  74. package/dist/lib-cjs/index.js +117 -117
  75. package/package.json +81 -81
  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 +733 -733
  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 +591 -561
  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 +963 -949
  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 +770 -772
  90. package/src/api/classes/viewerError.ts +63 -63
  91. package/src/api/classes/viewerLight.ts +339 -339
  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 +205 -205
  95. package/src/api/manager/animationManager.ts +143 -143
  96. package/src/api/manager/gltfExportManager.ts +302 -237
  97. package/src/api/manager/sceneManager.ts +134 -134
  98. package/src/api/manager/tagManager.ts +536 -477
  99. package/src/api/manager/textureLoadManager.ts +95 -95
  100. package/src/api/manager/variantInstanceManager.ts +306 -309
  101. package/src/api/store/specStorage.ts +68 -68
  102. package/src/api/util/babylonHelper.ts +823 -823
  103. package/src/api/util/globalTypes.ts +543 -525
  104. package/src/api/util/resourceHelper.ts +191 -191
  105. package/src/api/util/sceneLoaderHelper.ts +170 -170
  106. package/src/api/util/stringHelper.ts +30 -30
  107. package/src/api/util/structureHelper.ts +60 -58
  108. package/src/buildinfo.json +3 -3
  109. package/src/dev.ts +62 -62
  110. package/src/index.ts +103 -103
  111. package/src/types.d.ts +38 -38
@@ -1,477 +1,536 @@
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 { assertMeshCapability, mapTags, setMaterial } from '../util/babylonHelper';
6
+ import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
7
+ import { Tags } from '@babylonjs/core/Misc/tags';
8
+ import { clone, get, merge, uniq } from 'lodash-es';
9
+
10
+ export class TagManager {
11
+ public readonly parameters: TagManagerParameterBag = new FuzzyMap();
12
+
13
+ public readonly parameterObservers: TagManagerParameterObserverBag = new Map();
14
+
15
+ /**
16
+ * Constructor.
17
+ */
18
+ public constructor(protected viewer: Viewer) {
19
+ this.addParameterObservers();
20
+ }
21
+
22
+ /**
23
+ * Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
24
+ * nodes with given tagName.
25
+ */
26
+ public async setTagParameterValue(
27
+ tagName: string,
28
+ parameterName: string,
29
+ value: ParameterValue
30
+ ): Promise<TagManagerParameterObserverResultBag> {
31
+ return await this.handleParameter({ tagName: tagName }, parameterName, value);
32
+ }
33
+
34
+ /**
35
+ * Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
36
+ * nodes with given nodeName.
37
+ */
38
+ public async setNodeParameterValue(
39
+ nodeName: string,
40
+ parameterName: string,
41
+ value: ParameterValue
42
+ ): Promise<TagManagerParameterObserverResultBag> {
43
+ return await this.handleParameter({ nodeName: nodeName }, parameterName, value);
44
+ }
45
+
46
+ /**
47
+ * Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
48
+ * materials with given materialName.
49
+ */
50
+ public async setMaterialParameterValue(
51
+ materialName: string,
52
+ parameterName: string,
53
+ value: ParameterValue
54
+ ): Promise<TagManagerParameterObserverResultBag> {
55
+ return await this.handleParameter({ materialName: materialName }, parameterName, value);
56
+ }
57
+
58
+ /**
59
+ * Splits the passed {@link TagManagerParameterValue}s into individual values and calls all {@link ParameterObserver}s
60
+ * of all {@link Parameter}s with the respective {@link TagManagerSubject} and {@link ParameterValue}. The result is a
61
+ * map of passed {@link TagManagerParameterValue}s and the associated {@link TagManagerParameterObserverResult} of the
62
+ * {@link ParameterObserver}.
63
+ */
64
+ public async setParameterValues(
65
+ values: TagManagerParameterValue[]
66
+ ): Promise<Map<TagManagerParameterValue, TagManagerParameterObserverResultBag>> {
67
+ const observerResultMap: Map<TagManagerParameterValue, TagManagerParameterObserverResultBag> = new Map();
68
+ const tagPromises: Promise<TagManagerParameterObserverResultBag>[] = [];
69
+ const nodePromises: Promise<TagManagerParameterObserverResultBag>[] = [];
70
+ const materialPromises: Promise<TagManagerParameterObserverResultBag>[] = [];
71
+ for (const value of values) {
72
+ const subject: TagManagerSubject = {};
73
+ if (value.tagName) {
74
+ subject.tagName = value.tagName;
75
+ }
76
+ if (value.nodeName) {
77
+ subject.nodeName = value.nodeName;
78
+ }
79
+ if (value.materialName) {
80
+ subject.materialName = value.materialName;
81
+ }
82
+ const observerResultPromise = this.handleParameter(subject, value.parameterName, value.value);
83
+ observerResultPromise.then(result => observerResultMap.set(value, result));
84
+ if (value.tagName) {
85
+ tagPromises.push(observerResultPromise);
86
+ }
87
+ if (value.nodeName) {
88
+ nodePromises.push(observerResultPromise);
89
+ }
90
+ if (value.materialName) {
91
+ materialPromises.push(observerResultPromise);
92
+ }
93
+ }
94
+ await Promise.all(tagPromises);
95
+ await Promise.all(nodePromises);
96
+ await Promise.all(materialPromises);
97
+ return observerResultMap;
98
+ }
99
+
100
+ /**
101
+ * Gets a list of {@link TagManagerSubject}s that are present in both the state of the {@link TagManager}'s
102
+ * {@link parameters} and the given object.
103
+ */
104
+ public getSubjectsFor(object: TransformNode | Material): TagManagerSubject[] {
105
+ return [...this.parameters.keys()].filter(
106
+ subject =>
107
+ (subject.tagName && Tags.MatchesQuery(object, subject.tagName)) ||
108
+ (subject.nodeName && object.name === subject.nodeName) ||
109
+ (subject.materialName && object.name === subject.materialName)
110
+ );
111
+ }
112
+
113
+ /**
114
+ * Gets a list of {@link TagManagerSubject}s that are present in both the state of the {@link TagManager}'s
115
+ * {@link parameters} and the given objects.
116
+ */
117
+ public getApplicableSubjectsFor(objects: (TransformNode | Material)[]): TagManagerSubject[] {
118
+ let applicableSubjects: TagManagerSubject[] = [];
119
+ for (const object of objects) {
120
+ const subjects = this.getSubjectsFor(object);
121
+ applicableSubjects = [...applicableSubjects, ...subjects];
122
+ }
123
+ return uniq(applicableSubjects);
124
+ }
125
+
126
+ /**
127
+ * Applies all existing states of the {@link TagManager}'s {@link parameters} for given {@link TagManagerSubject}s.
128
+ */
129
+ public async applyExistingParameterValuesFor(
130
+ subjects: TagManagerSubject[]
131
+ ): Promise<Map<TagManagerSubject, TagManagerParameterObserverResultBag>> {
132
+ const observerResultMap: Map<TagManagerSubject, TagManagerParameterObserverResultBag> = new Map();
133
+ let tagPromises: Promise<TagManagerParameterObserverResultBag>[] = [];
134
+ let nodePromises: Promise<TagManagerParameterObserverResultBag>[] = [];
135
+ let materialPromises: Promise<TagManagerParameterObserverResultBag>[] = [];
136
+ for (const subject of subjects) {
137
+ const observerResultPromises = this.handleParameterBag(subject, this.parameters.get(subject)!);
138
+ for (const observerResultPromise of observerResultPromises) {
139
+ observerResultPromise.then(result => observerResultMap.set(subject, result));
140
+ }
141
+ if (subject.tagName) {
142
+ tagPromises = [...tagPromises, ...observerResultPromises];
143
+ }
144
+ if (subject.nodeName) {
145
+ nodePromises = [...nodePromises, ...observerResultPromises];
146
+ }
147
+ if (subject.materialName) {
148
+ materialPromises = [...materialPromises, ...observerResultPromises];
149
+ }
150
+ }
151
+ await Promise.all(tagPromises);
152
+ await Promise.all(nodePromises);
153
+ await Promise.all(materialPromises);
154
+ return observerResultMap;
155
+ }
156
+
157
+ /**
158
+ * Does the same as {@link setParameterValues} with the difference that all existing states of the
159
+ * {@link TagManager}'s {@link parameters} are applied to all given nodes.
160
+ */
161
+ public async applyExistingParameterValuesTo(
162
+ objects: (TransformNode | Material)[]
163
+ ): Promise<Map<TagManagerSubject, TagManagerParameterObserverResultBag>> {
164
+ return this.applyExistingParameterValuesFor(this.getApplicableSubjectsFor(objects));
165
+ }
166
+
167
+ /**
168
+ * Applies all existing states of the {@link TagManager}'s {@link parameters} for all {@link TagManagerSubject}s.
169
+ */
170
+ public async applyExistingParameterValues(): Promise<Map<TagManagerSubject, TagManagerParameterObserverResultBag>> {
171
+ return this.applyExistingParameterValuesFor([...this.parameters.keys()]);
172
+ }
173
+
174
+ /**
175
+ * Maps all tags on given nodes with the {@link TagMapping} and updates the state of the {@link TagManager}'s
176
+ * {@link parameters} for all new tags.
177
+ * Also updates the state of all nodes in the tag managers parameter state.
178
+ */
179
+ public mapNodesAndTags(nodes: TransformNode[], tagMapping: TagMapping): TagManager {
180
+ this.updateParametersWithNodeAndTagMapping(nodes, tagMapping);
181
+ mapTags(nodes, tagMapping);
182
+ return this;
183
+ }
184
+
185
+ /**
186
+ * Gets a distinct list of all tags within the current scene.
187
+ */
188
+ public getAllTags(): string[] {
189
+ const tags: string[] = [];
190
+ const nodes = this.viewer.scene.getNodes();
191
+ for (const node of nodes) {
192
+ tags.push(...Object.keys(Tags.GetTags(node, false) ?? {}));
193
+ }
194
+ return [...new Set(tags)];
195
+ }
196
+
197
+ /**
198
+ * Prints the state of the {@link TagManager}'s {@link parameters} to the console.
199
+ */
200
+ public printAllTags(): void {
201
+ const printable = [];
202
+ for (const subject of this.parameters.keys()) {
203
+ const parameterBag = this.parameters.get(subject);
204
+ for (const parameter in parameterBag) {
205
+ printable.push({
206
+ subject: JSON.stringify(subject),
207
+ parameter: parameter,
208
+ value: parameterBag[parameter],
209
+ nodes: this.getNodesBySubject(subject),
210
+ });
211
+ }
212
+ }
213
+ console.table(printable);
214
+ }
215
+
216
+ /**
217
+ * Prints the state of the {@link TagManager}'s {@link parameters} for one tagName to the console.
218
+ */
219
+ public printTagInfo(tagName: string): void {
220
+ const parameterBag = this.parameters.get({ tagName: tagName });
221
+ const printable = [];
222
+ for (const parameter in parameterBag) {
223
+ printable.push({
224
+ parameter: parameter,
225
+ value: parameterBag[parameter],
226
+ nodes: this.getNodesBySubject({ tagName: tagName }),
227
+ });
228
+ }
229
+ console.table(printable);
230
+ }
231
+
232
+ /**
233
+ * Sets a {@link ParameterObserver} for the given {@link Parameter}.
234
+ *
235
+ * The observer should return `false` in cases where the given value was not actually applied. E.g. when wanting to
236
+ * apply a property on the given `node`s material which doesn't exist at the time the observer is called etc.
237
+ */
238
+ public setParameterObserver(parameter: string, observer: TagManagerParameterObserver): TagManager {
239
+ this.parameterObservers.set(parameter, observer);
240
+ return this;
241
+ }
242
+
243
+ /**
244
+ * Gets all nodes for given {@link TagManagerSubject} on the Babylon.js scene.
245
+ */
246
+ public getNodesBySubject(subject: TagManagerSubject, predicate?: (node: TransformNode) => boolean): TransformNode[] {
247
+ let nodes: TransformNode[] = [];
248
+ if (subject.tagName) {
249
+ nodes = [
250
+ ...nodes,
251
+ ...this.viewer.scene.getTransformNodesByTags(subject.tagName, predicate),
252
+ ...this.viewer.scene.getMeshesByTags(subject.tagName, predicate),
253
+ ];
254
+ }
255
+ if (subject.nodeName) {
256
+ nodes = [
257
+ ...nodes,
258
+ this.viewer.scene.getTransformNodeByName(subject.nodeName),
259
+ this.viewer.scene.getMeshByName(subject.nodeName),
260
+ ].filter(t => !!t && (!predicate || predicate(t))) as TransformNode[];
261
+ }
262
+ return nodes;
263
+ }
264
+
265
+ /**
266
+ * Gets all materials for given {@link TagManagerSubject} on the Babylon.js scene.
267
+ */
268
+ public getMaterialsBySubject(subject: TagManagerSubject, predicate?: (material: Material) => boolean): Material[] {
269
+ let materials: Material[] = [];
270
+ if (subject.tagName) {
271
+ materials = [...materials, ...this.viewer.scene.getMaterialByTags(subject.tagName, predicate)];
272
+ }
273
+ if (subject.materialName) {
274
+ materials = [...materials, this.viewer.scene.getMaterialByName(subject.materialName)].filter(
275
+ t => !!t && (!predicate || predicate(t))
276
+ ) as Material[];
277
+ }
278
+ return materials;
279
+ }
280
+
281
+ /**
282
+ * Registers observers that are called on every new object added to the Babylon.js scene.
283
+ * The observers ensure that each new object gets the state of the {@link TagManager}'s {@link parameters} applied.
284
+ */
285
+ public registerNewObjectObservers(scene: Scene) {
286
+ // nodes and meshes
287
+ const onNewTransformNodeAdded = (node: TransformNode) => {
288
+ /* NOTE:
289
+ Removed the check for created instances here since it is not guaranteed that all instances
290
+ created means that there is no scenario where new nodes should get TagManager parameters applied.
291
+ Instead, we check for the state to be enabled via the `onEnabledStateChangedObservable` below.
292
+ */
293
+ //if (node.name === Viewer.BOUNDING_BOX_NAME || !this.viewer.variantInstances.areAllDefinitionsCreated) {
294
+ if (node.name === Viewer.BOUNDING_BOX_NAME) {
295
+ return;
296
+ }
297
+ const onEnabledStateChangedObserver = node.onEnabledStateChangedObservable.add(async state => {
298
+ if (!state) {
299
+ // if the node is disabled, means ignoring also "ghost nodes"
300
+ return;
301
+ }
302
+ await this.applyExistingParameterValuesTo([node]);
303
+ node.onEnabledStateChangedObservable.remove(onEnabledStateChangedObserver);
304
+ });
305
+ node.onEnabledStateChangedObservable.makeObserverBottomPriority(onEnabledStateChangedObserver!);
306
+ };
307
+ scene.onNewTransformNodeAddedObservable.makeObserverBottomPriority(
308
+ scene.onNewTransformNodeAddedObservable.add(onNewTransformNodeAdded)!
309
+ );
310
+ scene.onNewMeshAddedObservable.makeObserverBottomPriority(
311
+ scene.onNewMeshAddedObservable.add(onNewTransformNodeAdded)!
312
+ );
313
+ // materials
314
+ const onNewMaterialAdded = (material: Material) => {
315
+ /* NOTE:
316
+ We have to wait until a material is bound to a Mesh. In all other scenarios, the material
317
+ is not "fully ready" or even empty (without working attributes/properties).
318
+ */
319
+ const onMaterialBindObserver = material.onBindObservable.add(async abstractMesh => {
320
+ await this.applyExistingParameterValuesTo([material]);
321
+ material.onBindObservable.remove(onMaterialBindObserver);
322
+ });
323
+ material.onBindObservable.makeObserverBottomPriority(onMaterialBindObserver!);
324
+ };
325
+ scene.onNewMaterialAddedObservable.makeObserverBottomPriority(
326
+ scene.onNewMaterialAddedObservable.add(onNewMaterialAdded)!
327
+ );
328
+ }
329
+
330
+ /**
331
+ * Adds the default {@link ParameterObserver}s.
332
+ * @protected
333
+ */
334
+ protected addParameterObservers(): TagManager {
335
+ this.parameterObservers.set(Parameter.VISIBLE, async payload => {
336
+ let visible;
337
+ try {
338
+ visible = Parameter.parseBoolean(payload.newValue);
339
+ } catch (e) {
340
+ return false;
341
+ }
342
+ if (visible === true) {
343
+ for (const node of payload.nodes) {
344
+ node.setEnabled(true);
345
+ }
346
+ } else if (visible === false) {
347
+ for (const node of payload.nodes) {
348
+ node.setEnabled(false);
349
+ }
350
+ }
351
+ return true;
352
+ });
353
+ this.parameterObservers.set(Parameter.SCALING, async payload => {
354
+ for (const node of payload.nodes) {
355
+ node.scaling = Parameter.parseVector(payload.newValue);
356
+ }
357
+ return true;
358
+ });
359
+ this.parameterObservers.set(Parameter.POSITION, async payload => {
360
+ for (const node of payload.nodes) {
361
+ node.position = Parameter.parseVector(payload.newValue);
362
+ }
363
+ return true;
364
+ });
365
+ this.parameterObservers.set(Parameter.ROTATION, async payload => {
366
+ for (const node of payload.nodes) {
367
+ node.rotation = Parameter.parseRotation(payload.newValue);
368
+ }
369
+ return true;
370
+ });
371
+ this.parameterObservers.set(Parameter.MATERIAL, async payload => {
372
+ for (const node of payload.nodes) {
373
+ assertMeshCapability(node, Parameter.MATERIAL);
374
+ setMaterial(node, payload.newValue.toString(), false);
375
+ }
376
+ return true;
377
+ });
378
+ this.parameterObservers.set(Parameter.COLOR, async payload => {
379
+ const color = Parameter.parseColor(payload.newValue);
380
+ for (const material of payload.materials) {
381
+ const materialCls = material.getClassName();
382
+ switch (materialCls) {
383
+ case 'PBRMaterial':
384
+ (material as PBRMaterial).albedoColor = color.toLinearSpace();
385
+ break;
386
+ case 'StandardMaterial':
387
+ (material as StandardMaterial).diffuseColor = color;
388
+ break;
389
+ default:
390
+ throw new Error(`Setting color for material of instance "${materialCls}" not implemented (yet).`);
391
+ }
392
+ }
393
+ return true;
394
+ });
395
+ this.parameterObservers.set(Parameter.ROUGHNESS, async payload => {
396
+ const roughness = Parameter.parseNumber(payload.newValue);
397
+ for (const material of payload.materials) {
398
+ const materialCls = material.getClassName();
399
+ switch (materialCls) {
400
+ case 'PBRMaterial':
401
+ (material as PBRMaterial).roughness = roughness;
402
+ break;
403
+ case 'StandardMaterial':
404
+ (material as StandardMaterial).roughness = roughness;
405
+ break;
406
+ default:
407
+ throw new Error(`Setting roughness for material of instance "${materialCls}" not implemented (yet).`);
408
+ }
409
+ }
410
+ return true;
411
+ });
412
+ this.parameterObservers.set(Parameter.METALLNESS, async payload => {
413
+ const metallness = Parameter.parseNumber(payload.newValue);
414
+ for (const material of payload.materials) {
415
+ const materialCls = material.getClassName();
416
+ switch (materialCls) {
417
+ case 'PBRMaterial':
418
+ (material as PBRMaterial).metallic = metallness;
419
+ break;
420
+ default:
421
+ throw new Error(`Setting metallness for material of instance "${materialCls}" not implemented (yet).`);
422
+ }
423
+ }
424
+ return true;
425
+ });
426
+ return this;
427
+ }
428
+
429
+ /**
430
+ * Passes all {@link ParameterValue}s of the given {@link ParameterBag} for given {@link TagManagerSubject} to
431
+ * {@link handleParameter}.
432
+ * @protected
433
+ */
434
+ protected handleParameterBag(
435
+ subject: TagManagerSubject,
436
+ parameters: ParameterBag
437
+ ): Promise<TagManagerParameterObserverResultBag>[] {
438
+ const observerPromises: Promise<TagManagerParameterObserverResultBag>[] = [];
439
+ for (const parameter in parameters) {
440
+ observerPromises.push(this.handleParameter(subject, parameter, parameters[parameter]));
441
+ }
442
+ return observerPromises;
443
+ }
444
+
445
+ /**
446
+ * Asserts the given {@link Parameter} and its {@link ParameterValue}, stores the state in the {@link TagManager}'s
447
+ * {@link parameters}, calculates the applicable nodes, injects the {@link ParameterValue} in the node's metadata,
448
+ * calls the responsible {@link ParameterObserver}s and emits the event {@link Event.TAG_MANAGER_PARAMETER_COMMITTED}.
449
+ * @protected
450
+ */
451
+ protected async handleParameter(
452
+ subject: TagManagerSubject,
453
+ parameter: string,
454
+ parameterValue: ParameterValue
455
+ ): Promise<TagManagerParameterObserverResultBag> {
456
+ Parameter.assertParameter(Parameter.declarations, parameter, parameterValue);
457
+ const parameterBag = this.parameters.get(subject) || {};
458
+ const oldValue = parameterBag[parameter];
459
+ const parameterObserverResultBag: TagManagerParameterObserverResultBag = {
460
+ subject: subject,
461
+ parameter: parameter,
462
+ nodes: [],
463
+ materials: [],
464
+ oldValue: oldValue,
465
+ newValue: parameterValue,
466
+ parameterObserverResult: false,
467
+ };
468
+ if (!this.parameterObservers.has(parameter)) {
469
+ return Promise.resolve(parameterObserverResultBag);
470
+ }
471
+ if (oldValue === parameterValue) {
472
+ /* NOTE:
473
+ The following is wrong in different scenarios. If a node enters life and the subject/parameter
474
+ applied in the past, the new node will not be altered by the subsequent observers, because of
475
+ the return on the next line. If we want to tackle that problem and do an early return to not
476
+ trigger observers twice, we have to hold a state for every node/material and the applied
477
+ parameter value. This could be highly cost sensitive, so I would just avoid that check
478
+ at all. Babylon will not trigger changes if the value on a node/material does not change
479
+ anyway.
480
+ */
481
+ //return Promise.resolve(parameterObserverResultBag);
482
+ }
483
+ this.parameters.set(subject, parameterBag);
484
+ this.parameters.get(subject)![parameter] = parameterValue;
485
+ const nodes = this.getNodesBySubject(subject);
486
+ const materials = this.getMaterialsBySubject(subject);
487
+ if (nodes.length === 0 && materials.length === 0) {
488
+ return Promise.resolve(parameterObserverResultBag);
489
+ }
490
+ const observer = this.parameterObservers.get(parameter)!;
491
+ const result = await observer({
492
+ subject: subject,
493
+ nodes: nodes,
494
+ materials: materials,
495
+ newValue: parameterValue,
496
+ oldValue: oldValue,
497
+ });
498
+ if (result === false) {
499
+ // reset to old value if observer was not successful
500
+ this.parameters.get(subject)![parameter] = oldValue;
501
+ }
502
+ parameterObserverResultBag.nodes = nodes;
503
+ parameterObserverResultBag.materials = materials;
504
+ parameterObserverResultBag.parameterObserverResult = result;
505
+ emitter.emit(Event.TAG_MANAGER_PARAMETER_COMMITTED, parameterObserverResultBag);
506
+ return parameterObserverResultBag;
507
+ }
508
+
509
+ /**
510
+ * Updates the state of the {@link TagManager}'s {@link parameters} for all new nodes and tags given in
511
+ * {@link TagMapping}.
512
+ * @protected
513
+ */
514
+ protected updateParametersWithNodeAndTagMapping(nodes: TransformNode[], tagMapping: TagMapping): void {
515
+ // create node mapping by linking the clone source name to the new node name
516
+ const nodeMapping = nodes.reduce((accNodeMapping, curNode) => {
517
+ const oldNode = get(curNode.metadata, 'cloneSource') as TransformNode;
518
+ if (oldNode) {
519
+ accNodeMapping[oldNode.name] = curNode.name;
520
+ }
521
+ return accNodeMapping;
522
+ }, {} as TagMapping);
523
+ for (const subject of this.parameters.keys()) {
524
+ const isNode = subject.nodeName;
525
+ const newName = isNode ? nodeMapping[subject.nodeName] : tagMapping[subject.tagName];
526
+ if (!newName) {
527
+ continue;
528
+ }
529
+ const newSubject = clone(subject);
530
+ newSubject[isNode ? 'nodeName' : 'tagName'] = newName;
531
+ const parameterBag = clone(this.parameters.get(subject)!);
532
+ merge(parameterBag, this.parameters.get(newSubject));
533
+ this.parameters.set(newSubject, parameterBag);
534
+ }
535
+ }
536
+ }