@combeenation/3d-viewer 7.0.0-beta3 → 7.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 (103) 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 +670 -670
  8. package/dist/lib-cjs/api/classes/event.d.ts +396 -396
  9. package/dist/lib-cjs/api/classes/event.js +419 -419
  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 +517 -517
  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 +843 -843
  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 +88 -88
  28. package/dist/lib-cjs/api/classes/viewer.d.ts +200 -199
  29. package/dist/lib-cjs/api/classes/viewer.js +671 -670
  30. package/dist/lib-cjs/api/classes/viewer.js.map +1 -1
  31. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
  32. package/dist/lib-cjs/api/classes/viewerLight.js +348 -348
  33. package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
  34. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  35. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
  36. package/dist/lib-cjs/api/internal/sceneSetup.js +226 -226
  37. package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
  38. package/dist/lib-cjs/api/manager/animationManager.js +126 -126
  39. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +78 -78
  40. package/dist/lib-cjs/api/manager/gltfExportManager.js +241 -241
  41. package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
  42. package/dist/lib-cjs/api/manager/sceneManager.js +130 -130
  43. package/dist/lib-cjs/api/manager/tagManager.d.ts +108 -108
  44. package/dist/lib-cjs/api/manager/tagManager.js +419 -419
  45. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
  46. package/dist/lib-cjs/api/manager/textureLoadManager.js +97 -97
  47. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +103 -102
  48. package/dist/lib-cjs/api/manager/variantInstanceManager.js +285 -284
  49. package/dist/lib-cjs/api/manager/variantInstanceManager.js.map +1 -1
  50. package/dist/lib-cjs/api/store/specStorage.d.ts +32 -32
  51. package/dist/lib-cjs/api/store/specStorage.js +65 -65
  52. package/dist/lib-cjs/api/util/babylonHelper.d.ts +235 -235
  53. package/dist/lib-cjs/api/util/babylonHelper.js +750 -750
  54. package/dist/lib-cjs/api/util/globalTypes.d.ts +436 -432
  55. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  56. package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
  57. package/dist/lib-cjs/api/util/resourceHelper.js +203 -203
  58. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +44 -44
  59. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +173 -173
  60. package/dist/lib-cjs/api/util/stringHelper.d.ts +13 -13
  61. package/dist/lib-cjs/api/util/stringHelper.js +32 -32
  62. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
  63. package/dist/lib-cjs/api/util/structureHelper.js +48 -48
  64. package/dist/lib-cjs/buildinfo.json +3 -3
  65. package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
  66. package/dist/lib-cjs/index.d.ts +53 -53
  67. package/dist/lib-cjs/index.js +114 -114
  68. package/package.json +81 -81
  69. package/src/api/classes/animationInterface.ts +10 -10
  70. package/src/api/classes/dottedPath.ts +181 -181
  71. package/src/api/classes/element.ts +731 -731
  72. package/src/api/classes/event.ts +452 -452
  73. package/src/api/classes/eventBroadcaster.ts +52 -52
  74. package/src/api/classes/fuzzyMap.ts +21 -21
  75. package/src/api/classes/parameter.ts +554 -554
  76. package/src/api/classes/parameterObservable.ts +73 -73
  77. package/src/api/classes/parameterizable.ts +87 -87
  78. package/src/api/classes/placementAnimation.ts +162 -162
  79. package/src/api/classes/variant.ts +933 -933
  80. package/src/api/classes/variantInstance.ts +123 -123
  81. package/src/api/classes/variantParameterizable.ts +85 -85
  82. package/src/api/classes/viewer.ts +744 -743
  83. package/src/api/classes/viewerLight.ts +339 -339
  84. package/src/api/internal/debugViewer.ts +90 -90
  85. package/src/api/internal/lensRendering.ts +9 -9
  86. package/src/api/internal/sceneSetup.ts +205 -205
  87. package/src/api/manager/animationManager.ts +143 -143
  88. package/src/api/manager/gltfExportManager.ts +236 -236
  89. package/src/api/manager/sceneManager.ts +136 -136
  90. package/src/api/manager/tagManager.ts +451 -451
  91. package/src/api/manager/textureLoadManager.ts +95 -95
  92. package/src/api/manager/variantInstanceManager.ts +298 -297
  93. package/src/api/store/specStorage.ts +68 -68
  94. package/src/api/util/babylonHelper.ts +822 -822
  95. package/src/api/util/globalTypes.ts +503 -499
  96. package/src/api/util/resourceHelper.ts +191 -191
  97. package/src/api/util/sceneLoaderHelper.ts +170 -170
  98. package/src/api/util/stringHelper.ts +30 -30
  99. package/src/api/util/structureHelper.ts +49 -49
  100. package/src/buildinfo.json +3 -3
  101. package/src/dev.ts +62 -62
  102. package/src/index.ts +100 -100
  103. package/src/types.d.ts +35 -35
