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