@needle-tools/engine 4.6.2 → 4.6.3

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 (1069) hide show
  1. package/CHANGELOG.md +3773 -3768
  2. package/LICENSE.md +10 -10
  3. package/README.md +64 -64
  4. package/components.needle.json +1 -1
  5. package/dist/generateMeshBVH.worker-Cdfpaq5W.js +25 -0
  6. package/dist/{gltf-progressive-Bl4okF1b.min.js → gltf-progressive-Bm9eEfgu.min.js} +1 -1
  7. package/dist/{gltf-progressive-P8b8a0qY.umd.cjs → gltf-progressive-Dn6o99rH.umd.cjs} +1 -1
  8. package/dist/{gltf-progressive-DSpdn0QT.js → gltf-progressive-GjIqwSG3.js} +2 -2
  9. package/dist/{needle-engine.bundle-DGcStTA7.js → needle-engine.bundle-B3xwa0ZL.js} +1995 -1976
  10. package/dist/{needle-engine.bundle-DmYMLdWP.umd.cjs → needle-engine.bundle-Bhmc3xq0.umd.cjs} +92 -89
  11. package/dist/{needle-engine.bundle-D0XWaCQs.min.js → needle-engine.bundle-DzStNbW2.min.js} +110 -107
  12. package/dist/needle-engine.d.ts +129 -130
  13. package/dist/needle-engine.js +4 -4
  14. package/dist/needle-engine.min.js +1 -1
  15. package/dist/needle-engine.umd.cjs +1 -1
  16. package/dist/{postprocessing-CjW23fio.umd.cjs → postprocessing-8AQTeZsr.umd.cjs} +2 -2
  17. package/dist/{postprocessing-xYQWCHFu.min.js → postprocessing-BDScN9yu.min.js} +2 -2
  18. package/dist/{postprocessing-DYLNOL3W.js → postprocessing-BkxN_08g.js} +3 -3
  19. package/dist/{three-DuDKwKB8.min.js → three-Boa-jOq-.min.js} +33 -33
  20. package/dist/{three-DrqIzZTH.js → three-Bz6X1mrw.js} +4198 -4198
  21. package/dist/{three-B_hneGZr.umd.cjs → three-DMrv-4ar.umd.cjs} +4 -4
  22. package/dist/{three-examples-X3OadjXB.umd.cjs → three-examples-C7ryg8vN.umd.cjs} +3 -3
  23. package/dist/{three-examples-DaDLBuy6.min.js → three-examples-DuVhxqft.min.js} +14 -14
  24. package/dist/{three-examples-B50TT3Iu.js → three-examples-GggCDHv0.js} +5 -5
  25. package/dist/{three-mesh-ui-CxuWt7m-.js → three-mesh-ui-CLNOfsWn.js} +1 -1
  26. package/dist/{three-mesh-ui-B3p3gyUz.min.js → three-mesh-ui-CY6Izc7C.min.js} +1 -1
  27. package/dist/{three-mesh-ui-CQiIQIlA.umd.cjs → three-mesh-ui-CwlN0FUC.umd.cjs} +1 -1
  28. package/dist/{vendor-BmYIgaS1.js → vendor-BSD1RQIh.js} +3 -3
  29. package/dist/{vendor-Cavtu3CP.umd.cjs → vendor-DHr4aqIZ.umd.cjs} +3 -3
  30. package/dist/{vendor-BlSxe9JJ.min.js → vendor-zxXa3Dmr.min.js} +3 -3
  31. package/lib/asap/needle-asap.d.ts +1 -1
  32. package/lib/asap/needle-asap.js +95 -95
  33. package/lib/asap/sessiongranted.d.ts +3 -3
  34. package/lib/asap/sessiongranted.js +65 -65
  35. package/lib/asap/utils.d.ts +1 -1
  36. package/lib/asap/utils.js +3 -3
  37. package/lib/engine/analytics/index.d.ts +6 -6
  38. package/lib/engine/analytics/index.js +12 -12
  39. package/lib/engine/analytics/lcp.d.ts +3 -3
  40. package/lib/engine/analytics/lcp.js +34 -34
  41. package/lib/engine/api.d.ts +82 -82
  42. package/lib/engine/api.js +81 -81
  43. package/lib/engine/assets/index.d.ts +11 -11
  44. package/lib/engine/assets/index.js +47 -47
  45. package/lib/engine/assets/static.d.ts +1 -1
  46. package/lib/engine/assets/static.js +4 -4
  47. package/lib/engine/codegen/register_types.d.ts +1 -1
  48. package/lib/engine/codegen/register_types.js +300 -300
  49. package/lib/engine/debug/debug.d.ts +15 -15
  50. package/lib/engine/debug/debug.js +44 -44
  51. package/lib/engine/debug/debug_console.d.ts +2 -2
  52. package/lib/engine/debug/debug_console.js +307 -307
  53. package/lib/engine/debug/debug_overlay.d.ts +22 -22
  54. package/lib/engine/debug/debug_overlay.js +316 -316
  55. package/lib/engine/debug/debug_spatial_console.d.ts +2 -2
  56. package/lib/engine/debug/debug_spatial_console.js +390 -390
  57. package/lib/engine/debug/index.d.ts +2 -2
  58. package/lib/engine/debug/index.js +2 -2
  59. package/lib/engine/engine_addressables.d.ts +166 -166
  60. package/lib/engine/engine_addressables.js +608 -608
  61. package/lib/engine/engine_animation.d.ts +43 -43
  62. package/lib/engine/engine_animation.js +133 -133
  63. package/lib/engine/engine_application.d.ts +45 -45
  64. package/lib/engine/engine_application.js +104 -104
  65. package/lib/engine/engine_assetdatabase.d.ts +25 -25
  66. package/lib/engine/engine_assetdatabase.js +346 -346
  67. package/lib/engine/engine_audio.d.ts +4 -4
  68. package/lib/engine/engine_audio.js +23 -23
  69. package/lib/engine/engine_camera.d.ts +13 -13
  70. package/lib/engine/engine_camera.js +30 -30
  71. package/lib/engine/engine_components.d.ts +110 -110
  72. package/lib/engine/engine_components.js +374 -374
  73. package/lib/engine/engine_components_internal.d.ts +9 -9
  74. package/lib/engine/engine_components_internal.js +36 -36
  75. package/lib/engine/engine_constants.d.ts +10 -10
  76. package/lib/engine/engine_constants.js +41 -41
  77. package/lib/engine/engine_context.d.ts +475 -475
  78. package/lib/engine/engine_context.js +1673 -1672
  79. package/lib/engine/engine_context.js.map +1 -1
  80. package/lib/engine/engine_context_registry.d.ts +71 -71
  81. package/lib/engine/engine_context_registry.js +117 -117
  82. package/lib/engine/engine_coroutine.d.ts +35 -35
  83. package/lib/engine/engine_coroutine.js +52 -52
  84. package/lib/engine/engine_create_objects.d.ts +119 -119
  85. package/lib/engine/engine_create_objects.js +320 -320
  86. package/lib/engine/engine_default_parameters.d.ts +2 -2
  87. package/lib/engine/engine_default_parameters.js +3 -3
  88. package/lib/engine/engine_editor-sync.d.ts +21 -21
  89. package/lib/engine/engine_editor-sync.js +4 -4
  90. package/lib/engine/engine_fileloader.d.ts +2 -2
  91. package/lib/engine/engine_fileloader.js +8 -8
  92. package/lib/engine/engine_gameobject.d.ts +68 -68
  93. package/lib/engine/engine_gameobject.js +619 -619
  94. package/lib/engine/engine_generic_utils.d.ts +1 -1
  95. package/lib/engine/engine_generic_utils.js +13 -13
  96. package/lib/engine/engine_gizmos.d.ts +149 -149
  97. package/lib/engine/engine_gizmos.js +530 -530
  98. package/lib/engine/engine_gltf.d.ts +12 -12
  99. package/lib/engine/engine_gltf.js +15 -15
  100. package/lib/engine/engine_gltf_builtin_components.d.ts +11 -11
  101. package/lib/engine/engine_gltf_builtin_components.js +341 -341
  102. package/lib/engine/engine_hot_reload.d.ts +8 -8
  103. package/lib/engine/engine_hot_reload.js +197 -197
  104. package/lib/engine/engine_input.d.ts +362 -362
  105. package/lib/engine/engine_input.js +1294 -1294
  106. package/lib/engine/engine_input_utils.d.ts +2 -2
  107. package/lib/engine/engine_input_utils.js +22 -22
  108. package/lib/engine/engine_instancing.d.ts +19 -19
  109. package/lib/engine/engine_instancing.js +39 -39
  110. package/lib/engine/engine_license.d.ts +11 -11
  111. package/lib/engine/engine_license.js +369 -369
  112. package/lib/engine/engine_lifecycle_api.d.ts +83 -83
  113. package/lib/engine/engine_lifecycle_api.js +106 -106
  114. package/lib/engine/engine_lifecycle_functions_internal.d.ts +32 -32
  115. package/lib/engine/engine_lifecycle_functions_internal.js +146 -146
  116. package/lib/engine/engine_lightdata.d.ts +23 -23
  117. package/lib/engine/engine_lightdata.js +91 -91
  118. package/lib/engine/engine_loaders.callbacks.d.ts +97 -97
  119. package/lib/engine/engine_loaders.callbacks.js +86 -86
  120. package/lib/engine/engine_loaders.d.ts +48 -48
  121. package/lib/engine/engine_loaders.gltf.d.ts +13 -13
  122. package/lib/engine/engine_loaders.gltf.js +62 -62
  123. package/lib/engine/engine_loaders.js +337 -337
  124. package/lib/engine/engine_lods.d.ts +31 -31
  125. package/lib/engine/engine_lods.js +146 -146
  126. package/lib/engine/engine_mainloop_utils.d.ts +32 -32
  127. package/lib/engine/engine_mainloop_utils.js +466 -466
  128. package/lib/engine/engine_math.d.ts +114 -114
  129. package/lib/engine/engine_math.js +247 -247
  130. package/lib/engine/engine_modules.d.ts +36 -36
  131. package/lib/engine/engine_modules.js +85 -85
  132. package/lib/engine/engine_networking.d.ts +260 -260
  133. package/lib/engine/engine_networking.js +764 -764
  134. package/lib/engine/engine_networking_auto.d.ts +24 -24
  135. package/lib/engine/engine_networking_auto.js +310 -310
  136. package/lib/engine/engine_networking_blob.d.ts +48 -48
  137. package/lib/engine/engine_networking_blob.js +228 -228
  138. package/lib/engine/engine_networking_files.d.ts +35 -35
  139. package/lib/engine/engine_networking_files.js +172 -172
  140. package/lib/engine/engine_networking_files_default_components.d.ts +6 -6
  141. package/lib/engine/engine_networking_files_default_components.js +42 -42
  142. package/lib/engine/engine_networking_instantiate.d.ts +100 -100
  143. package/lib/engine/engine_networking_instantiate.js +345 -345
  144. package/lib/engine/engine_networking_peer.d.ts +15 -15
  145. package/lib/engine/engine_networking_peer.js +132 -132
  146. package/lib/engine/engine_networking_streams.d.ts +123 -123
  147. package/lib/engine/engine_networking_streams.js +645 -645
  148. package/lib/engine/engine_networking_types.d.ts +22 -22
  149. package/lib/engine/engine_networking_types.js +7 -7
  150. package/lib/engine/engine_networking_utils.d.ts +2 -2
  151. package/lib/engine/engine_networking_utils.js +20 -20
  152. package/lib/engine/engine_networking_websocket.d.ts +1 -1
  153. package/lib/engine/engine_networking_websocket.js +2 -2
  154. package/lib/engine/engine_patcher.d.ts +10 -10
  155. package/lib/engine/engine_patcher.js +142 -142
  156. package/lib/engine/engine_physics.d.ts +152 -152
  157. package/lib/engine/engine_physics.js +645 -645
  158. package/lib/engine/engine_physics.types.d.ts +40 -40
  159. package/lib/engine/engine_physics.types.js +33 -33
  160. package/lib/engine/engine_physics_rapier.d.ts +147 -147
  161. package/lib/engine/engine_physics_rapier.js +1433 -1433
  162. package/lib/engine/engine_playerview.d.ts +26 -26
  163. package/lib/engine/engine_playerview.js +64 -64
  164. package/lib/engine/engine_scenelighting.d.ts +71 -71
  165. package/lib/engine/engine_scenelighting.js +226 -226
  166. package/lib/engine/engine_serialization.d.ts +3 -3
  167. package/lib/engine/engine_serialization.js +3 -3
  168. package/lib/engine/engine_serialization_builtin_serializer.d.ts +72 -72
  169. package/lib/engine/engine_serialization_builtin_serializer.js +403 -403
  170. package/lib/engine/engine_serialization_core.d.ts +94 -94
  171. package/lib/engine/engine_serialization_core.js +607 -607
  172. package/lib/engine/engine_serialization_decorator.d.ts +23 -23
  173. package/lib/engine/engine_serialization_decorator.js +66 -66
  174. package/lib/engine/engine_setup.d.ts +1 -1
  175. package/lib/engine/engine_setup.js +2 -2
  176. package/lib/engine/engine_shaders.d.ts +53 -53
  177. package/lib/engine/engine_shaders.js +252 -252
  178. package/lib/engine/engine_shims.d.ts +4 -4
  179. package/lib/engine/engine_shims.js +24 -24
  180. package/lib/engine/engine_test_utils.d.ts +39 -39
  181. package/lib/engine/engine_test_utils.js +83 -83
  182. package/lib/engine/engine_texture.d.ts +28 -28
  183. package/lib/engine/engine_texture.js +64 -64
  184. package/lib/engine/engine_three_utils.d.ts +204 -204
  185. package/lib/engine/engine_three_utils.js +784 -784
  186. package/lib/engine/engine_time.d.ts +51 -51
  187. package/lib/engine/engine_time.js +82 -82
  188. package/lib/engine/engine_time_utils.d.ts +88 -88
  189. package/lib/engine/engine_time_utils.js +215 -215
  190. package/lib/engine/engine_tonemapping.d.ts +6 -6
  191. package/lib/engine/engine_tonemapping.js +197 -197
  192. package/lib/engine/engine_types.d.ts +578 -578
  193. package/lib/engine/engine_types.js +95 -95
  194. package/lib/engine/engine_typestore.d.ts +28 -28
  195. package/lib/engine/engine_typestore.js +55 -55
  196. package/lib/engine/engine_util_decorator.d.ts +13 -13
  197. package/lib/engine/engine_util_decorator.js +116 -116
  198. package/lib/engine/engine_utils.d.ts +248 -248
  199. package/lib/engine/engine_utils.js +1012 -1012
  200. package/lib/engine/engine_utils_format.d.ts +24 -24
  201. package/lib/engine/engine_utils_format.js +239 -239
  202. package/lib/engine/engine_utils_screenshot.d.ts +159 -159
  203. package/lib/engine/engine_utils_screenshot.js +522 -522
  204. package/lib/engine/engine_utils_screenshot.xr.d.ts +5 -5
  205. package/lib/engine/engine_utils_screenshot.xr.js +90 -90
  206. package/lib/engine/engine_xr.d.ts +1 -1
  207. package/lib/engine/engine_xr.js +1 -1
  208. package/lib/engine/export/gltf/Writers.d.ts +19 -19
  209. package/lib/engine/export/gltf/Writers.js +24 -24
  210. package/lib/engine/export/gltf/index.d.ts +11 -11
  211. package/lib/engine/export/gltf/index.js +123 -123
  212. package/lib/engine/export/index.d.ts +2 -2
  213. package/lib/engine/export/index.js +2 -2
  214. package/lib/engine/export/state.d.ts +7 -7
  215. package/lib/engine/export/state.js +17 -17
  216. package/lib/engine/export/utils.d.ts +2 -2
  217. package/lib/engine/export/utils.js +7 -7
  218. package/lib/engine/extensions/EXT_texture_exr.d.ts +8 -8
  219. package/lib/engine/extensions/EXT_texture_exr.js +32 -32
  220. package/lib/engine/extensions/NEEDLE_animator_controller_model.d.ts +122 -122
  221. package/lib/engine/extensions/NEEDLE_animator_controller_model.js +95 -95
  222. package/lib/engine/extensions/NEEDLE_components.d.ts +35 -35
  223. package/lib/engine/extensions/NEEDLE_components.js +220 -220
  224. package/lib/engine/extensions/NEEDLE_gameobject_data.d.ts +10 -10
  225. package/lib/engine/extensions/NEEDLE_gameobject_data.js +57 -57
  226. package/lib/engine/extensions/NEEDLE_lighting_settings.d.ts +37 -37
  227. package/lib/engine/extensions/NEEDLE_lighting_settings.js +157 -157
  228. package/lib/engine/extensions/NEEDLE_lightmaps.d.ts +18 -18
  229. package/lib/engine/extensions/NEEDLE_lightmaps.js +99 -99
  230. package/lib/engine/extensions/NEEDLE_persistent_assets.d.ts +11 -11
  231. package/lib/engine/extensions/NEEDLE_persistent_assets.js +63 -63
  232. package/lib/engine/extensions/NEEDLE_progressive.d.ts +1 -1
  233. package/lib/engine/extensions/NEEDLE_progressive.js +1 -1
  234. package/lib/engine/extensions/NEEDLE_render_objects.d.ts +13 -13
  235. package/lib/engine/extensions/NEEDLE_render_objects.js +159 -159
  236. package/lib/engine/extensions/NEEDLE_techniques_webgl.d.ts +38 -38
  237. package/lib/engine/extensions/NEEDLE_techniques_webgl.js +564 -564
  238. package/lib/engine/extensions/extension_resolver.d.ts +4 -4
  239. package/lib/engine/extensions/extension_resolver.js +1 -1
  240. package/lib/engine/extensions/extension_utils.d.ts +12 -12
  241. package/lib/engine/extensions/extension_utils.js +152 -152
  242. package/lib/engine/extensions/extensions.d.ts +32 -32
  243. package/lib/engine/extensions/extensions.js +107 -107
  244. package/lib/engine/extensions/index.d.ts +6 -6
  245. package/lib/engine/extensions/index.js +6 -6
  246. package/lib/engine/extensions/usage_tracker.d.ts +13 -13
  247. package/lib/engine/extensions/usage_tracker.js +65 -65
  248. package/lib/engine/js-extensions/Camera.d.ts +1 -1
  249. package/lib/engine/js-extensions/Camera.js +39 -39
  250. package/lib/engine/js-extensions/ExtensionUtils.d.ts +9 -9
  251. package/lib/engine/js-extensions/ExtensionUtils.js +67 -67
  252. package/lib/engine/js-extensions/Layers.d.ts +6 -6
  253. package/lib/engine/js-extensions/Layers.js +22 -22
  254. package/lib/engine/js-extensions/Object3D.d.ts +120 -120
  255. package/lib/engine/js-extensions/Object3D.js +136 -136
  256. package/lib/engine/js-extensions/RGBAColor.d.ts +23 -23
  257. package/lib/engine/js-extensions/RGBAColor.js +111 -111
  258. package/lib/engine/js-extensions/Vector.d.ts +3 -3
  259. package/lib/engine/js-extensions/Vector.js +13 -13
  260. package/lib/engine/js-extensions/index.d.ts +5 -5
  261. package/lib/engine/js-extensions/index.js +5 -5
  262. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.d.ts +4 -4
  263. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +79 -79
  264. package/lib/engine/shaders/shaderData.d.ts +55 -55
  265. package/lib/engine/shaders/shaderData.js +58 -58
  266. package/lib/engine/tests/test_utils.d.ts +2 -2
  267. package/lib/engine/tests/test_utils.js +53 -53
  268. package/lib/engine/webcomponents/WebXRButtons.d.ts +56 -56
  269. package/lib/engine/webcomponents/WebXRButtons.js +230 -230
  270. package/lib/engine/webcomponents/api.d.ts +5 -5
  271. package/lib/engine/webcomponents/api.js +4 -4
  272. package/lib/engine/webcomponents/buttons.d.ts +51 -51
  273. package/lib/engine/webcomponents/buttons.js +264 -264
  274. package/lib/engine/webcomponents/fonts.d.ts +9 -9
  275. package/lib/engine/webcomponents/fonts.js +32 -32
  276. package/lib/engine/webcomponents/icons.d.ts +9 -9
  277. package/lib/engine/webcomponents/icons.js +52 -52
  278. package/lib/engine/webcomponents/index.d.ts +1 -1
  279. package/lib/engine/webcomponents/index.js +1 -1
  280. package/lib/engine/webcomponents/logo-element.d.ts +10 -10
  281. package/lib/engine/webcomponents/logo-element.js +67 -67
  282. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.d.ts +37 -37
  283. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.js +513 -513
  284. package/lib/engine/webcomponents/needle menu/needle-menu.d.ts +155 -155
  285. package/lib/engine/webcomponents/needle menu/needle-menu.js +1029 -1029
  286. package/lib/engine/webcomponents/needle-button.d.ts +34 -34
  287. package/lib/engine/webcomponents/needle-button.js +161 -161
  288. package/lib/engine/webcomponents/needle-engine.ar-overlay.d.ts +21 -21
  289. package/lib/engine/webcomponents/needle-engine.ar-overlay.js +166 -166
  290. package/lib/engine/webcomponents/needle-engine.attributes.d.ts +69 -69
  291. package/lib/engine/webcomponents/needle-engine.attributes.js +1 -1
  292. package/lib/engine/webcomponents/needle-engine.d.ts +116 -116
  293. package/lib/engine/webcomponents/needle-engine.extras.d.ts +6 -6
  294. package/lib/engine/webcomponents/needle-engine.extras.js +13 -13
  295. package/lib/engine/webcomponents/needle-engine.js +821 -821
  296. package/lib/engine/webcomponents/needle-engine.loading.d.ts +44 -44
  297. package/lib/engine/webcomponents/needle-engine.loading.js +341 -341
  298. package/lib/engine/xr/NeedleXRController.d.ts +313 -313
  299. package/lib/engine/xr/NeedleXRController.js +1007 -1007
  300. package/lib/engine/xr/NeedleXRSession.d.ts +340 -340
  301. package/lib/engine/xr/NeedleXRSession.js +1463 -1463
  302. package/lib/engine/xr/NeedleXRSync.d.ts +22 -22
  303. package/lib/engine/xr/NeedleXRSync.js +188 -188
  304. package/lib/engine/xr/SceneTransition.d.ts +18 -18
  305. package/lib/engine/xr/SceneTransition.js +69 -69
  306. package/lib/engine/xr/TempXRContext.d.ts +34 -34
  307. package/lib/engine/xr/TempXRContext.js +187 -187
  308. package/lib/engine/xr/XRRig.d.ts +7 -7
  309. package/lib/engine/xr/XRRig.js +1 -1
  310. package/lib/engine/xr/api.d.ts +6 -6
  311. package/lib/engine/xr/api.js +6 -6
  312. package/lib/engine/xr/events.d.ts +66 -66
  313. package/lib/engine/xr/events.js +93 -93
  314. package/lib/engine/xr/internal.d.ts +12 -12
  315. package/lib/engine/xr/internal.js +25 -25
  316. package/lib/engine/xr/usdz.d.ts +12 -12
  317. package/lib/engine/xr/usdz.js +29 -29
  318. package/lib/engine/xr/utils.d.ts +11 -11
  319. package/lib/engine/xr/utils.js +34 -34
  320. package/lib/engine-components/AlignmentConstraint.d.ts +10 -10
  321. package/lib/engine-components/AlignmentConstraint.js +39 -39
  322. package/lib/engine-components/Animation.d.ts +156 -156
  323. package/lib/engine-components/Animation.js +508 -508
  324. package/lib/engine-components/AnimationCurve.d.ts +40 -40
  325. package/lib/engine-components/AnimationCurve.js +159 -159
  326. package/lib/engine-components/AnimationUtils.d.ts +8 -8
  327. package/lib/engine-components/AnimationUtils.js +27 -27
  328. package/lib/engine-components/AnimationUtilsAutoplay.d.ts +1 -1
  329. package/lib/engine-components/AnimationUtilsAutoplay.js +39 -39
  330. package/lib/engine-components/Animator.d.ts +217 -217
  331. package/lib/engine-components/Animator.js +354 -354
  332. package/lib/engine-components/AnimatorController.d.ts +227 -227
  333. package/lib/engine-components/AnimatorController.js +1152 -1152
  334. package/lib/engine-components/AudioListener.d.ts +33 -33
  335. package/lib/engine-components/AudioListener.js +86 -86
  336. package/lib/engine-components/AudioSource.d.ts +217 -217
  337. package/lib/engine-components/AudioSource.js +635 -635
  338. package/lib/engine-components/AvatarLoader.d.ts +80 -80
  339. package/lib/engine-components/AvatarLoader.js +231 -231
  340. package/lib/engine-components/AxesHelper.d.ts +32 -32
  341. package/lib/engine-components/AxesHelper.js +67 -67
  342. package/lib/engine-components/BasicIKConstraint.d.ts +9 -9
  343. package/lib/engine-components/BasicIKConstraint.js +43 -43
  344. package/lib/engine-components/BoxCollider.d.ts +2 -2
  345. package/lib/engine-components/BoxCollider.js +2 -2
  346. package/lib/engine-components/BoxHelperComponent.d.ts +47 -47
  347. package/lib/engine-components/BoxHelperComponent.js +102 -102
  348. package/lib/engine-components/Camera.d.ts +231 -231
  349. package/lib/engine-components/Camera.js +700 -700
  350. package/lib/engine-components/CameraUtils.d.ts +1 -1
  351. package/lib/engine-components/CameraUtils.js +121 -121
  352. package/lib/engine-components/CharacterController.d.ts +55 -55
  353. package/lib/engine-components/CharacterController.js +236 -236
  354. package/lib/engine-components/Collider.d.ts +188 -188
  355. package/lib/engine-components/Collider.js +369 -369
  356. package/lib/engine-components/Component.d.ts +792 -792
  357. package/lib/engine-components/Component.js +920 -920
  358. package/lib/engine-components/ContactShadows.d.ts +94 -94
  359. package/lib/engine-components/ContactShadows.js +453 -453
  360. package/lib/engine-components/DeleteBox.d.ts +19 -19
  361. package/lib/engine-components/DeleteBox.js +58 -58
  362. package/lib/engine-components/DeviceFlag.d.ts +16 -16
  363. package/lib/engine-components/DeviceFlag.js +47 -47
  364. package/lib/engine-components/DragControls.d.ts +170 -170
  365. package/lib/engine-components/DragControls.js +1421 -1421
  366. package/lib/engine-components/DropListener.d.ts +215 -215
  367. package/lib/engine-components/DropListener.js +642 -642
  368. package/lib/engine-components/Duplicatable.d.ts +35 -35
  369. package/lib/engine-components/Duplicatable.js +202 -202
  370. package/lib/engine-components/EventList.d.ts +54 -54
  371. package/lib/engine-components/EventList.js +232 -232
  372. package/lib/engine-components/EventTrigger.d.ts +33 -33
  373. package/lib/engine-components/EventTrigger.js +75 -75
  374. package/lib/engine-components/EventType.d.ts +22 -22
  375. package/lib/engine-components/EventType.js +23 -23
  376. package/lib/engine-components/Fog.d.ts +22 -22
  377. package/lib/engine-components/Fog.js +61 -61
  378. package/lib/engine-components/Gizmos.d.ts +17 -17
  379. package/lib/engine-components/Gizmos.js +64 -64
  380. package/lib/engine-components/GridHelper.d.ts +20 -20
  381. package/lib/engine-components/GridHelper.js +54 -54
  382. package/lib/engine-components/GroundProjection.d.ts +67 -67
  383. package/lib/engine-components/GroundProjection.js +343 -343
  384. package/lib/engine-components/Interactable.d.ts +12 -12
  385. package/lib/engine-components/Interactable.js +12 -12
  386. package/lib/engine-components/Joints.d.ts +19 -19
  387. package/lib/engine-components/Joints.js +51 -51
  388. package/lib/engine-components/LODGroup.d.ts +35 -35
  389. package/lib/engine-components/LODGroup.js +152 -152
  390. package/lib/engine-components/Light.d.ts +180 -180
  391. package/lib/engine-components/Light.js +535 -535
  392. package/lib/engine-components/LookAtConstraint.d.ts +19 -19
  393. package/lib/engine-components/LookAtConstraint.js +35 -35
  394. package/lib/engine-components/NeedleMenu.d.ts +50 -50
  395. package/lib/engine-components/NeedleMenu.js +92 -92
  396. package/lib/engine-components/NestedGltf.d.ts +25 -25
  397. package/lib/engine-components/NestedGltf.js +88 -88
  398. package/lib/engine-components/Networking.d.ts +54 -54
  399. package/lib/engine-components/Networking.js +112 -112
  400. package/lib/engine-components/OffsetConstraint.d.ts +14 -14
  401. package/lib/engine-components/OffsetConstraint.js +65 -65
  402. package/lib/engine-components/OrbitControls.d.ts +268 -268
  403. package/lib/engine-components/OrbitControls.js +1015 -1015
  404. package/lib/engine-components/PlayerColor.d.ts +19 -19
  405. package/lib/engine-components/PlayerColor.js +94 -94
  406. package/lib/engine-components/ReflectionProbe.d.ts +28 -28
  407. package/lib/engine-components/ReflectionProbe.js +204 -204
  408. package/lib/engine-components/Renderer.d.ts +153 -153
  409. package/lib/engine-components/Renderer.js +834 -834
  410. package/lib/engine-components/RendererInstancing.d.ts +140 -140
  411. package/lib/engine-components/RendererInstancing.js +744 -744
  412. package/lib/engine-components/RendererLightmap.d.ts +24 -24
  413. package/lib/engine-components/RendererLightmap.js +182 -182
  414. package/lib/engine-components/RigidBody.d.ts +155 -155
  415. package/lib/engine-components/RigidBody.js +517 -517
  416. package/lib/engine-components/SceneSwitcher.d.ts +263 -263
  417. package/lib/engine-components/SceneSwitcher.js +971 -971
  418. package/lib/engine-components/ScreenCapture.d.ts +144 -144
  419. package/lib/engine-components/ScreenCapture.js +547 -547
  420. package/lib/engine-components/ShadowCatcher.d.ts +33 -33
  421. package/lib/engine-components/ShadowCatcher.js +166 -166
  422. package/lib/engine-components/Skybox.d.ts +88 -88
  423. package/lib/engine-components/Skybox.js +469 -469
  424. package/lib/engine-components/SmoothFollow.d.ts +34 -34
  425. package/lib/engine-components/SmoothFollow.js +82 -82
  426. package/lib/engine-components/SpatialTrigger.d.ts +102 -102
  427. package/lib/engine-components/SpatialTrigger.js +225 -225
  428. package/lib/engine-components/SpectatorCamera.d.ts +111 -111
  429. package/lib/engine-components/SpectatorCamera.js +715 -715
  430. package/lib/engine-components/SphereCollider.d.ts +2 -2
  431. package/lib/engine-components/SphereCollider.js +2 -2
  432. package/lib/engine-components/SpriteRenderer.d.ts +132 -132
  433. package/lib/engine-components/SpriteRenderer.js +472 -472
  434. package/lib/engine-components/SyncedCamera.d.ts +41 -41
  435. package/lib/engine-components/SyncedCamera.js +199 -199
  436. package/lib/engine-components/SyncedRoom.d.ts +106 -106
  437. package/lib/engine-components/SyncedRoom.js +371 -371
  438. package/lib/engine-components/SyncedTransform.d.ts +94 -94
  439. package/lib/engine-components/SyncedTransform.js +331 -331
  440. package/lib/engine-components/TestRunner.d.ts +16 -16
  441. package/lib/engine-components/TestRunner.js +102 -102
  442. package/lib/engine-components/TransformGizmo.d.ts +75 -75
  443. package/lib/engine-components/TransformGizmo.js +209 -209
  444. package/lib/engine-components/VideoPlayer.d.ts +184 -184
  445. package/lib/engine-components/VideoPlayer.js +978 -978
  446. package/lib/engine-components/Voip.d.ts +67 -67
  447. package/lib/engine-components/Voip.js +360 -360
  448. package/lib/engine-components/api.d.ts +51 -51
  449. package/lib/engine-components/api.js +50 -50
  450. package/lib/engine-components/avatar/AvatarBlink_Simple.d.ts +11 -11
  451. package/lib/engine-components/avatar/AvatarBlink_Simple.js +76 -76
  452. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.d.ts +14 -14
  453. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.js +68 -68
  454. package/lib/engine-components/avatar/Avatar_Brain_LookAt.d.ts +29 -29
  455. package/lib/engine-components/avatar/Avatar_Brain_LookAt.js +121 -121
  456. package/lib/engine-components/avatar/Avatar_MouthShapes.d.ts +15 -15
  457. package/lib/engine-components/avatar/Avatar_MouthShapes.js +79 -79
  458. package/lib/engine-components/avatar/Avatar_MustacheShake.d.ts +9 -9
  459. package/lib/engine-components/avatar/Avatar_MustacheShake.js +29 -29
  460. package/lib/engine-components/codegen/components.d.ts +216 -216
  461. package/lib/engine-components/codegen/components.js +218 -218
  462. package/lib/engine-components/debug/LogStats.d.ts +5 -5
  463. package/lib/engine-components/debug/LogStats.js +18 -18
  464. package/lib/engine-components/export/gltf/GltfExport.d.ts +30 -30
  465. package/lib/engine-components/export/gltf/GltfExport.js +246 -246
  466. package/lib/engine-components/export/gltf/index.d.ts +1 -1
  467. package/lib/engine-components/export/gltf/index.js +1 -1
  468. package/lib/engine-components/export/index.d.ts +1 -1
  469. package/lib/engine-components/export/index.js +1 -1
  470. package/lib/engine-components/export/usdz/Extension.d.ts +22 -22
  471. package/lib/engine-components/export/usdz/Extension.js +1 -1
  472. package/lib/engine-components/export/usdz/ThreeUSDZExporter.d.ts +160 -160
  473. package/lib/engine-components/export/usdz/ThreeUSDZExporter.js +1782 -1782
  474. package/lib/engine-components/export/usdz/USDZExporter.d.ts +130 -130
  475. package/lib/engine-components/export/usdz/USDZExporter.js +663 -663
  476. package/lib/engine-components/export/usdz/extensions/Animation.d.ts +106 -106
  477. package/lib/engine-components/export/usdz/extensions/Animation.js +1071 -1071
  478. package/lib/engine-components/export/usdz/extensions/DocumentExtension.d.ts +5 -5
  479. package/lib/engine-components/export/usdz/extensions/DocumentExtension.js +6 -6
  480. package/lib/engine-components/export/usdz/extensions/NodeMaterialConverter.d.ts +10 -0
  481. package/lib/engine-components/export/usdz/extensions/NodeMaterialConverter.js +452 -0
  482. package/lib/engine-components/export/usdz/extensions/NodeMaterialConverter.js.map +1 -0
  483. package/lib/engine-components/export/usdz/extensions/USDZText.d.ts +54 -54
  484. package/lib/engine-components/export/usdz/extensions/USDZText.js +203 -203
  485. package/lib/engine-components/export/usdz/extensions/USDZUI.d.ts +8 -8
  486. package/lib/engine-components/export/usdz/extensions/USDZUI.js +158 -158
  487. package/lib/engine-components/export/usdz/extensions/behavior/Actions.d.ts +30 -30
  488. package/lib/engine-components/export/usdz/extensions/behavior/Actions.js +88 -88
  489. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.d.ts +10 -10
  490. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.js +86 -86
  491. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.d.ts +28 -28
  492. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.js +290 -290
  493. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.d.ts +190 -190
  494. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.js +1060 -1060
  495. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.d.ts +135 -135
  496. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.js +548 -548
  497. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.d.ts +7 -7
  498. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.js +115 -115
  499. package/lib/engine-components/export/usdz/index.d.ts +3 -3
  500. package/lib/engine-components/export/usdz/index.js +2 -2
  501. package/lib/engine-components/export/usdz/utils/animationutils.d.ts +7 -7
  502. package/lib/engine-components/export/usdz/utils/animationutils.js +163 -163
  503. package/lib/engine-components/export/usdz/utils/quicklook.d.ts +2 -2
  504. package/lib/engine-components/export/usdz/utils/quicklook.js +43 -43
  505. package/lib/engine-components/particlesystem/ParticleSystem.d.ts +177 -177
  506. package/lib/engine-components/particlesystem/ParticleSystem.js +1176 -1176
  507. package/lib/engine-components/particlesystem/ParticleSystemModules.d.ts +526 -526
  508. package/lib/engine-components/particlesystem/ParticleSystemModules.js +1930 -1930
  509. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.d.ts +25 -25
  510. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.js +87 -87
  511. package/lib/engine-components/particlesystem/api.d.ts +2 -2
  512. package/lib/engine-components/particlesystem/api.js +2 -2
  513. package/lib/engine-components/postprocessing/Effects/Antialiasing.d.ts +17 -17
  514. package/lib/engine-components/postprocessing/Effects/Antialiasing.js +59 -52
  515. package/lib/engine-components/postprocessing/Effects/Antialiasing.js.map +1 -1
  516. package/lib/engine-components/postprocessing/Effects/BloomEffect.d.ts +46 -46
  517. package/lib/engine-components/postprocessing/Effects/BloomEffect.js +113 -116
  518. package/lib/engine-components/postprocessing/Effects/BloomEffect.js.map +1 -1
  519. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.d.ts +11 -11
  520. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.js +39 -39
  521. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.d.ts +23 -23
  522. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.js +111 -111
  523. package/lib/engine-components/postprocessing/Effects/DepthOfField.d.ts +25 -25
  524. package/lib/engine-components/postprocessing/Effects/DepthOfField.js +104 -104
  525. package/lib/engine-components/postprocessing/Effects/EffectWrapper.d.ts +12 -12
  526. package/lib/engine-components/postprocessing/Effects/EffectWrapper.js +18 -18
  527. package/lib/engine-components/postprocessing/Effects/Pixelation.d.ts +11 -11
  528. package/lib/engine-components/postprocessing/Effects/Pixelation.js +32 -32
  529. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.d.ts +18 -18
  530. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.js +91 -91
  531. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.d.ts +70 -70
  532. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.js +176 -176
  533. package/lib/engine-components/postprocessing/Effects/Sharpening.d.ts +18 -18
  534. package/lib/engine-components/postprocessing/Effects/Sharpening.js +127 -127
  535. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.d.ts +17 -17
  536. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.js +70 -70
  537. package/lib/engine-components/postprocessing/Effects/Tonemapping.d.ts +19 -19
  538. package/lib/engine-components/postprocessing/Effects/Tonemapping.js +94 -94
  539. package/lib/engine-components/postprocessing/Effects/Tonemapping.utils.d.ts +13 -13
  540. package/lib/engine-components/postprocessing/Effects/Tonemapping.utils.js +51 -51
  541. package/lib/engine-components/postprocessing/Effects/Vignette.d.ts +15 -15
  542. package/lib/engine-components/postprocessing/Effects/Vignette.js +60 -60
  543. package/lib/engine-components/postprocessing/PostProcessingEffect.d.ts +90 -90
  544. package/lib/engine-components/postprocessing/PostProcessingEffect.js +168 -168
  545. package/lib/engine-components/postprocessing/PostProcessingHandler.d.ts +42 -42
  546. package/lib/engine-components/postprocessing/PostProcessingHandler.js +495 -462
  547. package/lib/engine-components/postprocessing/PostProcessingHandler.js.map +1 -1
  548. package/lib/engine-components/postprocessing/Volume.d.ts +90 -90
  549. package/lib/engine-components/postprocessing/Volume.js +385 -385
  550. package/lib/engine-components/postprocessing/Volume.js.map +1 -1
  551. package/lib/engine-components/postprocessing/VolumeParameter.d.ts +26 -26
  552. package/lib/engine-components/postprocessing/VolumeParameter.js +136 -136
  553. package/lib/engine-components/postprocessing/VolumeProfile.d.ts +15 -15
  554. package/lib/engine-components/postprocessing/VolumeProfile.js +60 -60
  555. package/lib/engine-components/postprocessing/index.d.ts +6 -6
  556. package/lib/engine-components/postprocessing/index.js +6 -6
  557. package/lib/engine-components/postprocessing/utils.d.ts +55 -54
  558. package/lib/engine-components/postprocessing/utils.js +119 -119
  559. package/lib/engine-components/postprocessing/utils.js.map +1 -1
  560. package/lib/engine-components/timeline/PlayableDirector.d.ts +163 -163
  561. package/lib/engine-components/timeline/PlayableDirector.js +686 -686
  562. package/lib/engine-components/timeline/SignalAsset.d.ts +24 -24
  563. package/lib/engine-components/timeline/SignalAsset.js +130 -130
  564. package/lib/engine-components/timeline/TimelineModels.d.ts +89 -89
  565. package/lib/engine-components/timeline/TimelineModels.js +22 -22
  566. package/lib/engine-components/timeline/TimelineTracks.d.ts +110 -110
  567. package/lib/engine-components/timeline/TimelineTracks.js +879 -879
  568. package/lib/engine-components/timeline/index.d.ts +4 -4
  569. package/lib/engine-components/timeline/index.js +3 -3
  570. package/lib/engine-components/ui/BaseUIComponent.d.ts +48 -48
  571. package/lib/engine-components/ui/BaseUIComponent.js +170 -170
  572. package/lib/engine-components/ui/Button.d.ts +64 -64
  573. package/lib/engine-components/ui/Button.js +315 -315
  574. package/lib/engine-components/ui/Canvas.d.ts +74 -74
  575. package/lib/engine-components/ui/Canvas.js +407 -407
  576. package/lib/engine-components/ui/CanvasGroup.d.ts +19 -19
  577. package/lib/engine-components/ui/CanvasGroup.js +58 -58
  578. package/lib/engine-components/ui/EventSystem.d.ts +125 -125
  579. package/lib/engine-components/ui/EventSystem.js +765 -765
  580. package/lib/engine-components/ui/Graphic.d.ts +55 -55
  581. package/lib/engine-components/ui/Graphic.js +255 -255
  582. package/lib/engine-components/ui/Image.d.ts +35 -35
  583. package/lib/engine-components/ui/Image.js +116 -116
  584. package/lib/engine-components/ui/InputField.d.ts +42 -42
  585. package/lib/engine-components/ui/InputField.js +268 -268
  586. package/lib/engine-components/ui/Interfaces.d.ts +38 -38
  587. package/lib/engine-components/ui/Interfaces.js +12 -12
  588. package/lib/engine-components/ui/Layout.d.ts +84 -84
  589. package/lib/engine-components/ui/Layout.js +330 -330
  590. package/lib/engine-components/ui/Outline.d.ts +7 -7
  591. package/lib/engine-components/ui/Outline.js +20 -20
  592. package/lib/engine-components/ui/PointerEvents.d.ts +115 -115
  593. package/lib/engine-components/ui/PointerEvents.js +145 -145
  594. package/lib/engine-components/ui/RaycastUtils.d.ts +11 -11
  595. package/lib/engine-components/ui/RaycastUtils.js +67 -67
  596. package/lib/engine-components/ui/Raycaster.d.ts +30 -30
  597. package/lib/engine-components/ui/Raycaster.js +95 -95
  598. package/lib/engine-components/ui/RectTransform.d.ts +61 -61
  599. package/lib/engine-components/ui/RectTransform.js +356 -356
  600. package/lib/engine-components/ui/SpatialHtml.d.ts +8 -8
  601. package/lib/engine-components/ui/SpatialHtml.js +79 -79
  602. package/lib/engine-components/ui/Symbols.d.ts +1 -1
  603. package/lib/engine-components/ui/Symbols.js +1 -1
  604. package/lib/engine-components/ui/Text.d.ts +78 -78
  605. package/lib/engine-components/ui/Text.js +539 -539
  606. package/lib/engine-components/ui/Utils.d.ts +24 -24
  607. package/lib/engine-components/ui/Utils.js +90 -90
  608. package/lib/engine-components/ui/index.d.ts +1 -1
  609. package/lib/engine-components/ui/index.js +1 -1
  610. package/lib/engine-components/utils/EnvironmentScene.d.ts +5 -5
  611. package/lib/engine-components/utils/EnvironmentScene.js +205 -205
  612. package/lib/engine-components/utils/LookAt.d.ts +31 -31
  613. package/lib/engine-components/utils/LookAt.js +82 -82
  614. package/lib/engine-components/utils/OpenURL.d.ts +42 -42
  615. package/lib/engine-components/utils/OpenURL.js +119 -119
  616. package/lib/engine-components/webxr/Avatar.d.ts +25 -25
  617. package/lib/engine-components/webxr/Avatar.js +255 -255
  618. package/lib/engine-components/webxr/TeleportTarget.d.ts +7 -7
  619. package/lib/engine-components/webxr/TeleportTarget.js +7 -7
  620. package/lib/engine-components/webxr/WebARCameraBackground.d.ts +30 -30
  621. package/lib/engine-components/webxr/WebARCameraBackground.js +155 -155
  622. package/lib/engine-components/webxr/WebARSessionRoot.d.ts +98 -98
  623. package/lib/engine-components/webxr/WebARSessionRoot.js +770 -770
  624. package/lib/engine-components/webxr/WebXR.d.ts +232 -232
  625. package/lib/engine-components/webxr/WebXR.js +561 -561
  626. package/lib/engine-components/webxr/WebXRAvatar.d.ts +27 -27
  627. package/lib/engine-components/webxr/WebXRAvatar.js +44 -44
  628. package/lib/engine-components/webxr/WebXRImageTracking.d.ts +86 -86
  629. package/lib/engine-components/webxr/WebXRImageTracking.js +471 -471
  630. package/lib/engine-components/webxr/WebXRPlaneTracking.d.ts +92 -92
  631. package/lib/engine-components/webxr/WebXRPlaneTracking.js +500 -500
  632. package/lib/engine-components/webxr/WebXRRig.d.ts +32 -32
  633. package/lib/engine-components/webxr/WebXRRig.js +72 -72
  634. package/lib/engine-components/webxr/XRFlag.d.ts +38 -38
  635. package/lib/engine-components/webxr/XRFlag.js +139 -139
  636. package/lib/engine-components/webxr/controllers/XRControllerFollow.d.ts +47 -47
  637. package/lib/engine-components/webxr/controllers/XRControllerFollow.js +120 -120
  638. package/lib/engine-components/webxr/controllers/XRControllerModel.d.ts +43 -43
  639. package/lib/engine-components/webxr/controllers/XRControllerModel.js +352 -352
  640. package/lib/engine-components/webxr/controllers/XRControllerMovement.d.ts +78 -78
  641. package/lib/engine-components/webxr/controllers/XRControllerMovement.js +506 -506
  642. package/lib/engine-components/webxr/index.d.ts +3 -3
  643. package/lib/engine-components/webxr/index.js +3 -3
  644. package/lib/engine-components/webxr/types.d.ts +3 -3
  645. package/lib/engine-components/webxr/types.js +1 -1
  646. package/lib/engine-components-experimental/Presentation.d.ts +6 -6
  647. package/lib/engine-components-experimental/Presentation.js +9 -9
  648. package/lib/engine-components-experimental/api.d.ts +4 -4
  649. package/lib/engine-components-experimental/api.js +4 -4
  650. package/lib/engine-components-experimental/networking/PlayerSync.d.ts +156 -156
  651. package/lib/engine-components-experimental/networking/PlayerSync.js +377 -377
  652. package/lib/engine-schemes/api.d.ts +12 -12
  653. package/lib/engine-schemes/api.js +12 -12
  654. package/lib/engine-schemes/schemes.d.ts +7 -7
  655. package/lib/engine-schemes/schemes.js +19 -19
  656. package/lib/engine-schemes/synced-camera-model.d.ts +25 -25
  657. package/lib/engine-schemes/synced-camera-model.js +67 -67
  658. package/lib/engine-schemes/synced-transform-model.d.ts +31 -31
  659. package/lib/engine-schemes/synced-transform-model.js +66 -66
  660. package/lib/engine-schemes/transform.d.ts +12 -12
  661. package/lib/engine-schemes/transform.js +39 -39
  662. package/lib/engine-schemes/vec2.d.ts +10 -10
  663. package/lib/engine-schemes/vec2.js +25 -25
  664. package/lib/engine-schemes/vec3.d.ts +11 -11
  665. package/lib/engine-schemes/vec3.js +29 -29
  666. package/lib/engine-schemes/vec4.d.ts +12 -12
  667. package/lib/engine-schemes/vec4.js +33 -33
  668. package/lib/engine-schemes/vr-user-state-buffer.d.ts +37 -37
  669. package/lib/engine-schemes/vr-user-state-buffer.js +110 -110
  670. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.d.ts +6 -6
  671. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.js +45 -45
  672. package/lib/needle-engine.d.ts +7 -7
  673. package/lib/needle-engine.js +64 -64
  674. package/package.json +1 -1
  675. package/plugins/common/buildinfo.js +64 -64
  676. package/plugins/common/cloud.js +1 -1
  677. package/plugins/common/config.cjs +31 -31
  678. package/plugins/common/config.js +35 -35
  679. package/plugins/common/files.js +31 -31
  680. package/plugins/common/generator.js +10 -10
  681. package/plugins/common/license.js +452 -452
  682. package/plugins/common/npm.js +15 -15
  683. package/plugins/common/timers.js +7 -7
  684. package/plugins/common/version.js +37 -37
  685. package/plugins/gltf-packer.mjs +1 -1
  686. package/plugins/next/alias.cjs +39 -39
  687. package/plugins/next/license.cjs +24 -24
  688. package/plugins/next/meshbvhworker.cjs +18 -18
  689. package/plugins/next/next.js +141 -141
  690. package/plugins/types/index.d.ts +2 -2
  691. package/plugins/types/license.d.ts +24 -24
  692. package/plugins/types/needleConfig.d.ts +27 -27
  693. package/plugins/types/next.d.ts +2 -2
  694. package/plugins/types/userconfig.d.ts +120 -120
  695. package/plugins/types/vite.d.ts +13 -13
  696. package/plugins/types/webmanifest.d.ts +32 -32
  697. package/plugins/vite/alias.js +184 -174
  698. package/plugins/vite/asap.js +251 -251
  699. package/plugins/vite/build-pipeline.js +371 -371
  700. package/plugins/vite/build.js +19 -19
  701. package/plugins/vite/buildinfo.js +41 -41
  702. package/plugins/vite/config.js +106 -106
  703. package/plugins/vite/copyfiles.js +138 -138
  704. package/plugins/vite/defines.js +70 -70
  705. package/plugins/vite/dependencies.js +232 -232
  706. package/plugins/vite/dependency-watcher.js +237 -237
  707. package/plugins/vite/drop-client.js +76 -76
  708. package/plugins/vite/drop.js +87 -87
  709. package/plugins/vite/editor-connection.js +124 -124
  710. package/plugins/vite/facebook-instant-games.js +102 -102
  711. package/plugins/vite/gzip.js +5 -5
  712. package/plugins/vite/imports-logger.js +143 -143
  713. package/plugins/vite/index.js +143 -143
  714. package/plugins/vite/license.js +56 -56
  715. package/plugins/vite/local-files.js +440 -440
  716. package/plugins/vite/meta.js +163 -163
  717. package/plugins/vite/npm.js +7 -7
  718. package/plugins/vite/peer.js +29 -29
  719. package/plugins/vite/poster-client.js +73 -73
  720. package/plugins/vite/poster.js +79 -79
  721. package/plugins/vite/pwa.js +604 -604
  722. package/plugins/vite/reload-client.js +15 -15
  723. package/plugins/vite/reload.js +351 -351
  724. package/plugins/vite/server.js +66 -66
  725. package/plugins/vite/transform-codegen.js +55 -55
  726. package/plugins/vite/transform.js +31 -31
  727. package/plugins/vite/vite-4.4-hack.js +31 -31
  728. package/src/asap/needle-asap.ts +111 -111
  729. package/src/asap/sessiongranted.ts +75 -75
  730. package/src/asap/utils.ts +4 -4
  731. package/src/engine/analytics/index.ts +10 -10
  732. package/src/engine/analytics/lcp.ts +35 -35
  733. package/src/engine/api.ts +82 -82
  734. package/src/engine/assets/index.ts +59 -59
  735. package/src/engine/assets/static.js +5 -5
  736. package/src/engine/codegen/register_types.ts +300 -300
  737. package/src/engine/debug/debug.ts +51 -51
  738. package/src/engine/debug/debug_console.ts +333 -333
  739. package/src/engine/debug/debug_overlay.ts +332 -332
  740. package/src/engine/debug/debug_spatial_console.ts +429 -429
  741. package/src/engine/debug/index.ts +1 -1
  742. package/src/engine/engine_addressables.ts +680 -680
  743. package/src/engine/engine_animation.ts +145 -145
  744. package/src/engine/engine_application.ts +113 -113
  745. package/src/engine/engine_assetdatabase.ts +389 -389
  746. package/src/engine/engine_audio.ts +24 -24
  747. package/src/engine/engine_camera.ts +39 -39
  748. package/src/engine/engine_components.ts +366 -366
  749. package/src/engine/engine_components_internal.ts +40 -40
  750. package/src/engine/engine_constants.ts +52 -52
  751. package/src/engine/engine_context.ts +1824 -1823
  752. package/src/engine/engine_context_registry.ts +129 -129
  753. package/src/engine/engine_coroutine.ts +54 -54
  754. package/src/engine/engine_create_objects.ts +411 -411
  755. package/src/engine/engine_default_parameters.ts +3 -3
  756. package/src/engine/engine_editor-sync.ts +28 -28
  757. package/src/engine/engine_fileloader.js +9 -9
  758. package/src/engine/engine_gameobject.ts +712 -712
  759. package/src/engine/engine_generic_utils.js +13 -13
  760. package/src/engine/engine_gizmos.ts +577 -577
  761. package/src/engine/engine_gltf.ts +29 -29
  762. package/src/engine/engine_gltf_builtin_components.ts +403 -403
  763. package/src/engine/engine_hot_reload.ts +210 -210
  764. package/src/engine/engine_input.ts +1500 -1500
  765. package/src/engine/engine_input_utils.ts +23 -23
  766. package/src/engine/engine_instancing.ts +45 -45
  767. package/src/engine/engine_license.ts +386 -386
  768. package/src/engine/engine_lifecycle_api.ts +113 -113
  769. package/src/engine/engine_lifecycle_functions_internal.ts +193 -193
  770. package/src/engine/engine_lightdata.ts +117 -117
  771. package/src/engine/engine_loaders.callbacks.ts +136 -136
  772. package/src/engine/engine_loaders.gltf.ts +82 -82
  773. package/src/engine/engine_loaders.ts +378 -378
  774. package/src/engine/engine_lods.ts +168 -168
  775. package/src/engine/engine_mainloop_utils.ts +472 -472
  776. package/src/engine/engine_math.ts +282 -282
  777. package/src/engine/engine_modules.ts +83 -83
  778. package/src/engine/engine_networking.ts +862 -862
  779. package/src/engine/engine_networking_auto.ts +352 -352
  780. package/src/engine/engine_networking_blob.ts +275 -275
  781. package/src/engine/engine_networking_files.ts +217 -217
  782. package/src/engine/engine_networking_files_default_components.ts +58 -58
  783. package/src/engine/engine_networking_instantiate.ts +419 -419
  784. package/src/engine/engine_networking_peer.ts +159 -159
  785. package/src/engine/engine_networking_streams.ts +713 -713
  786. package/src/engine/engine_networking_types.ts +24 -24
  787. package/src/engine/engine_networking_utils.ts +23 -23
  788. package/src/engine/engine_networking_websocket.ts +2 -2
  789. package/src/engine/engine_patcher.ts +199 -199
  790. package/src/engine/engine_physics.ts +783 -783
  791. package/src/engine/engine_physics.types.ts +46 -46
  792. package/src/engine/engine_physics_rapier.ts +1577 -1577
  793. package/src/engine/engine_playerview.ts +80 -80
  794. package/src/engine/engine_scenelighting.ts +294 -294
  795. package/src/engine/engine_serialization.ts +2 -2
  796. package/src/engine/engine_serialization_builtin_serializer.ts +473 -473
  797. package/src/engine/engine_serialization_core.ts +720 -720
  798. package/src/engine/engine_serialization_decorator.ts +80 -80
  799. package/src/engine/engine_setup.ts +1 -1
  800. package/src/engine/engine_shaders.ts +267 -267
  801. package/src/engine/engine_shims.ts +32 -32
  802. package/src/engine/engine_test_utils.ts +109 -109
  803. package/src/engine/engine_texture.ts +82 -82
  804. package/src/engine/engine_three_utils.ts +925 -925
  805. package/src/engine/engine_time.ts +94 -94
  806. package/src/engine/engine_time_utils.ts +237 -237
  807. package/src/engine/engine_tonemapping.ts +208 -208
  808. package/src/engine/engine_types.ts +730 -730
  809. package/src/engine/engine_typestore.ts +63 -63
  810. package/src/engine/engine_util_decorator.ts +136 -136
  811. package/src/engine/engine_utils.ts +1115 -1115
  812. package/src/engine/engine_utils_format.ts +273 -273
  813. package/src/engine/engine_utils_screenshot.ts +708 -708
  814. package/src/engine/engine_utils_screenshot.xr.ts +103 -103
  815. package/src/engine/export/gltf/Writers.ts +34 -34
  816. package/src/engine/export/gltf/index.ts +158 -158
  817. package/src/engine/export/index.ts +2 -2
  818. package/src/engine/export/state.ts +19 -19
  819. package/src/engine/export/utils.ts +9 -9
  820. package/src/engine/extensions/EXT_texture_exr.ts +50 -50
  821. package/src/engine/extensions/NEEDLE_animator_controller_model.ts +195 -195
  822. package/src/engine/extensions/NEEDLE_components.ts +268 -268
  823. package/src/engine/extensions/NEEDLE_gameobject_data.ts +81 -81
  824. package/src/engine/extensions/NEEDLE_lighting_settings.ts +185 -185
  825. package/src/engine/extensions/NEEDLE_lightmaps.ts +119 -119
  826. package/src/engine/extensions/NEEDLE_persistent_assets.ts +76 -76
  827. package/src/engine/extensions/NEEDLE_render_objects.ts +209 -209
  828. package/src/engine/extensions/NEEDLE_techniques_webgl.ts +640 -640
  829. package/src/engine/extensions/extension_resolver.ts +4 -4
  830. package/src/engine/extensions/extension_utils.ts +166 -166
  831. package/src/engine/extensions/extensions.ts +140 -140
  832. package/src/engine/extensions/index.ts +5 -5
  833. package/src/engine/extensions/usage_tracker.ts +100 -100
  834. package/src/engine/js-extensions/Camera.ts +37 -37
  835. package/src/engine/js-extensions/ExtensionUtils.ts +85 -85
  836. package/src/engine/js-extensions/Layers.ts +23 -23
  837. package/src/engine/js-extensions/Object3D.ts +296 -296
  838. package/src/engine/js-extensions/RGBAColor.ts +126 -126
  839. package/src/engine/js-extensions/Vector.ts +18 -18
  840. package/src/engine/js-extensions/index.ts +4 -4
  841. package/src/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +125 -125
  842. package/src/engine/shaders/shaderData.ts +67 -67
  843. package/src/engine/tests/test_utils.ts +63 -63
  844. package/src/engine/webcomponents/WebXRButtons.ts +260 -260
  845. package/src/engine/webcomponents/api.ts +6 -6
  846. package/src/engine/webcomponents/buttons.ts +292 -292
  847. package/src/engine/webcomponents/fonts.ts +41 -41
  848. package/src/engine/webcomponents/icons.ts +57 -57
  849. package/src/engine/webcomponents/index.ts +1 -1
  850. package/src/engine/webcomponents/logo-element.ts +78 -78
  851. package/src/engine/webcomponents/needle menu/needle-menu-spatial.ts +573 -573
  852. package/src/engine/webcomponents/needle menu/needle-menu.ts +1118 -1118
  853. package/src/engine/webcomponents/needle-button.ts +181 -181
  854. package/src/engine/webcomponents/needle-engine.ar-overlay.ts +186 -186
  855. package/src/engine/webcomponents/needle-engine.attributes.ts +82 -82
  856. package/src/engine/webcomponents/needle-engine.extras.ts +16 -16
  857. package/src/engine/webcomponents/needle-engine.loading.ts +373 -373
  858. package/src/engine/webcomponents/needle-engine.ts +860 -860
  859. package/src/engine/xr/NeedleXRController.ts +1125 -1125
  860. package/src/engine/xr/NeedleXRSession.ts +1624 -1624
  861. package/src/engine/xr/NeedleXRSync.ts +220 -220
  862. package/src/engine/xr/SceneTransition.ts +78 -78
  863. package/src/engine/xr/TempXRContext.ts +216 -216
  864. package/src/engine/xr/XRRig.ts +9 -9
  865. package/src/engine/xr/api.ts +5 -5
  866. package/src/engine/xr/events.ts +102 -102
  867. package/src/engine/xr/internal.ts +34 -34
  868. package/src/engine/xr/usdz.ts +30 -30
  869. package/src/engine/xr/utils.ts +39 -39
  870. package/src/engine-components/AlignmentConstraint.ts +36 -36
  871. package/src/engine-components/Animation.ts +557 -557
  872. package/src/engine-components/AnimationCurve.ts +150 -150
  873. package/src/engine-components/AnimationUtils.ts +28 -28
  874. package/src/engine-components/AnimationUtilsAutoplay.ts +43 -43
  875. package/src/engine-components/Animator.ts +397 -397
  876. package/src/engine-components/AnimatorController.ts +1293 -1293
  877. package/src/engine-components/AudioListener.ts +92 -92
  878. package/src/engine-components/AudioSource.ts +644 -644
  879. package/src/engine-components/AvatarLoader.ts +263 -263
  880. package/src/engine-components/AxesHelper.ts +59 -59
  881. package/src/engine-components/BasicIKConstraint.ts +54 -54
  882. package/src/engine-components/BoxCollider.ts +1 -1
  883. package/src/engine-components/BoxHelperComponent.ts +114 -114
  884. package/src/engine-components/Camera.ts +719 -719
  885. package/src/engine-components/CameraUtils.ts +136 -136
  886. package/src/engine-components/CharacterController.ts +253 -253
  887. package/src/engine-components/Collider.ts +374 -374
  888. package/src/engine-components/Component.ts +1297 -1297
  889. package/src/engine-components/ContactShadows.ts +506 -506
  890. package/src/engine-components/DeleteBox.ts +62 -62
  891. package/src/engine-components/DeviceFlag.ts +46 -46
  892. package/src/engine-components/DragControls.ts +1623 -1623
  893. package/src/engine-components/DropListener.ts +713 -713
  894. package/src/engine-components/Duplicatable.ts +198 -198
  895. package/src/engine-components/EventList.ts +266 -266
  896. package/src/engine-components/EventTrigger.ts +74 -74
  897. package/src/engine-components/EventType.ts +22 -22
  898. package/src/engine-components/Fog.ts +60 -60
  899. package/src/engine-components/Gizmos.ts +56 -56
  900. package/src/engine-components/GridHelper.ts +48 -48
  901. package/src/engine-components/GroundProjection.ts +356 -356
  902. package/src/engine-components/Interactable.ts +14 -14
  903. package/src/engine-components/Joints.ts +52 -52
  904. package/src/engine-components/LODGroup.ts +153 -153
  905. package/src/engine-components/Light.ts +558 -558
  906. package/src/engine-components/LookAtConstraint.ts +25 -25
  907. package/src/engine-components/NeedleMenu.ts +84 -84
  908. package/src/engine-components/NestedGltf.ts +86 -86
  909. package/src/engine-components/Networking.ts +114 -114
  910. package/src/engine-components/OffsetConstraint.ts +60 -60
  911. package/src/engine-components/OrbitControls.ts +1074 -1074
  912. package/src/engine-components/PlayerColor.ts +103 -103
  913. package/src/engine-components/ReflectionProbe.ts +220 -220
  914. package/src/engine-components/Renderer.ts +903 -903
  915. package/src/engine-components/RendererInstancing.ts +855 -855
  916. package/src/engine-components/RendererLightmap.ts +198 -198
  917. package/src/engine-components/RigidBody.ts +526 -526
  918. package/src/engine-components/SceneSwitcher.ts +1030 -1030
  919. package/src/engine-components/ScreenCapture.ts +592 -592
  920. package/src/engine-components/ShadowCatcher.ts +172 -172
  921. package/src/engine-components/Skybox.ts +475 -475
  922. package/src/engine-components/SmoothFollow.ts +76 -76
  923. package/src/engine-components/SpatialTrigger.ts +229 -229
  924. package/src/engine-components/SpectatorCamera.ts +787 -787
  925. package/src/engine-components/SphereCollider.ts +1 -1
  926. package/src/engine-components/SpriteRenderer.ts +468 -468
  927. package/src/engine-components/SyncedCamera.ts +220 -220
  928. package/src/engine-components/SyncedRoom.ts +380 -380
  929. package/src/engine-components/SyncedTransform.ts +383 -383
  930. package/src/engine-components/TestRunner.ts +118 -118
  931. package/src/engine-components/TransformGizmo.ts +219 -219
  932. package/src/engine-components/VideoPlayer.ts +1025 -1025
  933. package/src/engine-components/Voip.ts +363 -363
  934. package/src/engine-components/api.ts +60 -60
  935. package/src/engine-components/avatar/AvatarBlink_Simple.ts +69 -69
  936. package/src/engine-components/avatar/AvatarEyeLook_Rotation.ts +63 -63
  937. package/src/engine-components/avatar/Avatar_Brain_LookAt.ts +139 -139
  938. package/src/engine-components/avatar/Avatar_MouthShapes.ts +83 -83
  939. package/src/engine-components/avatar/Avatar_MustacheShake.ts +31 -31
  940. package/src/engine-components/codegen/components.ts +217 -217
  941. package/src/engine-components/debug/LogStats.ts +21 -21
  942. package/src/engine-components/export/gltf/GltfExport.ts +265 -265
  943. package/src/engine-components/export/usdz/Extension.ts +24 -24
  944. package/src/engine-components/export/usdz/ThreeUSDZExporter.ts +2413 -2413
  945. package/src/engine-components/export/usdz/USDZExporter.ts +705 -705
  946. package/src/engine-components/export/usdz/extensions/Animation.ts +1204 -1204
  947. package/src/engine-components/export/usdz/extensions/DocumentExtension.ts +9 -9
  948. package/src/engine-components/export/usdz/extensions/USDZText.ts +240 -240
  949. package/src/engine-components/export/usdz/extensions/USDZUI.ts +189 -189
  950. package/src/engine-components/export/usdz/extensions/behavior/Actions.ts +99 -99
  951. package/src/engine-components/export/usdz/extensions/behavior/AudioExtension.ts +102 -102
  952. package/src/engine-components/export/usdz/extensions/behavior/Behaviour.ts +320 -320
  953. package/src/engine-components/export/usdz/extensions/behavior/BehaviourComponents.ts +1225 -1225
  954. package/src/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.ts +646 -646
  955. package/src/engine-components/export/usdz/extensions/behavior/PhysicsExtension.ts +132 -132
  956. package/src/engine-components/export/usdz/index.ts +2 -2
  957. package/src/engine-components/export/usdz/utils/animationutils.ts +191 -191
  958. package/src/engine-components/export/usdz/utils/quicklook.ts +50 -50
  959. package/src/engine-components/particlesystem/ParticleSystem.ts +1287 -1287
  960. package/src/engine-components/particlesystem/ParticleSystemModules.ts +1765 -1765
  961. package/src/engine-components/particlesystem/ParticleSystemSubEmitter.ts +111 -111
  962. package/src/engine-components/particlesystem/api.ts +1 -1
  963. package/src/engine-components/postprocessing/Effects/Antialiasing.ts +64 -57
  964. package/src/engine-components/postprocessing/Effects/BloomEffect.ts +116 -118
  965. package/src/engine-components/postprocessing/Effects/ChromaticAberration.ts +37 -37
  966. package/src/engine-components/postprocessing/Effects/ColorAdjustments.ts +106 -106
  967. package/src/engine-components/postprocessing/Effects/DepthOfField.ts +103 -103
  968. package/src/engine-components/postprocessing/Effects/EffectWrapper.ts +25 -25
  969. package/src/engine-components/postprocessing/Effects/Pixelation.ts +32 -32
  970. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.ts +90 -90
  971. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.ts +192 -192
  972. package/src/engine-components/postprocessing/Effects/Sharpening.ts +143 -143
  973. package/src/engine-components/postprocessing/Effects/TiltShiftEffect.ts +61 -61
  974. package/src/engine-components/postprocessing/Effects/Tonemapping.ts +103 -103
  975. package/src/engine-components/postprocessing/Effects/Tonemapping.utils.ts +60 -60
  976. package/src/engine-components/postprocessing/Effects/Vignette.ts +59 -59
  977. package/src/engine-components/postprocessing/PostProcessingEffect.ts +192 -192
  978. package/src/engine-components/postprocessing/PostProcessingHandler.ts +573 -535
  979. package/src/engine-components/postprocessing/Volume.ts +426 -426
  980. package/src/engine-components/postprocessing/VolumeParameter.ts +158 -158
  981. package/src/engine-components/postprocessing/VolumeProfile.ts +61 -61
  982. package/src/engine-components/postprocessing/index.ts +5 -5
  983. package/src/engine-components/postprocessing/utils.ts +154 -153
  984. package/src/engine-components/timeline/PlayableDirector.ts +722 -722
  985. package/src/engine-components/timeline/SignalAsset.ts +144 -144
  986. package/src/engine-components/timeline/TimelineModels.ts +92 -92
  987. package/src/engine-components/timeline/TimelineTracks.ts +967 -967
  988. package/src/engine-components/timeline/index.ts +3 -3
  989. package/src/engine-components/ui/BaseUIComponent.ts +203 -203
  990. package/src/engine-components/ui/Button.ts +307 -307
  991. package/src/engine-components/ui/Canvas.ts +419 -419
  992. package/src/engine-components/ui/CanvasGroup.ts +54 -54
  993. package/src/engine-components/ui/EventSystem.ts +854 -854
  994. package/src/engine-components/ui/Graphic.ts +275 -275
  995. package/src/engine-components/ui/Image.ts +112 -112
  996. package/src/engine-components/ui/InputField.ts +321 -321
  997. package/src/engine-components/ui/Interfaces.ts +57 -57
  998. package/src/engine-components/ui/Layout.ts +334 -334
  999. package/src/engine-components/ui/Outline.ts +13 -13
  1000. package/src/engine-components/ui/PointerEvents.ts +206 -206
  1001. package/src/engine-components/ui/RaycastUtils.ts +69 -69
  1002. package/src/engine-components/ui/Raycaster.ts +102 -102
  1003. package/src/engine-components/ui/RectTransform.ts +375 -375
  1004. package/src/engine-components/ui/SpatialHtml.ts +79 -79
  1005. package/src/engine-components/ui/Symbols.ts +1 -1
  1006. package/src/engine-components/ui/Text.ts +578 -578
  1007. package/src/engine-components/ui/Utils.ts +113 -113
  1008. package/src/engine-components/utils/EnvironmentScene.ts +245 -245
  1009. package/src/engine-components/utils/LookAt.ts +88 -88
  1010. package/src/engine-components/utils/OpenURL.ts +114 -114
  1011. package/src/engine-components/webxr/Avatar.ts +265 -265
  1012. package/src/engine-components/webxr/TeleportTarget.ts +9 -9
  1013. package/src/engine-components/webxr/WebARCameraBackground.ts +175 -175
  1014. package/src/engine-components/webxr/WebARSessionRoot.ts +880 -880
  1015. package/src/engine-components/webxr/WebXR.ts +585 -585
  1016. package/src/engine-components/webxr/WebXRAvatar.ts +66 -66
  1017. package/src/engine-components/webxr/WebXRImageTracking.ts +519 -519
  1018. package/src/engine-components/webxr/WebXRPlaneTracking.ts +570 -570
  1019. package/src/engine-components/webxr/WebXRRig.ts +77 -77
  1020. package/src/engine-components/webxr/XRFlag.ts +147 -147
  1021. package/src/engine-components/webxr/controllers/XRControllerFollow.ts +118 -118
  1022. package/src/engine-components/webxr/controllers/XRControllerModel.ts +373 -373
  1023. package/src/engine-components/webxr/controllers/XRControllerMovement.ts +550 -550
  1024. package/src/engine-components/webxr/index.ts +2 -2
  1025. package/src/engine-components/webxr/types.ts +3 -3
  1026. package/src/engine-components-experimental/Presentation.ts +12 -12
  1027. package/src/engine-components-experimental/api.ts +4 -4
  1028. package/src/engine-components-experimental/networking/PlayerSync.ts +401 -401
  1029. package/src/engine-schemes/COMPILE_SCHEMES.bat +3 -3
  1030. package/src/engine-schemes/COMPILE_TS.bat +11 -11
  1031. package/src/engine-schemes/README.md +1 -1
  1032. package/src/engine-schemes/api.ts +12 -12
  1033. package/src/engine-schemes/dist/api.js +17 -0
  1034. package/src/engine-schemes/dist/api.js.meta +7 -0
  1035. package/src/engine-schemes/dist/schemes.js +25 -0
  1036. package/src/engine-schemes/dist/schemes.js.meta +7 -0
  1037. package/src/engine-schemes/dist/synced-camera-model.js +74 -0
  1038. package/src/engine-schemes/dist/synced-camera-model.js.meta +7 -0
  1039. package/src/engine-schemes/dist/synced-transform-model.js +73 -0
  1040. package/src/engine-schemes/dist/synced-transform-model.js.meta +7 -0
  1041. package/src/engine-schemes/dist/transform.js +46 -0
  1042. package/src/engine-schemes/dist/transform.js.meta +7 -0
  1043. package/src/engine-schemes/dist/vec2.js +32 -0
  1044. package/src/engine-schemes/dist/vec2.js.meta +7 -0
  1045. package/src/engine-schemes/dist/vec3.js +36 -0
  1046. package/src/engine-schemes/dist/vec3.js.meta +7 -0
  1047. package/src/engine-schemes/dist/vec4.js +40 -0
  1048. package/src/engine-schemes/dist/vec4.js.meta +7 -0
  1049. package/src/engine-schemes/dist/vr-user-state-buffer.js +110 -0
  1050. package/src/engine-schemes/dist/vr-user-state-buffer.js.meta +7 -0
  1051. package/src/engine-schemes/schemes.ts +28 -28
  1052. package/src/engine-schemes/synced-camera-model.ts +92 -92
  1053. package/src/engine-schemes/synced-transform-model.ts +90 -90
  1054. package/src/engine-schemes/syncedCamera.fbs +10 -10
  1055. package/src/engine-schemes/transform.ts +50 -50
  1056. package/src/engine-schemes/transforms.fbs +25 -25
  1057. package/src/engine-schemes/vec.fbs +19 -19
  1058. package/src/engine-schemes/vec2.ts +33 -33
  1059. package/src/engine-schemes/vec3.ts +38 -38
  1060. package/src/engine-schemes/vec4.ts +43 -43
  1061. package/src/engine-schemes/vr-user-state-buffer.ts +145 -145
  1062. package/src/engine-schemes/vrUserStateBuffer.fbs +17 -17
  1063. package/src/include/draco/draco_decoder.js +34 -34
  1064. package/src/include/ktx2/basis_transcoder.js +21 -21
  1065. package/src/include/needle/arial-msdf.json +1471 -1471
  1066. package/src/include/three/DragControls.js +231 -231
  1067. package/src/include/three/EXT_mesh_gpu_instancing_exporter.js +66 -66
  1068. package/src/needle-engine.ts +70 -70
  1069. package/dist/generateMeshBVH.worker-BaNp_Xtp.js +0 -25
