@needle-tools/engine 4.4.1 → 4.4.3-beta

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 (1046) hide show
  1. package/CHANGELOG.md +3678 -3667
  2. package/LICENSE.md +10 -10
  3. package/README.md +64 -64
  4. package/components.needle.json +1 -1
  5. package/dist/needle-engine.bundle.js +364 -237
  6. package/dist/needle-engine.bundle.light.js +364 -237
  7. package/dist/needle-engine.bundle.light.min.js +6 -6
  8. package/dist/needle-engine.bundle.light.umd.cjs +6 -6
  9. package/dist/needle-engine.bundle.min.js +6 -6
  10. package/dist/needle-engine.bundle.umd.cjs +56 -56
  11. package/dist/needle-engine.d.ts +130 -129
  12. package/dist/needle-engine.light.d.ts +130 -129
  13. package/lib/asap/needle-asap.d.ts +1 -1
  14. package/lib/asap/needle-asap.js +95 -95
  15. package/lib/asap/sessiongranted.d.ts +3 -3
  16. package/lib/asap/sessiongranted.js +65 -65
  17. package/lib/asap/utils.d.ts +1 -1
  18. package/lib/asap/utils.js +3 -3
  19. package/lib/engine/analytics/index.d.ts +6 -6
  20. package/lib/engine/analytics/index.js +12 -12
  21. package/lib/engine/analytics/lcp.d.ts +3 -3
  22. package/lib/engine/analytics/lcp.js +34 -34
  23. package/lib/engine/api.d.ts +81 -81
  24. package/lib/engine/api.js +80 -80
  25. package/lib/engine/assets/index.d.ts +11 -11
  26. package/lib/engine/assets/index.js +47 -47
  27. package/lib/engine/assets/static.d.ts +1 -1
  28. package/lib/engine/assets/static.js +4 -4
  29. package/lib/engine/codegen/register_types.d.ts +1 -1
  30. package/lib/engine/codegen/register_types.js +300 -300
  31. package/lib/engine/debug/debug.d.ts +15 -15
  32. package/lib/engine/debug/debug.js +44 -44
  33. package/lib/engine/debug/debug_console.d.ts +2 -2
  34. package/lib/engine/debug/debug_console.js +307 -307
  35. package/lib/engine/debug/debug_overlay.d.ts +22 -22
  36. package/lib/engine/debug/debug_overlay.js +316 -316
  37. package/lib/engine/debug/debug_spatial_console.d.ts +2 -2
  38. package/lib/engine/debug/debug_spatial_console.js +390 -390
  39. package/lib/engine/debug/index.d.ts +2 -2
  40. package/lib/engine/debug/index.js +2 -2
  41. package/lib/engine/engine_addressables.d.ts +166 -166
  42. package/lib/engine/engine_addressables.js +608 -608
  43. package/lib/engine/engine_animation.d.ts +43 -43
  44. package/lib/engine/engine_animation.js +133 -133
  45. package/lib/engine/engine_application.d.ts +40 -40
  46. package/lib/engine/engine_application.js +104 -104
  47. package/lib/engine/engine_assetdatabase.d.ts +25 -25
  48. package/lib/engine/engine_assetdatabase.js +344 -344
  49. package/lib/engine/engine_audio.d.ts +4 -4
  50. package/lib/engine/engine_audio.js +23 -23
  51. package/lib/engine/engine_camera.d.ts +13 -13
  52. package/lib/engine/engine_camera.js +30 -30
  53. package/lib/engine/engine_components.d.ts +110 -110
  54. package/lib/engine/engine_components.js +382 -382
  55. package/lib/engine/engine_components_internal.d.ts +9 -9
  56. package/lib/engine/engine_components_internal.js +36 -36
  57. package/lib/engine/engine_constants.d.ts +10 -10
  58. package/lib/engine/engine_constants.js +41 -41
  59. package/lib/engine/engine_context.d.ts +472 -354
  60. package/lib/engine/engine_context.js +1653 -1536
  61. package/lib/engine/engine_context.js.map +1 -1
  62. package/lib/engine/engine_context_registry.d.ts +71 -71
  63. package/lib/engine/engine_context_registry.js +117 -117
  64. package/lib/engine/engine_coroutine.d.ts +35 -35
  65. package/lib/engine/engine_coroutine.js +52 -52
  66. package/lib/engine/engine_create_objects.d.ts +118 -118
  67. package/lib/engine/engine_create_objects.js +308 -308
  68. package/lib/engine/engine_default_parameters.d.ts +2 -2
  69. package/lib/engine/engine_default_parameters.js +3 -3
  70. package/lib/engine/engine_editor-sync.d.ts +21 -21
  71. package/lib/engine/engine_editor-sync.js +4 -4
  72. package/lib/engine/engine_element.d.ts +113 -113
  73. package/lib/engine/engine_element.js +832 -832
  74. package/lib/engine/engine_element_attributes.d.ts +72 -72
  75. package/lib/engine/engine_element_attributes.js +1 -1
  76. package/lib/engine/engine_element_extras.d.ts +6 -6
  77. package/lib/engine/engine_element_extras.js +13 -13
  78. package/lib/engine/engine_element_loading.d.ts +44 -44
  79. package/lib/engine/engine_element_loading.js +349 -349
  80. package/lib/engine/engine_element_overlay.d.ts +21 -21
  81. package/lib/engine/engine_element_overlay.js +166 -166
  82. package/lib/engine/engine_fileloader.d.ts +2 -2
  83. package/lib/engine/engine_fileloader.js +8 -8
  84. package/lib/engine/engine_gameobject.d.ts +68 -68
  85. package/lib/engine/engine_gameobject.js +596 -596
  86. package/lib/engine/engine_generic_utils.d.ts +1 -1
  87. package/lib/engine/engine_generic_utils.js +13 -13
  88. package/lib/engine/engine_gizmos.d.ts +149 -149
  89. package/lib/engine/engine_gizmos.js +530 -530
  90. package/lib/engine/engine_gltf.d.ts +12 -12
  91. package/lib/engine/engine_gltf.js +15 -15
  92. package/lib/engine/engine_gltf_builtin_components.d.ts +7 -7
  93. package/lib/engine/engine_gltf_builtin_components.js +341 -341
  94. package/lib/engine/engine_hot_reload.d.ts +7 -7
  95. package/lib/engine/engine_hot_reload.js +184 -184
  96. package/lib/engine/engine_input.d.ts +362 -352
  97. package/lib/engine/engine_input.js +1294 -1265
  98. package/lib/engine/engine_input.js.map +1 -1
  99. package/lib/engine/engine_input_utils.d.ts +2 -2
  100. package/lib/engine/engine_input_utils.js +22 -22
  101. package/lib/engine/engine_instancing.d.ts +19 -19
  102. package/lib/engine/engine_instancing.js +39 -39
  103. package/lib/engine/engine_license.d.ts +11 -11
  104. package/lib/engine/engine_license.js +361 -361
  105. package/lib/engine/engine_license.js.map +1 -1
  106. package/lib/engine/engine_lifecycle_api.d.ts +76 -76
  107. package/lib/engine/engine_lifecycle_api.js +99 -99
  108. package/lib/engine/engine_lifecycle_functions_internal.d.ts +32 -32
  109. package/lib/engine/engine_lifecycle_functions_internal.js +146 -146
  110. package/lib/engine/engine_lightdata.d.ts +23 -23
  111. package/lib/engine/engine_lightdata.js +91 -91
  112. package/lib/engine/engine_loaders.d.ts +13 -13
  113. package/lib/engine/engine_loaders.js +62 -62
  114. package/lib/engine/engine_lods.d.ts +31 -31
  115. package/lib/engine/engine_lods.js +146 -146
  116. package/lib/engine/engine_mainloop_utils.d.ts +32 -32
  117. package/lib/engine/engine_mainloop_utils.js +466 -466
  118. package/lib/engine/engine_math.d.ts +114 -114
  119. package/lib/engine/engine_math.js +247 -247
  120. package/lib/engine/engine_modules.d.ts +36 -36
  121. package/lib/engine/engine_modules.js +85 -85
  122. package/lib/engine/engine_networking.d.ts +252 -252
  123. package/lib/engine/engine_networking.js +743 -743
  124. package/lib/engine/engine_networking_auto.d.ts +24 -24
  125. package/lib/engine/engine_networking_auto.js +310 -310
  126. package/lib/engine/engine_networking_blob.d.ts +48 -48
  127. package/lib/engine/engine_networking_blob.js +228 -228
  128. package/lib/engine/engine_networking_files.d.ts +35 -35
  129. package/lib/engine/engine_networking_files.js +172 -172
  130. package/lib/engine/engine_networking_files_default_components.d.ts +6 -6
  131. package/lib/engine/engine_networking_files_default_components.js +42 -42
  132. package/lib/engine/engine_networking_instantiate.d.ts +100 -100
  133. package/lib/engine/engine_networking_instantiate.js +345 -345
  134. package/lib/engine/engine_networking_peer.d.ts +15 -15
  135. package/lib/engine/engine_networking_peer.js +132 -132
  136. package/lib/engine/engine_networking_streams.d.ts +123 -123
  137. package/lib/engine/engine_networking_streams.js +645 -645
  138. package/lib/engine/engine_networking_types.d.ts +22 -22
  139. package/lib/engine/engine_networking_types.js +7 -7
  140. package/lib/engine/engine_networking_utils.d.ts +2 -2
  141. package/lib/engine/engine_networking_utils.js +20 -20
  142. package/lib/engine/engine_networking_websocket.d.ts +1 -1
  143. package/lib/engine/engine_networking_websocket.js +2 -2
  144. package/lib/engine/engine_patcher.d.ts +10 -10
  145. package/lib/engine/engine_patcher.js +142 -142
  146. package/lib/engine/engine_physics.d.ts +152 -152
  147. package/lib/engine/engine_physics.js +645 -645
  148. package/lib/engine/engine_physics.types.d.ts +40 -40
  149. package/lib/engine/engine_physics.types.js +33 -33
  150. package/lib/engine/engine_physics_rapier.d.ts +147 -147
  151. package/lib/engine/engine_physics_rapier.js +1433 -1433
  152. package/lib/engine/engine_playerview.d.ts +26 -26
  153. package/lib/engine/engine_playerview.js +64 -64
  154. package/lib/engine/engine_scenelighting.d.ts +71 -71
  155. package/lib/engine/engine_scenelighting.js +226 -226
  156. package/lib/engine/engine_scenetools.d.ts +50 -50
  157. package/lib/engine/engine_scenetools.js +321 -321
  158. package/lib/engine/engine_serialization.d.ts +3 -3
  159. package/lib/engine/engine_serialization.js +3 -3
  160. package/lib/engine/engine_serialization_builtin_serializer.d.ts +72 -72
  161. package/lib/engine/engine_serialization_builtin_serializer.js +403 -403
  162. package/lib/engine/engine_serialization_core.d.ts +85 -85
  163. package/lib/engine/engine_serialization_core.js +606 -606
  164. package/lib/engine/engine_serialization_decorator.d.ts +23 -23
  165. package/lib/engine/engine_serialization_decorator.js +66 -66
  166. package/lib/engine/engine_setup.d.ts +1 -1
  167. package/lib/engine/engine_setup.js +2 -2
  168. package/lib/engine/engine_shaders.d.ts +53 -53
  169. package/lib/engine/engine_shaders.js +252 -252
  170. package/lib/engine/engine_shims.d.ts +4 -4
  171. package/lib/engine/engine_shims.js +24 -24
  172. package/lib/engine/engine_test_utils.d.ts +39 -39
  173. package/lib/engine/engine_test_utils.js +83 -83
  174. package/lib/engine/engine_texture.d.ts +28 -28
  175. package/lib/engine/engine_texture.js +64 -64
  176. package/lib/engine/engine_three_utils.d.ts +201 -201
  177. package/lib/engine/engine_three_utils.js +731 -731
  178. package/lib/engine/engine_time.d.ts +51 -51
  179. package/lib/engine/engine_time.js +82 -82
  180. package/lib/engine/engine_time_utils.d.ts +88 -88
  181. package/lib/engine/engine_time_utils.js +215 -215
  182. package/lib/engine/engine_tonemapping.d.ts +2 -2
  183. package/lib/engine/engine_tonemapping.js +194 -194
  184. package/lib/engine/engine_types.d.ts +572 -572
  185. package/lib/engine/engine_types.js +88 -88
  186. package/lib/engine/engine_typestore.d.ts +28 -28
  187. package/lib/engine/engine_typestore.js +55 -55
  188. package/lib/engine/engine_util_decorator.d.ts +13 -13
  189. package/lib/engine/engine_util_decorator.js +116 -116
  190. package/lib/engine/engine_utils.d.ts +266 -266
  191. package/lib/engine/engine_utils.js +878 -878
  192. package/lib/engine/engine_utils_format.d.ts +21 -21
  193. package/lib/engine/engine_utils_format.js +193 -193
  194. package/lib/engine/engine_utils_screenshot.d.ts +159 -159
  195. package/lib/engine/engine_utils_screenshot.js +513 -513
  196. package/lib/engine/engine_utils_screenshot.xr.d.ts +5 -5
  197. package/lib/engine/engine_utils_screenshot.xr.js +90 -90
  198. package/lib/engine/engine_xr.d.ts +1 -1
  199. package/lib/engine/engine_xr.js +1 -1
  200. package/lib/engine/export/gltf/Writers.d.ts +19 -19
  201. package/lib/engine/export/gltf/Writers.js +24 -24
  202. package/lib/engine/export/gltf/index.d.ts +11 -11
  203. package/lib/engine/export/gltf/index.js +123 -123
  204. package/lib/engine/export/index.d.ts +2 -2
  205. package/lib/engine/export/index.js +2 -2
  206. package/lib/engine/export/state.d.ts +7 -7
  207. package/lib/engine/export/state.js +17 -17
  208. package/lib/engine/export/utils.d.ts +2 -2
  209. package/lib/engine/export/utils.js +7 -7
  210. package/lib/engine/extensions/EXT_texture_exr.d.ts +8 -8
  211. package/lib/engine/extensions/EXT_texture_exr.js +32 -32
  212. package/lib/engine/extensions/NEEDLE_animator_controller_model.d.ts +122 -122
  213. package/lib/engine/extensions/NEEDLE_animator_controller_model.js +95 -95
  214. package/lib/engine/extensions/NEEDLE_components.d.ts +35 -35
  215. package/lib/engine/extensions/NEEDLE_components.js +220 -220
  216. package/lib/engine/extensions/NEEDLE_gameobject_data.d.ts +10 -10
  217. package/lib/engine/extensions/NEEDLE_gameobject_data.js +57 -57
  218. package/lib/engine/extensions/NEEDLE_lighting_settings.d.ts +37 -37
  219. package/lib/engine/extensions/NEEDLE_lighting_settings.js +157 -157
  220. package/lib/engine/extensions/NEEDLE_lightmaps.d.ts +18 -18
  221. package/lib/engine/extensions/NEEDLE_lightmaps.js +99 -99
  222. package/lib/engine/extensions/NEEDLE_persistent_assets.d.ts +11 -11
  223. package/lib/engine/extensions/NEEDLE_persistent_assets.js +63 -63
  224. package/lib/engine/extensions/NEEDLE_progressive.d.ts +1 -1
  225. package/lib/engine/extensions/NEEDLE_progressive.js +1 -1
  226. package/lib/engine/extensions/NEEDLE_render_objects.d.ts +13 -13
  227. package/lib/engine/extensions/NEEDLE_render_objects.js +159 -159
  228. package/lib/engine/extensions/NEEDLE_techniques_webgl.d.ts +38 -38
  229. package/lib/engine/extensions/NEEDLE_techniques_webgl.js +564 -564
  230. package/lib/engine/extensions/extension_resolver.d.ts +4 -4
  231. package/lib/engine/extensions/extension_resolver.js +1 -1
  232. package/lib/engine/extensions/extension_utils.d.ts +12 -12
  233. package/lib/engine/extensions/extension_utils.js +152 -152
  234. package/lib/engine/extensions/extensions.d.ts +31 -31
  235. package/lib/engine/extensions/extensions.js +103 -103
  236. package/lib/engine/extensions/index.d.ts +6 -6
  237. package/lib/engine/extensions/index.js +6 -6
  238. package/lib/engine/extensions/usage_tracker.d.ts +13 -13
  239. package/lib/engine/extensions/usage_tracker.js +65 -65
  240. package/lib/engine/js-extensions/Camera.d.ts +1 -1
  241. package/lib/engine/js-extensions/Camera.js +39 -39
  242. package/lib/engine/js-extensions/ExtensionUtils.d.ts +9 -9
  243. package/lib/engine/js-extensions/ExtensionUtils.js +67 -67
  244. package/lib/engine/js-extensions/Layers.d.ts +6 -6
  245. package/lib/engine/js-extensions/Layers.js +22 -22
  246. package/lib/engine/js-extensions/Object3D.d.ts +120 -120
  247. package/lib/engine/js-extensions/Object3D.js +136 -136
  248. package/lib/engine/js-extensions/RGBAColor.d.ts +23 -23
  249. package/lib/engine/js-extensions/RGBAColor.js +111 -110
  250. package/lib/engine/js-extensions/RGBAColor.js.map +1 -1
  251. package/lib/engine/js-extensions/Vector.d.ts +3 -3
  252. package/lib/engine/js-extensions/Vector.js +13 -13
  253. package/lib/engine/js-extensions/index.d.ts +5 -5
  254. package/lib/engine/js-extensions/index.js +5 -5
  255. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.d.ts +4 -4
  256. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +76 -76
  257. package/lib/engine/shaders/shaderData.d.ts +55 -55
  258. package/lib/engine/shaders/shaderData.js +58 -58
  259. package/lib/engine/tests/test_utils.d.ts +2 -2
  260. package/lib/engine/tests/test_utils.js +53 -53
  261. package/lib/engine/webcomponents/WebXRButtons.d.ts +56 -56
  262. package/lib/engine/webcomponents/WebXRButtons.js +230 -230
  263. package/lib/engine/webcomponents/api.d.ts +5 -5
  264. package/lib/engine/webcomponents/api.js +4 -4
  265. package/lib/engine/webcomponents/buttons.d.ts +39 -39
  266. package/lib/engine/webcomponents/buttons.js +237 -237
  267. package/lib/engine/webcomponents/fonts.d.ts +9 -9
  268. package/lib/engine/webcomponents/fonts.js +32 -32
  269. package/lib/engine/webcomponents/icons.d.ts +9 -9
  270. package/lib/engine/webcomponents/icons.js +52 -52
  271. package/lib/engine/webcomponents/index.d.ts +1 -1
  272. package/lib/engine/webcomponents/index.js +1 -1
  273. package/lib/engine/webcomponents/logo-element.d.ts +10 -10
  274. package/lib/engine/webcomponents/logo-element.js +67 -67
  275. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.d.ts +37 -37
  276. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.js +513 -513
  277. package/lib/engine/webcomponents/needle menu/needle-menu.d.ts +155 -155
  278. package/lib/engine/webcomponents/needle menu/needle-menu.js +1029 -1029
  279. package/lib/engine/webcomponents/needle-button.d.ts +34 -34
  280. package/lib/engine/webcomponents/needle-button.js +161 -161
  281. package/lib/engine/xr/NeedleXRController.d.ts +313 -313
  282. package/lib/engine/xr/NeedleXRController.js +1007 -1007
  283. package/lib/engine/xr/NeedleXRSession.d.ts +339 -339
  284. package/lib/engine/xr/NeedleXRSession.js +1427 -1427
  285. package/lib/engine/xr/NeedleXRSync.d.ts +22 -22
  286. package/lib/engine/xr/NeedleXRSync.js +188 -188
  287. package/lib/engine/xr/SceneTransition.d.ts +18 -18
  288. package/lib/engine/xr/SceneTransition.js +69 -69
  289. package/lib/engine/xr/TempXRContext.d.ts +34 -34
  290. package/lib/engine/xr/TempXRContext.js +187 -187
  291. package/lib/engine/xr/XRRig.d.ts +7 -7
  292. package/lib/engine/xr/XRRig.js +1 -1
  293. package/lib/engine/xr/api.d.ts +6 -6
  294. package/lib/engine/xr/api.js +6 -6
  295. package/lib/engine/xr/events.d.ts +66 -66
  296. package/lib/engine/xr/events.js +93 -93
  297. package/lib/engine/xr/internal.d.ts +12 -12
  298. package/lib/engine/xr/internal.js +25 -25
  299. package/lib/engine/xr/usdz.d.ts +12 -12
  300. package/lib/engine/xr/usdz.js +29 -29
  301. package/lib/engine/xr/utils.d.ts +11 -11
  302. package/lib/engine/xr/utils.js +34 -34
  303. package/lib/engine-components/AlignmentConstraint.d.ts +10 -10
  304. package/lib/engine-components/AlignmentConstraint.js +39 -39
  305. package/lib/engine-components/Animation.d.ts +156 -156
  306. package/lib/engine-components/Animation.js +508 -508
  307. package/lib/engine-components/AnimationCurve.d.ts +40 -40
  308. package/lib/engine-components/AnimationCurve.js +159 -159
  309. package/lib/engine-components/AnimationUtils.d.ts +8 -8
  310. package/lib/engine-components/AnimationUtils.js +27 -27
  311. package/lib/engine-components/AnimationUtilsAutoplay.d.ts +1 -1
  312. package/lib/engine-components/AnimationUtilsAutoplay.js +39 -39
  313. package/lib/engine-components/Animator.d.ts +217 -217
  314. package/lib/engine-components/Animator.js +354 -354
  315. package/lib/engine-components/AnimatorController.d.ts +227 -227
  316. package/lib/engine-components/AnimatorController.js +1152 -1152
  317. package/lib/engine-components/AudioListener.d.ts +33 -33
  318. package/lib/engine-components/AudioListener.js +86 -86
  319. package/lib/engine-components/AudioSource.d.ts +217 -217
  320. package/lib/engine-components/AudioSource.js +634 -634
  321. package/lib/engine-components/AvatarLoader.d.ts +80 -80
  322. package/lib/engine-components/AvatarLoader.js +231 -231
  323. package/lib/engine-components/AxesHelper.d.ts +32 -32
  324. package/lib/engine-components/AxesHelper.js +67 -67
  325. package/lib/engine-components/BasicIKConstraint.d.ts +9 -9
  326. package/lib/engine-components/BasicIKConstraint.js +43 -43
  327. package/lib/engine-components/BoxCollider.d.ts +2 -2
  328. package/lib/engine-components/BoxCollider.js +2 -2
  329. package/lib/engine-components/BoxHelperComponent.d.ts +47 -47
  330. package/lib/engine-components/BoxHelperComponent.js +102 -102
  331. package/lib/engine-components/Camera.d.ts +231 -231
  332. package/lib/engine-components/Camera.js +700 -700
  333. package/lib/engine-components/CameraUtils.d.ts +1 -1
  334. package/lib/engine-components/CameraUtils.js +121 -121
  335. package/lib/engine-components/CharacterController.d.ts +55 -55
  336. package/lib/engine-components/CharacterController.js +236 -236
  337. package/lib/engine-components/Collider.d.ts +188 -188
  338. package/lib/engine-components/Collider.js +369 -369
  339. package/lib/engine-components/Component.d.ts +792 -792
  340. package/lib/engine-components/Component.js +915 -915
  341. package/lib/engine-components/ContactShadows.d.ts +82 -82
  342. package/lib/engine-components/ContactShadows.js +430 -430
  343. package/lib/engine-components/DeleteBox.d.ts +19 -19
  344. package/lib/engine-components/DeleteBox.js +58 -58
  345. package/lib/engine-components/DeviceFlag.d.ts +16 -16
  346. package/lib/engine-components/DeviceFlag.js +47 -47
  347. package/lib/engine-components/DragControls.d.ts +170 -170
  348. package/lib/engine-components/DragControls.js +1421 -1421
  349. package/lib/engine-components/DropListener.d.ts +215 -215
  350. package/lib/engine-components/DropListener.js +630 -630
  351. package/lib/engine-components/Duplicatable.d.ts +35 -35
  352. package/lib/engine-components/Duplicatable.js +202 -202
  353. package/lib/engine-components/EventList.d.ts +54 -54
  354. package/lib/engine-components/EventList.js +232 -232
  355. package/lib/engine-components/EventTrigger.d.ts +33 -33
  356. package/lib/engine-components/EventTrigger.js +75 -75
  357. package/lib/engine-components/EventType.d.ts +22 -22
  358. package/lib/engine-components/EventType.js +23 -23
  359. package/lib/engine-components/Fog.d.ts +22 -22
  360. package/lib/engine-components/Fog.js +61 -61
  361. package/lib/engine-components/Gizmos.d.ts +17 -17
  362. package/lib/engine-components/Gizmos.js +64 -64
  363. package/lib/engine-components/GridHelper.d.ts +20 -20
  364. package/lib/engine-components/GridHelper.js +54 -54
  365. package/lib/engine-components/GroundProjection.d.ts +67 -67
  366. package/lib/engine-components/GroundProjection.js +343 -343
  367. package/lib/engine-components/Interactable.d.ts +12 -12
  368. package/lib/engine-components/Interactable.js +12 -12
  369. package/lib/engine-components/Joints.d.ts +19 -19
  370. package/lib/engine-components/Joints.js +51 -51
  371. package/lib/engine-components/LODGroup.d.ts +35 -35
  372. package/lib/engine-components/LODGroup.js +152 -152
  373. package/lib/engine-components/Light.d.ts +180 -180
  374. package/lib/engine-components/Light.js +535 -535
  375. package/lib/engine-components/LookAtConstraint.d.ts +19 -19
  376. package/lib/engine-components/LookAtConstraint.js +35 -35
  377. package/lib/engine-components/NeedleMenu.d.ts +50 -50
  378. package/lib/engine-components/NeedleMenu.js +92 -92
  379. package/lib/engine-components/NestedGltf.d.ts +25 -25
  380. package/lib/engine-components/NestedGltf.js +88 -88
  381. package/lib/engine-components/Networking.d.ts +54 -54
  382. package/lib/engine-components/Networking.js +112 -112
  383. package/lib/engine-components/OffsetConstraint.d.ts +14 -14
  384. package/lib/engine-components/OffsetConstraint.js +65 -65
  385. package/lib/engine-components/OrbitControls.d.ts +266 -266
  386. package/lib/engine-components/OrbitControls.js +1011 -1011
  387. package/lib/engine-components/PlayerColor.d.ts +19 -19
  388. package/lib/engine-components/PlayerColor.js +94 -94
  389. package/lib/engine-components/ReflectionProbe.d.ts +27 -27
  390. package/lib/engine-components/ReflectionProbe.js +201 -201
  391. package/lib/engine-components/Renderer.d.ts +153 -153
  392. package/lib/engine-components/Renderer.js +830 -830
  393. package/lib/engine-components/RendererInstancing.d.ts +140 -140
  394. package/lib/engine-components/RendererInstancing.js +744 -744
  395. package/lib/engine-components/RendererLightmap.d.ts +24 -24
  396. package/lib/engine-components/RendererLightmap.js +182 -182
  397. package/lib/engine-components/RigidBody.d.ts +155 -155
  398. package/lib/engine-components/RigidBody.js +517 -517
  399. package/lib/engine-components/SceneSwitcher.d.ts +263 -263
  400. package/lib/engine-components/SceneSwitcher.js +972 -972
  401. package/lib/engine-components/ScreenCapture.d.ts +144 -144
  402. package/lib/engine-components/ScreenCapture.js +547 -547
  403. package/lib/engine-components/ShadowCatcher.d.ts +33 -33
  404. package/lib/engine-components/ShadowCatcher.js +166 -166
  405. package/lib/engine-components/Skybox.d.ts +82 -82
  406. package/lib/engine-components/Skybox.js +448 -448
  407. package/lib/engine-components/SmoothFollow.d.ts +34 -34
  408. package/lib/engine-components/SmoothFollow.js +82 -82
  409. package/lib/engine-components/SpatialTrigger.d.ts +102 -102
  410. package/lib/engine-components/SpatialTrigger.js +225 -225
  411. package/lib/engine-components/SpectatorCamera.d.ts +111 -111
  412. package/lib/engine-components/SpectatorCamera.js +715 -715
  413. package/lib/engine-components/SphereCollider.d.ts +2 -2
  414. package/lib/engine-components/SphereCollider.js +2 -2
  415. package/lib/engine-components/SpriteRenderer.d.ts +132 -132
  416. package/lib/engine-components/SpriteRenderer.js +472 -472
  417. package/lib/engine-components/SyncedCamera.d.ts +41 -41
  418. package/lib/engine-components/SyncedCamera.js +199 -199
  419. package/lib/engine-components/SyncedRoom.d.ts +106 -106
  420. package/lib/engine-components/SyncedRoom.js +371 -371
  421. package/lib/engine-components/SyncedTransform.d.ts +94 -94
  422. package/lib/engine-components/SyncedTransform.js +331 -331
  423. package/lib/engine-components/SyncedTransform.js.map +1 -1
  424. package/lib/engine-components/TestRunner.d.ts +16 -16
  425. package/lib/engine-components/TestRunner.js +102 -102
  426. package/lib/engine-components/TransformGizmo.d.ts +75 -75
  427. package/lib/engine-components/TransformGizmo.js +209 -209
  428. package/lib/engine-components/VideoPlayer.d.ts +184 -184
  429. package/lib/engine-components/VideoPlayer.js +978 -978
  430. package/lib/engine-components/Voip.d.ts +67 -67
  431. package/lib/engine-components/Voip.js +360 -360
  432. package/lib/engine-components/api.d.ts +51 -51
  433. package/lib/engine-components/api.js +50 -50
  434. package/lib/engine-components/avatar/AvatarBlink_Simple.d.ts +11 -11
  435. package/lib/engine-components/avatar/AvatarBlink_Simple.js +76 -76
  436. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.d.ts +14 -14
  437. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.js +68 -68
  438. package/lib/engine-components/avatar/Avatar_Brain_LookAt.d.ts +29 -29
  439. package/lib/engine-components/avatar/Avatar_Brain_LookAt.js +121 -121
  440. package/lib/engine-components/avatar/Avatar_MouthShapes.d.ts +15 -15
  441. package/lib/engine-components/avatar/Avatar_MouthShapes.js +79 -79
  442. package/lib/engine-components/avatar/Avatar_MustacheShake.d.ts +9 -9
  443. package/lib/engine-components/avatar/Avatar_MustacheShake.js +29 -29
  444. package/lib/engine-components/codegen/components.d.ts +216 -216
  445. package/lib/engine-components/codegen/components.js +218 -218
  446. package/lib/engine-components/debug/LogStats.d.ts +5 -5
  447. package/lib/engine-components/debug/LogStats.js +18 -18
  448. package/lib/engine-components/export/gltf/GltfExport.d.ts +30 -30
  449. package/lib/engine-components/export/gltf/GltfExport.js +246 -246
  450. package/lib/engine-components/export/gltf/index.d.ts +1 -1
  451. package/lib/engine-components/export/gltf/index.js +1 -1
  452. package/lib/engine-components/export/index.d.ts +1 -1
  453. package/lib/engine-components/export/index.js +1 -1
  454. package/lib/engine-components/export/usdz/Extension.d.ts +22 -22
  455. package/lib/engine-components/export/usdz/Extension.js +1 -1
  456. package/lib/engine-components/export/usdz/ThreeUSDZExporter.d.ts +160 -160
  457. package/lib/engine-components/export/usdz/ThreeUSDZExporter.js +1782 -1782
  458. package/lib/engine-components/export/usdz/USDZExporter.d.ts +130 -130
  459. package/lib/engine-components/export/usdz/USDZExporter.js +663 -663
  460. package/lib/engine-components/export/usdz/extensions/Animation.d.ts +106 -106
  461. package/lib/engine-components/export/usdz/extensions/Animation.js +1071 -1071
  462. package/lib/engine-components/export/usdz/extensions/DocumentExtension.d.ts +5 -5
  463. package/lib/engine-components/export/usdz/extensions/DocumentExtension.js +6 -6
  464. package/lib/engine-components/export/usdz/extensions/USDZText.d.ts +54 -54
  465. package/lib/engine-components/export/usdz/extensions/USDZText.js +203 -203
  466. package/lib/engine-components/export/usdz/extensions/USDZUI.d.ts +8 -8
  467. package/lib/engine-components/export/usdz/extensions/USDZUI.js +158 -158
  468. package/lib/engine-components/export/usdz/extensions/behavior/Actions.d.ts +30 -30
  469. package/lib/engine-components/export/usdz/extensions/behavior/Actions.js +88 -88
  470. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.d.ts +10 -10
  471. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.js +86 -86
  472. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.d.ts +28 -28
  473. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.js +290 -290
  474. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.d.ts +190 -190
  475. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.js +1060 -1060
  476. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.d.ts +135 -135
  477. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.js +548 -548
  478. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.d.ts +7 -7
  479. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.js +115 -115
  480. package/lib/engine-components/export/usdz/index.d.ts +3 -3
  481. package/lib/engine-components/export/usdz/index.js +2 -2
  482. package/lib/engine-components/export/usdz/utils/animationutils.d.ts +7 -7
  483. package/lib/engine-components/export/usdz/utils/animationutils.js +163 -163
  484. package/lib/engine-components/export/usdz/utils/quicklook.d.ts +2 -2
  485. package/lib/engine-components/export/usdz/utils/quicklook.js +43 -43
  486. package/lib/engine-components/particlesystem/ParticleSystem.d.ts +177 -177
  487. package/lib/engine-components/particlesystem/ParticleSystem.js +1176 -1176
  488. package/lib/engine-components/particlesystem/ParticleSystemModules.d.ts +526 -526
  489. package/lib/engine-components/particlesystem/ParticleSystemModules.js +1930 -1930
  490. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.d.ts +25 -25
  491. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.js +87 -87
  492. package/lib/engine-components/particlesystem/api.d.ts +2 -2
  493. package/lib/engine-components/particlesystem/api.js +2 -2
  494. package/lib/engine-components/postprocessing/Effects/Antialiasing.d.ts +17 -17
  495. package/lib/engine-components/postprocessing/Effects/Antialiasing.js +50 -50
  496. package/lib/engine-components/postprocessing/Effects/BloomEffect.d.ts +46 -46
  497. package/lib/engine-components/postprocessing/Effects/BloomEffect.js +113 -113
  498. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.d.ts +11 -11
  499. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.js +39 -39
  500. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.d.ts +15 -15
  501. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.js +92 -92
  502. package/lib/engine-components/postprocessing/Effects/DepthOfField.d.ts +25 -25
  503. package/lib/engine-components/postprocessing/Effects/DepthOfField.js +104 -104
  504. package/lib/engine-components/postprocessing/Effects/EffectWrapper.d.ts +12 -12
  505. package/lib/engine-components/postprocessing/Effects/EffectWrapper.js +18 -18
  506. package/lib/engine-components/postprocessing/Effects/Pixelation.d.ts +11 -11
  507. package/lib/engine-components/postprocessing/Effects/Pixelation.js +32 -32
  508. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.d.ts +18 -18
  509. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.js +91 -91
  510. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.d.ts +70 -70
  511. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.js +175 -175
  512. package/lib/engine-components/postprocessing/Effects/Sharpening.d.ts +17 -17
  513. package/lib/engine-components/postprocessing/Effects/Sharpening.js +123 -123
  514. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.d.ts +17 -17
  515. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.js +70 -70
  516. package/lib/engine-components/postprocessing/Effects/Tonemapping.d.ts +26 -26
  517. package/lib/engine-components/postprocessing/Effects/Tonemapping.js +138 -138
  518. package/lib/engine-components/postprocessing/Effects/Vignette.d.ts +15 -15
  519. package/lib/engine-components/postprocessing/Effects/Vignette.js +60 -60
  520. package/lib/engine-components/postprocessing/PostProcessingEffect.d.ts +72 -72
  521. package/lib/engine-components/postprocessing/PostProcessingEffect.js +149 -149
  522. package/lib/engine-components/postprocessing/PostProcessingHandler.d.ts +25 -25
  523. package/lib/engine-components/postprocessing/PostProcessingHandler.js +350 -350
  524. package/lib/engine-components/postprocessing/Volume.d.ts +89 -89
  525. package/lib/engine-components/postprocessing/Volume.js +367 -367
  526. package/lib/engine-components/postprocessing/VolumeParameter.d.ts +26 -26
  527. package/lib/engine-components/postprocessing/VolumeParameter.js +136 -136
  528. package/lib/engine-components/postprocessing/VolumeProfile.d.ts +15 -15
  529. package/lib/engine-components/postprocessing/VolumeProfile.js +60 -60
  530. package/lib/engine-components/postprocessing/index.d.ts +5 -5
  531. package/lib/engine-components/postprocessing/index.js +5 -5
  532. package/lib/engine-components/postprocessing/utils.d.ts +11 -11
  533. package/lib/engine-components/postprocessing/utils.js +37 -37
  534. package/lib/engine-components/timeline/PlayableDirector.d.ts +163 -163
  535. package/lib/engine-components/timeline/PlayableDirector.js +686 -686
  536. package/lib/engine-components/timeline/SignalAsset.d.ts +24 -24
  537. package/lib/engine-components/timeline/SignalAsset.js +130 -130
  538. package/lib/engine-components/timeline/TimelineModels.d.ts +89 -89
  539. package/lib/engine-components/timeline/TimelineModels.js +22 -22
  540. package/lib/engine-components/timeline/TimelineTracks.d.ts +110 -110
  541. package/lib/engine-components/timeline/TimelineTracks.js +879 -879
  542. package/lib/engine-components/timeline/index.d.ts +4 -4
  543. package/lib/engine-components/timeline/index.js +3 -3
  544. package/lib/engine-components/ui/BaseUIComponent.d.ts +48 -48
  545. package/lib/engine-components/ui/BaseUIComponent.js +170 -170
  546. package/lib/engine-components/ui/Button.d.ts +64 -64
  547. package/lib/engine-components/ui/Button.js +315 -315
  548. package/lib/engine-components/ui/Canvas.d.ts +74 -74
  549. package/lib/engine-components/ui/Canvas.js +407 -407
  550. package/lib/engine-components/ui/CanvasGroup.d.ts +19 -19
  551. package/lib/engine-components/ui/CanvasGroup.js +58 -58
  552. package/lib/engine-components/ui/EventSystem.d.ts +125 -125
  553. package/lib/engine-components/ui/EventSystem.js +764 -764
  554. package/lib/engine-components/ui/Graphic.d.ts +55 -55
  555. package/lib/engine-components/ui/Graphic.js +255 -255
  556. package/lib/engine-components/ui/Image.d.ts +35 -35
  557. package/lib/engine-components/ui/Image.js +116 -116
  558. package/lib/engine-components/ui/InputField.d.ts +42 -42
  559. package/lib/engine-components/ui/InputField.js +268 -268
  560. package/lib/engine-components/ui/Interfaces.d.ts +38 -38
  561. package/lib/engine-components/ui/Interfaces.js +12 -12
  562. package/lib/engine-components/ui/Layout.d.ts +84 -84
  563. package/lib/engine-components/ui/Layout.js +330 -330
  564. package/lib/engine-components/ui/Outline.d.ts +7 -7
  565. package/lib/engine-components/ui/Outline.js +20 -20
  566. package/lib/engine-components/ui/PointerEvents.d.ts +115 -115
  567. package/lib/engine-components/ui/PointerEvents.js +145 -145
  568. package/lib/engine-components/ui/RaycastUtils.d.ts +11 -11
  569. package/lib/engine-components/ui/RaycastUtils.js +67 -67
  570. package/lib/engine-components/ui/Raycaster.d.ts +30 -30
  571. package/lib/engine-components/ui/Raycaster.js +95 -95
  572. package/lib/engine-components/ui/RectTransform.d.ts +61 -61
  573. package/lib/engine-components/ui/RectTransform.js +356 -356
  574. package/lib/engine-components/ui/SpatialHtml.d.ts +8 -8
  575. package/lib/engine-components/ui/SpatialHtml.js +79 -79
  576. package/lib/engine-components/ui/Symbols.d.ts +1 -1
  577. package/lib/engine-components/ui/Symbols.js +1 -1
  578. package/lib/engine-components/ui/Text.d.ts +78 -78
  579. package/lib/engine-components/ui/Text.js +539 -539
  580. package/lib/engine-components/ui/Utils.d.ts +24 -24
  581. package/lib/engine-components/ui/Utils.js +90 -90
  582. package/lib/engine-components/ui/index.d.ts +1 -1
  583. package/lib/engine-components/ui/index.js +1 -1
  584. package/lib/engine-components/utils/EnvironmentScene.d.ts +5 -5
  585. package/lib/engine-components/utils/EnvironmentScene.js +205 -205
  586. package/lib/engine-components/utils/LookAt.d.ts +31 -31
  587. package/lib/engine-components/utils/LookAt.js +82 -82
  588. package/lib/engine-components/utils/OpenURL.d.ts +42 -42
  589. package/lib/engine-components/utils/OpenURL.js +119 -119
  590. package/lib/engine-components/webxr/Avatar.d.ts +25 -25
  591. package/lib/engine-components/webxr/Avatar.js +255 -255
  592. package/lib/engine-components/webxr/TeleportTarget.d.ts +7 -7
  593. package/lib/engine-components/webxr/TeleportTarget.js +7 -7
  594. package/lib/engine-components/webxr/WebARCameraBackground.d.ts +30 -30
  595. package/lib/engine-components/webxr/WebARCameraBackground.js +155 -155
  596. package/lib/engine-components/webxr/WebARSessionRoot.d.ts +98 -98
  597. package/lib/engine-components/webxr/WebARSessionRoot.js +770 -770
  598. package/lib/engine-components/webxr/WebXR.d.ts +232 -232
  599. package/lib/engine-components/webxr/WebXR.js +561 -561
  600. package/lib/engine-components/webxr/WebXRAvatar.d.ts +27 -27
  601. package/lib/engine-components/webxr/WebXRAvatar.js +44 -44
  602. package/lib/engine-components/webxr/WebXRImageTracking.d.ts +86 -86
  603. package/lib/engine-components/webxr/WebXRImageTracking.js +470 -470
  604. package/lib/engine-components/webxr/WebXRPlaneTracking.d.ts +92 -92
  605. package/lib/engine-components/webxr/WebXRPlaneTracking.js +500 -500
  606. package/lib/engine-components/webxr/WebXRRig.d.ts +32 -32
  607. package/lib/engine-components/webxr/WebXRRig.js +72 -72
  608. package/lib/engine-components/webxr/XRFlag.d.ts +38 -38
  609. package/lib/engine-components/webxr/XRFlag.js +139 -139
  610. package/lib/engine-components/webxr/controllers/XRControllerFollow.d.ts +47 -47
  611. package/lib/engine-components/webxr/controllers/XRControllerFollow.js +120 -120
  612. package/lib/engine-components/webxr/controllers/XRControllerModel.d.ts +43 -43
  613. package/lib/engine-components/webxr/controllers/XRControllerModel.js +351 -351
  614. package/lib/engine-components/webxr/controllers/XRControllerMovement.d.ts +78 -78
  615. package/lib/engine-components/webxr/controllers/XRControllerMovement.js +506 -506
  616. package/lib/engine-components/webxr/index.d.ts +3 -3
  617. package/lib/engine-components/webxr/index.js +3 -3
  618. package/lib/engine-components/webxr/types.d.ts +3 -3
  619. package/lib/engine-components/webxr/types.js +1 -1
  620. package/lib/engine-components-experimental/Presentation.d.ts +6 -6
  621. package/lib/engine-components-experimental/Presentation.js +9 -9
  622. package/lib/engine-components-experimental/api.d.ts +4 -4
  623. package/lib/engine-components-experimental/api.js +4 -4
  624. package/lib/engine-components-experimental/networking/PlayerSync.d.ts +156 -156
  625. package/lib/engine-components-experimental/networking/PlayerSync.js +377 -377
  626. package/lib/engine-schemes/api.d.ts +12 -12
  627. package/lib/engine-schemes/api.js +12 -12
  628. package/lib/engine-schemes/schemes.d.ts +7 -7
  629. package/lib/engine-schemes/schemes.js +19 -19
  630. package/lib/engine-schemes/synced-camera-model.d.ts +25 -25
  631. package/lib/engine-schemes/synced-camera-model.js +67 -67
  632. package/lib/engine-schemes/synced-transform-model.d.ts +31 -31
  633. package/lib/engine-schemes/synced-transform-model.js +66 -66
  634. package/lib/engine-schemes/transform.d.ts +12 -12
  635. package/lib/engine-schemes/transform.js +39 -39
  636. package/lib/engine-schemes/vec2.d.ts +10 -10
  637. package/lib/engine-schemes/vec2.js +25 -25
  638. package/lib/engine-schemes/vec3.d.ts +11 -11
  639. package/lib/engine-schemes/vec3.js +29 -29
  640. package/lib/engine-schemes/vec4.d.ts +12 -12
  641. package/lib/engine-schemes/vec4.js +33 -33
  642. package/lib/engine-schemes/vr-user-state-buffer.d.ts +37 -37
  643. package/lib/engine-schemes/vr-user-state-buffer.js +110 -110
  644. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.d.ts +6 -6
  645. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.js +45 -45
  646. package/lib/needle-engine.d.ts +7 -7
  647. package/lib/needle-engine.js +64 -64
  648. package/package.json +1 -1
  649. package/plugins/common/buildinfo.js +64 -64
  650. package/plugins/common/cloud.js +1 -1
  651. package/plugins/common/config.cjs +31 -31
  652. package/plugins/common/config.js +35 -35
  653. package/plugins/common/files.js +31 -31
  654. package/plugins/common/generator.js +10 -10
  655. package/plugins/common/license.js +415 -365
  656. package/plugins/common/npm.js +15 -15
  657. package/plugins/common/timers.js +7 -7
  658. package/plugins/common/version.js +37 -37
  659. package/plugins/gltf-packer.mjs +1 -1
  660. package/plugins/next/alias.cjs +39 -39
  661. package/plugins/next/license.cjs +24 -18
  662. package/plugins/next/meshbvhworker.cjs +18 -18
  663. package/plugins/next/next.js +136 -128
  664. package/plugins/types/index.d.ts +2 -2
  665. package/plugins/types/license.d.ts +24 -24
  666. package/plugins/types/needleConfig.d.ts +27 -27
  667. package/plugins/types/userconfig.d.ts +113 -110
  668. package/plugins/types/webmanifest.d.ts +32 -32
  669. package/plugins/vite/alias.js +174 -174
  670. package/plugins/vite/asap.js +245 -245
  671. package/plugins/vite/build-pipeline.js +355 -355
  672. package/plugins/vite/build.js +19 -19
  673. package/plugins/vite/buildinfo.js +41 -41
  674. package/plugins/vite/config.js +106 -106
  675. package/plugins/vite/copyfiles.js +138 -138
  676. package/plugins/vite/defines.js +68 -66
  677. package/plugins/vite/dependencies.js +232 -223
  678. package/plugins/vite/dependency-watcher.js +231 -231
  679. package/plugins/vite/drop-client.js +76 -76
  680. package/plugins/vite/drop.js +87 -87
  681. package/plugins/vite/editor-connection.js +124 -124
  682. package/plugins/vite/facebook-instant-games.js +102 -102
  683. package/plugins/vite/gzip.js +5 -5
  684. package/plugins/vite/imports-logger.js +143 -143
  685. package/plugins/vite/index.js +139 -139
  686. package/plugins/vite/license.js +56 -55
  687. package/plugins/vite/meta.js +163 -163
  688. package/plugins/vite/npm.js +7 -7
  689. package/plugins/vite/peer.js +29 -29
  690. package/plugins/vite/poster-client.js +73 -73
  691. package/plugins/vite/poster.js +79 -79
  692. package/plugins/vite/pwa.js +604 -604
  693. package/plugins/vite/reload-client.js +15 -15
  694. package/plugins/vite/reload.js +363 -363
  695. package/plugins/vite/server.js +66 -66
  696. package/plugins/vite/transform-codegen.js +55 -55
  697. package/plugins/vite/transform.js +31 -31
  698. package/plugins/vite/vite-4.4-hack.js +31 -31
  699. package/src/asap/needle-asap.ts +111 -111
  700. package/src/asap/sessiongranted.ts +75 -75
  701. package/src/asap/utils.ts +4 -4
  702. package/src/engine/analytics/index.ts +10 -10
  703. package/src/engine/analytics/lcp.ts +35 -35
  704. package/src/engine/api.ts +81 -81
  705. package/src/engine/assets/index.ts +59 -59
  706. package/src/engine/assets/static.js +5 -5
  707. package/src/engine/codegen/register_types.ts +300 -300
  708. package/src/engine/debug/debug.ts +51 -51
  709. package/src/engine/debug/debug_console.ts +333 -333
  710. package/src/engine/debug/debug_overlay.ts +332 -332
  711. package/src/engine/debug/debug_spatial_console.ts +429 -429
  712. package/src/engine/debug/index.ts +1 -1
  713. package/src/engine/engine_addressables.ts +680 -680
  714. package/src/engine/engine_animation.ts +145 -145
  715. package/src/engine/engine_application.ts +113 -113
  716. package/src/engine/engine_assetdatabase.ts +387 -387
  717. package/src/engine/engine_audio.ts +24 -24
  718. package/src/engine/engine_camera.ts +39 -39
  719. package/src/engine/engine_components.ts +374 -374
  720. package/src/engine/engine_components_internal.ts +40 -40
  721. package/src/engine/engine_constants.ts +52 -52
  722. package/src/engine/engine_context.ts +1798 -1686
  723. package/src/engine/engine_context_registry.ts +129 -129
  724. package/src/engine/engine_coroutine.ts +54 -54
  725. package/src/engine/engine_create_objects.ts +398 -398
  726. package/src/engine/engine_default_parameters.ts +3 -3
  727. package/src/engine/engine_editor-sync.ts +28 -28
  728. package/src/engine/engine_element.ts +872 -872
  729. package/src/engine/engine_element_attributes.ts +85 -85
  730. package/src/engine/engine_element_extras.ts +16 -16
  731. package/src/engine/engine_element_loading.ts +381 -381
  732. package/src/engine/engine_element_overlay.ts +186 -186
  733. package/src/engine/engine_fileloader.js +9 -9
  734. package/src/engine/engine_gameobject.ts +691 -691
  735. package/src/engine/engine_generic_utils.js +13 -13
  736. package/src/engine/engine_gizmos.ts +577 -577
  737. package/src/engine/engine_gltf.ts +29 -29
  738. package/src/engine/engine_gltf_builtin_components.ts +403 -403
  739. package/src/engine/engine_hot_reload.ts +198 -198
  740. package/src/engine/engine_input.ts +1500 -1460
  741. package/src/engine/engine_input_utils.ts +23 -23
  742. package/src/engine/engine_instancing.ts +45 -45
  743. package/src/engine/engine_license.ts +378 -378
  744. package/src/engine/engine_lifecycle_api.ts +106 -106
  745. package/src/engine/engine_lifecycle_functions_internal.ts +193 -193
  746. package/src/engine/engine_lightdata.ts +117 -117
  747. package/src/engine/engine_loaders.ts +82 -82
  748. package/src/engine/engine_lods.ts +168 -168
  749. package/src/engine/engine_mainloop_utils.ts +472 -472
  750. package/src/engine/engine_math.ts +282 -282
  751. package/src/engine/engine_modules.ts +83 -83
  752. package/src/engine/engine_networking.ts +841 -841
  753. package/src/engine/engine_networking_auto.ts +352 -352
  754. package/src/engine/engine_networking_blob.ts +275 -275
  755. package/src/engine/engine_networking_files.ts +217 -217
  756. package/src/engine/engine_networking_files_default_components.ts +58 -58
  757. package/src/engine/engine_networking_instantiate.ts +419 -419
  758. package/src/engine/engine_networking_peer.ts +159 -159
  759. package/src/engine/engine_networking_streams.ts +713 -713
  760. package/src/engine/engine_networking_types.ts +24 -24
  761. package/src/engine/engine_networking_utils.ts +23 -23
  762. package/src/engine/engine_networking_websocket.ts +2 -2
  763. package/src/engine/engine_patcher.ts +199 -199
  764. package/src/engine/engine_physics.ts +783 -783
  765. package/src/engine/engine_physics.types.ts +46 -46
  766. package/src/engine/engine_physics_rapier.ts +1577 -1577
  767. package/src/engine/engine_playerview.ts +80 -80
  768. package/src/engine/engine_scenelighting.ts +294 -294
  769. package/src/engine/engine_scenetools.ts +365 -365
  770. package/src/engine/engine_serialization.ts +2 -2
  771. package/src/engine/engine_serialization_builtin_serializer.ts +473 -473
  772. package/src/engine/engine_serialization_core.ts +710 -710
  773. package/src/engine/engine_serialization_decorator.ts +80 -80
  774. package/src/engine/engine_setup.ts +1 -1
  775. package/src/engine/engine_shaders.ts +267 -267
  776. package/src/engine/engine_shims.ts +32 -32
  777. package/src/engine/engine_test_utils.ts +109 -109
  778. package/src/engine/engine_texture.ts +82 -82
  779. package/src/engine/engine_three_utils.ts +849 -849
  780. package/src/engine/engine_time.ts +94 -94
  781. package/src/engine/engine_time_utils.ts +237 -237
  782. package/src/engine/engine_tonemapping.ts +210 -210
  783. package/src/engine/engine_types.ts +714 -714
  784. package/src/engine/engine_typestore.ts +63 -63
  785. package/src/engine/engine_util_decorator.ts +136 -136
  786. package/src/engine/engine_utils.ts +972 -972
  787. package/src/engine/engine_utils_format.ts +212 -212
  788. package/src/engine/engine_utils_screenshot.ts +698 -698
  789. package/src/engine/engine_utils_screenshot.xr.ts +103 -103
  790. package/src/engine/export/gltf/Writers.ts +34 -34
  791. package/src/engine/export/gltf/index.ts +158 -158
  792. package/src/engine/export/index.ts +2 -2
  793. package/src/engine/export/state.ts +19 -19
  794. package/src/engine/export/utils.ts +9 -9
  795. package/src/engine/extensions/EXT_texture_exr.ts +50 -50
  796. package/src/engine/extensions/NEEDLE_animator_controller_model.ts +195 -195
  797. package/src/engine/extensions/NEEDLE_components.ts +268 -268
  798. package/src/engine/extensions/NEEDLE_gameobject_data.ts +81 -81
  799. package/src/engine/extensions/NEEDLE_lighting_settings.ts +185 -185
  800. package/src/engine/extensions/NEEDLE_lightmaps.ts +119 -119
  801. package/src/engine/extensions/NEEDLE_persistent_assets.ts +76 -76
  802. package/src/engine/extensions/NEEDLE_render_objects.ts +209 -209
  803. package/src/engine/extensions/NEEDLE_techniques_webgl.ts +640 -640
  804. package/src/engine/extensions/extension_resolver.ts +4 -4
  805. package/src/engine/extensions/extension_utils.ts +166 -166
  806. package/src/engine/extensions/extensions.ts +135 -135
  807. package/src/engine/extensions/index.ts +5 -5
  808. package/src/engine/extensions/usage_tracker.ts +100 -100
  809. package/src/engine/js-extensions/Camera.ts +37 -37
  810. package/src/engine/js-extensions/ExtensionUtils.ts +85 -85
  811. package/src/engine/js-extensions/Layers.ts +23 -23
  812. package/src/engine/js-extensions/Object3D.ts +296 -296
  813. package/src/engine/js-extensions/RGBAColor.ts +126 -125
  814. package/src/engine/js-extensions/Vector.ts +18 -18
  815. package/src/engine/js-extensions/index.ts +4 -4
  816. package/src/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +122 -122
  817. package/src/engine/shaders/shaderData.ts +67 -67
  818. package/src/engine/tests/test_utils.ts +63 -63
  819. package/src/engine/webcomponents/WebXRButtons.ts +260 -260
  820. package/src/engine/webcomponents/api.ts +6 -6
  821. package/src/engine/webcomponents/buttons.ts +262 -262
  822. package/src/engine/webcomponents/fonts.ts +41 -41
  823. package/src/engine/webcomponents/icons.ts +57 -57
  824. package/src/engine/webcomponents/index.ts +1 -1
  825. package/src/engine/webcomponents/logo-element.ts +78 -78
  826. package/src/engine/webcomponents/needle menu/needle-menu-spatial.ts +573 -573
  827. package/src/engine/webcomponents/needle menu/needle-menu.ts +1118 -1118
  828. package/src/engine/webcomponents/needle-button.ts +181 -181
  829. package/src/engine/xr/NeedleXRController.ts +1125 -1125
  830. package/src/engine/xr/NeedleXRSession.ts +1585 -1585
  831. package/src/engine/xr/NeedleXRSync.ts +220 -220
  832. package/src/engine/xr/SceneTransition.ts +78 -78
  833. package/src/engine/xr/TempXRContext.ts +216 -216
  834. package/src/engine/xr/XRRig.ts +9 -9
  835. package/src/engine/xr/api.ts +5 -5
  836. package/src/engine/xr/events.ts +102 -102
  837. package/src/engine/xr/internal.ts +34 -34
  838. package/src/engine/xr/usdz.ts +30 -30
  839. package/src/engine/xr/utils.ts +39 -39
  840. package/src/engine-components/AlignmentConstraint.ts +36 -36
  841. package/src/engine-components/Animation.ts +557 -557
  842. package/src/engine-components/AnimationCurve.ts +150 -150
  843. package/src/engine-components/AnimationUtils.ts +28 -28
  844. package/src/engine-components/AnimationUtilsAutoplay.ts +43 -43
  845. package/src/engine-components/Animator.ts +397 -397
  846. package/src/engine-components/AnimatorController.ts +1293 -1293
  847. package/src/engine-components/AudioListener.ts +92 -92
  848. package/src/engine-components/AudioSource.ts +644 -644
  849. package/src/engine-components/AvatarLoader.ts +263 -263
  850. package/src/engine-components/AxesHelper.ts +59 -59
  851. package/src/engine-components/BasicIKConstraint.ts +54 -54
  852. package/src/engine-components/BoxCollider.ts +1 -1
  853. package/src/engine-components/BoxHelperComponent.ts +114 -114
  854. package/src/engine-components/Camera.ts +719 -719
  855. package/src/engine-components/CameraUtils.ts +136 -136
  856. package/src/engine-components/CharacterController.ts +253 -253
  857. package/src/engine-components/Collider.ts +374 -374
  858. package/src/engine-components/Component.ts +1294 -1294
  859. package/src/engine-components/ContactShadows.ts +482 -482
  860. package/src/engine-components/DeleteBox.ts +62 -62
  861. package/src/engine-components/DeviceFlag.ts +46 -46
  862. package/src/engine-components/DragControls.ts +1623 -1623
  863. package/src/engine-components/DropListener.ts +698 -698
  864. package/src/engine-components/Duplicatable.ts +198 -198
  865. package/src/engine-components/EventList.ts +266 -266
  866. package/src/engine-components/EventTrigger.ts +74 -74
  867. package/src/engine-components/EventType.ts +22 -22
  868. package/src/engine-components/Fog.ts +60 -60
  869. package/src/engine-components/Gizmos.ts +56 -56
  870. package/src/engine-components/GridHelper.ts +48 -48
  871. package/src/engine-components/GroundProjection.ts +356 -356
  872. package/src/engine-components/Interactable.ts +14 -14
  873. package/src/engine-components/Joints.ts +52 -52
  874. package/src/engine-components/LODGroup.ts +153 -153
  875. package/src/engine-components/Light.ts +558 -558
  876. package/src/engine-components/LookAtConstraint.ts +25 -25
  877. package/src/engine-components/NeedleMenu.ts +84 -84
  878. package/src/engine-components/NestedGltf.ts +86 -86
  879. package/src/engine-components/Networking.ts +114 -114
  880. package/src/engine-components/OffsetConstraint.ts +60 -60
  881. package/src/engine-components/OrbitControls.ts +1069 -1069
  882. package/src/engine-components/PlayerColor.ts +103 -103
  883. package/src/engine-components/ReflectionProbe.ts +216 -216
  884. package/src/engine-components/Renderer.ts +900 -900
  885. package/src/engine-components/RendererInstancing.ts +855 -855
  886. package/src/engine-components/RendererLightmap.ts +198 -198
  887. package/src/engine-components/RigidBody.ts +526 -526
  888. package/src/engine-components/SceneSwitcher.ts +1030 -1030
  889. package/src/engine-components/ScreenCapture.ts +592 -592
  890. package/src/engine-components/ShadowCatcher.ts +172 -172
  891. package/src/engine-components/Skybox.ts +455 -455
  892. package/src/engine-components/SmoothFollow.ts +76 -76
  893. package/src/engine-components/SpatialTrigger.ts +229 -229
  894. package/src/engine-components/SpectatorCamera.ts +787 -787
  895. package/src/engine-components/SphereCollider.ts +1 -1
  896. package/src/engine-components/SpriteRenderer.ts +468 -468
  897. package/src/engine-components/SyncedCamera.ts +220 -220
  898. package/src/engine-components/SyncedRoom.ts +380 -380
  899. package/src/engine-components/SyncedTransform.ts +383 -383
  900. package/src/engine-components/TestRunner.ts +118 -118
  901. package/src/engine-components/TransformGizmo.ts +219 -219
  902. package/src/engine-components/VideoPlayer.ts +1025 -1025
  903. package/src/engine-components/Voip.ts +363 -363
  904. package/src/engine-components/api.ts +60 -60
  905. package/src/engine-components/avatar/AvatarBlink_Simple.ts +69 -69
  906. package/src/engine-components/avatar/AvatarEyeLook_Rotation.ts +63 -63
  907. package/src/engine-components/avatar/Avatar_Brain_LookAt.ts +139 -139
  908. package/src/engine-components/avatar/Avatar_MouthShapes.ts +83 -83
  909. package/src/engine-components/avatar/Avatar_MustacheShake.ts +31 -31
  910. package/src/engine-components/codegen/components.ts +217 -217
  911. package/src/engine-components/debug/LogStats.ts +21 -21
  912. package/src/engine-components/export/gltf/GltfExport.ts +265 -265
  913. package/src/engine-components/export/usdz/Extension.ts +24 -24
  914. package/src/engine-components/export/usdz/ThreeUSDZExporter.ts +2413 -2413
  915. package/src/engine-components/export/usdz/USDZExporter.ts +705 -705
  916. package/src/engine-components/export/usdz/extensions/Animation.ts +1204 -1204
  917. package/src/engine-components/export/usdz/extensions/DocumentExtension.ts +9 -9
  918. package/src/engine-components/export/usdz/extensions/USDZText.ts +240 -240
  919. package/src/engine-components/export/usdz/extensions/USDZUI.ts +189 -189
  920. package/src/engine-components/export/usdz/extensions/behavior/Actions.ts +99 -99
  921. package/src/engine-components/export/usdz/extensions/behavior/AudioExtension.ts +102 -102
  922. package/src/engine-components/export/usdz/extensions/behavior/Behaviour.ts +320 -320
  923. package/src/engine-components/export/usdz/extensions/behavior/BehaviourComponents.ts +1225 -1225
  924. package/src/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.ts +646 -646
  925. package/src/engine-components/export/usdz/extensions/behavior/PhysicsExtension.ts +132 -132
  926. package/src/engine-components/export/usdz/index.ts +2 -2
  927. package/src/engine-components/export/usdz/utils/animationutils.ts +191 -191
  928. package/src/engine-components/export/usdz/utils/quicklook.ts +50 -50
  929. package/src/engine-components/particlesystem/ParticleSystem.ts +1287 -1287
  930. package/src/engine-components/particlesystem/ParticleSystemModules.ts +1765 -1765
  931. package/src/engine-components/particlesystem/ParticleSystemSubEmitter.ts +111 -111
  932. package/src/engine-components/particlesystem/api.ts +1 -1
  933. package/src/engine-components/postprocessing/Effects/Antialiasing.ts +55 -55
  934. package/src/engine-components/postprocessing/Effects/BloomEffect.ts +116 -116
  935. package/src/engine-components/postprocessing/Effects/ChromaticAberration.ts +37 -37
  936. package/src/engine-components/postprocessing/Effects/ColorAdjustments.ts +95 -95
  937. package/src/engine-components/postprocessing/Effects/DepthOfField.ts +103 -103
  938. package/src/engine-components/postprocessing/Effects/EffectWrapper.ts +25 -25
  939. package/src/engine-components/postprocessing/Effects/Pixelation.ts +32 -32
  940. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.ts +90 -90
  941. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.ts +191 -191
  942. package/src/engine-components/postprocessing/Effects/Sharpening.ts +138 -138
  943. package/src/engine-components/postprocessing/Effects/TiltShiftEffect.ts +61 -61
  944. package/src/engine-components/postprocessing/Effects/Tonemapping.ts +155 -155
  945. package/src/engine-components/postprocessing/Effects/Vignette.ts +59 -59
  946. package/src/engine-components/postprocessing/PostProcessingEffect.ts +172 -172
  947. package/src/engine-components/postprocessing/PostProcessingHandler.ts +398 -398
  948. package/src/engine-components/postprocessing/Volume.ts +410 -410
  949. package/src/engine-components/postprocessing/VolumeParameter.ts +158 -158
  950. package/src/engine-components/postprocessing/VolumeProfile.ts +61 -61
  951. package/src/engine-components/postprocessing/index.ts +5 -5
  952. package/src/engine-components/postprocessing/utils.ts +52 -52
  953. package/src/engine-components/timeline/PlayableDirector.ts +722 -722
  954. package/src/engine-components/timeline/SignalAsset.ts +144 -144
  955. package/src/engine-components/timeline/TimelineModels.ts +92 -92
  956. package/src/engine-components/timeline/TimelineTracks.ts +967 -967
  957. package/src/engine-components/timeline/index.ts +3 -3
  958. package/src/engine-components/ui/BaseUIComponent.ts +203 -203
  959. package/src/engine-components/ui/Button.ts +307 -307
  960. package/src/engine-components/ui/Canvas.ts +419 -419
  961. package/src/engine-components/ui/CanvasGroup.ts +54 -54
  962. package/src/engine-components/ui/EventSystem.ts +853 -853
  963. package/src/engine-components/ui/Graphic.ts +275 -275
  964. package/src/engine-components/ui/Image.ts +112 -112
  965. package/src/engine-components/ui/InputField.ts +321 -321
  966. package/src/engine-components/ui/Interfaces.ts +57 -57
  967. package/src/engine-components/ui/Layout.ts +334 -334
  968. package/src/engine-components/ui/Outline.ts +13 -13
  969. package/src/engine-components/ui/PointerEvents.ts +206 -206
  970. package/src/engine-components/ui/RaycastUtils.ts +69 -69
  971. package/src/engine-components/ui/Raycaster.ts +102 -102
  972. package/src/engine-components/ui/RectTransform.ts +375 -375
  973. package/src/engine-components/ui/SpatialHtml.ts +79 -79
  974. package/src/engine-components/ui/Symbols.ts +1 -1
  975. package/src/engine-components/ui/Text.ts +578 -578
  976. package/src/engine-components/ui/Utils.ts +113 -113
  977. package/src/engine-components/utils/EnvironmentScene.ts +245 -245
  978. package/src/engine-components/utils/LookAt.ts +88 -88
  979. package/src/engine-components/utils/OpenURL.ts +114 -114
  980. package/src/engine-components/webxr/Avatar.ts +265 -265
  981. package/src/engine-components/webxr/TeleportTarget.ts +9 -9
  982. package/src/engine-components/webxr/WebARCameraBackground.ts +175 -175
  983. package/src/engine-components/webxr/WebARSessionRoot.ts +880 -880
  984. package/src/engine-components/webxr/WebXR.ts +585 -585
  985. package/src/engine-components/webxr/WebXRAvatar.ts +66 -66
  986. package/src/engine-components/webxr/WebXRImageTracking.ts +518 -518
  987. package/src/engine-components/webxr/WebXRPlaneTracking.ts +570 -570
  988. package/src/engine-components/webxr/WebXRRig.ts +77 -77
  989. package/src/engine-components/webxr/XRFlag.ts +147 -147
  990. package/src/engine-components/webxr/controllers/XRControllerFollow.ts +118 -118
  991. package/src/engine-components/webxr/controllers/XRControllerModel.ts +374 -374
  992. package/src/engine-components/webxr/controllers/XRControllerMovement.ts +550 -550
  993. package/src/engine-components/webxr/index.ts +2 -2
  994. package/src/engine-components/webxr/types.ts +3 -3
  995. package/src/engine-components-experimental/Presentation.ts +12 -12
  996. package/src/engine-components-experimental/api.ts +4 -4
  997. package/src/engine-components-experimental/networking/PlayerSync.ts +401 -401
  998. package/src/engine-schemes/COMPILE_SCHEMES.bat +3 -3
  999. package/src/engine-schemes/COMPILE_TS.bat +11 -11
  1000. package/src/engine-schemes/README.md +1 -1
  1001. package/src/engine-schemes/api.ts +12 -12
  1002. package/src/engine-schemes/schemes.ts +28 -28
  1003. package/src/engine-schemes/synced-camera-model.ts +92 -92
  1004. package/src/engine-schemes/synced-transform-model.ts +90 -90
  1005. package/src/engine-schemes/syncedCamera.fbs +10 -10
  1006. package/src/engine-schemes/transform.ts +50 -50
  1007. package/src/engine-schemes/transforms.fbs +25 -25
  1008. package/src/engine-schemes/vec.fbs +19 -19
  1009. package/src/engine-schemes/vec2.ts +33 -33
  1010. package/src/engine-schemes/vec3.ts +38 -38
  1011. package/src/engine-schemes/vec4.ts +43 -43
  1012. package/src/engine-schemes/vr-user-state-buffer.ts +145 -145
  1013. package/src/engine-schemes/vrUserStateBuffer.fbs +17 -17
  1014. package/src/include/draco/draco_decoder.js +34 -34
  1015. package/src/include/ktx2/basis_transcoder.js +21 -21
  1016. package/src/include/needle/arial-msdf.json +1471 -1471
  1017. package/src/include/three/DragControls.js +231 -231
  1018. package/src/include/three/EXT_mesh_gpu_instancing_exporter.js +66 -66
  1019. package/src/needle-engine.ts +70 -70
  1020. package/lib/engine/engine.d.ts +0 -4
  1021. package/lib/engine/engine.js +0 -12
  1022. package/lib/engine/engine.js.map +0 -1
  1023. package/lib/engine/engine_web_api.d.ts +0 -12
  1024. package/lib/engine/engine_web_api.js +0 -113
  1025. package/lib/engine/engine_web_api.js.map +0 -1
  1026. package/lib/engine-components/FlyControls.d.ts +0 -10
  1027. package/lib/engine-components/FlyControls.js +0 -29
  1028. package/lib/engine-components/FlyControls.js.map +0 -1
  1029. package/src/engine-schemes/dist/api.js +0 -17
  1030. package/src/engine-schemes/dist/api.js.meta +0 -7
  1031. package/src/engine-schemes/dist/schemes.js +0 -25
  1032. package/src/engine-schemes/dist/schemes.js.meta +0 -7
  1033. package/src/engine-schemes/dist/synced-camera-model.js +0 -74
  1034. package/src/engine-schemes/dist/synced-camera-model.js.meta +0 -7
  1035. package/src/engine-schemes/dist/synced-transform-model.js +0 -73
  1036. package/src/engine-schemes/dist/synced-transform-model.js.meta +0 -7
  1037. package/src/engine-schemes/dist/transform.js +0 -46
  1038. package/src/engine-schemes/dist/transform.js.meta +0 -7
  1039. package/src/engine-schemes/dist/vec2.js +0 -32
  1040. package/src/engine-schemes/dist/vec2.js.meta +0 -7
  1041. package/src/engine-schemes/dist/vec3.js +0 -36
  1042. package/src/engine-schemes/dist/vec3.js.meta +0 -7
  1043. package/src/engine-schemes/dist/vec4.js +0 -40
  1044. package/src/engine-schemes/dist/vec4.js.meta +0 -7
  1045. package/src/engine-schemes/dist/vr-user-state-buffer.js +0 -110
  1046. package/src/engine-schemes/dist/vr-user-state-buffer.js.meta +0 -7
@@ -1,1030 +1,1030 @@
1
- import { EquirectangularReflectionMapping, Object3D, Scene, Texture } from "three";
2
-
3
- import { AssetReference } from "../engine/engine_addressables.js";
4
- import { registerObservableAttribute } from "../engine/engine_element_extras.js";
5
- import { destroy } from "../engine/engine_gameobject.js";
6
- import { InputEvents } from "../engine/engine_input.js";
7
- import { isLocalNetwork } from "../engine/engine_networking_utils.js";
8
- import { serializable } from "../engine/engine_serialization.js";
9
- import { getParam, setParamWithoutReload } from "../engine/engine_utils.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 { registerObservableAttribute } from "../engine/engine_element_extras.js";
5
+ import { destroy } from "../engine/engine_gameobject.js";
6
+ import { InputEvents } from "../engine/engine_input.js";
7
+ import { isLocalNetwork } from "../engine/engine_networking_utils.js";
8
+ import { serializable } from "../engine/engine_serialization.js";
9
+ import { getParam, setParamWithoutReload } from "../engine/engine_utils.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
+ }