@combeenation/3d-viewer 3.0.0-rc2 → 4.0.0-alpha6

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 (212) hide show
  1. package/LICENSE +0 -0
  2. package/README.md +111 -111
  3. package/dist/lib-cjs/api/classes/animationInterface.d.ts +8 -8
  4. package/dist/lib-cjs/api/classes/animationInterface.js +1 -1
  5. package/dist/lib-cjs/api/classes/animationInterface.js.map +0 -0
  6. package/dist/lib-cjs/api/classes/dottedPath.d.ts +79 -79
  7. package/dist/lib-cjs/api/classes/dottedPath.js +190 -190
  8. package/dist/lib-cjs/api/classes/dottedPath.js.map +0 -0
  9. package/dist/lib-cjs/api/classes/element.d.ts +130 -125
  10. package/dist/lib-cjs/api/classes/element.js +752 -638
  11. package/dist/lib-cjs/api/classes/element.js.map +1 -1
  12. package/dist/lib-cjs/api/classes/elementParameterizable.d.ts +14 -14
  13. package/dist/lib-cjs/api/classes/elementParameterizable.js +134 -134
  14. package/dist/lib-cjs/api/classes/elementParameterizable.js.map +0 -0
  15. package/dist/lib-cjs/api/classes/event.d.ts +326 -312
  16. package/dist/lib-cjs/api/classes/event.js +371 -357
  17. package/dist/lib-cjs/api/classes/event.js.map +1 -1
  18. package/dist/lib-cjs/api/classes/eventBroadcaster.d.ts +26 -26
  19. package/dist/lib-cjs/api/classes/eventBroadcaster.js +53 -53
  20. package/dist/lib-cjs/api/classes/eventBroadcaster.js.map +0 -0
  21. package/dist/lib-cjs/api/classes/parameter.d.ts +259 -161
  22. package/dist/lib-cjs/api/classes/parameter.js +387 -261
  23. package/dist/lib-cjs/api/classes/parameter.js.map +1 -1
  24. package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
  25. package/dist/lib-cjs/api/classes/parameterObservable.js +101 -126
  26. package/dist/lib-cjs/api/classes/parameterObservable.js.map +1 -1
  27. package/dist/lib-cjs/api/classes/parameterizable.d.ts +15 -0
  28. package/dist/lib-cjs/api/classes/parameterizable.js +150 -0
  29. package/dist/lib-cjs/api/classes/parameterizable.js.map +1 -0
  30. package/dist/lib-cjs/api/classes/placementAnimation.d.ts +38 -38
  31. package/dist/lib-cjs/api/classes/placementAnimation.js +138 -138
  32. package/dist/lib-cjs/api/classes/placementAnimation.js.map +0 -0
  33. package/dist/lib-cjs/api/classes/variant.d.ts +224 -176
  34. package/dist/lib-cjs/api/classes/variant.js +1126 -770
  35. package/dist/lib-cjs/api/classes/variant.js.map +1 -1
  36. package/dist/lib-cjs/api/classes/variantInstance.d.ts +45 -41
  37. package/dist/lib-cjs/api/classes/variantInstance.js +108 -98
  38. package/dist/lib-cjs/api/classes/variantInstance.js.map +1 -1
  39. package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +17 -0
  40. package/dist/lib-cjs/api/classes/variantParameterizable.js +93 -0
  41. package/dist/lib-cjs/api/classes/variantParameterizable.js.map +1 -0
  42. package/dist/lib-cjs/api/classes/viewer.d.ts +127 -128
  43. package/dist/lib-cjs/api/classes/viewer.js +486 -486
  44. package/dist/lib-cjs/api/classes/viewer.js.map +1 -1
  45. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -0
  46. package/dist/lib-cjs/api/classes/viewerLight.js +350 -0
  47. package/dist/lib-cjs/api/classes/viewerLight.js.map +1 -0
  48. package/dist/lib-cjs/api/emitter.d.ts +35 -0
  49. package/dist/lib-cjs/api/emitter.js +61 -0
  50. package/dist/lib-cjs/api/emitter.js.map +1 -0
  51. package/dist/lib-cjs/api/internal/debugViewer.d.ts +13 -13
  52. package/dist/lib-cjs/api/internal/debugViewer.js +87 -87
  53. package/dist/lib-cjs/api/internal/debugViewer.js.map +0 -0
  54. package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
  55. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  56. package/dist/lib-cjs/api/internal/lensRendering.js.map +0 -0
  57. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +10 -6
  58. package/dist/lib-cjs/api/internal/sceneSetup.js +231 -227
  59. package/dist/lib-cjs/api/internal/sceneSetup.js.map +1 -1
  60. package/dist/lib-cjs/api/manager/animationManager.d.ts +29 -29
  61. package/dist/lib-cjs/api/manager/animationManager.js +121 -121
  62. package/dist/lib-cjs/api/manager/animationManager.js.map +0 -0
  63. package/dist/lib-cjs/api/manager/sceneManager.d.ts +32 -32
  64. package/dist/lib-cjs/api/manager/sceneManager.js +132 -132
  65. package/dist/lib-cjs/api/manager/sceneManager.js.map +0 -0
  66. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +90 -90
  67. package/dist/lib-cjs/api/manager/variantInstanceManager.js +321 -321
  68. package/dist/lib-cjs/api/manager/variantInstanceManager.js.map +0 -0
  69. package/dist/lib-cjs/api/store/specStorage.d.ts +24 -24
  70. package/dist/lib-cjs/api/store/specStorage.js +51 -51
  71. package/dist/lib-cjs/api/store/specStorage.js.map +0 -0
  72. package/dist/lib-cjs/api/util/babylonHelper.d.ts +160 -125
  73. package/dist/lib-cjs/api/util/babylonHelper.js +465 -368
  74. package/dist/lib-cjs/api/util/babylonHelper.js.map +1 -1
  75. package/dist/lib-cjs/api/util/globalTypes.d.ts +321 -275
  76. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  77. package/dist/lib-cjs/api/util/globalTypes.js.map +0 -0
  78. package/dist/lib-cjs/api/util/resourceHelper.d.ts +26 -30
  79. package/dist/lib-cjs/api/util/resourceHelper.js +237 -247
  80. package/dist/lib-cjs/api/util/resourceHelper.js.map +1 -1
  81. package/dist/lib-cjs/api/util/stringHelper.d.ts +9 -0
  82. package/dist/lib-cjs/api/util/stringHelper.js +26 -0
  83. package/dist/lib-cjs/api/util/stringHelper.js.map +1 -0
  84. package/dist/lib-cjs/buildinfo.json +3 -3
  85. package/dist/lib-cjs/index.d.ts +48 -46
  86. package/dist/lib-cjs/index.js +86 -82
  87. package/dist/lib-cjs/index.js.map +1 -1
  88. package/package.json +83 -83
  89. package/src/api/classes/animationInterface.ts +11 -11
  90. package/src/api/classes/dottedPath.ts +189 -189
  91. package/src/api/classes/element.ts +648 -606
  92. package/src/api/classes/event.ts +370 -355
  93. package/src/api/classes/eventBroadcaster.ts +54 -54
  94. package/src/api/classes/parameter.ts +408 -270
  95. package/src/api/classes/parameterObservable.ts +99 -121
  96. package/src/api/classes/{elementParameterizable.ts → parameterizable.ts} +89 -78
  97. package/src/api/classes/placementAnimation.ts +133 -133
  98. package/src/api/classes/variant.ts +799 -652
  99. package/src/api/classes/variantInstance.ts +88 -81
  100. package/src/api/classes/variantParameterizable.ts +73 -0
  101. package/src/api/classes/viewer.ts +420 -421
  102. package/src/api/classes/viewerLight.ts +295 -0
  103. package/src/api/internal/debugViewer.ts +81 -81
  104. package/src/api/internal/lensRendering.ts +10 -10
  105. package/src/api/internal/sceneSetup.ts +194 -204
  106. package/src/api/manager/animationManager.ts +116 -116
  107. package/src/api/manager/sceneManager.ts +105 -105
  108. package/src/api/manager/variantInstanceManager.ts +236 -236
  109. package/src/api/store/specStorage.ts +53 -53
  110. package/src/api/util/babylonHelper.ts +497 -392
  111. package/src/api/util/globalTypes.ts +369 -314
  112. package/src/api/util/resourceHelper.ts +157 -168
  113. package/src/api/util/stringHelper.ts +26 -0
  114. package/src/buildinfo.json +2 -2
  115. package/src/commonjs.tsconfig.json +13 -13
  116. package/src/declaration.tsconfig.json +10 -10
  117. package/src/dev.ts +45 -60
  118. package/src/es6.tsconfig.json +13 -13
  119. package/src/index.ts +91 -87
  120. package/src/pagesconfig.json +51 -47
  121. package/src/tsconfig.json +43 -43
  122. package/src/tsconfig.types.json +9 -9
  123. package/src/types.d.ts +4 -4
  124. package/src/assets/02_environment.env +0 -0
  125. package/src/assets/02_test_hdri_flipped.hdr +0 -0
  126. package/src/assets/07rDvxP2xTk.glb +0 -0
  127. package/src/assets/08L8DrdZt8y.glb +0 -0
  128. package/src/assets/CB-6250/main.js +0 -427
  129. package/src/assets/CB-6250/models/.gitkeep +0 -1
  130. package/src/assets/CB-6250/models/candle.glb +0 -0
  131. package/src/assets/CB-6250/models/lamp.glb +0 -0
  132. package/src/assets/CB-6250/models/molto-bido.glb +0 -0
  133. package/src/assets/CB-6250/models/mtron.glb +0 -0
  134. package/src/assets/CB-6250/models/mtron_split_geometry.glb +0 -0
  135. package/src/assets/CB-6250/models/mtron_split_material.glb +0 -0
  136. package/src/assets/KTM1290SA/AvatarAdv.glb +0 -0
  137. package/src/assets/KTM1290SA/ktm1290SA.ts +0 -77
  138. package/src/assets/KTM1290SA/scene.json +0 -16
  139. package/src/assets/_draft/main.js +0 -117
  140. package/src/assets/_draft/models/.gitkeep +0 -1
  141. package/src/assets/_draft/models/_demo.glb +0 -0
  142. package/src/assets/_draft/studio.env +0 -0
  143. package/src/assets/bike/CompleteBike_Optim_986K_01.glb +0 -0
  144. package/src/assets/bike/complete.json +0 -19
  145. package/src/assets/bike/index.json +0 -9
  146. package/src/assets/bike/setup.json +0 -11
  147. package/src/assets/ctrls-helper.ts +0 -89
  148. package/src/assets/cube/10 environment.env +0 -0
  149. package/src/assets/cube/bin_svg_logo_test.glb +0 -0
  150. package/src/assets/cube/cube.ts +0 -42
  151. package/src/assets/cube/cube_v2.glb +0 -0
  152. package/src/assets/cube/scene.ts +0 -83
  153. package/src/assets/cube/testCylinderUVs.glb +0 -0
  154. package/src/assets/environment.env +0 -0
  155. package/src/assets/hoferkerzen/hoferkerzen.glb +0 -0
  156. package/src/assets/hoferkerzen/index.json +0 -9
  157. package/src/assets/hoferkerzen/setup.json +0 -11
  158. package/src/assets/hoferkerzen/variant_kgl.json +0 -41
  159. package/src/assets/husqvarna-instanced-meshes/husqvarna.env +0 -0
  160. package/src/assets/husqvarna-instanced-meshes/husqvarna.glb +0 -0
  161. package/src/assets/husqvarna-instanced-meshes/main.ts +0 -108
  162. package/src/assets/index.html +0 -144
  163. package/src/assets/index.json +0 -9
  164. package/src/assets/linkeddups/example_2_instances.glb +0 -0
  165. package/src/assets/linkeddups/spec.ts +0 -32
  166. package/src/assets/molto-mova-multi-instance-shown-bug/main.ts +0 -106
  167. package/src/assets/molto-mova-multi-instance-shown-bug/molto-mova-rc82.glb +0 -0
  168. package/src/assets/molto-mova-multi-instance-shown-bug/molto-mova-volare.glb +0 -0
  169. package/src/assets/molto-mova-multi-instance-shown-bug/studio.env +0 -0
  170. package/src/assets/moltomova/10 environment.env +0 -0
  171. package/src/assets/moltomova/RC65.glb +0 -0
  172. package/src/assets/moltomova/RC82.glb +0 -0
  173. package/src/assets/moltomova/TPH67.glb +0 -0
  174. package/src/assets/moltomova/TPH82.glb +0 -0
  175. package/src/assets/moltomova/Volare.glb +0 -0
  176. package/src/assets/moltomova/moltomova-cl3d-spec-rc65.ts +0 -159
  177. package/src/assets/moltomova/moltomova-cl3d-spec-rc82.ts +0 -118
  178. package/src/assets/moltomova/moltomova-cl3d-spec-scene.ts +0 -57
  179. package/src/assets/moltomova/moltomova-cl3d-spec-tph67.ts +0 -199
  180. package/src/assets/moltomova/moltomova-cl3d-spec-tph82.ts +0 -173
  181. package/src/assets/moltomova/moltomova-cl3d-spec-volare65.ts +0 -173
  182. package/src/assets/moltomova/moltomova.ts +0 -175
  183. package/src/assets/mova.json +0 -18
  184. package/src/assets/mova_3_phase_rail.glb +0 -0
  185. package/src/assets/mova_3_phase_rail.json +0 -86
  186. package/src/assets/mova_recessed_luminaire.glb +0 -0
  187. package/src/assets/mova_recessed_luminaire.json +0 -81
  188. package/src/assets/nessie/gltf-test-no-material.gltf +0 -142
  189. package/src/assets/nessie/gltf-test-no-material_data.bin +0 -0
  190. package/src/assets/nessie/gltf-test-rotation.gltf +0 -142
  191. package/src/assets/nessie/gltf-test-rotation_data.bin +0 -0
  192. package/src/assets/nessie/gltf-test.gltf +0 -178
  193. package/src/assets/nessie/gltf-test_data.bin +0 -0
  194. package/src/assets/nessie/index.json +0 -9
  195. package/src/assets/nessie/nessie_basic.json +0 -24
  196. package/src/assets/nessie/setup.json +0 -12
  197. package/src/assets/scene.json +0 -64
  198. package/src/assets/setup.json +0 -25
  199. package/src/assets/small_cave_1k.hdr +0 -0
  200. package/src/assets/svgTo3D/09aJssVZrjk.env +0 -0
  201. package/src/assets/svgTo3D/09f0zfBQBWK.glb +0 -0
  202. package/src/assets/svgTo3D/9bae062709f8a7803769ba955cde3c4a.jpg +0 -0
  203. package/src/assets/svgTo3D/logo-cyledge.svg +0 -19
  204. package/src/assets/svgTo3D/spec.ts +0 -56
  205. package/src/assets/svgTo3D/svg_assets/09fmVjc59hQ.png +0 -0
  206. package/src/assets/svgTo3D/svg_assets/LDI2apCSOBg7S-QT7pb0EPOreec.woff2 +0 -0
  207. package/src/assets/svgTo3D/svg_assets/unineue_regular.woff2 +0 -0
  208. package/src/assets/svgTo3D/testCube.glb +0 -0
  209. package/src/assets/svgTo3D/testCube001.glb +0 -0
  210. package/src/assets/svgTo3D/testCubeSpec.ts +0 -49
  211. package/src/assets/textures/grass.png +0 -0
  212. package/src/assets/textures/seamless-grunge-scratched-texture.jpg +0 -0
