@combeenation/3d-viewer 12.4.1 → 13.0.1

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