@combeenation/3d-viewer 5.0.1 → 5.0.3-beta2
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.
- package/README.md +111 -114
- package/dist/lib-cjs/api/classes/animationInterface.d.ts +8 -8
- package/dist/lib-cjs/api/classes/animationInterface.js +1 -1
- package/dist/lib-cjs/api/classes/dottedPath.d.ts +79 -79
- package/dist/lib-cjs/api/classes/dottedPath.js +187 -187
- package/dist/lib-cjs/api/classes/element.d.ts +139 -139
- package/dist/lib-cjs/api/classes/element.js +794 -794
- package/dist/lib-cjs/api/classes/element.js.map +1 -1
- package/dist/lib-cjs/api/classes/elementParameterizable.d.ts +14 -0
- package/dist/lib-cjs/api/classes/elementParameterizable.js +135 -0
- package/dist/lib-cjs/api/classes/elementParameterizable.js.map +1 -0
- package/dist/lib-cjs/api/classes/event.d.ts +326 -326
- package/dist/lib-cjs/api/classes/event.js +371 -371
- package/dist/lib-cjs/api/classes/eventBroadcaster.d.ts +26 -26
- package/dist/lib-cjs/api/classes/eventBroadcaster.js +53 -53
- package/dist/lib-cjs/api/classes/parameter.d.ts +316 -259
- package/dist/lib-cjs/api/classes/parameter.js +451 -388
- package/dist/lib-cjs/api/classes/parameter.js.map +1 -1
- package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
- package/dist/lib-cjs/api/classes/parameterObservable.js +101 -101
- package/dist/lib-cjs/api/classes/parameterizable.d.ts +15 -15
- package/dist/lib-cjs/api/classes/parameterizable.js +149 -149
- package/dist/lib-cjs/api/classes/placementAnimation.d.ts +44 -44
- package/dist/lib-cjs/api/classes/placementAnimation.js +163 -163
- package/dist/lib-cjs/api/classes/variant.d.ts +234 -234
- package/dist/lib-cjs/api/classes/variant.js +1154 -1154
- package/dist/lib-cjs/api/classes/variantInstance.d.ts +45 -45
- package/dist/lib-cjs/api/classes/variantInstance.js +108 -108
- package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +17 -17
- package/dist/lib-cjs/api/classes/variantParameterizable.js +99 -99
- package/dist/lib-cjs/api/classes/viewer.d.ts +177 -175
- package/dist/lib-cjs/api/classes/viewer.js +717 -701
- package/dist/lib-cjs/api/classes/viewer.js.map +1 -1
- package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
- package/dist/lib-cjs/api/classes/viewerLight.js +392 -392
- package/dist/lib-cjs/api/internal/debugViewer.d.ts +13 -13
- package/dist/lib-cjs/api/internal/debugViewer.js +86 -86
- package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
- package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
- package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -10
- package/dist/lib-cjs/api/internal/sceneSetup.js +238 -234
- package/dist/lib-cjs/api/internal/sceneSetup.js.map +1 -1
- package/dist/lib-cjs/api/manager/animationManager.d.ts +29 -29
- package/dist/lib-cjs/api/manager/animationManager.js +130 -130
- package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +65 -65
- package/dist/lib-cjs/api/manager/gltfExportManager.js +223 -222
- package/dist/lib-cjs/api/manager/gltfExportManager.js.map +1 -1
- package/dist/lib-cjs/api/manager/sceneManager.d.ts +31 -32
- package/dist/lib-cjs/api/manager/sceneManager.js +153 -132
- package/dist/lib-cjs/api/manager/sceneManager.js.map +1 -1
- package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +92 -92
- package/dist/lib-cjs/api/manager/variantInstanceManager.js +335 -335
- package/dist/lib-cjs/api/store/specStorage.d.ts +24 -24
- package/dist/lib-cjs/api/store/specStorage.js +51 -51
- package/dist/lib-cjs/api/util/babylonHelper.d.ts +174 -166
- package/dist/lib-cjs/api/util/babylonHelper.js +575 -497
- package/dist/lib-cjs/api/util/babylonHelper.js.map +1 -1
- package/dist/lib-cjs/api/util/globalTypes.d.ts +366 -356
- package/dist/lib-cjs/api/util/globalTypes.js +1 -1
- package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -53
- package/dist/lib-cjs/api/util/resourceHelper.js +257 -242
- package/dist/lib-cjs/api/util/resourceHelper.js.map +1 -1
- package/dist/lib-cjs/api/util/stringHelper.d.ts +9 -9
- package/dist/lib-cjs/api/util/stringHelper.js +25 -25
- package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
- package/dist/lib-cjs/api/util/structureHelper.js +48 -44
- package/dist/lib-cjs/api/util/structureHelper.js.map +1 -1
- package/dist/lib-cjs/buildinfo.json +3 -3
- package/dist/lib-cjs/index.d.ts +49 -49
- package/dist/lib-cjs/index.js +89 -89
- package/dist/webpack-stats.json +0 -0
- package/package.json +87 -87
- package/src/api/classes/animationInterface.ts +10 -10
- package/src/api/classes/dottedPath.ts +181 -181
- package/src/api/classes/element.ts +690 -692
- package/src/api/classes/event.ts +367 -367
- package/src/api/classes/eventBroadcaster.ts +52 -52
- package/src/api/classes/parameter.ts +474 -405
- package/src/api/classes/parameterObservable.ts +100 -100
- package/src/api/classes/parameterizable.ts +87 -87
- package/src/api/classes/placementAnimation.ts +160 -160
- package/src/api/classes/variant.ts +845 -845
- package/src/api/classes/variantInstance.ts +97 -97
- package/src/api/classes/variantParameterizable.ts +85 -85
- package/src/api/classes/viewer.ts +650 -624
- package/src/api/classes/viewerLight.ts +334 -334
- package/src/api/internal/debugViewer.ts +90 -90
- package/src/api/internal/lensRendering.ts +10 -10
- package/src/api/internal/sceneSetup.ts +204 -201
- package/src/api/manager/animationManager.ts +142 -142
- package/src/api/manager/gltfExportManager.ts +191 -191
- package/src/api/manager/sceneManager.ts +128 -102
- package/src/api/manager/variantInstanceManager.ts +265 -265
- package/src/api/store/specStorage.ts +51 -51
- package/src/api/util/babylonHelper.ts +628 -538
- package/src/api/util/globalTypes.ts +413 -402
- package/src/api/util/resourceHelper.ts +189 -173
- package/src/api/util/stringHelper.ts +23 -23
- package/src/api/util/structureHelper.ts +49 -43
- package/src/buildinfo.json +3 -3
- package/src/commonjs.tsconfig.json +10 -10
- package/src/declaration.tsconfig.json +8 -8
- package/src/dev.ts +42 -42
- package/src/es6.tsconfig.json +10 -10
- package/src/index.ts +94 -94
- package/src/pagesconfig.json +77 -73
- package/src/tsconfig.json +32 -32
- package/src/tsconfig.types.json +9 -9
- package/src/types.d.ts +3 -3
|
@@ -1,336 +1,336 @@
|
|
|
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.variantInstancePromises = new Map();
|
|
24
|
-
_this.variantInstances = new Map();
|
|
25
|
-
_this.variantInstanceDefinitions = new Map();
|
|
26
|
-
_this.parameters = {};
|
|
27
|
-
_this.queues = {};
|
|
28
|
-
return _this;
|
|
29
|
-
}
|
|
30
|
-
/**
|
|
31
|
-
* Creates a {@link VariantInstanceManager} based on given root Variant.
|
|
32
|
-
*/
|
|
33
|
-
VariantInstanceManager.create = function (rootVariant) {
|
|
34
|
-
return tslib_1.__awaiter(this, void 0, void 0, function () {
|
|
35
|
-
return tslib_1.__generator(this, function (_a) {
|
|
36
|
-
return [2 /*return*/, new VariantInstanceManager(rootVariant)];
|
|
37
|
-
});
|
|
38
|
-
});
|
|
39
|
-
};
|
|
40
|
-
Object.defineProperty(VariantInstanceManager.prototype, "all", {
|
|
41
|
-
/**
|
|
42
|
-
* Gets all instances.
|
|
43
|
-
*/
|
|
44
|
-
get: function () {
|
|
45
|
-
var all = [];
|
|
46
|
-
this.variantInstances.forEach(function (variantInstance) { return all.push(variantInstance); });
|
|
47
|
-
return all;
|
|
48
|
-
},
|
|
49
|
-
enumerable: false,
|
|
50
|
-
configurable: true
|
|
51
|
-
});
|
|
52
|
-
Object.defineProperty(VariantInstanceManager.prototype, "allDefinitions", {
|
|
53
|
-
/**
|
|
54
|
-
* Gets all instance definitions.
|
|
55
|
-
*/
|
|
56
|
-
get: function () {
|
|
57
|
-
var all = [];
|
|
58
|
-
this.variantInstanceDefinitions.forEach(function (definition) { return all.push(definition); });
|
|
59
|
-
return all;
|
|
60
|
-
},
|
|
61
|
-
enumerable: false,
|
|
62
|
-
configurable: true
|
|
63
|
-
});
|
|
64
|
-
/**
|
|
65
|
-
* Checks whether a {@link VariantInstance} is either registered or created.
|
|
66
|
-
*/
|
|
67
|
-
VariantInstanceManager.prototype.has = function (name) {
|
|
68
|
-
return this.variantInstances.has(name) || this.variantInstanceDefinitions.has(name);
|
|
69
|
-
};
|
|
70
|
-
/**
|
|
71
|
-
* Retrieves a {@link VariantInstance}.
|
|
72
|
-
* If the instance has been created, the created instance will be returned.
|
|
73
|
-
* If the instance is registered, the instance will be created and returned.
|
|
74
|
-
* if the instance has already been requested and is currently pending, the dedicated promise will be returned.
|
|
75
|
-
* If none of these apply, an Error is thrown.
|
|
76
|
-
*
|
|
77
|
-
* @emits {@link Event.VARIANT_INSTANCE_CREATED}
|
|
78
|
-
*/
|
|
79
|
-
VariantInstanceManager.prototype.get = function (name) {
|
|
80
|
-
return tslib_1.__awaiter(this, void 0, void 0, function () {
|
|
81
|
-
var definition, vip;
|
|
82
|
-
var _this = this;
|
|
83
|
-
return tslib_1.__generator(this, function (_a) {
|
|
84
|
-
// 1) see if we have an instance of that name already and return it if found
|
|
85
|
-
if (this.variantInstances.has(name)) {
|
|
86
|
-
return [2 /*return*/, this.variantInstances.get(name)]; // cannot be null, hence the exclamation mark
|
|
87
|
-
}
|
|
88
|
-
// 2) try to get promise from list of requested instances and return it if found
|
|
89
|
-
if (this.variantInstancePromises.has(name)) {
|
|
90
|
-
return [2 /*return*/, this.variantInstancePromises.get(name)];
|
|
91
|
-
}
|
|
92
|
-
// 3) see if there's a definition of that name, create an instance from it and store the related promise
|
|
93
|
-
if (this.variantInstanceDefinitions.has(name)) {
|
|
94
|
-
definition = this.variantInstanceDefinitions.get(name);
|
|
95
|
-
vip = this.createFromDefinition(definition);
|
|
96
|
-
this.variantInstancePromises.set(name, vip);
|
|
97
|
-
// remove promise after it has been finished
|
|
98
|
-
vip.then(function () { return _this.variantInstancePromises.delete(name); });
|
|
99
|
-
return [2 /*return*/, vip];
|
|
100
|
-
}
|
|
101
|
-
//* if we are here, no instance definition of that name exists. throw error.
|
|
102
|
-
throw Error("VariantInstance with name \"" + name + "\" neither created nor configured.");
|
|
103
|
-
});
|
|
104
|
-
});
|
|
105
|
-
};
|
|
106
|
-
/**
|
|
107
|
-
* Creates and registers a unique {@link VariantInstance}.
|
|
108
|
-
*
|
|
109
|
-
* @emits {@link Event.VARIANT_INSTANCE_CREATED}
|
|
110
|
-
*/
|
|
111
|
-
VariantInstanceManager.prototype.create = function (dottedPath, name, parameters) {
|
|
112
|
-
return tslib_1.__awaiter(this, void 0, void 0, function () {
|
|
113
|
-
var variant, definition;
|
|
114
|
-
return tslib_1.__generator(this, function (_a) {
|
|
115
|
-
switch (_a.label) {
|
|
116
|
-
case 0:
|
|
117
|
-
variant = dottedPath_1.DottedPath.create(dottedPath).path;
|
|
118
|
-
definition = {
|
|
119
|
-
name: this.ensureUniqueName(name ? name : variant),
|
|
120
|
-
variant: variant,
|
|
121
|
-
parameters: parameters,
|
|
122
|
-
};
|
|
123
|
-
return [4 /*yield*/, this.createFromDefinition(definition)];
|
|
124
|
-
case 1: return [2 /*return*/, _a.sent()];
|
|
125
|
-
}
|
|
126
|
-
});
|
|
127
|
-
});
|
|
128
|
-
};
|
|
129
|
-
/**
|
|
130
|
-
* Registers a unique {@link VariantInstanceDefinition}.
|
|
131
|
-
*
|
|
132
|
-
* @emits {@link Event.VARIANT_INSTANCE_REGISTERED}
|
|
133
|
-
*/
|
|
134
|
-
VariantInstanceManager.prototype.register = function (instanceDefinition) {
|
|
135
|
-
var name = instanceDefinition.name ? instanceDefinition.name : dottedPath_1.DottedPath.create(instanceDefinition.variant).path;
|
|
136
|
-
instanceDefinition.name = this.ensureUniqueName(name);
|
|
137
|
-
this.variantInstanceDefinitions.set(instanceDefinition.name, instanceDefinition);
|
|
138
|
-
this.broadcastEvent(event_1.Event.VARIANT_INSTANCE_REGISTERED, instanceDefinition);
|
|
139
|
-
return instanceDefinition;
|
|
140
|
-
};
|
|
141
|
-
/**
|
|
142
|
-
* Commits the {@link ParameterBag} to all registered and created {@link VariantInstance}s.
|
|
143
|
-
*/
|
|
144
|
-
VariantInstanceManager.prototype.commitParameters = function (parameters, onlyVisible) {
|
|
145
|
-
if (parameters === void 0) { parameters = {}; }
|
|
146
|
-
if (onlyVisible === void 0) { onlyVisible = true; }
|
|
147
|
-
return tslib_1.__awaiter(this, void 0, void 0, function () {
|
|
148
|
-
var instances, promises;
|
|
149
|
-
var _this = this;
|
|
150
|
-
return tslib_1.__generator(this, function (_a) {
|
|
151
|
-
switch (_a.label) {
|
|
152
|
-
case 0:
|
|
153
|
-
this.parameters = lodash_es_1.merge(this.parameters, parameters);
|
|
154
|
-
this.allDefinitions.forEach(function (definition) { return (definition.parameters = lodash_es_1.merge(definition.parameters, _this.parameters)); });
|
|
155
|
-
instances = this.all;
|
|
156
|
-
if (onlyVisible) {
|
|
157
|
-
instances = this.all.filter(function (instance) { return instance.variant.visible; });
|
|
158
|
-
}
|
|
159
|
-
promises = instances.map(function (instance) { return instance.variant.commitParameters(_this.parameters); });
|
|
160
|
-
return [4 /*yield*/, Promise.all(promises)];
|
|
161
|
-
case 1:
|
|
162
|
-
_a.sent();
|
|
163
|
-
return [2 /*return*/, this];
|
|
164
|
-
}
|
|
165
|
-
});
|
|
166
|
-
});
|
|
167
|
-
};
|
|
168
|
-
/**
|
|
169
|
-
* Show one {@link VariantInstance}. If `exclusive` is set to `true` it will hide all other
|
|
170
|
-
* instances handled by this {@link VariantInstanceManager}. If the function is called synchronously,
|
|
171
|
-
* the calls end up in a queue according to the FIFO principle (the last one wins).
|
|
172
|
-
*/
|
|
173
|
-
VariantInstanceManager.prototype.show = function (name, exclusive) {
|
|
174
|
-
if (exclusive === void 0) { exclusive = false; }
|
|
175
|
-
return tslib_1.__awaiter(this, void 0, void 0, function () {
|
|
176
|
-
var promise, i, instance;
|
|
177
|
-
var _this = this;
|
|
178
|
-
return tslib_1.__generator(this, function (_a) {
|
|
179
|
-
switch (_a.label) {
|
|
180
|
-
case 0:
|
|
181
|
-
promise = new Promise(function (resolve) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
|
|
182
|
-
var instance;
|
|
183
|
-
return tslib_1.__generator(this, function (_a) {
|
|
184
|
-
switch (_a.label) {
|
|
185
|
-
case 0:
|
|
186
|
-
if (!exclusive) return [3 /*break*/, 2];
|
|
187
|
-
this.allDefinitions
|
|
188
|
-
.filter(function (definition) { return definition.name !== name; })
|
|
189
|
-
.forEach(function (definition) {
|
|
190
|
-
var parameters = {};
|
|
191
|
-
parameters[parameter_1.Parameter.VISIBLE] = false;
|
|
192
|
-
definition.parameters = lodash_es_1.merge(definition.parameters, parameters);
|
|
193
|
-
});
|
|
194
|
-
return [4 /*yield*/, Promise.all(this.all
|
|
195
|
-
.filter(function (_instance) { return _instance.name !== name; })
|
|
196
|
-
.map(function (_instance) {
|
|
197
|
-
return _instance.variant.hide();
|
|
198
|
-
}))];
|
|
199
|
-
case 1:
|
|
200
|
-
_a.sent();
|
|
201
|
-
_a.label = 2;
|
|
202
|
-
case 2: return [4 /*yield*/, this.get(name)];
|
|
203
|
-
case 3:
|
|
204
|
-
instance = _a.sent();
|
|
205
|
-
return [4 /*yield*/, instance.variant.show()];
|
|
206
|
-
case 4:
|
|
207
|
-
_a.sent();
|
|
208
|
-
resolve(instance);
|
|
209
|
-
return [2 /*return*/];
|
|
210
|
-
}
|
|
211
|
-
});
|
|
212
|
-
}); });
|
|
213
|
-
if (!this.queues['show']) {
|
|
214
|
-
this.queues['show'] = [];
|
|
215
|
-
}
|
|
216
|
-
this.queues['show'].push(promise);
|
|
217
|
-
i = 0;
|
|
218
|
-
_a.label = 1;
|
|
219
|
-
case 1:
|
|
220
|
-
if (!(i < this.queues['show'].length)) return [3 /*break*/, 5];
|
|
221
|
-
return [4 /*yield*/, this.queues['show'][i]];
|
|
222
|
-
case 2:
|
|
223
|
-
instance = _a.sent();
|
|
224
|
-
if (!exclusive) return [3 /*break*/, 4];
|
|
225
|
-
if (!(i + 1 < this.queues['show'].length)) return [3 /*break*/, 4];
|
|
226
|
-
return [4 /*yield*/, instance.variant.hide()];
|
|
227
|
-
case 3:
|
|
228
|
-
_a.sent();
|
|
229
|
-
_a.label = 4;
|
|
230
|
-
case 4:
|
|
231
|
-
i++;
|
|
232
|
-
return [3 /*break*/, 1];
|
|
233
|
-
case 5:
|
|
234
|
-
this.queues['show'] = [];
|
|
235
|
-
return [2 /*return*/, promise];
|
|
236
|
-
}
|
|
237
|
-
});
|
|
238
|
-
});
|
|
239
|
-
};
|
|
240
|
-
/**
|
|
241
|
-
* Clones and registers a new {@link VariantInstance} with a new, unique name.
|
|
242
|
-
*
|
|
243
|
-
* @emits {@link Event.VARIANT_INSTANCE_CLONED}
|
|
244
|
-
*/
|
|
245
|
-
VariantInstanceManager.prototype.clone = function (name, newName, parameters) {
|
|
246
|
-
return tslib_1.__awaiter(this, void 0, void 0, function () {
|
|
247
|
-
var variantInstance, definition, living, variantInstanceClone;
|
|
248
|
-
return tslib_1.__generator(this, function (_a) {
|
|
249
|
-
switch (_a.label) {
|
|
250
|
-
case 0:
|
|
251
|
-
if (!this.variantInstances.has(name)) {
|
|
252
|
-
throw Error("VariantInstance with name \"" + name + "\" does not exist.");
|
|
253
|
-
}
|
|
254
|
-
variantInstance = this.variantInstances.get(name);
|
|
255
|
-
definition = {
|
|
256
|
-
name: this.ensureUniqueName(newName ? newName : name),
|
|
257
|
-
variant: variantInstance.variant.id,
|
|
258
|
-
parameters: parameters,
|
|
259
|
-
};
|
|
260
|
-
return [4 /*yield*/, variantInstance.variant.createLiving(definition.parameters)];
|
|
261
|
-
case 1:
|
|
262
|
-
living = _a.sent();
|
|
263
|
-
variantInstanceClone = new variantInstance_1.VariantInstance(living, definition.name);
|
|
264
|
-
this.variantInstances.set(definition.name, variantInstanceClone);
|
|
265
|
-
variantInstance.broadcastEvent(event_1.Event.VARIANT_INSTANCE_CLONED, variantInstanceClone);
|
|
266
|
-
return [2 /*return*/, variantInstanceClone];
|
|
267
|
-
}
|
|
268
|
-
});
|
|
269
|
-
});
|
|
270
|
-
};
|
|
271
|
-
/**
|
|
272
|
-
* Destroys the instance by removing the {@link Variant} and de-registering the instance.
|
|
273
|
-
*
|
|
274
|
-
* @emits {@link Event.VARIANT_INSTANCE_DESTROYED}
|
|
275
|
-
*/
|
|
276
|
-
VariantInstanceManager.prototype.destroy = function (name) {
|
|
277
|
-
if (!this.variantInstances.has(name)) {
|
|
278
|
-
throw Error("VariantInstance with name \"" + name + "\" does not exist.");
|
|
279
|
-
}
|
|
280
|
-
var variantInstance = this.variantInstances.get(name);
|
|
281
|
-
variantInstance.variant.destroy();
|
|
282
|
-
this.variantInstances.delete(name);
|
|
283
|
-
variantInstance.broadcastEvent(event_1.Event.VARIANT_INSTANCE_DESTROYED, variantInstance);
|
|
284
|
-
return this;
|
|
285
|
-
};
|
|
286
|
-
/**
|
|
287
|
-
* Creates and registers a unique {@link VariantInstance} from `definition`.
|
|
288
|
-
*
|
|
289
|
-
* @emits {@link Event.VARIANT_INSTANCE_CREATED}
|
|
290
|
-
*/
|
|
291
|
-
VariantInstanceManager.prototype.createFromDefinition = function (definition) {
|
|
292
|
-
return tslib_1.__awaiter(this, void 0, void 0, function () {
|
|
293
|
-
var variant, living, variantInstance;
|
|
294
|
-
return tslib_1.__generator(this, function (_a) {
|
|
295
|
-
switch (_a.label) {
|
|
296
|
-
case 0:
|
|
297
|
-
if (!definition.name) {
|
|
298
|
-
throw new Error("Given VariantInstanceDefinition " + definition.variant + " is missing a name property.");
|
|
299
|
-
}
|
|
300
|
-
if (this.variantInstances.has(definition.name)) {
|
|
301
|
-
throw new Error("VariantInstance with name \"" + definition.name + "\" is already created.");
|
|
302
|
-
}
|
|
303
|
-
if (!this.rootVariant) {
|
|
304
|
-
throw new Error("Viewer has not been properly bootstrapped (rootVariant missing).");
|
|
305
|
-
}
|
|
306
|
-
return [4 /*yield*/, this.rootVariant.getDescendant(definition.variant)];
|
|
307
|
-
case 1:
|
|
308
|
-
variant = _a.sent();
|
|
309
|
-
return [4 /*yield*/, variant.createLiving(definition.parameters)];
|
|
310
|
-
case 2:
|
|
311
|
-
living = _a.sent();
|
|
312
|
-
variantInstance = new variantInstance_1.VariantInstance(living, definition.name);
|
|
313
|
-
this.variantInstances.set(definition.name, variantInstance);
|
|
314
|
-
this.broadcastEvent(event_1.Event.VARIANT_INSTANCE_CREATED, variantInstance);
|
|
315
|
-
return [2 /*return*/, variantInstance];
|
|
316
|
-
}
|
|
317
|
-
});
|
|
318
|
-
});
|
|
319
|
-
};
|
|
320
|
-
/**
|
|
321
|
-
* Creates a unique instance name based on already registered instance names on the {@link VariantInstanceManager}.
|
|
322
|
-
* Appends an `_i` to the name where `i = 0` and increments as long as the name is not registered.
|
|
323
|
-
*/
|
|
324
|
-
VariantInstanceManager.prototype.ensureUniqueName = function (name) {
|
|
325
|
-
var instanceName = name;
|
|
326
|
-
var i = 1;
|
|
327
|
-
while (this.has(instanceName)) {
|
|
328
|
-
instanceName = name + "_" + i;
|
|
329
|
-
i++;
|
|
330
|
-
}
|
|
331
|
-
return instanceName;
|
|
332
|
-
};
|
|
333
|
-
return VariantInstanceManager;
|
|
334
|
-
}(eventBroadcaster_1.EventBroadcaster));
|
|
335
|
-
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.variantInstancePromises = new Map();
|
|
24
|
+
_this.variantInstances = new Map();
|
|
25
|
+
_this.variantInstanceDefinitions = new Map();
|
|
26
|
+
_this.parameters = {};
|
|
27
|
+
_this.queues = {};
|
|
28
|
+
return _this;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Creates a {@link VariantInstanceManager} based on given root Variant.
|
|
32
|
+
*/
|
|
33
|
+
VariantInstanceManager.create = function (rootVariant) {
|
|
34
|
+
return tslib_1.__awaiter(this, void 0, void 0, function () {
|
|
35
|
+
return tslib_1.__generator(this, function (_a) {
|
|
36
|
+
return [2 /*return*/, new VariantInstanceManager(rootVariant)];
|
|
37
|
+
});
|
|
38
|
+
});
|
|
39
|
+
};
|
|
40
|
+
Object.defineProperty(VariantInstanceManager.prototype, "all", {
|
|
41
|
+
/**
|
|
42
|
+
* Gets all instances.
|
|
43
|
+
*/
|
|
44
|
+
get: function () {
|
|
45
|
+
var all = [];
|
|
46
|
+
this.variantInstances.forEach(function (variantInstance) { return all.push(variantInstance); });
|
|
47
|
+
return all;
|
|
48
|
+
},
|
|
49
|
+
enumerable: false,
|
|
50
|
+
configurable: true
|
|
51
|
+
});
|
|
52
|
+
Object.defineProperty(VariantInstanceManager.prototype, "allDefinitions", {
|
|
53
|
+
/**
|
|
54
|
+
* Gets all instance definitions.
|
|
55
|
+
*/
|
|
56
|
+
get: function () {
|
|
57
|
+
var all = [];
|
|
58
|
+
this.variantInstanceDefinitions.forEach(function (definition) { return all.push(definition); });
|
|
59
|
+
return all;
|
|
60
|
+
},
|
|
61
|
+
enumerable: false,
|
|
62
|
+
configurable: true
|
|
63
|
+
});
|
|
64
|
+
/**
|
|
65
|
+
* Checks whether a {@link VariantInstance} is either registered or created.
|
|
66
|
+
*/
|
|
67
|
+
VariantInstanceManager.prototype.has = function (name) {
|
|
68
|
+
return this.variantInstances.has(name) || this.variantInstanceDefinitions.has(name);
|
|
69
|
+
};
|
|
70
|
+
/**
|
|
71
|
+
* Retrieves a {@link VariantInstance}.
|
|
72
|
+
* If the instance has been created, the created instance will be returned.
|
|
73
|
+
* If the instance is registered, the instance will be created and returned.
|
|
74
|
+
* if the instance has already been requested and is currently pending, the dedicated promise will be returned.
|
|
75
|
+
* If none of these apply, an Error is thrown.
|
|
76
|
+
*
|
|
77
|
+
* @emits {@link Event.VARIANT_INSTANCE_CREATED}
|
|
78
|
+
*/
|
|
79
|
+
VariantInstanceManager.prototype.get = function (name) {
|
|
80
|
+
return tslib_1.__awaiter(this, void 0, void 0, function () {
|
|
81
|
+
var definition, vip;
|
|
82
|
+
var _this = this;
|
|
83
|
+
return tslib_1.__generator(this, function (_a) {
|
|
84
|
+
// 1) see if we have an instance of that name already and return it if found
|
|
85
|
+
if (this.variantInstances.has(name)) {
|
|
86
|
+
return [2 /*return*/, this.variantInstances.get(name)]; // cannot be null, hence the exclamation mark
|
|
87
|
+
}
|
|
88
|
+
// 2) try to get promise from list of requested instances and return it if found
|
|
89
|
+
if (this.variantInstancePromises.has(name)) {
|
|
90
|
+
return [2 /*return*/, this.variantInstancePromises.get(name)];
|
|
91
|
+
}
|
|
92
|
+
// 3) see if there's a definition of that name, create an instance from it and store the related promise
|
|
93
|
+
if (this.variantInstanceDefinitions.has(name)) {
|
|
94
|
+
definition = this.variantInstanceDefinitions.get(name);
|
|
95
|
+
vip = this.createFromDefinition(definition);
|
|
96
|
+
this.variantInstancePromises.set(name, vip);
|
|
97
|
+
// remove promise after it has been finished
|
|
98
|
+
vip.then(function () { return _this.variantInstancePromises.delete(name); });
|
|
99
|
+
return [2 /*return*/, vip];
|
|
100
|
+
}
|
|
101
|
+
//* if we are here, no instance definition of that name exists. throw error.
|
|
102
|
+
throw Error("VariantInstance with name \"" + name + "\" neither created nor configured.");
|
|
103
|
+
});
|
|
104
|
+
});
|
|
105
|
+
};
|
|
106
|
+
/**
|
|
107
|
+
* Creates and registers a unique {@link VariantInstance}.
|
|
108
|
+
*
|
|
109
|
+
* @emits {@link Event.VARIANT_INSTANCE_CREATED}
|
|
110
|
+
*/
|
|
111
|
+
VariantInstanceManager.prototype.create = function (dottedPath, name, parameters) {
|
|
112
|
+
return tslib_1.__awaiter(this, void 0, void 0, function () {
|
|
113
|
+
var variant, definition;
|
|
114
|
+
return tslib_1.__generator(this, function (_a) {
|
|
115
|
+
switch (_a.label) {
|
|
116
|
+
case 0:
|
|
117
|
+
variant = dottedPath_1.DottedPath.create(dottedPath).path;
|
|
118
|
+
definition = {
|
|
119
|
+
name: this.ensureUniqueName(name ? name : variant),
|
|
120
|
+
variant: variant,
|
|
121
|
+
parameters: parameters,
|
|
122
|
+
};
|
|
123
|
+
return [4 /*yield*/, this.createFromDefinition(definition)];
|
|
124
|
+
case 1: return [2 /*return*/, _a.sent()];
|
|
125
|
+
}
|
|
126
|
+
});
|
|
127
|
+
});
|
|
128
|
+
};
|
|
129
|
+
/**
|
|
130
|
+
* Registers a unique {@link VariantInstanceDefinition}.
|
|
131
|
+
*
|
|
132
|
+
* @emits {@link Event.VARIANT_INSTANCE_REGISTERED}
|
|
133
|
+
*/
|
|
134
|
+
VariantInstanceManager.prototype.register = function (instanceDefinition) {
|
|
135
|
+
var name = instanceDefinition.name ? instanceDefinition.name : dottedPath_1.DottedPath.create(instanceDefinition.variant).path;
|
|
136
|
+
instanceDefinition.name = this.ensureUniqueName(name);
|
|
137
|
+
this.variantInstanceDefinitions.set(instanceDefinition.name, instanceDefinition);
|
|
138
|
+
this.broadcastEvent(event_1.Event.VARIANT_INSTANCE_REGISTERED, instanceDefinition);
|
|
139
|
+
return instanceDefinition;
|
|
140
|
+
};
|
|
141
|
+
/**
|
|
142
|
+
* Commits the {@link ParameterBag} to all registered and created {@link VariantInstance}s.
|
|
143
|
+
*/
|
|
144
|
+
VariantInstanceManager.prototype.commitParameters = function (parameters, onlyVisible) {
|
|
145
|
+
if (parameters === void 0) { parameters = {}; }
|
|
146
|
+
if (onlyVisible === void 0) { onlyVisible = true; }
|
|
147
|
+
return tslib_1.__awaiter(this, void 0, void 0, function () {
|
|
148
|
+
var instances, promises;
|
|
149
|
+
var _this = this;
|
|
150
|
+
return tslib_1.__generator(this, function (_a) {
|
|
151
|
+
switch (_a.label) {
|
|
152
|
+
case 0:
|
|
153
|
+
this.parameters = lodash_es_1.merge(this.parameters, parameters);
|
|
154
|
+
this.allDefinitions.forEach(function (definition) { return (definition.parameters = lodash_es_1.merge(definition.parameters, _this.parameters)); });
|
|
155
|
+
instances = this.all;
|
|
156
|
+
if (onlyVisible) {
|
|
157
|
+
instances = this.all.filter(function (instance) { return instance.variant.visible; });
|
|
158
|
+
}
|
|
159
|
+
promises = instances.map(function (instance) { return instance.variant.commitParameters(_this.parameters); });
|
|
160
|
+
return [4 /*yield*/, Promise.all(promises)];
|
|
161
|
+
case 1:
|
|
162
|
+
_a.sent();
|
|
163
|
+
return [2 /*return*/, this];
|
|
164
|
+
}
|
|
165
|
+
});
|
|
166
|
+
});
|
|
167
|
+
};
|
|
168
|
+
/**
|
|
169
|
+
* Show one {@link VariantInstance}. If `exclusive` is set to `true` it will hide all other
|
|
170
|
+
* instances handled by this {@link VariantInstanceManager}. If the function is called synchronously,
|
|
171
|
+
* the calls end up in a queue according to the FIFO principle (the last one wins).
|
|
172
|
+
*/
|
|
173
|
+
VariantInstanceManager.prototype.show = function (name, exclusive) {
|
|
174
|
+
if (exclusive === void 0) { exclusive = false; }
|
|
175
|
+
return tslib_1.__awaiter(this, void 0, void 0, function () {
|
|
176
|
+
var promise, i, instance;
|
|
177
|
+
var _this = this;
|
|
178
|
+
return tslib_1.__generator(this, function (_a) {
|
|
179
|
+
switch (_a.label) {
|
|
180
|
+
case 0:
|
|
181
|
+
promise = new Promise(function (resolve) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
|
|
182
|
+
var instance;
|
|
183
|
+
return tslib_1.__generator(this, function (_a) {
|
|
184
|
+
switch (_a.label) {
|
|
185
|
+
case 0:
|
|
186
|
+
if (!exclusive) return [3 /*break*/, 2];
|
|
187
|
+
this.allDefinitions
|
|
188
|
+
.filter(function (definition) { return definition.name !== name; })
|
|
189
|
+
.forEach(function (definition) {
|
|
190
|
+
var parameters = {};
|
|
191
|
+
parameters[parameter_1.Parameter.VISIBLE] = false;
|
|
192
|
+
definition.parameters = lodash_es_1.merge(definition.parameters, parameters);
|
|
193
|
+
});
|
|
194
|
+
return [4 /*yield*/, Promise.all(this.all
|
|
195
|
+
.filter(function (_instance) { return _instance.name !== name; })
|
|
196
|
+
.map(function (_instance) {
|
|
197
|
+
return _instance.variant.hide();
|
|
198
|
+
}))];
|
|
199
|
+
case 1:
|
|
200
|
+
_a.sent();
|
|
201
|
+
_a.label = 2;
|
|
202
|
+
case 2: return [4 /*yield*/, this.get(name)];
|
|
203
|
+
case 3:
|
|
204
|
+
instance = _a.sent();
|
|
205
|
+
return [4 /*yield*/, instance.variant.show()];
|
|
206
|
+
case 4:
|
|
207
|
+
_a.sent();
|
|
208
|
+
resolve(instance);
|
|
209
|
+
return [2 /*return*/];
|
|
210
|
+
}
|
|
211
|
+
});
|
|
212
|
+
}); });
|
|
213
|
+
if (!this.queues['show']) {
|
|
214
|
+
this.queues['show'] = [];
|
|
215
|
+
}
|
|
216
|
+
this.queues['show'].push(promise);
|
|
217
|
+
i = 0;
|
|
218
|
+
_a.label = 1;
|
|
219
|
+
case 1:
|
|
220
|
+
if (!(i < this.queues['show'].length)) return [3 /*break*/, 5];
|
|
221
|
+
return [4 /*yield*/, this.queues['show'][i]];
|
|
222
|
+
case 2:
|
|
223
|
+
instance = _a.sent();
|
|
224
|
+
if (!exclusive) return [3 /*break*/, 4];
|
|
225
|
+
if (!(i + 1 < this.queues['show'].length)) return [3 /*break*/, 4];
|
|
226
|
+
return [4 /*yield*/, instance.variant.hide()];
|
|
227
|
+
case 3:
|
|
228
|
+
_a.sent();
|
|
229
|
+
_a.label = 4;
|
|
230
|
+
case 4:
|
|
231
|
+
i++;
|
|
232
|
+
return [3 /*break*/, 1];
|
|
233
|
+
case 5:
|
|
234
|
+
this.queues['show'] = [];
|
|
235
|
+
return [2 /*return*/, promise];
|
|
236
|
+
}
|
|
237
|
+
});
|
|
238
|
+
});
|
|
239
|
+
};
|
|
240
|
+
/**
|
|
241
|
+
* Clones and registers a new {@link VariantInstance} with a new, unique name.
|
|
242
|
+
*
|
|
243
|
+
* @emits {@link Event.VARIANT_INSTANCE_CLONED}
|
|
244
|
+
*/
|
|
245
|
+
VariantInstanceManager.prototype.clone = function (name, newName, parameters) {
|
|
246
|
+
return tslib_1.__awaiter(this, void 0, void 0, function () {
|
|
247
|
+
var variantInstance, definition, living, variantInstanceClone;
|
|
248
|
+
return tslib_1.__generator(this, function (_a) {
|
|
249
|
+
switch (_a.label) {
|
|
250
|
+
case 0:
|
|
251
|
+
if (!this.variantInstances.has(name)) {
|
|
252
|
+
throw Error("VariantInstance with name \"" + name + "\" does not exist.");
|
|
253
|
+
}
|
|
254
|
+
variantInstance = this.variantInstances.get(name);
|
|
255
|
+
definition = {
|
|
256
|
+
name: this.ensureUniqueName(newName ? newName : name),
|
|
257
|
+
variant: variantInstance.variant.id,
|
|
258
|
+
parameters: parameters,
|
|
259
|
+
};
|
|
260
|
+
return [4 /*yield*/, variantInstance.variant.createLiving(definition.parameters)];
|
|
261
|
+
case 1:
|
|
262
|
+
living = _a.sent();
|
|
263
|
+
variantInstanceClone = new variantInstance_1.VariantInstance(living, definition.name);
|
|
264
|
+
this.variantInstances.set(definition.name, variantInstanceClone);
|
|
265
|
+
variantInstance.broadcastEvent(event_1.Event.VARIANT_INSTANCE_CLONED, variantInstanceClone);
|
|
266
|
+
return [2 /*return*/, variantInstanceClone];
|
|
267
|
+
}
|
|
268
|
+
});
|
|
269
|
+
});
|
|
270
|
+
};
|
|
271
|
+
/**
|
|
272
|
+
* Destroys the instance by removing the {@link Variant} and de-registering the instance.
|
|
273
|
+
*
|
|
274
|
+
* @emits {@link Event.VARIANT_INSTANCE_DESTROYED}
|
|
275
|
+
*/
|
|
276
|
+
VariantInstanceManager.prototype.destroy = function (name) {
|
|
277
|
+
if (!this.variantInstances.has(name)) {
|
|
278
|
+
throw Error("VariantInstance with name \"" + name + "\" does not exist.");
|
|
279
|
+
}
|
|
280
|
+
var variantInstance = this.variantInstances.get(name);
|
|
281
|
+
variantInstance.variant.destroy();
|
|
282
|
+
this.variantInstances.delete(name);
|
|
283
|
+
variantInstance.broadcastEvent(event_1.Event.VARIANT_INSTANCE_DESTROYED, variantInstance);
|
|
284
|
+
return this;
|
|
285
|
+
};
|
|
286
|
+
/**
|
|
287
|
+
* Creates and registers a unique {@link VariantInstance} from `definition`.
|
|
288
|
+
*
|
|
289
|
+
* @emits {@link Event.VARIANT_INSTANCE_CREATED}
|
|
290
|
+
*/
|
|
291
|
+
VariantInstanceManager.prototype.createFromDefinition = function (definition) {
|
|
292
|
+
return tslib_1.__awaiter(this, void 0, void 0, function () {
|
|
293
|
+
var variant, living, variantInstance;
|
|
294
|
+
return tslib_1.__generator(this, function (_a) {
|
|
295
|
+
switch (_a.label) {
|
|
296
|
+
case 0:
|
|
297
|
+
if (!definition.name) {
|
|
298
|
+
throw new Error("Given VariantInstanceDefinition " + definition.variant + " is missing a name property.");
|
|
299
|
+
}
|
|
300
|
+
if (this.variantInstances.has(definition.name)) {
|
|
301
|
+
throw new Error("VariantInstance with name \"" + definition.name + "\" is already created.");
|
|
302
|
+
}
|
|
303
|
+
if (!this.rootVariant) {
|
|
304
|
+
throw new Error("Viewer has not been properly bootstrapped (rootVariant missing).");
|
|
305
|
+
}
|
|
306
|
+
return [4 /*yield*/, this.rootVariant.getDescendant(definition.variant)];
|
|
307
|
+
case 1:
|
|
308
|
+
variant = _a.sent();
|
|
309
|
+
return [4 /*yield*/, variant.createLiving(definition.parameters)];
|
|
310
|
+
case 2:
|
|
311
|
+
living = _a.sent();
|
|
312
|
+
variantInstance = new variantInstance_1.VariantInstance(living, definition.name);
|
|
313
|
+
this.variantInstances.set(definition.name, variantInstance);
|
|
314
|
+
this.broadcastEvent(event_1.Event.VARIANT_INSTANCE_CREATED, variantInstance);
|
|
315
|
+
return [2 /*return*/, variantInstance];
|
|
316
|
+
}
|
|
317
|
+
});
|
|
318
|
+
});
|
|
319
|
+
};
|
|
320
|
+
/**
|
|
321
|
+
* Creates a unique instance name based on already registered instance names on the {@link VariantInstanceManager}.
|
|
322
|
+
* Appends an `_i` to the name where `i = 0` and increments as long as the name is not registered.
|
|
323
|
+
*/
|
|
324
|
+
VariantInstanceManager.prototype.ensureUniqueName = function (name) {
|
|
325
|
+
var instanceName = name;
|
|
326
|
+
var i = 1;
|
|
327
|
+
while (this.has(instanceName)) {
|
|
328
|
+
instanceName = name + "_" + i;
|
|
329
|
+
i++;
|
|
330
|
+
}
|
|
331
|
+
return instanceName;
|
|
332
|
+
};
|
|
333
|
+
return VariantInstanceManager;
|
|
334
|
+
}(eventBroadcaster_1.EventBroadcaster));
|
|
335
|
+
exports.VariantInstanceManager = VariantInstanceManager;
|
|
336
336
|
//# sourceMappingURL=variantInstanceManager.js.map
|