@@ -1,322 +1,322 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.VariantInstanceManager = void 0;
4
- var tslib_1 = require("tslib");
5
- var lodash_es_1 = require("lodash-es");
6
- var dottedPath_1 = require("../classes/dottedPath");
7
- var event_1 = require("../classes/event");
8
- var eventBroadcaster_1 = require("../classes/eventBroadcaster");
9
- var parameter_1 = require("../classes/parameter");
10
- var variantInstance_1 = require("../classes/variantInstance");
11
- /**
12
- * There's usually no need to instantiate a {@link VariantInstanceManager} yourself as it is provided by each
13
- * {@link Viewer} instance via its {@link Viewer.variantInstances}
14
- */
15
- var VariantInstanceManager = /** @class */ (function (_super) {
16
- tslib_1.__extends(VariantInstanceManager, _super);
17
- /**
18
- * Constructor.
19
- */
20
- function VariantInstanceManager(rootVariant) {
21
- var _this = _super.call(this) || this;
22
- _this.rootVariant = rootVariant;
23
- _this.variantInstances = new Map();
24
- _this.variantInstanceDefinitions = new Map();
25
- _this.parameters = {};
26
- _this.queues = {};
27
- return _this;
28
- }
29
- /**
30
- * Creates a {@link VariantInstanceManager} based on given root Variant.
31
- */
32
- VariantInstanceManager.create = function (rootVariant) {
33
- return tslib_1.__awaiter(this, void 0, void 0, function () {
34
- return tslib_1.__generator(this, function (_a) {
35
- return [2 /*return*/, new VariantInstanceManager(rootVariant)];
36
- });
37
- });
38
- };
39
- Object.defineProperty(VariantInstanceManager.prototype, "all", {
40
- /**
41
- * Gets all instances.
42
- */
43
- get: function () {
44
- var all = [];
45
- this.variantInstances.forEach(function (variantInstance) { return all.push(variantInstance); });
46
- return all;
47
- },
48
- enumerable: false,
49
- configurable: true
50
- });
51
- Object.defineProperty(VariantInstanceManager.prototype, "allDefinitions", {
52
- /**
53
- * Gets all instance definitions.
54
- */
55
- get: function () {
56
- var all = [];
57
- this.variantInstanceDefinitions.forEach(function (definition) { return all.push(definition); });
58
- return all;
59
- },
60
- enumerable: false,
61
- configurable: true
62
- });
63
- /**
64
- * Checks whether a {@link VariantInstance} is either registered or created.
65
- */
66
- VariantInstanceManager.prototype.has = function (name) {
67
- return this.variantInstances.has(name) || this.variantInstanceDefinitions.has(name);
68
- };
69
- /**
70
- * Retrieves a {@link VariantInstance}.
71
- * If the instance has been created, the created instance will be returned.
72
- * If the instance is registered, the instance will be created.
73
- * If none of these apply, an Error is thrown.
74
- *
75
- * @emits {@link Event.VARIANT_INSTANCE_CREATED}
76
- */
77
- VariantInstanceManager.prototype.get = function (name) {
78
- return tslib_1.__awaiter(this, void 0, void 0, function () {
79
- var definition;
80
- return tslib_1.__generator(this, function (_a) {
81
- switch (_a.label) {
82
- case 0:
83
- if (this.variantInstances.has(name)) {
84
- return [2 /*return*/, this.variantInstances.get(name)];
85
- }
86
- if (!this.variantInstanceDefinitions.has(name)) return [3 /*break*/, 2];
87
- definition = this.variantInstanceDefinitions.get(name);
88
- return [4 /*yield*/, this.createFromDefinition(definition)];
89
- case 1: return [2 /*return*/, _a.sent()];
90
- case 2: throw Error("VariantInstance with name \"" + name + "\" neither created nor configured.");
91
- }
92
- });
93
- });
94
- };
95
- /**
96
- * Creates and registers a unique {@link VariantInstance}.
97
- *
98
- * @emits {@link Event.VARIANT_INSTANCE_CREATED}
99
- */
100
- VariantInstanceManager.prototype.create = function (dottedPath, name, parameters) {
101
- return tslib_1.__awaiter(this, void 0, void 0, function () {
102
- var variant, definition;
103
- return tslib_1.__generator(this, function (_a) {
104
- switch (_a.label) {
105
- case 0:
106
- variant = dottedPath_1.DottedPath.create(dottedPath).path;
107
- definition = {
108
- name: this.ensureUniqueName(name ? name : variant),
109
- variant: variant,
110
- parameters: parameters
111
- };
112
- return [4 /*yield*/, this.createFromDefinition(definition)];
113
- case 1: return [2 /*return*/, _a.sent()];
114
- }
115
- });
116
- });
117
- };
118
- /**
119
- * Registers a unique {@link VariantInstanceDefinition}.
120
- *
121
- * @emits {@link Event.VARIANT_INSTANCE_REGISTERED}
122
- */
123
- VariantInstanceManager.prototype.register = function (instanceDefinition) {
124
- var name = instanceDefinition.name ? instanceDefinition.name
125
- : dottedPath_1.DottedPath.create(instanceDefinition.variant).path;
126
- instanceDefinition.name = this.ensureUniqueName(name);
127
- this.variantInstanceDefinitions.set(instanceDefinition.name, instanceDefinition);
128
- this.broadcastEvent(event_1.Event.VARIANT_INSTANCE_REGISTERED, instanceDefinition);
129
- return instanceDefinition;
130
- };
131
- /**
132
- * Commits the {@link ParameterBag} to all registered and created {@link VariantInstance}s.
133
- */
134
- VariantInstanceManager.prototype.commitParameters = function (parameters, onlyVisible) {
135
- if (parameters === void 0) { parameters = {}; }
136
- if (onlyVisible === void 0) { onlyVisible = true; }
137
- return tslib_1.__awaiter(this, void 0, void 0, function () {
138
- var instances, promises;
139
- var _this = this;
140
- return tslib_1.__generator(this, function (_a) {
141
- switch (_a.label) {
142
- case 0:
143
- this.parameters = lodash_es_1.merge(this.parameters, parameters);
144
- this.allDefinitions.forEach(function (definition) { return definition.parameters = lodash_es_1.merge(definition.parameters, _this.parameters); });
145
- instances = this.all;
146
- if (onlyVisible) {
147
- instances = this.all.filter(function (instance) { return instance.variant.visible; });
148
- }
149
- promises = instances.map(function (instance) { return instance.variant.commitParameters(_this.parameters); });
150
- return [4 /*yield*/, Promise.all(promises)];
151
- case 1:
152
- _a.sent();
153
- return [2 /*return*/, this];
154
- }
155
- });
156
- });
157
- };
158
- /**
159
- * Show one {@link VariantInstance}. If `exclusive` is set to `true` it will hide all other
160
- * instances handled by this {@link VariantInstanceManager}. If the function is called synchronously,
161
- * the calls end up in a queue according to the FIFO principle (the last one wins).
162
- */
163
- VariantInstanceManager.prototype.show = function (name, exclusive) {
164
- if (exclusive === void 0) { exclusive = false; }
165
- return tslib_1.__awaiter(this, void 0, void 0, function () {
166
- var promise, i, instance;
167
- var _this = this;
168
- return tslib_1.__generator(this, function (_a) {
169
- switch (_a.label) {
170
- case 0:
171
- promise = new Promise(function (resolve) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
172
- var instance;
173
- return tslib_1.__generator(this, function (_a) {
174
- switch (_a.label) {
175
- case 0:
176
- if (!exclusive) return [3 /*break*/, 2];
177
- this.allDefinitions.filter(function (definition) { return definition.name !== name; }).forEach(function (definition) {
178
- var parameters = {};
179
- parameters[parameter_1.Parameter.VISIBLE] = false;
180
- definition.parameters = lodash_es_1.merge(definition.parameters, parameters);
181
- });
182
- return [4 /*yield*/, Promise.all(this.all.filter(function (_instance) { return _instance.name !== name; }).map(function (_instance) {
183
- return _instance.variant.hide();
184
- }))];
185
- case 1:
186
- _a.sent();
187
- _a.label = 2;
188
- case 2: return [4 /*yield*/, this.get(name)];
189
- case 3:
190
- instance = _a.sent();
191
- return [4 /*yield*/, instance.variant.show()];
192
- case 4:
193
- _a.sent();
194
- resolve(instance);
195
- return [2 /*return*/];
196
- }
197
- });
198
- }); });
199
- if (!this.queues['show']) {
200
- this.queues['show'] = [];
201
- }
202
- this.queues['show'].push(promise);
203
- i = 0;
204
- _a.label = 1;
205
- case 1:
206
- if (!(i < this.queues['show'].length)) return [3 /*break*/, 5];
207
- return [4 /*yield*/, this.queues['show'][i]];
208
- case 2:
209
- instance = _a.sent();
210
- if (!exclusive) return [3 /*break*/, 4];
211
- if (!(i + 1 < this.queues['show'].length)) return [3 /*break*/, 4];
212
- return [4 /*yield*/, instance.variant.hide()];
213
- case 3:
214
- _a.sent();
215
- _a.label = 4;
216
- case 4:
217
- i++;
218
- return [3 /*break*/, 1];
219
- case 5:
220
- this.queues['show'] = [];
221
- return [2 /*return*/, promise];
222
- }
223
- });
224
- });
225
- };
226
- /**
227
- * Clones and registers a new {@link VariantInstance} with a new, unique name.
228
- *
229
- * @emits {@link Event.VARIANT_INSTANCE_CLONED}
230
- */
231
- VariantInstanceManager.prototype.clone = function (name, newName, parameters) {
232
- return tslib_1.__awaiter(this, void 0, void 0, function () {
233
- var variantInstance, definition, living, variantInstanceClone;
234
- return tslib_1.__generator(this, function (_a) {
235
- switch (_a.label) {
236
- case 0:
237
- if (!this.variantInstances.has(name)) {
238
- throw Error("VariantInstance with name \"" + name + "\" does not exist.");
239
- }
240
- variantInstance = this.variantInstances.get(name);
241
- definition = {
242
- name: this.ensureUniqueName(newName ? newName : name),
243
- variant: variantInstance.variant.id,
244
- parameters: parameters
245
- };
246
- return [4 /*yield*/, variantInstance.variant.createLiving(definition.parameters)];
247
- case 1:
248
- living = _a.sent();
249
- variantInstanceClone = new variantInstance_1.VariantInstance(living, definition.name);
250
- this.variantInstances.set(definition.name, variantInstanceClone);
251
- variantInstance.broadcastEvent(event_1.Event.VARIANT_INSTANCE_CLONED, variantInstanceClone);
252
- return [2 /*return*/, variantInstanceClone];
253
- }
254
- });
255
- });
256
- };
257
- /**
258
- * Destroys the instance by removing the {@link Variant} and de-registering the instance.
259
- *
260
- * @emits {@link Event.VARIANT_INSTANCE_DESTROYED}
261
- */
262
- VariantInstanceManager.prototype.destroy = function (name) {
263
- if (!this.variantInstances.has(name)) {
264
- throw Error("VariantInstance with name \"" + name + "\" does not exist.");
265
- }
266
- var variantInstance = this.variantInstances.get(name);
267
- variantInstance.variant.destroy();
268
- this.variantInstances.delete(name);
269
- variantInstance.broadcastEvent(event_1.Event.VARIANT_INSTANCE_DESTROYED, variantInstance);
270
- return this;
271
- };
272
- /**
273
- * Creates and registers a unique {@link VariantInstance} from `definition`.
274
- *
275
- * @emits {@link Event.VARIANT_INSTANCE_CREATED}
276
- */
277
- VariantInstanceManager.prototype.createFromDefinition = function (definition) {
278
- return tslib_1.__awaiter(this, void 0, void 0, function () {
279
- var variant, living, variantInstance;
280
- return tslib_1.__generator(this, function (_a) {
281
- switch (_a.label) {
282
- case 0:
283
- if (!definition.name) {
284
- throw new Error("Given VariantInstanceDefinition " + definition.variant + " is missing a name property.");
285
- }
286
- if (this.variantInstances.has(definition.name)) {
287
- throw new Error("VariantInstance with name \"" + definition.name + "\" is already created.");
288
- }
289
- if (!this.rootVariant) {
290
- throw new Error("Viewer has not been properly bootstrapped (rootVariant missing).");
291
- }
292
- return [4 /*yield*/, this.rootVariant.getDescendant(definition.variant)];
293
- case 1:
294
- variant = _a.sent();
295
- return [4 /*yield*/, variant.createLiving(definition.parameters)];
296
- case 2:
297
- living = _a.sent();
298
- variantInstance = new variantInstance_1.VariantInstance(living, definition.name);
299
- this.variantInstances.set(definition.name, variantInstance);
300
- this.broadcastEvent(event_1.Event.VARIANT_INSTANCE_CREATED, variantInstance);
301
- return [2 /*return*/, variantInstance];
302
- }
303
- });
304
- });
305
- };
306
- /**
307
- * Creates a unique instance name based on already registered instance names on the {@link VariantInstanceManager}.
308
- * Appends an `_i` to the name where `i = 0` and increments as long as the name is not registered.
309
- */
310
- VariantInstanceManager.prototype.ensureUniqueName = function (name) {
311
- var instanceName = name;
312
- var i = 1;
313
- while (this.has(instanceName)) {
314
- instanceName = name + "_" + i;
315
- i++;
316
- }
317
- return instanceName;
318
- };
319
- return VariantInstanceManager;
320
- }(eventBroadcaster_1.EventBroadcaster));
321
- exports.VariantInstanceManager = VariantInstanceManager;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.VariantInstanceManager = void 0;
4
+ var tslib_1 = require("tslib");
5
+ var lodash_es_1 = require("lodash-es");
6
+ var dottedPath_1 = require("../classes/dottedPath");
7
+ var event_1 = require("../classes/event");
8
+ var eventBroadcaster_1 = require("../classes/eventBroadcaster");
9
+ var parameter_1 = require("../classes/parameter");
10
+ var variantInstance_1 = require("../classes/variantInstance");
11
+ /**
12
+ * There's usually no need to instantiate a {@link VariantInstanceManager} yourself as it is provided by each
13
+ * {@link Viewer} instance via its {@link Viewer.variantInstances}
14
+ */
15
+ var VariantInstanceManager = /** @class */ (function (_super) {
16
+ tslib_1.__extends(VariantInstanceManager, _super);
17
+ /**
18
+ * Constructor.
19
+ */
20
+ function VariantInstanceManager(rootVariant) {
21
+ var _this = _super.call(this) || this;
22
+ _this.rootVariant = rootVariant;
23
+ _this.variantInstances = new Map();
24
+ _this.variantInstanceDefinitions = new Map();
25
+ _this.parameters = {};
26
+ _this.queues = {};
27
+ return _this;
28
+ }
29
+ /**
30
+ * Creates a {@link VariantInstanceManager} based on given root Variant.
31
+ */
32
+ VariantInstanceManager.create = function (rootVariant) {
33
+ return tslib_1.__awaiter(this, void 0, void 0, function () {
34
+ return tslib_1.__generator(this, function (_a) {
35
+ return [2 /*return*/, new VariantInstanceManager(rootVariant)];
36
+ });
37
+ });
38
+ };
39
+ Object.defineProperty(VariantInstanceManager.prototype, "all", {
40
+ /**
41
+ * Gets all instances.
42
+ */
43
+ get: function () {
44
+ var all = [];
45
+ this.variantInstances.forEach(function (variantInstance) { return all.push(variantInstance); });
46
+ return all;
47
+ },
48
+ enumerable: false,
49
+ configurable: true
50
+ });
51
+ Object.defineProperty(VariantInstanceManager.prototype, "allDefinitions", {
52
+ /**
53
+ * Gets all instance definitions.
54
+ */
55
+ get: function () {
56
+ var all = [];
57
+ this.variantInstanceDefinitions.forEach(function (definition) { return all.push(definition); });
58
+ return all;
59
+ },
60
+ enumerable: false,
61
+ configurable: true
62
+ });
63
+ /**
64
+ * Checks whether a {@link VariantInstance} is either registered or created.
65
+ */
66
+ VariantInstanceManager.prototype.has = function (name) {
67
+ return this.variantInstances.has(name) || this.variantInstanceDefinitions.has(name);
68
+ };
69
+ /**
70
+ * Retrieves a {@link VariantInstance}.
71
+ * If the instance has been created, the created instance will be returned.
72
+ * If the instance is registered, the instance will be created.
73
+ * If none of these apply, an Error is thrown.
74
+ *
75
+ * @emits {@link Event.VARIANT_INSTANCE_CREATED}
76
+ */
77
+ VariantInstanceManager.prototype.get = function (name) {
78
+ return tslib_1.__awaiter(this, void 0, void 0, function () {
79
+ var definition;
80
+ return tslib_1.__generator(this, function (_a) {
81
+ switch (_a.label) {
82
+ case 0:
83
+ if (this.variantInstances.has(name)) {
84
+ return [2 /*return*/, this.variantInstances.get(name)];
85
+ }
86
+ if (!this.variantInstanceDefinitions.has(name)) return [3 /*break*/, 2];
87
+ definition = this.variantInstanceDefinitions.get(name);
88
+ return [4 /*yield*/, this.createFromDefinition(definition)];
89
+ case 1: return [2 /*return*/, _a.sent()];
90
+ case 2: throw Error("VariantInstance with name \"" + name + "\" neither created nor configured.");
91
+ }
92
+ });
93
+ });
94
+ };
95
+ /**
96
+ * Creates and registers a unique {@link VariantInstance}.
97
+ *
98
+ * @emits {@link Event.VARIANT_INSTANCE_CREATED}
99
+ */
100
+ VariantInstanceManager.prototype.create = function (dottedPath, name, parameters) {
101
+ return tslib_1.__awaiter(this, void 0, void 0, function () {
102
+ var variant, definition;
103
+ return tslib_1.__generator(this, function (_a) {
104
+ switch (_a.label) {
105
+ case 0:
106
+ variant = dottedPath_1.DottedPath.create(dottedPath).path;
107
+ definition = {
108
+ name: this.ensureUniqueName(name ? name : variant),
109
+ variant: variant,
110
+ parameters: parameters
111
+ };
112
+ return [4 /*yield*/, this.createFromDefinition(definition)];
113
+ case 1: return [2 /*return*/, _a.sent()];
114
+ }
115
+ });
116
+ });
117
+ };
118
+ /**
119
+ * Registers a unique {@link VariantInstanceDefinition}.
120
+ *
121
+ * @emits {@link Event.VARIANT_INSTANCE_REGISTERED}
122
+ */
123
+ VariantInstanceManager.prototype.register = function (instanceDefinition) {
124
+ var name = instanceDefinition.name ? instanceDefinition.name
125
+ : dottedPath_1.DottedPath.create(instanceDefinition.variant).path;
126
+ instanceDefinition.name = this.ensureUniqueName(name);
127
+ this.variantInstanceDefinitions.set(instanceDefinition.name, instanceDefinition);
128
+ this.broadcastEvent(event_1.Event.VARIANT_INSTANCE_REGISTERED, instanceDefinition);
129
+ return instanceDefinition;
130
+ };
131
+ /**
132
+ * Commits the {@link ParameterBag} to all registered and created {@link VariantInstance}s.
133
+ */
134
+ VariantInstanceManager.prototype.commitParameters = function (parameters, onlyVisible) {
135
+ if (parameters === void 0) { parameters = {}; }
136
+ if (onlyVisible === void 0) { onlyVisible = true; }
137
+ return tslib_1.__awaiter(this, void 0, void 0, function () {
138
+ var instances, promises;
139
+ var _this = this;
140
+ return tslib_1.__generator(this, function (_a) {
141
+ switch (_a.label) {
142
+ case 0:
143
+ this.parameters = lodash_es_1.merge(this.parameters, parameters);
144
+ this.allDefinitions.forEach(function (definition) { return definition.parameters = lodash_es_1.merge(definition.parameters, _this.parameters); });
145
+ instances = this.all;
146
+ if (onlyVisible) {
147
+ instances = this.all.filter(function (instance) { return instance.variant.visible; });
148
+ }
149
+ promises = instances.map(function (instance) { return instance.variant.commitParameters(_this.parameters); });
150
+ return [4 /*yield*/, Promise.all(promises)];
151
+ case 1:
152
+ _a.sent();
153
+ return [2 /*return*/, this];
154
+ }
155
+ });
156
+ });
157
+ };
158
+ /**
159
+ * Show one {@link VariantInstance}. If `exclusive` is set to `true` it will hide all other
160
+ * instances handled by this {@link VariantInstanceManager}. If the function is called synchronously,
161
+ * the calls end up in a queue according to the FIFO principle (the last one wins).
162
+ */
163
+ VariantInstanceManager.prototype.show = function (name, exclusive) {
164
+ if (exclusive === void 0) { exclusive = false; }
165
+ return tslib_1.__awaiter(this, void 0, void 0, function () {
166
+ var promise, i, instance;
167
+ var _this = this;
168
+ return tslib_1.__generator(this, function (_a) {
169
+ switch (_a.label) {
170
+ case 0:
171
+ promise = new Promise(function (resolve) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
172
+ var instance;
173
+ return tslib_1.__generator(this, function (_a) {
174
+ switch (_a.label) {
175
+ case 0:
176
+ if (!exclusive) return [3 /*break*/, 2];
177
+ this.allDefinitions.filter(function (definition) { return definition.name !== name; }).forEach(function (definition) {
178
+ var parameters = {};
179
+ parameters[parameter_1.Parameter.VISIBLE] = false;
180
+ definition.parameters = lodash_es_1.merge(definition.parameters, parameters);
181
+ });
182
+ return [4 /*yield*/, Promise.all(this.all.filter(function (_instance) { return _instance.name !== name; }).map(function (_instance) {
183
+ return _instance.variant.hide();
184
+ }))];
185
+ case 1:
186
+ _a.sent();
187
+ _a.label = 2;
188
+ case 2: return [4 /*yield*/, this.get(name)];
189
+ case 3:
190
+ instance = _a.sent();
191
+ return [4 /*yield*/, instance.variant.show()];
192
+ case 4:
193
+ _a.sent();
194
+ resolve(instance);
195
+ return [2 /*return*/];
196
+ }
197
+ });
198
+ }); });
199
+ if (!this.queues['show']) {
200
+ this.queues['show'] = [];
201
+ }
202
+ this.queues['show'].push(promise);
203
+ i = 0;
204
+ _a.label = 1;
205
+ case 1:
206
+ if (!(i < this.queues['show'].length)) return [3 /*break*/, 5];
207
+ return [4 /*yield*/, this.queues['show'][i]];
208
+ case 2:
209
+ instance = _a.sent();
210
+ if (!exclusive) return [3 /*break*/, 4];
211
+ if (!(i + 1 < this.queues['show'].length)) return [3 /*break*/, 4];
212
+ return [4 /*yield*/, instance.variant.hide()];
213
+ case 3:
214
+ _a.sent();
215
+ _a.label = 4;
216
+ case 4:
217
+ i++;
218
+ return [3 /*break*/, 1];
219
+ case 5:
220
+ this.queues['show'] = [];
221
+ return [2 /*return*/, promise];
222
+ }
223
+ });
224
+ });
225
+ };
226
+ /**
227
+ * Clones and registers a new {@link VariantInstance} with a new, unique name.
228
+ *
229
+ * @emits {@link Event.VARIANT_INSTANCE_CLONED}
230
+ */
231
+ VariantInstanceManager.prototype.clone = function (name, newName, parameters) {
232
+ return tslib_1.__awaiter(this, void 0, void 0, function () {
233
+ var variantInstance, definition, living, variantInstanceClone;
234
+ return tslib_1.__generator(this, function (_a) {
235
+ switch (_a.label) {
236
+ case 0:
237
+ if (!this.variantInstances.has(name)) {
238
+ throw Error("VariantInstance with name \"" + name + "\" does not exist.");
239
+ }
240
+ variantInstance = this.variantInstances.get(name);
241
+ definition = {
242
+ name: this.ensureUniqueName(newName ? newName : name),
243
+ variant: variantInstance.variant.id,
244
+ parameters: parameters
245
+ };
246
+ return [4 /*yield*/, variantInstance.variant.createLiving(definition.parameters)];
247
+ case 1:
248
+ living = _a.sent();
249
+ variantInstanceClone = new variantInstance_1.VariantInstance(living, definition.name);
250
+ this.variantInstances.set(definition.name, variantInstanceClone);
251
+ variantInstance.broadcastEvent(event_1.Event.VARIANT_INSTANCE_CLONED, variantInstanceClone);
252
+ return [2 /*return*/, variantInstanceClone];
253
+ }
254
+ });
255
+ });
256
+ };
257
+ /**
258
+ * Destroys the instance by removing the {@link Variant} and de-registering the instance.
259
+ *
260
+ * @emits {@link Event.VARIANT_INSTANCE_DESTROYED}
261
+ */
262
+ VariantInstanceManager.prototype.destroy = function (name) {
263
+ if (!this.variantInstances.has(name)) {
264
+ throw Error("VariantInstance with name \"" + name + "\" does not exist.");
265
+ }
266
+ var variantInstance = this.variantInstances.get(name);
267
+ variantInstance.variant.destroy();
268
+ this.variantInstances.delete(name);
269
+ variantInstance.broadcastEvent(event_1.Event.VARIANT_INSTANCE_DESTROYED, variantInstance);
270
+ return this;
271
+ };
272
+ /**
273
+ * Creates and registers a unique {@link VariantInstance} from `definition`.
274
+ *
275
+ * @emits {@link Event.VARIANT_INSTANCE_CREATED}
276
+ */
277
+ VariantInstanceManager.prototype.createFromDefinition = function (definition) {
278
+ return tslib_1.__awaiter(this, void 0, void 0, function () {
279
+ var variant, living, variantInstance;
280
+ return tslib_1.__generator(this, function (_a) {
281
+ switch (_a.label) {
282
+ case 0:
283
+ if (!definition.name) {
284
+ throw new Error("Given VariantInstanceDefinition " + definition.variant + " is missing a name property.");
285
+ }
286
+ if (this.variantInstances.has(definition.name)) {
287
+ throw new Error("VariantInstance with name \"" + definition.name + "\" is already created.");
288
+ }
289
+ if (!this.rootVariant) {
290
+ throw new Error("Viewer has not been properly bootstrapped (rootVariant missing).");
291
+ }
292
+ return [4 /*yield*/, this.rootVariant.getDescendant(definition.variant)];
293
+ case 1:
294
+ variant = _a.sent();
295
+ return [4 /*yield*/, variant.createLiving(definition.parameters)];
296
+ case 2:
297
+ living = _a.sent();
298
+ variantInstance = new variantInstance_1.VariantInstance(living, definition.name);
299
+ this.variantInstances.set(definition.name, variantInstance);
300
+ this.broadcastEvent(event_1.Event.VARIANT_INSTANCE_CREATED, variantInstance);
301
+ return [2 /*return*/, variantInstance];
302
+ }
303
+ });
304
+ });
305
+ };
306
+ /**
307
+ * Creates a unique instance name based on already registered instance names on the {@link VariantInstanceManager}.
308
+ * Appends an `_i` to the name where `i = 0` and increments as long as the name is not registered.
309
+ */
310
+ VariantInstanceManager.prototype.ensureUniqueName = function (name) {
311
+ var instanceName = name;
312
+ var i = 1;
313
+ while (this.has(instanceName)) {
314
+ instanceName = name + "_" + i;
315
+ i++;
316
+ }
317
+ return instanceName;
318
+ };
319
+ return VariantInstanceManager;
320
+ }(eventBroadcaster_1.EventBroadcaster));
321
+ exports.VariantInstanceManager = VariantInstanceManager;
322
322
  //# sourceMappingURL=variantInstanceManager.js.map