@combeenation/3d-viewer 7.0.0 → 7.1.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 (105) 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 +199 -200
  29. package/dist/lib-cjs/api/classes/viewer.js +670 -671
  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 +102 -103
  48. package/dist/lib-cjs/api/manager/variantInstanceManager.js +284 -285
  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 +753 -750
  54. package/dist/lib-cjs/api/util/babylonHelper.js.map +1 -1
  55. package/dist/lib-cjs/api/util/globalTypes.d.ts +436 -436
  56. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  57. package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
  58. package/dist/lib-cjs/api/util/resourceHelper.js +203 -203
  59. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +44 -44
  60. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +175 -173
  61. package/dist/lib-cjs/api/util/sceneLoaderHelper.js.map +1 -1
  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 +48 -48
  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 +53 -53
  69. package/dist/lib-cjs/index.js +114 -114
  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 +731 -731
  74. package/src/api/classes/event.ts +452 -452
  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 +554 -554
  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 +933 -933
  82. package/src/api/classes/variantInstance.ts +123 -123
  83. package/src/api/classes/variantParameterizable.ts +85 -85
  84. package/src/api/classes/viewer.ts +743 -744
  85. package/src/api/classes/viewerLight.ts +339 -339
  86. package/src/api/internal/debugViewer.ts +90 -90
  87. package/src/api/internal/lensRendering.ts +9 -9
  88. package/src/api/internal/sceneSetup.ts +205 -205
  89. package/src/api/manager/animationManager.ts +143 -143
  90. package/src/api/manager/gltfExportManager.ts +236 -236
  91. package/src/api/manager/sceneManager.ts +136 -136
  92. package/src/api/manager/tagManager.ts +451 -451
  93. package/src/api/manager/textureLoadManager.ts +95 -95
  94. package/src/api/manager/variantInstanceManager.ts +297 -298
  95. package/src/api/store/specStorage.ts +68 -68
  96. package/src/api/util/babylonHelper.ts +823 -822
  97. package/src/api/util/globalTypes.ts +503 -503
  98. package/src/api/util/resourceHelper.ts +191 -191
  99. package/src/api/util/sceneLoaderHelper.ts +170 -170
  100. package/src/api/util/stringHelper.ts +30 -30
  101. package/src/api/util/structureHelper.ts +49 -49
  102. package/src/buildinfo.json +3 -3
  103. package/src/dev.ts +62 -62
  104. package/src/index.ts +100 -100
  105. package/src/types.d.ts +38 -35
