@combeenation/3d-viewer 5.1.2 → 5.2.0-alpha1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +111 -111
- package/dist/lib-cjs/buildinfo.json +3 -3
- package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -0
- package/dist/lib-cjs/{api → src/api}/classes/animationInterface.d.ts +8 -8
- package/dist/lib-cjs/src/api/classes/animationInterface.js +3 -0
- package/dist/lib-cjs/src/api/classes/animationInterface.js.map +1 -0
- package/dist/{lib-es6 → lib-cjs/src}/api/classes/dottedPath.d.ts +79 -79
- package/dist/lib-cjs/src/api/classes/dottedPath.js +167 -0
- package/dist/lib-cjs/src/api/classes/dottedPath.js.map +1 -0
- package/dist/lib-cjs/{api → src/api}/classes/element.d.ts +149 -149
- package/dist/lib-cjs/src/api/classes/element.js +669 -0
- package/dist/lib-cjs/src/api/classes/element.js.map +1 -0
- package/dist/{lib-es6 → lib-cjs/src}/api/classes/event.d.ts +326 -326
- package/dist/lib-cjs/src/api/classes/event.js +350 -0
- package/dist/lib-cjs/src/api/classes/event.js.map +1 -0
- package/dist/{lib-es6 → lib-cjs/src}/api/classes/eventBroadcaster.d.ts +26 -26
- package/dist/lib-cjs/src/api/classes/eventBroadcaster.js +50 -0
- package/dist/lib-cjs/src/api/classes/eventBroadcaster.js.map +1 -0
- package/dist/{lib-es6 → lib-cjs/src}/api/classes/parameter.d.ts +336 -336
- package/dist/lib-cjs/src/api/classes/parameter.js +462 -0
- package/dist/lib-cjs/src/api/classes/parameter.js.map +1 -0
- package/dist/lib-cjs/{api → src/api}/classes/parameterObservable.d.ts +36 -36
- package/dist/lib-cjs/src/api/classes/parameterObservable.js +98 -0
- package/dist/lib-cjs/src/api/classes/parameterObservable.js.map +1 -0
- package/dist/lib-cjs/{api → src/api}/classes/parameterizable.d.ts +15 -15
- package/dist/lib-cjs/src/api/classes/parameterizable.js +103 -0
- package/dist/lib-cjs/src/api/classes/parameterizable.js.map +1 -0
- package/dist/lib-cjs/{api → src/api}/classes/placementAnimation.d.ts +45 -44
- package/dist/lib-cjs/{api → src/api}/classes/placementAnimation.js +175 -163
- package/dist/lib-cjs/src/api/classes/placementAnimation.js.map +1 -0
- package/dist/{lib-es6 → lib-cjs/src}/api/classes/variant.d.ts +234 -234
- package/dist/lib-cjs/src/api/classes/variant.js +837 -0
- package/dist/lib-cjs/src/api/classes/variant.js.map +1 -0
- package/dist/lib-cjs/{api → src/api}/classes/variantInstance.d.ts +45 -45
- package/dist/lib-cjs/src/api/classes/variantInstance.js +102 -0
- package/dist/lib-cjs/src/api/classes/variantInstance.js.map +1 -0
- package/dist/{lib-es6 → lib-cjs/src}/api/classes/variantParameterizable.d.ts +17 -17
- package/dist/lib-cjs/src/api/classes/variantParameterizable.js +89 -0
- package/dist/lib-cjs/src/api/classes/variantParameterizable.js.map +1 -0
- package/dist/lib-cjs/{api → src/api}/classes/viewer.d.ts +187 -184
- package/dist/lib-cjs/src/api/classes/viewer.js +594 -0
- package/dist/lib-cjs/src/api/classes/viewer.js.map +1 -0
- package/dist/lib-cjs/{api → src/api}/classes/viewerLight.d.ts +66 -66
- package/dist/lib-cjs/src/api/classes/viewerLight.js +344 -0
- package/dist/lib-cjs/src/api/classes/viewerLight.js.map +1 -0
- package/dist/{lib-es6 → lib-cjs/src}/api/internal/lensRendering.d.ts +8 -8
- package/dist/lib-cjs/{api → src/api}/internal/lensRendering.js +11 -11
- package/dist/lib-cjs/src/api/internal/lensRendering.js.map +1 -0
- package/dist/{lib-es6 → lib-cjs/src}/api/internal/sceneSetup.d.ts +13 -13
- package/dist/lib-cjs/src/api/internal/sceneSetup.js +226 -0
- package/dist/lib-cjs/src/api/internal/sceneSetup.js.map +1 -0
- package/dist/lib-cjs/{api → src/api}/manager/animationManager.d.ts +30 -29
- package/dist/lib-cjs/src/api/manager/animationManager.js +127 -0
- package/dist/lib-cjs/src/api/manager/animationManager.js.map +1 -0
- package/dist/lib-cjs/{api → src/api}/manager/gltfExportManager.d.ts +65 -65
- package/dist/lib-cjs/src/api/manager/gltfExportManager.js +197 -0
- package/dist/lib-cjs/src/api/manager/gltfExportManager.js.map +1 -0
- package/dist/lib-cjs/{api → src/api}/manager/sceneManager.d.ts +31 -31
- package/dist/lib-cjs/src/api/manager/sceneManager.js +128 -0
- package/dist/lib-cjs/src/api/manager/sceneManager.js.map +1 -0
- package/dist/{lib-es6 → lib-cjs/src}/api/manager/variantInstanceManager.d.ts +92 -92
- package/dist/lib-cjs/src/api/manager/variantInstanceManager.js +261 -0
- package/dist/lib-cjs/src/api/manager/variantInstanceManager.js.map +1 -0
- package/dist/{lib-es6 → lib-cjs/src}/api/store/specStorage.d.ts +24 -24
- package/dist/lib-cjs/{api → src/api}/store/specStorage.js +50 -51
- package/dist/lib-cjs/src/api/store/specStorage.js.map +1 -0
- package/dist/{lib-es6 → lib-cjs/src}/api/util/babylonHelper.d.ts +174 -174
- package/dist/lib-cjs/{api → src/api}/util/babylonHelper.js +591 -611
- package/dist/lib-cjs/src/api/util/babylonHelper.js.map +1 -0
- package/dist/{lib-es6 → lib-cjs/src}/api/util/globalTypes.d.ts +366 -366
- package/dist/lib-cjs/src/api/util/globalTypes.js +2 -0
- package/dist/lib-cjs/src/api/util/globalTypes.js.map +1 -0
- package/dist/lib-cjs/{api → src/api}/util/resourceHelper.d.ts +58 -58
- package/dist/lib-cjs/src/api/util/resourceHelper.js +202 -0
- package/dist/lib-cjs/src/api/util/resourceHelper.js.map +1 -0
- package/dist/lib-cjs/{api → src/api}/util/sceneLoaderHelper.d.ts +35 -35
- package/dist/lib-cjs/{api → src/api}/util/sceneLoaderHelper.js +141 -140
- package/dist/lib-cjs/src/api/util/sceneLoaderHelper.js.map +1 -0
- package/dist/{lib-es6 → lib-cjs/src}/api/util/stringHelper.d.ts +9 -9
- package/dist/lib-cjs/{api → src/api}/util/stringHelper.js +23 -25
- package/dist/lib-cjs/src/api/util/stringHelper.js.map +1 -0
- package/dist/{lib-es6 → lib-cjs/src}/api/util/structureHelper.d.ts +9 -9
- package/dist/lib-cjs/{api → src/api}/util/structureHelper.js +48 -48
- package/dist/lib-cjs/src/api/util/structureHelper.js.map +1 -0
- package/dist/lib-cjs/{index.d.ts → src/index.d.ts} +51 -49
- package/dist/lib-cjs/{index.js → src/index.js} +110 -89
- package/dist/lib-cjs/src/index.js.map +1 -0
- package/dist/lib-es6/buildinfo.json +3 -3
- package/dist/lib-es6/es6.tsconfig.tsbuildinfo +1 -0
- package/dist/lib-es6/{api → src/api}/classes/animationInterface.d.ts +8 -8
- package/dist/lib-es6/src/api/classes/animationInterface.js +2 -0
- package/dist/lib-es6/src/api/classes/animationInterface.js.map +1 -0
- package/dist/{lib-cjs → lib-es6/src}/api/classes/dottedPath.d.ts +79 -79
- package/dist/lib-es6/src/api/classes/dottedPath.js +163 -0
- package/dist/lib-es6/src/api/classes/dottedPath.js.map +1 -0
- package/dist/lib-es6/{api → src/api}/classes/element.d.ts +149 -149
- package/dist/lib-es6/src/api/classes/element.js +665 -0
- package/dist/lib-es6/src/api/classes/element.js.map +1 -0
- package/dist/{lib-cjs → lib-es6/src}/api/classes/event.d.ts +326 -326
- package/dist/lib-es6/src/api/classes/event.js +346 -0
- package/dist/lib-es6/src/api/classes/event.js.map +1 -0
- package/dist/{lib-cjs → lib-es6/src}/api/classes/eventBroadcaster.d.ts +26 -26
- package/dist/lib-es6/src/api/classes/eventBroadcaster.js +43 -0
- package/dist/lib-es6/src/api/classes/eventBroadcaster.js.map +1 -0
- package/dist/{lib-cjs → lib-es6/src}/api/classes/parameter.d.ts +336 -336
- package/dist/lib-es6/src/api/classes/parameter.js +458 -0
- package/dist/lib-es6/src/api/classes/parameter.js.map +1 -0
- package/dist/lib-es6/{api → src/api}/classes/parameterObservable.d.ts +36 -36
- package/dist/lib-es6/src/api/classes/parameterObservable.js +94 -0
- package/dist/lib-es6/src/api/classes/parameterObservable.js.map +1 -0
- package/dist/lib-es6/{api → src/api}/classes/parameterizable.d.ts +15 -15
- package/dist/lib-es6/src/api/classes/parameterizable.js +99 -0
- package/dist/lib-es6/src/api/classes/parameterizable.js.map +1 -0
- package/dist/lib-es6/{api → src/api}/classes/placementAnimation.d.ts +45 -44
- package/dist/lib-es6/{api → src/api}/classes/placementAnimation.js +171 -160
- package/dist/lib-es6/src/api/classes/placementAnimation.js.map +1 -0
- package/dist/{lib-cjs → lib-es6/src}/api/classes/variant.d.ts +234 -234
- package/dist/lib-es6/src/api/classes/variant.js +833 -0
- package/dist/lib-es6/src/api/classes/variant.js.map +1 -0
- package/dist/lib-es6/{api → src/api}/classes/variantInstance.d.ts +45 -45
- package/dist/lib-es6/src/api/classes/variantInstance.js +98 -0
- package/dist/lib-es6/src/api/classes/variantInstance.js.map +1 -0
- package/dist/{lib-cjs → lib-es6/src}/api/classes/variantParameterizable.d.ts +17 -17
- package/dist/lib-es6/src/api/classes/variantParameterizable.js +85 -0
- package/dist/lib-es6/src/api/classes/variantParameterizable.js.map +1 -0
- package/dist/lib-es6/{api → src/api}/classes/viewer.d.ts +187 -184
- package/dist/lib-es6/src/api/classes/viewer.js +587 -0
- package/dist/lib-es6/src/api/classes/viewer.js.map +1 -0
- package/dist/lib-es6/{api → src/api}/classes/viewerLight.d.ts +66 -66
- package/dist/lib-es6/src/api/classes/viewerLight.js +317 -0
- package/dist/lib-es6/src/api/classes/viewerLight.js.map +1 -0
- package/dist/{lib-cjs → lib-es6/src}/api/internal/lensRendering.d.ts +8 -8
- package/dist/lib-es6/{api → src/api}/internal/lensRendering.js +8 -8
- package/dist/lib-es6/src/api/internal/lensRendering.js.map +1 -0
- package/dist/{lib-cjs → lib-es6/src}/api/internal/sceneSetup.d.ts +13 -13
- package/dist/lib-es6/src/api/internal/sceneSetup.js +198 -0
- package/dist/lib-es6/src/api/internal/sceneSetup.js.map +1 -0
- package/dist/lib-es6/{api → src/api}/manager/animationManager.d.ts +30 -29
- package/dist/lib-es6/src/api/manager/animationManager.js +123 -0
- package/dist/lib-es6/src/api/manager/animationManager.js.map +1 -0
- package/dist/lib-es6/{api → src/api}/manager/gltfExportManager.d.ts +65 -65
- package/dist/lib-es6/{api → src/api}/manager/gltfExportManager.js +192 -220
- package/dist/lib-es6/src/api/manager/gltfExportManager.js.map +1 -0
- package/dist/lib-es6/{api → src/api}/manager/sceneManager.d.ts +31 -31
- package/dist/lib-es6/src/api/manager/sceneManager.js +124 -0
- package/dist/lib-es6/src/api/manager/sceneManager.js.map +1 -0
- package/dist/{lib-cjs → lib-es6/src}/api/manager/variantInstanceManager.d.ts +92 -92
- package/dist/lib-es6/src/api/manager/variantInstanceManager.js +257 -0
- package/dist/lib-es6/src/api/manager/variantInstanceManager.js.map +1 -0
- package/dist/{lib-cjs → lib-es6/src}/api/store/specStorage.d.ts +24 -24
- package/dist/lib-es6/{api → src/api}/store/specStorage.js +46 -48
- package/dist/lib-es6/src/api/store/specStorage.js.map +1 -0
- package/dist/{lib-cjs → lib-es6/src}/api/util/babylonHelper.d.ts +174 -174
- package/dist/lib-es6/{api → src/api}/util/babylonHelper.js +561 -581
- package/dist/lib-es6/src/api/util/babylonHelper.js.map +1 -0
- package/dist/{lib-cjs → lib-es6/src}/api/util/globalTypes.d.ts +366 -366
- package/dist/lib-es6/src/api/util/globalTypes.js +2 -0
- package/dist/lib-es6/src/api/util/globalTypes.js.map +1 -0
- package/dist/lib-es6/{api → src/api}/util/resourceHelper.d.ts +58 -58
- package/dist/lib-es6/src/api/util/resourceHelper.js +192 -0
- package/dist/lib-es6/src/api/util/resourceHelper.js.map +1 -0
- package/dist/lib-es6/{api → src/api}/util/sceneLoaderHelper.d.ts +35 -35
- package/dist/lib-es6/{api → src/api}/util/sceneLoaderHelper.js +131 -133
- package/dist/lib-es6/src/api/util/sceneLoaderHelper.js.map +1 -0
- package/dist/{lib-cjs → lib-es6/src}/api/util/stringHelper.d.ts +9 -9
- package/dist/lib-es6/{api → src/api}/util/stringHelper.js +19 -21
- package/dist/lib-es6/src/api/util/stringHelper.js.map +1 -0
- package/dist/{lib-cjs → lib-es6/src}/api/util/structureHelper.d.ts +9 -9
- package/dist/lib-es6/{api → src/api}/util/structureHelper.js +45 -45
- package/dist/lib-es6/src/api/util/structureHelper.js.map +1 -0
- package/dist/lib-es6/{index.js → src/index.d.ts} +51 -51
- package/dist/lib-es6/{index.d.ts → src/index.js} +49 -49
- package/dist/lib-es6/src/index.js.map +1 -0
- package/dist/lib-full/lens-rendering.js +2 -0
- package/dist/lib-full/lens-rendering.js.map +1 -0
- package/dist/lib-full/main.js +3 -0
- package/dist/lib-full/main.js.LICENSE.txt +9 -0
- package/dist/lib-full/main.js.map +1 -0
- package/package.json +76 -88
- package/src/api/classes/animationInterface.ts +10 -10
- package/src/api/classes/dottedPath.ts +181 -181
- package/src/api/classes/element.ts +716 -716
- package/src/api/classes/event.ts +367 -367
- package/src/api/classes/eventBroadcaster.ts +52 -52
- package/src/api/classes/parameter.ts +494 -494
- package/src/api/classes/parameterObservable.ts +100 -100
- package/src/api/classes/parameterizable.ts +87 -87
- package/src/api/classes/placementAnimation.ts +161 -160
- package/src/api/classes/variant.ts +904 -905
- package/src/api/classes/variantInstance.ts +97 -97
- package/src/api/classes/variantParameterizable.ts +85 -85
- package/src/api/classes/viewer.ts +669 -668
- package/src/api/classes/viewerLight.ts +334 -334
- package/src/api/internal/debugViewer.ts +90 -90
- package/src/api/internal/lensRendering.ts +9 -10
- package/src/api/internal/sceneSetup.ts +204 -204
- package/src/api/manager/animationManager.ts +143 -142
- package/src/api/manager/gltfExportManager.ts +191 -191
- package/src/api/manager/sceneManager.ts +127 -127
- package/src/api/manager/variantInstanceManager.ts +265 -265
- package/src/api/store/specStorage.ts +51 -51
- package/src/api/util/babylonHelper.ts +663 -663
- package/src/api/util/globalTypes.ts +413 -413
- package/src/api/util/resourceHelper.ts +189 -189
- package/src/api/util/sceneLoaderHelper.ts +148 -147
- package/src/api/util/stringHelper.ts +23 -23
- package/src/api/util/structureHelper.ts +49 -49
- package/src/dev.ts +61 -64
- package/src/index.ts +96 -94
- package/src/types.d.ts +28 -28
- package/dist/lib-cjs/api/classes/animationInterface.js +0 -2
- package/dist/lib-cjs/api/classes/animationInterface.js.map +0 -1
- package/dist/lib-cjs/api/classes/dottedPath.js +0 -188
- package/dist/lib-cjs/api/classes/dottedPath.js.map +0 -1
- package/dist/lib-cjs/api/classes/element.js +0 -824
- package/dist/lib-cjs/api/classes/element.js.map +0 -1
- package/dist/lib-cjs/api/classes/elementParameterizable.d.ts +0 -14
- package/dist/lib-cjs/api/classes/elementParameterizable.js +0 -135
- package/dist/lib-cjs/api/classes/elementParameterizable.js.map +0 -1
- package/dist/lib-cjs/api/classes/event.js +0 -372
- package/dist/lib-cjs/api/classes/event.js.map +0 -1
- package/dist/lib-cjs/api/classes/eventBroadcaster.js +0 -54
- package/dist/lib-cjs/api/classes/eventBroadcaster.js.map +0 -1
- package/dist/lib-cjs/api/classes/parameter.js +0 -472
- package/dist/lib-cjs/api/classes/parameter.js.map +0 -1
- package/dist/lib-cjs/api/classes/parameterObservable.js +0 -102
- package/dist/lib-cjs/api/classes/parameterObservable.js.map +0 -1
- package/dist/lib-cjs/api/classes/parameterizable.js +0 -150
- package/dist/lib-cjs/api/classes/parameterizable.js.map +0 -1
- package/dist/lib-cjs/api/classes/placementAnimation.js.map +0 -1
- package/dist/lib-cjs/api/classes/variant.js +0 -1204
- package/dist/lib-cjs/api/classes/variant.js.map +0 -1
- package/dist/lib-cjs/api/classes/variantInstance.js +0 -109
- package/dist/lib-cjs/api/classes/variantInstance.js.map +0 -1
- package/dist/lib-cjs/api/classes/variantParameterizable.js +0 -100
- package/dist/lib-cjs/api/classes/variantParameterizable.js.map +0 -1
- package/dist/lib-cjs/api/classes/viewer.js +0 -732
- package/dist/lib-cjs/api/classes/viewer.js.map +0 -1
- package/dist/lib-cjs/api/classes/viewerLight.js +0 -393
- package/dist/lib-cjs/api/classes/viewerLight.js.map +0 -1
- package/dist/lib-cjs/api/internal/debugViewer.d.ts +0 -13
- package/dist/lib-cjs/api/internal/debugViewer.js +0 -87
- package/dist/lib-cjs/api/internal/debugViewer.js.map +0 -1
- package/dist/lib-cjs/api/internal/lensRendering.js.map +0 -1
- package/dist/lib-cjs/api/internal/sceneSetup.js +0 -239
- package/dist/lib-cjs/api/internal/sceneSetup.js.map +0 -1
- package/dist/lib-cjs/api/manager/animationManager.js +0 -131
- package/dist/lib-cjs/api/manager/animationManager.js.map +0 -1
- package/dist/lib-cjs/api/manager/gltfExportManager.js +0 -224
- package/dist/lib-cjs/api/manager/gltfExportManager.js.map +0 -1
- package/dist/lib-cjs/api/manager/sceneManager.js +0 -153
- package/dist/lib-cjs/api/manager/sceneManager.js.map +0 -1
- package/dist/lib-cjs/api/manager/variantInstanceManager.js +0 -336
- package/dist/lib-cjs/api/manager/variantInstanceManager.js.map +0 -1
- package/dist/lib-cjs/api/store/specStorage.js.map +0 -1
- package/dist/lib-cjs/api/util/babylonHelper.js.map +0 -1
- package/dist/lib-cjs/api/util/globalTypes.js +0 -2
- package/dist/lib-cjs/api/util/globalTypes.js.map +0 -1
- package/dist/lib-cjs/api/util/resourceHelper.js +0 -258
- package/dist/lib-cjs/api/util/resourceHelper.js.map +0 -1
- package/dist/lib-cjs/api/util/sceneLoaderHelper.js.map +0 -1
- package/dist/lib-cjs/api/util/stringHelper.js.map +0 -1
- package/dist/lib-cjs/api/util/structureHelper.js.map +0 -1
- package/dist/lib-cjs/index.js.map +0 -1
- package/dist/lib-es6/api/classes/animationInterface.js +0 -2
- package/dist/lib-es6/api/classes/animationInterface.js.map +0 -1
- package/dist/lib-es6/api/classes/dottedPath.js +0 -185
- package/dist/lib-es6/api/classes/dottedPath.js.map +0 -1
- package/dist/lib-es6/api/classes/element.js +0 -821
- package/dist/lib-es6/api/classes/element.js.map +0 -1
- package/dist/lib-es6/api/classes/event.js +0 -369
- package/dist/lib-es6/api/classes/event.js.map +0 -1
- package/dist/lib-es6/api/classes/eventBroadcaster.js +0 -51
- package/dist/lib-es6/api/classes/eventBroadcaster.js.map +0 -1
- package/dist/lib-es6/api/classes/parameter.js +0 -469
- package/dist/lib-es6/api/classes/parameter.js.map +0 -1
- package/dist/lib-es6/api/classes/parameterObservable.js +0 -99
- package/dist/lib-es6/api/classes/parameterObservable.js.map +0 -1
- package/dist/lib-es6/api/classes/parameterizable.js +0 -147
- package/dist/lib-es6/api/classes/parameterizable.js.map +0 -1
- package/dist/lib-es6/api/classes/placementAnimation.js.map +0 -1
- package/dist/lib-es6/api/classes/variant.js +0 -1199
- package/dist/lib-es6/api/classes/variant.js.map +0 -1
- package/dist/lib-es6/api/classes/variantInstance.js +0 -106
- package/dist/lib-es6/api/classes/variantInstance.js.map +0 -1
- package/dist/lib-es6/api/classes/variantParameterizable.js +0 -97
- package/dist/lib-es6/api/classes/variantParameterizable.js.map +0 -1
- package/dist/lib-es6/api/classes/viewer.js +0 -729
- package/dist/lib-es6/api/classes/viewer.js.map +0 -1
- package/dist/lib-es6/api/classes/viewerLight.js +0 -390
- package/dist/lib-es6/api/classes/viewerLight.js.map +0 -1
- package/dist/lib-es6/api/internal/debugViewer.d.ts +0 -13
- package/dist/lib-es6/api/internal/debugViewer.js +0 -84
- package/dist/lib-es6/api/internal/debugViewer.js.map +0 -1
- package/dist/lib-es6/api/internal/lensRendering.js.map +0 -1
- package/dist/lib-es6/api/internal/sceneSetup.js +0 -234
- package/dist/lib-es6/api/internal/sceneSetup.js.map +0 -1
- package/dist/lib-es6/api/manager/animationManager.js +0 -128
- package/dist/lib-es6/api/manager/animationManager.js.map +0 -1
- package/dist/lib-es6/api/manager/gltfExportManager.js.map +0 -1
- package/dist/lib-es6/api/manager/sceneManager.js +0 -150
- package/dist/lib-es6/api/manager/sceneManager.js.map +0 -1
- package/dist/lib-es6/api/manager/variantInstanceManager.js +0 -333
- package/dist/lib-es6/api/manager/variantInstanceManager.js.map +0 -1
- package/dist/lib-es6/api/store/specStorage.js.map +0 -1
- package/dist/lib-es6/api/util/babylonHelper.js.map +0 -1
- package/dist/lib-es6/api/util/globalTypes.js +0 -2
- package/dist/lib-es6/api/util/globalTypes.js.map +0 -1
- package/dist/lib-es6/api/util/resourceHelper.js +0 -248
- package/dist/lib-es6/api/util/resourceHelper.js.map +0 -1
- package/dist/lib-es6/api/util/sceneLoaderHelper.js.map +0 -1
- package/dist/lib-es6/api/util/stringHelper.js.map +0 -1
- package/dist/lib-es6/api/util/structureHelper.js.map +0 -1
- package/dist/lib-es6/index.js.map +0 -1
- package/dist/webpack-stats.json +0 -0
- package/src/buildinfo.json +0 -3
- package/src/commonjs.tsconfig.json +0 -10
- package/src/declaration.tsconfig.json +0 -8
- package/src/es6.tsconfig.json +0 -10
- package/src/pagesconfig.json +0 -81
- package/src/tsconfig.json +0 -33
- package/src/tsconfig.types.json +0 -9
|
@@ -0,0 +1,458 @@
|
|
|
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
|
+
* This `Parameter` class defines all parameters that can be consumed and committed by a {@link ParameterObservable}.
|
|
6
|
+
* Use {@link ParameterObservable.addParameterObserver} or {@link ParameterObservable.commitParameters} to either add or
|
|
7
|
+
* commit parameters on your observable objects.
|
|
8
|
+
*/
|
|
9
|
+
export class Parameter {
|
|
10
|
+
/**
|
|
11
|
+
* Constructor.
|
|
12
|
+
*/
|
|
13
|
+
constructor() { }
|
|
14
|
+
/**
|
|
15
|
+
* The {@link ParameterDeclarations} for all parameters in this class.
|
|
16
|
+
*/
|
|
17
|
+
static get declarations() {
|
|
18
|
+
const declarations = {};
|
|
19
|
+
declarations[Parameter.VISIBLE] = { type: 'boolean', parser: Parameter.parseBoolean };
|
|
20
|
+
declarations[Parameter.SCALING] = { type: 'number', parser: Parameter.parseNumber };
|
|
21
|
+
declarations[Parameter.POSITION] = { type: 'vector', parser: Parameter.parseVector };
|
|
22
|
+
declarations[Parameter.ROTATION] = { type: 'vector', parser: Parameter.parseVector };
|
|
23
|
+
declarations[Parameter.HIGHLIGHTED] = { type: 'boolean', parser: Parameter.parseBoolean };
|
|
24
|
+
declarations[Parameter.MATERIAL] = { type: 'string' };
|
|
25
|
+
declarations[Parameter.MATERIAL_COLOR] = { type: 'color', parser: Parameter.parseColor };
|
|
26
|
+
declarations[Parameter.MATERIAL_METALLNESS] = { type: 'number', parser: Parameter.parseNumber };
|
|
27
|
+
declarations[Parameter.MATERIAL_ROUGHNESS] = { type: 'number', parser: Parameter.parseNumber };
|
|
28
|
+
declarations[Parameter.HIGHLIGHT_ENABLED] = { type: 'boolean', parser: Parameter.parseBoolean };
|
|
29
|
+
declarations[Parameter.HIGHLIGHT_COLOR] = { type: 'color', parser: Parameter.parseColor };
|
|
30
|
+
declarations[Parameter.HIGHLIGHTED] = { type: 'boolean', parser: Parameter.parseBoolean };
|
|
31
|
+
declarations[Parameter.CAST_SHADOW] = { type: 'boolean', parser: Parameter.parseBoolean };
|
|
32
|
+
declarations[Parameter.CAST_SHADOW_FROM_LIGHTS] = { type: 'csl', parser: Parameter.parseCommaSeparatedList };
|
|
33
|
+
declarations[Parameter.RECEIVE_SHADOWS] = { type: 'boolean', parser: Parameter.parseBoolean };
|
|
34
|
+
declarations[Parameter.INTENSITY] = { type: 'number', parser: Parameter.parseNumber };
|
|
35
|
+
declarations[Parameter.DIRECTION] = { type: 'vector', parser: Parameter.parseVector };
|
|
36
|
+
declarations[Parameter.ANGLE] = { type: 'number', parser: Parameter.parseNumber };
|
|
37
|
+
declarations[Parameter.EXPONENT] = { type: 'number', parser: Parameter.parseNumber };
|
|
38
|
+
declarations[Parameter.DIFFUSE] = { type: 'color', parser: Parameter.parseColor };
|
|
39
|
+
declarations[Parameter.SPECULAR] = { type: 'color', parser: Parameter.parseColor };
|
|
40
|
+
declarations[Parameter.ENVIRONMENT] = { type: 'string' };
|
|
41
|
+
declarations[Parameter.ENVIRONMENT_COLOR] = { type: 'color', parser: Parameter.parseColor };
|
|
42
|
+
declarations[Parameter.ENVIRONMENT_ROTATION] = { type: 'number', parser: Parameter.parseNumber };
|
|
43
|
+
declarations[Parameter.ENVIRONMENT_INTENSITY] = { type: 'number', parser: Parameter.parseNumber };
|
|
44
|
+
declarations[Parameter.ENVIRONMENT_BACKGROUND] = { type: 'string' };
|
|
45
|
+
declarations[Parameter.ENVIRONMENT_USEDEFAULT] = { type: 'boolean', parser: Parameter.parseBoolean };
|
|
46
|
+
return declarations;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Gets the {@link ParameterDeclaration} for a given {@link Parameter} declared in this class.
|
|
50
|
+
*/
|
|
51
|
+
static getDeclaration(parameter) {
|
|
52
|
+
return Parameter.declarations[parameter];
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* All parameters defined in this class.
|
|
56
|
+
*/
|
|
57
|
+
static get all() {
|
|
58
|
+
const all = [];
|
|
59
|
+
for (const parameter in Parameter) {
|
|
60
|
+
const property = Object.getOwnPropertyDescriptor(Parameter, parameter);
|
|
61
|
+
if (parameter.toUpperCase() === parameter && property && isString(property.value)) {
|
|
62
|
+
all.push(property.value);
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
return all;
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Parses given {@link ParameterBag} with given {@link ParameterDeclarations}.
|
|
69
|
+
*/
|
|
70
|
+
static parseFromDeclarations(declarations, parameterBag) {
|
|
71
|
+
const parameters = {};
|
|
72
|
+
for (const parameter in parameterBag) {
|
|
73
|
+
const value = get(parameterBag, parameter);
|
|
74
|
+
parameters[parameter] = value;
|
|
75
|
+
const declaration = declarations[parameter];
|
|
76
|
+
if (declaration) {
|
|
77
|
+
if (!isEmpty(value) && declaration.parser) {
|
|
78
|
+
parameters[parameter] = declaration.parser(value);
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
return parameters;
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* Parses a string of format `'(x,y,z)'` to a `Vector3`.
|
|
86
|
+
*/
|
|
87
|
+
static parseVector(value) {
|
|
88
|
+
if (!isString(value)) {
|
|
89
|
+
throw new Error(`Unable to convert "${value}" into a Vector: not a string.`);
|
|
90
|
+
}
|
|
91
|
+
let cleanedValue = value.split(' ').join('');
|
|
92
|
+
if (cleanedValue.startsWith('(') && cleanedValue.endsWith(')')) {
|
|
93
|
+
cleanedValue = cleanedValue.substring(1, cleanedValue.length - 1);
|
|
94
|
+
let [x, y, z] = cleanedValue.split(',').map(value => parseFloat(value));
|
|
95
|
+
return new Vector3(x, y, z);
|
|
96
|
+
}
|
|
97
|
+
else {
|
|
98
|
+
throw new Error(`Unable to parse "${value}" to a Vector: expected "(x,y,z)".`);
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Stringifies a Vector3 to format `(x,y,z)`.
|
|
103
|
+
*/
|
|
104
|
+
static stringifyVector(value) {
|
|
105
|
+
return `(${value.x},${value.y},${value.z})`;
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* Parses a string of format `'(x,y,z)'` with angular degrees to a `Vector3` with rotation information in radians.
|
|
109
|
+
*/
|
|
110
|
+
static parseRotation(value) {
|
|
111
|
+
const rotation = Parameter.parseVector(value);
|
|
112
|
+
const deg2rad = function (deg) {
|
|
113
|
+
return (deg * Math.PI) / 180;
|
|
114
|
+
};
|
|
115
|
+
return rotation.set(deg2rad(rotation.x), deg2rad(rotation.y), deg2rad(rotation.z));
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* Parses a string of format `'(x,y,z)'` or a simple `number` to a `Vector3` for scaling.
|
|
119
|
+
*/
|
|
120
|
+
static parseScaling(value) {
|
|
121
|
+
let scaling = new Vector3();
|
|
122
|
+
if (isString(value)) {
|
|
123
|
+
const cleanedFactor = value.split(' ').join('');
|
|
124
|
+
if (cleanedFactor.startsWith('(') && cleanedFactor.endsWith(')')) {
|
|
125
|
+
scaling = Parameter.parseVector(cleanedFactor);
|
|
126
|
+
}
|
|
127
|
+
else {
|
|
128
|
+
const _factor = parseFloat(value);
|
|
129
|
+
scaling = new Vector3(_factor, _factor, _factor);
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
else if (isNumber(value)) {
|
|
133
|
+
scaling = new Vector3(value, value, value);
|
|
134
|
+
}
|
|
135
|
+
else {
|
|
136
|
+
throw new Error(`Unable to convert "${value}" to a Vector: expected "(x,y,z)".`);
|
|
137
|
+
}
|
|
138
|
+
return scaling;
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* Parses a string of format `'#rrggbb'` or `'(r,g,b)'` to a `Color3`.
|
|
142
|
+
*/
|
|
143
|
+
static parseColor(value) {
|
|
144
|
+
let cleanedValue = value.toString().split(' ').join('');
|
|
145
|
+
if (cleanedValue.startsWith('#')) {
|
|
146
|
+
return Color3.FromHexString(value.toString());
|
|
147
|
+
}
|
|
148
|
+
if (cleanedValue.startsWith('(') && cleanedValue.endsWith(')')) {
|
|
149
|
+
cleanedValue = cleanedValue.substring(1, cleanedValue.length - 1);
|
|
150
|
+
let [r, g, b] = cleanedValue.split(',').map(value => parseFloat(value));
|
|
151
|
+
return Color3.FromInts(r, g, b);
|
|
152
|
+
}
|
|
153
|
+
throw new Error(`Unable to parse "${value}" to a Color: expected "#rrggbb" or "(r,g,b)".`);
|
|
154
|
+
}
|
|
155
|
+
/**
|
|
156
|
+
* Parses a `boolean` string (`'true'`/`'1'` or `'false'`/`'0'`) or `number` (`1` or `0`) to a `boolean` or `undefined`.
|
|
157
|
+
*/
|
|
158
|
+
static parseBoolean(value) {
|
|
159
|
+
if (value.toString() === 'true' || value.toString() === '1') {
|
|
160
|
+
return true;
|
|
161
|
+
}
|
|
162
|
+
else if (value.toString() === 'false' || value.toString() === '0') {
|
|
163
|
+
return false;
|
|
164
|
+
}
|
|
165
|
+
throw new Error(`Unable to parse "${value}" to a boolean.`);
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* Parses a number `string` to a `number`.
|
|
169
|
+
*/
|
|
170
|
+
static parseNumber(value) {
|
|
171
|
+
return parseFloat(value.toString());
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* Parses a string with comma separated values to a list of strings.
|
|
175
|
+
*/
|
|
176
|
+
static parseCommaSeparatedList(value) {
|
|
177
|
+
return value
|
|
178
|
+
.toString()
|
|
179
|
+
.split(',')
|
|
180
|
+
.map(s => s.trim());
|
|
181
|
+
}
|
|
182
|
+
}
|
|
183
|
+
/**
|
|
184
|
+
* Mutates the visibility. Helper methods are {@link VariantParameterizable.show} and
|
|
185
|
+
* {@link VariantParameterizable.hide}. Getter and setter is {@link VariantParameterizable.visible}.
|
|
186
|
+
*
|
|
187
|
+
* Scopes:
|
|
188
|
+
* * {@link Element}
|
|
189
|
+
* * {@link Variant}
|
|
190
|
+
* * {@link ViewerLight} Available for all light types
|
|
191
|
+
*
|
|
192
|
+
* @parser {@link parseBoolean}
|
|
193
|
+
*/
|
|
194
|
+
Parameter.VISIBLE = 'visible';
|
|
195
|
+
/**
|
|
196
|
+
* Stretches or compresses some meshes. Getter and setter is {@link VariantParameterizable.scaling}.
|
|
197
|
+
*
|
|
198
|
+
* Scopes:
|
|
199
|
+
* * {@link Element}
|
|
200
|
+
* * {@link Variant}
|
|
201
|
+
*
|
|
202
|
+
* @parser {@link parseScaling}
|
|
203
|
+
*/
|
|
204
|
+
Parameter.SCALING = 'scaling';
|
|
205
|
+
/**
|
|
206
|
+
* Mutates the material. Getter and setter is {@link VariantParameterizable.material}. The value of this parameter
|
|
207
|
+
* represents the ID of a baked-in glTF or custom created material in the {@link Variant} tree.
|
|
208
|
+
*
|
|
209
|
+
* Scopes:
|
|
210
|
+
* * {@link Element}
|
|
211
|
+
* * {@link Variant}
|
|
212
|
+
*
|
|
213
|
+
* @parser string
|
|
214
|
+
*/
|
|
215
|
+
Parameter.MATERIAL = 'material';
|
|
216
|
+
/**
|
|
217
|
+
* Mutates the material color.
|
|
218
|
+
*
|
|
219
|
+
* Scopes:
|
|
220
|
+
* * {@link Element}
|
|
221
|
+
* * {@link Variant}
|
|
222
|
+
*
|
|
223
|
+
* @parser {@link parseColor}
|
|
224
|
+
*/
|
|
225
|
+
Parameter.MATERIAL_COLOR = 'material.color';
|
|
226
|
+
/**
|
|
227
|
+
* Mutates the material metallness.
|
|
228
|
+
*
|
|
229
|
+
* Scopes:
|
|
230
|
+
* * {@link Element}
|
|
231
|
+
* * {@link Variant}
|
|
232
|
+
*
|
|
233
|
+
* @parser {@link parseNumber}
|
|
234
|
+
*/
|
|
235
|
+
Parameter.MATERIAL_METALLNESS = 'material.metallness';
|
|
236
|
+
/**
|
|
237
|
+
* Mutates the material roughness.
|
|
238
|
+
*
|
|
239
|
+
* Scopes:
|
|
240
|
+
* * {@link Element}
|
|
241
|
+
* * {@link Variant}
|
|
242
|
+
*
|
|
243
|
+
* @parser {@link parseNumber}
|
|
244
|
+
*/
|
|
245
|
+
Parameter.MATERIAL_ROUGHNESS = 'material.roughness';
|
|
246
|
+
/**
|
|
247
|
+
* Mutates whether a highlight layer should be enabled.
|
|
248
|
+
*
|
|
249
|
+
* Scopes:
|
|
250
|
+
* * {@link Element}
|
|
251
|
+
* * {@link Variant}
|
|
252
|
+
*
|
|
253
|
+
* @parser {@link parseBoolean}
|
|
254
|
+
*/
|
|
255
|
+
Parameter.HIGHLIGHT_ENABLED = 'highlight.enabled';
|
|
256
|
+
/**
|
|
257
|
+
* Changes the highlight color.
|
|
258
|
+
*
|
|
259
|
+
* Scopes:
|
|
260
|
+
* * {@link Element}
|
|
261
|
+
* * {@link Variant}
|
|
262
|
+
*
|
|
263
|
+
* @parser {@link parseColor}
|
|
264
|
+
*/
|
|
265
|
+
Parameter.HIGHLIGHT_COLOR = 'highlight.color';
|
|
266
|
+
/**
|
|
267
|
+
* Mutates the highlighted state. Getter and setter is {@link VariantParameterizable.highlighted}.
|
|
268
|
+
*
|
|
269
|
+
* Scopes:
|
|
270
|
+
* * {@link Element}
|
|
271
|
+
* * {@link Variant}
|
|
272
|
+
*
|
|
273
|
+
* @parser {@link parseBoolean}
|
|
274
|
+
*/
|
|
275
|
+
Parameter.HIGHLIGHTED = 'highlighted';
|
|
276
|
+
/**
|
|
277
|
+
* Mutates the position relative to its origin position. Getter and setter is {@link VariantParameterizable.position}.
|
|
278
|
+
*
|
|
279
|
+
* Scopes:
|
|
280
|
+
* * {@link Element}
|
|
281
|
+
* * {@link Variant}
|
|
282
|
+
* * {@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)
|
|
283
|
+
*
|
|
284
|
+
* @parser {@link parseVector}
|
|
285
|
+
*/
|
|
286
|
+
Parameter.POSITION = 'position';
|
|
287
|
+
/**
|
|
288
|
+
* Mutates the rotation relative to its origin rotation. Getter and setter is {@link VariantParameterizable.rotation}.
|
|
289
|
+
*
|
|
290
|
+
* Scopes:
|
|
291
|
+
* * {@link Element}
|
|
292
|
+
* * {@link Variant}
|
|
293
|
+
*
|
|
294
|
+
* @parser {@link parseRotation}
|
|
295
|
+
*/
|
|
296
|
+
Parameter.ROTATION = 'rotation';
|
|
297
|
+
/**
|
|
298
|
+
* Mutates whether a shadow should be casted or not.
|
|
299
|
+
*
|
|
300
|
+
* Scopes:
|
|
301
|
+
* * {@link Element}
|
|
302
|
+
* * {@link Variant}
|
|
303
|
+
*
|
|
304
|
+
* @parser {@link parseBoolean}
|
|
305
|
+
*/
|
|
306
|
+
Parameter.CAST_SHADOW = 'castShadow';
|
|
307
|
+
/**
|
|
308
|
+
* Mutates from which lights a shadow should be casted.
|
|
309
|
+
*
|
|
310
|
+
* Scopes:
|
|
311
|
+
* * {@link Element}
|
|
312
|
+
* * {@link Variant}
|
|
313
|
+
*
|
|
314
|
+
* @parser {@link parseCommaSeparatedList}
|
|
315
|
+
*/
|
|
316
|
+
Parameter.CAST_SHADOW_FROM_LIGHTS = 'castShadow.fromLights';
|
|
317
|
+
/**
|
|
318
|
+
* Mutates whether to receive shadows or not.
|
|
319
|
+
*
|
|
320
|
+
* Scopes:
|
|
321
|
+
* * {@link Element}
|
|
322
|
+
* * {@link Variant}
|
|
323
|
+
*
|
|
324
|
+
* @parser {@link parseBoolean}
|
|
325
|
+
*/
|
|
326
|
+
Parameter.RECEIVE_SHADOWS = 'receiveShadows';
|
|
327
|
+
/**
|
|
328
|
+
* Mutates the intensity of Lights.
|
|
329
|
+
*
|
|
330
|
+
* Scopes:
|
|
331
|
+
* * {@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)
|
|
332
|
+
*
|
|
333
|
+
* @parser {@link parseNumber}
|
|
334
|
+
*/
|
|
335
|
+
Parameter.INTENSITY = 'intensity';
|
|
336
|
+
/**
|
|
337
|
+
* Mutates the direction of Lights.
|
|
338
|
+
*
|
|
339
|
+
* Scopes:
|
|
340
|
+
* * {@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)
|
|
341
|
+
*
|
|
342
|
+
* @parser {@link parseNumber}
|
|
343
|
+
*/
|
|
344
|
+
Parameter.DIRECTION = 'direction';
|
|
345
|
+
/**
|
|
346
|
+
* Mutates the angle of Lights.
|
|
347
|
+
*
|
|
348
|
+
* Scopes:
|
|
349
|
+
* * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#angle)
|
|
350
|
+
*
|
|
351
|
+
* @parser {@link parseNumber}
|
|
352
|
+
*/
|
|
353
|
+
Parameter.ANGLE = 'angle';
|
|
354
|
+
/**
|
|
355
|
+
* Mutates the exponent of Lights.
|
|
356
|
+
*
|
|
357
|
+
* Scopes:
|
|
358
|
+
* * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#exponent)
|
|
359
|
+
*
|
|
360
|
+
* @parser {@link parseNumber}
|
|
361
|
+
*/
|
|
362
|
+
Parameter.EXPONENT = 'exponent';
|
|
363
|
+
/**
|
|
364
|
+
* Mutates the diffuse color of Lights.
|
|
365
|
+
*
|
|
366
|
+
* Scopes:
|
|
367
|
+
* * {@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)
|
|
368
|
+
*
|
|
369
|
+
* @parser {@link parseNumber}
|
|
370
|
+
*/
|
|
371
|
+
Parameter.DIFFUSE = 'diffuse';
|
|
372
|
+
/**
|
|
373
|
+
* Mutates the specular color of Lights.
|
|
374
|
+
*
|
|
375
|
+
* Scopes:
|
|
376
|
+
* * {@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)
|
|
377
|
+
*
|
|
378
|
+
* @parser {@link parseNumber}
|
|
379
|
+
*/
|
|
380
|
+
Parameter.SPECULAR = 'specular';
|
|
381
|
+
/**
|
|
382
|
+
* Sets the environment. See [BABYLON.Scene.environmentTexture](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#environmentTexture).
|
|
383
|
+
*
|
|
384
|
+
* Usually the URL to an `*.env` file.
|
|
385
|
+
*
|
|
386
|
+
* See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
|
|
387
|
+
*
|
|
388
|
+
* Scopes:
|
|
389
|
+
* * {@link SceneManager}
|
|
390
|
+
*
|
|
391
|
+
* @parser string
|
|
392
|
+
*/
|
|
393
|
+
Parameter.ENVIRONMENT = 'environment';
|
|
394
|
+
/**
|
|
395
|
+
* Sets [BABYLON.Scene.clearColor](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#clearColor)
|
|
396
|
+
*
|
|
397
|
+
* See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
|
|
398
|
+
*
|
|
399
|
+
* Scopes:
|
|
400
|
+
* * {@link SceneManager}
|
|
401
|
+
*
|
|
402
|
+
* @parser {@link parseColor}
|
|
403
|
+
*/
|
|
404
|
+
Parameter.ENVIRONMENT_COLOR = 'environment.color';
|
|
405
|
+
/**
|
|
406
|
+
* Rotates connected textures, i.e. IBL, reflection, background, ...
|
|
407
|
+
* Rotation angle in degree.
|
|
408
|
+
*
|
|
409
|
+
* See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
|
|
410
|
+
*
|
|
411
|
+
* Scopes:
|
|
412
|
+
* * {@link SceneManager}
|
|
413
|
+
*
|
|
414
|
+
* @parser {@link parseNumber}
|
|
415
|
+
*/
|
|
416
|
+
Parameter.ENVIRONMENT_ROTATION = 'environment.rotation';
|
|
417
|
+
/**
|
|
418
|
+
* Intensity of IBL. Defaults to 1, usually between 0 & 2.
|
|
419
|
+
*
|
|
420
|
+
* See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
|
|
421
|
+
*
|
|
422
|
+
* Scopes:
|
|
423
|
+
* * {@link SceneManager}
|
|
424
|
+
*
|
|
425
|
+
* @parser {@link parseNumber}
|
|
426
|
+
*/
|
|
427
|
+
Parameter.ENVIRONMENT_INTENSITY = 'environment.intensity';
|
|
428
|
+
/**
|
|
429
|
+
* Background texture on a [PhotoDome](https://doc.babylonjs.com/divingDeeper/environment/360PhotoDome). Just background, no IBL or reflection.
|
|
430
|
+
*
|
|
431
|
+
* Recommended format is `*.jpg`. HDR files are not supported as background but can be converted to `*.jpg` using tools like Photoshop, Gimp or various free online converters.
|
|
432
|
+
*
|
|
433
|
+
* See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
|
|
434
|
+
*
|
|
435
|
+
* Scopes:
|
|
436
|
+
* * {@link SceneManager}
|
|
437
|
+
*
|
|
438
|
+
* @parser string
|
|
439
|
+
*/
|
|
440
|
+
Parameter.ENVIRONMENT_BACKGROUND = 'environment.background';
|
|
441
|
+
/**
|
|
442
|
+
* If `true`, sets a `scene.environmentTexture` and creates a *BackgroundHelper* Node (via
|
|
443
|
+
* [scene.createDefaultEnvironment](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#createDefaultEnvironment))
|
|
444
|
+
* with two subnodes/meshes:
|
|
445
|
+
* - BackgroundPlane
|
|
446
|
+
* - BackgroundSkybox
|
|
447
|
+
*
|
|
448
|
+
* The value of this parameter is ignored if {@link ENVIRONMENT_BACKGROUND} is also set.
|
|
449
|
+
*
|
|
450
|
+
* See [environment page](./../pages/Documentation/Environment.html) for details on how to use this.
|
|
451
|
+
*
|
|
452
|
+
* Scopes:
|
|
453
|
+
* * {@link SceneManager}
|
|
454
|
+
*
|
|
455
|
+
* @parser {@link parseBoolean}
|
|
456
|
+
*/
|
|
457
|
+
Parameter.ENVIRONMENT_USEDEFAULT = 'environment.usedefault';
|
|
458
|
+
//# sourceMappingURL=parameter.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"parameter.js","sourceRoot":"","sources":["../../../../../src/api/classes/parameter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAC1D,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC;AAC5D,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAE7D;;;;GAIG;AACH,MAAM,OAAO,SAAS;IACpB;;OAEG;IACH,gBAAuB,CAAC;IA+SxB;;OAEG;IACI,MAAM,KAAK,YAAY;QAC5B,MAAM,YAAY,GAA0B,EAAE,CAAC;QAC/C,YAAY,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,YAAY,EAAE,CAAC;QACtF,YAAY,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC;QACpF,YAAY,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC;QACrF,YAAY,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC;QACrF,YAAY,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,YAAY,EAAE,CAAC;QAC1F,YAAY,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QACtD,YAAY,CAAC,SAAS,CAAC,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,UAAU,EAAE,CAAC;QACzF,YAAY,CAAC,SAAS,CAAC,mBAAmB,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC;QAChG,YAAY,CAAC,SAAS,CAAC,kBAAkB,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC;QAC/F,YAAY,CAAC,SAAS,CAAC,iBAAiB,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,YAAY,EAAE,CAAC;QAChG,YAAY,CAAC,SAAS,CAAC,eAAe,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,UAAU,EAAE,CAAC;QAC1F,YAAY,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,YAAY,EAAE,CAAC;QAC1F,YAAY,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,YAAY,EAAE,CAAC;QAC1F,YAAY,CAAC,SAAS,CAAC,uBAAuB,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,uBAAuB,EAAE,CAAC;QAC7G,YAAY,CAAC,SAAS,CAAC,eAAe,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,YAAY,EAAE,CAAC;QAC9F,YAAY,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC;QACtF,YAAY,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC;QACtF,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC;QAClF,YAAY,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC;QACrF,YAAY,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,UAAU,EAAE,CAAC;QAClF,YAAY,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,UAAU,EAAE,CAAC;QACnF,YAAY,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QACzD,YAAY,CAAC,SAAS,CAAC,iBAAiB,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,UAAU,EAAE,CAAC;QAC5F,YAAY,CAAC,SAAS,CAAC,oBAAoB,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC;QACjG,YAAY,CAAC,SAAS,CAAC,qBAAqB,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC;QAClG,YAAY,CAAC,SAAS,CAAC,sBAAsB,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QACpE,YAAY,CAAC,SAAS,CAAC,sBAAsB,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,YAAY,EAAE,CAAC;QACrG,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,cAAc,CAAC,SAAiB;QAC5C,OAAO,SAAS,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,GAAG;QACnB,MAAM,GAAG,GAAa,EAAE,CAAC;QACzB,KAAK,MAAM,SAAS,IAAI,SAAS,EAAE;YACjC,MAAM,QAAQ,GAAG,MAAM,CAAC,wBAAwB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YACvE,IAAI,SAAS,CAAC,WAAW,EAAE,KAAK,SAAS,IAAI,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBACjF,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;aAC1B;SACF;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,qBAAqB,CACjC,YAAmC,EACnC,YAA0B;QAE1B,MAAM,UAAU,GAAuB,EAAE,CAAC;QAC1C,KAAK,MAAM,SAAS,IAAI,YAAY,EAAE;YACpC,MAAM,KAAK,GAAG,GAAG,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;YAC3C,UAAU,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC;YAC9B,MAAM,WAAW,GAAyB,YAAY,CAAC,SAAS,CAAC,CAAC;YAClE,IAAI,WAAW,EAAE;gBACf,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,WAAW,CAAC,MAAM,EAAE;oBACzC,UAAU,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;iBACnD;aACF;SACF;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,WAAW,CAAC,KAAqB;QAC7C,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,sBAAsB,KAAK,gCAAgC,CAAC,CAAC;SAC9E;QACD,IAAI,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7C,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC9D,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAClE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;YACxE,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;SAC7B;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,oBAAoB,KAAK,oCAAoC,CAAC,CAAC;SAChF;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,eAAe,CAAC,KAAc;QAC1C,OAAO,IAAI,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,GAAG,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,aAAa,CAAC,KAAqB;QAC/C,MAAM,QAAQ,GAAG,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,UAAU,GAAW;YACnC,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC;QAC/B,CAAC,CAAC;QACF,OAAO,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,YAAY,CAAC,KAAqB;QAC9C,IAAI,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;QAC5B,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE;YACnB,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAChD,IAAI,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBAChE,OAAO,GAAG,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;aAChD;iBAAM;gBACL,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;gBAClC,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;aAClD;SACF;aAAM,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE;YAC1B,OAAO,GAAG,IAAI,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;SAC5C;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,sBAAsB,KAAK,oCAAoC,CAAC,CAAC;SAClF;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,UAAU,CAAC,KAAqB;QAC5C,IAAI,YAAY,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACxD,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAChC,OAAO,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;SAC/C;QACD,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC9D,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAClE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;YACxE,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;SACjC;QACD,MAAM,IAAI,KAAK,CAAC,oBAAoB,KAAK,gDAAgD,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,YAAY,CAAC,KAAqB;QAC9C,IAAI,KAAK,CAAC,QAAQ,EAAE,KAAK,MAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,KAAK,GAAG,EAAE;YAC3D,OAAO,IAAI,CAAC;SACb;aAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,KAAK,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE,KAAK,GAAG,EAAE;YACnE,OAAO,KAAK,CAAC;SACd;QACD,MAAM,IAAI,KAAK,CAAC,oBAAoB,KAAK,iBAAiB,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,WAAW,CAAC,KAAqB;QAC7C,OAAO,UAAU,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,uBAAuB,CAAC,KAAqB;QACzD,OAAO,KAAK;aACT,QAAQ,EAAE;aACV,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACxB,CAAC;;AA7dD;;;;;;;;;;GAUG;AACoB,iBAAO,GAAG,SAAS,CAAC;AAE3C;;;;;;;;GAQG;AACoB,iBAAO,GAAG,SAAS,CAAC;AAE3C;;;;;;;;;GASG;AACoB,kBAAQ,GAAG,UAAU,CAAC;AAE7C;;;;;;;;GAQG;AACoB,wBAAc,GAAG,gBAAgB,CAAC;AAEzD;;;;;;;;GAQG;AACoB,6BAAmB,GAAG,qBAAqB,CAAC;AAEnE;;;;;;;;GAQG;AACoB,4BAAkB,GAAG,oBAAoB,CAAC;AAEjE;;;;;;;;GAQG;AACoB,2BAAiB,GAAG,mBAAmB,CAAC;AAE/D;;;;;;;;GAQG;AACoB,yBAAe,GAAG,iBAAiB,CAAC;AAE3D;;;;;;;;GAQG;AACoB,qBAAW,GAAG,aAAa,CAAC;AAEnD;;;;;;;;;GASG;AACoB,kBAAQ,GAAG,UAAU,CAAC;AAE7C;;;;;;;;GAQG;AACoB,kBAAQ,GAAG,UAAU,CAAC;AAE7C;;;;;;;;GAQG;AACoB,qBAAW,GAAG,YAAY,CAAC;AAElD;;;;;;;;GAQG;AACoB,iCAAuB,GAAG,uBAAuB,CAAC;AAEzE;;;;;;;;GAQG;AACoB,yBAAe,GAAG,gBAAgB,CAAC;AAE1D;;;;;;;GAOG;AACoB,mBAAS,GAAG,WAAW,CAAC;AAE/C;;;;;;;GAOG;AACoB,mBAAS,GAAG,WAAW,CAAC;AAE/C;;;;;;;GAOG;AACoB,eAAK,GAAG,OAAO,CAAC;AAEvC;;;;;;;GAOG;AACoB,kBAAQ,GAAG,UAAU,CAAC;AAE7C;;;;;;;GAOG;AACoB,iBAAO,GAAG,SAAS,CAAC;AAE3C;;;;;;;GAOG;AACoB,kBAAQ,GAAG,UAAU,CAAC;AAE7C;;;;;;;;;;;GAWG;AACoB,qBAAW,GAAG,aAAa,CAAC;AAEnD;;;;;;;;;GASG;AACoB,2BAAiB,GAAG,mBAAmB,CAAC;AAE/D;;;;;;;;;;GAUG;AACoB,8BAAoB,GAAG,sBAAsB,CAAC;AAErE;;;;;;;;;GASG;AACoB,+BAAqB,GAAG,uBAAuB,CAAC;AAEvE;;;;;;;;;;;GAWG;AACoB,gCAAsB,GAAG,wBAAwB,CAAC;AAEzE;;;;;;;;;;;;;;;GAeG;AACoB,gCAAsB,GAAG,wBAAwB,CAAC"}
|
|
@@ -1,36 +1,36 @@
|
|
|
1
|
-
import { EventBroadcaster } from './eventBroadcaster';
|
|
2
|
-
export declare abstract class ParameterObservable extends EventBroadcaster {
|
|
3
|
-
readonly uuid: string;
|
|
4
|
-
readonly parameters: ParameterBag;
|
|
5
|
-
protected readonly parameterDeclaration: ParameterDeclarations;
|
|
6
|
-
protected parameterObservers: Map<string, ParameterObserver[]>;
|
|
7
|
-
protected constructor(parameterDeclaration?: ParameterDeclarations, parameters?: ParameterBag);
|
|
8
|
-
/**
|
|
9
|
-
* The uuid (if not overloaded).
|
|
10
|
-
*/
|
|
11
|
-
get id(): string;
|
|
12
|
-
/**
|
|
13
|
-
* Adds an observer function for parameter changes.
|
|
14
|
-
* The {@link ParameterObserver} gets 3 parameters: the {@link ParameterObservable}, the old {@link ParameterValue}
|
|
15
|
-
* and the new {@link ParameterValue}.
|
|
16
|
-
*
|
|
17
|
-
* See {@page Parameters} for an example.
|
|
18
|
-
*/
|
|
19
|
-
addParameterObserver(parameter: string, observer: ParameterObserver): ParameterObservable;
|
|
20
|
-
/**
|
|
21
|
-
* Removes all {@link ParameterObserver}s for given parameter.
|
|
22
|
-
*/
|
|
23
|
-
removeParameterObservers(parameter: string): ParameterObservable;
|
|
24
|
-
/**
|
|
25
|
-
* Invoke parameter observers for given parameter.
|
|
26
|
-
*/
|
|
27
|
-
commitParameter(parameter: string, value: ParameterValue): Promise<ParameterObservable>;
|
|
28
|
-
/**
|
|
29
|
-
* Invoke parameter observers for given parameters.
|
|
30
|
-
*/
|
|
31
|
-
abstract commitParameters(parameters?: ParameterBag): Promise<ParameterObservable>;
|
|
32
|
-
/**
|
|
33
|
-
* Asserts whether given parameter is declared and valid.
|
|
34
|
-
*/
|
|
35
|
-
assertParameter(parameterDeclaration: ParameterDeclarations, parameter: string, value: ParameterValue): void;
|
|
36
|
-
}
|
|
1
|
+
import { EventBroadcaster } from './eventBroadcaster';
|
|
2
|
+
export declare abstract class ParameterObservable extends EventBroadcaster {
|
|
3
|
+
readonly uuid: string;
|
|
4
|
+
readonly parameters: ParameterBag;
|
|
5
|
+
protected readonly parameterDeclaration: ParameterDeclarations;
|
|
6
|
+
protected parameterObservers: Map<string, ParameterObserver[]>;
|
|
7
|
+
protected constructor(parameterDeclaration?: ParameterDeclarations, parameters?: ParameterBag);
|
|
8
|
+
/**
|
|
9
|
+
* The uuid (if not overloaded).
|
|
10
|
+
*/
|
|
11
|
+
get id(): string;
|
|
12
|
+
/**
|
|
13
|
+
* Adds an observer function for parameter changes.
|
|
14
|
+
* The {@link ParameterObserver} gets 3 parameters: the {@link ParameterObservable}, the old {@link ParameterValue}
|
|
15
|
+
* and the new {@link ParameterValue}.
|
|
16
|
+
*
|
|
17
|
+
* See {@page ../../../doc/documentation/Parameters.md} for an example.
|
|
18
|
+
*/
|
|
19
|
+
addParameterObserver(parameter: string, observer: ParameterObserver): ParameterObservable;
|
|
20
|
+
/**
|
|
21
|
+
* Removes all {@link ParameterObserver}s for given parameter.
|
|
22
|
+
*/
|
|
23
|
+
removeParameterObservers(parameter: string): ParameterObservable;
|
|
24
|
+
/**
|
|
25
|
+
* Invoke parameter observers for given parameter.
|
|
26
|
+
*/
|
|
27
|
+
commitParameter(parameter: string, value: ParameterValue): Promise<ParameterObservable>;
|
|
28
|
+
/**
|
|
29
|
+
* Invoke parameter observers for given parameters.
|
|
30
|
+
*/
|
|
31
|
+
abstract commitParameters(parameters?: ParameterBag): Promise<ParameterObservable>;
|
|
32
|
+
/**
|
|
33
|
+
* Asserts whether given parameter is declared and valid.
|
|
34
|
+
*/
|
|
35
|
+
assertParameter(parameterDeclaration: ParameterDeclarations, parameter: string, value: ParameterValue): void;
|
|
36
|
+
}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
2
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
3
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
4
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
5
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
6
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
7
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
8
|
+
});
|
|
9
|
+
};
|
|
10
|
+
import { uuidv4 } from '../util/stringHelper';
|
|
11
|
+
import { EventBroadcaster } from './eventBroadcaster';
|
|
12
|
+
import { merge } from 'lodash-es';
|
|
13
|
+
export class ParameterObservable extends EventBroadcaster {
|
|
14
|
+
constructor(parameterDeclaration = {}, parameters = {}) {
|
|
15
|
+
super();
|
|
16
|
+
this.parameters = {};
|
|
17
|
+
this.parameterDeclaration = {};
|
|
18
|
+
this.parameterObservers = new Map();
|
|
19
|
+
this.uuid = uuidv4();
|
|
20
|
+
this.parameterDeclaration = merge(this.parameterDeclaration, parameterDeclaration);
|
|
21
|
+
this.parameters = merge(this.parameters, parameters);
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* The uuid (if not overloaded).
|
|
25
|
+
*/
|
|
26
|
+
get id() {
|
|
27
|
+
return this.uuid;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Adds an observer function for parameter changes.
|
|
31
|
+
* The {@link ParameterObserver} gets 3 parameters: the {@link ParameterObservable}, the old {@link ParameterValue}
|
|
32
|
+
* and the new {@link ParameterValue}.
|
|
33
|
+
*
|
|
34
|
+
* See {@page ../../../doc/documentation/Parameters.md} for an example.
|
|
35
|
+
*/
|
|
36
|
+
addParameterObserver(parameter, observer) {
|
|
37
|
+
if (this.parameterObservers.has(parameter)) {
|
|
38
|
+
this.parameterObservers.get(parameter).push(observer);
|
|
39
|
+
return this;
|
|
40
|
+
}
|
|
41
|
+
this.parameterObservers.set(parameter, [observer]);
|
|
42
|
+
return this;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Removes all {@link ParameterObserver}s for given parameter.
|
|
46
|
+
*/
|
|
47
|
+
removeParameterObservers(parameter) {
|
|
48
|
+
this.parameterObservers.delete(parameter);
|
|
49
|
+
return this;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Invoke parameter observers for given parameter.
|
|
53
|
+
*/
|
|
54
|
+
commitParameter(parameter, value) {
|
|
55
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
56
|
+
const parameters = {};
|
|
57
|
+
parameters[parameter] = value;
|
|
58
|
+
return this.commitParameters(parameters);
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Asserts whether given parameter is declared and valid.
|
|
63
|
+
*/
|
|
64
|
+
assertParameter(parameterDeclaration, parameter, value) {
|
|
65
|
+
if (!(parameter in parameterDeclaration)) {
|
|
66
|
+
// This is a valid case since we are not able to check parameters that are not declared.
|
|
67
|
+
// We just ignore parameters that are not declared.
|
|
68
|
+
return;
|
|
69
|
+
}
|
|
70
|
+
const declaration = parameterDeclaration[parameter];
|
|
71
|
+
const genericError = `"${value}" is not a valid value for parameter "${parameter}" of type. ` +
|
|
72
|
+
`"${declaration.type}" for ${this.constructor.name} "${this.id}".`;
|
|
73
|
+
if (declaration.parser) {
|
|
74
|
+
try {
|
|
75
|
+
declaration.parser(value);
|
|
76
|
+
}
|
|
77
|
+
catch (e) {
|
|
78
|
+
throw Error(genericError + e.message);
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
switch (declaration.type) {
|
|
82
|
+
case 'select':
|
|
83
|
+
if (!declaration.options) {
|
|
84
|
+
throw Error(`No options defined for parameter declaration "${parameter}"` +
|
|
85
|
+
`of type "${declaration.type}" for ${this.constructor.name} "${this.id}".`);
|
|
86
|
+
}
|
|
87
|
+
if (declaration.options.indexOf(value) === -1) {
|
|
88
|
+
throw Error(genericError + ` Valid values are: "${declaration.options.join('", "')}".`);
|
|
89
|
+
}
|
|
90
|
+
break;
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
//# sourceMappingURL=parameterObservable.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"parameterObservable.js","sourceRoot":"","sources":["../../../../../src/api/classes/parameterObservable.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAElC,MAAM,OAAgB,mBAAoB,SAAQ,gBAAgB;IAShE,YAAsB,uBAA8C,EAAE,EAAE,aAA2B,EAAE;QACnG,KAAK,EAAE,CAAC;QAPM,eAAU,GAAiB,EAAE,CAAC;QAE3B,yBAAoB,GAA0B,EAAE,CAAC;QAE1D,uBAAkB,GAAqC,IAAI,GAAG,EAAE,CAAC;QAIzE,IAAI,CAAC,IAAI,GAAG,MAAM,EAAE,CAAC;QACrB,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,IAAI,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAC;QACnF,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACH,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;;;;OAMG;IACI,oBAAoB,CAAC,SAAiB,EAAE,QAA2B;QACxE,IAAI,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;YAC1C,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,SAAS,CAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACvD,OAAO,IAAI,CAAC;SACb;QACD,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,wBAAwB,CAAC,SAAiB;QAC/C,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACU,eAAe,CAAC,SAAiB,EAAE,KAAqB;;YACnE,MAAM,UAAU,GAAiB,EAAE,CAAC;YACpC,UAAU,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC;YAC9B,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAC3C,CAAC;KAAA;IAOD;;OAEG;IACI,eAAe,CAAC,oBAA2C,EAAE,SAAiB,EAAE,KAAqB;QAC1G,IAAI,CAAC,CAAC,SAAS,IAAI,oBAAoB,CAAC,EAAE;YACxC,wFAAwF;YACxF,mDAAmD;YACnD,OAAO;SACR;QACD,MAAM,WAAW,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC;QACpD,MAAM,YAAY,GAChB,IAAI,KAAK,yCAAyC,SAAS,aAAa;YACxE,IAAI,WAAW,CAAC,IAAI,SAAS,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,IAAI,CAAC;QACrE,IAAI,WAAW,CAAC,MAAM,EAAE;YACtB,IAAI;gBACF,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aAC3B;YAAC,OAAO,CAAM,EAAE;gBACf,MAAM,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;aACvC;SACF;QACD,QAAQ,WAAW,CAAC,IAAI,EAAE;YACxB,KAAK,QAAQ;gBACX,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE;oBACxB,MAAM,KAAK,CACT,iDAAiD,SAAS,GAAG;wBAC3D,YAAY,WAAW,CAAC,IAAI,SAAS,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,IAAI,CAC7E,CAAC;iBACH;gBACD,IAAI,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE;oBAC7C,MAAM,KAAK,CAAC,YAAY,GAAG,uBAAuB,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;iBACzF;gBACD,MAAM;SACT;IACH,CAAC;CACF"}
|