@@ -1,1030 +1,1030 @@
1
- import { EquirectangularReflectionMapping, Object3D, Scene, Texture } from "three";
2
-
3
- import { AssetReference } from "../engine/engine_addressables.js";
4
- import { destroy } from "../engine/engine_gameobject.js";
5
- import { InputEvents } from "../engine/engine_input.js";
6
- import { isLocalNetwork } from "../engine/engine_networking_utils.js";
7
- import { serializable } from "../engine/engine_serialization.js";
8
- import { getParam, setParamWithoutReload } from "../engine/engine_utils.js";
9
- import { registerObservableAttribute } from "../engine/webcomponents/needle-engine.extras.js";
10
- import { Behaviour, GameObject } from "./Component.js";
11
- import { EventList } from "./EventList.js";
12
-
13
- const debug = getParam("debugsceneswitcher");
14
- const experimental_clearSceneOnLoad = getParam("sceneswitcher:clearscene");
15
-
16
- const ENGINE_ELEMENT_SCENE_ATTRIBUTE_NAME = "scene";
17
- registerObservableAttribute(ENGINE_ELEMENT_SCENE_ATTRIBUTE_NAME);
18
-
19
- // ContextRegistry.registerCallback(ContextEvent.ContextRegistered, async _ => {
20
- // // We need to defer import to not get issues with circular dependencies
21
- // import("../engine/engine_element").then(res => {
22
- // const webcomponent = res.NeedleEngineHTMLElement;
23
- // if (debug) console.log("SceneSwitcher: registering scene attribute", webcomponent.observedAttributes);
24
- // if (!webcomponent.observedAttributes.includes(ENGINE_ELEMENT_SCENE_ATTRIBUTE_NAME))
25
- // webcomponent.observedAttributes.push(ENGINE_ELEMENT_SCENE_ATTRIBUTE_NAME);
26
- // });
27
- // });
28
-
29
- const couldNotLoadScenePromise = Promise.resolve(false);
30
-
31
- /**
32
- * {@link SceneSwitcher} event argument data
33
- */
34
- export type LoadSceneEvent = {
35
- /**
36
- * The {@link SceneSwitcher} that is loading the scene
37
- */
38
- switcher: SceneSwitcher;
39
- /**
40
- * The scene that is being loaded
41
- */
42
- scene: AssetReference;
43
- /**
44
- * The index of the scene that is being loaded
45
- */
46
- index: number;
47
- }
48
-
49
- export type LoadSceneProgressEvent = LoadSceneEvent & {
50
- progress: number,
51
- }
52
-
53
- /**
54
- * The ISceneEventListener is called by the {@link SceneSwitcher} when a scene is loaded or unloaded.
55
- * It must be added to the root object of your scene (that is being loaded) or on the same object as the SceneSwitcher
56
- * It can be used to e.g. smooth the transition between scenes or to load additional content when a scene is loaded.
57
- * @example
58
- * ```ts
59
- * import { ISceneEventListener } from "@needle-tools/engine";
60
- *
61
- * // Add this component to the root object of a scene loaded by a SceneSwitcher or to the same object as the SceneSwitcher
62
- * export class MySceneListener implements ISceneEventListener {
63
- * async sceneOpened(sceneSwitcher: SceneSwitcher) {
64
- * console.log("Scene opened", sceneSwitcher.currentlyLoadedScene?.url);
65
- * }
66
- * }
67
- * ```
68
- *
69
- **/
70
- export interface ISceneEventListener {
71
- /** Called when the scene is loaded and added */
72
- sceneOpened(sceneSwitcher: SceneSwitcher): Promise<void>
73
- /** Called before the scene is being removed (due to another scene being loaded) */
74
- sceneClosing(): Promise<void>
75
- }
76
-
77
-
78
-
79
- /** The SceneSwitcher can be used to dynamically load and unload extra content
80
- * Available scenes are defined in the `scenes` array.
81
- * Loaded scenes will be added to the SceneSwitcher's GameObject as a child and removed when another scene is loaded by the same SceneSwitcher.
82
- * Live Examples
83
- * - [Multi Scenes Sample](https://engine.needle.tools/samples/multi-scenes-dynamic-loading) (source code available)
84
- * - [Needle Website](https://needle.tools)
85
- * - [Songs Of Cultures](https://app.songsofcultures.com)
86
- *
87
- * ### Interfaces
88
- * Use the {@link ISceneEventListener} interface to listen to scene open and closing events with the ability to modify transitions and stall the scene loading process.
89
- *
90
- * ### Events
91
- * - `loadscene-start`: Called when a scene starts loading
92
- * - `loadscene-finished`: Called when a scene finished loading
93
- * - `progress`: Called when a scene is loading and the progress changes
94
- * - `scene-opened`: Called when a scene is loaded and added to the SceneSwitcher's GameObject
95
- * @example
96
- * ```ts
97
- * sceneSwitcher.addEventListener("loadscene-start", (e) => {
98
- * console.log("Loading scene", e.detail.scene.url);
99
- * });
100
- * sceneSwitcher.addEventListener("loadscene-finished", (e) => {
101
- * console.log("Finished loading scene", e.detail.scene.url);
102
- * });
103
- * sceneSwitcher.addEventListener("progress", (e) => {
104
- * console.log("Loading progress", e.loaded, e.total);
105
- * });
106
- * sceneSwitcher.addEventListener("scene-opened", (e) => {
107
- * console.log("Scene opened", e.detail.scene.url);
108
- * });
109
- * ```
110
- *
111
- * @category Asset Management
112
- * @group Components
113
- */
114
- export class SceneSwitcher extends Behaviour {
115
-
116
- /** When enabled the first scene will be loaded when the SceneSwitcher becomes active
117
- * @default true
118
- */
119
- @serializable()
120
- autoLoadFirstScene: boolean = true;
121
-
122
- /**
123
- * The scenes that can be loaded by the SceneSwitcher.
124
- * @default []
125
- */
126
- @serializable(AssetReference)
127
- scenes: AssetReference[] = [];
128
-
129
- /**
130
- * The scene that is displayed while a scene is loading.
131
- * @default undefined
132
- */
133
- @serializable(AssetReference)
134
- loadingScene?: AssetReference;
135
-
136
- /** the url parameter that is set/used to store the currently loaded scene in, set to "" to disable
137
- * @default "scene"
138
- */
139
- @serializable()
140
- queryParameterName: string = "scene";
141
-
142
- /**
143
- * when enabled the scene name will be used as the query parameter (otherwise the scene index will be used)
144
- * Needs `queryParameterName` set
145
- * @default true
146
- */
147
- @serializable()
148
- useSceneName: boolean = true;
149
-
150
- /**
151
- * When enabled the current scene index will be clamped to the scenes array bounds.
152
- * For example when the last scene is loaded and `clamp` is true then trying to load the `next()` scene will not change the scene.
153
- * When `clamp` is false and the last scene is loaded then the first scene will be loaded instead.
154
- * @default true
155
- */
156
- @serializable()
157
- clamp: boolean = true;
158
-
159
- /** when enabled the new scene is pushed to the browser navigation history, only works with a valid query parameter set
160
- * @default true
161
- */
162
- @serializable()
163
- useHistory: boolean = true;
164
-
165
- /** when enabled you can switch between scenes using keyboard left, right, A and D or number keys
166
- * @default true
167
- */
168
- @serializable()
169
- useKeyboard: boolean = true;
170
-
171
- /** when enabled you can switch between scenes using swipe (mobile only)
172
- * @default true
173
- */
174
- @serializable()
175
- useSwipe: boolean = true;
176
-
177
- /** when enabled will automatically apply the environment scene lights
178
- * @default true
179
- */
180
- @serializable()
181
- useSceneLighting: boolean = true;
182
-
183
- /** When enabled will automatically apply the skybox from the loaded scene
184
- * @default true
185
- */
186
- @serializable()
187
- useSceneBackground: boolean = true;
188
-
189
- /** how many scenes after the currently active scene should be preloaded
190
- * @default 1
191
- */
192
- @serializable()
193
- preloadNext: number = 1;
194
-
195
- /** how many scenes before the currently active scene should be preloaded
196
- * @default 1
197
- */
198
- @serializable()
199
- preloadPrevious: number = 1;
200
-
201
- /** how many scenes can be loaded in parallel
202
- * @default 2
203
- */
204
- @serializable()
205
- preloadConcurrent: number = 2;
206
-
207
- /**
208
- * When enabled will create a button for the Needle menu to switch to the next or previous scene
209
- * @default false
210
- */
211
- @serializable()
212
- createMenuButtons: boolean = false;
213
-
214
-
215
- /** The index of the currently loaded and active scene */
216
- get currentIndex(): number { return this._currentIndex; }
217
-
218
- /** Get the progress of the currently loading scene. This is undefined if no scene is loading
219
- * You can also subscribe to the loading event by adding an event listener to the scene switcher.
220
- * For example like this `sceneSwitcher.addEventListeneer("progress", (e) => {...})`
221
- */
222
- get currentLoadingProgress() { return this._currentLoadingProgress; }
223
-
224
- /** The currently loading scene. This is undefined if no scene is loading. */
225
- get currentlyLoadingScene() { return this._currentlyLoadingScene; }
226
-
227
- /**
228
- * The currently loaded scene. This is undefined if no scene is loaded.
229
- */
230
- get currentlyLoadedScene() { return this._currentScene; }
231
-
232
- /**
233
- * Called when a scene starts loading
234
- */
235
- @serializable(EventList)
236
- sceneLoadingStart: EventList<LoadSceneEvent> = new EventList();
237
-
238
- @serializable(EventList)
239
- sceneLoadingProgress: EventList<ProgressEvent> = new EventList();
240
-
241
- /**
242
- * The sceneLoaded event is called when a scene/glTF is loaded and added to the scene
243
- */
244
- @serializable(EventList)
245
- sceneLoaded: EventList<SceneSwitcher> = new EventList();
246
-
247
- private _currentIndex: number = -1;
248
- private _currentScene: AssetReference | undefined = undefined;
249
- private _engineElementOverserver: MutationObserver | undefined = undefined;
250
-
251
- private _preloadScheduler?: PreLoadScheduler;
252
-
253
- private _menuButtons?: HTMLElement[];
254
-
255
- /** @internal */
256
- awake(): void {
257
- if (this.scenes === undefined) this.scenes = [];
258
- // remove all scenes from the url that are in the scenes array at startup
259
- for (const scene of this.scenes) {
260
- if (scene && !scene.hasUrl && scene.asset instanceof Object3D) {
261
- GameObject.remove(scene.asset);
262
- }
263
- else if(scene instanceof Object3D) {
264
- GameObject.remove(scene);
265
- }
266
- }
267
-
268
- if (debug) console.log("SceneSwitcher", this);
269
- }
270
-
271
- /** @internal */
272
- async onEnable() {
273
- globalThis.addEventListener("popstate", this.onPopState);
274
- this.context.input.addEventListener(InputEvents.KeyDown, this.onInputKeyDown);
275
- this.context.input.addEventListener(InputEvents.PointerMove, this.onInputPointerMove);
276
- this.context.input.addEventListener(InputEvents.PointerUp, this.onInputPointerUp);
277
-
278
- if (!this._engineElementOverserver) {
279
- this._engineElementOverserver = new MutationObserver((mutations) => {
280
- for (const mut of mutations) {
281
- if (mut.type === "attributes" && mut.attributeName === ENGINE_ELEMENT_SCENE_ATTRIBUTE_NAME) {
282
- const value = this.context.domElement.getAttribute(ENGINE_ELEMENT_SCENE_ATTRIBUTE_NAME);
283
- if (value !== null) {
284
- this.trySelectSceneFromValue(value);
285
- }
286
- }
287
- }
288
- });
289
- }
290
-
291
- this._engineElementOverserver.observe(this.context.domElement, {
292
- attributes: true
293
- });
294
-
295
- if (!this._preloadScheduler)
296
- this._preloadScheduler = new PreLoadScheduler(this);
297
- this._preloadScheduler.maxLoadAhead = this.preloadNext;
298
- this._preloadScheduler.maxLoadBehind = this.preloadPrevious;
299
- this._preloadScheduler.maxConcurrent = this.preloadConcurrent;
300
- this._preloadScheduler.begin(2000);
301
-
302
- // Begin loading the loading scene
303
- if (this.autoLoadFirstScene && this._currentIndex === -1 && !await this.tryLoadFromQueryParam()) {
304
- const value = this.context.domElement.getAttribute(ENGINE_ELEMENT_SCENE_ATTRIBUTE_NAME);
305
- // let locked = this.lock;
306
- try {
307
- // this.lock = false;
308
- if (value === null || !await this.trySelectSceneFromValue(value)) {
309
- if (this._currentIndex === -1)
310
- this.select(0);
311
- }
312
- }
313
- finally {
314
- // this.lock = locked;
315
- }
316
- }
317
-
318
- // create the menu buttons
319
- if (this.createMenuButtons) {
320
- this._menuButtons ??= [];
321
- this._menuButtons.push(this.context.menu.appendChild({
322
- label: "Previous",
323
- icon: "arrow_back_ios",
324
- onClick: () => this.selectPrev(),
325
- priority: -1005,
326
- class: "row2"
327
- }));
328
- this._menuButtons.push(this.context.menu.appendChild({
329
- label: "Next",
330
- icon: "arrow_forward_ios",
331
- iconSide: "right",
332
- onClick: () => this.selectNext(),
333
- priority: -1000,
334
- class: "row2"
335
- }));
336
- }
337
- }
338
-
339
- /** @internal */
340
- onDisable(): void {
341
- globalThis.removeEventListener("popstate", this.onPopState);
342
- this.context.input.removeEventListener(InputEvents.KeyDown, this.onInputKeyDown);
343
- this.context.input.removeEventListener(InputEvents.PointerMove, this.onInputPointerMove);
344
- this.context.input.removeEventListener(InputEvents.PointerUp, this.onInputPointerUp);
345
- this._preloadScheduler?.stop();
346
-
347
- // remove the menu buttons
348
- if (this._menuButtons) {
349
- for (const button of this._menuButtons) {
350
- button.remove();
351
- }
352
- this._menuButtons = undefined;
353
- }
354
- }
355
-
356
- private onPopState = async (_state: PopStateEvent) => {
357
- if (!this.useHistory) return;
358
- const wasUsingHistory = this.useHistory;
359
- try {
360
- this.useHistory = false;
361
- let didResolve = false;
362
- if (this.queryParameterName)
363
- didResolve = await this.tryLoadFromQueryParam();
364
- if (!didResolve) {
365
- const state = _state?.state;
366
- if (state && state.startsWith(this.guid)) {
367
- const value = state.substr(this.guid.length + 2);
368
- if (debug) console.log("PopState", value);
369
- await this.trySelectSceneFromValue(value);
370
- }
371
- }
372
- }
373
- finally {
374
- this.useHistory = wasUsingHistory;
375
- }
376
- }
377
-
378
- private normalizedSwipeThresholdX = 0.1;
379
- private _didSwipe: boolean = false;
380
- private onInputPointerMove = (e: any) => {
381
- if (!this.useSwipe) return;
382
- if (!this._didSwipe && e.button === 0 && e.pointerType === "touch" && this.context.input.getPointerPressedCount() === 1) {
383
- const delta = this.context.input.getPointerPositionDelta(e.button);
384
- if (delta) {
385
- const normalizedX = delta.x / this.context.domWidth;
386
- if (normalizedX >= this.normalizedSwipeThresholdX) {
387
- this._didSwipe = true;
388
- this.selectPrev();
389
- }
390
- else if (normalizedX <= -this.normalizedSwipeThresholdX) {
391
- this._didSwipe = true;
392
- this.selectNext();
393
- }
394
- }
395
- }
396
- }
397
-
398
- private onInputPointerUp = (e: any) => {
399
- if (e.button === 0) {
400
- this._didSwipe = false;
401
- }
402
- };
403
-
404
- private onInputKeyDown = (e: any) => {
405
- if (!this.useKeyboard) return;
406
- if (!this.scenes) return;
407
- const key = e.key.toLowerCase();
408
- if (!key) return;
409
- const index = parseInt(key) - 1;
410
- if (index >= 0) {
411
- this.trySelectSceneFromValue(index);
412
- return;
413
- }
414
- switch (key) {
415
- case "arrowright":
416
- case "d":
417
- this.selectNext();
418
- break;
419
- case "arrowleft":
420
- case "a":
421
- this.selectPrev();
422
- break;
423
- }
424
- }
425
-
426
- /**
427
- * Add a scene to the SceneSwitcher.
428
- * If the scene is already added it will be added again.
429
- * @param urlOrAssetReference The url of the scene or an AssetReference to the scene
430
- * @returns The AssetReference of the scene that was added
431
- * @example
432
- * ```ts
433
- * // adding a scene:
434
- * sceneSwitcher.addScene("scene1.glb");
435
- * // add another scene and load it:
436
- * const scene2 = sceneSwitcher.addScene("scene2.glb");
437
- * sceneSwitcher.switchScene(scene2).then(res => { console.log("Scene loaded", res); });
438
- * ```
439
- */
440
- addScene(urlOrAssetReference: string | AssetReference): AssetReference {
441
- if (typeof urlOrAssetReference === "string") {
442
- let assetReference = this.context.addressables.findAssetReference(urlOrAssetReference);
443
- if (!assetReference) {
444
- assetReference = new AssetReference(urlOrAssetReference);
445
- this.context.addressables.registerAssetReference(assetReference);
446
- }
447
- this.scenes.push(assetReference);
448
- return assetReference;
449
- }
450
-
451
- this.scenes.push(urlOrAssetReference);
452
- return urlOrAssetReference;
453
- }
454
-
455
- /**
456
- * Load the next scene in the scenes array ({@link this.currentIndex} + 1)
457
- * If the current scene is the last scene in the array and {@link this.clamp} is disabled then the first scene will be loaded.
458
- * @returns a promise that resolves to true if the scene was loaded successfully
459
- */
460
- selectNext(): Promise<boolean> {
461
- return this.select(this._currentIndex + 1);
462
- }
463
-
464
- /**
465
- * Load the previous scene in the scenes array ({@link this.currentIndex} - 1)
466
- * If the current scene is the first scene in the array and {@link this.clamp} is disabled then the last scene will be loaded.
467
- * @returns a promise that resolves to true if the scene was loaded successfully
468
- */
469
- selectPrev(): Promise<boolean> {
470
- return this.select(this._currentIndex - 1);
471
- }
472
-
473
- /**
474
- * Load a scene by its index in the scenes array.
475
- * @param index The index of the scene or a string that represents the scene uri (if the url is not known to the SceneSwitcher it will try to load the scene by its uri but it won't be added to the current scenes array. Use {@link addScene} to add a scene to the SceneSwitcher)
476
- * @returns a promise that resolves to true if the scene was loaded successfully
477
- */
478
- select(index: number | string): Promise<boolean> {
479
- if (debug) console.log("select", index);
480
-
481
- if (typeof index === "object") {
482
- // If a user tries to reference a scene object in a UnityEvent and invoke select(obj)
483
- // Then the object will be serialized as a object { guid : ... } or with the index json pointer
484
- // This case is not supported right now. Object references in the editor must not be scene references
485
- console.warn("Switching to \"" + index + "\" might not work. Please either use an index or a AssetReference (not a scene reference)");
486
- }
487
-
488
- if (typeof index === "string") {
489
- // If the parameter is a string we try to resolve the scene by its uri
490
- // it's either already known in the scenes array
491
- // or we create/get a new AssetReference and try to switch to that
492
- const scene = this.scenes?.find(s => s.url === index);
493
- if (!scene) {
494
- // Ok the scene is unknown to the scene switcher
495
- // we create a new asset reference (or get an existing one)
496
- // And switch to that. With this we can not modify the history
497
- // Until the scene switcher can store the uri in the history instead of the index
498
- const reference = AssetReference.getOrCreate(this.sourceId ?? "", index, this.context);
499
- return this.switchScene(reference);
500
- }
501
- if (scene) index = this.scenes?.indexOf(scene);
502
- else return couldNotLoadScenePromise;
503
- }
504
-
505
- if (!this.scenes?.length) return couldNotLoadScenePromise;
506
- if (index < 0) {
507
- if (this.clamp) return couldNotLoadScenePromise;
508
- index = this.scenes.length - 1;
509
- }
510
- else if (index >= this.scenes.length) {
511
- if (this.clamp) return couldNotLoadScenePromise;
512
- index = 0;
513
- }
514
- const scene = this.scenes[index];
515
- return this.switchScene(scene);
516
- }
517
-
518
- /**
519
- * Unload the currently loaded scene.
520
- */
521
- unload(): Promise<void> {
522
- this.__lastSwitchScene = undefined;
523
- this.__lastSwitchScenePromise = undefined;
524
- return this.__unloadCurrentScene();
525
- }
526
-
527
- /**
528
- * Reload the last scene that was loaded
529
- * @returns a promise that resolves to true if the scene was loaded successfully
530
- */
531
- async reload() {
532
- if (this.__lastSwitchScene) {
533
- const scene = this.__lastSwitchScene;
534
- this.__lastSwitchScene = undefined;
535
- return this.switchScene(scene);
536
- }
537
- return false;
538
- }
539
-
540
- // this is the scene that was requested last
541
- private __lastSwitchScene?: AssetReference;
542
- private __lastSwitchScenePromise?: Promise<boolean>;
543
-
544
- /**
545
- * Switch to a scene by its AssetReference.
546
- * If the scene is already loaded it will be unloaded and the new scene will be loaded.
547
- * If the scene is already loading it will wait for the scene to be loaded.
548
- * If the scene is already loaded and the same scene is requested again it will return the same promise that was returned the first time the scene was requested.
549
- * @param scene The AssetReference of the scene to switch to
550
- * @returns a promise that resolves to true if the scene was loaded successfully
551
- * @example
552
- * ```ts
553
- * const myAssetReference = new AssetReference("scene1.glb");
554
- * sceneSwitcher.switchScene(myAssetReference).then(res => { console.log("Scene loaded", res); });
555
- * ```
556
- */
557
- async switchScene(scene: AssetReference): Promise<boolean> {
558
- if (!(scene instanceof AssetReference)) {
559
- const type = typeof scene;
560
- if (type === "string") {
561
- return this.select(scene);
562
- }
563
- else if (type === "number") {
564
- return this.select(scene);
565
- }
566
- // If we're switching an Object3D
567
- else if (scene && (scene as Object3D) instanceof Object3D) {
568
- const i = this.scenes?.indexOf(scene);
569
- scene = new AssetReference((scene as Object3D).name, undefined, scene);
570
- if (i >= 0) this.scenes[i] = scene; // update the asset in the list to the new asset reference
571
- }
572
- else {
573
- console.warn(`[SceneSwitcher] Can't switch to scene of type ${type}`);
574
- return false;
575
- }
576
- }
577
-
578
- if (scene.url === this.sourceId) {
579
- console.warn("[SceneSwitcher] Can't load own scene - prevent recursive loading", this.sourceId);
580
- return false;
581
- }
582
-
583
- // ensure that we never run the same scene switch multiple times (at the same time) for the same requested scene
584
- if (this.__lastSwitchScene === scene && this.__lastSwitchScenePromise) {
585
- return this.__lastSwitchScenePromise;
586
- }
587
- this.__lastSwitchScene = scene;
588
- this.__lastSwitchScenePromise = this.__internalSwitchScene(scene);
589
- const res = await this.__lastSwitchScenePromise;
590
- return res;
591
- }
592
-
593
- private async __unloadCurrentScene() {
594
- const current = this._currentScene;
595
- this._currentScene = undefined;
596
- if (current) {
597
- if (debug) console.log("UNLOAD", current.url, "HasURL?: " + current.hasUrl)
598
- const sceneListener = this.tryGetSceneEventListener(current.asset as any as Object3D);
599
- if (sceneListener?.sceneClosing) {
600
- const res = sceneListener.sceneClosing();
601
- if (res instanceof Promise) await res;
602
- }
603
- // if the current scene has a URL (so it can be reloaded)
604
- // then we unload it
605
- if (current.hasUrl)
606
- current.unload();
607
- // otherwise if it's a regular Object3D we just remove it from the scene
608
- else if (current.asset instanceof Object3D) {
609
- GameObject.remove(current.asset as any as Object3D);
610
- }
611
- }
612
- }
613
-
614
- private _currentlyLoadingScene?: AssetReference;
615
- /** @internal */
616
- private async __internalSwitchScene(scene: AssetReference): Promise<boolean> {
617
-
618
- await this.__unloadCurrentScene();
619
- const index = this._currentIndex = this.scenes?.indexOf(scene) ?? -1;
620
-
621
- try {
622
- this._currentlyLoadingScene = scene;
623
- this._currentLoadingProgress = new ProgressEvent("progress", { loaded: 0, total: 1 });
624
-
625
- const loadStartEvt = new CustomEvent<LoadSceneEvent>("loadscene-start", { detail: { scene: scene, switcher: this, index: index } })
626
- this.dispatchEvent(loadStartEvt);
627
- this.sceneLoadingStart?.invoke(loadStartEvt.detail);
628
- await this.onStartLoading();
629
- // start loading and wait for the scene to be loaded
630
- await scene.loadAssetAsync((_, prog) => {
631
- if (debug) {
632
- const t01 = prog.loaded / prog.total;
633
- const progressBarString = "[" + "=".repeat(Math.floor(t01 * 20)) + "-".repeat(20 - Math.floor(t01 * 20)) + "]";
634
- console.debug(`[SceneSwitcher] Download ${(t01 * 100).toFixed(1)} % ${progressBarString}`, scene.url);
635
- }
636
- this._currentLoadingProgress = prog;
637
- this.dispatchEvent(prog);
638
- this.sceneLoadingProgress?.invoke(prog);
639
- }).catch(console.error);
640
- await this.onEndLoading();
641
- const finishedEvt = new CustomEvent<LoadSceneEvent>("loadscene-finished", { detail: { scene: scene, switcher: this, index: index } });
642
- this.dispatchEvent(finishedEvt);
643
-
644
- this._currentLoadingProgress = undefined;
645
- this._currentlyLoadingScene = undefined;
646
-
647
- if (finishedEvt.defaultPrevented) {
648
- if (debug) console.warn("Adding loaded scene prevented:", scene, finishedEvt);
649
- return false;
650
- }
651
- if (!scene.asset) {
652
- if (debug) console.warn("Failed loading scene:", scene);
653
- return false;
654
- }
655
- if (this._currentIndex === index) {
656
- if (debug) console.log("ADD", scene.url);
657
- this._currentScene = scene;
658
-
659
-
660
- // Experimental: replace the whole content of the scene
661
- if (experimental_clearSceneOnLoad) {
662
- const camera = this.context.mainCameraComponent?.gameObject || this.context.mainCamera;
663
- camera?.removeFromParent();
664
- const self = this.gameObject.removeFromParent();
665
- destroy(this.context.scene, true, true)
666
- this.context.scene = new Scene();
667
- this.context.scene.add(self);
668
- if (camera) {
669
- this.context.scene.add(camera);
670
- }
671
- }
672
-
673
- GameObject.add(scene.asset, this.gameObject);
674
-
675
- if (this.useSceneLighting)
676
- this.context.sceneLighting.enable(scene);
677
- // Set the background texture from the loaded scene
678
- if (this.useSceneBackground) {
679
- const skybox = this.context.lightmaps.tryGetSkybox(scene.url) as Texture;
680
- if (skybox) {
681
- skybox.mapping = EquirectangularReflectionMapping;
682
- this.context.scene.background = skybox;
683
- }
684
- else if (debug) {
685
- console.warn("SceneSwitcher: Can't find skybox for scene " + scene.url);
686
- }
687
- }
688
-
689
-
690
- if (this.useHistory && index >= 0) {
691
- // take the index as the query parameter value
692
- let queryParameterValue = index.toString();
693
- // unless the user defines that he wants to use the scene name
694
- if (this.useSceneName) {
695
- if (scene instanceof Object3D) queryParameterValue = scene.name;
696
- else if (scene.url) queryParameterValue = sceneUriToName(scene.url);
697
- }
698
- // save the loaded scene as an url parameter
699
- if (this.queryParameterName?.length)
700
- setParamWithoutReload(this.queryParameterName, queryParameterValue, this.useHistory);
701
- // or set the history state without updating the url parameter
702
- else {
703
- const lastState = history.state;
704
- const stateName = this.guid + "::" + index;
705
- if (lastState !== stateName)
706
- history.pushState(stateName, "unused", location.href);
707
- }
708
- }
709
- // Call SceneListener opened callback (if a SceneListener is in the scene)
710
- const sceneListener = this.tryGetSceneEventListener(scene.asset as any as Object3D);
711
- if (sceneListener?.sceneOpened) {
712
- const res = sceneListener.sceneOpened(this);
713
- if (res instanceof Promise) await res;
714
- }
715
-
716
- const openedEvt = new CustomEvent<LoadSceneEvent>("scene-opened", { detail: { scene: scene, switcher: this, index: index } });
717
- this.dispatchEvent(openedEvt);
718
-
719
- this.sceneLoaded?.invoke(this);
720
- return true;
721
- }
722
- }
723
- catch (err) {
724
- console.error(err);
725
- }
726
- return false;
727
- }
728
-
729
- preload(index: number) {
730
- if (index >= 0 && index < this.scenes.length) {
731
- const scene = this.scenes[index];
732
- if (scene instanceof AssetReference)
733
- return scene.preload();
734
- }
735
- return couldNotLoadScenePromise;
736
- }
737
-
738
- private tryLoadFromQueryParam() {
739
- if (!this.queryParameterName?.length) return couldNotLoadScenePromise;
740
- // try restore the scene from the url
741
- const value = getParam(this.queryParameterName);
742
- if (typeof value === "boolean") return couldNotLoadScenePromise;
743
- return this.trySelectSceneFromValue(value);
744
- }
745
-
746
- /** try to select a scene from a string or index */
747
- private trySelectSceneFromValue(value: string | number) {
748
-
749
- if (typeof value === "string") {
750
- const index = parseInt(value as string);
751
- if (index >= 0 && index < this.scenes.length) {
752
- return this.select(index);;
753
- }
754
- else {
755
- // Try to find a scene with a matching name
756
- // we don't care about casing. e.g. Scene1 and scene1 should both match
757
- const lowerCaseValue = value.toLowerCase();
758
- for (let i = 0; i < this.scenes.length; i++) {
759
- const scene = this.scenes[i];
760
- if (!scene) continue;
761
- const name = scene instanceof Object3D ? scene.name : sceneUriToName(scene.url);
762
- if (name.toLowerCase().includes(lowerCaseValue)) {
763
- return this.select(i);
764
- }
765
- }
766
- }
767
- }
768
- else if (typeof value === "number") {
769
- if (value >= 0 && value < this.scenes.length) {
770
- return this.select(value);;
771
- }
772
- }
773
-
774
- if (isLocalNetwork()) console.warn("Can not find scene: \"" + value + "\"", this)
775
-
776
- return couldNotLoadScenePromise;
777
- }
778
-
779
- private _lastLoadingScene: AssetReference | undefined = undefined;
780
- private _loadingScenePromise: Promise<boolean> | undefined = undefined;
781
- private _isCurrentlyLoading: boolean = false;
782
- private _currentLoadingProgress: ProgressEvent | undefined = undefined;
783
-
784
- private async onStartLoading() {
785
- this._isCurrentlyLoading = true;
786
- if (this.loadingScene) {
787
- // save the last loading scene reference so that it can be changed at runtime
788
- // since we cache the loading promise here
789
- if (this._lastLoadingScene !== this.loadingScene) {
790
- this._loadingScenePromise = undefined;
791
- }
792
- this._lastLoadingScene = this.loadingScene;
793
- if (!this._loadingScenePromise) {
794
- this._loadingScenePromise = this.loadingScene?.loadAssetAsync().then(res => res != null);
795
- }
796
- await this._loadingScenePromise;
797
- if (this._isCurrentlyLoading && this.loadingScene?.asset) {
798
- if (debug) console.log("Add loading scene", this.loadingScene.url, this.loadingScene.asset)
799
- const loadingScene = this.loadingScene.asset as any as Object3D;
800
- GameObject.add(loadingScene, this.gameObject);
801
- const sceneListener = this.tryGetSceneEventListener(loadingScene);
802
- if (sceneListener?.sceneOpened) {
803
- const res = sceneListener.sceneOpened(this);
804
- if (res instanceof Promise) await res;
805
- }
806
- }
807
- }
808
- // Invoke the event on a loading listener on the same object as the scene switcher
809
- if (this._isCurrentlyLoading) {
810
- const listener = this.tryGetSceneEventListener(this.gameObject);
811
- if (listener) {
812
- if (listener.sceneOpened) {
813
- const res = listener.sceneOpened(this);
814
- if (res instanceof Promise) await res;
815
- }
816
- }
817
- }
818
- }
819
- private async onEndLoading() {
820
- this._isCurrentlyLoading = false;
821
- if (this.loadingScene?.asset) {
822
- if (debug) console.log("Remove loading scene", this.loadingScene.url);
823
- const obj = this.loadingScene.asset as any as Object3D;
824
- // try to find an ISceneEventListener component
825
- const sceneListener = this.tryGetSceneEventListener(obj);
826
- if (typeof sceneListener?.sceneClosing === "function") {
827
- const res = sceneListener.sceneClosing();
828
- if (res instanceof Promise) await res;
829
- }
830
- GameObject.remove(obj);
831
- }
832
- // Invoke the event on a loading listener on the same object as the scene switcher
833
- if (!this._isCurrentlyLoading) {
834
- const listener = this.tryGetSceneEventListener(this.gameObject);
835
- if (listener) {
836
- if (listener.sceneClosing) {
837
- const res = listener.sceneClosing();
838
- if (res instanceof Promise) await res;
839
- }
840
- }
841
- }
842
- }
843
-
844
- private tryGetSceneEventListener(obj: Object3D, level: number = 0): ISceneEventListener | null {
845
- if (!obj) {
846
- return null;
847
- }
848
- const sceneListener = GameObject.foreachComponent(obj, c => {
849
- const i = c as any as ISceneEventListener;
850
- if (i.sceneClosing! || i.sceneOpened!) return i;
851
- else return undefined;
852
- });
853
- // if we didnt find any component with the listener on the root object
854
- // we also check the first level of its children because a scene might be a group
855
- if (level === 0 && !sceneListener && obj.children.length) {
856
- for (const ch of obj.children) {
857
- const res = this.tryGetSceneEventListener(ch, level + 1);
858
- if (res) return res;
859
- }
860
- }
861
- if (!sceneListener) return null;
862
- return sceneListener;
863
- }
864
- }
865
-
866
-
867
- function sceneUriToName(uri: string): string {
868
- const name = uri.split("/").pop();
869
- const value = name?.split(".").shift();
870
- if (value?.length) return value;
871
- return uri;
872
- }
873
-
874
-
875
-
876
- /**
877
- * PreLoadScheduler is responsible for managing preloading of scenes.
878
- * It handles scheduling and limiting concurrent downloads of scenes based on specified parameters.
879
- */
880
- class PreLoadScheduler {
881
- /** Maximum number of scenes to preload ahead of the current scene */
882
- maxLoadAhead: number;
883
-
884
- /** Maximum number of scenes to preload behind the current scene */
885
- maxLoadBehind: number;
886
-
887
- /** Maximum number of scenes that can be preloaded concurrently */
888
- maxConcurrent: number;
889
-
890
- private _isRunning: boolean = false;
891
- private _switcher: SceneSwitcher;
892
- private _loadTasks: LoadTask[] = [];
893
- private _maxConcurrentLoads: number = 1;
894
-
895
- /**
896
- * Creates a new PreLoadScheduler instance
897
- * @param rooms The SceneSwitcher that this scheduler belongs to
898
- * @param ahead Number of scenes to preload ahead of current scene
899
- * @param behind Number of scenes to preload behind current scene
900
- * @param maxConcurrent Maximum number of concurrent preloads allowed
901
- */
902
- constructor(rooms: SceneSwitcher, ahead: number = 1, behind: number = 1, maxConcurrent: number = 2) {
903
- this._switcher = rooms;
904
- this.maxLoadAhead = ahead;
905
- this.maxLoadBehind = behind;
906
- this.maxConcurrent = maxConcurrent;
907
- }
908
-
909
- /**
910
- * Starts the preloading process after a specified delay
911
- * @param delay Time in milliseconds to wait before starting preload
912
- */
913
- begin(delay: number) {
914
- if (this._isRunning) return;
915
- if (debug) console.log("Preload begin", { delay })
916
- this._isRunning = true;
917
- let lastRoom: number = -10;
918
- let searchDistance: number;
919
- let searchCall: number;
920
- const array = this._switcher.scenes;
921
- const startTime = Date.now() + delay;
922
- const interval = setInterval(() => {
923
- if (this.allLoaded()) {
924
- if (debug)
925
- console.log("All scenes (pre-)loaded");
926
- this.stop();
927
- }
928
- if (!this._isRunning) {
929
- clearInterval(interval);
930
- return;
931
- }
932
-
933
- if (Date.now() < startTime) return;
934
-
935
- if (this.canLoadNewScene() === false) return;
936
- if (lastRoom === -10 || lastRoom !== this._switcher.currentIndex) {
937
- lastRoom = this._switcher.currentIndex;
938
- searchCall = 0;
939
- searchDistance = 0;
940
- }
941
- const searchForward = searchCall % 2 === 0;
942
- if (searchForward) searchDistance += 1;
943
- searchCall += 1;
944
- const maxSearchDistance = searchForward ? this.maxLoadAhead : this.maxLoadBehind;
945
- if (searchDistance > maxSearchDistance) return;
946
- const roomIndex = searchForward ? lastRoom + searchDistance : lastRoom - searchDistance;
947
- if (roomIndex < 0) return;
948
- // if (roomIndex < 0) roomIndex = array.length + roomIndex;
949
- if (roomIndex < 0 || roomIndex >= array.length) return;
950
- if (!this._loadTasks.some(t => t.index === roomIndex)) {
951
- const scene = array[roomIndex];
952
- if (debug) console.log("Preload scene", { roomIndex, searchForward, lastRoom, currentIndex: this._switcher.currentIndex, tasks: this._loadTasks.length }, scene?.url);
953
- new LoadTask(roomIndex, scene, this._loadTasks);
954
- }
955
- }, 200);
956
- }
957
-
958
- /**
959
- * Stops the preloading process
960
- */
961
- stop() {
962
- this._isRunning = false;
963
- }
964
-
965
- /**
966
- * Checks if a new scene can be loaded based on current load limits
967
- * @returns True if a new scene can be loaded, false otherwise
968
- */
969
- canLoadNewScene(): boolean {
970
- return this._loadTasks.length < this._maxConcurrentLoads;
971
- }
972
-
973
- /**
974
- * Checks if all scenes in the SceneSwitcher have been loaded
975
- * @returns True if all scenes are loaded, false otherwise
976
- */
977
- allLoaded(): boolean {
978
- if (this._switcher.scenes) {
979
- for (const scene of this._switcher.scenes) {
980
- if (!scene?.isLoaded) continue;
981
- if (scene.isLoaded() === false) return false;
982
- }
983
- }
984
- return true;
985
- }
986
- }
987
-
988
- /**
989
- * Represents a single preloading task for a scene
990
- */
991
- class LoadTask {
992
- /** The index of the scene in the scenes array */
993
- index: number;
994
-
995
- /** The AssetReference to be loaded */
996
- asset: AssetReference;
997
-
998
- /** The collection of active load tasks this task belongs to */
999
- tasks: LoadTask[];
1000
-
1001
- /**
1002
- * Creates a new LoadTask and begins loading immediately
1003
- * @param index The index of the scene in the scenes array
1004
- * @param asset The AssetReference to preload
1005
- * @param tasks The collection of active load tasks
1006
- */
1007
- constructor(index: number, asset: AssetReference, tasks: LoadTask[]) {
1008
- this.index = index;
1009
- this.asset = asset;
1010
- this.tasks = tasks;
1011
- tasks.push(this);
1012
- this.awaitLoading();
1013
- }
1014
-
1015
- /**
1016
- * Asynchronously loads the asset and removes this task from the active tasks list when complete
1017
- */
1018
- private async awaitLoading() {
1019
- if (this.asset && !this.asset.isLoaded()) {
1020
- if (debug)
1021
- console.log("Preload start: " + this.asset.url, this.index);
1022
- await this.asset.preload();
1023
- if (debug)
1024
- console.log("Preload finished: " + this.asset.url, this.index);
1025
- }
1026
-
1027
- const i = this.tasks.indexOf(this);
1028
- if (i >= 0) this.tasks.splice(i, 1);
1029
- }
1030
- }
1
+ import { EquirectangularReflectionMapping, Object3D, Scene, Texture } from "three";
2
+
3
+ import { AssetReference } from "../engine/engine_addressables.js";
4
+ import { destroy } from "../engine/engine_gameobject.js";
5
+ import { InputEvents } from "../engine/engine_input.js";
6
+ import { isLocalNetwork } from "../engine/engine_networking_utils.js";
7
+ import { serializable } from "../engine/engine_serialization.js";
8
+ import { getParam, setParamWithoutReload } from "../engine/engine_utils.js";
9
+ import { registerObservableAttribute } from "../engine/webcomponents/needle-engine.extras.js";
10
+ import { Behaviour, GameObject } from "./Component.js";
11
+ import { EventList } from "./EventList.js";
12
+
13
+ const debug = getParam("debugsceneswitcher");
14
+ const experimental_clearSceneOnLoad = getParam("sceneswitcher:clearscene");
15
+
16
+ const ENGINE_ELEMENT_SCENE_ATTRIBUTE_NAME = "scene";
17
+ registerObservableAttribute(ENGINE_ELEMENT_SCENE_ATTRIBUTE_NAME);
18
+
19
+ // ContextRegistry.registerCallback(ContextEvent.ContextRegistered, async _ => {
20
+ // // We need to defer import to not get issues with circular dependencies
21
+ // import("../engine/engine_element").then(res => {
22
+ // const webcomponent = res.NeedleEngineHTMLElement;
23
+ // if (debug) console.log("SceneSwitcher: registering scene attribute", webcomponent.observedAttributes);
24
+ // if (!webcomponent.observedAttributes.includes(ENGINE_ELEMENT_SCENE_ATTRIBUTE_NAME))
25
+ // webcomponent.observedAttributes.push(ENGINE_ELEMENT_SCENE_ATTRIBUTE_NAME);
26
+ // });
27
+ // });
28
+
29
+ const couldNotLoadScenePromise = Promise.resolve(false);
30
+
31
+ /**
32
+ * {@link SceneSwitcher} event argument data
33
+ */
34
+ export type LoadSceneEvent = {
35
+ /**
36
+ * The {@link SceneSwitcher} that is loading the scene
37
+ */
38
+ switcher: SceneSwitcher;
39
+ /**
40
+ * The scene that is being loaded
41
+ */
42
+ scene: AssetReference;
43
+ /**
44
+ * The index of the scene that is being loaded
45
+ */
46
+ index: number;
47
+ }
48
+
49
+ export type LoadSceneProgressEvent = LoadSceneEvent & {
50
+ progress: number,
51
+ }
52
+
53
+ /**
54
+ * The ISceneEventListener is called by the {@link SceneSwitcher} when a scene is loaded or unloaded.
55
+ * It must be added to the root object of your scene (that is being loaded) or on the same object as the SceneSwitcher
56
+ * It can be used to e.g. smooth the transition between scenes or to load additional content when a scene is loaded.
57
+ * @example
58
+ * ```ts
59
+ * import { ISceneEventListener } from "@needle-tools/engine";
60
+ *
61
+ * // Add this component to the root object of a scene loaded by a SceneSwitcher or to the same object as the SceneSwitcher
62
+ * export class MySceneListener implements ISceneEventListener {
63
+ * async sceneOpened(sceneSwitcher: SceneSwitcher) {
64
+ * console.log("Scene opened", sceneSwitcher.currentlyLoadedScene?.url);
65
+ * }
66
+ * }
67
+ * ```
68
+ *
69
+ **/
70
+ export interface ISceneEventListener {
71
+ /** Called when the scene is loaded and added */
72
+ sceneOpened(sceneSwitcher: SceneSwitcher): Promise<void>
73
+ /** Called before the scene is being removed (due to another scene being loaded) */
74
+ sceneClosing(): Promise<void>
75
+ }
76
+
77
+
78
+
79
+ /** The SceneSwitcher can be used to dynamically load and unload extra content
80
+ * Available scenes are defined in the `scenes` array.
81
+ * Loaded scenes will be added to the SceneSwitcher's GameObject as a child and removed when another scene is loaded by the same SceneSwitcher.
82
+ * Live Examples
83
+ * - [Multi Scenes Sample](https://engine.needle.tools/samples/multi-scenes-dynamic-loading) (source code available)
84
+ * - [Needle Website](https://needle.tools)
85
+ * - [Songs Of Cultures](https://app.songsofcultures.com)
86
+ *
87
+ * ### Interfaces
88
+ * Use the {@link ISceneEventListener} interface to listen to scene open and closing events with the ability to modify transitions and stall the scene loading process.
89
+ *
90
+ * ### Events
91
+ * - `loadscene-start`: Called when a scene starts loading
92
+ * - `loadscene-finished`: Called when a scene finished loading
93
+ * - `progress`: Called when a scene is loading and the progress changes
94
+ * - `scene-opened`: Called when a scene is loaded and added to the SceneSwitcher's GameObject
95
+ * @example
96
+ * ```ts
97
+ * sceneSwitcher.addEventListener("loadscene-start", (e) => {
98
+ * console.log("Loading scene", e.detail.scene.url);
99
+ * });
100
+ * sceneSwitcher.addEventListener("loadscene-finished", (e) => {
101
+ * console.log("Finished loading scene", e.detail.scene.url);
102
+ * });
103
+ * sceneSwitcher.addEventListener("progress", (e) => {
104
+ * console.log("Loading progress", e.loaded, e.total);
105
+ * });
106
+ * sceneSwitcher.addEventListener("scene-opened", (e) => {
107
+ * console.log("Scene opened", e.detail.scene.url);
108
+ * });
109
+ * ```
110
+ *
111
+ * @category Asset Management
112
+ * @group Components
113
+ */
114
+ export class SceneSwitcher extends Behaviour {
115
+
116
+ /** When enabled the first scene will be loaded when the SceneSwitcher becomes active
117
+ * @default true
118
+ */
119
+ @serializable()
120
+ autoLoadFirstScene: boolean = true;
121
+
122
+ /**
123
+ * The scenes that can be loaded by the SceneSwitcher.
124
+ * @default []
125
+ */
126
+ @serializable(AssetReference)
127
+ scenes: AssetReference[] = [];
128
+
129
+ /**
130
+ * The scene that is displayed while a scene is loading.
131
+ * @default undefined
132
+ */
133
+ @serializable(AssetReference)
134
+ loadingScene?: AssetReference;
135
+
136
+ /** the url parameter that is set/used to store the currently loaded scene in, set to "" to disable
137
+ * @default "scene"
138
+ */
139
+ @serializable()
140
+ queryParameterName: string = "scene";
141
+
142
+ /**
143
+ * when enabled the scene name will be used as the query parameter (otherwise the scene index will be used)
144
+ * Needs `queryParameterName` set
145
+ * @default true
146
+ */
147
+ @serializable()
148
+ useSceneName: boolean = true;
149
+
150
+ /**
151
+ * When enabled the current scene index will be clamped to the scenes array bounds.
152
+ * For example when the last scene is loaded and `clamp` is true then trying to load the `next()` scene will not change the scene.
153
+ * When `clamp` is false and the last scene is loaded then the first scene will be loaded instead.
154
+ * @default true
155
+ */
156
+ @serializable()
157
+ clamp: boolean = true;
158
+
159
+ /** when enabled the new scene is pushed to the browser navigation history, only works with a valid query parameter set
160
+ * @default true
161
+ */
162
+ @serializable()
163
+ useHistory: boolean = true;
164
+
165
+ /** when enabled you can switch between scenes using keyboard left, right, A and D or number keys
166
+ * @default true
167
+ */
168
+ @serializable()
169
+ useKeyboard: boolean = true;
170
+
171
+ /** when enabled you can switch between scenes using swipe (mobile only)
172
+ * @default true
173
+ */
174
+ @serializable()
175
+ useSwipe: boolean = true;
176
+
177
+ /** when enabled will automatically apply the environment scene lights
178
+ * @default true
179
+ */
180
+ @serializable()
181
+ useSceneLighting: boolean = true;
182
+
183
+ /** When enabled will automatically apply the skybox from the loaded scene
184
+ * @default true
185
+ */
186
+ @serializable()
187
+ useSceneBackground: boolean = true;
188
+
189
+ /** how many scenes after the currently active scene should be preloaded
190
+ * @default 1
191
+ */
192
+ @serializable()
193
+ preloadNext: number = 1;
194
+
195
+ /** how many scenes before the currently active scene should be preloaded
196
+ * @default 1
197
+ */
198
+ @serializable()
199
+ preloadPrevious: number = 1;
200
+
201
+ /** how many scenes can be loaded in parallel
202
+ * @default 2
203
+ */
204
+ @serializable()
205
+ preloadConcurrent: number = 2;
206
+
207
+ /**
208
+ * When enabled will create a button for the Needle menu to switch to the next or previous scene
209
+ * @default false
210
+ */
211
+ @serializable()
212
+ createMenuButtons: boolean = false;
213
+
214
+
215
+ /** The index of the currently loaded and active scene */
216
+ get currentIndex(): number { return this._currentIndex; }
217
+
218
+ /** Get the progress of the currently loading scene. This is undefined if no scene is loading
219
+ * You can also subscribe to the loading event by adding an event listener to the scene switcher.
220
+ * For example like this `sceneSwitcher.addEventListeneer("progress", (e) => {...})`
221
+ */
222
+ get currentLoadingProgress() { return this._currentLoadingProgress; }
223
+
224
+ /** The currently loading scene. This is undefined if no scene is loading. */
225
+ get currentlyLoadingScene() { return this._currentlyLoadingScene; }
226
+
227
+ /**
228
+ * The currently loaded scene. This is undefined if no scene is loaded.
229
+ */
230
+ get currentlyLoadedScene() { return this._currentScene; }
231
+
232
+ /**
233
+ * Called when a scene starts loading
234
+ */
235
+ @serializable(EventList)
236
+ sceneLoadingStart: EventList<LoadSceneEvent> = new EventList();
237
+
238
+ @serializable(EventList)
239
+ sceneLoadingProgress: EventList<ProgressEvent> = new EventList();
240
+
241
+ /**
242
+ * The sceneLoaded event is called when a scene/glTF is loaded and added to the scene
243
+ */
244
+ @serializable(EventList)
245
+ sceneLoaded: EventList<SceneSwitcher> = new EventList();
246
+
247
+ private _currentIndex: number = -1;
248
+ private _currentScene: AssetReference | undefined = undefined;
249
+ private _engineElementOverserver: MutationObserver | undefined = undefined;
250
+
251
+ private _preloadScheduler?: PreLoadScheduler;
252
+
253
+ private _menuButtons?: HTMLElement[];
254
+
255
+ /** @internal */
256
+ awake(): void {
257
+ if (this.scenes === undefined) this.scenes = [];
258
+ // remove all scenes from the url that are in the scenes array at startup
259
+ for (const scene of this.scenes) {
260
+ if (scene && !scene.hasUrl && scene.asset instanceof Object3D) {
261
+ GameObject.remove(scene.asset);
262
+ }
263
+ else if(scene instanceof Object3D) {
264
+ GameObject.remove(scene);
265
+ }
266
+ }
267
+
268
+ if (debug) console.log("SceneSwitcher", this);
269
+ }
270
+
271
+ /** @internal */
272
+ async onEnable() {
273
+ globalThis.addEventListener("popstate", this.onPopState);
274
+ this.context.input.addEventListener(InputEvents.KeyDown, this.onInputKeyDown);
275
+ this.context.input.addEventListener(InputEvents.PointerMove, this.onInputPointerMove);
276
+ this.context.input.addEventListener(InputEvents.PointerUp, this.onInputPointerUp);
277
+
278
+ if (!this._engineElementOverserver) {
279
+ this._engineElementOverserver = new MutationObserver((mutations) => {
280
+ for (const mut of mutations) {
281
+ if (mut.type === "attributes" && mut.attributeName === ENGINE_ELEMENT_SCENE_ATTRIBUTE_NAME) {
282
+ const value = this.context.domElement.getAttribute(ENGINE_ELEMENT_SCENE_ATTRIBUTE_NAME);
283
+ if (value !== null) {
284
+ this.trySelectSceneFromValue(value);
285
+ }
286
+ }
287
+ }
288
+ });
289
+ }
290
+
291
+ this._engineElementOverserver.observe(this.context.domElement, {
292
+ attributes: true
293
+ });
294
+
295
+ if (!this._preloadScheduler)
296
+ this._preloadScheduler = new PreLoadScheduler(this);
297
+ this._preloadScheduler.maxLoadAhead = this.preloadNext;
298
+ this._preloadScheduler.maxLoadBehind = this.preloadPrevious;
299
+ this._preloadScheduler.maxConcurrent = this.preloadConcurrent;
300
+ this._preloadScheduler.begin(2000);
301
+
302
+ // Begin loading the loading scene
303
+ if (this.autoLoadFirstScene && this._currentIndex === -1 && !await this.tryLoadFromQueryParam()) {
304
+ const value = this.context.domElement.getAttribute(ENGINE_ELEMENT_SCENE_ATTRIBUTE_NAME);
305
+ // let locked = this.lock;
306
+ try {
307
+ // this.lock = false;
308
+ if (value === null || !await this.trySelectSceneFromValue(value)) {
309
+ if (this._currentIndex === -1)
310
+ this.select(0);
311
+ }
312
+ }
313
+ finally {
314
+ // this.lock = locked;
315
+ }
316
+ }
317
+
318
+ // create the menu buttons
319
+ if (this.createMenuButtons) {
320
+ this._menuButtons ??= [];
321
+ this._menuButtons.push(this.context.menu.appendChild({
322
+ label: "Previous",
323
+ icon: "arrow_back_ios",
324
+ onClick: () => this.selectPrev(),
325
+ priority: -1005,
326
+ class: "row2"
327
+ }));
328
+ this._menuButtons.push(this.context.menu.appendChild({
329
+ label: "Next",
330
+ icon: "arrow_forward_ios",
331
+ iconSide: "right",
332
+ onClick: () => this.selectNext(),
333
+ priority: -1000,
334
+ class: "row2"
335
+ }));
336
+ }
337
+ }
338
+
339
+ /** @internal */
340
+ onDisable(): void {
341
+ globalThis.removeEventListener("popstate", this.onPopState);
342
+ this.context.input.removeEventListener(InputEvents.KeyDown, this.onInputKeyDown);
343
+ this.context.input.removeEventListener(InputEvents.PointerMove, this.onInputPointerMove);
344
+ this.context.input.removeEventListener(InputEvents.PointerUp, this.onInputPointerUp);
345
+ this._preloadScheduler?.stop();
346
+
347
+ // remove the menu buttons
348
+ if (this._menuButtons) {
349
+ for (const button of this._menuButtons) {
350
+ button.remove();
351
+ }
352
+ this._menuButtons = undefined;
353
+ }
354
+ }
355
+
356
+ private onPopState = async (_state: PopStateEvent) => {
357
+ if (!this.useHistory) return;
358
+ const wasUsingHistory = this.useHistory;
359
+ try {
360
+ this.useHistory = false;
361
+ let didResolve = false;
362
+ if (this.queryParameterName)
363
+ didResolve = await this.tryLoadFromQueryParam();
364
+ if (!didResolve) {
365
+ const state = _state?.state;
366
+ if (state && state.startsWith(this.guid)) {
367
+ const value = state.substr(this.guid.length + 2);
368
+ if (debug) console.log("PopState", value);
369
+ await this.trySelectSceneFromValue(value);
370
+ }
371
+ }
372
+ }
373
+ finally {
374
+ this.useHistory = wasUsingHistory;
375
+ }
376
+ }
377
+
378
+ private normalizedSwipeThresholdX = 0.1;
379
+ private _didSwipe: boolean = false;
380
+ private onInputPointerMove = (e: any) => {
381
+ if (!this.useSwipe) return;
382
+ if (!this._didSwipe && e.button === 0 && e.pointerType === "touch" && this.context.input.getPointerPressedCount() === 1) {
383
+ const delta = this.context.input.getPointerPositionDelta(e.button);
384
+ if (delta) {
385
+ const normalizedX = delta.x / this.context.domWidth;
386
+ if (normalizedX >= this.normalizedSwipeThresholdX) {
387
+ this._didSwipe = true;
388
+ this.selectPrev();
389
+ }
390
+ else if (normalizedX <= -this.normalizedSwipeThresholdX) {
391
+ this._didSwipe = true;
392
+ this.selectNext();
393
+ }
394
+ }
395
+ }
396
+ }
397
+
398
+ private onInputPointerUp = (e: any) => {
399
+ if (e.button === 0) {
400
+ this._didSwipe = false;
401
+ }
402
+ };
403
+
404
+ private onInputKeyDown = (e: any) => {
405
+ if (!this.useKeyboard) return;
406
+ if (!this.scenes) return;
407
+ const key = e.key.toLowerCase();
408
+ if (!key) return;
409
+ const index = parseInt(key) - 1;
410
+ if (index >= 0) {
411
+ this.trySelectSceneFromValue(index);
412
+ return;
413
+ }
414
+ switch (key) {
415
+ case "arrowright":
416
+ case "d":
417
+ this.selectNext();
418
+ break;
419
+ case "arrowleft":
420
+ case "a":
421
+ this.selectPrev();
422
+ break;
423
+ }
424
+ }
425
+
426
+ /**
427
+ * Add a scene to the SceneSwitcher.
428
+ * If the scene is already added it will be added again.
429
+ * @param urlOrAssetReference The url of the scene or an AssetReference to the scene
430
+ * @returns The AssetReference of the scene that was added
431
+ * @example
432
+ * ```ts
433
+ * // adding a scene:
434
+ * sceneSwitcher.addScene("scene1.glb");
435
+ * // add another scene and load it:
436
+ * const scene2 = sceneSwitcher.addScene("scene2.glb");
437
+ * sceneSwitcher.switchScene(scene2).then(res => { console.log("Scene loaded", res); });
438
+ * ```
439
+ */
440
+ addScene(urlOrAssetReference: string | AssetReference): AssetReference {
441
+ if (typeof urlOrAssetReference === "string") {
442
+ let assetReference = this.context.addressables.findAssetReference(urlOrAssetReference);
443
+ if (!assetReference) {
444
+ assetReference = new AssetReference(urlOrAssetReference);
445
+ this.context.addressables.registerAssetReference(assetReference);
446
+ }
447
+ this.scenes.push(assetReference);
448
+ return assetReference;
449
+ }
450
+
451
+ this.scenes.push(urlOrAssetReference);
452
+ return urlOrAssetReference;
453
+ }
454
+
455
+ /**
456
+ * Load the next scene in the scenes array ({@link this.currentIndex} + 1)
457
+ * If the current scene is the last scene in the array and {@link this.clamp} is disabled then the first scene will be loaded.
458
+ * @returns a promise that resolves to true if the scene was loaded successfully
459
+ */
460
+ selectNext(): Promise<boolean> {
461
+ return this.select(this._currentIndex + 1);
462
+ }
463
+
464
+ /**
465
+ * Load the previous scene in the scenes array ({@link this.currentIndex} - 1)
466
+ * If the current scene is the first scene in the array and {@link this.clamp} is disabled then the last scene will be loaded.
467
+ * @returns a promise that resolves to true if the scene was loaded successfully
468
+ */
469
+ selectPrev(): Promise<boolean> {
470
+ return this.select(this._currentIndex - 1);
471
+ }
472
+
473
+ /**
474
+ * Load a scene by its index in the scenes array.
475
+ * @param index The index of the scene or a string that represents the scene uri (if the url is not known to the SceneSwitcher it will try to load the scene by its uri but it won't be added to the current scenes array. Use {@link addScene} to add a scene to the SceneSwitcher)
476
+ * @returns a promise that resolves to true if the scene was loaded successfully
477
+ */
478
+ select(index: number | string): Promise<boolean> {
479
+ if (debug) console.log("select", index);
480
+
481
+ if (typeof index === "object") {
482
+ // If a user tries to reference a scene object in a UnityEvent and invoke select(obj)
483
+ // Then the object will be serialized as a object { guid : ... } or with the index json pointer
484
+ // This case is not supported right now. Object references in the editor must not be scene references
485
+ console.warn("Switching to \"" + index + "\" might not work. Please either use an index or a AssetReference (not a scene reference)");
486
+ }
487
+
488
+ if (typeof index === "string") {
489
+ // If the parameter is a string we try to resolve the scene by its uri
490
+ // it's either already known in the scenes array
491
+ // or we create/get a new AssetReference and try to switch to that
492
+ const scene = this.scenes?.find(s => s.url === index);
493
+ if (!scene) {
494
+ // Ok the scene is unknown to the scene switcher
495
+ // we create a new asset reference (or get an existing one)
496
+ // And switch to that. With this we can not modify the history
497
+ // Until the scene switcher can store the uri in the history instead of the index
498
+ const reference = AssetReference.getOrCreate(this.sourceId ?? "", index, this.context);
499
+ return this.switchScene(reference);
500
+ }
501
+ if (scene) index = this.scenes?.indexOf(scene);
502
+ else return couldNotLoadScenePromise;
503
+ }
504
+
505
+ if (!this.scenes?.length) return couldNotLoadScenePromise;
506
+ if (index < 0) {
507
+ if (this.clamp) return couldNotLoadScenePromise;
508
+ index = this.scenes.length - 1;
509
+ }
510
+ else if (index >= this.scenes.length) {
511
+ if (this.clamp) return couldNotLoadScenePromise;
512
+ index = 0;
513
+ }
514
+ const scene = this.scenes[index];
515
+ return this.switchScene(scene);
516
+ }
517
+
518
+ /**
519
+ * Unload the currently loaded scene.
520
+ */
521
+ unload(): Promise<void> {
522
+ this.__lastSwitchScene = undefined;
523
+ this.__lastSwitchScenePromise = undefined;
524
+ return this.__unloadCurrentScene();
525
+ }
526
+
527
+ /**
528
+ * Reload the last scene that was loaded
529
+ * @returns a promise that resolves to true if the scene was loaded successfully
530
+ */
531
+ async reload() {
532
+ if (this.__lastSwitchScene) {
533
+ const scene = this.__lastSwitchScene;
534
+ this.__lastSwitchScene = undefined;
535
+ return this.switchScene(scene);
536
+ }
537
+ return false;
538
+ }
539
+
540
+ // this is the scene that was requested last
541
+ private __lastSwitchScene?: AssetReference;
542
+ private __lastSwitchScenePromise?: Promise<boolean>;
543
+
544
+ /**
545
+ * Switch to a scene by its AssetReference.
546
+ * If the scene is already loaded it will be unloaded and the new scene will be loaded.
547
+ * If the scene is already loading it will wait for the scene to be loaded.
548
+ * If the scene is already loaded and the same scene is requested again it will return the same promise that was returned the first time the scene was requested.
549
+ * @param scene The AssetReference of the scene to switch to
550
+ * @returns a promise that resolves to true if the scene was loaded successfully
551
+ * @example
552
+ * ```ts
553
+ * const myAssetReference = new AssetReference("scene1.glb");
554
+ * sceneSwitcher.switchScene(myAssetReference).then(res => { console.log("Scene loaded", res); });
555
+ * ```
556
+ */
557
+ async switchScene(scene: AssetReference): Promise<boolean> {
558
+ if (!(scene instanceof AssetReference)) {
559
+ const type = typeof scene;
560
+ if (type === "string") {
561
+ return this.select(scene);
562
+ }
563
+ else if (type === "number") {
564
+ return this.select(scene);
565
+ }
566
+ // If we're switching an Object3D
567
+ else if (scene && (scene as Object3D) instanceof Object3D) {
568
+ const i = this.scenes?.indexOf(scene);
569
+ scene = new AssetReference((scene as Object3D).name, undefined, scene);
570
+ if (i >= 0) this.scenes[i] = scene; // update the asset in the list to the new asset reference
571
+ }
572
+ else {
573
+ console.warn(`[SceneSwitcher] Can't switch to scene of type ${type}`);
574
+ return false;
575
+ }
576
+ }
577
+
578
+ if (scene.url === this.sourceId) {
579
+ console.warn("[SceneSwitcher] Can't load own scene - prevent recursive loading", this.sourceId);
580
+ return false;
581
+ }
582
+
583
+ // ensure that we never run the same scene switch multiple times (at the same time) for the same requested scene
584
+ if (this.__lastSwitchScene === scene && this.__lastSwitchScenePromise) {
585
+ return this.__lastSwitchScenePromise;
586
+ }
587
+ this.__lastSwitchScene = scene;
588
+ this.__lastSwitchScenePromise = this.__internalSwitchScene(scene);
589
+ const res = await this.__lastSwitchScenePromise;
590
+ return res;
591
+ }
592
+
593
+ private async __unloadCurrentScene() {
594
+ const current = this._currentScene;
595
+ this._currentScene = undefined;
596
+ if (current) {
597
+ if (debug) console.log("UNLOAD", current.url, "HasURL?: " + current.hasUrl)
598
+ const sceneListener = this.tryGetSceneEventListener(current.asset as any as Object3D);
599
+ if (sceneListener?.sceneClosing) {
600
+ const res = sceneListener.sceneClosing();
601
+ if (res instanceof Promise) await res;
602
+ }
603
+ // if the current scene has a URL (so it can be reloaded)
604
+ // then we unload it
605
+ if (current.hasUrl)
606
+ current.unload();
607
+ // otherwise if it's a regular Object3D we just remove it from the scene
608
+ else if (current.asset instanceof Object3D) {
609
+ GameObject.remove(current.asset as any as Object3D);
610
+ }
611
+ }
612
+ }
613
+
614
+ private _currentlyLoadingScene?: AssetReference;
615
+ /** @internal */
616
+ private async __internalSwitchScene(scene: AssetReference): Promise<boolean> {
617
+
618
+ await this.__unloadCurrentScene();
619
+ const index = this._currentIndex = this.scenes?.indexOf(scene) ?? -1;
620
+
621
+ try {
622
+ this._currentlyLoadingScene = scene;
623
+ this._currentLoadingProgress = new ProgressEvent("progress", { loaded: 0, total: 1 });
624
+
625
+ const loadStartEvt = new CustomEvent<LoadSceneEvent>("loadscene-start", { detail: { scene: scene, switcher: this, index: index } })
626
+ this.dispatchEvent(loadStartEvt);
627
+ this.sceneLoadingStart?.invoke(loadStartEvt.detail);
628
+ await this.onStartLoading();
629
+ // start loading and wait for the scene to be loaded
630
+ await scene.loadAssetAsync((_, prog) => {
631
+ if (debug) {
632
+ const t01 = prog.loaded / prog.total;
633
+ const progressBarString = "[" + "=".repeat(Math.floor(t01 * 20)) + "-".repeat(20 - Math.floor(t01 * 20)) + "]";
634
+ console.debug(`[SceneSwitcher] Download ${(t01 * 100).toFixed(1)} % ${progressBarString}`, scene.url);
635
+ }
636
+ this._currentLoadingProgress = prog;
637
+ this.dispatchEvent(prog);
638
+ this.sceneLoadingProgress?.invoke(prog);
639
+ }).catch(console.error);
640
+ await this.onEndLoading();
641
+ const finishedEvt = new CustomEvent<LoadSceneEvent>("loadscene-finished", { detail: { scene: scene, switcher: this, index: index } });
642
+ this.dispatchEvent(finishedEvt);
643
+
644
+ this._currentLoadingProgress = undefined;
645
+ this._currentlyLoadingScene = undefined;
646
+
647
+ if (finishedEvt.defaultPrevented) {
648
+ if (debug) console.warn("Adding loaded scene prevented:", scene, finishedEvt);
649
+ return false;
650
+ }
651
+ if (!scene.asset) {
652
+ if (debug) console.warn("Failed loading scene:", scene);
653
+ return false;
654
+ }
655
+ if (this._currentIndex === index) {
656
+ if (debug) console.log("ADD", scene.url);
657
+ this._currentScene = scene;
658
+
659
+
660
+ // Experimental: replace the whole content of the scene
661
+ if (experimental_clearSceneOnLoad) {
662
+ const camera = this.context.mainCameraComponent?.gameObject || this.context.mainCamera;
663
+ camera?.removeFromParent();
664
+ const self = this.gameObject.removeFromParent();
665
+ destroy(this.context.scene, true, true)
666
+ this.context.scene = new Scene();
667
+ this.context.scene.add(self);
668
+ if (camera) {
669
+ this.context.scene.add(camera);
670
+ }
671
+ }
672
+
673
+ GameObject.add(scene.asset, this.gameObject);
674
+
675
+ if (this.useSceneLighting)
676
+ this.context.sceneLighting.enable(scene);
677
+ // Set the background texture from the loaded scene
678
+ if (this.useSceneBackground) {
679
+ const skybox = this.context.lightmaps.tryGetSkybox(scene.url) as Texture;
680
+ if (skybox) {
681
+ skybox.mapping = EquirectangularReflectionMapping;
682
+ this.context.scene.background = skybox;
683
+ }
684
+ else if (debug) {
685
+ console.warn("SceneSwitcher: Can't find skybox for scene " + scene.url);
686
+ }
687
+ }
688
+
689
+
690
+ if (this.useHistory && index >= 0) {
691
+ // take the index as the query parameter value
692
+ let queryParameterValue = index.toString();
693
+ // unless the user defines that he wants to use the scene name
694
+ if (this.useSceneName) {
695
+ if (scene instanceof Object3D) queryParameterValue = scene.name;
696
+ else if (scene.url) queryParameterValue = sceneUriToName(scene.url);
697
+ }
698
+ // save the loaded scene as an url parameter
699
+ if (this.queryParameterName?.length)
700
+ setParamWithoutReload(this.queryParameterName, queryParameterValue, this.useHistory);
701
+ // or set the history state without updating the url parameter
702
+ else {
703
+ const lastState = history.state;
704
+ const stateName = this.guid + "::" + index;
705
+ if (lastState !== stateName)
706
+ history.pushState(stateName, "unused", location.href);
707
+ }
708
+ }
709
+ // Call SceneListener opened callback (if a SceneListener is in the scene)
710
+ const sceneListener = this.tryGetSceneEventListener(scene.asset as any as Object3D);
711
+ if (sceneListener?.sceneOpened) {
712
+ const res = sceneListener.sceneOpened(this);
713
+ if (res instanceof Promise) await res;
714
+ }
715
+
716
+ const openedEvt = new CustomEvent<LoadSceneEvent>("scene-opened", { detail: { scene: scene, switcher: this, index: index } });
717
+ this.dispatchEvent(openedEvt);
718
+
719
+ this.sceneLoaded?.invoke(this);
720
+ return true;
721
+ }
722
+ }
723
+ catch (err) {
724
+ console.error(err);
725
+ }
726
+ return false;
727
+ }
728
+
729
+ preload(index: number) {
730
+ if (index >= 0 && index < this.scenes.length) {
731
+ const scene = this.scenes[index];
732
+ if (scene instanceof AssetReference)
733
+ return scene.preload();
734
+ }
735
+ return couldNotLoadScenePromise;
736
+ }
737
+
738
+ private tryLoadFromQueryParam() {
739
+ if (!this.queryParameterName?.length) return couldNotLoadScenePromise;
740
+ // try restore the scene from the url
741
+ const value = getParam(this.queryParameterName);
742
+ if (typeof value === "boolean") return couldNotLoadScenePromise;
743
+ return this.trySelectSceneFromValue(value);
744
+ }
745
+
746
+ /** try to select a scene from a string or index */
747
+ private trySelectSceneFromValue(value: string | number) {
748
+
749
+ if (typeof value === "string") {
750
+ const index = parseInt(value as string);
751
+ if (index >= 0 && index < this.scenes.length) {
752
+ return this.select(index);;
753
+ }
754
+ else {
755
+ // Try to find a scene with a matching name
756
+ // we don't care about casing. e.g. Scene1 and scene1 should both match
757
+ const lowerCaseValue = value.toLowerCase();
758
+ for (let i = 0; i < this.scenes.length; i++) {
759
+ const scene = this.scenes[i];
760
+ if (!scene) continue;
761
+ const name = scene instanceof Object3D ? scene.name : sceneUriToName(scene.url);
762
+ if (name.toLowerCase().includes(lowerCaseValue)) {
763
+ return this.select(i);
764
+ }
765
+ }
766
+ }
767
+ }
768
+ else if (typeof value === "number") {
769
+ if (value >= 0 && value < this.scenes.length) {
770
+ return this.select(value);;
771
+ }
772
+ }
773
+
774
+ if (isLocalNetwork()) console.warn("Can not find scene: \"" + value + "\"", this)
775
+
776
+ return couldNotLoadScenePromise;
777
+ }
778
+
779
+ private _lastLoadingScene: AssetReference | undefined = undefined;
780
+ private _loadingScenePromise: Promise<boolean> | undefined = undefined;
781
+ private _isCurrentlyLoading: boolean = false;
782
+ private _currentLoadingProgress: ProgressEvent | undefined = undefined;
783
+
784
+ private async onStartLoading() {
785
+ this._isCurrentlyLoading = true;
786
+ if (this.loadingScene) {
787
+ // save the last loading scene reference so that it can be changed at runtime
788
+ // since we cache the loading promise here
789
+ if (this._lastLoadingScene !== this.loadingScene) {
790
+ this._loadingScenePromise = undefined;
791
+ }
792
+ this._lastLoadingScene = this.loadingScene;
793
+ if (!this._loadingScenePromise) {
794
+ this._loadingScenePromise = this.loadingScene?.loadAssetAsync().then(res => res != null);
795
+ }
796
+ await this._loadingScenePromise;
797
+ if (this._isCurrentlyLoading && this.loadingScene?.asset) {
798
+ if (debug) console.log("Add loading scene", this.loadingScene.url, this.loadingScene.asset)
799
+ const loadingScene = this.loadingScene.asset as any as Object3D;
800
+ GameObject.add(loadingScene, this.gameObject);
801
+ const sceneListener = this.tryGetSceneEventListener(loadingScene);
802
+ if (sceneListener?.sceneOpened) {
803
+ const res = sceneListener.sceneOpened(this);
804
+ if (res instanceof Promise) await res;
805
+ }
806
+ }
807
+ }
808
+ // Invoke the event on a loading listener on the same object as the scene switcher
809
+ if (this._isCurrentlyLoading) {
810
+ const listener = this.tryGetSceneEventListener(this.gameObject);
811
+ if (listener) {
812
+ if (listener.sceneOpened) {
813
+ const res = listener.sceneOpened(this);
814
+ if (res instanceof Promise) await res;
815
+ }
816
+ }
817
+ }
818
+ }
819
+ private async onEndLoading() {
820
+ this._isCurrentlyLoading = false;
821
+ if (this.loadingScene?.asset) {
822
+ if (debug) console.log("Remove loading scene", this.loadingScene.url);
823
+ const obj = this.loadingScene.asset as any as Object3D;
824
+ // try to find an ISceneEventListener component
825
+ const sceneListener = this.tryGetSceneEventListener(obj);
826
+ if (typeof sceneListener?.sceneClosing === "function") {
827
+ const res = sceneListener.sceneClosing();
828
+ if (res instanceof Promise) await res;
829
+ }
830
+ GameObject.remove(obj);
831
+ }
832
+ // Invoke the event on a loading listener on the same object as the scene switcher
833
+ if (!this._isCurrentlyLoading) {
834
+ const listener = this.tryGetSceneEventListener(this.gameObject);
835
+ if (listener) {
836
+ if (listener.sceneClosing) {
837
+ const res = listener.sceneClosing();
838
+ if (res instanceof Promise) await res;
839
+ }
840
+ }
841
+ }
842
+ }
843
+
844
+ private tryGetSceneEventListener(obj: Object3D, level: number = 0): ISceneEventListener | null {
845
+ if (!obj) {
846
+ return null;
847
+ }
848
+ const sceneListener = GameObject.foreachComponent(obj, c => {
849
+ const i = c as any as ISceneEventListener;
850
+ if (i.sceneClosing! || i.sceneOpened!) return i;
851
+ else return undefined;
852
+ });
853
+ // if we didnt find any component with the listener on the root object
854
+ // we also check the first level of its children because a scene might be a group
855
+ if (level === 0 && !sceneListener && obj.children.length) {
856
+ for (const ch of obj.children) {
857
+ const res = this.tryGetSceneEventListener(ch, level + 1);
858
+ if (res) return res;
859
+ }
860
+ }
861
+ if (!sceneListener) return null;
862
+ return sceneListener;
863
+ }
864
+ }
865
+
866
+
867
+ function sceneUriToName(uri: string): string {
868
+ const name = uri.split("/").pop();
869
+ const value = name?.split(".").shift();
870
+ if (value?.length) return value;
871
+ return uri;
872
+ }
873
+
874
+
875
+
876
+ /**
877
+ * PreLoadScheduler is responsible for managing preloading of scenes.
878
+ * It handles scheduling and limiting concurrent downloads of scenes based on specified parameters.
879
+ */
880
+ class PreLoadScheduler {
881
+ /** Maximum number of scenes to preload ahead of the current scene */
882
+ maxLoadAhead: number;
883
+
884
+ /** Maximum number of scenes to preload behind the current scene */
885
+ maxLoadBehind: number;
886
+
887
+ /** Maximum number of scenes that can be preloaded concurrently */
888
+ maxConcurrent: number;
889
+
890
+ private _isRunning: boolean = false;
891
+ private _switcher: SceneSwitcher;
892
+ private _loadTasks: LoadTask[] = [];
893
+ private _maxConcurrentLoads: number = 1;
894
+
895
+ /**
896
+ * Creates a new PreLoadScheduler instance
897
+ * @param rooms The SceneSwitcher that this scheduler belongs to
898
+ * @param ahead Number of scenes to preload ahead of current scene
899
+ * @param behind Number of scenes to preload behind current scene
900
+ * @param maxConcurrent Maximum number of concurrent preloads allowed
901
+ */
902
+ constructor(rooms: SceneSwitcher, ahead: number = 1, behind: number = 1, maxConcurrent: number = 2) {
903
+ this._switcher = rooms;
904
+ this.maxLoadAhead = ahead;
905
+ this.maxLoadBehind = behind;
906
+ this.maxConcurrent = maxConcurrent;
907
+ }
908
+
909
+ /**
910
+ * Starts the preloading process after a specified delay
911
+ * @param delay Time in milliseconds to wait before starting preload
912
+ */
913
+ begin(delay: number) {
914
+ if (this._isRunning) return;
915
+ if (debug) console.log("Preload begin", { delay })
916
+ this._isRunning = true;
917
+ let lastRoom: number = -10;
918
+ let searchDistance: number;
919
+ let searchCall: number;
920
+ const array = this._switcher.scenes;
921
+ const startTime = Date.now() + delay;
922
+ const interval = setInterval(() => {
923
+ if (this.allLoaded()) {
924
+ if (debug)
925
+ console.log("All scenes (pre-)loaded");
926
+ this.stop();
927
+ }
928
+ if (!this._isRunning) {
929
+ clearInterval(interval);
930
+ return;
931
+ }
932
+
933
+ if (Date.now() < startTime) return;
934
+
935
+ if (this.canLoadNewScene() === false) return;
936
+ if (lastRoom === -10 || lastRoom !== this._switcher.currentIndex) {
937
+ lastRoom = this._switcher.currentIndex;
938
+ searchCall = 0;
939
+ searchDistance = 0;
940
+ }
941
+ const searchForward = searchCall % 2 === 0;
942
+ if (searchForward) searchDistance += 1;
943
+ searchCall += 1;
944
+ const maxSearchDistance = searchForward ? this.maxLoadAhead : this.maxLoadBehind;
945
+ if (searchDistance > maxSearchDistance) return;
946
+ const roomIndex = searchForward ? lastRoom + searchDistance : lastRoom - searchDistance;
947
+ if (roomIndex < 0) return;
948
+ // if (roomIndex < 0) roomIndex = array.length + roomIndex;
949
+ if (roomIndex < 0 || roomIndex >= array.length) return;
950
+ if (!this._loadTasks.some(t => t.index === roomIndex)) {
951
+ const scene = array[roomIndex];
952
+ if (debug) console.log("Preload scene", { roomIndex, searchForward, lastRoom, currentIndex: this._switcher.currentIndex, tasks: this._loadTasks.length }, scene?.url);
953
+ new LoadTask(roomIndex, scene, this._loadTasks);
954
+ }
955
+ }, 200);
956
+ }
957
+
958
+ /**
959
+ * Stops the preloading process
960
+ */
961
+ stop() {
962
+ this._isRunning = false;
963
+ }
964
+
965
+ /**
966
+ * Checks if a new scene can be loaded based on current load limits
967
+ * @returns True if a new scene can be loaded, false otherwise
968
+ */
969
+ canLoadNewScene(): boolean {
970
+ return this._loadTasks.length < this._maxConcurrentLoads;
971
+ }
972
+
973
+ /**
974
+ * Checks if all scenes in the SceneSwitcher have been loaded
975
+ * @returns True if all scenes are loaded, false otherwise
976
+ */
977
+ allLoaded(): boolean {
978
+ if (this._switcher.scenes) {
979
+ for (const scene of this._switcher.scenes) {
980
+ if (!scene?.isLoaded) continue;
981
+ if (scene.isLoaded() === false) return false;
982
+ }
983
+ }
984
+ return true;
985
+ }
986
+ }
987
+
988
+ /**
989
+ * Represents a single preloading task for a scene
990
+ */
991
+ class LoadTask {
992
+ /** The index of the scene in the scenes array */
993
+ index: number;
994
+
995
+ /** The AssetReference to be loaded */
996
+ asset: AssetReference;
997
+
998
+ /** The collection of active load tasks this task belongs to */
999
+ tasks: LoadTask[];
1000
+
1001
+ /**
1002
+ * Creates a new LoadTask and begins loading immediately
1003
+ * @param index The index of the scene in the scenes array
1004
+ * @param asset The AssetReference to preload
1005
+ * @param tasks The collection of active load tasks
1006
+ */
1007
+ constructor(index: number, asset: AssetReference, tasks: LoadTask[]) {
1008
+ this.index = index;
1009
+ this.asset = asset;
1010
+ this.tasks = tasks;
1011
+ tasks.push(this);
1012
+ this.awaitLoading();
1013
+ }
1014
+
1015
+ /**
1016
+ * Asynchronously loads the asset and removes this task from the active tasks list when complete
1017
+ */
1018
+ private async awaitLoading() {
1019
+ if (this.asset && !this.asset.isLoaded()) {
1020
+ if (debug)
1021
+ console.log("Preload start: " + this.asset.url, this.index);
1022
+ await this.asset.preload();
1023
+ if (debug)
1024
+ console.log("Preload finished: " + this.asset.url, this.index);
1025
+ }
1026
+
1027
+ const i = this.tasks.indexOf(this);
1028
+ if (i >= 0) this.tasks.splice(i, 1);
1029
+ }
1030
+ }