@@ -1,131 +1,131 @@
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.SceneManager = void 0;
13
- const event_1 = require("../classes/event");
14
- const parameter_1 = require("../classes/parameter");
15
- const parameterObservable_1 = require("../classes/parameterObservable");
16
- const specStorage_1 = require("../store/specStorage");
17
- const babylonHelper_1 = require("../util/babylonHelper");
18
- const resourceHelper_1 = require("../util/resourceHelper");
19
- const textureLoadManager_1 = require("./textureLoadManager");
20
- const lodash_es_1 = require("lodash-es");
21
- class SceneManager extends parameterObservable_1.ParameterObservable {
22
- /**
23
- * Constructor.
24
- */
25
- constructor(scene) {
26
- super();
27
- this.scene = scene;
28
- this._parameterObservers = new Map();
29
- this._textureLoadManager = null;
30
- this._textureLoadManager = textureLoadManager_1.TextureLoadManager.create(scene);
31
- this.addParameterObservers();
32
- }
33
- /**
34
- * Creates a {@link SceneManager} based on given Babylon.js scene.
35
- */
36
- static create(scene) {
37
- return __awaiter(this, void 0, void 0, function* () {
38
- const sceneManager = new SceneManager(scene);
39
- yield sceneManager.bootstrapParameters(specStorage_1.SpecStorage.get('scene.parameters'));
40
- return sceneManager;
41
- });
42
- }
43
- /**
44
- * The active `Camera`.
45
- */
46
- get activeCamera() {
47
- if (!this.scene.activeCamera) {
48
- throw new Error('Scene has no active camera.');
49
- }
50
- return this.scene.activeCamera;
51
- }
52
- /**
53
- * Places the given {@link ParameterBag} in the {@link SceneManager}'s parameters, replaces all patterns in the
54
- * {@link StructureJson} and broadcasts all {@link ParameterObserver}s.
55
- *
56
- * @emit {@link Event.SCENE_PARAMETER_COMMITTED}
57
- */
58
- commitParameters(parameters) {
59
- return __awaiter(this, void 0, void 0, function* () {
60
- if (!parameters) {
61
- parameters = {};
62
- }
63
- const oldParameters = (0, lodash_es_1.cloneDeep)(this.parameters);
64
- (0, lodash_es_1.merge)(this.parameters, parameters);
65
- // handle parameter observers
66
- let observerPromises = [];
67
- for (const parameter in this.parameters) {
68
- const oldParameterValue = oldParameters[parameter];
69
- const newParameterValue = this.parameters[parameter];
70
- this.assertParameter(parameter_1.Parameter.declarations, parameter, newParameterValue);
71
- if (oldParameterValue === newParameterValue) {
72
- continue;
73
- }
74
- // parameter changed
75
- const parameterObservers = (0, resourceHelper_1.mergeMaps)(this._parameterObservers, this.parameterObservers);
76
- if (parameterObservers.has(parameter)) {
77
- const observers = parameterObservers.get(parameter);
78
- observerPromises = (0, lodash_es_1.concat)(observerPromises, observers.map(observer => {
79
- const observerResult = observer(this, oldParameterValue, newParameterValue);
80
- const observerPromise = Promise.resolve(observerResult);
81
- observerPromise.then(() => {
82
- this.broadcastEvent(event_1.Event.SCENE_PARAMETER_COMMITTED, this, parameter, oldParameterValue, newParameterValue);
83
- });
84
- return observerPromise;
85
- }));
86
- }
87
- }
88
- yield Promise.all(observerPromises);
89
- return this;
90
- });
91
- }
92
- addParameterObservers() {
93
- const handleEnvParamChange = (manager, oldValue, newValue) => {
94
- const params = {
95
- color: manager.parameters[parameter_1.Parameter.ENVIRONMENT_COLOR],
96
- intensity: manager.parameters[parameter_1.Parameter.ENVIRONMENT_INTENSITY],
97
- env: manager.parameters[parameter_1.Parameter.ENVIRONMENT],
98
- background: manager.parameters[parameter_1.Parameter.ENVIRONMENT_BACKGROUND],
99
- rotation: manager.parameters[parameter_1.Parameter.ENVIRONMENT_ROTATION],
100
- useDefault: manager.parameters[parameter_1.Parameter.ENVIRONMENT_USEDEFAULT],
101
- };
102
- const envDef = {
103
- environmentColor: params.color ? parameter_1.Parameter.parseColor(params.color) : undefined,
104
- environmentIntensity: params.intensity !== undefined ? parameter_1.Parameter.parseNumber(params.intensity) : undefined,
105
- environment: params.env ? params.env : undefined,
106
- environmentBackground: params.background ? params.background : undefined,
107
- environmentRotation: params.rotation !== undefined ? parameter_1.Parameter.parseNumber(params.rotation) : undefined,
108
- environmentUseDefault: params.useDefault ? parameter_1.Parameter.parseBoolean(params.useDefault) : undefined,
109
- };
110
- (0, babylonHelper_1.changeEnvironment)(manager.scene, envDef);
111
- };
112
- this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_COLOR, [handleEnvParamChange]);
113
- this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_ROTATION, [handleEnvParamChange]);
114
- this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_USEDEFAULT, [handleEnvParamChange]);
115
- this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT, [handleEnvParamChange]);
116
- this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_BACKGROUND, [handleEnvParamChange]);
117
- this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_INTENSITY, [handleEnvParamChange]);
118
- return this;
119
- }
120
- /**
121
- * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
122
- */
123
- bootstrapParameters(parameters) {
124
- return __awaiter(this, void 0, void 0, function* () {
125
- yield this.commitParameters((0, lodash_es_1.merge)((0, lodash_es_1.cloneDeep)(this.parameters), parameters));
126
- return this;
127
- });
128
- }
129
- }
130
- exports.SceneManager = SceneManager;
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.SceneManager = void 0;
13
+ const event_1 = require("../classes/event");
14
+ const parameter_1 = require("../classes/parameter");
15
+ const parameterObservable_1 = require("../classes/parameterObservable");
16
+ const specStorage_1 = require("../store/specStorage");
17
+ const babylonHelper_1 = require("../util/babylonHelper");
18
+ const resourceHelper_1 = require("../util/resourceHelper");
19
+ const textureLoadManager_1 = require("./textureLoadManager");
20
+ const lodash_es_1 = require("lodash-es");
21
+ class SceneManager extends parameterObservable_1.ParameterObservable {
22
+ /**
23
+ * Constructor.
24
+ */
25
+ constructor(scene) {
26
+ super();
27
+ this.scene = scene;
28
+ this._parameterObservers = new Map();
29
+ this._textureLoadManager = null;
30
+ this._textureLoadManager = textureLoadManager_1.TextureLoadManager.create(scene);
31
+ this.addParameterObservers();
32
+ }
33
+ /**
34
+ * Creates a {@link SceneManager} based on given Babylon.js scene.
35
+ */
36
+ static create(scene) {
37
+ return __awaiter(this, void 0, void 0, function* () {
38
+ const sceneManager = new SceneManager(scene);
39
+ yield sceneManager.bootstrapParameters(specStorage_1.SpecStorage.get('scene.parameters'));
40
+ return sceneManager;
41
+ });
42
+ }
43
+ /**
44
+ * The active `Camera`.
45
+ */
46
+ get activeCamera() {
47
+ if (!this.scene.activeCamera) {
48
+ throw new Error('Scene has no active camera.');
49
+ }
50
+ return this.scene.activeCamera;
51
+ }
52
+ /**
53
+ * Places the given {@link ParameterBag} in the {@link SceneManager}'s parameters, replaces all patterns in the
54
+ * {@link StructureJson} and broadcasts all {@link ParameterObserver}s.
55
+ *
56
+ * @emit {@link Event.SCENE_PARAMETER_COMMITTED}
57
+ */
58
+ commitParameters(parameters) {
59
+ return __awaiter(this, void 0, void 0, function* () {
60
+ if (!parameters) {
61
+ parameters = {};
62
+ }
63
+ const oldParameters = (0, lodash_es_1.cloneDeep)(this.parameters);
64
+ (0, lodash_es_1.merge)(this.parameters, parameters);
65
+ // handle parameter observers
66
+ let observerPromises = [];
67
+ for (const parameter in this.parameters) {
68
+ const oldParameterValue = oldParameters[parameter];
69
+ const newParameterValue = this.parameters[parameter];
70
+ this.assertParameter(parameter_1.Parameter.declarations, parameter, newParameterValue);
71
+ if (oldParameterValue === newParameterValue) {
72
+ continue;
73
+ }
74
+ // parameter changed
75
+ const parameterObservers = (0, resourceHelper_1.mergeMaps)(this._parameterObservers, this.parameterObservers);
76
+ if (parameterObservers.has(parameter)) {
77
+ const observers = parameterObservers.get(parameter);
78
+ observerPromises = (0, lodash_es_1.concat)(observerPromises, observers.map(observer => {
79
+ const observerResult = observer(this, oldParameterValue, newParameterValue);
80
+ const observerPromise = Promise.resolve(observerResult);
81
+ observerPromise.then(() => {
82
+ this.broadcastEvent(event_1.Event.SCENE_PARAMETER_COMMITTED, this, parameter, oldParameterValue, newParameterValue);
83
+ });
84
+ return observerPromise;
85
+ }));
86
+ }
87
+ }
88
+ yield Promise.all(observerPromises);
89
+ return this;
90
+ });
91
+ }
92
+ addParameterObservers() {
93
+ const handleEnvParamChange = (manager, oldValue, newValue) => {
94
+ const params = {
95
+ color: manager.parameters[parameter_1.Parameter.ENVIRONMENT_COLOR],
96
+ intensity: manager.parameters[parameter_1.Parameter.ENVIRONMENT_INTENSITY],
97
+ env: manager.parameters[parameter_1.Parameter.ENVIRONMENT],
98
+ background: manager.parameters[parameter_1.Parameter.ENVIRONMENT_BACKGROUND],
99
+ rotation: manager.parameters[parameter_1.Parameter.ENVIRONMENT_ROTATION],
100
+ useDefault: manager.parameters[parameter_1.Parameter.ENVIRONMENT_USEDEFAULT],
101
+ };
102
+ const envDef = {
103
+ environmentColor: params.color ? parameter_1.Parameter.parseColor(params.color) : undefined,
104
+ environmentIntensity: params.intensity !== undefined ? parameter_1.Parameter.parseNumber(params.intensity) : undefined,
105
+ environment: params.env ? params.env : undefined,
106
+ environmentBackground: params.background ? params.background : undefined,
107
+ environmentRotation: params.rotation !== undefined ? parameter_1.Parameter.parseNumber(params.rotation) : undefined,
108
+ environmentUseDefault: params.useDefault ? parameter_1.Parameter.parseBoolean(params.useDefault) : undefined,
109
+ };
110
+ (0, babylonHelper_1.changeEnvironment)(manager.scene, envDef);
111
+ };
112
+ this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_COLOR, [handleEnvParamChange]);
113
+ this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_ROTATION, [handleEnvParamChange]);
114
+ this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_USEDEFAULT, [handleEnvParamChange]);
115
+ this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT, [handleEnvParamChange]);
116
+ this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_BACKGROUND, [handleEnvParamChange]);
117
+ this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_INTENSITY, [handleEnvParamChange]);
118
+ return this;
119
+ }
120
+ /**
121
+ * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
122
+ */
123
+ bootstrapParameters(parameters) {
124
+ return __awaiter(this, void 0, void 0, function* () {
125
+ yield this.commitParameters((0, lodash_es_1.merge)((0, lodash_es_1.cloneDeep)(this.parameters), parameters));
126
+ return this;
127
+ });
128
+ }
129
+ }
130
+ exports.SceneManager = SceneManager;
131
131
  //# sourceMappingURL=sceneManager.js.map