@@ -1,420 +1,420 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- Object.defineProperty(exports, "__esModule", { value: true });
12
- exports.TagManager = void 0;
13
- const event_1 = require("../classes/event");
14
- const fuzzyMap_1 = require("../classes/fuzzyMap");
15
- const parameter_1 = require("../classes/parameter");
16
- const babylonHelper_1 = require("../util/babylonHelper");
17
- const tags_1 = require("@babylonjs/core/Misc/tags");
18
- const lodash_es_1 = require("lodash-es");
19
- class TagManager {
20
- /**
21
- * Constructor.
22
- */
23
- constructor(viewer) {
24
- this.viewer = viewer;
25
- this.parameters = new fuzzyMap_1.FuzzyMap();
26
- this.parameterObservers = new Map();
27
- this.addParameterObservers();
28
- }
29
- /**
30
- * Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
31
- * nodes with given tagName.
32
- */
33
- setTagParameterValue(tagName, parameterName, value) {
34
- return __awaiter(this, void 0, void 0, function* () {
35
- return yield this.handleParameter({ tagName: tagName }, parameterName, value);
36
- });
37
- }
38
- /**
39
- * Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
40
- * nodes with given nodeName.
41
- */
42
- setNodeParameterValue(nodeName, parameterName, value) {
43
- return __awaiter(this, void 0, void 0, function* () {
44
- return yield this.handleParameter({ nodeName: nodeName }, parameterName, value);
45
- });
46
- }
47
- /**
48
- * Splits the passed {@link TagManagerParameterValue}s into individual values and calls all {@link ParameterObserver}s
49
- * of all {@link Parameter}s with the respective {@link TagManagerSubject} and {@link ParameterValue}. The result is a
50
- * map of passed {@link TagManagerParameterValue}s and the associated {@link ParameterObserverResult} of the
51
- * {@link ParameterObserver}.
52
- */
53
- setParameterValues(values) {
54
- return __awaiter(this, void 0, void 0, function* () {
55
- const observerResultMap = new Map();
56
- const tagPromises = [];
57
- const nodePromises = [];
58
- for (const value of values) {
59
- const subject = {};
60
- if (value.tagName) {
61
- subject.tagName = value.tagName;
62
- }
63
- if (value.nodeName) {
64
- subject.nodeName = value.nodeName;
65
- }
66
- const promise = this.handleParameter(subject, value.parameterName, value.value);
67
- promise.then(result => observerResultMap.set(value, result));
68
- if (value.tagName) {
69
- tagPromises.push(promise);
70
- }
71
- if (value.nodeName) {
72
- nodePromises.push(promise);
73
- }
74
- }
75
- yield Promise.all(tagPromises);
76
- yield Promise.all(nodePromises);
77
- return observerResultMap;
78
- });
79
- }
80
- /**
81
- * Gets a list of {@link TagManagerSubject}s that are present in both the state of the {@link TagManager}'s
82
- * {@link parameters} and the given node.
83
- */
84
- getSubjectsFor(node) {
85
- return [...this.parameters.keys()].filter(subject => (subject.tagName && tags_1.Tags.MatchesQuery(node, subject.tagName)) ||
86
- (subject.nodeName && node.name === subject.nodeName));
87
- }
88
- /**
89
- * Gets a list of {@link TagManagerSubject}s that are present in both the state of the {@link TagManager}'s
90
- * {@link parameters} and the given nodes.
91
- */
92
- getApplicableSubjectsFor(nodes) {
93
- let applicableSubjects = [];
94
- for (const node of nodes) {
95
- const subjects = this.getSubjectsFor(node);
96
- applicableSubjects = [...applicableSubjects, ...subjects];
97
- }
98
- return (0, lodash_es_1.uniq)(applicableSubjects);
99
- }
100
- /**
101
- * Applies all existing states of the {@link TagManager}'s {@link parameters} for given {@link TagManagerSubject}s.
102
- */
103
- applyExistingParameterValuesFor(subjects) {
104
- return __awaiter(this, void 0, void 0, function* () {
105
- const observerResultMap = new Map();
106
- let tagPromises = [];
107
- let nodePromises = [];
108
- for (const subject of subjects) {
109
- this.clearAppliedNodeMetadataParameters(this.getNodesBySubject(subject));
110
- const promises = this.handleParameterBag(subject, this.parameters.get(subject));
111
- for (const promise of promises) {
112
- promise.then(result => observerResultMap.set(subject, result));
113
- }
114
- if (subject.tagName) {
115
- tagPromises = [...tagPromises, ...promises];
116
- }
117
- if (subject.nodeName) {
118
- nodePromises = [...nodePromises, ...promises];
119
- }
120
- }
121
- yield Promise.all(tagPromises);
122
- yield Promise.all(nodePromises);
123
- return observerResultMap;
124
- });
125
- }
126
- /**
127
- * Does the same as {@link setParameterValues} with the difference that all existing states of the
128
- * {@link TagManager}'s {@link parameters} are applied to all given nodes.
129
- */
130
- applyExistingParameterValuesTo(nodes) {
131
- return __awaiter(this, void 0, void 0, function* () {
132
- return this.applyExistingParameterValuesFor(this.getApplicableSubjectsFor(nodes));
133
- });
134
- }
135
- /**
136
- * Applies all existing states of the {@link TagManager}'s {@link parameters} for all {@link TagManagerSubject}s.
137
- */
138
- applyExistingParameterValues() {
139
- return __awaiter(this, void 0, void 0, function* () {
140
- return this.applyExistingParameterValuesFor([...this.parameters.keys()]);
141
- });
142
- }
143
- /**
144
- * Maps all tags on given nodes with the {@link TagMapping} and updates the state of the {@link TagManager}'s
145
- * {@link parameters} for all new tags.
146
- * Also updates the state of all nodes in the tag managers parameter state.
147
- */
148
- mapNodesAndTags(nodes, tagMapping) {
149
- this.updateParametersWithNodeAndTagMapping(nodes, tagMapping);
150
- (0, babylonHelper_1.mapTags)(nodes, tagMapping);
151
- return this;
152
- }
153
- /**
154
- * Prints the state of the {@link TagManager}'s {@link parameters} to the console.
155
- */
156
- printAllTags() {
157
- const printable = [];
158
- for (const subject of this.parameters.keys()) {
159
- const parameterBag = this.parameters.get(subject);
160
- for (const parameter in parameterBag) {
161
- printable.push({
162
- subject: JSON.stringify(subject),
163
- parameter: parameter,
164
- value: parameterBag[parameter],
165
- nodes: this.getNodesBySubject(subject),
166
- });
167
- }
168
- }
169
- console.table(printable);
170
- }
171
- /**
172
- * Prints the state of the {@link TagManager}'s {@link parameters} for one tagName to the console.
173
- */
174
- printTagInfo(tagName) {
175
- const parameterBag = this.parameters.get({ tagName: tagName });
176
- const printable = [];
177
- for (const parameter in parameterBag) {
178
- printable.push({
179
- parameter: parameter,
180
- value: parameterBag[parameter],
181
- nodes: this.getNodesBySubject({ tagName: tagName }),
182
- });
183
- }
184
- console.table(printable);
185
- }
186
- /**
187
- * Sets a {@link ParameterObserver} for the given {@link Parameter}.
188
- */
189
- setParameterObserver(parameter, observer) {
190
- this.parameterObservers.set(parameter, observer);
191
- return this;
192
- }
193
- /**
194
- * Gets all nodes for given {@link TagManagerSubject} on the Babylon.js scene.
195
- */
196
- getNodesBySubject(subject, predicate) {
197
- let nodes = [];
198
- if (subject.tagName) {
199
- nodes = [
200
- ...nodes,
201
- ...this.viewer.scene.getTransformNodesByTags(subject.tagName, predicate),
202
- ...this.viewer.scene.getMeshesByTags(subject.tagName, predicate),
203
- ];
204
- }
205
- if (subject.nodeName) {
206
- nodes = [
207
- ...nodes,
208
- this.viewer.scene.getTransformNodeByName(subject.nodeName),
209
- this.viewer.scene.getMeshByName(subject.nodeName),
210
- ].filter(t => !!t && (!predicate || predicate(t)));
211
- }
212
- return nodes;
213
- }
214
- /**
215
- * Registers observers that are called on every new node added to the Babylon.js scene. The observers ensure that each
216
- * new node gets the state of the {@link TagManager}'s {@link parameters} applied.
217
- */
218
- registerNewTransformNodeObservers(scene) {
219
- const onNewTransformNodeAdded = (node) => __awaiter(this, void 0, void 0, function* () {
220
- yield this.viewer.scene.whenReadyAsync();
221
- yield this.applyExistingParameterValuesTo([node]);
222
- });
223
- scene.onNewTransformNodeAddedObservable.makeObserverBottomPriority(scene.onNewTransformNodeAddedObservable.add(onNewTransformNodeAdded));
224
- scene.onNewMeshAddedObservable.makeObserverBottomPriority(scene.onNewMeshAddedObservable.add(onNewTransformNodeAdded));
225
- }
226
- /**
227
- * Adds the default {@link ParameterObserver}s.
228
- * @protected
229
- */
230
- addParameterObservers() {
231
- this.parameterObservers.set(parameter_1.Parameter.VISIBLE, (payload) => __awaiter(this, void 0, void 0, function* () {
232
- let visible;
233
- try {
234
- visible = parameter_1.Parameter.parseBoolean(payload.newValue);
235
- }
236
- catch (e) {
237
- return;
238
- }
239
- if (visible === true) {
240
- for (const node of payload.nodes) {
241
- node.setEnabled(true);
242
- }
243
- }
244
- else if (visible === false) {
245
- for (const node of payload.nodes) {
246
- node.setEnabled(false);
247
- }
248
- }
249
- return payload;
250
- }));
251
- this.parameterObservers.set(parameter_1.Parameter.SCALING, (payload) => __awaiter(this, void 0, void 0, function* () {
252
- for (const node of payload.nodes) {
253
- node.scaling = parameter_1.Parameter.parseVector(payload.newValue);
254
- }
255
- return payload;
256
- }));
257
- this.parameterObservers.set(parameter_1.Parameter.POSITION, (payload) => __awaiter(this, void 0, void 0, function* () {
258
- for (const node of payload.nodes) {
259
- node.position = parameter_1.Parameter.parseVector(payload.newValue);
260
- }
261
- return payload;
262
- }));
263
- this.parameterObservers.set(parameter_1.Parameter.ROTATION, (payload) => __awaiter(this, void 0, void 0, function* () {
264
- for (const node of payload.nodes) {
265
- node.rotation = parameter_1.Parameter.parseRotation(payload.newValue);
266
- }
267
- return payload;
268
- }));
269
- this.parameterObservers.set(parameter_1.Parameter.MATERIAL, (payload) => __awaiter(this, void 0, void 0, function* () {
270
- for (const node of payload.nodes) {
271
- (0, babylonHelper_1.assertMeshCapability)(node, parameter_1.Parameter.MATERIAL);
272
- (0, babylonHelper_1.setMaterial)(node, payload.newValue.toString(), false);
273
- }
274
- return payload;
275
- }));
276
- this.parameterObservers.set(parameter_1.Parameter.MATERIAL_COLOR, (payload) => __awaiter(this, void 0, void 0, function* () {
277
- const parsedValue = parameter_1.Parameter.parseColor(payload.newValue);
278
- for (const node of payload.nodes) {
279
- (0, babylonHelper_1.assertMeshCapability)(node, parameter_1.Parameter.MATERIAL_COLOR);
280
- if (this.viewer.cloneMaterialsOnMutation) {
281
- if (!(0, lodash_es_1.has)(node.metadata, 'dirty.material')) {
282
- (0, babylonHelper_1.cloneTransformNodeMaterial)(node);
283
- }
284
- if (!(0, lodash_es_1.has)(node.metadata, 'dirty.material.color')) {
285
- // inject initial value and mark as dirty
286
- (0, babylonHelper_1.injectNodeMetadata)(node, { dirty: { material: { color: payload.oldValue } } }, false);
287
- }
288
- }
289
- (0, babylonHelper_1.setMaterialColor)(node, parsedValue, false);
290
- }
291
- return payload;
292
- }));
293
- this.parameterObservers.set(parameter_1.Parameter.MATERIAL_ROUGHNESS, (payload) => __awaiter(this, void 0, void 0, function* () {
294
- const parsedValue = parameter_1.Parameter.parseNumber(payload.newValue);
295
- for (const node of payload.nodes) {
296
- (0, babylonHelper_1.assertMeshCapability)(node, parameter_1.Parameter.MATERIAL_ROUGHNESS);
297
- if (this.viewer.cloneMaterialsOnMutation) {
298
- if (!(0, lodash_es_1.has)(node.metadata, 'dirty.material')) {
299
- (0, babylonHelper_1.cloneTransformNodeMaterial)(node);
300
- }
301
- if (!(0, lodash_es_1.has)(node.metadata, 'dirty.material.roughness')) {
302
- // inject initial value and mark as dirty
303
- (0, babylonHelper_1.injectNodeMetadata)(node, { dirty: { material: { color: payload.oldValue } } }, false);
304
- }
305
- }
306
- (0, babylonHelper_1.setMaterialRoughness)(node, parsedValue, false);
307
- }
308
- return payload;
309
- }));
310
- this.parameterObservers.set(parameter_1.Parameter.MATERIAL_METALLNESS, (payload) => __awaiter(this, void 0, void 0, function* () {
311
- const parsedValue = parameter_1.Parameter.parseNumber(payload.newValue);
312
- for (const node of payload.nodes) {
313
- (0, babylonHelper_1.assertMeshCapability)(node, parameter_1.Parameter.MATERIAL_METALLNESS);
314
- if (this.viewer.cloneMaterialsOnMutation) {
315
- if (!(0, lodash_es_1.has)(node.metadata, 'dirty.material')) {
316
- (0, babylonHelper_1.cloneTransformNodeMaterial)(node);
317
- }
318
- if (!(0, lodash_es_1.has)(node.metadata, 'dirty.material.metallness')) {
319
- // inject initial value and mark as dirty
320
- (0, babylonHelper_1.injectNodeMetadata)(node, { dirty: { material: { color: payload.oldValue } } }, false);
321
- }
322
- }
323
- (0, babylonHelper_1.setMaterialMetallness)(node, parsedValue, false);
324
- }
325
- return payload;
326
- }));
327
- return this;
328
- }
329
- /**
330
- * Passes all {@link ParameterValue}s of the given {@link ParameterBag} for given {@link TagManagerSubject} to
331
- * {@link handleParameter}.
332
- * @protected
333
- */
334
- handleParameterBag(subject, parameters) {
335
- const observerPromises = [];
336
- for (const parameter in parameters) {
337
- observerPromises.push(this.handleParameter(subject, parameter, parameters[parameter]));
338
- }
339
- return observerPromises;
340
- }
341
- /**
342
- * Asserts the given {@link Parameter} and its {@link ParameterValue}, stores the state in the {@link TagManager}'s
343
- * {@link parameters}, calculates the applicable nodes, injects the {@link ParameterValue} in the node's metadata,
344
- * calls the responsible {@link ParameterObserver}s and emits the event {@link Event.TAG_MANAGER_PARAMETER_COMMITTED}.
345
- * @protected
346
- */
347
- handleParameter(subject, parameter, parameterValue) {
348
- parameter_1.Parameter.assertParameter(parameter_1.Parameter.declarations, parameter, parameterValue);
349
- if (!this.parameterObservers.has(parameter)) {
350
- return Promise.resolve(() => undefined);
351
- }
352
- const parameterBag = this.parameters.get(subject) || {};
353
- const oldValue = parameterBag[parameter];
354
- this.parameters.set(subject, parameterBag);
355
- this.parameters.get(subject)[parameter] = parameterValue;
356
- const predicate = (node) => { var _a, _b; return ((_b = (_a = node.metadata) === null || _a === void 0 ? void 0 : _a.tagManager) === null || _b === void 0 ? void 0 : _b.parameters[parameter]) !== parameterValue; };
357
- const nodes = this.getNodesBySubject(subject, predicate);
358
- if (nodes.length === 0) {
359
- return Promise.resolve(() => undefined);
360
- }
361
- for (const node of nodes) {
362
- (0, babylonHelper_1.injectNodeMetadata)(node, { tagManager: { parameters: { [parameter]: parameterValue } } }, false);
363
- }
364
- const observer = this.parameterObservers.get(parameter);
365
- const observerResult = observer({ subject: subject, nodes: nodes, newValue: parameterValue, oldValue: oldValue });
366
- return Promise.resolve(observerResult).then(result => {
367
- event_1.emitter.emit(event_1.Event.TAG_MANAGER_PARAMETER_COMMITTED, {
368
- subject: subject,
369
- parameter: parameter,
370
- value: parameterValue,
371
- nodes: nodes,
372
- result: result,
373
- });
374
- });
375
- }
376
- /**
377
- * Updates the state of the {@link TagManager}'s {@link parameters} for all new nodes and tags given in
378
- * {@link TagMapping}.
379
- * @protected
380
- */
381
- updateParametersWithNodeAndTagMapping(nodes, tagMapping) {
382
- // create node mapping by linking the clone source name to the new node name
383
- const nodeMapping = nodes.reduce((accNodeMapping, curNode) => {
384
- const oldNode = (0, lodash_es_1.get)(curNode.metadata, 'cloneSource');
385
- if (oldNode) {
386
- accNodeMapping[oldNode.name] = curNode.name;
387
- }
388
- return accNodeMapping;
389
- }, {});
390
- for (const subject of this.parameters.keys()) {
391
- const isNode = subject.nodeName;
392
- const newName = isNode ? nodeMapping[subject.nodeName] : tagMapping[subject.tagName];
393
- if (!newName) {
394
- continue;
395
- }
396
- const newSubject = (0, lodash_es_1.clone)(subject);
397
- newSubject[isNode ? 'nodeName' : 'tagName'] = newName;
398
- const parameterBag = (0, lodash_es_1.clone)(this.parameters.get(subject));
399
- (0, lodash_es_1.merge)(parameterBag, this.parameters.get(newSubject));
400
- this.parameters.set(newSubject, parameterBag);
401
- }
402
- }
403
- /**
404
- * Clears the applied {@link ParameterBag} state of the node's metadata to ensure that observers trigger (once again).
405
- * This is necessary e.g. after mapping tags when a nodeName subject shall override the parameterValue of a mapped
406
- * tag.
407
- * @protected
408
- */
409
- clearAppliedNodeMetadataParameters(nodes) {
410
- var _a, _b;
411
- for (const node of nodes) {
412
- if (!((_b = (_a = node.metadata) === null || _a === void 0 ? void 0 : _a.tagManager) === null || _b === void 0 ? void 0 : _b.parameters)) {
413
- continue;
414
- }
415
- node.metadata.tagManager.parameters = {};
416
- }
417
- }
418
- }
419
- exports.TagManager = TagManager;
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.TagManager = void 0;
13
+ const event_1 = require("../classes/event");
14
+ const fuzzyMap_1 = require("../classes/fuzzyMap");
15
+ const parameter_1 = require("../classes/parameter");
16
+ const babylonHelper_1 = require("../util/babylonHelper");
17
+ const tags_1 = require("@babylonjs/core/Misc/tags");
18
+ const lodash_es_1 = require("lodash-es");
19
+ class TagManager {
20
+ /**
21
+ * Constructor.
22
+ */
23
+ constructor(viewer) {
24
+ this.viewer = viewer;
25
+ this.parameters = new fuzzyMap_1.FuzzyMap();
26
+ this.parameterObservers = new Map();
27
+ this.addParameterObservers();
28
+ }
29
+ /**
30
+ * Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
31
+ * nodes with given tagName.
32
+ */
33
+ setTagParameterValue(tagName, parameterName, value) {
34
+ return __awaiter(this, void 0, void 0, function* () {
35
+ return yield this.handleParameter({ tagName: tagName }, parameterName, value);
36
+ });
37
+ }
38
+ /**
39
+ * Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
40
+ * nodes with given nodeName.
41
+ */
42
+ setNodeParameterValue(nodeName, parameterName, value) {
43
+ return __awaiter(this, void 0, void 0, function* () {
44
+ return yield this.handleParameter({ nodeName: nodeName }, parameterName, value);
45
+ });
46
+ }
47
+ /**
48
+ * Splits the passed {@link TagManagerParameterValue}s into individual values and calls all {@link ParameterObserver}s
49
+ * of all {@link Parameter}s with the respective {@link TagManagerSubject} and {@link ParameterValue}. The result is a
50
+ * map of passed {@link TagManagerParameterValue}s and the associated {@link ParameterObserverResult} of the
51
+ * {@link ParameterObserver}.
52
+ */
53
+ setParameterValues(values) {
54
+ return __awaiter(this, void 0, void 0, function* () {
55
+ const observerResultMap = new Map();
56
+ const tagPromises = [];
57
+ const nodePromises = [];
58
+ for (const value of values) {
59
+ const subject = {};
60
+ if (value.tagName) {
61
+ subject.tagName = value.tagName;
62
+ }
63
+ if (value.nodeName) {
64
+ subject.nodeName = value.nodeName;
65
+ }
66
+ const promise = this.handleParameter(subject, value.parameterName, value.value);
67
+ promise.then(result => observerResultMap.set(value, result));
68
+ if (value.tagName) {
69
+ tagPromises.push(promise);
70
+ }
71
+ if (value.nodeName) {
72
+ nodePromises.push(promise);
73
+ }
74
+ }
75
+ yield Promise.all(tagPromises);
76
+ yield Promise.all(nodePromises);
77
+ return observerResultMap;
78
+ });
79
+ }
80
+ /**
81
+ * Gets a list of {@link TagManagerSubject}s that are present in both the state of the {@link TagManager}'s
82
+ * {@link parameters} and the given node.
83
+ */
84
+ getSubjectsFor(node) {
85
+ return [...this.parameters.keys()].filter(subject => (subject.tagName && tags_1.Tags.MatchesQuery(node, subject.tagName)) ||
86
+ (subject.nodeName && node.name === subject.nodeName));
87
+ }
88
+ /**
89
+ * Gets a list of {@link TagManagerSubject}s that are present in both the state of the {@link TagManager}'s
90
+ * {@link parameters} and the given nodes.
91
+ */
92
+ getApplicableSubjectsFor(nodes) {
93
+ let applicableSubjects = [];
94
+ for (const node of nodes) {
95
+ const subjects = this.getSubjectsFor(node);
96
+ applicableSubjects = [...applicableSubjects, ...subjects];
97
+ }
98
+ return (0, lodash_es_1.uniq)(applicableSubjects);
99
+ }
100
+ /**
101
+ * Applies all existing states of the {@link TagManager}'s {@link parameters} for given {@link TagManagerSubject}s.
102
+ */
103
+ applyExistingParameterValuesFor(subjects) {
104
+ return __awaiter(this, void 0, void 0, function* () {
105
+ const observerResultMap = new Map();
106
+ let tagPromises = [];
107
+ let nodePromises = [];
108
+ for (const subject of subjects) {
109
+ this.clearAppliedNodeMetadataParameters(this.getNodesBySubject(subject));
110
+ const promises = this.handleParameterBag(subject, this.parameters.get(subject));
111
+ for (const promise of promises) {
112
+ promise.then(result => observerResultMap.set(subject, result));
113
+ }
114
+ if (subject.tagName) {
115
+ tagPromises = [...tagPromises, ...promises];
116
+ }
117
+ if (subject.nodeName) {
118
+ nodePromises = [...nodePromises, ...promises];
119
+ }
120
+ }
121
+ yield Promise.all(tagPromises);
122
+ yield Promise.all(nodePromises);
123
+ return observerResultMap;
124
+ });
125
+ }
126
+ /**
127
+ * Does the same as {@link setParameterValues} with the difference that all existing states of the
128
+ * {@link TagManager}'s {@link parameters} are applied to all given nodes.
129
+ */
130
+ applyExistingParameterValuesTo(nodes) {
131
+ return __awaiter(this, void 0, void 0, function* () {
132
+ return this.applyExistingParameterValuesFor(this.getApplicableSubjectsFor(nodes));
133
+ });
134
+ }
135
+ /**
136
+ * Applies all existing states of the {@link TagManager}'s {@link parameters} for all {@link TagManagerSubject}s.
137
+ */
138
+ applyExistingParameterValues() {
139
+ return __awaiter(this, void 0, void 0, function* () {
140
+ return this.applyExistingParameterValuesFor([...this.parameters.keys()]);
141
+ });
142
+ }
143
+ /**
144
+ * Maps all tags on given nodes with the {@link TagMapping} and updates the state of the {@link TagManager}'s
145
+ * {@link parameters} for all new tags.
146
+ * Also updates the state of all nodes in the tag managers parameter state.
147
+ */
148
+ mapNodesAndTags(nodes, tagMapping) {
149
+ this.updateParametersWithNodeAndTagMapping(nodes, tagMapping);
150
+ (0, babylonHelper_1.mapTags)(nodes, tagMapping);
151
+ return this;
152
+ }
153
+ /**
154
+ * Prints the state of the {@link TagManager}'s {@link parameters} to the console.
155
+ */
156
+ printAllTags() {
157
+ const printable = [];
158
+ for (const subject of this.parameters.keys()) {
159
+ const parameterBag = this.parameters.get(subject);
160
+ for (const parameter in parameterBag) {
161
+ printable.push({
162
+ subject: JSON.stringify(subject),
163
+ parameter: parameter,
164
+ value: parameterBag[parameter],
165
+ nodes: this.getNodesBySubject(subject),
166
+ });
167
+ }
168
+ }
169
+ console.table(printable);
170
+ }
171
+ /**
172
+ * Prints the state of the {@link TagManager}'s {@link parameters} for one tagName to the console.
173
+ */
174
+ printTagInfo(tagName) {
175
+ const parameterBag = this.parameters.get({ tagName: tagName });
176
+ const printable = [];
177
+ for (const parameter in parameterBag) {
178
+ printable.push({
179
+ parameter: parameter,
180
+ value: parameterBag[parameter],
181
+ nodes: this.getNodesBySubject({ tagName: tagName }),
182
+ });
183
+ }
184
+ console.table(printable);
185
+ }
186
+ /**
187
+ * Sets a {@link ParameterObserver} for the given {@link Parameter}.
188
+ */
189
+ setParameterObserver(parameter, observer) {
190
+ this.parameterObservers.set(parameter, observer);
191
+ return this;
192
+ }
193
+ /**
194
+ * Gets all nodes for given {@link TagManagerSubject} on the Babylon.js scene.
195
+ */
196
+ getNodesBySubject(subject, predicate) {
197
+ let nodes = [];
198
+ if (subject.tagName) {
199
+ nodes = [
200
+ ...nodes,
201
+ ...this.viewer.scene.getTransformNodesByTags(subject.tagName, predicate),
202
+ ...this.viewer.scene.getMeshesByTags(subject.tagName, predicate),
203
+ ];
204
+ }
205
+ if (subject.nodeName) {
206
+ nodes = [
207
+ ...nodes,
208
+ this.viewer.scene.getTransformNodeByName(subject.nodeName),
209
+ this.viewer.scene.getMeshByName(subject.nodeName),
210
+ ].filter(t => !!t && (!predicate || predicate(t)));
211
+ }
212
+ return nodes;
213
+ }
214
+ /**
215
+ * Registers observers that are called on every new node added to the Babylon.js scene. The observers ensure that each
216
+ * new node gets the state of the {@link TagManager}'s {@link parameters} applied.
217
+ */
218
+ registerNewTransformNodeObservers(scene) {
219
+ const onNewTransformNodeAdded = (node) => __awaiter(this, void 0, void 0, function* () {
220
+ yield this.viewer.scene.whenReadyAsync();
221
+ yield this.applyExistingParameterValuesTo([node]);
222
+ });
223
+ scene.onNewTransformNodeAddedObservable.makeObserverBottomPriority(scene.onNewTransformNodeAddedObservable.add(onNewTransformNodeAdded));
224
+ scene.onNewMeshAddedObservable.makeObserverBottomPriority(scene.onNewMeshAddedObservable.add(onNewTransformNodeAdded));
225
+ }
226
+ /**
227
+ * Adds the default {@link ParameterObserver}s.
228
+ * @protected
229
+ */
230
+ addParameterObservers() {
231
+ this.parameterObservers.set(parameter_1.Parameter.VISIBLE, (payload) => __awaiter(this, void 0, void 0, function* () {
232
+ let visible;
233
+ try {
234
+ visible = parameter_1.Parameter.parseBoolean(payload.newValue);
235
+ }
236
+ catch (e) {
237
+ return;
238
+ }
239
+ if (visible === true) {
240
+ for (const node of payload.nodes) {
241
+ node.setEnabled(true);
242
+ }
243
+ }
244
+ else if (visible === false) {
245
+ for (const node of payload.nodes) {
246
+ node.setEnabled(false);
247
+ }
248
+ }
249
+ return payload;
250
+ }));
251
+ this.parameterObservers.set(parameter_1.Parameter.SCALING, (payload) => __awaiter(this, void 0, void 0, function* () {
252
+ for (const node of payload.nodes) {
253
+ node.scaling = parameter_1.Parameter.parseVector(payload.newValue);
254
+ }
255
+ return payload;
256
+ }));
257
+ this.parameterObservers.set(parameter_1.Parameter.POSITION, (payload) => __awaiter(this, void 0, void 0, function* () {
258
+ for (const node of payload.nodes) {
259
+ node.position = parameter_1.Parameter.parseVector(payload.newValue);
260
+ }
261
+ return payload;
262
+ }));
263
+ this.parameterObservers.set(parameter_1.Parameter.ROTATION, (payload) => __awaiter(this, void 0, void 0, function* () {
264
+ for (const node of payload.nodes) {
265
+ node.rotation = parameter_1.Parameter.parseRotation(payload.newValue);
266
+ }
267
+ return payload;
268
+ }));
269
+ this.parameterObservers.set(parameter_1.Parameter.MATERIAL, (payload) => __awaiter(this, void 0, void 0, function* () {
270
+ for (const node of payload.nodes) {
271
+ (0, babylonHelper_1.assertMeshCapability)(node, parameter_1.Parameter.MATERIAL);
272
+ (0, babylonHelper_1.setMaterial)(node, payload.newValue.toString(), false);
273
+ }
274
+ return payload;
275
+ }));
276
+ this.parameterObservers.set(parameter_1.Parameter.MATERIAL_COLOR, (payload) => __awaiter(this, void 0, void 0, function* () {
277
+ const parsedValue = parameter_1.Parameter.parseColor(payload.newValue);
278
+ for (const node of payload.nodes) {
279
+ (0, babylonHelper_1.assertMeshCapability)(node, parameter_1.Parameter.MATERIAL_COLOR);
280
+ if (this.viewer.cloneMaterialsOnMutation) {
281
+ if (!(0, lodash_es_1.has)(node.metadata, 'dirty.material')) {
282
+ (0, babylonHelper_1.cloneTransformNodeMaterial)(node);
283
+ }
284
+ if (!(0, lodash_es_1.has)(node.metadata, 'dirty.material.color')) {
285
+ // inject initial value and mark as dirty
286
+ (0, babylonHelper_1.injectNodeMetadata)(node, { dirty: { material: { color: payload.oldValue } } }, false);
287
+ }
288
+ }
289
+ (0, babylonHelper_1.setMaterialColor)(node, parsedValue, false);
290
+ }
291
+ return payload;
292
+ }));
293
+ this.parameterObservers.set(parameter_1.Parameter.MATERIAL_ROUGHNESS, (payload) => __awaiter(this, void 0, void 0, function* () {
294
+ const parsedValue = parameter_1.Parameter.parseNumber(payload.newValue);
295
+ for (const node of payload.nodes) {
296
+ (0, babylonHelper_1.assertMeshCapability)(node, parameter_1.Parameter.MATERIAL_ROUGHNESS);
297
+ if (this.viewer.cloneMaterialsOnMutation) {
298
+ if (!(0, lodash_es_1.has)(node.metadata, 'dirty.material')) {
299
+ (0, babylonHelper_1.cloneTransformNodeMaterial)(node);
300
+ }
301
+ if (!(0, lodash_es_1.has)(node.metadata, 'dirty.material.roughness')) {
302
+ // inject initial value and mark as dirty
303
+ (0, babylonHelper_1.injectNodeMetadata)(node, { dirty: { material: { color: payload.oldValue } } }, false);
304
+ }
305
+ }
306
+ (0, babylonHelper_1.setMaterialRoughness)(node, parsedValue, false);
307
+ }
308
+ return payload;
309
+ }));
310
+ this.parameterObservers.set(parameter_1.Parameter.MATERIAL_METALLNESS, (payload) => __awaiter(this, void 0, void 0, function* () {
311
+ const parsedValue = parameter_1.Parameter.parseNumber(payload.newValue);
312
+ for (const node of payload.nodes) {
313
+ (0, babylonHelper_1.assertMeshCapability)(node, parameter_1.Parameter.MATERIAL_METALLNESS);
314
+ if (this.viewer.cloneMaterialsOnMutation) {
315
+ if (!(0, lodash_es_1.has)(node.metadata, 'dirty.material')) {
316
+ (0, babylonHelper_1.cloneTransformNodeMaterial)(node);
317
+ }
318
+ if (!(0, lodash_es_1.has)(node.metadata, 'dirty.material.metallness')) {
319
+ // inject initial value and mark as dirty
320
+ (0, babylonHelper_1.injectNodeMetadata)(node, { dirty: { material: { color: payload.oldValue } } }, false);
321
+ }
322
+ }
323
+ (0, babylonHelper_1.setMaterialMetallness)(node, parsedValue, false);
324
+ }
325
+ return payload;
326
+ }));
327
+ return this;
328
+ }
329
+ /**
330
+ * Passes all {@link ParameterValue}s of the given {@link ParameterBag} for given {@link TagManagerSubject} to
331
+ * {@link handleParameter}.
332
+ * @protected
333
+ */
334
+ handleParameterBag(subject, parameters) {
335
+ const observerPromises = [];
336
+ for (const parameter in parameters) {
337
+ observerPromises.push(this.handleParameter(subject, parameter, parameters[parameter]));
338
+ }
339
+ return observerPromises;
340
+ }
341
+ /**
342
+ * Asserts the given {@link Parameter} and its {@link ParameterValue}, stores the state in the {@link TagManager}'s
343
+ * {@link parameters}, calculates the applicable nodes, injects the {@link ParameterValue} in the node's metadata,
344
+ * calls the responsible {@link ParameterObserver}s and emits the event {@link Event.TAG_MANAGER_PARAMETER_COMMITTED}.
345
+ * @protected
346
+ */
347
+ handleParameter(subject, parameter, parameterValue) {
348
+ parameter_1.Parameter.assertParameter(parameter_1.Parameter.declarations, parameter, parameterValue);
349
+ if (!this.parameterObservers.has(parameter)) {
350
+ return Promise.resolve(() => undefined);
351
+ }
352
+ const parameterBag = this.parameters.get(subject) || {};
353
+ const oldValue = parameterBag[parameter];
354
+ this.parameters.set(subject, parameterBag);
355
+ this.parameters.get(subject)[parameter] = parameterValue;
356
+ const predicate = (node) => { var _a, _b; return ((_b = (_a = node.metadata) === null || _a === void 0 ? void 0 : _a.tagManager) === null || _b === void 0 ? void 0 : _b.parameters[parameter]) !== parameterValue; };
357
+ const nodes = this.getNodesBySubject(subject, predicate);
358
+ if (nodes.length === 0) {
359
+ return Promise.resolve(() => undefined);
360
+ }
361
+ for (const node of nodes) {
362
+ (0, babylonHelper_1.injectNodeMetadata)(node, { tagManager: { parameters: { [parameter]: parameterValue } } }, false);
363
+ }
364
+ const observer = this.parameterObservers.get(parameter);
365
+ const observerResult = observer({ subject: subject, nodes: nodes, newValue: parameterValue, oldValue: oldValue });
366
+ return Promise.resolve(observerResult).then(result => {
367
+ event_1.emitter.emit(event_1.Event.TAG_MANAGER_PARAMETER_COMMITTED, {
368
+ subject: subject,
369
+ parameter: parameter,
370
+ value: parameterValue,
371
+ nodes: nodes,
372
+ result: result,
373
+ });
374
+ });
375
+ }
376
+ /**
377
+ * Updates the state of the {@link TagManager}'s {@link parameters} for all new nodes and tags given in
378
+ * {@link TagMapping}.
379
+ * @protected
380
+ */
381
+ updateParametersWithNodeAndTagMapping(nodes, tagMapping) {
382
+ // create node mapping by linking the clone source name to the new node name
383
+ const nodeMapping = nodes.reduce((accNodeMapping, curNode) => {
384
+ const oldNode = (0, lodash_es_1.get)(curNode.metadata, 'cloneSource');
385
+ if (oldNode) {
386
+ accNodeMapping[oldNode.name] = curNode.name;
387
+ }
388
+ return accNodeMapping;
389
+ }, {});
390
+ for (const subject of this.parameters.keys()) {
391
+ const isNode = subject.nodeName;
392
+ const newName = isNode ? nodeMapping[subject.nodeName] : tagMapping[subject.tagName];
393
+ if (!newName) {
394
+ continue;
395
+ }
396
+ const newSubject = (0, lodash_es_1.clone)(subject);
397
+ newSubject[isNode ? 'nodeName' : 'tagName'] = newName;
398
+ const parameterBag = (0, lodash_es_1.clone)(this.parameters.get(subject));
399
+ (0, lodash_es_1.merge)(parameterBag, this.parameters.get(newSubject));
400
+ this.parameters.set(newSubject, parameterBag);
401
+ }
402
+ }
403
+ /**
404
+ * Clears the applied {@link ParameterBag} state of the node's metadata to ensure that observers trigger (once again).
405
+ * This is necessary e.g. after mapping tags when a nodeName subject shall override the parameterValue of a mapped
406
+ * tag.
407
+ * @protected
408
+ */
409
+ clearAppliedNodeMetadataParameters(nodes) {
410
+ var _a, _b;
411
+ for (const node of nodes) {
412
+ if (!((_b = (_a = node.metadata) === null || _a === void 0 ? void 0 : _a.tagManager) === null || _b === void 0 ? void 0 : _b.parameters)) {
413
+ continue;
414
+ }
415
+ node.metadata.tagManager.parameters = {};
416
+ }
417
+ }
418
+ }
419
+ exports.TagManager = TagManager;
420
420
  //# sourceMappingURL=tagManager.js.map