@combeenation/3d-viewer 7.1.3 → 8.0.0

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 (106) 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 -153
  7. package/dist/lib-cjs/api/classes/element.js +672 -672
  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 +351 -351
  15. package/dist/lib-cjs/api/classes/parameter.js +524 -524
  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 +253 -253
  23. package/dist/lib-cjs/api/classes/variant.js +858 -858
  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 +213 -213
  29. package/dist/lib-cjs/api/classes/viewer.js +716 -716
  30. package/dist/lib-cjs/api/classes/viewer.js.map +1 -1
  31. package/dist/lib-cjs/api/classes/viewerError.d.ts +43 -43
  32. package/dist/lib-cjs/api/classes/viewerError.js +55 -55
  33. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
  34. package/dist/lib-cjs/api/classes/viewerLight.js +348 -348
  35. package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
  36. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  37. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
  38. package/dist/lib-cjs/api/internal/sceneSetup.js +226 -226
  39. package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
  40. package/dist/lib-cjs/api/manager/animationManager.js +126 -126
  41. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +102 -79
  42. package/dist/lib-cjs/api/manager/gltfExportManager.js +320 -242
  43. package/dist/lib-cjs/api/manager/gltfExportManager.js.map +1 -1
  44. package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
  45. package/dist/lib-cjs/api/manager/sceneManager.js +128 -128
  46. package/dist/lib-cjs/api/manager/tagManager.d.ts +116 -116
  47. package/dist/lib-cjs/api/manager/tagManager.js +444 -444
  48. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
  49. package/dist/lib-cjs/api/manager/textureLoadManager.js +97 -97
  50. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +106 -106
  51. package/dist/lib-cjs/api/manager/variantInstanceManager.js +292 -292
  52. package/dist/lib-cjs/api/store/specStorage.d.ts +32 -32
  53. package/dist/lib-cjs/api/store/specStorage.js +65 -65
  54. package/dist/lib-cjs/api/util/babylonHelper.d.ts +235 -235
  55. package/dist/lib-cjs/api/util/babylonHelper.js +753 -753
  56. package/dist/lib-cjs/api/util/globalTypes.d.ts +457 -455
  57. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  58. package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
  59. package/dist/lib-cjs/api/util/resourceHelper.js +203 -203
  60. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +44 -44
  61. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +175 -175
  62. package/dist/lib-cjs/api/util/stringHelper.d.ts +13 -13
  63. package/dist/lib-cjs/api/util/stringHelper.js +32 -32
  64. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
  65. package/dist/lib-cjs/api/util/structureHelper.js +57 -57
  66. package/dist/lib-cjs/buildinfo.json +3 -3
  67. package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
  68. package/dist/lib-cjs/index.d.ts +54 -54
  69. package/dist/lib-cjs/index.js +117 -117
  70. package/package.json +81 -81
  71. package/src/api/classes/animationInterface.ts +10 -10
  72. package/src/api/classes/dottedPath.ts +181 -181
  73. package/src/api/classes/element.ts +733 -733
  74. package/src/api/classes/event.ts +457 -457
  75. package/src/api/classes/eventBroadcaster.ts +52 -52
  76. package/src/api/classes/fuzzyMap.ts +21 -21
  77. package/src/api/classes/parameter.ts +561 -561
  78. package/src/api/classes/parameterObservable.ts +73 -73
  79. package/src/api/classes/parameterizable.ts +87 -87
  80. package/src/api/classes/placementAnimation.ts +162 -162
  81. package/src/api/classes/variant.ts +949 -949
  82. package/src/api/classes/variantInstance.ts +123 -123
  83. package/src/api/classes/variantParameterizable.ts +83 -83
  84. package/src/api/classes/viewer.ts +772 -772
  85. package/src/api/classes/viewerError.ts +63 -63
  86. package/src/api/classes/viewerLight.ts +339 -339
  87. package/src/api/internal/debugViewer.ts +90 -90
  88. package/src/api/internal/lensRendering.ts +9 -9
  89. package/src/api/internal/sceneSetup.ts +205 -205
  90. package/src/api/manager/animationManager.ts +143 -143
  91. package/src/api/manager/gltfExportManager.ts +297 -237
  92. package/src/api/manager/sceneManager.ts +134 -134
  93. package/src/api/manager/tagManager.ts +477 -477
  94. package/src/api/manager/textureLoadManager.ts +95 -95
  95. package/src/api/manager/variantInstanceManager.ts +309 -309
  96. package/src/api/store/specStorage.ts +68 -68
  97. package/src/api/util/babylonHelper.ts +823 -823
  98. package/src/api/util/globalTypes.ts +527 -525
  99. package/src/api/util/resourceHelper.ts +191 -191
  100. package/src/api/util/sceneLoaderHelper.ts +170 -170
  101. package/src/api/util/stringHelper.ts +30 -30
  102. package/src/api/util/structureHelper.ts +58 -58
  103. package/src/buildinfo.json +3 -3
  104. package/src/dev.ts +62 -62
  105. package/src/index.ts +103 -103
  106. package/src/types.d.ts +38 -38