@@ -1,108 +1,108 @@
1
- import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
2
- export declare class TagManager {
3
- protected viewer: Viewer;
4
- readonly parameters: TagManagerParameterBag;
5
- readonly parameterObservers: TagManagerParameterObserverBag;
6
- /**
7
- * Constructor.
8
- */
9
- constructor(viewer: Viewer);
10
- /**
11
- * Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
12
- * nodes with given tagName.
13
- */
14
- setTagParameterValue(tagName: string, parameterName: string, value: ParameterValue): Promise<ParameterObserverResult>;
15
- /**
16
- * Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
17
- * nodes with given nodeName.
18
- */
19
- setNodeParameterValue(nodeName: string, parameterName: string, value: ParameterValue): Promise<ParameterObserverResult>;
20
- /**
21
- * Splits the passed {@link TagManagerParameterValue}s into individual values and calls all {@link ParameterObserver}s
22
- * of all {@link Parameter}s with the respective {@link TagManagerSubject} and {@link ParameterValue}. The result is a
23
- * map of passed {@link TagManagerParameterValue}s and the associated {@link ParameterObserverResult} of the
24
- * {@link ParameterObserver}.
25
- */
26
- setParameterValues(values: TagManagerParameterValue[]): Promise<Map<TagManagerParameterValue, ParameterObserverResult>>;
27
- /**
28
- * Gets a list of {@link TagManagerSubject}s that are present in both the state of the {@link TagManager}'s
29
- * {@link parameters} and the given node.
30
- */
31
- getSubjectsFor(node: TransformNode): TagManagerSubject[];
32
- /**
33
- * Gets a list of {@link TagManagerSubject}s that are present in both the state of the {@link TagManager}'s
34
- * {@link parameters} and the given nodes.
35
- */
36
- getApplicableSubjectsFor(nodes: TransformNode[]): TagManagerSubject[];
37
- /**
38
- * Applies all existing states of the {@link TagManager}'s {@link parameters} for given {@link TagManagerSubject}s.
39
- */
40
- applyExistingParameterValuesFor(subjects: TagManagerSubject[]): Promise<Map<TagManagerSubject, ParameterObserverResult>>;
41
- /**
42
- * Does the same as {@link setParameterValues} with the difference that all existing states of the
43
- * {@link TagManager}'s {@link parameters} are applied to all given nodes.
44
- */
45
- applyExistingParameterValuesTo(nodes: TransformNode[]): Promise<Map<TagManagerSubject, ParameterObserverResult>>;
46
- /**
47
- * Applies all existing states of the {@link TagManager}'s {@link parameters} for all {@link TagManagerSubject}s.
48
- */
49
- applyExistingParameterValues(): Promise<Map<TagManagerSubject, ParameterObserverResult>>;
50
- /**
51
- * Maps all tags on given nodes with the {@link TagMapping} and updates the state of the {@link TagManager}'s
52
- * {@link parameters} for all new tags.
53
- * Also updates the state of all nodes in the tag managers parameter state.
54
- */
55
- mapNodesAndTags(nodes: TransformNode[], tagMapping: TagMapping): TagManager;
56
- /**
57
- * Prints the state of the {@link TagManager}'s {@link parameters} to the console.
58
- */
59
- printAllTags(): void;
60
- /**
61
- * Prints the state of the {@link TagManager}'s {@link parameters} for one tagName to the console.
62
- */
63
- printTagInfo(tagName: string): void;
64
- /**
65
- * Sets a {@link ParameterObserver} for the given {@link Parameter}.
66
- */
67
- setParameterObserver(parameter: string, observer: TagManagerParameterObserver): TagManager;
68
- /**
69
- * Gets all nodes for given {@link TagManagerSubject} on the Babylon.js scene.
70
- */
71
- getNodesBySubject(subject: TagManagerSubject, predicate?: (node: TransformNode) => boolean): TransformNode[];
72
- /**
73
- * Registers observers that are called on every new node added to the Babylon.js scene. The observers ensure that each
74
- * new node gets the state of the {@link TagManager}'s {@link parameters} applied.
75
- */
76
- registerNewTransformNodeObservers(scene: Scene): void;
77
- /**
78
- * Adds the default {@link ParameterObserver}s.
79
- * @protected
80
- */
81
- protected addParameterObservers(): TagManager;
82
- /**
83
- * Passes all {@link ParameterValue}s of the given {@link ParameterBag} for given {@link TagManagerSubject} to
84
- * {@link handleParameter}.
85
- * @protected
86
- */
87
- protected handleParameterBag(subject: TagManagerSubject, parameters: ParameterBag): Promise<ParameterObserver>[];
88
- /**
89
- * Asserts the given {@link Parameter} and its {@link ParameterValue}, stores the state in the {@link TagManager}'s
90
- * {@link parameters}, calculates the applicable nodes, injects the {@link ParameterValue} in the node's metadata,
91
- * calls the responsible {@link ParameterObserver}s and emits the event {@link Event.TAG_MANAGER_PARAMETER_COMMITTED}.
92
- * @protected
93
- */
94
- protected handleParameter(subject: TagManagerSubject, parameter: string, parameterValue: ParameterValue): Promise<ParameterObserver>;
95
- /**
96
- * Updates the state of the {@link TagManager}'s {@link parameters} for all new nodes and tags given in
97
- * {@link TagMapping}.
98
- * @protected
99
- */
100
- protected updateParametersWithNodeAndTagMapping(nodes: TransformNode[], tagMapping: TagMapping): void;
101
- /**
102
- * Clears the applied {@link ParameterBag} state of the node's metadata to ensure that observers trigger (once again).
103
- * This is necessary e.g. after mapping tags when a nodeName subject shall override the parameterValue of a mapped
104
- * tag.
105
- * @protected
106
- */
107
- protected clearAppliedNodeMetadataParameters(nodes: TransformNode[]): void;
108
- }
1
+ import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
2
+ export declare class TagManager {
3
+ protected viewer: Viewer;
4
+ readonly parameters: TagManagerParameterBag;
5
+ readonly parameterObservers: TagManagerParameterObserverBag;
6
+ /**
7
+ * Constructor.
8
+ */
9
+ constructor(viewer: Viewer);
10
+ /**
11
+ * Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
12
+ * nodes with given tagName.
13
+ */
14
+ setTagParameterValue(tagName: string, parameterName: string, value: ParameterValue): Promise<ParameterObserverResult>;
15
+ /**
16
+ * Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
17
+ * nodes with given nodeName.
18
+ */
19
+ setNodeParameterValue(nodeName: string, parameterName: string, value: ParameterValue): Promise<ParameterObserverResult>;
20
+ /**
21
+ * Splits the passed {@link TagManagerParameterValue}s into individual values and calls all {@link ParameterObserver}s
22
+ * of all {@link Parameter}s with the respective {@link TagManagerSubject} and {@link ParameterValue}. The result is a
23
+ * map of passed {@link TagManagerParameterValue}s and the associated {@link ParameterObserverResult} of the
24
+ * {@link ParameterObserver}.
25
+ */
26
+ setParameterValues(values: TagManagerParameterValue[]): Promise<Map<TagManagerParameterValue, ParameterObserverResult>>;
27
+ /**
28
+ * Gets a list of {@link TagManagerSubject}s that are present in both the state of the {@link TagManager}'s
29
+ * {@link parameters} and the given node.
30
+ */
31
+ getSubjectsFor(node: TransformNode): TagManagerSubject[];
32
+ /**
33
+ * Gets a list of {@link TagManagerSubject}s that are present in both the state of the {@link TagManager}'s
34
+ * {@link parameters} and the given nodes.
35
+ */
36
+ getApplicableSubjectsFor(nodes: TransformNode[]): TagManagerSubject[];
37
+ /**
38
+ * Applies all existing states of the {@link TagManager}'s {@link parameters} for given {@link TagManagerSubject}s.
39
+ */
40
+ applyExistingParameterValuesFor(subjects: TagManagerSubject[]): Promise<Map<TagManagerSubject, ParameterObserverResult>>;
41
+ /**
42
+ * Does the same as {@link setParameterValues} with the difference that all existing states of the
43
+ * {@link TagManager}'s {@link parameters} are applied to all given nodes.
44
+ */
45
+ applyExistingParameterValuesTo(nodes: TransformNode[]): Promise<Map<TagManagerSubject, ParameterObserverResult>>;
46
+ /**
47
+ * Applies all existing states of the {@link TagManager}'s {@link parameters} for all {@link TagManagerSubject}s.
48
+ */
49
+ applyExistingParameterValues(): Promise<Map<TagManagerSubject, ParameterObserverResult>>;
50
+ /**
51
+ * Maps all tags on given nodes with the {@link TagMapping} and updates the state of the {@link TagManager}'s
52
+ * {@link parameters} for all new tags.
53
+ * Also updates the state of all nodes in the tag managers parameter state.
54
+ */
55
+ mapNodesAndTags(nodes: TransformNode[], tagMapping: TagMapping): TagManager;
56
+ /**
57
+ * Prints the state of the {@link TagManager}'s {@link parameters} to the console.
58
+ */
59
+ printAllTags(): void;
60
+ /**
61
+ * Prints the state of the {@link TagManager}'s {@link parameters} for one tagName to the console.
62
+ */
63
+ printTagInfo(tagName: string): void;
64
+ /**
65
+ * Sets a {@link ParameterObserver} for the given {@link Parameter}.
66
+ */
67
+ setParameterObserver(parameter: string, observer: TagManagerParameterObserver): TagManager;
68
+ /**
69
+ * Gets all nodes for given {@link TagManagerSubject} on the Babylon.js scene.
70
+ */
71
+ getNodesBySubject(subject: TagManagerSubject, predicate?: (node: TransformNode) => boolean): TransformNode[];
72
+ /**
73
+ * Registers observers that are called on every new node added to the Babylon.js scene. The observers ensure that each
74
+ * new node gets the state of the {@link TagManager}'s {@link parameters} applied.
75
+ */
76
+ registerNewTransformNodeObservers(scene: Scene): void;
77
+ /**
78
+ * Adds the default {@link ParameterObserver}s.
79
+ * @protected
80
+ */
81
+ protected addParameterObservers(): TagManager;
82
+ /**
83
+ * Passes all {@link ParameterValue}s of the given {@link ParameterBag} for given {@link TagManagerSubject} to
84
+ * {@link handleParameter}.
85
+ * @protected
86
+ */
87
+ protected handleParameterBag(subject: TagManagerSubject, parameters: ParameterBag): Promise<ParameterObserver>[];
88
+ /**
89
+ * Asserts the given {@link Parameter} and its {@link ParameterValue}, stores the state in the {@link TagManager}'s
90
+ * {@link parameters}, calculates the applicable nodes, injects the {@link ParameterValue} in the node's metadata,
91
+ * calls the responsible {@link ParameterObserver}s and emits the event {@link Event.TAG_MANAGER_PARAMETER_COMMITTED}.
92
+ * @protected
93
+ */
94
+ protected handleParameter(subject: TagManagerSubject, parameter: string, parameterValue: ParameterValue): Promise<ParameterObserver>;
95
+ /**
96
+ * Updates the state of the {@link TagManager}'s {@link parameters} for all new nodes and tags given in
97
+ * {@link TagMapping}.
98
+ * @protected
99
+ */
100
+ protected updateParametersWithNodeAndTagMapping(nodes: TransformNode[], tagMapping: TagMapping): void;
101
+ /**
102
+ * Clears the applied {@link ParameterBag} state of the node's metadata to ensure that observers trigger (once again).
103
+ * This is necessary e.g. after mapping tags when a nodeName subject shall override the parameterValue of a mapped
104
+ * tag.
105
+ * @protected
106
+ */
107
+ protected clearAppliedNodeMetadataParameters(nodes: TransformNode[]): void;
108
+ }