@combeenation/3d-viewer 6.5.0 → 7.0.0-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.
Files changed (118) hide show
  1. package/README.md +111 -111
  2. package/dist/lib-cjs/api/classes/animationInterface.d.ts +8 -8
  3. package/dist/lib-cjs/api/classes/animationInterface.js +2 -2
  4. package/dist/lib-cjs/api/classes/dottedPath.d.ts +79 -79
  5. package/dist/lib-cjs/api/classes/dottedPath.js +166 -166
  6. package/dist/lib-cjs/api/classes/element.d.ts +153 -149
  7. package/dist/lib-cjs/api/classes/element.js +670 -669
  8. package/dist/lib-cjs/api/classes/element.js.map +1 -1
  9. package/dist/lib-cjs/api/classes/event.d.ts +396 -342
  10. package/dist/lib-cjs/api/classes/event.js +419 -365
  11. package/dist/lib-cjs/api/classes/event.js.map +1 -1
  12. package/dist/lib-cjs/api/classes/eventBroadcaster.d.ts +26 -26
  13. package/dist/lib-cjs/api/classes/eventBroadcaster.js +49 -49
  14. package/dist/lib-cjs/api/classes/fuzzyMap.d.ts +7 -0
  15. package/dist/lib-cjs/api/classes/fuzzyMap.js +22 -0
  16. package/dist/lib-cjs/api/classes/fuzzyMap.js.map +1 -0
  17. package/dist/lib-cjs/api/classes/parameter.d.ts +351 -339
  18. package/dist/lib-cjs/api/classes/parameter.js +517 -464
  19. package/dist/lib-cjs/api/classes/parameter.js.map +1 -1
  20. package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
  21. package/dist/lib-cjs/api/classes/parameterObservable.js +72 -97
  22. package/dist/lib-cjs/api/classes/parameterObservable.js.map +1 -1
  23. package/dist/lib-cjs/api/classes/parameterizable.d.ts +15 -15
  24. package/dist/lib-cjs/api/classes/parameterizable.js +102 -102
  25. package/dist/lib-cjs/api/classes/placementAnimation.d.ts +45 -45
  26. package/dist/lib-cjs/api/classes/placementAnimation.js +176 -176
  27. package/dist/lib-cjs/api/classes/variant.d.ts +253 -234
  28. package/dist/lib-cjs/api/classes/variant.js +843 -818
  29. package/dist/lib-cjs/api/classes/variant.js.map +1 -1
  30. package/dist/lib-cjs/api/classes/variantInstance.d.ts +53 -44
  31. package/dist/lib-cjs/api/classes/variantInstance.js +125 -105
  32. package/dist/lib-cjs/api/classes/variantInstance.js.map +1 -1
  33. package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +17 -17
  34. package/dist/lib-cjs/api/classes/variantParameterizable.js +88 -88
  35. package/dist/lib-cjs/api/classes/viewer.d.ts +199 -185
  36. package/dist/lib-cjs/api/classes/viewer.js +670 -619
  37. package/dist/lib-cjs/api/classes/viewer.js.map +1 -1
  38. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
  39. package/dist/lib-cjs/api/classes/viewerLight.js +348 -348
  40. package/dist/lib-cjs/api/classes/viewerLight.js.map +1 -1
  41. package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
  42. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  43. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
  44. package/dist/lib-cjs/api/internal/sceneSetup.js +226 -226
  45. package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
  46. package/dist/lib-cjs/api/manager/animationManager.js +126 -126
  47. package/dist/lib-cjs/api/manager/animationManager.js.map +1 -1
  48. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +78 -78
  49. package/dist/lib-cjs/api/manager/gltfExportManager.js +241 -241
  50. package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
  51. package/dist/lib-cjs/api/manager/sceneManager.js +130 -130
  52. package/dist/lib-cjs/api/manager/sceneManager.js.map +1 -1
  53. package/dist/lib-cjs/api/manager/tagManager.d.ts +108 -0
  54. package/dist/lib-cjs/api/manager/tagManager.js +420 -0
  55. package/dist/lib-cjs/api/manager/tagManager.js.map +1 -0
  56. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
  57. package/dist/lib-cjs/api/manager/textureLoadManager.js +97 -97
  58. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +102 -92
  59. package/dist/lib-cjs/api/manager/variantInstanceManager.js +284 -260
  60. package/dist/lib-cjs/api/manager/variantInstanceManager.js.map +1 -1
  61. package/dist/lib-cjs/api/store/specStorage.d.ts +32 -24
  62. package/dist/lib-cjs/api/store/specStorage.js +65 -50
  63. package/dist/lib-cjs/api/store/specStorage.js.map +1 -1
  64. package/dist/lib-cjs/api/util/babylonHelper.d.ts +235 -206
  65. package/dist/lib-cjs/api/util/babylonHelper.js +745 -668
  66. package/dist/lib-cjs/api/util/babylonHelper.js.map +1 -1
  67. package/dist/lib-cjs/api/util/globalTypes.d.ts +432 -387
  68. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  69. package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
  70. package/dist/lib-cjs/api/util/resourceHelper.js +203 -203
  71. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +44 -43
  72. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +173 -155
  73. package/dist/lib-cjs/api/util/sceneLoaderHelper.js.map +1 -1
  74. package/dist/lib-cjs/api/util/stringHelper.d.ts +13 -13
  75. package/dist/lib-cjs/api/util/stringHelper.js +32 -32
  76. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
  77. package/dist/lib-cjs/api/util/structureHelper.js +48 -48
  78. package/dist/lib-cjs/buildinfo.json +3 -3
  79. package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
  80. package/dist/lib-cjs/index.d.ts +53 -52
  81. package/dist/lib-cjs/index.js +114 -112
  82. package/dist/lib-cjs/index.js.map +1 -1
  83. package/package.json +81 -81
  84. package/src/api/classes/animationInterface.ts +10 -10
  85. package/src/api/classes/dottedPath.ts +181 -181
  86. package/src/api/classes/element.ts +731 -717
  87. package/src/api/classes/event.ts +452 -385
  88. package/src/api/classes/eventBroadcaster.ts +52 -52
  89. package/src/api/classes/fuzzyMap.ts +21 -0
  90. package/src/api/classes/parameter.ts +554 -497
  91. package/src/api/classes/parameterObservable.ts +73 -100
  92. package/src/api/classes/parameterizable.ts +87 -87
  93. package/src/api/classes/placementAnimation.ts +162 -162
  94. package/src/api/classes/variant.ts +933 -884
  95. package/src/api/classes/variantInstance.ts +123 -97
  96. package/src/api/classes/variantParameterizable.ts +85 -85
  97. package/src/api/classes/viewer.ts +743 -691
  98. package/src/api/classes/viewerLight.ts +339 -339
  99. package/src/api/internal/debugViewer.ts +90 -90
  100. package/src/api/internal/lensRendering.ts +9 -9
  101. package/src/api/internal/sceneSetup.ts +205 -205
  102. package/src/api/manager/animationManager.ts +143 -143
  103. package/src/api/manager/gltfExportManager.ts +236 -236
  104. package/src/api/manager/sceneManager.ts +136 -132
  105. package/src/api/manager/tagManager.ts +451 -0
  106. package/src/api/manager/textureLoadManager.ts +95 -95
  107. package/src/api/manager/variantInstanceManager.ts +297 -265
  108. package/src/api/store/specStorage.ts +68 -51
  109. package/src/api/util/babylonHelper.ts +817 -739
  110. package/src/api/util/globalTypes.ts +499 -437
  111. package/src/api/util/resourceHelper.ts +191 -191
  112. package/src/api/util/sceneLoaderHelper.ts +170 -151
  113. package/src/api/util/stringHelper.ts +30 -30
  114. package/src/api/util/structureHelper.ts +49 -49
  115. package/src/buildinfo.json +3 -3
  116. package/src/dev.ts +62 -60
  117. package/src/index.ts +100 -98
  118. package/src/types.d.ts +35 -28
