@combeenation/3d-viewer 12.4.3 → 12.4.4

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 (113) hide show
  1. package/README.md +9 -9
  2. package/dist/lib-cjs/api/classes/animationInterface.d.ts +8 -8
  3. package/dist/lib-cjs/api/classes/animationInterface.js +2 -2
  4. package/dist/lib-cjs/api/classes/dottedPath.d.ts +79 -79
  5. package/dist/lib-cjs/api/classes/dottedPath.js +166 -166
  6. package/dist/lib-cjs/api/classes/element.d.ts +153 -153
  7. package/dist/lib-cjs/api/classes/element.js +702 -702
  8. package/dist/lib-cjs/api/classes/event.d.ts +401 -401
  9. package/dist/lib-cjs/api/classes/event.js +424 -424
  10. package/dist/lib-cjs/api/classes/eventBroadcaster.d.ts +26 -26
  11. package/dist/lib-cjs/api/classes/eventBroadcaster.js +49 -49
  12. package/dist/lib-cjs/api/classes/fuzzyMap.d.ts +7 -7
  13. package/dist/lib-cjs/api/classes/fuzzyMap.js +21 -21
  14. package/dist/lib-cjs/api/classes/parameter.d.ts +410 -410
  15. package/dist/lib-cjs/api/classes/parameter.js +642 -642
  16. package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
  17. package/dist/lib-cjs/api/classes/parameterObservable.js +72 -72
  18. package/dist/lib-cjs/api/classes/parameterizable.d.ts +15 -15
  19. package/dist/lib-cjs/api/classes/parameterizable.js +102 -102
  20. package/dist/lib-cjs/api/classes/placementAnimation.d.ts +45 -45
  21. package/dist/lib-cjs/api/classes/placementAnimation.js +176 -176
  22. package/dist/lib-cjs/api/classes/variant.d.ts +261 -261
  23. package/dist/lib-cjs/api/classes/variant.js +872 -872
  24. package/dist/lib-cjs/api/classes/variantInstance.d.ts +53 -53
  25. package/dist/lib-cjs/api/classes/variantInstance.js +125 -125
  26. package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +17 -17
  27. package/dist/lib-cjs/api/classes/variantParameterizable.js +86 -86
  28. package/dist/lib-cjs/api/classes/viewer.d.ts +215 -215
  29. package/dist/lib-cjs/api/classes/viewer.js +708 -708
  30. package/dist/lib-cjs/api/classes/viewerError.d.ts +43 -43
  31. package/dist/lib-cjs/api/classes/viewerError.js +55 -55
  32. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
  33. package/dist/lib-cjs/api/classes/viewerLight.js +344 -344
  34. package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
  35. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  36. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
  37. package/dist/lib-cjs/api/internal/sceneSetup.js +227 -227
  38. package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
  39. package/dist/lib-cjs/api/manager/animationManager.js +126 -126
  40. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +80 -80
  41. package/dist/lib-cjs/api/manager/gltfExportManager.js +300 -300
  42. package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
  43. package/dist/lib-cjs/api/manager/sceneManager.js +128 -128
  44. package/dist/lib-cjs/api/manager/tagManager.d.ts +118 -118
  45. package/dist/lib-cjs/api/manager/tagManager.js +530 -530
  46. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
  47. package/dist/lib-cjs/api/manager/textureLoadManager.js +107 -107
  48. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +106 -106
  49. package/dist/lib-cjs/api/manager/variantInstanceManager.js +290 -290
  50. package/dist/lib-cjs/api/store/specStorage.d.ts +32 -32
  51. package/dist/lib-cjs/api/store/specStorage.js +65 -65
  52. package/dist/lib-cjs/api/util/babylonHelper.d.ts +238 -238
  53. package/dist/lib-cjs/api/util/babylonHelper.js +825 -825
  54. package/dist/lib-cjs/api/util/debugHelper.d.ts +9 -9
  55. package/dist/lib-cjs/api/util/debugHelper.js +93 -93
  56. package/dist/lib-cjs/api/util/deviceHelper.d.ts +9 -9
  57. package/dist/lib-cjs/api/util/deviceHelper.js +28 -28
  58. package/dist/lib-cjs/api/util/geometryHelper.d.ts +17 -17
  59. package/dist/lib-cjs/api/util/geometryHelper.js +112 -112
  60. package/dist/lib-cjs/api/util/globalTypes.d.ts +490 -490
  61. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  62. package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
  63. package/dist/lib-cjs/api/util/resourceHelper.js +214 -214
  64. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +58 -58
  65. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +228 -228
  66. package/dist/lib-cjs/api/util/stringHelper.d.ts +13 -13
  67. package/dist/lib-cjs/api/util/stringHelper.js +32 -32
  68. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
  69. package/dist/lib-cjs/api/util/structureHelper.js +57 -57
  70. package/dist/lib-cjs/buildinfo.json +3 -3
  71. package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
  72. package/dist/lib-cjs/index.d.ts +63 -63
  73. package/dist/lib-cjs/index.js +128 -128
  74. package/package.json +93 -93
  75. package/src/api/classes/animationInterface.ts +10 -10
  76. package/src/api/classes/dottedPath.ts +181 -181
  77. package/src/api/classes/element.ts +766 -766
  78. package/src/api/classes/event.ts +457 -457
  79. package/src/api/classes/eventBroadcaster.ts +52 -52
  80. package/src/api/classes/fuzzyMap.ts +21 -21
  81. package/src/api/classes/parameter.ts +686 -686
  82. package/src/api/classes/parameterObservable.ts +73 -73
  83. package/src/api/classes/parameterizable.ts +87 -87
  84. package/src/api/classes/placementAnimation.ts +162 -162
  85. package/src/api/classes/variant.ts +965 -965
  86. package/src/api/classes/variantInstance.ts +123 -123
  87. package/src/api/classes/variantParameterizable.ts +83 -83
  88. package/src/api/classes/viewer.ts +751 -751
  89. package/src/api/classes/viewerError.ts +63 -63
  90. package/src/api/classes/viewerLight.ts +335 -335
  91. package/src/api/internal/debugViewer.ts +90 -90
  92. package/src/api/internal/lensRendering.ts +9 -9
  93. package/src/api/internal/sceneSetup.ts +208 -208
  94. package/src/api/manager/animationManager.ts +143 -143
  95. package/src/api/manager/gltfExportManager.ts +337 -337
  96. package/src/api/manager/sceneManager.ts +134 -134
  97. package/src/api/manager/tagManager.ts +572 -572
  98. package/src/api/manager/textureLoadManager.ts +107 -107
  99. package/src/api/manager/variantInstanceManager.ts +306 -306
  100. package/src/api/store/specStorage.ts +68 -68
  101. package/src/api/util/babylonHelper.ts +915 -915
  102. package/src/api/util/debugHelper.ts +121 -121
  103. package/src/api/util/deviceHelper.ts +31 -31
  104. package/src/api/util/geometryHelper.ts +142 -142
  105. package/src/api/util/globalTypes.ts +566 -566
  106. package/src/api/util/resourceHelper.ts +201 -201
  107. package/src/api/util/sceneLoaderHelper.ts +247 -247
  108. package/src/api/util/stringHelper.ts +30 -30
  109. package/src/api/util/structureHelper.ts +62 -62
  110. package/src/buildinfo.json +3 -3
  111. package/src/dev.ts +70 -70
  112. package/src/index.ts +116 -116
  113. package/src/types.d.ts +49 -49