@@ -1,351 +1,351 @@
1
- import { Color3 } from '@babylonjs/core/Maths/math.color';
2
- import { Vector3 } from '@babylonjs/core/Maths/math.vector';
3
- /**
4
- * This `Parameter` class defines all parameters that can be consumed and committed by a {@link ParameterObservable}.
5
- * Use {@link ParameterObservable.addParameterObserver} or {@link ParameterObservable.commitParameters} to either add or
6
- * commit parameters on your observable objects.
7
- */
8
- export declare class Parameter {
9
- /**
10
- * Constructor.
11
- */
12
- private constructor();
13
- /**
14
- * Mutates the visibility. Helper methods are {@link VariantParameterizable.show} and
15
- * {@link VariantParameterizable.hide}. Getter and setter is {@link VariantParameterizable.visible}.
16
- *
17
- * Scopes:
18
- * * {@link Element}
19
- * * {@link Variant}
20
- * * {@link ViewerLight} Available for all light types
21
- *
22
- * @parser {@link parseBoolean}
23
- */
24
- static readonly VISIBLE = "visible";
25
- /**
26
- * Stretches or compresses some meshes. Getter and setter is {@link VariantParameterizable.scaling}.
27
- *
28
- * Scopes:
29
- * * {@link Element}
30
- * * {@link Variant}
31
- *
32
- * @parser {@link parseScaling}
33
- */
34
- static readonly SCALING = "scaling";
35
- /**
36
- * Mutates the material. Getter and setter is {@link VariantParameterizable.material}. The value of this parameter
37
- * represents the ID of a baked-in glTF or custom created material in the {@link Variant} tree.
38
- *
39
- * Scopes:
40
- * * {@link Element}
41
- * * {@link Variant}
42
- *
43
- * @parser string
44
- */
45
- static readonly MATERIAL = "material";
46
- /**
47
- * Mutates the material color.
48
- *
49
- * Scopes:
50
- * * {@link Element}
51
- * * {@link Variant}
52
- *
53
- * @parser {@link parseColor}
54
- */
55
- static readonly MATERIAL_COLOR = "material.color";
56
- /**
57
- * Mutates the material metallness.
58
- *
59
- * Scopes:
60
- * * {@link Element}
61
- * * {@link Variant}
62
- *
63
- * @parser {@link parseNumber}
64
- */
65
- static readonly MATERIAL_METALLNESS = "material.metallness";
66
- /**
67
- * Mutates the material roughness.
68
- *
69
- * Scopes:
70
- * * {@link Element}
71
- * * {@link Variant}
72
- *
73
- * @parser {@link parseNumber}
74
- */
75
- static readonly MATERIAL_ROUGHNESS = "material.roughness";
76
- /**
77
- * Mutates whether a highlight layer should be enabled.
78
- *
79
- * Scopes:
80
- * * {@link Element}
81
- * * {@link Variant}
82
- *
83
- * @parser {@link parseBoolean}
84
- */
85
- static readonly HIGHLIGHT_ENABLED = "highlight.enabled";
86
- /**
87
- * Changes the highlight color.
88
- *
89
- * Scopes:
90
- * * {@link Element}
91
- * * {@link Variant}
92
- *
93
- * @parser {@link parseColor}
94
- */
95
- static readonly HIGHLIGHT_COLOR = "highlight.color";
96
- /**
97
- * Mutates the highlighted state. Getter and setter is {@link VariantParameterizable.highlighted}.
98
- *
99
- * Scopes:
100
- * * {@link Element}
101
- * * {@link Variant}
102
- *
103
- * @parser {@link parseBoolean}
104
- */
105
- static readonly HIGHLIGHTED = "highlighted";
106
- /**
107
- * Mutates the position relative to its origin position. Getter and setter is {@link VariantParameterizable.position}.
108
- *
109
- * Scopes:
110
- * * {@link Element}
111
- * * {@link Variant}
112
- * * {@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)
113
- *
114
- * @parser {@link parseVector}
115
- */
116
- static readonly POSITION = "position";
117
- /**
118
- * Mutates the rotation relative to its origin rotation. Getter and setter is {@link VariantParameterizable.rotation}.
119
- *
120
- * Scopes:
121
- * * {@link Element}
122
- * * {@link Variant}
123
- *
124
- * @parser {@link parseRotation}
125
- */
126
- static readonly ROTATION = "rotation";
127
- /**
128
- * Mutates whether a shadow should be casted or not.
129
- *
130
- * Scopes:
131
- * * {@link Element}
132
- * * {@link Variant}
133
- *
134
- * @parser {@link parseBoolean}
135
- */
136
- static readonly CAST_SHADOW = "castShadow";
137
- /**
138
- * Mutates from which lights a shadow should be casted.
139
- *
140
- * Scopes:
141
- * * {@link Element}
142
- * * {@link Variant}
143
- *
144
- * @parser {@link parseCommaSeparatedList}
145
- */
146
- static readonly CAST_SHADOW_FROM_LIGHTS = "castShadow.fromLights";
147
- /**
148
- * Mutates whether to receive shadows or not.
149
- *
150
- * Scopes:
151
- * * {@link Element}
152
- * * {@link Variant}
153
- *
154
- * @parser {@link parseBoolean}
155
- */
156
- static readonly RECEIVE_SHADOWS = "receiveShadows";
157
- /**
158
- * Mutates the intensity of Lights.
159
- *
160
- * Scopes:
161
- * * {@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)
162
- *
163
- * @parser {@link parseNumber}
164
- */
165
- static readonly INTENSITY = "intensity";
166
- /**
167
- * Mutates the direction of Lights.
168
- *
169
- * Scopes:
170
- * * {@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)
171
- *
172
- * @parser {@link parseNumber}
173
- */
174
- static readonly DIRECTION = "direction";
175
- /**
176
- * Mutates the angle of Lights.
177
- *
178
- * Scopes:
179
- * * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#angle)
180
- *
181
- * @parser {@link parseNumber}
182
- */
183
- static readonly ANGLE = "angle";
184
- /**
185
- * Mutates the exponent of Lights.
186
- *
187
- * Scopes:
188
- * * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#exponent)
189
- *
190
- * @parser {@link parseNumber}
191
- */
192
- static readonly EXPONENT = "exponent";
193
- /**
194
- * Mutates the diffuse color of Lights.
195
- *
196
- * Scopes:
197
- * * {@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)
198
- *
199
- * @parser {@link parseNumber}
200
- */
201
- static readonly DIFFUSE = "diffuse";
202
- /**
203
- * Mutates the specular color of Lights.
204
- *
205
- * Scopes:
206
- * * {@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)
207
- *
208
- * @parser {@link parseNumber}
209
- */
210
- static readonly SPECULAR = "specular";
211
- /**
212
- * Sets the environment. See [BABYLON.Scene.environmentTexture](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#environmentTexture).
213
- *
214
- * Usually the URL to an `*.env` file.
215
- *
216
- * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
217
- *
218
- * Scopes:
219
- * * {@link SceneManager}
220
- *
221
- * @parser string
222
- */
223
- static readonly ENVIRONMENT = "environment";
224
- /**
225
- * Sets [BABYLON.Scene.clearColor](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#clearColor)
226
- *
227
- * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
228
- *
229
- * Scopes:
230
- * * {@link SceneManager}
231
- *
232
- * @parser {@link parseColor}
233
- */
234
- static readonly ENVIRONMENT_COLOR = "environment.color";
235
- /**
236
- * Rotates connected textures, i.e. IBL, reflection, background, ...
237
- * Rotation angle in degree.
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 {@link parseNumber}
245
- */
246
- static readonly ENVIRONMENT_ROTATION = "environment.rotation";
247
- /**
248
- * Intensity of IBL. Defaults to 1, usually between 0 & 2.
249
- *
250
- * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
251
- *
252
- * Scopes:
253
- * * {@link SceneManager}
254
- *
255
- * @parser {@link parseNumber}
256
- */
257
- static readonly ENVIRONMENT_INTENSITY = "environment.intensity";
258
- /**
259
- * Background texture on a [PhotoDome](https://doc.babylonjs.com/divingDeeper/environment/360PhotoDome).
260
- * Just background, no IBL or reflection.
261
- *
262
- * Recommended format is `*.jpg`. HDR files are not supported as background but can be converted to `*.jpg` using
263
- * tools like Photoshop, Gimp or various free online converters.
264
- *
265
- * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
266
- *
267
- * Scopes:
268
- * * {@link SceneManager}
269
- *
270
- * @parser string
271
- */
272
- static readonly ENVIRONMENT_BACKGROUND = "environment.background";
273
- /**
274
- * If `true`, sets a `scene.environmentTexture` and creates a *BackgroundHelper* Node (via
275
- * [scene.createDefaultEnvironment](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#createDefaultEnvironment))
276
- * with two subnodes/meshes:
277
- * - BackgroundPlane
278
- * - BackgroundSkybox
279
- *
280
- * The value of this parameter is ignored if {@link ENVIRONMENT_BACKGROUND} is also set.
281
- *
282
- * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
283
- *
284
- * Scopes:
285
- * * {@link SceneManager}
286
- *
287
- * @parser {@link parseBoolean}
288
- */
289
- static readonly ENVIRONMENT_USEDEFAULT = "environment.usedefault";
290
- /**
291
- * The {@link ParameterDeclarations} for all parameters in this class.
292
- */
293
- static get declarations(): ParameterDeclarations;
294
- /**
295
- * The default {@link ParameterValue}s returned as {@link ParameterBag} for a set of parameters in this class.
296
- */
297
- static get defaultValues(): ParameterBag;
298
- /**
299
- * Gets the {@link ParameterDeclaration} for a given {@link Parameter} declared in this class.
300
- */
301
- static getDeclaration(parameter: string): ParameterDeclaration;
302
- /**
303
- * Gets the default {@link ParameterValue} for a given {@link Parameter} declared in this class.
304
- */
305
- static getDefaultValue(parameter: string): ParameterValue;
306
- /**
307
- * All parameters defined in this class.
308
- */
309
- static get all(): string[];
310
- /**
311
- * Asserts whether given parameter is declared and valid.
312
- */
313
- static assertParameter(parameterDeclaration: ParameterDeclarations, parameter: string, value: ParameterValue): void;
314
- /**
315
- * Parses given {@link ParameterBag} with given {@link ParameterDeclarations}.
316
- */
317
- static parseFromDeclarations(declarations: ParameterDeclarations, parameterBag: ParameterBag): ParsedParameterBag;
318
- /**
319
- * Parses a string of format `'(x,y,z)'` to a `Vector3`.
320
- */
321
- static parseVector(value: ParameterValue): Vector3;
322
- /**
323
- * Stringifies a Vector3 to format `(x,y,z)`.
324
- */
325
- static stringifyVector(value: Vector3): string;
326
- /**
327
- * Parses a string of format `'(x,y,z)'` with angular degrees to a `Vector3` with rotation information in radians.
328
- */
329
- static parseRotation(value: ParameterValue): Vector3;
330
- /**
331
- * Parses a string of format `'(x,y,z)'` or a simple `number` to a `Vector3` for scaling.
332
- */
333
- static parseScaling(value: ParameterValue): Vector3;
334
- /**
335
- * Parses a string of format `'#rrggbb'` or `'(r,g,b)'` to a `Color3`.
336
- */
337
- static parseColor(value: ParameterValue): Color3;
338
- /**
339
- * Parses a `boolean` string (`'true'`/`'1'` or `'false'`/`'0'`) or `number` (`1` or `0`) to a `boolean` or
340
- * `undefined`.
341
- */
342
- static parseBoolean(value: ParameterValue): boolean;
343
- /**
344
- * Parses a number `string` to a `number`.
345
- */
346
- static parseNumber(value: ParameterValue): number;
347
- /**
348
- * Parses a string with comma separated values to a list of strings.
349
- */
350
- static parseCommaSeparatedList(value: ParameterValue): string[];
351
- }
1
+ import { Color3 } from '@babylonjs/core/Maths/math.color';
2
+ import { Vector3 } from '@babylonjs/core/Maths/math.vector';
3
+ /**
4
+ * This `Parameter` class defines all parameters that can be consumed and committed by a {@link ParameterObservable}.
5
+ * Use {@link ParameterObservable.addParameterObserver} or {@link ParameterObservable.commitParameters} to either add or
6
+ * commit parameters on your observable objects.
7
+ */
8
+ export declare class Parameter {
9
+ /**
10
+ * Constructor.
11
+ */
12
+ private constructor();
13
+ /**
14
+ * Mutates the visibility. Helper methods are {@link VariantParameterizable.show} and
15
+ * {@link VariantParameterizable.hide}. Getter and setter is {@link VariantParameterizable.visible}.
16
+ *
17
+ * Scopes:
18
+ * * {@link Element}
19
+ * * {@link Variant}
20
+ * * {@link ViewerLight} Available for all light types
21
+ *
22
+ * @parser {@link parseBoolean}
23
+ */
24
+ static readonly VISIBLE = "visible";
25
+ /**
26
+ * Stretches or compresses some meshes. Getter and setter is {@link VariantParameterizable.scaling}.
27
+ *
28
+ * Scopes:
29
+ * * {@link Element}
30
+ * * {@link Variant}
31
+ *
32
+ * @parser {@link parseScaling}
33
+ */
34
+ static readonly SCALING = "scaling";
35
+ /**
36
+ * Mutates the material. Getter and setter is {@link VariantParameterizable.material}. The value of this parameter
37
+ * represents the ID of a baked-in glTF or custom created material in the {@link Variant} tree.
38
+ *
39
+ * Scopes:
40
+ * * {@link Element}
41
+ * * {@link Variant}
42
+ *
43
+ * @parser string
44
+ */
45
+ static readonly MATERIAL = "material";
46
+ /**
47
+ * Mutates the material color.
48
+ *
49
+ * Scopes:
50
+ * * {@link Element}
51
+ * * {@link Variant}
52
+ *
53
+ * @parser {@link parseColor}
54
+ */
55
+ static readonly MATERIAL_COLOR = "material.color";
56
+ /**
57
+ * Mutates the material metallness.
58
+ *
59
+ * Scopes:
60
+ * * {@link Element}
61
+ * * {@link Variant}
62
+ *
63
+ * @parser {@link parseNumber}
64
+ */
65
+ static readonly MATERIAL_METALLNESS = "material.metallness";
66
+ /**
67
+ * Mutates the material roughness.
68
+ *
69
+ * Scopes:
70
+ * * {@link Element}
71
+ * * {@link Variant}
72
+ *
73
+ * @parser {@link parseNumber}
74
+ */
75
+ static readonly MATERIAL_ROUGHNESS = "material.roughness";
76
+ /**
77
+ * Mutates whether a highlight layer should be enabled.
78
+ *
79
+ * Scopes:
80
+ * * {@link Element}
81
+ * * {@link Variant}
82
+ *
83
+ * @parser {@link parseBoolean}
84
+ */
85
+ static readonly HIGHLIGHT_ENABLED = "highlight.enabled";
86
+ /**
87
+ * Changes the highlight color.
88
+ *
89
+ * Scopes:
90
+ * * {@link Element}
91
+ * * {@link Variant}
92
+ *
93
+ * @parser {@link parseColor}
94
+ */
95
+ static readonly HIGHLIGHT_COLOR = "highlight.color";
96
+ /**
97
+ * Mutates the highlighted state. Getter and setter is {@link VariantParameterizable.highlighted}.
98
+ *
99
+ * Scopes:
100
+ * * {@link Element}
101
+ * * {@link Variant}
102
+ *
103
+ * @parser {@link parseBoolean}
104
+ */
105
+ static readonly HIGHLIGHTED = "highlighted";
106
+ /**
107
+ * Mutates the position relative to its origin position. Getter and setter is {@link VariantParameterizable.position}.
108
+ *
109
+ * Scopes:
110
+ * * {@link Element}
111
+ * * {@link Variant}
112
+ * * {@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)
113
+ *
114
+ * @parser {@link parseVector}
115
+ */
116
+ static readonly POSITION = "position";
117
+ /**
118
+ * Mutates the rotation relative to its origin rotation. Getter and setter is {@link VariantParameterizable.rotation}.
119
+ *
120
+ * Scopes:
121
+ * * {@link Element}
122
+ * * {@link Variant}
123
+ *
124
+ * @parser {@link parseRotation}
125
+ */
126
+ static readonly ROTATION = "rotation";
127
+ /**
128
+ * Mutates whether a shadow should be casted or not.
129
+ *
130
+ * Scopes:
131
+ * * {@link Element}
132
+ * * {@link Variant}
133
+ *
134
+ * @parser {@link parseBoolean}
135
+ */
136
+ static readonly CAST_SHADOW = "castShadow";
137
+ /**
138
+ * Mutates from which lights a shadow should be casted.
139
+ *
140
+ * Scopes:
141
+ * * {@link Element}
142
+ * * {@link Variant}
143
+ *
144
+ * @parser {@link parseCommaSeparatedList}
145
+ */
146
+ static readonly CAST_SHADOW_FROM_LIGHTS = "castShadow.fromLights";
147
+ /**
148
+ * Mutates whether to receive shadows or not.
149
+ *
150
+ * Scopes:
151
+ * * {@link Element}
152
+ * * {@link Variant}
153
+ *
154
+ * @parser {@link parseBoolean}
155
+ */
156
+ static readonly RECEIVE_SHADOWS = "receiveShadows";
157
+ /**
158
+ * Mutates the intensity of Lights.
159
+ *
160
+ * Scopes:
161
+ * * {@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)
162
+ *
163
+ * @parser {@link parseNumber}
164
+ */
165
+ static readonly INTENSITY = "intensity";
166
+ /**
167
+ * Mutates the direction of Lights.
168
+ *
169
+ * Scopes:
170
+ * * {@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)
171
+ *
172
+ * @parser {@link parseNumber}
173
+ */
174
+ static readonly DIRECTION = "direction";
175
+ /**
176
+ * Mutates the angle of Lights.
177
+ *
178
+ * Scopes:
179
+ * * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#angle)
180
+ *
181
+ * @parser {@link parseNumber}
182
+ */
183
+ static readonly ANGLE = "angle";
184
+ /**
185
+ * Mutates the exponent of Lights.
186
+ *
187
+ * Scopes:
188
+ * * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#exponent)
189
+ *
190
+ * @parser {@link parseNumber}
191
+ */
192
+ static readonly EXPONENT = "exponent";
193
+ /**
194
+ * Mutates the diffuse color of Lights.
195
+ *
196
+ * Scopes:
197
+ * * {@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)
198
+ *
199
+ * @parser {@link parseNumber}
200
+ */
201
+ static readonly DIFFUSE = "diffuse";
202
+ /**
203
+ * Mutates the specular color of Lights.
204
+ *
205
+ * Scopes:
206
+ * * {@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)
207
+ *
208
+ * @parser {@link parseNumber}
209
+ */
210
+ static readonly SPECULAR = "specular";
211
+ /**
212
+ * Sets the environment. See [BABYLON.Scene.environmentTexture](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#environmentTexture).
213
+ *
214
+ * Usually the URL to an `*.env` file.
215
+ *
216
+ * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
217
+ *
218
+ * Scopes:
219
+ * * {@link SceneManager}
220
+ *
221
+ * @parser string
222
+ */
223
+ static readonly ENVIRONMENT = "environment";
224
+ /**
225
+ * Sets [BABYLON.Scene.clearColor](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#clearColor)
226
+ *
227
+ * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
228
+ *
229
+ * Scopes:
230
+ * * {@link SceneManager}
231
+ *
232
+ * @parser {@link parseColor}
233
+ */
234
+ static readonly ENVIRONMENT_COLOR = "environment.color";
235
+ /**
236
+ * Rotates connected textures, i.e. IBL, reflection, background, ...
237
+ * Rotation angle in degree.
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 {@link parseNumber}
245
+ */
246
+ static readonly ENVIRONMENT_ROTATION = "environment.rotation";
247
+ /**
248
+ * Intensity of IBL. Defaults to 1, usually between 0 & 2.
249
+ *
250
+ * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
251
+ *
252
+ * Scopes:
253
+ * * {@link SceneManager}
254
+ *
255
+ * @parser {@link parseNumber}
256
+ */
257
+ static readonly ENVIRONMENT_INTENSITY = "environment.intensity";
258
+ /**
259
+ * Background texture on a [PhotoDome](https://doc.babylonjs.com/divingDeeper/environment/360PhotoDome).
260
+ * Just background, no IBL or reflection.
261
+ *
262
+ * Recommended format is `*.jpg`. HDR files are not supported as background but can be converted to `*.jpg` using
263
+ * tools like Photoshop, Gimp or various free online converters.
264
+ *
265
+ * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
266
+ *
267
+ * Scopes:
268
+ * * {@link SceneManager}
269
+ *
270
+ * @parser string
271
+ */
272
+ static readonly ENVIRONMENT_BACKGROUND = "environment.background";
273
+ /**
274
+ * If `true`, sets a `scene.environmentTexture` and creates a *BackgroundHelper* Node (via
275
+ * [scene.createDefaultEnvironment](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#createDefaultEnvironment))
276
+ * with two subnodes/meshes:
277
+ * - BackgroundPlane
278
+ * - BackgroundSkybox
279
+ *
280
+ * The value of this parameter is ignored if {@link ENVIRONMENT_BACKGROUND} is also set.
281
+ *
282
+ * See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
283
+ *
284
+ * Scopes:
285
+ * * {@link SceneManager}
286
+ *
287
+ * @parser {@link parseBoolean}
288
+ */
289
+ static readonly ENVIRONMENT_USEDEFAULT = "environment.usedefault";
290
+ /**
291
+ * The {@link ParameterDeclarations} for all parameters in this class.
292
+ */
293
+ static get declarations(): ParameterDeclarations;
294
+ /**
295
+ * The default {@link ParameterValue}s returned as {@link ParameterBag} for a set of parameters in this class.
296
+ */
297
+ static get defaultValues(): ParameterBag;
298
+ /**
299
+ * Gets the {@link ParameterDeclaration} for a given {@link Parameter} declared in this class.
300
+ */
301
+ static getDeclaration(parameter: string): ParameterDeclaration;
302
+ /**
303
+ * Gets the default {@link ParameterValue} for a given {@link Parameter} declared in this class.
304
+ */
305
+ static getDefaultValue(parameter: string): ParameterValue;
306
+ /**
307
+ * All parameters defined in this class.
308
+ */
309
+ static get all(): string[];
310
+ /**
311
+ * Asserts whether given parameter is declared and valid.
312
+ */
313
+ static assertParameter(parameterDeclaration: ParameterDeclarations, parameter: string, value: ParameterValue): void;
314
+ /**
315
+ * Parses given {@link ParameterBag} with given {@link ParameterDeclarations}.
316
+ */
317
+ static parseFromDeclarations(declarations: ParameterDeclarations, parameterBag: ParameterBag): ParsedParameterBag;
318
+ /**
319
+ * Parses a string of format `'(x,y,z)'` to a `Vector3`.
320
+ */
321
+ static parseVector(value: ParameterValue): Vector3;
322
+ /**
323
+ * Stringifies a Vector3 to format `(x,y,z)`.
324
+ */
325
+ static stringifyVector(value: Vector3): string;
326
+ /**
327
+ * Parses a string of format `'(x,y,z)'` with angular degrees to a `Vector3` with rotation information in radians.
328
+ */
329
+ static parseRotation(value: ParameterValue): Vector3;
330
+ /**
331
+ * Parses a string of format `'(x,y,z)'` or a simple `number` to a `Vector3` for scaling.
332
+ */
333
+ static parseScaling(value: ParameterValue): Vector3;
334
+ /**
335
+ * Parses a string of format `'#rrggbb'` or `'(r,g,b)'` to a `Color3`.
336
+ */
337
+ static parseColor(value: ParameterValue): Color3;
338
+ /**
339
+ * Parses a `boolean` string (`'true'`/`'1'` or `'false'`/`'0'`) or `number` (`1` or `0`) to a `boolean` or
340
+ * `undefined`.
341
+ */
342
+ static parseBoolean(value: ParameterValue): boolean;
343
+ /**
344
+ * Parses a number `string` to a `number`.
345
+ */
346
+ static parseNumber(value: ParameterValue): number;
347
+ /**
348
+ * Parses a string with comma separated values to a list of strings.
349
+ */
350
+ static parseCommaSeparatedList(value: ParameterValue): string[];
351
+ }