@@ -1,497 +1,554 @@
1
- import { Color3 } from '@babylonjs/core/Maths/math.color';
2
- import { Vector3 } from '@babylonjs/core/Maths/math.vector';
3
- import { get, isEmpty, isNumber, isString } from 'lodash-es';
4
-
5
- /**
6
- * This `Parameter` class defines all parameters that can be consumed and committed by a {@link ParameterObservable}.
7
- * Use {@link ParameterObservable.addParameterObserver} or {@link ParameterObservable.commitParameters} to either add or
8
- * commit parameters on your observable objects.
9
- */
10
- export class Parameter {
11
- /**
12
- * Constructor.
13
- */
14
- private constructor() {}
15
-
16
- /**
17
- * Mutates the visibility. Helper methods are {@link VariantParameterizable.show} and
18
- * {@link VariantParameterizable.hide}. Getter and setter is {@link VariantParameterizable.visible}.
19
- *
20
- * Scopes:
21
- * * {@link Element}
22
- * * {@link Variant}
23
- * * {@link ViewerLight} Available for all light types
24
- *
25
- * @parser {@link parseBoolean}
26
- */
27
- public static readonly VISIBLE = 'visible';
28
-
29
- /**
30
- * Stretches or compresses some meshes. Getter and setter is {@link VariantParameterizable.scaling}.
31
- *
32
- * Scopes:
33
- * * {@link Element}
34
- * * {@link Variant}
35
- *
36
- * @parser {@link parseScaling}
37
- */
38
- public static readonly SCALING = 'scaling';
39
-
40
- /**
41
- * Mutates the material. Getter and setter is {@link VariantParameterizable.material}. The value of this parameter
42
- * represents the ID of a baked-in glTF or custom created material in the {@link Variant} tree.
43
- *
44
- * Scopes:
45
- * * {@link Element}
46
- * * {@link Variant}
47
- *
48
- * @parser string
49
- */
50
- public static readonly MATERIAL = 'material';
51
-
52
- /**
53
- * Mutates the material color.
54
- *
55
- * Scopes:
56
- * * {@link Element}
57
- * * {@link Variant}
58
- *
59
- * @parser {@link parseColor}
60
- */
61
- public static readonly MATERIAL_COLOR = 'material.color';
62
-
63
- /**
64
- * Mutates the material metallness.
65
- *
66
- * Scopes:
67
- * * {@link Element}
68
- * * {@link Variant}
69
- *
70
- * @parser {@link parseNumber}
71
- */
72
- public static readonly MATERIAL_METALLNESS = 'material.metallness';
73
-
74
- /**
75
- * Mutates the material roughness.
76
- *
77
- * Scopes:
78
- * * {@link Element}
79
- * * {@link Variant}
80
- *
81
- * @parser {@link parseNumber}
82
- */
83
- public static readonly MATERIAL_ROUGHNESS = 'material.roughness';
84
-
85
- /**
86
- * Mutates whether a highlight layer should be enabled.
87
- *
88
- * Scopes:
89
- * * {@link Element}
90
- * * {@link Variant}
91
- *
92
- * @parser {@link parseBoolean}
93
- */
94
- public static readonly HIGHLIGHT_ENABLED = 'highlight.enabled';
95
-
96
- /**
97
- * Changes the highlight color.
98
- *
99
- * Scopes:
100
- * * {@link Element}
101
- * * {@link Variant}
102
- *
103
- * @parser {@link parseColor}
104
- */
105
- public static readonly HIGHLIGHT_COLOR = 'highlight.color';
106
-
107
- /**
108
- * Mutates the highlighted state. Getter and setter is {@link VariantParameterizable.highlighted}.
109
- *
110
- * Scopes:
111
- * * {@link Element}
112
- * * {@link Variant}
113
- *
114
- * @parser {@link parseBoolean}
115
- */
116
- public static readonly HIGHLIGHTED = 'highlighted';
117
-
118
- /**
119
- * Mutates the position relative to its origin position. Getter and setter is {@link VariantParameterizable.position}.
120
- *
121
- * Scopes:
122
- * * {@link Element}
123
- * * {@link Variant}
124
- * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#position), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#position), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#position)
125
- *
126
- * @parser {@link parseVector}
127
- */
128
- public static readonly POSITION = 'position';
129
-
130
- /**
131
- * Mutates the rotation relative to its origin rotation. Getter and setter is {@link VariantParameterizable.rotation}.
132
- *
133
- * Scopes:
134
- * * {@link Element}
135
- * * {@link Variant}
136
- *
137
- * @parser {@link parseRotation}
138
- */
139
- public static readonly ROTATION = 'rotation';
140
-
141
- /**
142
- * Mutates whether a shadow should be casted or not.
143
- *
144
- * Scopes:
145
- * * {@link Element}
146
- * * {@link Variant}
147
- *
148
- * @parser {@link parseBoolean}
149
- */
150
- public static readonly CAST_SHADOW = 'castShadow';
151
-
152
- /**
153
- * Mutates from which lights a shadow should be casted.
154
- *
155
- * Scopes:
156
- * * {@link Element}
157
- * * {@link Variant}
158
- *
159
- * @parser {@link parseCommaSeparatedList}
160
- */
161
- public static readonly CAST_SHADOW_FROM_LIGHTS = 'castShadow.fromLights';
162
-
163
- /**
164
- * Mutates whether to receive shadows or not.
165
- *
166
- * Scopes:
167
- * * {@link Element}
168
- * * {@link Variant}
169
- *
170
- * @parser {@link parseBoolean}
171
- */
172
- public static readonly RECEIVE_SHADOWS = 'receiveShadows';
173
-
174
- /**
175
- * Mutates the intensity of Lights.
176
- *
177
- * Scopes:
178
- * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#intensity), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#intensity), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#intensity), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#intensity)
179
- *
180
- * @parser {@link parseNumber}
181
- */
182
- public static readonly INTENSITY = 'intensity';
183
-
184
- /**
185
- * Mutates the direction of Lights.
186
- *
187
- * Scopes:
188
- * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#direction), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#direction), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#direction), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#direction)
189
- *
190
- * @parser {@link parseNumber}
191
- */
192
- public static readonly DIRECTION = 'direction';
193
-
194
- /**
195
- * Mutates the angle of Lights.
196
- *
197
- * Scopes:
198
- * * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#angle)
199
- *
200
- * @parser {@link parseNumber}
201
- */
202
- public static readonly ANGLE = 'angle';
203
-
204
- /**
205
- * Mutates the exponent of Lights.
206
- *
207
- * Scopes:
208
- * * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#exponent)
209
- *
210
- * @parser {@link parseNumber}
211
- */
212
- public static readonly EXPONENT = 'exponent';
213
-
214
- /**
215
- * Mutates the diffuse color of Lights.
216
- *
217
- * Scopes:
218
- * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#diffuse), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#diffuse), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#diffuse), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#diffuse)
219
- *
220
- * @parser {@link parseNumber}
221
- */
222
- public static readonly DIFFUSE = 'diffuse';
223
-
224
- /**
225
- * Mutates the specular color of Lights.
226
- *
227
- * Scopes:
228
- * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#specular), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#specular), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#specular), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#specular)
229
- *
230
- * @parser {@link parseNumber}
231
- */
232
- public static readonly SPECULAR = 'specular';
233
-
234
- /**
235
- * Sets the environment. See [BABYLON.Scene.environmentTexture](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#environmentTexture).
236
- *
237
- * Usually the URL to an `*.env` file.
238
- *
239
- * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
240
- *
241
- * Scopes:
242
- * * {@link SceneManager}
243
- *
244
- * @parser string
245
- */
246
- public static readonly ENVIRONMENT = 'environment';
247
-
248
- /**
249
- * Sets [BABYLON.Scene.clearColor](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#clearColor)
250
- *
251
- * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
252
- *
253
- * Scopes:
254
- * * {@link SceneManager}
255
- *
256
- * @parser {@link parseColor}
257
- */
258
- public static readonly ENVIRONMENT_COLOR = 'environment.color';
259
-
260
- /**
261
- * Rotates connected textures, i.e. IBL, reflection, background, ...
262
- * Rotation angle in degree.
263
- *
264
- * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
265
- *
266
- * Scopes:
267
- * * {@link SceneManager}
268
- *
269
- * @parser {@link parseNumber}
270
- */
271
- public static readonly ENVIRONMENT_ROTATION = 'environment.rotation';
272
-
273
- /**
274
- * Intensity of IBL. Defaults to 1, usually between 0 & 2.
275
- *
276
- * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
277
- *
278
- * Scopes:
279
- * * {@link SceneManager}
280
- *
281
- * @parser {@link parseNumber}
282
- */
283
- public static readonly ENVIRONMENT_INTENSITY = 'environment.intensity';
284
-
285
- /**
286
- * Background texture on a [PhotoDome](https://doc.babylonjs.com/divingDeeper/environment/360PhotoDome).
287
- * Just background, no IBL or reflection.
288
- *
289
- * Recommended format is `*.jpg`. HDR files are not supported as background but can be converted to `*.jpg` using
290
- * tools like Photoshop, Gimp or various free online converters.
291
- *
292
- * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
293
- *
294
- * Scopes:
295
- * * {@link SceneManager}
296
- *
297
- * @parser string
298
- */
299
- public static readonly ENVIRONMENT_BACKGROUND = 'environment.background';
300
-
301
- /**
302
- * If `true`, sets a `scene.environmentTexture` and creates a *BackgroundHelper* Node (via
303
- * [scene.createDefaultEnvironment](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#createDefaultEnvironment))
304
- * with two subnodes/meshes:
305
- * - BackgroundPlane
306
- * - BackgroundSkybox
307
- *
308
- * The value of this parameter is ignored if {@link ENVIRONMENT_BACKGROUND} is also set.
309
- *
310
- * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
311
- *
312
- * Scopes:
313
- * * {@link SceneManager}
314
- *
315
- * @parser {@link parseBoolean}
316
- */
317
- public static readonly ENVIRONMENT_USEDEFAULT = 'environment.usedefault';
318
-
319
- /**
320
- * The {@link ParameterDeclarations} for all parameters in this class.
321
- */
322
- public static get declarations(): ParameterDeclarations {
323
- const declarations: ParameterDeclarations = {};
324
- declarations[Parameter.VISIBLE] = { type: 'boolean', parser: Parameter.parseBoolean };
325
- declarations[Parameter.SCALING] = { type: 'number', parser: Parameter.parseNumber };
326
- declarations[Parameter.POSITION] = { type: 'vector', parser: Parameter.parseVector };
327
- declarations[Parameter.ROTATION] = { type: 'vector', parser: Parameter.parseVector };
328
- declarations[Parameter.HIGHLIGHTED] = { type: 'boolean', parser: Parameter.parseBoolean };
329
- declarations[Parameter.MATERIAL] = { type: 'string' };
330
- declarations[Parameter.MATERIAL_COLOR] = { type: 'color', parser: Parameter.parseColor };
331
- declarations[Parameter.MATERIAL_METALLNESS] = { type: 'number', parser: Parameter.parseNumber };
332
- declarations[Parameter.MATERIAL_ROUGHNESS] = { type: 'number', parser: Parameter.parseNumber };
333
- declarations[Parameter.HIGHLIGHT_ENABLED] = { type: 'boolean', parser: Parameter.parseBoolean };
334
- declarations[Parameter.HIGHLIGHT_COLOR] = { type: 'color', parser: Parameter.parseColor };
335
- declarations[Parameter.HIGHLIGHTED] = { type: 'boolean', parser: Parameter.parseBoolean };
336
- declarations[Parameter.CAST_SHADOW] = { type: 'boolean', parser: Parameter.parseBoolean };
337
- declarations[Parameter.CAST_SHADOW_FROM_LIGHTS] = { type: 'csl', parser: Parameter.parseCommaSeparatedList };
338
- declarations[Parameter.RECEIVE_SHADOWS] = { type: 'boolean', parser: Parameter.parseBoolean };
339
- declarations[Parameter.INTENSITY] = { type: 'number', parser: Parameter.parseNumber };
340
- declarations[Parameter.DIRECTION] = { type: 'vector', parser: Parameter.parseVector };
341
- declarations[Parameter.ANGLE] = { type: 'number', parser: Parameter.parseNumber };
342
- declarations[Parameter.EXPONENT] = { type: 'number', parser: Parameter.parseNumber };
343
- declarations[Parameter.DIFFUSE] = { type: 'color', parser: Parameter.parseColor };
344
- declarations[Parameter.SPECULAR] = { type: 'color', parser: Parameter.parseColor };
345
- declarations[Parameter.ENVIRONMENT] = { type: 'string' };
346
- declarations[Parameter.ENVIRONMENT_COLOR] = { type: 'color', parser: Parameter.parseColor };
347
- declarations[Parameter.ENVIRONMENT_ROTATION] = { type: 'number', parser: Parameter.parseNumber };
348
- declarations[Parameter.ENVIRONMENT_INTENSITY] = { type: 'number', parser: Parameter.parseNumber };
349
- declarations[Parameter.ENVIRONMENT_BACKGROUND] = { type: 'string' };
350
- declarations[Parameter.ENVIRONMENT_USEDEFAULT] = { type: 'boolean', parser: Parameter.parseBoolean };
351
- return declarations;
352
- }
353
-
354
- /**
355
- * Gets the {@link ParameterDeclaration} for a given {@link Parameter} declared in this class.
356
- */
357
- public static getDeclaration(parameter: string): ParameterDeclaration {
358
- return Parameter.declarations[parameter];
359
- }
360
-
361
- /**
362
- * All parameters defined in this class.
363
- */
364
- public static get all() {
365
- const all: string[] = [];
366
- for (const parameter in Parameter) {
367
- const property = Object.getOwnPropertyDescriptor(Parameter, parameter);
368
- if (parameter.toUpperCase() === parameter && property && isString(property.value)) {
369
- all.push(property.value);
370
- }
371
- }
372
- return all;
373
- }
374
-
375
- /**
376
- * Parses given {@link ParameterBag} with given {@link ParameterDeclarations}.
377
- */
378
- public static parseFromDeclarations(
379
- declarations: ParameterDeclarations,
380
- parameterBag: ParameterBag
381
- ): ParsedParameterBag {
382
- const parameters: ParsedParameterBag = {};
383
- for (const parameter in parameterBag) {
384
- const value = get(parameterBag, parameter);
385
- parameters[parameter] = value;
386
- const declaration: ParameterDeclaration = declarations[parameter];
387
- if (declaration) {
388
- if (!isEmpty(value) && declaration.parser) {
389
- parameters[parameter] = declaration.parser(value);
390
- }
391
- }
392
- }
393
- return parameters;
394
- }
395
-
396
- /**
397
- * Parses a string of format `'(x,y,z)'` to a `Vector3`.
398
- */
399
- public static parseVector(value: ParameterValue): Vector3 {
400
- if (!isString(value)) {
401
- throw new Error(`Unable to convert "${value}" into a Vector: not a string.`);
402
- }
403
- let cleanedValue = value.split(' ').join('');
404
- if (cleanedValue.startsWith('(') && cleanedValue.endsWith(')')) {
405
- cleanedValue = cleanedValue.substring(1, cleanedValue.length - 1);
406
- const [x, y, z] = cleanedValue.split(',').map(value => parseFloat(value));
407
- return new Vector3(x, y, z);
408
- } else {
409
- throw new Error(`Unable to parse "${value}" to a Vector: expected "(x,y,z)".`);
410
- }
411
- }
412
-
413
- /**
414
- * Stringifies a Vector3 to format `(x,y,z)`.
415
- */
416
- public static stringifyVector(value: Vector3): string {
417
- return `(${value.x},${value.y},${value.z})`;
418
- }
419
-
420
- /**
421
- * Parses a string of format `'(x,y,z)'` with angular degrees to a `Vector3` with rotation information in radians.
422
- */
423
- public static parseRotation(value: ParameterValue): Vector3 {
424
- const rotation = Parameter.parseVector(value);
425
- const deg2rad = function (deg: number) {
426
- return (deg * Math.PI) / 180;
427
- };
428
- return rotation.set(deg2rad(rotation.x), deg2rad(rotation.y), deg2rad(rotation.z));
429
- }
430
-
431
- /**
432
- * Parses a string of format `'(x,y,z)'` or a simple `number` to a `Vector3` for scaling.
433
- */
434
- public static parseScaling(value: ParameterValue): Vector3 {
435
- let scaling = new Vector3();
436
- if (isString(value)) {
437
- const cleanedFactor = value.split(' ').join('');
438
- if (cleanedFactor.startsWith('(') && cleanedFactor.endsWith(')')) {
439
- scaling = Parameter.parseVector(cleanedFactor);
440
- } else {
441
- const _factor = parseFloat(value);
442
- scaling = new Vector3(_factor, _factor, _factor);
443
- }
444
- } else if (isNumber(value)) {
445
- scaling = new Vector3(value, value, value);
446
- } else {
447
- throw new Error(`Unable to convert "${value}" to a Vector: expected "(x,y,z)".`);
448
- }
449
- return scaling;
450
- }
451
-
452
- /**
453
- * Parses a string of format `'#rrggbb'` or `'(r,g,b)'` to a `Color3`.
454
- */
455
- public static parseColor(value: ParameterValue): Color3 {
456
- let cleanedValue = value.toString().split(' ').join('');
457
- if (cleanedValue.startsWith('#')) {
458
- return Color3.FromHexString(value.toString());
459
- }
460
- if (cleanedValue.startsWith('(') && cleanedValue.endsWith(')')) {
461
- cleanedValue = cleanedValue.substring(1, cleanedValue.length - 1);
462
- const [r, g, b] = cleanedValue.split(',').map(value => parseFloat(value));
463
- return Color3.FromInts(r, g, b);
464
- }
465
- throw new Error(`Unable to parse "${value}" to a Color: expected "#rrggbb" or "(r,g,b)".`);
466
- }
467
-
468
- /**
469
- * Parses a `boolean` string (`'true'`/`'1'` or `'false'`/`'0'`) or `number` (`1` or `0`) to a `boolean` or
470
- * `undefined`.
471
- */
472
- public static parseBoolean(value: ParameterValue): boolean {
473
- if (value.toString() === 'true' || value.toString() === '1') {
474
- return true;
475
- } else if (value.toString() === 'false' || value.toString() === '0') {
476
- return false;
477
- }
478
- throw new Error(`Unable to parse "${value}" to a boolean.`);
479
- }
480
-
481
- /**
482
- * Parses a number `string` to a `number`.
483
- */
484
- public static parseNumber(value: ParameterValue): number {
485
- return parseFloat(value.toString());
486
- }
487
-
488
- /**
489
- * Parses a string with comma separated values to a list of strings.
490
- */
491
- public static parseCommaSeparatedList(value: ParameterValue): string[] {
492
- return value
493
- .toString()
494
- .split(',')
495
- .map(s => s.trim());
496
- }
497
- }
1
+ import { Color3 } from '@babylonjs/core/Maths/math.color';
2
+ import { Vector3 } from '@babylonjs/core/Maths/math.vector';
3
+ import { capitalize, get, isEmpty, isNumber, isString } from 'lodash-es';
4
+
5
+ /**
6
+ * This `Parameter` class defines all parameters that can be consumed and committed by a {@link ParameterObservable}.
7
+ * Use {@link ParameterObservable.addParameterObserver} or {@link ParameterObservable.commitParameters} to either add or
8
+ * commit parameters on your observable objects.
9
+ */
10
+ export class Parameter {
11
+ /**
12
+ * Constructor.
13
+ */
14
+ private constructor() {}
15
+
16
+ /**
17
+ * Mutates the visibility. Helper methods are {@link VariantParameterizable.show} and
18
+ * {@link VariantParameterizable.hide}. Getter and setter is {@link VariantParameterizable.visible}.
19
+ *
20
+ * Scopes:
21
+ * * {@link Element}
22
+ * * {@link Variant}
23
+ * * {@link ViewerLight} Available for all light types
24
+ *
25
+ * @parser {@link parseBoolean}
26
+ */
27
+ public static readonly VISIBLE = 'visible';
28
+
29
+ /**
30
+ * Stretches or compresses some meshes. Getter and setter is {@link VariantParameterizable.scaling}.
31
+ *
32
+ * Scopes:
33
+ * * {@link Element}
34
+ * * {@link Variant}
35
+ *
36
+ * @parser {@link parseScaling}
37
+ */
38
+ public static readonly SCALING = 'scaling';
39
+
40
+ /**
41
+ * Mutates the material. Getter and setter is {@link VariantParameterizable.material}. The value of this parameter
42
+ * represents the ID of a baked-in glTF or custom created material in the {@link Variant} tree.
43
+ *
44
+ * Scopes:
45
+ * * {@link Element}
46
+ * * {@link Variant}
47
+ *
48
+ * @parser string
49
+ */
50
+ public static readonly MATERIAL = 'material';
51
+
52
+ /**
53
+ * Mutates the material color.
54
+ *
55
+ * Scopes:
56
+ * * {@link Element}
57
+ * * {@link Variant}
58
+ *
59
+ * @parser {@link parseColor}
60
+ */
61
+ public static readonly MATERIAL_COLOR = 'material.color';
62
+
63
+ /**
64
+ * Mutates the material metallness.
65
+ *
66
+ * Scopes:
67
+ * * {@link Element}
68
+ * * {@link Variant}
69
+ *
70
+ * @parser {@link parseNumber}
71
+ */
72
+ public static readonly MATERIAL_METALLNESS = 'material.metallness';
73
+
74
+ /**
75
+ * Mutates the material roughness.
76
+ *
77
+ * Scopes:
78
+ * * {@link Element}
79
+ * * {@link Variant}
80
+ *
81
+ * @parser {@link parseNumber}
82
+ */
83
+ public static readonly MATERIAL_ROUGHNESS = 'material.roughness';
84
+
85
+ /**
86
+ * Mutates whether a highlight layer should be enabled.
87
+ *
88
+ * Scopes:
89
+ * * {@link Element}
90
+ * * {@link Variant}
91
+ *
92
+ * @parser {@link parseBoolean}
93
+ */
94
+ public static readonly HIGHLIGHT_ENABLED = 'highlight.enabled';
95
+
96
+ /**
97
+ * Changes the highlight color.
98
+ *
99
+ * Scopes:
100
+ * * {@link Element}
101
+ * * {@link Variant}
102
+ *
103
+ * @parser {@link parseColor}
104
+ */
105
+ public static readonly HIGHLIGHT_COLOR = 'highlight.color';
106
+
107
+ /**
108
+ * Mutates the highlighted state. Getter and setter is {@link VariantParameterizable.highlighted}.
109
+ *
110
+ * Scopes:
111
+ * * {@link Element}
112
+ * * {@link Variant}
113
+ *
114
+ * @parser {@link parseBoolean}
115
+ */
116
+ public static readonly HIGHLIGHTED = 'highlighted';
117
+
118
+ /**
119
+ * Mutates the position relative to its origin position. Getter and setter is {@link VariantParameterizable.position}.
120
+ *
121
+ * Scopes:
122
+ * * {@link Element}
123
+ * * {@link Variant}
124
+ * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#position), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#position), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#position)
125
+ *
126
+ * @parser {@link parseVector}
127
+ */
128
+ public static readonly POSITION = 'position';
129
+
130
+ /**
131
+ * Mutates the rotation relative to its origin rotation. Getter and setter is {@link VariantParameterizable.rotation}.
132
+ *
133
+ * Scopes:
134
+ * * {@link Element}
135
+ * * {@link Variant}
136
+ *
137
+ * @parser {@link parseRotation}
138
+ */
139
+ public static readonly ROTATION = 'rotation';
140
+
141
+ /**
142
+ * Mutates whether a shadow should be casted or not.
143
+ *
144
+ * Scopes:
145
+ * * {@link Element}
146
+ * * {@link Variant}
147
+ *
148
+ * @parser {@link parseBoolean}
149
+ */
150
+ public static readonly CAST_SHADOW = 'castShadow';
151
+
152
+ /**
153
+ * Mutates from which lights a shadow should be casted.
154
+ *
155
+ * Scopes:
156
+ * * {@link Element}
157
+ * * {@link Variant}
158
+ *
159
+ * @parser {@link parseCommaSeparatedList}
160
+ */
161
+ public static readonly CAST_SHADOW_FROM_LIGHTS = 'castShadow.fromLights';
162
+
163
+ /**
164
+ * Mutates whether to receive shadows or not.
165
+ *
166
+ * Scopes:
167
+ * * {@link Element}
168
+ * * {@link Variant}
169
+ *
170
+ * @parser {@link parseBoolean}
171
+ */
172
+ public static readonly RECEIVE_SHADOWS = 'receiveShadows';
173
+
174
+ /**
175
+ * Mutates the intensity of Lights.
176
+ *
177
+ * Scopes:
178
+ * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#intensity), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#intensity), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#intensity), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#intensity)
179
+ *
180
+ * @parser {@link parseNumber}
181
+ */
182
+ public static readonly INTENSITY = 'intensity';
183
+
184
+ /**
185
+ * Mutates the direction of Lights.
186
+ *
187
+ * Scopes:
188
+ * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#direction), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#direction), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#direction), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#direction)
189
+ *
190
+ * @parser {@link parseNumber}
191
+ */
192
+ public static readonly DIRECTION = 'direction';
193
+
194
+ /**
195
+ * Mutates the angle of Lights.
196
+ *
197
+ * Scopes:
198
+ * * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#angle)
199
+ *
200
+ * @parser {@link parseNumber}
201
+ */
202
+ public static readonly ANGLE = 'angle';
203
+
204
+ /**
205
+ * Mutates the exponent of Lights.
206
+ *
207
+ * Scopes:
208
+ * * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#exponent)
209
+ *
210
+ * @parser {@link parseNumber}
211
+ */
212
+ public static readonly EXPONENT = 'exponent';
213
+
214
+ /**
215
+ * Mutates the diffuse color of Lights.
216
+ *
217
+ * Scopes:
218
+ * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#diffuse), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#diffuse), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#diffuse), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#diffuse)
219
+ *
220
+ * @parser {@link parseNumber}
221
+ */
222
+ public static readonly DIFFUSE = 'diffuse';
223
+
224
+ /**
225
+ * Mutates the specular color of Lights.
226
+ *
227
+ * Scopes:
228
+ * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#specular), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#specular), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#specular), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#specular)
229
+ *
230
+ * @parser {@link parseNumber}
231
+ */
232
+ public static readonly SPECULAR = 'specular';
233
+
234
+ /**
235
+ * Sets the environment. See [BABYLON.Scene.environmentTexture](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#environmentTexture).
236
+ *
237
+ * Usually the URL to an `*.env` file.
238
+ *
239
+ * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
240
+ *
241
+ * Scopes:
242
+ * * {@link SceneManager}
243
+ *
244
+ * @parser string
245
+ */
246
+ public static readonly ENVIRONMENT = 'environment';
247
+
248
+ /**
249
+ * Sets [BABYLON.Scene.clearColor](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#clearColor)
250
+ *
251
+ * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
252
+ *
253
+ * Scopes:
254
+ * * {@link SceneManager}
255
+ *
256
+ * @parser {@link parseColor}
257
+ */
258
+ public static readonly ENVIRONMENT_COLOR = 'environment.color';
259
+
260
+ /**
261
+ * Rotates connected textures, i.e. IBL, reflection, background, ...
262
+ * Rotation angle in degree.
263
+ *
264
+ * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
265
+ *
266
+ * Scopes:
267
+ * * {@link SceneManager}
268
+ *
269
+ * @parser {@link parseNumber}
270
+ */
271
+ public static readonly ENVIRONMENT_ROTATION = 'environment.rotation';
272
+
273
+ /**
274
+ * Intensity of IBL. Defaults to 1, usually between 0 & 2.
275
+ *
276
+ * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
277
+ *
278
+ * Scopes:
279
+ * * {@link SceneManager}
280
+ *
281
+ * @parser {@link parseNumber}
282
+ */
283
+ public static readonly ENVIRONMENT_INTENSITY = 'environment.intensity';
284
+
285
+ /**
286
+ * Background texture on a [PhotoDome](https://doc.babylonjs.com/divingDeeper/environment/360PhotoDome).
287
+ * Just background, no IBL or reflection.
288
+ *
289
+ * Recommended format is `*.jpg`. HDR files are not supported as background but can be converted to `*.jpg` using
290
+ * tools like Photoshop, Gimp or various free online converters.
291
+ *
292
+ * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
293
+ *
294
+ * Scopes:
295
+ * * {@link SceneManager}
296
+ *
297
+ * @parser string
298
+ */
299
+ public static readonly ENVIRONMENT_BACKGROUND = 'environment.background';
300
+
301
+ /**
302
+ * If `true`, sets a `scene.environmentTexture` and creates a *BackgroundHelper* Node (via
303
+ * [scene.createDefaultEnvironment](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#createDefaultEnvironment))
304
+ * with two subnodes/meshes:
305
+ * - BackgroundPlane
306
+ * - BackgroundSkybox
307
+ *
308
+ * The value of this parameter is ignored if {@link ENVIRONMENT_BACKGROUND} is also set.
309
+ *
310
+ * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
311
+ *
312
+ * Scopes:
313
+ * * {@link SceneManager}
314
+ *
315
+ * @parser {@link parseBoolean}
316
+ */
317
+ public static readonly ENVIRONMENT_USEDEFAULT = 'environment.usedefault';
318
+
319
+ /**
320
+ * The {@link ParameterDeclarations} for all parameters in this class.
321
+ */
322
+ public static get declarations(): ParameterDeclarations {
323
+ return {
324
+ [Parameter.VISIBLE]: { type: 'boolean', parser: Parameter.parseBoolean },
325
+ [Parameter.SCALING]: { type: 'number', parser: Parameter.parseNumber },
326
+ [Parameter.POSITION]: { type: 'vector', parser: Parameter.parseVector },
327
+ [Parameter.ROTATION]: { type: 'vector', parser: Parameter.parseVector },
328
+ [Parameter.HIGHLIGHTED]: { type: 'boolean', parser: Parameter.parseBoolean },
329
+ [Parameter.MATERIAL]: { type: 'string' },
330
+ [Parameter.MATERIAL_COLOR]: { type: 'color', parser: Parameter.parseColor },
331
+ [Parameter.MATERIAL_METALLNESS]: { type: 'number', parser: Parameter.parseNumber },
332
+ [Parameter.MATERIAL_ROUGHNESS]: { type: 'number', parser: Parameter.parseNumber },
333
+ [Parameter.HIGHLIGHT_ENABLED]: { type: 'boolean', parser: Parameter.parseBoolean },
334
+ [Parameter.HIGHLIGHT_COLOR]: { type: 'color', parser: Parameter.parseColor },
335
+ [Parameter.HIGHLIGHTED]: { type: 'boolean', parser: Parameter.parseBoolean },
336
+ [Parameter.CAST_SHADOW]: { type: 'boolean', parser: Parameter.parseBoolean },
337
+ [Parameter.CAST_SHADOW_FROM_LIGHTS]: { type: 'csl', parser: Parameter.parseCommaSeparatedList },
338
+ [Parameter.RECEIVE_SHADOWS]: { type: 'boolean', parser: Parameter.parseBoolean },
339
+ [Parameter.INTENSITY]: { type: 'number', parser: Parameter.parseNumber },
340
+ [Parameter.DIRECTION]: { type: 'vector', parser: Parameter.parseVector },
341
+ [Parameter.ANGLE]: { type: 'number', parser: Parameter.parseNumber },
342
+ [Parameter.EXPONENT]: { type: 'number', parser: Parameter.parseNumber },
343
+ [Parameter.DIFFUSE]: { type: 'color', parser: Parameter.parseColor },
344
+ [Parameter.SPECULAR]: { type: 'color', parser: Parameter.parseColor },
345
+ [Parameter.ENVIRONMENT]: { type: 'string' },
346
+ [Parameter.ENVIRONMENT_COLOR]: { type: 'color', parser: Parameter.parseColor },
347
+ [Parameter.ENVIRONMENT_ROTATION]: { type: 'number', parser: Parameter.parseNumber },
348
+ [Parameter.ENVIRONMENT_INTENSITY]: { type: 'number', parser: Parameter.parseNumber },
349
+ [Parameter.ENVIRONMENT_BACKGROUND]: { type: 'string' },
350
+ [Parameter.ENVIRONMENT_USEDEFAULT]: { type: 'boolean', parser: Parameter.parseBoolean },
351
+ };
352
+ }
353
+
354
+ /**
355
+ * The default {@link ParameterValue}s returned as {@link ParameterBag} for a set of parameters in this class.
356
+ */
357
+ public static get defaultValues(): ParameterBag {
358
+ return {
359
+ [Parameter.SCALING]: '(1, 1, 1)',
360
+ [Parameter.POSITION]: '(0, 0, 0)',
361
+ [Parameter.ROTATION]: '(0, 0, 0)',
362
+ };
363
+ }
364
+
365
+ /**
366
+ * Gets the {@link ParameterDeclaration} for a given {@link Parameter} declared in this class.
367
+ */
368
+ public static getDeclaration(parameter: string): ParameterDeclaration {
369
+ return Parameter.declarations[parameter];
370
+ }
371
+
372
+ /**
373
+ * Gets the default {@link ParameterValue} for a given {@link Parameter} declared in this class.
374
+ */
375
+ public static getDefaultValue(parameter: string): ParameterValue {
376
+ return Parameter.defaultValues[parameter];
377
+ }
378
+
379
+ /**
380
+ * All parameters defined in this class.
381
+ */
382
+ public static get all() {
383
+ const all: string[] = [];
384
+ for (const parameter in Parameter) {
385
+ const property = Object.getOwnPropertyDescriptor(Parameter, parameter);
386
+ if (parameter.toUpperCase() === parameter && property && isString(property.value)) {
387
+ all.push(property.value);
388
+ }
389
+ }
390
+ return all;
391
+ }
392
+
393
+ /**
394
+ * Asserts whether given parameter is declared and valid.
395
+ */
396
+ public static assertParameter(parameterDeclaration: ParameterDeclarations, parameter: string, value: ParameterValue) {
397
+ if (!(parameter in parameterDeclaration)) {
398
+ // This is a valid case since we are not able to check parameters that are not declared.
399
+ // We just ignore parameters that are not declared.
400
+ return;
401
+ }
402
+ const declaration = parameterDeclaration[parameter];
403
+ const genericError = `"${value}" is not a valid value for parameter "${parameter}" of type "${declaration.type}".`;
404
+ if (declaration.parser) {
405
+ try {
406
+ declaration.parser(value);
407
+ } catch (e: any) {
408
+ throw Error(`${genericError} ${e.message}`);
409
+ }
410
+ }
411
+ switch (declaration.type) {
412
+ case 'select':
413
+ if (!declaration.options) {
414
+ throw Error(`No options defined for parameter declaration "${parameter}" of type "${declaration.type}".`);
415
+ }
416
+ if (declaration.options.indexOf(value) === -1) {
417
+ throw Error(genericError + ` Valid values are: "${declaration.options.join('", "')}".`);
418
+ }
419
+ break;
420
+ }
421
+ }
422
+
423
+ /**
424
+ * Parses given {@link ParameterBag} with given {@link ParameterDeclarations}.
425
+ */
426
+ public static parseFromDeclarations(
427
+ declarations: ParameterDeclarations,
428
+ parameterBag: ParameterBag
429
+ ): ParsedParameterBag {
430
+ const parameters: ParsedParameterBag = {};
431
+ for (const parameter in parameterBag) {
432
+ const value = get(parameterBag, parameter);
433
+ parameters[parameter] = value;
434
+ const declaration: ParameterDeclaration = declarations[parameter];
435
+ if (declaration) {
436
+ if (!isEmpty(value) && declaration.parser) {
437
+ parameters[parameter] = declaration.parser(value);
438
+ }
439
+ }
440
+ }
441
+ return parameters;
442
+ }
443
+
444
+ /**
445
+ * Parses a string of format `'(x,y,z)'` to a `Vector3`.
446
+ */
447
+ public static parseVector(value: ParameterValue): Vector3 {
448
+ if (!isString(value)) {
449
+ throw new Error(`Unable to convert "${value}" into a Vector: not a string.`);
450
+ }
451
+ let cleanedValue = value.split(' ').join('');
452
+ if (cleanedValue.startsWith('(') && cleanedValue.endsWith(')')) {
453
+ cleanedValue = cleanedValue.substring(1, cleanedValue.length - 1);
454
+ const [x, y, z] = cleanedValue.split(',').map(value => parseFloat(value));
455
+ return new Vector3(x, y, z);
456
+ } else {
457
+ throw new Error(`Unable to parse "${value}" to a Vector: expected "(x,y,z)".`);
458
+ }
459
+ }
460
+
461
+ /**
462
+ * Stringifies a Vector3 to format `(x,y,z)`.
463
+ */
464
+ public static stringifyVector(value: Vector3): string {
465
+ return `(${value.x},${value.y},${value.z})`;
466
+ }
467
+
468
+ /**
469
+ * Parses a string of format `'(x,y,z)'` with angular degrees to a `Vector3` with rotation information in radians.
470
+ */
471
+ public static parseRotation(value: ParameterValue): Vector3 {
472
+ const rotation = Parameter.parseVector(value);
473
+ const deg2rad = function (deg: number) {
474
+ return (deg * Math.PI) / 180;
475
+ };
476
+ return rotation.set(deg2rad(rotation.x), deg2rad(rotation.y), deg2rad(rotation.z));
477
+ }
478
+
479
+ /**
480
+ * Parses a string of format `'(x,y,z)'` or a simple `number` to a `Vector3` for scaling.
481
+ */
482
+ public static parseScaling(value: ParameterValue): Vector3 {
483
+ let scaling = new Vector3();
484
+ if (isString(value)) {
485
+ const cleanedFactor = value.split(' ').join('');
486
+ if (cleanedFactor.startsWith('(') && cleanedFactor.endsWith(')')) {
487
+ scaling = Parameter.parseVector(cleanedFactor);
488
+ } else {
489
+ const _factor = parseFloat(value);
490
+ scaling = new Vector3(_factor, _factor, _factor);
491
+ }
492
+ } else if (isNumber(value)) {
493
+ scaling = new Vector3(value, value, value);
494
+ } else {
495
+ throw new Error(`Unable to convert "${value}" to a Vector: expected "(x,y,z)".`);
496
+ }
497
+ return scaling;
498
+ }
499
+
500
+ /**
501
+ * Parses a string of format `'#rrggbb'` or `'(r,g,b)'` to a `Color3`.
502
+ */
503
+ public static parseColor(value: ParameterValue): Color3 {
504
+ const cleanedValue = value.toString().split(' ').join('');
505
+ if (cleanedValue.startsWith('#')) {
506
+ return Color3.FromHexString(value.toString());
507
+ }
508
+ if (cleanedValue.startsWith('(') && cleanedValue.endsWith(')')) {
509
+ const rgb = cleanedValue.substring(1, cleanedValue.length - 1);
510
+ const [r, g, b] = rgb.split(',').map(value => parseFloat(value));
511
+ return Color3.FromInts(r, g, b);
512
+ }
513
+ const humanReadable = capitalize(cleanedValue);
514
+ // disable lint for this rule as there is no smoother option for checking static class functions (eg Color.Red())
515
+ // eslint-disable-next-line no-prototype-builtins
516
+ if (Color3.hasOwnProperty(humanReadable)) {
517
+ // @ts-ignore same as above
518
+ return Color3[humanReadable]();
519
+ }
520
+ throw new Error(
521
+ `Unable to parse "${value}" to a Color: expected "#rrggbb", "(r,g,b)" or any human readable property implemented in Color3.`
522
+ );
523
+ }
524
+
525
+ /**
526
+ * Parses a `boolean` string (`'true'`/`'1'` or `'false'`/`'0'`) or `number` (`1` or `0`) to a `boolean` or
527
+ * `undefined`.
528
+ */
529
+ public static parseBoolean(value: ParameterValue): boolean {
530
+ if (value.toString() === 'true' || value.toString() === '1') {
531
+ return true;
532
+ } else if (value.toString() === 'false' || value.toString() === '0') {
533
+ return false;
534
+ }
535
+ throw new Error(`Unable to parse "${value}" to a boolean.`);
536
+ }
537
+
538
+ /**
539
+ * Parses a number `string` to a `number`.
540
+ */
541
+ public static parseNumber(value: ParameterValue): number {
542
+ return parseFloat(value.toString());
543
+ }
544
+
545
+ /**
546
+ * Parses a string with comma separated values to a list of strings.
547
+ */
548
+ public static parseCommaSeparatedList(value: ParameterValue): string[] {
549
+ return value
550
+ .toString()
551
+ .split(',')
552
+ .map(s => s.trim());
553
+ }
554
+ }