@@ -1,335 +1,335 @@
1
- import {
2
- cloneNodeWithParents,
3
- disableNodeWithParents,
4
- enableNodeWithParents,
5
- getRootNode,
6
- injectMetadata,
7
- transformTransformNode,
8
- } from './../util/babylonHelper';
9
- import { DottedPath } from './dottedPath';
10
- import { Parameter } from './parameter';
11
- import { Variant } from './variant';
12
- import { VariantParameterizable } from './variantParameterizable';
13
- import { ShadowGenerator } from '@babylonjs/core/Lights/Shadows/shadowGenerator';
14
- import '@babylonjs/core/Lights/Shadows/shadowGeneratorSceneComponent';
15
- import { HemisphericLight } from '@babylonjs/core/Lights/hemisphericLight';
16
- import { Light } from '@babylonjs/core/Lights/light';
17
- import { PointLight } from '@babylonjs/core/Lights/pointLight';
18
- import { ShadowLight } from '@babylonjs/core/Lights/shadowLight';
19
- import { Vector3 } from '@babylonjs/core/Maths/math.vector';
20
- import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
21
- import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_lights_punctual';
22
- import { get, isEmpty, isString, set } from 'lodash-es';
23
-
24
- /**
25
- * A {@link ViewerLight} of a {@link Variant}. Acts as a container for Babylon.js lights. Lives only in the context of a
26
- * {@link Variant}.
27
- */
28
- export class ViewerLight extends VariantParameterizable {
29
- protected _light: Light | undefined;
30
-
31
- /**
32
- * Constructor.
33
- */
34
- protected constructor(public readonly variant: Variant, public readonly name: string) {
35
- super(variant, name);
36
- this.addParameterObservers();
37
- }
38
-
39
- /**
40
- * Creates a {@link ViewerLight} with given name.
41
- */
42
- public static async create(variant: Variant, name: string): Promise<ViewerLight> {
43
- const viewerLight = new ViewerLight(variant, name);
44
- viewerLight._light = await viewerLight.createBabylonLightFromDefinition(viewerLight.definition);
45
- return viewerLight;
46
- }
47
-
48
- /**
49
- * The wrapped Light.
50
- */
51
- get light(): Light {
52
- if (!this._light) {
53
- throw new Error(`Light for ViewerLight "${this.name}" has not been properly initialized.`);
54
- }
55
- return this._light!;
56
- }
57
-
58
- /**
59
- * The {@link DottedPath} in the built tree of {@link ViewerLight}s.
60
- * E.g. "_.top-1.sub-2.sub-sub-3.el-1"
61
- */
62
- get dottedPath(): DottedPath {
63
- return DottedPath.create(this.variant.dottedPath).addPart(this.name);
64
- }
65
-
66
- /**
67
- * The id representing a {@link DottedPath}.
68
- */
69
- get id(): string {
70
- const dottedPath = DottedPath.create(this.dottedPath);
71
- dottedPath.shiftPart(); // remove root
72
- return dottedPath.path;
73
- }
74
-
75
- /**
76
- * The {@link LightDefinition} of the {@link ViewerLight}.
77
- */
78
- get definition(): LightDefinition {
79
- const definition = this.variant.structureJson.lights![this.name];
80
- if (isString(definition)) {
81
- return {
82
- type: 'baked',
83
- path: definition,
84
- } as LightDefinition;
85
- }
86
- return definition as LightDefinition;
87
- }
88
-
89
- /**
90
- * The type of the {@link ViewerLight}'s light.
91
- */
92
- get type(): string {
93
- return this.light.constructor.name.replace(/light/i, '').toLowerCase();
94
- }
95
-
96
- /**
97
- * @see {@link VariantParameterizable.commitParameters}
98
- * @emit {@link Event.VIEWER_LIGHT_PARAMETER_COMMITTED}
99
- */
100
- public async commitParameters(parameters?: ParameterBag): Promise<VariantParameterizable> {
101
- return super.commitParameters(parameters);
102
- }
103
-
104
- /**
105
- * Adds the default {@link ParameterObserver}s which are called every time {@link commitParameters} is called.
106
- */
107
- protected addParameterObservers(): ViewerLight {
108
- this._parameterObservers.set(Parameter.VISIBLE, [
109
- async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
110
- let visible;
111
- try {
112
- visible = Parameter.parseBoolean(newValue);
113
- } catch (e) {
114
- return;
115
- }
116
- if (visible === true) {
117
- enableNodeWithParents(light.light);
118
- } else if (visible === false) {
119
- disableNodeWithParents(light.light);
120
- }
121
- },
122
- ]);
123
- this._parameterObservers.set(Parameter.INTENSITY, [
124
- async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
125
- set(light.light, 'intensity', Parameter.parseNumber(newValue));
126
- },
127
- ]);
128
- this._parameterObservers.set(Parameter.SCALING, [
129
- async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
130
- // we have to deal just with root nodes here due to relative impacts in a node tree
131
- const rootNode = getRootNode(light.light);
132
- if (rootNode instanceof TransformNode) {
133
- transformTransformNode(rootNode, {
134
- scaling: Parameter.parseScaling(newValue),
135
- position: Parameter.parseVector(light.inheritedParameters[Parameter.POSITION] || '(0, 0, 0)'),
136
- rotation: Parameter.parseRotation(light.inheritedParameters[Parameter.ROTATION] || '(0, 0, 0)'),
137
- });
138
- }
139
- },
140
- ]);
141
- this._parameterObservers.set(Parameter.POSITION, [
142
- async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
143
- // we have to deal just with root nodes here due to relative impacts in a node tree
144
- const rootNode = getRootNode(light.light);
145
- if (rootNode instanceof TransformNode) {
146
- transformTransformNode(rootNode, {
147
- scaling: Parameter.parseVector(light.inheritedParameters[Parameter.SCALING] || '(1, 1, 1)'),
148
- position: Parameter.parseVector(newValue),
149
- rotation: Parameter.parseRotation(light.inheritedParameters[Parameter.ROTATION] || '(0, 0, 0)'),
150
- });
151
- }
152
- },
153
- ]);
154
- this._parameterObservers.set(Parameter.ROTATION, [
155
- async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
156
- // we have to deal just with root nodes here due to relative impacts in a node tree
157
- const rootNode = getRootNode(light.light);
158
- if (rootNode instanceof TransformNode) {
159
- transformTransformNode(rootNode, {
160
- scaling: Parameter.parseVector(light.inheritedParameters[Parameter.SCALING] || '(1, 1, 1)'),
161
- position: Parameter.parseVector(light.inheritedParameters[Parameter.POSITION] || '(0, 0, 0)'),
162
- rotation: Parameter.parseRotation(newValue),
163
- });
164
- }
165
- },
166
- ]);
167
- this._parameterObservers.set(Parameter.DIRECTION, [
168
- async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
169
- if (
170
- (light.light instanceof ShadowLight && !(light.light instanceof PointLight)) ||
171
- light.light instanceof HemisphericLight
172
- ) {
173
- set(light.light, 'direction', Parameter.parseVector(newValue));
174
- }
175
- },
176
- ]);
177
- this._parameterObservers.set(Parameter.ANGLE, [
178
- async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
179
- if (light.light.getClassName() === 'SpotLight') {
180
- set(light.light, 'angle', Parameter.parseNumber(newValue));
181
- }
182
- },
183
- ]);
184
- this._parameterObservers.set(Parameter.EXPONENT, [
185
- async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
186
- if (light.light.getClassName() === 'SpotLight') {
187
- set(light.light, 'exponent', Parameter.parseNumber(newValue));
188
- }
189
- },
190
- ]);
191
- this._parameterObservers.set(Parameter.DIFFUSE, [
192
- async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
193
- set(light.light, 'diffuse', Parameter.parseColor(newValue));
194
- },
195
- ]);
196
- this._parameterObservers.set(Parameter.SPECULAR, [
197
- async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
198
- set(light.light, 'specular', Parameter.parseColor(newValue));
199
- },
200
- ]);
201
- return this;
202
- }
203
-
204
- /**
205
- * @param definition
206
- * @protected
207
- */
208
- protected async createBabylonLightFromDefinition(definition: LightDefinition): Promise<Light> {
209
- const parameters = Parameter.parseFromDeclarations(Parameter.declarations, this.inheritedParameters);
210
- const scene = this.variant.viewer.scene;
211
- let lightId = this.id;
212
- let babylonLight;
213
- switch (definition.type) {
214
- case 'baked': {
215
- if (!definition['path']) {
216
- throw new Error(`The light "${lightId}" of type "${definition.type}" needs a "path".`);
217
- }
218
- const bakedLight = this.variant.inheritedLights.find(l => l.metadata.dottedPath.path === definition['path']);
219
- if (bakedLight) {
220
- lightId = bakedLight.metadata.dottedPath.clone().unshiftPart(this.id).path;
221
- babylonLight = cloneNodeWithParents(bakedLight) as Light;
222
- babylonLight!.name = lightId;
223
- babylonLight!.id = lightId;
224
- } else {
225
- throw new Error(`No light found for path "${definition['path']}" in ViewerLight "${lightId}".`);
226
- }
227
- break;
228
- }
229
- case 'hemispheric': {
230
- if (!parameters['direction']) {
231
- throw new Error(`The ViewerLight "${lightId}" of type "${definition.type}" needs a "direction".`);
232
- }
233
- const hemisphericLightModule = await import(
234
- /* webpackChunkName: "hemispheric-light" */ '@babylonjs/core/Lights/hemisphericLight'
235
- );
236
- babylonLight = new hemisphericLightModule.HemisphericLight(lightId, parameters['direction'], scene);
237
- break;
238
- }
239
- case 'point': {
240
- const pointLightModule = await import(
241
- /* webpackChunkName: "point-light" */ '@babylonjs/core/Lights/pointLight'
242
- );
243
- babylonLight = new pointLightModule.PointLight(
244
- lightId,
245
- Vector3.Zero(), // position is set via parent TransformNode
246
- scene
247
- );
248
- break;
249
- }
250
- case 'directional': {
251
- if (!parameters['direction']) {
252
- throw new Error(`The ViewerLight "${lightId}" of type "${definition.type}" needs a "direction".`);
253
- }
254
- const directionalLightModule = await import(
255
- /* webpackChunkName: "directional-light" */ '@babylonjs/core/Lights/directionalLight'
256
- );
257
- babylonLight = new directionalLightModule.DirectionalLight(lightId, parameters['direction'], scene);
258
- break;
259
- }
260
- case 'spot': {
261
- if (!parameters['direction']) {
262
- throw new Error(`The ViewerLight "${lightId}" of type "${definition.type}" needs a "direction".`);
263
- }
264
- if (!parameters['angle']) {
265
- throw new Error(`A ViewerLight of type "${definition.type}" needs an "angle".`);
266
- }
267
- if (!parameters['exponent']) {
268
- throw new Error(`The ViewerLight "${lightId}" of type "${definition.type}" needs an "exponent".`);
269
- }
270
- const spotLightModule = await import(/* webpackChunkName: "spot-light" */ '@babylonjs/core/Lights/spotLight');
271
- babylonLight = new spotLightModule.SpotLight(
272
- lightId,
273
- Vector3.Zero(), // position is set via parent TransformNode
274
- parameters['direction'],
275
- parameters['angle'],
276
- parameters['exponent'],
277
- scene
278
- );
279
- break;
280
- }
281
- default:
282
- throw new Error(`The type "${definition.type}" for ViewerLight "${lightId}" is not implemented (yet).`);
283
- }
284
- if (!babylonLight) {
285
- throw new Error(
286
- `The Light for ViewerLight "${lightId}" of type "${definition.type}" could no be created ` + `or found.`
287
- );
288
- }
289
- if (!babylonLight.parent) {
290
- // Create pseudo parent since lights do not implement mutations like "rotation" by itself.
291
- babylonLight.parent = new TransformNode('__light__', this.variant.viewer.scene, true);
292
- }
293
- injectMetadata(babylonLight.parent, {
294
- variant: this.variant,
295
- variantParameterizable: this,
296
- });
297
- // disable/hide by default
298
- disableNodeWithParents(babylonLight);
299
- // process shadow generator
300
- const shadowGeneratorDefinition = get(definition, 'shadowGenerator') as ShadowGeneratorDefinition;
301
- if (!isEmpty(shadowGeneratorDefinition)) {
302
- if (!(babylonLight instanceof ShadowLight)) {
303
- throw new Error(
304
- `Using a ShadowGenerator with light type "${definition.type}" is not supported for ` +
305
- `"${lightId}". Use lights deriving from ShadowLight.`
306
- );
307
- }
308
- await this.processShadowGenerator(babylonLight, shadowGeneratorDefinition);
309
- }
310
- return babylonLight;
311
- }
312
-
313
- /**
314
- * @param babylonLight
315
- * @param definition
316
- * @protected
317
- */
318
- protected async processShadowGenerator(
319
- babylonLight: ShadowLight,
320
- definition: ShadowGeneratorDefinition
321
- ): Promise<ShadowGenerator> {
322
- const parameterDeclarations: ParameterDeclarations = {};
323
- // define declarations here if needed in future
324
- const parameterBag = definition as {} as ParameterBag;
325
- const parameters = Parameter.parseFromDeclarations(parameterDeclarations, parameterBag);
326
- const shadowGenerator = new ShadowGenerator(parameters['mapSize'], babylonLight);
327
- for (const parameter in parameters) {
328
- if (parameter === 'mapSize') {
329
- continue;
330
- }
331
- set(shadowGenerator, parameter, get(parameters, parameter));
332
- }
333
- return shadowGenerator;
334
- }
335
- }
1
+ import {
2
+ cloneNodeWithParents,
3
+ disableNodeWithParents,
4
+ enableNodeWithParents,
5
+ getRootNode,
6
+ injectMetadata,
7
+ transformTransformNode,
8
+ } from './../util/babylonHelper';
9
+ import { DottedPath } from './dottedPath';
10
+ import { Parameter } from './parameter';
11
+ import { Variant } from './variant';
12
+ import { VariantParameterizable } from './variantParameterizable';
13
+ import { ShadowGenerator } from '@babylonjs/core/Lights/Shadows/shadowGenerator';
14
+ import '@babylonjs/core/Lights/Shadows/shadowGeneratorSceneComponent';
15
+ import { HemisphericLight } from '@babylonjs/core/Lights/hemisphericLight';
16
+ import { Light } from '@babylonjs/core/Lights/light';
17
+ import { PointLight } from '@babylonjs/core/Lights/pointLight';
18
+ import { ShadowLight } from '@babylonjs/core/Lights/shadowLight';
19
+ import { Vector3 } from '@babylonjs/core/Maths/math.vector';
20
+ import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
21
+ import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_lights_punctual';
22
+ import { get, isEmpty, isString, set } from 'lodash-es';
23
+
24
+ /**
25
+ * A {@link ViewerLight} of a {@link Variant}. Acts as a container for Babylon.js lights. Lives only in the context of a
26
+ * {@link Variant}.
27
+ */
28
+ export class ViewerLight extends VariantParameterizable {
29
+ protected _light: Light | undefined;
30
+
31
+ /**
32
+ * Constructor.
33
+ */
34
+ protected constructor(public readonly variant: Variant, public readonly name: string) {
35
+ super(variant, name);
36
+ this.addParameterObservers();
37
+ }
38
+
39
+ /**
40
+ * Creates a {@link ViewerLight} with given name.
41
+ */
42
+ public static async create(variant: Variant, name: string): Promise<ViewerLight> {
43
+ const viewerLight = new ViewerLight(variant, name);
44
+ viewerLight._light = await viewerLight.createBabylonLightFromDefinition(viewerLight.definition);
45
+ return viewerLight;
46
+ }
47
+
48
+ /**
49
+ * The wrapped Light.
50
+ */
51
+ get light(): Light {
52
+ if (!this._light) {
53
+ throw new Error(`Light for ViewerLight "${this.name}" has not been properly initialized.`);
54
+ }
55
+ return this._light!;
56
+ }
57
+
58
+ /**
59
+ * The {@link DottedPath} in the built tree of {@link ViewerLight}s.
60
+ * E.g. "_.top-1.sub-2.sub-sub-3.el-1"
61
+ */
62
+ get dottedPath(): DottedPath {
63
+ return DottedPath.create(this.variant.dottedPath).addPart(this.name);
64
+ }
65
+
66
+ /**
67
+ * The id representing a {@link DottedPath}.
68
+ */
69
+ get id(): string {
70
+ const dottedPath = DottedPath.create(this.dottedPath);
71
+ dottedPath.shiftPart(); // remove root
72
+ return dottedPath.path;
73
+ }
74
+
75
+ /**
76
+ * The {@link LightDefinition} of the {@link ViewerLight}.
77
+ */
78
+ get definition(): LightDefinition {
79
+ const definition = this.variant.structureJson.lights![this.name];
80
+ if (isString(definition)) {
81
+ return {
82
+ type: 'baked',
83
+ path: definition,
84
+ } as LightDefinition;
85
+ }
86
+ return definition as LightDefinition;
87
+ }
88
+
89
+ /**
90
+ * The type of the {@link ViewerLight}'s light.
91
+ */
92
+ get type(): string {
93
+ return this.light.constructor.name.replace(/light/i, '').toLowerCase();
94
+ }
95
+
96
+ /**
97
+ * @see {@link VariantParameterizable.commitParameters}
98
+ * @emit {@link Event.VIEWER_LIGHT_PARAMETER_COMMITTED}
99
+ */
100
+ public async commitParameters(parameters?: ParameterBag): Promise<VariantParameterizable> {
101
+ return super.commitParameters(parameters);
102
+ }
103
+
104
+ /**
105
+ * Adds the default {@link ParameterObserver}s which are called every time {@link commitParameters} is called.
106
+ */
107
+ protected addParameterObservers(): ViewerLight {
108
+ this._parameterObservers.set(Parameter.VISIBLE, [
109
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
110
+ let visible;
111
+ try {
112
+ visible = Parameter.parseBoolean(newValue);
113
+ } catch (e) {
114
+ return;
115
+ }
116
+ if (visible === true) {
117
+ enableNodeWithParents(light.light);
118
+ } else if (visible === false) {
119
+ disableNodeWithParents(light.light);
120
+ }
121
+ },
122
+ ]);
123
+ this._parameterObservers.set(Parameter.INTENSITY, [
124
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
125
+ set(light.light, 'intensity', Parameter.parseNumber(newValue));
126
+ },
127
+ ]);
128
+ this._parameterObservers.set(Parameter.SCALING, [
129
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
130
+ // we have to deal just with root nodes here due to relative impacts in a node tree
131
+ const rootNode = getRootNode(light.light);
132
+ if (rootNode instanceof TransformNode) {
133
+ transformTransformNode(rootNode, {
134
+ scaling: Parameter.parseScaling(newValue),
135
+ position: Parameter.parseVector(light.inheritedParameters[Parameter.POSITION] || '(0, 0, 0)'),
136
+ rotation: Parameter.parseRotation(light.inheritedParameters[Parameter.ROTATION] || '(0, 0, 0)'),
137
+ });
138
+ }
139
+ },
140
+ ]);
141
+ this._parameterObservers.set(Parameter.POSITION, [
142
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
143
+ // we have to deal just with root nodes here due to relative impacts in a node tree
144
+ const rootNode = getRootNode(light.light);
145
+ if (rootNode instanceof TransformNode) {
146
+ transformTransformNode(rootNode, {
147
+ scaling: Parameter.parseVector(light.inheritedParameters[Parameter.SCALING] || '(1, 1, 1)'),
148
+ position: Parameter.parseVector(newValue),
149
+ rotation: Parameter.parseRotation(light.inheritedParameters[Parameter.ROTATION] || '(0, 0, 0)'),
150
+ });
151
+ }
152
+ },
153
+ ]);
154
+ this._parameterObservers.set(Parameter.ROTATION, [
155
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
156
+ // we have to deal just with root nodes here due to relative impacts in a node tree
157
+ const rootNode = getRootNode(light.light);
158
+ if (rootNode instanceof TransformNode) {
159
+ transformTransformNode(rootNode, {
160
+ scaling: Parameter.parseVector(light.inheritedParameters[Parameter.SCALING] || '(1, 1, 1)'),
161
+ position: Parameter.parseVector(light.inheritedParameters[Parameter.POSITION] || '(0, 0, 0)'),
162
+ rotation: Parameter.parseRotation(newValue),
163
+ });
164
+ }
165
+ },
166
+ ]);
167
+ this._parameterObservers.set(Parameter.DIRECTION, [
168
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
169
+ if (
170
+ (light.light instanceof ShadowLight && !(light.light instanceof PointLight)) ||
171
+ light.light instanceof HemisphericLight
172
+ ) {
173
+ set(light.light, 'direction', Parameter.parseVector(newValue));
174
+ }
175
+ },
176
+ ]);
177
+ this._parameterObservers.set(Parameter.ANGLE, [
178
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
179
+ if (light.light.getClassName() === 'SpotLight') {
180
+ set(light.light, 'angle', Parameter.parseNumber(newValue));
181
+ }
182
+ },
183
+ ]);
184
+ this._parameterObservers.set(Parameter.EXPONENT, [
185
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
186
+ if (light.light.getClassName() === 'SpotLight') {
187
+ set(light.light, 'exponent', Parameter.parseNumber(newValue));
188
+ }
189
+ },
190
+ ]);
191
+ this._parameterObservers.set(Parameter.DIFFUSE, [
192
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
193
+ set(light.light, 'diffuse', Parameter.parseColor(newValue));
194
+ },
195
+ ]);
196
+ this._parameterObservers.set(Parameter.SPECULAR, [
197
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
198
+ set(light.light, 'specular', Parameter.parseColor(newValue));
199
+ },
200
+ ]);
201
+ return this;
202
+ }
203
+
204
+ /**
205
+ * @param definition
206
+ * @protected
207
+ */
208
+ protected async createBabylonLightFromDefinition(definition: LightDefinition): Promise<Light> {
209
+ const parameters = Parameter.parseFromDeclarations(Parameter.declarations, this.inheritedParameters);
210
+ const scene = this.variant.viewer.scene;
211
+ let lightId = this.id;
212
+ let babylonLight;
213
+ switch (definition.type) {
214
+ case 'baked': {
215
+ if (!definition['path']) {
216
+ throw new Error(`The light "${lightId}" of type "${definition.type}" needs a "path".`);
217
+ }
218
+ const bakedLight = this.variant.inheritedLights.find(l => l.metadata.dottedPath.path === definition['path']);
219
+ if (bakedLight) {
220
+ lightId = bakedLight.metadata.dottedPath.clone().unshiftPart(this.id).path;
221
+ babylonLight = cloneNodeWithParents(bakedLight) as Light;
222
+ babylonLight!.name = lightId;
223
+ babylonLight!.id = lightId;
224
+ } else {
225
+ throw new Error(`No light found for path "${definition['path']}" in ViewerLight "${lightId}".`);
226
+ }
227
+ break;
228
+ }
229
+ case 'hemispheric': {
230
+ if (!parameters['direction']) {
231
+ throw new Error(`The ViewerLight "${lightId}" of type "${definition.type}" needs a "direction".`);
232
+ }
233
+ const hemisphericLightModule = await import(
234
+ /* webpackChunkName: "hemispheric-light" */ '@babylonjs/core/Lights/hemisphericLight'
235
+ );
236
+ babylonLight = new hemisphericLightModule.HemisphericLight(lightId, parameters['direction'], scene);
237
+ break;
238
+ }
239
+ case 'point': {
240
+ const pointLightModule = await import(
241
+ /* webpackChunkName: "point-light" */ '@babylonjs/core/Lights/pointLight'
242
+ );
243
+ babylonLight = new pointLightModule.PointLight(
244
+ lightId,
245
+ Vector3.Zero(), // position is set via parent TransformNode
246
+ scene
247
+ );
248
+ break;
249
+ }
250
+ case 'directional': {
251
+ if (!parameters['direction']) {
252
+ throw new Error(`The ViewerLight "${lightId}" of type "${definition.type}" needs a "direction".`);
253
+ }
254
+ const directionalLightModule = await import(
255
+ /* webpackChunkName: "directional-light" */ '@babylonjs/core/Lights/directionalLight'
256
+ );
257
+ babylonLight = new directionalLightModule.DirectionalLight(lightId, parameters['direction'], scene);
258
+ break;
259
+ }
260
+ case 'spot': {
261
+ if (!parameters['direction']) {
262
+ throw new Error(`The ViewerLight "${lightId}" of type "${definition.type}" needs a "direction".`);
263
+ }
264
+ if (!parameters['angle']) {
265
+ throw new Error(`A ViewerLight of type "${definition.type}" needs an "angle".`);
266
+ }
267
+ if (!parameters['exponent']) {
268
+ throw new Error(`The ViewerLight "${lightId}" of type "${definition.type}" needs an "exponent".`);
269
+ }
270
+ const spotLightModule = await import(/* webpackChunkName: "spot-light" */ '@babylonjs/core/Lights/spotLight');
271
+ babylonLight = new spotLightModule.SpotLight(
272
+ lightId,
273
+ Vector3.Zero(), // position is set via parent TransformNode
274
+ parameters['direction'],
275
+ parameters['angle'],
276
+ parameters['exponent'],
277
+ scene
278
+ );
279
+ break;
280
+ }
281
+ default:
282
+ throw new Error(`The type "${definition.type}" for ViewerLight "${lightId}" is not implemented (yet).`);
283
+ }
284
+ if (!babylonLight) {
285
+ throw new Error(
286
+ `The Light for ViewerLight "${lightId}" of type "${definition.type}" could no be created ` + `or found.`
287
+ );
288
+ }
289
+ if (!babylonLight.parent) {
290
+ // Create pseudo parent since lights do not implement mutations like "rotation" by itself.
291
+ babylonLight.parent = new TransformNode('__light__', this.variant.viewer.scene, true);
292
+ }
293
+ injectMetadata(babylonLight.parent, {
294
+ variant: this.variant,
295
+ variantParameterizable: this,
296
+ });
297
+ // disable/hide by default
298
+ disableNodeWithParents(babylonLight);
299
+ // process shadow generator
300
+ const shadowGeneratorDefinition = get(definition, 'shadowGenerator') as ShadowGeneratorDefinition;
301
+ if (!isEmpty(shadowGeneratorDefinition)) {
302
+ if (!(babylonLight instanceof ShadowLight)) {
303
+ throw new Error(
304
+ `Using a ShadowGenerator with light type "${definition.type}" is not supported for ` +
305
+ `"${lightId}". Use lights deriving from ShadowLight.`
306
+ );
307
+ }
308
+ await this.processShadowGenerator(babylonLight, shadowGeneratorDefinition);
309
+ }
310
+ return babylonLight;
311
+ }
312
+
313
+ /**
314
+ * @param babylonLight
315
+ * @param definition
316
+ * @protected
317
+ */
318
+ protected async processShadowGenerator(
319
+ babylonLight: ShadowLight,
320
+ definition: ShadowGeneratorDefinition
321
+ ): Promise<ShadowGenerator> {
322
+ const parameterDeclarations: ParameterDeclarations = {};
323
+ // define declarations here if needed in future
324
+ const parameterBag = definition as {} as ParameterBag;
325
+ const parameters = Parameter.parseFromDeclarations(parameterDeclarations, parameterBag);
326
+ const shadowGenerator = new ShadowGenerator(parameters['mapSize'], babylonLight);
327
+ for (const parameter in parameters) {
328
+ if (parameter === 'mapSize') {
329
+ continue;
330
+ }
331
+ set(shadowGenerator, parameter, get(parameters, parameter));
332
+ }
333
+ return shadowGenerator;
334
+ }
335
+ }