@needle-tools/engine 4.4.0-beta → 4.4.0-beta.2

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 (1056) hide show
  1. package/CHANGELOG.md +3607 -3604
  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 +2256 -2254
  6. package/dist/needle-engine.bundle.light.js +2256 -2254
  7. package/dist/needle-engine.bundle.light.min.js +118 -118
  8. package/dist/needle-engine.bundle.light.umd.cjs +116 -116
  9. package/dist/needle-engine.bundle.min.js +118 -118
  10. package/dist/needle-engine.bundle.umd.cjs +116 -116
  11. package/dist/needle-engine.d.ts +130 -138
  12. package/dist/needle-engine.js +468 -467
  13. package/dist/needle-engine.light.d.ts +130 -138
  14. package/dist/needle-engine.light.js +468 -467
  15. package/dist/needle-engine.light.min.js +1 -1
  16. package/dist/needle-engine.light.umd.cjs +1 -1
  17. package/dist/needle-engine.min.js +1 -1
  18. package/dist/needle-engine.umd.cjs +1 -1
  19. package/dist/postprocessing.js +1673 -1527
  20. package/dist/postprocessing.light.js +1673 -1527
  21. package/dist/postprocessing.light.min.js +80 -66
  22. package/dist/postprocessing.light.umd.cjs +83 -69
  23. package/dist/postprocessing.min.js +80 -66
  24. package/dist/postprocessing.umd.cjs +83 -69
  25. package/dist/vendor.js +1 -1
  26. package/dist/vendor.light.js +1 -1
  27. package/lib/asap/needle-asap.d.ts +1 -1
  28. package/lib/asap/needle-asap.js +95 -95
  29. package/lib/asap/sessiongranted.d.ts +3 -3
  30. package/lib/asap/sessiongranted.js +65 -65
  31. package/lib/asap/utils.d.ts +1 -1
  32. package/lib/asap/utils.js +3 -3
  33. package/lib/engine/analytics/index.d.ts +6 -6
  34. package/lib/engine/analytics/index.js +12 -12
  35. package/lib/engine/analytics/lcp.d.ts +3 -3
  36. package/lib/engine/analytics/lcp.js +34 -34
  37. package/lib/engine/api.d.ts +81 -81
  38. package/lib/engine/api.js +80 -80
  39. package/lib/engine/assets/index.d.ts +11 -11
  40. package/lib/engine/assets/index.js +47 -47
  41. package/lib/engine/assets/static.d.ts +1 -1
  42. package/lib/engine/assets/static.js +4 -4
  43. package/lib/engine/codegen/register_types.d.ts +1 -1
  44. package/lib/engine/codegen/register_types.js +300 -298
  45. package/lib/engine/codegen/register_types.js.map +1 -1
  46. package/lib/engine/debug/debug.d.ts +15 -15
  47. package/lib/engine/debug/debug.js +44 -44
  48. package/lib/engine/debug/debug_console.d.ts +2 -2
  49. package/lib/engine/debug/debug_console.js +307 -307
  50. package/lib/engine/debug/debug_overlay.d.ts +22 -22
  51. package/lib/engine/debug/debug_overlay.js +316 -316
  52. package/lib/engine/debug/debug_spatial_console.d.ts +2 -2
  53. package/lib/engine/debug/debug_spatial_console.js +390 -390
  54. package/lib/engine/debug/index.d.ts +2 -2
  55. package/lib/engine/debug/index.js +2 -2
  56. package/lib/engine/engine_addressables.d.ts +166 -166
  57. package/lib/engine/engine_addressables.js +608 -608
  58. package/lib/engine/engine_animation.d.ts +43 -43
  59. package/lib/engine/engine_animation.js +133 -133
  60. package/lib/engine/engine_application.d.ts +40 -40
  61. package/lib/engine/engine_application.js +104 -104
  62. package/lib/engine/engine_assetdatabase.d.ts +25 -25
  63. package/lib/engine/engine_assetdatabase.js +344 -344
  64. package/lib/engine/engine_audio.d.ts +4 -4
  65. package/lib/engine/engine_audio.js +23 -23
  66. package/lib/engine/engine_camera.d.ts +13 -13
  67. package/lib/engine/engine_camera.js +30 -30
  68. package/lib/engine/engine_components.d.ts +110 -110
  69. package/lib/engine/engine_components.js +380 -380
  70. package/lib/engine/engine_components_internal.d.ts +9 -9
  71. package/lib/engine/engine_components_internal.js +36 -36
  72. package/lib/engine/engine_constants.d.ts +10 -10
  73. package/lib/engine/engine_constants.js +41 -41
  74. package/lib/engine/engine_context.d.ts +345 -345
  75. package/lib/engine/engine_context.js +1515 -1515
  76. package/lib/engine/engine_context_registry.d.ts +71 -71
  77. package/lib/engine/engine_context_registry.js +117 -117
  78. package/lib/engine/engine_coroutine.d.ts +35 -35
  79. package/lib/engine/engine_coroutine.js +52 -52
  80. package/lib/engine/engine_create_objects.d.ts +118 -118
  81. package/lib/engine/engine_create_objects.js +308 -308
  82. package/lib/engine/engine_default_parameters.d.ts +2 -2
  83. package/lib/engine/engine_default_parameters.js +3 -3
  84. package/lib/engine/engine_editor-sync.d.ts +21 -21
  85. package/lib/engine/engine_editor-sync.js +4 -4
  86. package/lib/engine/engine_element.d.ts +113 -113
  87. package/lib/engine/engine_element.js +830 -830
  88. package/lib/engine/engine_element_attributes.d.ts +72 -72
  89. package/lib/engine/engine_element_attributes.js +1 -1
  90. package/lib/engine/engine_element_extras.d.ts +6 -6
  91. package/lib/engine/engine_element_extras.js +13 -13
  92. package/lib/engine/engine_element_loading.d.ts +44 -44
  93. package/lib/engine/engine_element_loading.js +349 -349
  94. package/lib/engine/engine_element_overlay.d.ts +21 -21
  95. package/lib/engine/engine_element_overlay.js +166 -166
  96. package/lib/engine/engine_fileloader.d.ts +2 -2
  97. package/lib/engine/engine_fileloader.js +8 -8
  98. package/lib/engine/engine_gameobject.d.ts +68 -68
  99. package/lib/engine/engine_gameobject.js +591 -591
  100. package/lib/engine/engine_generic_utils.d.ts +1 -1
  101. package/lib/engine/engine_generic_utils.js +13 -13
  102. package/lib/engine/engine_gizmos.d.ts +149 -149
  103. package/lib/engine/engine_gizmos.js +530 -530
  104. package/lib/engine/engine_gltf.d.ts +12 -12
  105. package/lib/engine/engine_gltf.js +15 -15
  106. package/lib/engine/engine_gltf_builtin_components.d.ts +7 -7
  107. package/lib/engine/engine_gltf_builtin_components.js +341 -341
  108. package/lib/engine/engine_hot_reload.d.ts +7 -7
  109. package/lib/engine/engine_hot_reload.js +184 -184
  110. package/lib/engine/engine_input.d.ts +352 -352
  111. package/lib/engine/engine_input.js +1265 -1265
  112. package/lib/engine/engine_input_utils.d.ts +2 -2
  113. package/lib/engine/engine_input_utils.js +22 -22
  114. package/lib/engine/engine_instancing.d.ts +19 -19
  115. package/lib/engine/engine_instancing.js +39 -39
  116. package/lib/engine/engine_license.d.ts +9 -9
  117. package/lib/engine/engine_license.js +320 -320
  118. package/lib/engine/engine_lifecycle_api.d.ts +76 -76
  119. package/lib/engine/engine_lifecycle_api.js +99 -99
  120. package/lib/engine/engine_lifecycle_functions_internal.d.ts +32 -32
  121. package/lib/engine/engine_lifecycle_functions_internal.js +146 -146
  122. package/lib/engine/engine_lightdata.d.ts +23 -23
  123. package/lib/engine/engine_lightdata.js +91 -91
  124. package/lib/engine/engine_loaders.d.ts +13 -13
  125. package/lib/engine/engine_loaders.js +62 -62
  126. package/lib/engine/engine_lods.d.ts +31 -31
  127. package/lib/engine/engine_lods.js +146 -146
  128. package/lib/engine/engine_mainloop_utils.d.ts +32 -32
  129. package/lib/engine/engine_mainloop_utils.js +466 -466
  130. package/lib/engine/engine_math.d.ts +114 -114
  131. package/lib/engine/engine_math.js +247 -247
  132. package/lib/engine/engine_modules.d.ts +36 -36
  133. package/lib/engine/engine_modules.js +85 -85
  134. package/lib/engine/engine_networking.d.ts +252 -252
  135. package/lib/engine/engine_networking.js +743 -743
  136. package/lib/engine/engine_networking_auto.d.ts +24 -24
  137. package/lib/engine/engine_networking_auto.js +310 -310
  138. package/lib/engine/engine_networking_blob.d.ts +48 -48
  139. package/lib/engine/engine_networking_blob.js +212 -212
  140. package/lib/engine/engine_networking_files.d.ts +35 -35
  141. package/lib/engine/engine_networking_files.js +172 -172
  142. package/lib/engine/engine_networking_files_default_components.d.ts +6 -6
  143. package/lib/engine/engine_networking_files_default_components.js +42 -42
  144. package/lib/engine/engine_networking_instantiate.d.ts +100 -100
  145. package/lib/engine/engine_networking_instantiate.js +345 -345
  146. package/lib/engine/engine_networking_peer.d.ts +15 -15
  147. package/lib/engine/engine_networking_peer.js +132 -132
  148. package/lib/engine/engine_networking_streams.d.ts +123 -123
  149. package/lib/engine/engine_networking_streams.js +645 -645
  150. package/lib/engine/engine_networking_types.d.ts +22 -22
  151. package/lib/engine/engine_networking_types.js +7 -7
  152. package/lib/engine/engine_networking_utils.d.ts +2 -2
  153. package/lib/engine/engine_networking_utils.js +20 -20
  154. package/lib/engine/engine_networking_websocket.d.ts +1 -1
  155. package/lib/engine/engine_networking_websocket.js +2 -2
  156. package/lib/engine/engine_patcher.d.ts +10 -10
  157. package/lib/engine/engine_patcher.js +142 -142
  158. package/lib/engine/engine_physics.d.ts +152 -152
  159. package/lib/engine/engine_physics.js +645 -645
  160. package/lib/engine/engine_physics.types.d.ts +40 -40
  161. package/lib/engine/engine_physics.types.js +33 -33
  162. package/lib/engine/engine_physics_rapier.d.ts +147 -147
  163. package/lib/engine/engine_physics_rapier.js +1432 -1432
  164. package/lib/engine/engine_playerview.d.ts +26 -26
  165. package/lib/engine/engine_playerview.js +64 -64
  166. package/lib/engine/engine_scenelighting.d.ts +71 -71
  167. package/lib/engine/engine_scenelighting.js +226 -226
  168. package/lib/engine/engine_scenetools.d.ts +50 -50
  169. package/lib/engine/engine_scenetools.js +321 -321
  170. package/lib/engine/engine_serialization.d.ts +3 -3
  171. package/lib/engine/engine_serialization.js +3 -3
  172. package/lib/engine/engine_serialization_builtin_serializer.d.ts +72 -72
  173. package/lib/engine/engine_serialization_builtin_serializer.js +403 -403
  174. package/lib/engine/engine_serialization_core.d.ts +85 -85
  175. package/lib/engine/engine_serialization_core.js +602 -602
  176. package/lib/engine/engine_serialization_decorator.d.ts +23 -23
  177. package/lib/engine/engine_serialization_decorator.js +66 -66
  178. package/lib/engine/engine_setup.d.ts +1 -1
  179. package/lib/engine/engine_setup.js +2 -2
  180. package/lib/engine/engine_shaders.d.ts +53 -53
  181. package/lib/engine/engine_shaders.js +252 -252
  182. package/lib/engine/engine_shims.d.ts +4 -4
  183. package/lib/engine/engine_shims.js +24 -24
  184. package/lib/engine/engine_test_utils.d.ts +39 -39
  185. package/lib/engine/engine_test_utils.js +83 -83
  186. package/lib/engine/engine_texture.d.ts +28 -28
  187. package/lib/engine/engine_texture.js +64 -64
  188. package/lib/engine/engine_three_utils.d.ts +201 -201
  189. package/lib/engine/engine_three_utils.js +731 -731
  190. package/lib/engine/engine_time.d.ts +51 -51
  191. package/lib/engine/engine_time.js +82 -82
  192. package/lib/engine/engine_time_utils.d.ts +88 -88
  193. package/lib/engine/engine_time_utils.js +215 -215
  194. package/lib/engine/engine_tonemapping.d.ts +2 -2
  195. package/lib/engine/engine_tonemapping.js +194 -194
  196. package/lib/engine/engine_types.d.ts +572 -572
  197. package/lib/engine/engine_types.js +88 -88
  198. package/lib/engine/engine_typestore.d.ts +28 -28
  199. package/lib/engine/engine_typestore.js +55 -55
  200. package/lib/engine/engine_util_decorator.d.ts +13 -13
  201. package/lib/engine/engine_util_decorator.js +116 -116
  202. package/lib/engine/engine_utils.d.ts +266 -266
  203. package/lib/engine/engine_utils.js +878 -878
  204. package/lib/engine/engine_utils_format.d.ts +21 -21
  205. package/lib/engine/engine_utils_format.js +193 -193
  206. package/lib/engine/engine_utils_screenshot.d.ts +159 -159
  207. package/lib/engine/engine_utils_screenshot.js +513 -513
  208. package/lib/engine/engine_utils_screenshot.xr.d.ts +5 -5
  209. package/lib/engine/engine_utils_screenshot.xr.js +90 -90
  210. package/lib/engine/engine_xr.d.ts +1 -1
  211. package/lib/engine/engine_xr.js +1 -1
  212. package/lib/engine/export/gltf/Writers.d.ts +19 -19
  213. package/lib/engine/export/gltf/Writers.js +24 -24
  214. package/lib/engine/export/gltf/index.d.ts +11 -11
  215. package/lib/engine/export/gltf/index.js +123 -123
  216. package/lib/engine/export/index.d.ts +2 -2
  217. package/lib/engine/export/index.js +2 -2
  218. package/lib/engine/export/state.d.ts +7 -7
  219. package/lib/engine/export/state.js +17 -17
  220. package/lib/engine/export/utils.d.ts +2 -2
  221. package/lib/engine/export/utils.js +7 -7
  222. package/lib/engine/extensions/EXT_texture_exr.d.ts +8 -8
  223. package/lib/engine/extensions/EXT_texture_exr.js +32 -32
  224. package/lib/engine/extensions/NEEDLE_animator_controller_model.d.ts +122 -122
  225. package/lib/engine/extensions/NEEDLE_animator_controller_model.js +95 -95
  226. package/lib/engine/extensions/NEEDLE_components.d.ts +35 -35
  227. package/lib/engine/extensions/NEEDLE_components.js +220 -220
  228. package/lib/engine/extensions/NEEDLE_gameobject_data.d.ts +10 -10
  229. package/lib/engine/extensions/NEEDLE_gameobject_data.js +57 -57
  230. package/lib/engine/extensions/NEEDLE_lighting_settings.d.ts +37 -37
  231. package/lib/engine/extensions/NEEDLE_lighting_settings.js +157 -157
  232. package/lib/engine/extensions/NEEDLE_lightmaps.d.ts +18 -18
  233. package/lib/engine/extensions/NEEDLE_lightmaps.js +99 -99
  234. package/lib/engine/extensions/NEEDLE_persistent_assets.d.ts +11 -11
  235. package/lib/engine/extensions/NEEDLE_persistent_assets.js +63 -63
  236. package/lib/engine/extensions/NEEDLE_progressive.d.ts +1 -1
  237. package/lib/engine/extensions/NEEDLE_progressive.js +1 -1
  238. package/lib/engine/extensions/NEEDLE_render_objects.d.ts +13 -13
  239. package/lib/engine/extensions/NEEDLE_render_objects.js +159 -159
  240. package/lib/engine/extensions/NEEDLE_techniques_webgl.d.ts +38 -38
  241. package/lib/engine/extensions/NEEDLE_techniques_webgl.js +564 -564
  242. package/lib/engine/extensions/extension_resolver.d.ts +4 -4
  243. package/lib/engine/extensions/extension_resolver.js +1 -1
  244. package/lib/engine/extensions/extension_utils.d.ts +12 -12
  245. package/lib/engine/extensions/extension_utils.js +152 -152
  246. package/lib/engine/extensions/extensions.d.ts +31 -31
  247. package/lib/engine/extensions/extensions.js +103 -103
  248. package/lib/engine/extensions/index.d.ts +6 -6
  249. package/lib/engine/extensions/index.js +6 -6
  250. package/lib/engine/extensions/usage_tracker.d.ts +13 -13
  251. package/lib/engine/extensions/usage_tracker.js +65 -65
  252. package/lib/engine/js-extensions/Camera.d.ts +1 -1
  253. package/lib/engine/js-extensions/Camera.js +39 -39
  254. package/lib/engine/js-extensions/ExtensionUtils.d.ts +9 -9
  255. package/lib/engine/js-extensions/ExtensionUtils.js +67 -67
  256. package/lib/engine/js-extensions/Layers.d.ts +6 -6
  257. package/lib/engine/js-extensions/Layers.js +22 -22
  258. package/lib/engine/js-extensions/Object3D.d.ts +120 -120
  259. package/lib/engine/js-extensions/Object3D.js +136 -136
  260. package/lib/engine/js-extensions/RGBAColor.d.ts +22 -22
  261. package/lib/engine/js-extensions/RGBAColor.js +62 -62
  262. package/lib/engine/js-extensions/Vector.d.ts +3 -3
  263. package/lib/engine/js-extensions/Vector.js +13 -13
  264. package/lib/engine/js-extensions/index.d.ts +5 -5
  265. package/lib/engine/js-extensions/index.js +5 -5
  266. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.d.ts +4 -4
  267. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +75 -75
  268. package/lib/engine/shaders/shaderData.d.ts +55 -55
  269. package/lib/engine/shaders/shaderData.js +58 -58
  270. package/lib/engine/tests/test_utils.d.ts +2 -2
  271. package/lib/engine/tests/test_utils.js +53 -53
  272. package/lib/engine/webcomponents/WebXRButtons.d.ts +56 -56
  273. package/lib/engine/webcomponents/WebXRButtons.js +230 -230
  274. package/lib/engine/webcomponents/api.d.ts +5 -5
  275. package/lib/engine/webcomponents/api.js +4 -4
  276. package/lib/engine/webcomponents/buttons.d.ts +39 -39
  277. package/lib/engine/webcomponents/buttons.js +237 -237
  278. package/lib/engine/webcomponents/fonts.d.ts +9 -9
  279. package/lib/engine/webcomponents/fonts.js +32 -32
  280. package/lib/engine/webcomponents/icons.d.ts +9 -9
  281. package/lib/engine/webcomponents/icons.js +52 -52
  282. package/lib/engine/webcomponents/index.d.ts +1 -1
  283. package/lib/engine/webcomponents/index.js +1 -1
  284. package/lib/engine/webcomponents/logo-element.d.ts +10 -10
  285. package/lib/engine/webcomponents/logo-element.js +67 -67
  286. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.d.ts +37 -37
  287. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.js +513 -513
  288. package/lib/engine/webcomponents/needle menu/needle-menu.d.ts +151 -151
  289. package/lib/engine/webcomponents/needle menu/needle-menu.js +1018 -1018
  290. package/lib/engine/webcomponents/needle-button.d.ts +34 -34
  291. package/lib/engine/webcomponents/needle-button.js +161 -161
  292. package/lib/engine/xr/NeedleXRController.d.ts +313 -313
  293. package/lib/engine/xr/NeedleXRController.js +1008 -1008
  294. package/lib/engine/xr/NeedleXRSession.d.ts +339 -339
  295. package/lib/engine/xr/NeedleXRSession.js +1427 -1427
  296. package/lib/engine/xr/NeedleXRSync.d.ts +22 -22
  297. package/lib/engine/xr/NeedleXRSync.js +188 -188
  298. package/lib/engine/xr/SceneTransition.d.ts +18 -18
  299. package/lib/engine/xr/SceneTransition.js +69 -69
  300. package/lib/engine/xr/TempXRContext.d.ts +34 -34
  301. package/lib/engine/xr/TempXRContext.js +187 -187
  302. package/lib/engine/xr/XRRig.d.ts +7 -7
  303. package/lib/engine/xr/XRRig.js +1 -1
  304. package/lib/engine/xr/api.d.ts +6 -6
  305. package/lib/engine/xr/api.js +6 -6
  306. package/lib/engine/xr/events.d.ts +66 -66
  307. package/lib/engine/xr/events.js +93 -93
  308. package/lib/engine/xr/internal.d.ts +12 -12
  309. package/lib/engine/xr/internal.js +25 -25
  310. package/lib/engine/xr/usdz.d.ts +12 -12
  311. package/lib/engine/xr/usdz.js +29 -29
  312. package/lib/engine/xr/utils.d.ts +11 -11
  313. package/lib/engine/xr/utils.js +34 -34
  314. package/lib/engine-components/AlignmentConstraint.d.ts +10 -10
  315. package/lib/engine-components/AlignmentConstraint.js +39 -39
  316. package/lib/engine-components/Animation.d.ts +156 -156
  317. package/lib/engine-components/Animation.js +508 -508
  318. package/lib/engine-components/AnimationCurve.d.ts +40 -40
  319. package/lib/engine-components/AnimationCurve.js +159 -159
  320. package/lib/engine-components/AnimationUtils.d.ts +8 -8
  321. package/lib/engine-components/AnimationUtils.js +27 -27
  322. package/lib/engine-components/AnimationUtilsAutoplay.d.ts +1 -1
  323. package/lib/engine-components/AnimationUtilsAutoplay.js +39 -39
  324. package/lib/engine-components/Animator.d.ts +217 -217
  325. package/lib/engine-components/Animator.js +354 -354
  326. package/lib/engine-components/AnimatorController.d.ts +227 -227
  327. package/lib/engine-components/AnimatorController.js +1152 -1152
  328. package/lib/engine-components/AudioListener.d.ts +33 -33
  329. package/lib/engine-components/AudioListener.js +86 -86
  330. package/lib/engine-components/AudioSource.d.ts +217 -217
  331. package/lib/engine-components/AudioSource.js +627 -627
  332. package/lib/engine-components/AvatarLoader.d.ts +80 -80
  333. package/lib/engine-components/AvatarLoader.js +231 -231
  334. package/lib/engine-components/AxesHelper.d.ts +32 -32
  335. package/lib/engine-components/AxesHelper.js +67 -67
  336. package/lib/engine-components/BasicIKConstraint.d.ts +9 -9
  337. package/lib/engine-components/BasicIKConstraint.js +43 -43
  338. package/lib/engine-components/BoxCollider.d.ts +2 -2
  339. package/lib/engine-components/BoxCollider.js +2 -2
  340. package/lib/engine-components/BoxHelperComponent.d.ts +47 -47
  341. package/lib/engine-components/BoxHelperComponent.js +102 -102
  342. package/lib/engine-components/Camera.d.ts +231 -231
  343. package/lib/engine-components/Camera.js +694 -694
  344. package/lib/engine-components/CameraUtils.d.ts +1 -1
  345. package/lib/engine-components/CameraUtils.js +127 -127
  346. package/lib/engine-components/CameraUtils.js.map +1 -1
  347. package/lib/engine-components/CharacterController.d.ts +55 -55
  348. package/lib/engine-components/CharacterController.js +236 -236
  349. package/lib/engine-components/Collider.d.ts +188 -188
  350. package/lib/engine-components/Collider.js +369 -369
  351. package/lib/engine-components/Component.d.ts +792 -792
  352. package/lib/engine-components/Component.js +915 -915
  353. package/lib/engine-components/ContactShadows.d.ts +82 -82
  354. package/lib/engine-components/ContactShadows.js +430 -430
  355. package/lib/engine-components/DeleteBox.d.ts +19 -19
  356. package/lib/engine-components/DeleteBox.js +58 -58
  357. package/lib/engine-components/DeviceFlag.d.ts +16 -16
  358. package/lib/engine-components/DeviceFlag.js +47 -47
  359. package/lib/engine-components/DragControls.d.ts +170 -170
  360. package/lib/engine-components/DragControls.js +1421 -1421
  361. package/lib/engine-components/DropListener.d.ts +215 -215
  362. package/lib/engine-components/DropListener.js +630 -630
  363. package/lib/engine-components/Duplicatable.d.ts +35 -35
  364. package/lib/engine-components/Duplicatable.js +202 -202
  365. package/lib/engine-components/EventList.d.ts +54 -54
  366. package/lib/engine-components/EventList.js +232 -232
  367. package/lib/engine-components/EventTrigger.d.ts +33 -33
  368. package/lib/engine-components/EventTrigger.js +75 -75
  369. package/lib/engine-components/EventType.d.ts +22 -22
  370. package/lib/engine-components/EventType.js +23 -23
  371. package/lib/engine-components/Fog.d.ts +22 -22
  372. package/lib/engine-components/Fog.js +61 -61
  373. package/lib/engine-components/Gizmos.d.ts +17 -17
  374. package/lib/engine-components/Gizmos.js +64 -64
  375. package/lib/engine-components/GridHelper.d.ts +20 -20
  376. package/lib/engine-components/GridHelper.js +54 -54
  377. package/lib/engine-components/GroundProjection.d.ts +67 -67
  378. package/lib/engine-components/GroundProjection.js +343 -343
  379. package/lib/engine-components/Interactable.d.ts +12 -12
  380. package/lib/engine-components/Interactable.js +12 -12
  381. package/lib/engine-components/Joints.d.ts +19 -19
  382. package/lib/engine-components/Joints.js +51 -51
  383. package/lib/engine-components/LODGroup.d.ts +35 -35
  384. package/lib/engine-components/LODGroup.js +152 -152
  385. package/lib/engine-components/Light.d.ts +180 -180
  386. package/lib/engine-components/Light.js +535 -535
  387. package/lib/engine-components/LookAtConstraint.d.ts +19 -19
  388. package/lib/engine-components/LookAtConstraint.js +35 -35
  389. package/lib/engine-components/NeedleMenu.d.ts +50 -50
  390. package/lib/engine-components/NeedleMenu.js +92 -92
  391. package/lib/engine-components/NestedGltf.d.ts +25 -25
  392. package/lib/engine-components/NestedGltf.js +88 -88
  393. package/lib/engine-components/Networking.d.ts +54 -54
  394. package/lib/engine-components/Networking.js +112 -112
  395. package/lib/engine-components/OffsetConstraint.d.ts +14 -14
  396. package/lib/engine-components/OffsetConstraint.js +65 -65
  397. package/lib/engine-components/OrbitControls.d.ts +266 -266
  398. package/lib/engine-components/OrbitControls.js +1009 -1009
  399. package/lib/engine-components/PlayerColor.d.ts +19 -19
  400. package/lib/engine-components/PlayerColor.js +94 -94
  401. package/lib/engine-components/ReflectionProbe.d.ts +26 -26
  402. package/lib/engine-components/ReflectionProbe.js +194 -194
  403. package/lib/engine-components/Renderer.d.ts +153 -153
  404. package/lib/engine-components/Renderer.js +830 -830
  405. package/lib/engine-components/RendererInstancing.d.ts +140 -140
  406. package/lib/engine-components/RendererInstancing.js +744 -744
  407. package/lib/engine-components/RendererLightmap.d.ts +24 -24
  408. package/lib/engine-components/RendererLightmap.js +182 -182
  409. package/lib/engine-components/RigidBody.d.ts +155 -155
  410. package/lib/engine-components/RigidBody.js +517 -517
  411. package/lib/engine-components/SceneSwitcher.d.ts +263 -263
  412. package/lib/engine-components/SceneSwitcher.js +951 -951
  413. package/lib/engine-components/ScreenCapture.d.ts +144 -144
  414. package/lib/engine-components/ScreenCapture.js +547 -547
  415. package/lib/engine-components/ShadowCatcher.d.ts +33 -33
  416. package/lib/engine-components/ShadowCatcher.js +166 -166
  417. package/lib/engine-components/Skybox.d.ts +82 -82
  418. package/lib/engine-components/Skybox.js +448 -448
  419. package/lib/engine-components/SmoothFollow.d.ts +34 -34
  420. package/lib/engine-components/SmoothFollow.js +82 -82
  421. package/lib/engine-components/SpatialTrigger.d.ts +102 -102
  422. package/lib/engine-components/SpatialTrigger.js +225 -225
  423. package/lib/engine-components/SpectatorCamera.d.ts +111 -111
  424. package/lib/engine-components/SpectatorCamera.js +715 -715
  425. package/lib/engine-components/SphereCollider.d.ts +2 -2
  426. package/lib/engine-components/SphereCollider.js +2 -2
  427. package/lib/engine-components/SpriteRenderer.d.ts +132 -132
  428. package/lib/engine-components/SpriteRenderer.js +472 -472
  429. package/lib/engine-components/SyncedCamera.d.ts +41 -41
  430. package/lib/engine-components/SyncedCamera.js +199 -199
  431. package/lib/engine-components/SyncedRoom.d.ts +106 -106
  432. package/lib/engine-components/SyncedRoom.js +371 -371
  433. package/lib/engine-components/SyncedTransform.d.ts +88 -88
  434. package/lib/engine-components/SyncedTransform.js +326 -326
  435. package/lib/engine-components/TestRunner.d.ts +16 -16
  436. package/lib/engine-components/TestRunner.js +102 -102
  437. package/lib/engine-components/TransformGizmo.d.ts +75 -75
  438. package/lib/engine-components/TransformGizmo.js +209 -209
  439. package/lib/engine-components/VideoPlayer.d.ts +184 -184
  440. package/lib/engine-components/VideoPlayer.js +978 -978
  441. package/lib/engine-components/Voip.d.ts +67 -67
  442. package/lib/engine-components/Voip.js +360 -360
  443. package/lib/engine-components/api.d.ts +51 -51
  444. package/lib/engine-components/api.js +50 -50
  445. package/lib/engine-components/avatar/AvatarBlink_Simple.d.ts +11 -11
  446. package/lib/engine-components/avatar/AvatarBlink_Simple.js +76 -76
  447. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.d.ts +14 -14
  448. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.js +68 -68
  449. package/lib/engine-components/avatar/Avatar_Brain_LookAt.d.ts +29 -29
  450. package/lib/engine-components/avatar/Avatar_Brain_LookAt.js +121 -121
  451. package/lib/engine-components/avatar/Avatar_MouthShapes.d.ts +15 -15
  452. package/lib/engine-components/avatar/Avatar_MouthShapes.js +79 -79
  453. package/lib/engine-components/avatar/Avatar_MustacheShake.d.ts +9 -9
  454. package/lib/engine-components/avatar/Avatar_MustacheShake.js +29 -29
  455. package/lib/engine-components/codegen/components.d.ts +216 -215
  456. package/lib/engine-components/codegen/components.js +218 -217
  457. package/lib/engine-components/codegen/components.js.map +1 -1
  458. package/lib/engine-components/debug/LogStats.d.ts +5 -5
  459. package/lib/engine-components/debug/LogStats.js +18 -18
  460. package/lib/engine-components/export/gltf/GltfExport.d.ts +30 -30
  461. package/lib/engine-components/export/gltf/GltfExport.js +246 -246
  462. package/lib/engine-components/export/gltf/index.d.ts +1 -1
  463. package/lib/engine-components/export/gltf/index.js +1 -1
  464. package/lib/engine-components/export/index.d.ts +1 -1
  465. package/lib/engine-components/export/index.js +1 -1
  466. package/lib/engine-components/export/usdz/Extension.d.ts +22 -22
  467. package/lib/engine-components/export/usdz/Extension.js +1 -1
  468. package/lib/engine-components/export/usdz/ThreeUSDZExporter.d.ts +160 -160
  469. package/lib/engine-components/export/usdz/ThreeUSDZExporter.js +1782 -1782
  470. package/lib/engine-components/export/usdz/USDZExporter.d.ts +130 -130
  471. package/lib/engine-components/export/usdz/USDZExporter.js +663 -663
  472. package/lib/engine-components/export/usdz/extensions/Animation.d.ts +106 -106
  473. package/lib/engine-components/export/usdz/extensions/Animation.js +1071 -1071
  474. package/lib/engine-components/export/usdz/extensions/DocumentExtension.d.ts +5 -5
  475. package/lib/engine-components/export/usdz/extensions/DocumentExtension.js +6 -6
  476. package/lib/engine-components/export/usdz/extensions/USDZText.d.ts +54 -54
  477. package/lib/engine-components/export/usdz/extensions/USDZText.js +203 -203
  478. package/lib/engine-components/export/usdz/extensions/USDZUI.d.ts +8 -8
  479. package/lib/engine-components/export/usdz/extensions/USDZUI.js +157 -157
  480. package/lib/engine-components/export/usdz/extensions/behavior/Actions.d.ts +30 -30
  481. package/lib/engine-components/export/usdz/extensions/behavior/Actions.js +88 -88
  482. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.d.ts +10 -10
  483. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.js +86 -86
  484. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.d.ts +28 -28
  485. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.js +290 -290
  486. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.d.ts +190 -190
  487. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.js +1060 -1060
  488. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.d.ts +135 -135
  489. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.js +548 -548
  490. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.d.ts +7 -7
  491. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.js +115 -115
  492. package/lib/engine-components/export/usdz/index.d.ts +3 -3
  493. package/lib/engine-components/export/usdz/index.js +2 -2
  494. package/lib/engine-components/export/usdz/utils/animationutils.d.ts +7 -7
  495. package/lib/engine-components/export/usdz/utils/animationutils.js +163 -163
  496. package/lib/engine-components/export/usdz/utils/quicklook.d.ts +2 -2
  497. package/lib/engine-components/export/usdz/utils/quicklook.js +43 -43
  498. package/lib/engine-components/particlesystem/ParticleSystem.d.ts +177 -177
  499. package/lib/engine-components/particlesystem/ParticleSystem.js +1176 -1176
  500. package/lib/engine-components/particlesystem/ParticleSystemModules.d.ts +526 -526
  501. package/lib/engine-components/particlesystem/ParticleSystemModules.js +1930 -1930
  502. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.d.ts +25 -25
  503. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.js +87 -87
  504. package/lib/engine-components/particlesystem/api.d.ts +2 -2
  505. package/lib/engine-components/particlesystem/api.js +2 -2
  506. package/lib/engine-components/postprocessing/Effects/Antialiasing.d.ts +17 -17
  507. package/lib/engine-components/postprocessing/Effects/Antialiasing.js +50 -50
  508. package/lib/engine-components/postprocessing/Effects/BloomEffect.d.ts +46 -46
  509. package/lib/engine-components/postprocessing/Effects/BloomEffect.js +113 -113
  510. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.d.ts +11 -11
  511. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.js +39 -39
  512. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.d.ts +15 -15
  513. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.js +92 -92
  514. package/lib/engine-components/postprocessing/Effects/DepthOfField.d.ts +25 -25
  515. package/lib/engine-components/postprocessing/Effects/DepthOfField.js +104 -104
  516. package/lib/engine-components/postprocessing/Effects/EffectWrapper.d.ts +12 -12
  517. package/lib/engine-components/postprocessing/Effects/EffectWrapper.js +18 -18
  518. package/lib/engine-components/postprocessing/Effects/Pixelation.d.ts +11 -11
  519. package/lib/engine-components/postprocessing/Effects/Pixelation.js +32 -32
  520. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.d.ts +18 -18
  521. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.js +91 -91
  522. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.d.ts +70 -70
  523. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.js +175 -175
  524. package/lib/engine-components/postprocessing/Effects/Sharpening.d.ts +17 -17
  525. package/lib/engine-components/postprocessing/Effects/Sharpening.js +123 -123
  526. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.d.ts +17 -17
  527. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.js +70 -70
  528. package/lib/engine-components/postprocessing/Effects/Tonemapping.d.ts +26 -26
  529. package/lib/engine-components/postprocessing/Effects/Tonemapping.js +138 -138
  530. package/lib/engine-components/postprocessing/Effects/Vignette.d.ts +15 -15
  531. package/lib/engine-components/postprocessing/Effects/Vignette.js +60 -60
  532. package/lib/engine-components/postprocessing/PostProcessingEffect.d.ts +72 -72
  533. package/lib/engine-components/postprocessing/PostProcessingEffect.js +149 -149
  534. package/lib/engine-components/postprocessing/PostProcessingHandler.d.ts +25 -25
  535. package/lib/engine-components/postprocessing/PostProcessingHandler.js +350 -350
  536. package/lib/engine-components/postprocessing/Volume.d.ts +89 -89
  537. package/lib/engine-components/postprocessing/Volume.js +367 -367
  538. package/lib/engine-components/postprocessing/VolumeParameter.d.ts +26 -26
  539. package/lib/engine-components/postprocessing/VolumeParameter.js +136 -136
  540. package/lib/engine-components/postprocessing/VolumeProfile.d.ts +15 -15
  541. package/lib/engine-components/postprocessing/VolumeProfile.js +60 -60
  542. package/lib/engine-components/postprocessing/index.d.ts +5 -5
  543. package/lib/engine-components/postprocessing/index.js +5 -5
  544. package/lib/engine-components/postprocessing/utils.d.ts +11 -11
  545. package/lib/engine-components/postprocessing/utils.js +37 -37
  546. package/lib/engine-components/timeline/PlayableDirector.d.ts +163 -163
  547. package/lib/engine-components/timeline/PlayableDirector.js +686 -686
  548. package/lib/engine-components/timeline/SignalAsset.d.ts +24 -24
  549. package/lib/engine-components/timeline/SignalAsset.js +130 -130
  550. package/lib/engine-components/timeline/TimelineModels.d.ts +89 -89
  551. package/lib/engine-components/timeline/TimelineModels.js +22 -22
  552. package/lib/engine-components/timeline/TimelineTracks.d.ts +110 -110
  553. package/lib/engine-components/timeline/TimelineTracks.js +879 -879
  554. package/lib/engine-components/timeline/index.d.ts +4 -4
  555. package/lib/engine-components/timeline/index.js +3 -3
  556. package/lib/engine-components/ui/BaseUIComponent.d.ts +49 -49
  557. package/lib/engine-components/ui/BaseUIComponent.js +170 -170
  558. package/lib/engine-components/ui/Button.d.ts +64 -64
  559. package/lib/engine-components/ui/Button.js +315 -315
  560. package/lib/engine-components/ui/Canvas.d.ts +74 -74
  561. package/lib/engine-components/ui/Canvas.js +407 -407
  562. package/lib/engine-components/ui/CanvasGroup.d.ts +19 -19
  563. package/lib/engine-components/ui/CanvasGroup.js +58 -58
  564. package/lib/engine-components/ui/EventSystem.d.ts +125 -125
  565. package/lib/engine-components/ui/EventSystem.js +764 -764
  566. package/lib/engine-components/ui/Graphic.d.ts +55 -55
  567. package/lib/engine-components/ui/Graphic.js +254 -254
  568. package/lib/engine-components/ui/Image.d.ts +35 -35
  569. package/lib/engine-components/ui/Image.js +116 -116
  570. package/lib/engine-components/ui/InputField.d.ts +42 -42
  571. package/lib/engine-components/ui/InputField.js +268 -268
  572. package/lib/engine-components/ui/Interfaces.d.ts +38 -38
  573. package/lib/engine-components/ui/Interfaces.js +12 -12
  574. package/lib/engine-components/ui/Layout.d.ts +84 -84
  575. package/lib/engine-components/ui/Layout.js +330 -330
  576. package/lib/engine-components/ui/Outline.d.ts +7 -7
  577. package/lib/engine-components/ui/Outline.js +20 -20
  578. package/lib/engine-components/ui/PointerEvents.d.ts +115 -115
  579. package/lib/engine-components/ui/PointerEvents.js +145 -145
  580. package/lib/engine-components/ui/RaycastUtils.d.ts +11 -11
  581. package/lib/engine-components/ui/RaycastUtils.js +67 -67
  582. package/lib/engine-components/ui/Raycaster.d.ts +30 -30
  583. package/lib/engine-components/ui/Raycaster.js +95 -95
  584. package/lib/engine-components/ui/RectTransform.d.ts +61 -61
  585. package/lib/engine-components/ui/RectTransform.js +353 -353
  586. package/lib/engine-components/ui/SpatialHtml.d.ts +8 -8
  587. package/lib/engine-components/ui/SpatialHtml.js +79 -79
  588. package/lib/engine-components/ui/Text.d.ts +78 -78
  589. package/lib/engine-components/ui/Text.js +539 -539
  590. package/lib/engine-components/ui/Utils.d.ts +24 -24
  591. package/lib/engine-components/ui/Utils.js +90 -90
  592. package/lib/engine-components/ui/index.d.ts +1 -1
  593. package/lib/engine-components/ui/index.js +1 -1
  594. package/lib/engine-components/utils/EnvironmentScene.d.ts +5 -5
  595. package/lib/engine-components/utils/EnvironmentScene.js +205 -205
  596. package/lib/engine-components/utils/EnvironmentScene.js.map +1 -1
  597. package/lib/engine-components/utils/LookAt.d.ts +31 -31
  598. package/lib/engine-components/utils/LookAt.js +82 -82
  599. package/lib/engine-components/utils/OpenURL.d.ts +42 -42
  600. package/lib/engine-components/utils/OpenURL.js +119 -119
  601. package/lib/engine-components/webxr/Avatar.d.ts +25 -25
  602. package/lib/engine-components/webxr/Avatar.js +255 -255
  603. package/lib/engine-components/webxr/TeleportTarget.d.ts +7 -7
  604. package/lib/engine-components/webxr/TeleportTarget.js +7 -7
  605. package/lib/engine-components/webxr/WebARCameraBackground.d.ts +30 -30
  606. package/lib/engine-components/webxr/WebARCameraBackground.js +155 -155
  607. package/lib/engine-components/webxr/WebARSessionRoot.d.ts +98 -98
  608. package/lib/engine-components/webxr/WebARSessionRoot.js +770 -770
  609. package/lib/engine-components/webxr/WebXR.d.ts +232 -232
  610. package/lib/engine-components/webxr/WebXR.js +561 -561
  611. package/lib/engine-components/webxr/WebXRAvatar.d.ts +27 -27
  612. package/lib/engine-components/webxr/WebXRAvatar.js +44 -44
  613. package/lib/engine-components/webxr/WebXRImageTracking.d.ts +86 -86
  614. package/lib/engine-components/webxr/WebXRImageTracking.js +470 -470
  615. package/lib/engine-components/webxr/WebXRPlaneTracking.d.ts +92 -92
  616. package/lib/engine-components/webxr/WebXRPlaneTracking.js +500 -500
  617. package/lib/engine-components/webxr/WebXRRig.d.ts +32 -32
  618. package/lib/engine-components/webxr/WebXRRig.js +72 -72
  619. package/lib/engine-components/webxr/XRFlag.d.ts +38 -38
  620. package/lib/engine-components/webxr/XRFlag.js +139 -139
  621. package/lib/engine-components/webxr/controllers/XRControllerFollow.d.ts +47 -47
  622. package/lib/engine-components/webxr/controllers/XRControllerFollow.js +120 -120
  623. package/lib/engine-components/webxr/controllers/XRControllerModel.d.ts +43 -43
  624. package/lib/engine-components/webxr/controllers/XRControllerModel.js +351 -351
  625. package/lib/engine-components/webxr/controllers/XRControllerMovement.d.ts +78 -78
  626. package/lib/engine-components/webxr/controllers/XRControllerMovement.js +506 -506
  627. package/lib/engine-components/webxr/index.d.ts +3 -3
  628. package/lib/engine-components/webxr/index.js +3 -3
  629. package/lib/engine-components/webxr/types.d.ts +3 -3
  630. package/lib/engine-components/webxr/types.js +1 -1
  631. package/lib/engine-components-experimental/Presentation.d.ts +6 -6
  632. package/lib/engine-components-experimental/Presentation.js +9 -9
  633. package/lib/engine-components-experimental/api.d.ts +4 -4
  634. package/lib/engine-components-experimental/api.js +4 -4
  635. package/lib/engine-components-experimental/networking/PlayerSync.d.ts +156 -156
  636. package/lib/engine-components-experimental/networking/PlayerSync.js +377 -377
  637. package/lib/engine-schemes/api.d.ts +12 -12
  638. package/lib/engine-schemes/api.js +12 -12
  639. package/lib/engine-schemes/schemes.d.ts +7 -7
  640. package/lib/engine-schemes/schemes.js +19 -19
  641. package/lib/engine-schemes/synced-camera-model.d.ts +25 -25
  642. package/lib/engine-schemes/synced-camera-model.js +67 -67
  643. package/lib/engine-schemes/synced-transform-model.d.ts +31 -31
  644. package/lib/engine-schemes/synced-transform-model.js +66 -66
  645. package/lib/engine-schemes/transform.d.ts +12 -12
  646. package/lib/engine-schemes/transform.js +39 -39
  647. package/lib/engine-schemes/vec2.d.ts +10 -10
  648. package/lib/engine-schemes/vec2.js +25 -25
  649. package/lib/engine-schemes/vec3.d.ts +11 -11
  650. package/lib/engine-schemes/vec3.js +29 -29
  651. package/lib/engine-schemes/vec4.d.ts +12 -12
  652. package/lib/engine-schemes/vec4.js +33 -33
  653. package/lib/engine-schemes/vr-user-state-buffer.d.ts +37 -37
  654. package/lib/engine-schemes/vr-user-state-buffer.js +110 -110
  655. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.d.ts +6 -6
  656. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.js +45 -45
  657. package/lib/needle-engine.d.ts +7 -7
  658. package/lib/needle-engine.js +64 -64
  659. package/package.json +1 -1
  660. package/plugins/common/buildinfo.js +64 -63
  661. package/plugins/common/cloud.js +2 -0
  662. package/plugins/common/config.cjs +31 -31
  663. package/plugins/common/config.js +35 -35
  664. package/plugins/common/files.js +31 -31
  665. package/plugins/common/generator.js +10 -10
  666. package/plugins/common/license.js +317 -224
  667. package/plugins/common/npm.js +15 -15
  668. package/plugins/common/timers.js +7 -7
  669. package/plugins/common/version.js +37 -37
  670. package/plugins/gltf-packer.mjs +1 -1
  671. package/plugins/next/alias.cjs +39 -39
  672. package/plugins/next/license.cjs +18 -18
  673. package/plugins/next/meshbvhworker.cjs +18 -18
  674. package/plugins/next/next.js +128 -128
  675. package/plugins/types/index.d.ts +2 -2
  676. package/plugins/types/license.d.ts +24 -24
  677. package/plugins/types/needleConfig.d.ts +27 -27
  678. package/plugins/types/userconfig.d.ts +105 -105
  679. package/plugins/types/webmanifest.d.ts +32 -32
  680. package/plugins/vite/alias.js +174 -174
  681. package/plugins/vite/asap.js +245 -245
  682. package/plugins/vite/build-pipeline.js +355 -354
  683. package/plugins/vite/build.js +19 -19
  684. package/plugins/vite/buildinfo.js +41 -41
  685. package/plugins/vite/config.js +106 -106
  686. package/plugins/vite/copyfiles.js +138 -138
  687. package/plugins/vite/defines.js +66 -66
  688. package/plugins/vite/dependencies.js +213 -213
  689. package/plugins/vite/dependency-watcher.js +231 -231
  690. package/plugins/vite/drop-client.js +76 -76
  691. package/plugins/vite/drop.js +87 -87
  692. package/plugins/vite/editor-connection.js +124 -124
  693. package/plugins/vite/facebook-instant-games.js +99 -99
  694. package/plugins/vite/gzip.js +5 -5
  695. package/plugins/vite/imports-logger.js +143 -143
  696. package/plugins/vite/index.js +139 -139
  697. package/plugins/vite/license.js +55 -55
  698. package/plugins/vite/meta.js +163 -163
  699. package/plugins/vite/npm.js +7 -7
  700. package/plugins/vite/peer.js +29 -29
  701. package/plugins/vite/poster-client.js +73 -73
  702. package/plugins/vite/poster.js +79 -79
  703. package/plugins/vite/pwa.js +604 -604
  704. package/plugins/vite/reload-client.js +15 -15
  705. package/plugins/vite/reload.js +363 -363
  706. package/plugins/vite/server.js +66 -66
  707. package/plugins/vite/transform-codegen.js +55 -55
  708. package/plugins/vite/transform.js +31 -31
  709. package/plugins/vite/vite-4.4-hack.js +31 -31
  710. package/src/asap/needle-asap.ts +111 -111
  711. package/src/asap/sessiongranted.ts +75 -75
  712. package/src/asap/utils.ts +4 -4
  713. package/src/engine/analytics/index.ts +10 -10
  714. package/src/engine/analytics/lcp.ts +35 -35
  715. package/src/engine/api.ts +81 -81
  716. package/src/engine/assets/index.ts +59 -59
  717. package/src/engine/assets/static.js +5 -5
  718. package/src/engine/codegen/register_types.ts +300 -298
  719. package/src/engine/debug/debug.ts +51 -51
  720. package/src/engine/debug/debug_console.ts +333 -333
  721. package/src/engine/debug/debug_overlay.ts +332 -332
  722. package/src/engine/debug/debug_spatial_console.ts +429 -429
  723. package/src/engine/debug/index.ts +1 -1
  724. package/src/engine/engine_addressables.ts +679 -679
  725. package/src/engine/engine_animation.ts +145 -145
  726. package/src/engine/engine_application.ts +113 -113
  727. package/src/engine/engine_assetdatabase.ts +387 -387
  728. package/src/engine/engine_audio.ts +24 -24
  729. package/src/engine/engine_camera.ts +39 -39
  730. package/src/engine/engine_components.ts +373 -373
  731. package/src/engine/engine_components_internal.ts +40 -40
  732. package/src/engine/engine_constants.ts +52 -52
  733. package/src/engine/engine_context.ts +1662 -1662
  734. package/src/engine/engine_context_registry.ts +129 -129
  735. package/src/engine/engine_coroutine.ts +54 -54
  736. package/src/engine/engine_create_objects.ts +398 -398
  737. package/src/engine/engine_default_parameters.ts +3 -3
  738. package/src/engine/engine_editor-sync.ts +28 -28
  739. package/src/engine/engine_element.ts +871 -871
  740. package/src/engine/engine_element_attributes.ts +85 -85
  741. package/src/engine/engine_element_extras.ts +16 -16
  742. package/src/engine/engine_element_loading.ts +381 -381
  743. package/src/engine/engine_element_overlay.ts +186 -186
  744. package/src/engine/engine_fileloader.js +9 -9
  745. package/src/engine/engine_gameobject.ts +684 -684
  746. package/src/engine/engine_generic_utils.js +13 -13
  747. package/src/engine/engine_gizmos.ts +577 -577
  748. package/src/engine/engine_gltf.ts +29 -29
  749. package/src/engine/engine_gltf_builtin_components.ts +403 -403
  750. package/src/engine/engine_hot_reload.ts +198 -198
  751. package/src/engine/engine_input.ts +1460 -1460
  752. package/src/engine/engine_input_utils.ts +23 -23
  753. package/src/engine/engine_instancing.ts +45 -45
  754. package/src/engine/engine_license.ts +329 -329
  755. package/src/engine/engine_lifecycle_api.ts +106 -106
  756. package/src/engine/engine_lifecycle_functions_internal.ts +193 -193
  757. package/src/engine/engine_lightdata.ts +117 -117
  758. package/src/engine/engine_loaders.ts +82 -82
  759. package/src/engine/engine_lods.ts +168 -168
  760. package/src/engine/engine_mainloop_utils.ts +472 -472
  761. package/src/engine/engine_math.ts +282 -282
  762. package/src/engine/engine_modules.ts +83 -83
  763. package/src/engine/engine_networking.ts +841 -841
  764. package/src/engine/engine_networking_auto.ts +352 -352
  765. package/src/engine/engine_networking_blob.ts +254 -254
  766. package/src/engine/engine_networking_files.ts +217 -217
  767. package/src/engine/engine_networking_files_default_components.ts +58 -58
  768. package/src/engine/engine_networking_instantiate.ts +419 -419
  769. package/src/engine/engine_networking_peer.ts +159 -159
  770. package/src/engine/engine_networking_streams.ts +713 -713
  771. package/src/engine/engine_networking_types.ts +24 -24
  772. package/src/engine/engine_networking_utils.ts +23 -23
  773. package/src/engine/engine_networking_websocket.ts +2 -2
  774. package/src/engine/engine_patcher.ts +199 -199
  775. package/src/engine/engine_physics.ts +783 -783
  776. package/src/engine/engine_physics.types.ts +46 -46
  777. package/src/engine/engine_physics_rapier.ts +1579 -1579
  778. package/src/engine/engine_playerview.ts +80 -80
  779. package/src/engine/engine_scenelighting.ts +294 -294
  780. package/src/engine/engine_scenetools.ts +365 -365
  781. package/src/engine/engine_serialization.ts +2 -2
  782. package/src/engine/engine_serialization_builtin_serializer.ts +473 -473
  783. package/src/engine/engine_serialization_core.ts +705 -705
  784. package/src/engine/engine_serialization_decorator.ts +80 -80
  785. package/src/engine/engine_setup.ts +1 -1
  786. package/src/engine/engine_shaders.ts +267 -267
  787. package/src/engine/engine_shims.ts +32 -32
  788. package/src/engine/engine_test_utils.ts +109 -109
  789. package/src/engine/engine_texture.ts +82 -82
  790. package/src/engine/engine_three_utils.ts +849 -849
  791. package/src/engine/engine_time.ts +94 -94
  792. package/src/engine/engine_time_utils.ts +237 -237
  793. package/src/engine/engine_tonemapping.ts +210 -210
  794. package/src/engine/engine_types.ts +714 -714
  795. package/src/engine/engine_typestore.ts +63 -63
  796. package/src/engine/engine_util_decorator.ts +136 -136
  797. package/src/engine/engine_utils.ts +972 -972
  798. package/src/engine/engine_utils_format.ts +212 -212
  799. package/src/engine/engine_utils_screenshot.ts +698 -698
  800. package/src/engine/engine_utils_screenshot.xr.ts +103 -103
  801. package/src/engine/export/gltf/Writers.ts +34 -34
  802. package/src/engine/export/gltf/index.ts +158 -158
  803. package/src/engine/export/index.ts +2 -2
  804. package/src/engine/export/state.ts +19 -19
  805. package/src/engine/export/utils.ts +9 -9
  806. package/src/engine/extensions/EXT_texture_exr.ts +50 -50
  807. package/src/engine/extensions/NEEDLE_animator_controller_model.ts +195 -195
  808. package/src/engine/extensions/NEEDLE_components.ts +268 -268
  809. package/src/engine/extensions/NEEDLE_gameobject_data.ts +81 -81
  810. package/src/engine/extensions/NEEDLE_lighting_settings.ts +185 -185
  811. package/src/engine/extensions/NEEDLE_lightmaps.ts +119 -119
  812. package/src/engine/extensions/NEEDLE_persistent_assets.ts +76 -76
  813. package/src/engine/extensions/NEEDLE_render_objects.ts +209 -209
  814. package/src/engine/extensions/NEEDLE_techniques_webgl.ts +640 -640
  815. package/src/engine/extensions/extension_resolver.ts +4 -4
  816. package/src/engine/extensions/extension_utils.ts +166 -166
  817. package/src/engine/extensions/extensions.ts +135 -135
  818. package/src/engine/extensions/index.ts +5 -5
  819. package/src/engine/extensions/usage_tracker.ts +100 -100
  820. package/src/engine/js-extensions/Camera.ts +37 -37
  821. package/src/engine/js-extensions/ExtensionUtils.ts +85 -85
  822. package/src/engine/js-extensions/Layers.ts +23 -23
  823. package/src/engine/js-extensions/Object3D.ts +296 -296
  824. package/src/engine/js-extensions/RGBAColor.ts +75 -75
  825. package/src/engine/js-extensions/Vector.ts +18 -18
  826. package/src/engine/js-extensions/index.ts +4 -4
  827. package/src/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +122 -122
  828. package/src/engine/shaders/shaderData.ts +67 -67
  829. package/src/engine/tests/test_utils.ts +63 -63
  830. package/src/engine/webcomponents/WebXRButtons.ts +260 -260
  831. package/src/engine/webcomponents/api.ts +6 -6
  832. package/src/engine/webcomponents/buttons.ts +262 -262
  833. package/src/engine/webcomponents/fonts.ts +41 -41
  834. package/src/engine/webcomponents/icons.ts +57 -57
  835. package/src/engine/webcomponents/index.ts +1 -1
  836. package/src/engine/webcomponents/logo-element.ts +78 -78
  837. package/src/engine/webcomponents/needle menu/needle-menu-spatial.ts +573 -573
  838. package/src/engine/webcomponents/needle menu/needle-menu.ts +1107 -1107
  839. package/src/engine/webcomponents/needle-button.ts +181 -181
  840. package/src/engine/xr/NeedleXRController.ts +1126 -1126
  841. package/src/engine/xr/NeedleXRSession.ts +1585 -1585
  842. package/src/engine/xr/NeedleXRSync.ts +220 -220
  843. package/src/engine/xr/SceneTransition.ts +78 -78
  844. package/src/engine/xr/TempXRContext.ts +216 -216
  845. package/src/engine/xr/XRRig.ts +9 -9
  846. package/src/engine/xr/api.ts +5 -5
  847. package/src/engine/xr/events.ts +102 -102
  848. package/src/engine/xr/internal.ts +34 -34
  849. package/src/engine/xr/usdz.ts +30 -30
  850. package/src/engine/xr/utils.ts +39 -39
  851. package/src/engine-components/AlignmentConstraint.ts +36 -36
  852. package/src/engine-components/Animation.ts +557 -557
  853. package/src/engine-components/AnimationCurve.ts +150 -150
  854. package/src/engine-components/AnimationUtils.ts +28 -28
  855. package/src/engine-components/AnimationUtilsAutoplay.ts +43 -43
  856. package/src/engine-components/Animator.ts +397 -397
  857. package/src/engine-components/AnimatorController.ts +1293 -1293
  858. package/src/engine-components/AudioListener.ts +92 -92
  859. package/src/engine-components/AudioSource.ts +639 -639
  860. package/src/engine-components/AvatarLoader.ts +263 -263
  861. package/src/engine-components/AxesHelper.ts +59 -59
  862. package/src/engine-components/BasicIKConstraint.ts +54 -54
  863. package/src/engine-components/BoxCollider.ts +1 -1
  864. package/src/engine-components/BoxHelperComponent.ts +114 -114
  865. package/src/engine-components/Camera.ts +707 -707
  866. package/src/engine-components/CameraUtils.ts +142 -144
  867. package/src/engine-components/CharacterController.ts +253 -253
  868. package/src/engine-components/Collider.ts +374 -374
  869. package/src/engine-components/Component.ts +1294 -1294
  870. package/src/engine-components/ContactShadows.ts +482 -482
  871. package/src/engine-components/DeleteBox.ts +62 -62
  872. package/src/engine-components/DeviceFlag.ts +46 -46
  873. package/src/engine-components/DragControls.ts +1623 -1623
  874. package/src/engine-components/DropListener.ts +698 -698
  875. package/src/engine-components/Duplicatable.ts +198 -198
  876. package/src/engine-components/EventList.ts +266 -266
  877. package/src/engine-components/EventTrigger.ts +74 -74
  878. package/src/engine-components/EventType.ts +22 -22
  879. package/src/engine-components/Fog.ts +60 -60
  880. package/src/engine-components/Gizmos.ts +56 -56
  881. package/src/engine-components/GridHelper.ts +48 -48
  882. package/src/engine-components/GroundProjection.ts +356 -356
  883. package/src/engine-components/Interactable.ts +14 -14
  884. package/src/engine-components/Joints.ts +52 -52
  885. package/src/engine-components/LODGroup.ts +153 -153
  886. package/src/engine-components/Light.ts +558 -558
  887. package/src/engine-components/LookAtConstraint.ts +25 -25
  888. package/src/engine-components/NeedleMenu.ts +84 -84
  889. package/src/engine-components/NestedGltf.ts +86 -86
  890. package/src/engine-components/Networking.ts +114 -114
  891. package/src/engine-components/OffsetConstraint.ts +60 -60
  892. package/src/engine-components/OrbitControls.ts +1068 -1068
  893. package/src/engine-components/PlayerColor.ts +103 -103
  894. package/src/engine-components/ReflectionProbe.ts +209 -209
  895. package/src/engine-components/Renderer.ts +900 -900
  896. package/src/engine-components/RendererInstancing.ts +855 -855
  897. package/src/engine-components/RendererLightmap.ts +198 -198
  898. package/src/engine-components/RigidBody.ts +526 -526
  899. package/src/engine-components/SceneSwitcher.ts +1013 -1013
  900. package/src/engine-components/ScreenCapture.ts +592 -592
  901. package/src/engine-components/ShadowCatcher.ts +172 -172
  902. package/src/engine-components/Skybox.ts +455 -455
  903. package/src/engine-components/SmoothFollow.ts +76 -76
  904. package/src/engine-components/SpatialTrigger.ts +229 -229
  905. package/src/engine-components/SpectatorCamera.ts +787 -787
  906. package/src/engine-components/SphereCollider.ts +1 -1
  907. package/src/engine-components/SpriteRenderer.ts +468 -468
  908. package/src/engine-components/SyncedCamera.ts +220 -220
  909. package/src/engine-components/SyncedRoom.ts +380 -380
  910. package/src/engine-components/SyncedTransform.ts +378 -378
  911. package/src/engine-components/TestRunner.ts +118 -118
  912. package/src/engine-components/TransformGizmo.ts +219 -219
  913. package/src/engine-components/VideoPlayer.ts +1025 -1025
  914. package/src/engine-components/Voip.ts +363 -363
  915. package/src/engine-components/api.ts +60 -60
  916. package/src/engine-components/avatar/AvatarBlink_Simple.ts +69 -69
  917. package/src/engine-components/avatar/AvatarEyeLook_Rotation.ts +63 -63
  918. package/src/engine-components/avatar/Avatar_Brain_LookAt.ts +139 -139
  919. package/src/engine-components/avatar/Avatar_MouthShapes.ts +83 -83
  920. package/src/engine-components/avatar/Avatar_MustacheShake.ts +31 -31
  921. package/src/engine-components/codegen/components.ts +217 -216
  922. package/src/engine-components/debug/LogStats.ts +21 -21
  923. package/src/engine-components/export/gltf/GltfExport.ts +265 -265
  924. package/src/engine-components/export/usdz/Extension.ts +24 -24
  925. package/src/engine-components/export/usdz/ThreeUSDZExporter.ts +2413 -2413
  926. package/src/engine-components/export/usdz/USDZExporter.ts +705 -705
  927. package/src/engine-components/export/usdz/extensions/Animation.ts +1204 -1204
  928. package/src/engine-components/export/usdz/extensions/DocumentExtension.ts +9 -9
  929. package/src/engine-components/export/usdz/extensions/USDZText.ts +240 -240
  930. package/src/engine-components/export/usdz/extensions/USDZUI.ts +189 -189
  931. package/src/engine-components/export/usdz/extensions/behavior/Actions.ts +99 -99
  932. package/src/engine-components/export/usdz/extensions/behavior/AudioExtension.ts +102 -102
  933. package/src/engine-components/export/usdz/extensions/behavior/Behaviour.ts +320 -320
  934. package/src/engine-components/export/usdz/extensions/behavior/BehaviourComponents.ts +1225 -1225
  935. package/src/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.ts +646 -646
  936. package/src/engine-components/export/usdz/extensions/behavior/PhysicsExtension.ts +132 -132
  937. package/src/engine-components/export/usdz/index.ts +2 -2
  938. package/src/engine-components/export/usdz/utils/animationutils.ts +191 -191
  939. package/src/engine-components/export/usdz/utils/quicklook.ts +50 -50
  940. package/src/engine-components/particlesystem/ParticleSystem.ts +1287 -1287
  941. package/src/engine-components/particlesystem/ParticleSystemModules.ts +1765 -1765
  942. package/src/engine-components/particlesystem/ParticleSystemSubEmitter.ts +111 -111
  943. package/src/engine-components/particlesystem/api.ts +1 -1
  944. package/src/engine-components/postprocessing/Effects/Antialiasing.ts +55 -55
  945. package/src/engine-components/postprocessing/Effects/BloomEffect.ts +116 -116
  946. package/src/engine-components/postprocessing/Effects/ChromaticAberration.ts +37 -37
  947. package/src/engine-components/postprocessing/Effects/ColorAdjustments.ts +95 -95
  948. package/src/engine-components/postprocessing/Effects/DepthOfField.ts +103 -103
  949. package/src/engine-components/postprocessing/Effects/EffectWrapper.ts +25 -25
  950. package/src/engine-components/postprocessing/Effects/Pixelation.ts +32 -32
  951. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.ts +90 -90
  952. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.ts +191 -191
  953. package/src/engine-components/postprocessing/Effects/Sharpening.ts +138 -138
  954. package/src/engine-components/postprocessing/Effects/TiltShiftEffect.ts +61 -61
  955. package/src/engine-components/postprocessing/Effects/Tonemapping.ts +155 -155
  956. package/src/engine-components/postprocessing/Effects/Vignette.ts +59 -59
  957. package/src/engine-components/postprocessing/PostProcessingEffect.ts +172 -172
  958. package/src/engine-components/postprocessing/PostProcessingHandler.ts +398 -398
  959. package/src/engine-components/postprocessing/Volume.ts +410 -410
  960. package/src/engine-components/postprocessing/VolumeParameter.ts +158 -158
  961. package/src/engine-components/postprocessing/VolumeProfile.ts +61 -61
  962. package/src/engine-components/postprocessing/index.ts +5 -5
  963. package/src/engine-components/postprocessing/utils.ts +52 -52
  964. package/src/engine-components/timeline/PlayableDirector.ts +722 -722
  965. package/src/engine-components/timeline/SignalAsset.ts +144 -144
  966. package/src/engine-components/timeline/TimelineModels.ts +92 -92
  967. package/src/engine-components/timeline/TimelineTracks.ts +967 -967
  968. package/src/engine-components/timeline/index.ts +3 -3
  969. package/src/engine-components/ui/BaseUIComponent.ts +203 -203
  970. package/src/engine-components/ui/Button.ts +307 -307
  971. package/src/engine-components/ui/Canvas.ts +419 -419
  972. package/src/engine-components/ui/CanvasGroup.ts +54 -54
  973. package/src/engine-components/ui/EventSystem.ts +853 -853
  974. package/src/engine-components/ui/Graphic.ts +275 -275
  975. package/src/engine-components/ui/Image.ts +112 -112
  976. package/src/engine-components/ui/InputField.ts +321 -321
  977. package/src/engine-components/ui/Interfaces.ts +57 -57
  978. package/src/engine-components/ui/Layout.ts +334 -334
  979. package/src/engine-components/ui/Outline.ts +13 -13
  980. package/src/engine-components/ui/PointerEvents.ts +206 -206
  981. package/src/engine-components/ui/RaycastUtils.ts +69 -69
  982. package/src/engine-components/ui/Raycaster.ts +102 -102
  983. package/src/engine-components/ui/RectTransform.ts +372 -372
  984. package/src/engine-components/ui/SpatialHtml.ts +79 -79
  985. package/src/engine-components/ui/Text.ts +578 -578
  986. package/src/engine-components/ui/Utils.ts +112 -112
  987. package/src/engine-components/utils/EnvironmentScene.ts +245 -245
  988. package/src/engine-components/utils/LookAt.ts +88 -88
  989. package/src/engine-components/utils/OpenURL.ts +114 -114
  990. package/src/engine-components/webxr/Avatar.ts +265 -265
  991. package/src/engine-components/webxr/TeleportTarget.ts +9 -9
  992. package/src/engine-components/webxr/WebARCameraBackground.ts +175 -175
  993. package/src/engine-components/webxr/WebARSessionRoot.ts +880 -880
  994. package/src/engine-components/webxr/WebXR.ts +585 -585
  995. package/src/engine-components/webxr/WebXRAvatar.ts +66 -66
  996. package/src/engine-components/webxr/WebXRImageTracking.ts +518 -518
  997. package/src/engine-components/webxr/WebXRPlaneTracking.ts +570 -570
  998. package/src/engine-components/webxr/WebXRRig.ts +77 -77
  999. package/src/engine-components/webxr/XRFlag.ts +147 -147
  1000. package/src/engine-components/webxr/controllers/XRControllerFollow.ts +118 -118
  1001. package/src/engine-components/webxr/controllers/XRControllerModel.ts +374 -374
  1002. package/src/engine-components/webxr/controllers/XRControllerMovement.ts +550 -550
  1003. package/src/engine-components/webxr/index.ts +2 -2
  1004. package/src/engine-components/webxr/types.ts +3 -3
  1005. package/src/engine-components-experimental/Presentation.ts +12 -12
  1006. package/src/engine-components-experimental/api.ts +4 -4
  1007. package/src/engine-components-experimental/networking/PlayerSync.ts +401 -401
  1008. package/src/engine-schemes/COMPILE_SCHEMES.bat +3 -3
  1009. package/src/engine-schemes/COMPILE_TS.bat +11 -11
  1010. package/src/engine-schemes/README.md +1 -1
  1011. package/src/engine-schemes/api.ts +12 -12
  1012. package/src/engine-schemes/schemes.ts +28 -28
  1013. package/src/engine-schemes/synced-camera-model.ts +92 -92
  1014. package/src/engine-schemes/synced-transform-model.ts +90 -90
  1015. package/src/engine-schemes/syncedCamera.fbs +10 -10
  1016. package/src/engine-schemes/transform.ts +50 -50
  1017. package/src/engine-schemes/transforms.fbs +25 -25
  1018. package/src/engine-schemes/vec.fbs +19 -19
  1019. package/src/engine-schemes/vec2.ts +33 -33
  1020. package/src/engine-schemes/vec3.ts +38 -38
  1021. package/src/engine-schemes/vec4.ts +43 -43
  1022. package/src/engine-schemes/vr-user-state-buffer.ts +145 -145
  1023. package/src/engine-schemes/vrUserStateBuffer.fbs +17 -17
  1024. package/src/include/draco/draco_decoder.js +34 -34
  1025. package/src/include/ktx2/basis_transcoder.js +21 -21
  1026. package/src/include/needle/arial-msdf.json +1471 -1471
  1027. package/src/include/three/DragControls.js +231 -231
  1028. package/src/include/three/EXT_mesh_gpu_instancing_exporter.js +66 -66
  1029. package/src/needle-engine.ts +70 -70
  1030. package/lib/engine/engine.d.ts +0 -4
  1031. package/lib/engine/engine.js +0 -12
  1032. package/lib/engine/engine.js.map +0 -1
  1033. package/lib/engine/engine_web_api.d.ts +0 -12
  1034. package/lib/engine/engine_web_api.js +0 -113
  1035. package/lib/engine/engine_web_api.js.map +0 -1
  1036. package/lib/engine-components/FlyControls.d.ts +0 -10
  1037. package/lib/engine-components/FlyControls.js +0 -29
  1038. package/lib/engine-components/FlyControls.js.map +0 -1
  1039. package/src/engine-schemes/dist/api.js +0 -17
  1040. package/src/engine-schemes/dist/api.js.meta +0 -7
  1041. package/src/engine-schemes/dist/schemes.js +0 -25
  1042. package/src/engine-schemes/dist/schemes.js.meta +0 -7
  1043. package/src/engine-schemes/dist/synced-camera-model.js +0 -74
  1044. package/src/engine-schemes/dist/synced-camera-model.js.meta +0 -7
  1045. package/src/engine-schemes/dist/synced-transform-model.js +0 -73
  1046. package/src/engine-schemes/dist/synced-transform-model.js.meta +0 -7
  1047. package/src/engine-schemes/dist/transform.js +0 -46
  1048. package/src/engine-schemes/dist/transform.js.meta +0 -7
  1049. package/src/engine-schemes/dist/vec2.js +0 -32
  1050. package/src/engine-schemes/dist/vec2.js.meta +0 -7
  1051. package/src/engine-schemes/dist/vec3.js +0 -36
  1052. package/src/engine-schemes/dist/vec3.js.meta +0 -7
  1053. package/src/engine-schemes/dist/vec4.js +0 -40
  1054. package/src/engine-schemes/dist/vec4.js.meta +0 -7
  1055. package/src/engine-schemes/dist/vr-user-state-buffer.js +0 -110
  1056. package/src/engine-schemes/dist/vr-user-state-buffer.js.meta +0 -7
@@ -1,1585 +1,1585 @@
1
- import { Camera, Object3D, PerspectiveCamera, Quaternion, Vector3 } from "three";
2
-
3
- import { enableSpatialConsole, isDevEnvironment, showBalloonMessage, showBalloonWarning } from "../debug/index.js";
4
- import { Context, FrameEvent } from "../engine_context.js";
5
- import { ContextEvent, ContextRegistry } from "../engine_context_registry.js";
6
- import { isDestroyed } from "../engine_gameobject.js";
7
- import { Gizmos } from "../engine_gizmos.js";
8
- import { registerFrameEventCallback, unregisterFrameEventCallback } from "../engine_lifecycle_functions_internal.js";
9
- import { getBoundingBox, getTempQuaternion, getTempVector, getWorldPosition, getWorldQuaternion, getWorldScale, setWorldPosition, setWorldQuaternion, setWorldScale } from "../engine_three_utils.js";
10
- import type { ICamera, IComponent, INeedleXRSession } from "../engine_types.js";
11
- import { delay, DeviceUtilities, getParam } from "../engine_utils.js";
12
- import { invokeXRSessionEnd, invokeXRSessionStart } from "./events.js"
13
- import { flipForwardMatrix, flipForwardQuaternion, ImplictXRRig } from "./internal.js";
14
- import { NeedleXRController } from "./NeedleXRController.js";
15
- import { NeedleXRSync } from "./NeedleXRSync.js";
16
- import { SceneTransition } from "./SceneTransition.js";
17
- import { SessionInfo, TemporaryXRContext } from "./TempXRContext.js";
18
- import { InternalUSDZRegistry } from "./usdz.js";
19
- import type { IXRRig } from "./XRRig.js";
20
-
21
- const measure_SessionStartedMarker = "NeedleXRSession onStart";
22
- const measure_SessionEndedMarker = "NeedleXRSession onEnd";
23
-
24
-
25
- /** @link https://developer.mozilla.org/en-US/docs/Web/API/XRFrame/fillPoses */
26
- declare type FillPosesFunction = (spaces: IterableIterator<XRJointSpace>, referenceSpace: XRSpace, targetArray: Float32Array) => void;
27
- declare type NeedleXRFrame = XRFrame & { fillPoses?: FillPosesFunction };
28
-
29
- /** NeedleXRSession event argument.
30
- * Use `args.xr` to access the NeedleXRSession */
31
- export type NeedleXREventArgs = { readonly xr: NeedleXRSession }
32
- export type SessionChangedEvt = (args: NeedleXREventArgs) => void;
33
- export type SessionRequestedEvent = (args: { readonly mode: XRSessionMode, readonly init: XRSessionInit }) => void;
34
- export type SessionRequestedEndEvent = (args: { readonly mode: XRSessionMode, readonly init: XRSessionInit, newSession: XRSession | null }) => void;
35
-
36
- /** Result of a XR hit-test
37
- * @property {XRHitTestResult} hit The original XRHitTestResult
38
- * @property {Vector3} position The hit position in world space
39
- * @property {Quaternion} quaternion The hit rotation in world space
40
- */
41
- export type NeedleXRHitTestResult = { readonly hit: XRHitTestResult, readonly position: Vector3, readonly quaternion: Quaternion };
42
-
43
- const debug = getParam("debugwebxr");
44
- const debugFPS = getParam("stats");
45
- let debugFPSFramesSinceLastUpdate = 0;
46
-
47
- // TODO: move this into the IComponent interface!?
48
- export interface INeedleXRSessionEventReceiver extends Pick<IComponent, "destroyed"> {
49
- get activeAndEnabled(): boolean;
50
- supportsXR?(mode: XRSessionMode): boolean;
51
- /** Called before requesting a XR session */
52
- onBeforeXR?(mode: XRSessionMode, args: XRSessionInit): void;
53
- onEnterXR?(args: NeedleXREventArgs): void;
54
- onUpdateXR?(args: NeedleXREventArgs): void;
55
- onLeaveXR?(args: NeedleXREventArgs): void;
56
- onXRControllerAdded?(args: NeedleXRControllerEventArgs): void;
57
- onXRControllerRemoved?(args: NeedleXRControllerEventArgs): void;
58
- }
59
-
60
- /** Contains a reference to the currently active webxr session and the controller that has changed */
61
- export type NeedleXRControllerEventArgs = NeedleXREventArgs & { controller: NeedleXRController, change: "added" | "removed" }
62
- /** Event Arguments when a controller changed event is invoked (added or removed)
63
- * Access the controller via `args.controller`, the `args.change` property indicates if the controller was added or removed
64
- */
65
- export type ControllerChangedEvt = (args: NeedleXRControllerEventArgs) => void;
66
-
67
-
68
-
69
- function getDOMOverlayElement(domElement: HTMLElement) {
70
- let arOverlayElement: HTMLElement | null = null;
71
- // for react cases we dont have an Engine Element
72
- const element: any = domElement;
73
- if (element.getAROverlayContainer)
74
- arOverlayElement = element.getAROverlayContainer();
75
- else arOverlayElement = domElement;
76
- return arOverlayElement;
77
- }
78
-
79
-
80
-
81
- handleSessionGranted();
82
- async function handleSessionGranted() {
83
-
84
- // TODO: asap session granted doesnt handle the pre-room yet
85
- if (getParam("debugasap")) {
86
- let asapSession = globalThis["needle:XRSession"] as XRSession | undefined | Promise<XRSession>;
87
- // @ts-ignore // getting TS2848 here, not sure why
88
- if (asapSession instanceof Promise<XRSession>) {
89
- delete globalThis["needle:XRSession"];
90
- ContextRegistry.addContextCreatedCallback(async cb => {
91
- if (!asapSession) return;
92
- // TODO: add support to pass this to the temporary room
93
- enableSpatialConsole(true);
94
- const session = await asapSession;
95
- if (session) {
96
- const sessionInit = NeedleXRSession.getDefaultSessionInit("immersive-vr");
97
- NeedleXRSession.setSession("immersive-vr", session, sessionInit, cb.context);
98
- }
99
- else {
100
- console.error("NeedleXRSession: ASAP session was rejected");
101
- }
102
- asapSession = undefined;
103
- });
104
- return;
105
- }
106
- }
107
-
108
- if ('xr' in navigator) {
109
- // WebXRViewer (based on Firefox) has a bug where addEventListener
110
- // throws a silent exception and aborts execution entirely.
111
- if (/WebXRViewer\//i.test(navigator.userAgent)) {
112
- console.warn('WebXRViewer does not support addEventListener');
113
- return;
114
- }
115
-
116
- navigator.xr?.addEventListener('sessiongranted', async () => {
117
- enableSpatialConsole(true);
118
-
119
- console.log("Received Session Granted...")
120
- await delay(100);
121
-
122
- const lastSessionMode = sessionStorage.getItem("needle_xr_session_mode") as XRSessionMode;
123
- const lastSessionInit = sessionStorage.getItem("needle_xr_session_init") ?? null;
124
- const init = lastSessionInit ? JSON.parse(lastSessionInit) : null;
125
-
126
- let info: SessionInfo | null = null;
127
- if (contextIsLoading()) {
128
- await TemporaryXRContext.start(lastSessionMode || "immersive-vr", init || NeedleXRSession.getDefaultSessionInit("immersive-vr"));
129
- await waitForContextLoadingFinished();
130
- info = await TemporaryXRContext.handoff();
131
- }
132
- if (info) {
133
- NeedleXRSession.setSession(info.mode, info.session, info.init, Context.Current);
134
- }
135
- else if (lastSessionMode && lastSessionInit) {
136
- console.log("Session Granted: Restore last session")
137
- const init = JSON.parse(lastSessionInit);
138
- NeedleXRSession.start(lastSessionMode as XRSessionMode, init).catch(e => console.warn(e));
139
- }
140
- else {
141
- // if no session was found we start VR by default
142
- NeedleXRSession.start("immersive-vr").catch(e => console.warn("Session Granted failed:", e));
143
- }
144
- // make sure we only subscribe to the event once
145
- }, { once: true });
146
-
147
- }
148
- }
149
- function saveSessionInfo(mode: XRSessionMode, init: XRSessionInit) {
150
- sessionStorage.setItem("needle_xr_session_mode", mode);
151
- sessionStorage.setItem("needle_xr_session_init", JSON.stringify(init));
152
- }
153
- function deleteSessionInfo() {
154
- sessionStorage.removeItem("needle_xr_session_mode");
155
- sessionStorage.removeItem("needle_xr_session_init");
156
- }
157
-
158
- const contexts_loading: Set<Context> = new Set();
159
- ContextRegistry.registerCallback(ContextEvent.ContextCreationStart, async cb => {
160
- contexts_loading.add(cb.context);
161
- });
162
- ContextRegistry.registerCallback(ContextEvent.ContextCreated, async cb => {
163
- contexts_loading.delete(cb.context);
164
- });
165
-
166
- function contextIsLoading() { return contexts_loading.size > 0; }
167
- function waitForContextLoadingFinished(): Promise<void> {
168
- return new Promise(res => {
169
- const startTime = Date.now();
170
- const interval = setInterval(() => {
171
- if (!contextIsLoading() || Date.now() - startTime > 60000) {
172
- clearInterval(interval);
173
- res();
174
- }
175
- }, 100);
176
- });
177
- }
178
-
179
-
180
- if (DeviceUtilities.isDesktop() && isDevEnvironment()) {
181
- window.addEventListener("keydown", (evt) => {
182
- if (evt.key === "x" || evt.key === "Escape") {
183
- if (NeedleXRSession.active) {
184
- NeedleXRSession.stop();
185
- }
186
- }
187
- });
188
- }
189
-
190
- // if (getParam("simulatewebxrloading")) {
191
- // ContextRegistry.registerCallback(ContextEvent.ContextCreationStart, async _cb => {
192
- // await delay(3000);
193
- // setTimeout(async () => {
194
- // const info = await TemporaryXRContext.handoff();
195
- // if (info) NeedleXRSession.setSession(info.mode, info.session, info.init, Context.Current);
196
- // else
197
- // NeedleXRSession.start("immersive-vr")
198
- // }, 6000)
199
- // });
200
- // let triggered = false;
201
- // window.addEventListener("click", () => {
202
- // if (triggered) return;
203
- // triggered = true;
204
- // TemporaryXRContext.start("immersive-vr", NeedleXRSession.getDefaultSessionInit("immersive-vr"));
205
- // });
206
- // }
207
-
208
- /**
209
- * This class manages an XRSession to provide helper methods and events. It provides easy access to the XRInputSources (controllers and hands)
210
- * - Start a XRSession with `NeedleXRSession.start(...)`
211
- * - Stop a XRSession with `NeedleXRSession.stop()`
212
- * - Access a running XRSession with `NeedleXRSession.active`
213
- *
214
- * If a XRSession is active you can use all XR-related event methods on your components to receive XR events e.g. `onEnterXR`, `onUpdateXR`, `onLeaveXR`
215
- * ```ts
216
- * export class MyComponent extends Behaviour {
217
- * // callback invoked whenever the XRSession is started or your component is added to a scene with an active XRSession
218
- * onEnterXR(args: NeedleXREventArgs) {
219
- * console.log("Entered XR");
220
- * // access the NeedleXRSession via args.xr
221
- * }
222
- * // callback invoked whenever a controller is added (or you switch from controller to hand tracking)
223
- * onControllerAdded(args: NeedleXRControllerEventArgs) { }
224
- * }
225
- * ```
226
- *
227
- * ### XRRig
228
- * The XRRig can be accessed via the `rig` property
229
- * Set a custom XRRig via `NeedleXRSession.addRig(...)` or `NeedleXRSession.removeRig(...)`
230
- * By default the active XRRig with the highest priority in the scene is used
231
- */
232
- export class NeedleXRSession implements INeedleXRSession {
233
-
234
- private static _sync: NeedleXRSync | null = null;
235
- static getXRSync(context: Context) {
236
- if (!this._sync) this._sync = new NeedleXRSync(context);
237
- return this._sync;
238
- }
239
-
240
- static get currentSessionRequest(): XRSessionMode | null { return this._currentSessionRequestMode; }
241
- private static _currentSessionRequestMode: XRSessionMode | null = null;
242
-
243
- /**
244
- * @returns the active @type {NeedleXRSession} (if any active) or null
245
- */
246
- static get active(): NeedleXRSession | null { return this._activeSession; }
247
- /** The active xr session mode (if any xr session is active)
248
- * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSessionMode
249
- */
250
- static get activeMode() { return this._activeSession?.mode ?? null; }
251
- /** XRSystem via navigator.xr access
252
- * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSystem
253
- */
254
- static get xrSystem(): XRSystem | undefined {
255
- return ('xr' in navigator) ? navigator.xr : undefined;
256
- }
257
- /**
258
- * @returns true if the browser supports WebXR (`immersive-vr` or `immersive-ar`)
259
- * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSystem/isSessionSupported
260
- */
261
- static isXRSupported() { return Promise.all([this.isVRSupported(), this.isARSupported()]).then(res => res.some(e => e)).catch(() => false); }
262
- /**
263
- * @returns true if the browser supports immersive-vr (WebXR)
264
- * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSystem/isSessionSupported
265
- */
266
- static isVRSupported() { return this.isSessionSupported("immersive-vr"); }
267
- /**
268
- * @returns true if the browser supports immersive-ar (WebXR)
269
- * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSystem/isSessionSupported
270
- */
271
- static isARSupported() { return this.isSessionSupported("immersive-ar"); }
272
- /**
273
- * @param mode The XRSessionMode to check if it is supported
274
- * @returns true if the browser supports the given XRSessionMode
275
- */
276
- static isSessionSupported(mode: XRSessionMode) { return this.xrSystem?.isSessionSupported(mode).catch(err => { if (debug) console.error(err); return false }) ?? Promise.resolve(false); }
277
-
278
- private static _currentSessionRequest?: Promise<XRSession>;
279
- private static _activeSession: NeedleXRSession | null;
280
-
281
- /** Register to listen to XRSession start events. Unsubscribe with `offXRSessionStart` */
282
- static onSessionRequestStart(evt: SessionRequestedEvent) {
283
- this._sessionRequestStartListeners.push(evt);
284
- }
285
- /** Unsubscribe from request start evt. Register with `onSessionRequestStart` */
286
- static offSessionRequestStart(evt: SessionRequestedEvent) {
287
- const index = this._sessionRequestStartListeners.indexOf(evt);
288
- if (index >= 0) this._sessionRequestStartListeners.splice(index, 1);
289
- }
290
- private static readonly _sessionRequestStartListeners: SessionRequestedEvent[] = [];
291
-
292
- /** Called after the session request has finished */
293
- static onSessionRequestEnd(evt: SessionRequestedEndEvent) {
294
- this._sessionRequestEndListeners.push(evt);
295
- }
296
- /** Unsubscribe from request end evt */
297
- static offSessionRequestEnd(evt: SessionRequestedEndEvent) {
298
- const index = this._sessionRequestEndListeners.indexOf(evt);
299
- if (index >= 0) this._sessionRequestEndListeners.splice(index, 1);
300
- }
301
- private static readonly _sessionRequestEndListeners: SessionRequestedEndEvent[] = [];
302
-
303
- /** Listen to XR session started. Unsubscribe with `offXRSessionStart` */
304
- static onXRSessionStart(evt: SessionChangedEvt) {
305
- this._xrStartListeners.push(evt);
306
- };
307
- /** Unsubscribe from XRSession started events */
308
- static offXRSessionStart(evt: SessionChangedEvt) {
309
- const index = this._xrStartListeners.indexOf(evt);
310
- if (index >= 0) this._xrStartListeners.splice(index, 1);
311
- }
312
- private static readonly _xrStartListeners: SessionChangedEvt[] = [];
313
-
314
- /** Listen to XR session ended. Unsubscribe with `offXRSessionEnd` */
315
- static onXRSessionEnd(evt: SessionChangedEvt) {
316
- this._xrEndListeners.push(evt);
317
- };
318
- /** Unsubscribe from XRSession started events */
319
- static offXRSessionEnd(evt: SessionChangedEvt) {
320
- const index = this._xrEndListeners.indexOf(evt);
321
- if (index >= 0) this._xrEndListeners.splice(index, 1);
322
- }
323
- private static readonly _xrEndListeners: SessionChangedEvt[] = [];
324
-
325
- /** Listen to controller added events.
326
- * Events are cleared when starting a new session
327
- **/
328
- static onControllerAdded(evt: ControllerChangedEvt) {
329
- this._controllerAddedListeners.push(evt);
330
- }
331
- /** Unsubscribe from controller added evts */
332
- static offControllerAdded(evt: ControllerChangedEvt) {
333
- const index = this._controllerAddedListeners.indexOf(evt);
334
- if (index >= 0) this._controllerAddedListeners.splice(index, 1);
335
- }
336
- private static readonly _controllerAddedListeners: ControllerChangedEvt[] = [];
337
-
338
- /** Listen to controller removed events
339
- * Events are cleared when starting a new session
340
- **/
341
- static onControllerRemoved(evt: ControllerChangedEvt) {
342
- this._controllerRemovedListeners.push(evt);
343
- }
344
- /** Unsubscribe from controller removed events */
345
- static offControllerRemoved(evt: ControllerChangedEvt) {
346
- const index = this._controllerRemovedListeners.indexOf(evt);
347
- if (index >= 0) this._controllerRemovedListeners.splice(index, 1);
348
- }
349
- private static readonly _controllerRemovedListeners: ControllerChangedEvt[] = [];
350
-
351
- /** If the browser supports offerSession - creating a VR or AR button in the browser navigation bar */
352
- static offerSession(mode: XRSessionMode, init: XRSessionInit | "default", context: Context): boolean {
353
- if ('xr' in navigator && navigator.xr && 'offerSession' in navigator.xr) {
354
- if (typeof navigator.xr.offerSession === "function") {
355
- console.log("WebXR offerSession is available - requesting mode: " + mode);
356
- if (init == "default") {
357
- init = this.getDefaultSessionInit(mode);
358
- }
359
- navigator.xr.offerSession(mode, {
360
- ...init
361
- }).then((session) => {
362
- return NeedleXRSession.setSession(mode, session, init as XRSessionInit, context);
363
- }).catch(_ => {
364
- console.log("XRSession offer rejected (perhaps because another call to offerSession was made or a call to requestSession was made)")
365
- });
366
- }
367
- return true;
368
- }
369
- return false;
370
- }
371
-
372
- /** @returns a new XRSession init object with defaults */
373
- static getDefaultSessionInit(mode: Omit<XRSessionMode, "inline">): XRSessionInit {
374
- switch (mode) {
375
- case "immersive-ar":
376
- const arFeatures = ['anchors', 'local-floor', 'layers', 'dom-overlay', 'hit-test', 'unbounded'];
377
- // Don't request handtracking by default on VisionOS
378
- if (!DeviceUtilities.isVisionOS())
379
- arFeatures.push('hand-tracking');
380
- return {
381
- optionalFeatures: arFeatures,
382
- }
383
- case "immersive-vr":
384
- const vrFeatures = ['local-floor', 'bounded-floor', 'high-fixed-foveation-level', 'layers'];
385
- // Don't request handtracking by default on VisionOS
386
- if (!DeviceUtilities.isVisionOS())
387
- vrFeatures.push('hand-tracking');
388
- return {
389
- optionalFeatures: vrFeatures,
390
- }
391
- default:
392
- console.warn("No default session init for mode", mode);
393
- return {};
394
- }
395
- }
396
-
397
- /** start a new webXR session (make sure to stop already running sessions before calling this method)
398
- * @param mode The XRSessionMode to start (e.g. `immersive-vr` or `immersive-ar`) or `ar` to start `immersive-ar` on supported devices OR on iOS devices it will export an interactive USDZ and open in Quicklook.
399
- * Get more information about WebXR modes: https://developer.mozilla.org/en-US/docs/Web/API/XRSessionMode
400
- * @param init The XRSessionInit to use (optional), docs: https://developer.mozilla.org/en-US/docs/Web/API/XRSessionInit
401
- * @param context The Needle Engine context to use
402
- */
403
- static async start(mode: XRSessionMode | "ar", init?: XRSessionInit, context?: Context): Promise<NeedleXRSession | null> {
404
-
405
- // handle iOS platform where "immersive-ar" is not supported
406
- // TODO: should we add a separate mode (e.g. "AR")? https://linear.app/needle/issue/NE-5303
407
- if (DeviceUtilities.isiOS()) {
408
- if (mode === "ar") {
409
- const arSupported = await this.isARSupported();
410
- if (!arSupported) {
411
- InternalUSDZRegistry.exportAndOpen();
412
- return null;
413
- }
414
- else {
415
- mode = "immersive-ar";
416
- }
417
- }
418
- }
419
- else if (mode == "ar") {
420
- mode = "immersive-ar";
421
- }
422
-
423
-
424
-
425
- if (isDevEnvironment() && getParam("debugxrpreroom")) {
426
- console.warn("Debug: Starting temporary XR session");
427
- await TemporaryXRContext.start(mode, init || NeedleXRSession.getDefaultSessionInit(mode));
428
- return null;
429
- }
430
-
431
- if (this._currentSessionRequest) {
432
- console.warn("A XRSession is already being requested");
433
- if (debug || isDevEnvironment()) showBalloonWarning("A XRSession is already being requested");
434
- return this._currentSessionRequest.then(() => this._activeSession!);
435
- }
436
-
437
- if (this._activeSession) {
438
- console.error("A XRSession is already running");
439
- return this._activeSession;
440
- }
441
-
442
- // Make sure we have a context
443
- if (!context) context = Context.Current;
444
- if (!context) context = ContextRegistry.All[0] as Context;
445
- if (!context) throw new Error("No Needle Engine Context found");
446
-
447
- performance.mark('NeedleXRSession start');
448
-
449
- // setup session init args, make sure we have default values
450
- if (!init) init = {};
451
-
452
- switch (mode) {
453
-
454
- // Setup VR initialization parameters
455
- case "immersive-ar":
456
- {
457
- const supported = await this.xrSystem?.isSessionSupported('immersive-ar')
458
- if (supported !== true) {
459
- console.error(mode + ' is not supported by this browser.');
460
- return null;
461
- }
462
- const defaultInit: XRSessionInit = this.getDefaultSessionInit(mode);
463
- const domOverlayElement = getDOMOverlayElement(context.domElement);
464
- if (domOverlayElement && !DeviceUtilities.isQuest()) { // excluding quest since dom-overlay breaks sessiongranted
465
- defaultInit.domOverlay = { root: domOverlayElement };
466
- defaultInit.optionalFeatures!.push('dom-overlay');
467
- }
468
- init = {
469
- ...defaultInit,
470
- ...init,
471
- }
472
- }
473
- break;
474
-
475
- // Setup AR initialization parameters
476
- case "immersive-vr":
477
- {
478
- const supported = await this.xrSystem?.isSessionSupported('immersive-vr')
479
- if (supported !== true) {
480
- console.error(mode + ' is not supported by this browser.');
481
- return null;
482
- }
483
- const defaultInit: XRSessionInit = this.getDefaultSessionInit(mode);
484
- init = {
485
- ...defaultInit,
486
- ...init,
487
- }
488
- }
489
- break;
490
-
491
- default:
492
- console.warn("No default session init for mode", mode);
493
- break;
494
- }
495
-
496
- // Fix: define these here because VariantLauncher crashes otherwise. Spec: https://immersive-web.github.io/webxr/#feature-dependencies
497
- // Issue: https://linear.app/needle/issue/NE-5136
498
- init.optionalFeatures ??= [];
499
- init.requiredFeatures ??= [];
500
-
501
- // we stop a temporary session here (if any runs)
502
- await TemporaryXRContext.stop();
503
-
504
- const scripts = mode == "immersive-ar" ? context.scripts_immersive_ar : context.scripts_immersive_vr
505
-
506
- if (debug)
507
- console.log("%c" + `Requesting ${mode} session`, "font-weight:bold;", init, scripts);
508
- else
509
- console.log("%c" + `Requesting ${mode} session`, "font-weight:bold;");
510
- for (const script of scripts) {
511
- if (script.onBeforeXR) script.onBeforeXR(mode, init);
512
- }
513
- for (const listener of this._sessionRequestStartListeners) {
514
- listener({ mode, init });
515
- }
516
- if (debug) showBalloonMessage("Requesting " + mode + " session (" + Date.now() + ")");
517
- this._currentSessionRequest = navigator.xr?.requestSession(mode, init);
518
- this._currentSessionRequestMode = mode;
519
- /**@type {XRSystem} */
520
- const newSession = await (this._currentSessionRequest)?.catch(e => {
521
- console.error(e, "Code: " + e.code);
522
- if (e.code === 9) showBalloonWarning("Make sure your device has the required permissions (e.g. camera access)")
523
- console.log("If the specified XR configuration is not supported (e.g. entering AR doesnt work) - make sure you access the website on a secure connection (HTTPS) and your device has the required permissions (e.g. camera access)");
524
- const notSecure = location.protocol === 'http:';
525
- if (notSecure) showBalloonWarning("XR requires a secure connection (HTTPS)");
526
- });
527
- this._currentSessionRequest = undefined;
528
- this._currentSessionRequestMode = null;
529
- for (const listener of this._sessionRequestEndListeners) {
530
- listener({ mode, init, newSession: newSession || null });
531
- }
532
- if (!newSession) {
533
- console.warn("XR Session request was rejected");
534
- return null;
535
- }
536
- const session = this.setSession(mode, newSession, init, context);
537
- performance.mark('NeedleXRSession end');
538
- performance.measure('NeedleXRSession Startup', 'NeedleXRSession start', 'NeedleXRSession end');
539
- return session;
540
- }
541
-
542
- static setSession(mode: XRSessionMode, session: XRSession, init: XRSessionInit, context: Context) {
543
- if (this._activeSession) {
544
- console.error("A XRSession is already running");
545
- return this._activeSession;
546
- }
547
- const scripts = mode == "immersive-ar" ? context.scripts_immersive_ar : context.scripts_immersive_vr;
548
- this._activeSession = new NeedleXRSession(mode, session, context, {
549
- scripts: scripts,
550
- controller_added: this._controllerAddedListeners,
551
- controller_removed: this._controllerRemovedListeners,
552
- init: init
553
- });
554
- session.addEventListener("end", this.onEnd);
555
- if (debug)
556
- console.log("%c" + `Started ${mode} session`, "font-weight:bold;", scripts);
557
- else
558
- console.log("%c" + `Started ${mode} session`, "font-weight:bold;");
559
- return this._activeSession;
560
- }
561
- /** stops the active XR session */
562
- static stop() {
563
- this._activeSession?.end();
564
- }
565
- private static onEnd = () => {
566
- if (debug) console.log("XR Session ended");
567
- this._activeSession = null;
568
- }
569
-
570
-
571
- /** The needle engine context this session was started from */
572
- readonly context: Context;
573
-
574
- get sync(): NeedleXRSync | null {
575
- return NeedleXRSession._sync;
576
- }
577
-
578
- /** Returns true if the xr session is still active */
579
- get running(): boolean { return !this._ended && this.session != null; }
580
-
581
- /**
582
- * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSession
583
- */
584
- readonly session: XRSession;
585
-
586
- /** XR Session Mode: AR or VR */
587
- readonly mode: XRSessionMode;
588
-
589
- /**
590
- * The XRSession interface's read-only interactionMode property describes the best space (according to the user agent) for the application to draw an interactive UI for the current session.
591
- * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSession/interactionMode
592
- */
593
- get interactionMode(): "screen-space" | "world-space" { return this.session["interactionMode"]!; }
594
-
595
- /**
596
- * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSession/visibilityState
597
- * @returns {XRVisibilityState} The visibility state of the XRSession
598
- */
599
- get visibilityState(): XRVisibilityState { return this.session.visibilityState; }
600
-
601
- /**
602
- * Check if the session is `visible-blurred` - this means e.g. the keyboard is shown
603
- */
604
- get isVisibleBlurred(): boolean { return this.session.visibilityState === 'visible-blurred' }
605
-
606
- /**
607
- * Check if the session has system keyboard support
608
- */
609
- get isSystemKeyboardSupported(): boolean { return this.session.isSystemKeyboardSupported; }
610
-
611
- /**
612
- * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSession/environmentBlendMode
613
- */
614
- get environmentBlendMode(): XREnvironmentBlendMode { return this.session.environmentBlendMode; }
615
-
616
- /**
617
- * The current XR frame
618
- * @link https://developer.mozilla.org/en-US/docs/Web/API/XRFrame
619
- */
620
- get frame(): NeedleXRFrame { return this.context.xrFrame! as NeedleXRFrame; }
621
-
622
- /** The currently active/connected controllers */
623
- readonly controllers: NeedleXRController[] = [];
624
- /** shorthand to query the left controller. Use `controllers` to get access to all connected controllers */
625
- get leftController() { return this.controllers.find(c => c.side === "left"); }
626
- /** shorthand to query the right controller. Use `controllers` to get access to all connected controllers */
627
- get rightController() { return this.controllers.find(c => c.side === "right"); }
628
- /** @returns the given controller if it is connected */
629
- getController(side: XRHandedness | number) {
630
- if (typeof side === "number") return this.controllers[side] || null;
631
- return this.controllers.find(c => c.side === side) || null;
632
- }
633
-
634
- /** Returns true if running in pass through mode in immersive AR (e.g. user is wearing a headset while in AR) */
635
- get isPassThrough() {
636
- if (this.environmentBlendMode !== 'opaque' && this.interactionMode === "world-space") return true;
637
- // since we can not rely on interactionMode check we check the controllers too
638
- // https://linear.app/needle/issue/NE-4057
639
- // the following is a workaround for the issue above
640
- if (this.mode === "immersive-ar" && this.environmentBlendMode !== 'opaque') {
641
- // if we have any tracked pointer controllers we're also in passthrough
642
- if (this.controllers.some(c => c.inputSource.targetRayMode === "tracked-pointer"))
643
- return true;
644
- }
645
- if (isDevEnvironment() && DeviceUtilities.isDesktop() && this.mode === "immersive-ar") {
646
- return true;
647
- }
648
- return false;
649
- }
650
- get isAR() { return this.mode === 'immersive-ar'; }
651
- get isVR() { return this.mode === 'immersive-vr'; }
652
- /** If the AR mode is not immersive (meaning the user is e.g. holding a phone instead of wearing a AR passthrough headset) */
653
- get isScreenBasedAR() { return this.isAR && !this.isPassThrough; }
654
-
655
- get posePosition() { return this._transformPosition; }
656
- get poseOrientation() { return this._transformOrientation; }
657
- /** @returns the context.renderer.xr.getReferenceSpace() result */
658
- get referenceSpace(): XRSpace | null { return this.context.renderer.xr.getReferenceSpace(); }
659
- /** @returns the XRFrame `viewerpose` using the xr `referenceSpace` */
660
- get viewerPose(): XRViewerPose | undefined { return this._viewerPose; }
661
-
662
-
663
- /** @returns `true` if any image is currently being tracked */
664
- /** returns true if images are currently being tracked */
665
- get isTrackingImages() {
666
- if (this.frame && "getImageTrackingResults" in this.frame && typeof this.frame.getImageTrackingResults === "function") {
667
- try {
668
- const trackingResult = this.frame.getImageTrackingResults();
669
- for (const result of trackingResult) {
670
- const state = result.trackingState;
671
- if (state === "tracked") return true;
672
- }
673
- }
674
- catch {
675
- // Looks like we get a NotSupportedException on Android since the method is known
676
- // but the feature is not supported by the session
677
- // TODO Can we check here if we even requested the image-tracking feature instead of catching?
678
- return false;
679
- }
680
- }
681
- return false;
682
- }
683
-
684
-
685
- /** The currently active XR rig */
686
- get rig(): IXRRig | null {
687
- const rig = this._rigs[0] ?? null;
688
- if (rig?.gameObject && isDestroyed(rig.gameObject) || rig?.isActive === false) {
689
- this.updateActiveXRRig();
690
- return this._rigs[0] ?? null;
691
- }
692
- return rig;
693
- }
694
- private _rigScale: number = 1;
695
- private _lastRigScaleUpdate: number = -1;
696
-
697
- /** Get the XR Rig worldscale.
698
- *
699
- * **For AR**
700
- * If you want to modify the scale in AR at runtime get the WebARSessionRoot component via `findObjectOfType(WebARSessionRoot)` and then set the `arScale` value.
701
- *
702
- */
703
- get rigScale() {
704
- if (!this._rigs[0]) return 1;
705
- if (this._lastRigScaleUpdate !== this.context.time.frame) {
706
- this._lastRigScaleUpdate = this.context.time.frame;
707
- this._rigScale = this._rigs[0].gameObject.worldScale.x;
708
- }
709
- return this._rigScale;
710
- }
711
- /** add a rig to the available XR rigs - if it's priority is higher than the currently active rig it will be enabled */
712
- addRig(rig: IXRRig) {
713
- const i = this._rigs.indexOf(rig);
714
- if (i >= 0) return;
715
- if (rig.priority === undefined) rig.priority = 0;
716
- this._rigs.push(rig);
717
- this.updateActiveXRRig();
718
- }
719
- /** Remove a rig from the available XR Rigs */
720
- removeRig(rig: IXRRig) {
721
- const i = this._rigs.indexOf(rig);
722
- if (i === -1) return;
723
- this._rigs.splice(i, 1);
724
- this.updateActiveXRRig();
725
- }
726
- /** Sets a XRRig to be active which will parent the camera to this rig */
727
- setRigActive(rig: IXRRig) {
728
- const i = this._rigs.indexOf(rig);
729
- const currentlyActive = this._rigs[0];
730
- this._rigs.splice(i, 1);
731
- this._rigs.unshift(rig);
732
- // if there's another rig currently active we need to make sure we have at least the same priority
733
- rig.priority = currentlyActive?.priority ?? 0;
734
- this.updateActiveXRRig();
735
- }
736
- /**
737
- * @returns the user position in the rig space
738
- */
739
- getUserOffsetInRig() {
740
- const positionInRig = this.context.mainCamera?.position;
741
- if (!positionInRig || !this.rig) return getTempVector(0, 0, 0);
742
- const vec = getTempVector(positionInRig);
743
- vec.x *= -1;
744
- vec.z *= -1;
745
- vec.applyQuaternion(getTempQuaternion(this.rig.gameObject.quaternion));
746
- return vec;
747
- }
748
- private updateActiveXRRig() {
749
- const previouslyActiveRig = this._rigs[0] ?? null;
750
-
751
- // ensure that the default rig is in the scene
752
- if (this._defaultRig.gameObject.parent !== this.context.scene)
753
- this.context.scene.add(this._defaultRig.gameObject);
754
- // ensure the fallback rig is always active!!!
755
- this._defaultRig.gameObject.visible = true;
756
- // ensure that the default rig is in the list of available rigs
757
- if (!this._rigs.includes(this._defaultRig))
758
- this._rigs.push(this._defaultRig);
759
-
760
- // find the rig with the highest priority and make sure it's at the beginning of the array
761
- let highestPriorityRig: IXRRig = this._rigs[0];
762
- if (highestPriorityRig && highestPriorityRig.priority === undefined) highestPriorityRig.priority = 0;
763
-
764
- for (let i = 1; i < this._rigs.length; i++) {
765
- const rig = this._rigs[i];
766
- if (!rig.isActive) continue;
767
- if (isDestroyed(rig.gameObject)) {
768
- this._rigs.splice(i, 1);
769
- i--;
770
- continue;
771
- }
772
- if (!highestPriorityRig || highestPriorityRig.isActive === false || (rig.priority !== undefined && rig.priority > highestPriorityRig.priority!)) {
773
- highestPriorityRig = rig;
774
- }
775
- }
776
-
777
- // make sure the highest priority rig is at the beginning if it isnt already
778
- if (previouslyActiveRig !== highestPriorityRig) {
779
- const index = this._rigs.indexOf(highestPriorityRig);
780
- if (index >= 0) this._rigs.splice(index, 1);
781
- this._rigs.unshift(highestPriorityRig);
782
- }
783
-
784
- if (debug) {
785
- if (previouslyActiveRig === highestPriorityRig)
786
- console.log("Updated Active XR Rig:", highestPriorityRig, "prev:", previouslyActiveRig);
787
- else console.log("Updated Active XRRig:", highestPriorityRig, " (the same as before)");
788
- }
789
- }
790
- private _rigs: IXRRig[] = [];
791
-
792
-
793
-
794
- private _viewerHitTestSource: XRHitTestSource | null = null;
795
-
796
- /** Returns a XR hit test result (if hit-testing is available) in rig space
797
- * @param source If provided, the hit test will be performed for the given controller
798
- */
799
- getHitTest(source?: NeedleXRController): NeedleXRHitTestResult | null {
800
- if (source) {
801
- return this.getControllerHitTest(source);
802
- }
803
-
804
- if (!this._viewerHitTestSource) return null;
805
- const hitTestSource = this._viewerHitTestSource;
806
- const hitTestResults = this.frame.getHitTestResults(hitTestSource);
807
- if (hitTestResults.length > 0) {
808
- const hit = hitTestResults[0];
809
- return this.convertHitTestResult(hit);
810
- }
811
- return null;
812
- }
813
- private getControllerHitTest(controller: NeedleXRController): NeedleXRHitTestResult | null {
814
- const hitTestSource = controller.getHitTestSource();
815
- if (!hitTestSource) return null;
816
- const res = this.frame.getHitTestResultsForTransientInput(hitTestSource);
817
- for (const result of res) {
818
- if (result.inputSource === controller.inputSource) {
819
- for (const hit of result.results) {
820
- return this.convertHitTestResult(hit);
821
- }
822
- }
823
- }
824
- return null;
825
- }
826
- private convertHitTestResult(result: XRHitTestResult): NeedleXRHitTestResult | null {
827
- const referenceSpace = this.context.renderer.xr.getReferenceSpace();
828
- const pose = referenceSpace && result.getPose(referenceSpace);
829
- if (pose) {
830
- const pos = getTempVector(pose.transform.position);
831
- const rot = getTempQuaternion(pose.transform.orientation);
832
- const camera = this.context.mainCamera;
833
- if (camera?.parent !== this._cameraRenderParent) {
834
- pos.applyMatrix4(flipForwardMatrix);
835
- }
836
- if (camera?.parent) {
837
- pos.applyMatrix4(camera.parent.matrixWorld);
838
- rot.multiply(flipForwardQuaternion);
839
- // apply parent quaternion (if parent is moved/rotated)
840
- const parentRotation = getWorldQuaternion(camera.parent);
841
- // ensure that "up" (y+) is pointing away from the wall
842
- parentRotation.premultiply(flipForwardQuaternion);
843
- rot.premultiply(parentRotation);
844
- }
845
- return { hit: result, position: pos, quaternion: rot };
846
- }
847
- return null;
848
- }
849
-
850
-
851
- /** convert a XRRigidTransform from XR session space to threejs / Needle Engine XR space */
852
- convertSpace(transform: XRRigidTransform): { position: Vector3, quaternion: Quaternion } {
853
- const pos = getTempVector(transform.position);
854
- pos.applyMatrix4(flipForwardMatrix);
855
- const rot = getTempQuaternion(transform.orientation);
856
- rot.premultiply(flipForwardQuaternion);
857
- return { position: pos, quaternion: rot };
858
- }
859
-
860
- /** this is the implictly created XR rig */
861
- private readonly _defaultRig: IXRRig;
862
-
863
- /** all scripts that receive some sort of XR update event */
864
- private readonly _xr_scripts: INeedleXRSessionEventReceiver[];
865
- /** scripts that have onUpdateXR event methods */
866
- private readonly _xr_update_scripts: INeedleXRSessionEventReceiver[] = [];
867
- /** scripts that are in the scene but inactive (e.g. disabled parent gameObject) */
868
- private readonly _inactive_scripts: INeedleXRSessionEventReceiver[] = [];
869
- private readonly _controllerAdded: ControllerChangedEvt[];
870
- private readonly _controllerRemoved: ControllerChangedEvt[];
871
- private readonly _originalCameraWorldPosition?: Vector3 | null;
872
- private readonly _originalCameraWorldRotation?: Quaternion | null;
873
- private readonly _originalCameraWorldScale?: Vector3 | null;
874
- private readonly _originalCameraParent?: Object3D | null;
875
- /** we store the main camera reference here each frame to make sure we have a rendering camera
876
- * this e.g. the case when the XR rig with the camera gets disabled (and thus this.context.mainCamera is unassigned)
877
- */
878
- private _mainCamera: ICamera | null = null;
879
-
880
- private constructor(mode: XRSessionMode, session: XRSession, context: Context, extra: {
881
- scripts: INeedleXRSessionEventReceiver[],
882
- controller_added: ControllerChangedEvt[],
883
- controller_removed: ControllerChangedEvt[],
884
- /** the initialization arguments */
885
- init: XRSessionInit,
886
- }) {
887
- performance.mark(measure_SessionStartedMarker);
888
-
889
- saveSessionInfo(mode, extra.init);
890
- this.session = session;
891
- this.mode = mode;
892
- this.context = context;
893
-
894
-
895
- if (debug || getParam("console")) enableSpatialConsole(true);
896
-
897
- this._xr_scripts = [...extra.scripts];
898
- this._xr_update_scripts = this._xr_scripts.filter(e => typeof e.onUpdateXR === "function");
899
- this._controllerAdded = extra.controller_added;
900
- this._controllerRemoved = extra.controller_removed;
901
-
902
- registerFrameEventCallback(this.onBefore, FrameEvent.LateUpdate);
903
- this.context.pre_render_callbacks.push(this.onBeforeRender);
904
- this.context.post_render_callbacks.push(this.onAfterRender);
905
-
906
-
907
- if (extra.init.optionalFeatures?.includes("hit-test") || extra.init.requiredFeatures?.includes("hit-test")) {
908
- session.requestReferenceSpace('viewer').then((referenceSpace) => {
909
- return session.requestHitTestSource?.call(session, { space: referenceSpace })?.then((source) => {
910
- return this._viewerHitTestSource = source;
911
- }).catch(e => console.error(e));
912
- }).catch(e => console.error(e));
913
- }
914
-
915
- if (this.context.mainCamera) {
916
- this._originalCameraWorldPosition = getWorldPosition(this.context.mainCamera, new Vector3());
917
- this._originalCameraWorldRotation = getWorldQuaternion(this.context.mainCamera, new Quaternion());
918
- this._originalCameraWorldScale = getWorldScale(this.context.mainCamera, new Vector3());
919
- this._originalCameraParent = this.context.mainCamera.parent;
920
- }
921
-
922
- this._defaultRig = new ImplictXRRig();
923
- this.context.scene.add(this._defaultRig.gameObject);
924
- this.addRig(this._defaultRig);
925
-
926
- // register already connected input sources
927
- // this is for when the session is already running (via a temporary xr session)
928
- // and the controllers are already connected
929
- for (let i = 0; i < session.inputSources.length; i++) {
930
- const inputSource = session.inputSources[i];
931
- if (!inputSource.handedness) {
932
- console.warn("Input source in xr session has no handedness - ignoring", i);
933
- continue;
934
- }
935
- this.onInputSourceAdded(inputSource);
936
- }
937
-
938
- // handle controller and input source changes changes
939
- this.session.addEventListener('end', this.onEnd);
940
- // handle input sources change
941
- this.session.addEventListener("inputsourceschange",
942
- /* @ts-ignore (ignore CI XRInputSourceChangeEvent mismatch) */
943
- (evt: XRInputSourcesChangeEvent) => {
944
- // handle removed controllers
945
- for (const removedInputSource of evt.removed) {
946
- this.disconnectInputSource(removedInputSource);
947
- }
948
- for (const newInputSource of evt.added) {
949
- this.onInputSourceAdded(newInputSource);
950
- }
951
- });
952
-
953
- // Unfortunately the code below doesnt work: the session never receives any input sources sometimes
954
- // https://developer.mozilla.org/en-US/docs/Web/API/XRSession/visibilitychange_event
955
- // this.session.addEventListener("visibilitychange", (evt: XRSessionEvent) => {
956
- // // sometimes when entering an XR session the controllers are not added/not in the list and we don't receive an event
957
- // // this is a workaround trying to add controllers when the scene visibility changes to "visible"
958
- // // e.g. due to a user opening and closing the menu
959
- // if (this.controllers.length === 0 && evt.session.visibilityState === "visible") {
960
- // for (const controller of evt.session.inputSources) {
961
- // this.onInputSourceAdded(controller);
962
- // }
963
- // }
964
- // })
965
-
966
- // we set the session on the webxr manager at the end because we want to receive inputsource events first
967
- // e.g. in case there's a bug in the threejs codebase
968
- this.context.xr = this;
969
- this.context.renderer.xr.setSession(this.session).then(this.onRendererSessionSet);
970
- // disable three.js renderer controller autoUpdate (added in ac67b31e3548386f8a93e23a4176554c92bbd0d9)
971
- if ("controllerAutoUpdate" in this.context.renderer.xr) {
972
- console.debug("Disabling three.js controllerAutoUpdate");
973
- this.context.renderer.xr.controllerAutoUpdate = false;
974
- }
975
- else if (debug) {
976
- console.warn("controllerAutoUpdate is not available in three.js - cannot disable it");
977
- }
978
- }
979
-
980
- /** called when renderer.setSession is fulfilled */
981
- private onRendererSessionSet = () => {
982
- if (!this.running) return;
983
- this.context.renderer.xr.enabled = true;
984
- // calling update camera here once to prevent the xr camera left/right NaN in the first frame due to false near/far plane values, see NE-4126
985
- this.context.renderer.xr.updateCamera(this.context.mainCamera as PerspectiveCamera);
986
- this.context.mainCameraComponent?.applyClearFlags();
987
- }
988
-
989
- private onInputSourceAdded = (newInputSource: XRInputSource) => {
990
- // do not create XR controllers for screen input sources
991
- if (newInputSource.targetRayMode === "screen") {
992
- return;
993
- }
994
- let index = 0;
995
- for (let i = 0; i < this.session.inputSources.length; i++) {
996
- if (this.session.inputSources[i] === newInputSource) {
997
- index = i;
998
- break;
999
- }
1000
- }
1001
- // check if an xr controller for this input source already exists
1002
- // in case we have both an event from inputsourceschange and from the construtor initial input sources
1003
- if (this.controllers.find(c => c.inputSource === newInputSource)) {
1004
- console.debug("Controller already exists for input source", index);
1005
- return;
1006
- }
1007
- else if(this._newControllers.find(c => c.inputSource === newInputSource)) {
1008
- console.debug("Controller already registered for input source", index);
1009
- return;
1010
- }
1011
- // TODO: check if this is a transient input source AND we can figure out which existing controller it likely belongs to
1012
- // TODO: do not draw raycasts for controllers that don't have primary input actions / until we know that they have primary input actions
1013
- const newController = new NeedleXRController(this, newInputSource, index);
1014
- this._newControllers.push(newController);
1015
- }
1016
-
1017
- /** Disconnects the controller, invokes events and notifies previou controller (if any) */
1018
- private disconnectInputSource(inputSource: XRInputSource) {
1019
- const handleRemove = (oldController: NeedleXRController, _array: Array<NeedleXRController>, i: number) => {
1020
- if (oldController.inputSource === inputSource) {
1021
- if (debug) console.log("Disconnecting controller", oldController.index);
1022
- this.controllers.splice(i, 1);
1023
- this.invokeControllerEvent(oldController, this._controllerRemoved, "removed");
1024
- const args: NeedleXRControllerEventArgs = {
1025
- xr: this,
1026
- controller: oldController,
1027
- change: "removed"
1028
- };
1029
- for (const script of this._xr_scripts) {
1030
- if (script.onXRControllerRemoved) script.onXRControllerRemoved(args);
1031
- }
1032
- oldController.onDisconnected();
1033
- }
1034
- }
1035
- for (let i = this.controllers.length - 1; i >= 0; i--) {
1036
- const oldController = this.controllers[i];
1037
- handleRemove(oldController, this.controllers, i);
1038
- }
1039
- for (let i = this._newControllers.length - 1; i >= 0; i--) {
1040
- const oldController = this._newControllers[i];
1041
- handleRemove(oldController, this._newControllers, i);
1042
- }
1043
- }
1044
-
1045
- /** End the XR Session */
1046
- end() {
1047
- // this can be called by external code to end the session
1048
- // the actual cleanup happens in onEnd which subscribes to the session end event
1049
- // so users can also just regularly call session.end() and the cleanup will happen automatically
1050
- if (this._ended) return;
1051
- this.session.end().catch(e => console.warn(e));
1052
- }
1053
-
1054
- private _ended: boolean = false;
1055
- private readonly _newControllers: NeedleXRController[] = [];
1056
-
1057
- private onEnd = (_evt: XRSessionEvent) => {
1058
- if (this._ended) return;
1059
- this._ended = true;
1060
-
1061
- console.debug("XR Session ended");
1062
-
1063
- deleteSessionInfo();
1064
-
1065
- this.onAfterRender();
1066
- this.revertCustomForward();
1067
- this._didStart = false;
1068
- this._previousCameraParent = null;
1069
-
1070
- unregisterFrameEventCallback(this.onBefore, FrameEvent.LateUpdate);
1071
- const index = this.context.pre_render_callbacks.indexOf(this.onBeforeRender);
1072
- if (index >= 0) this.context.pre_render_callbacks.splice(index, 1);
1073
- const index2 = this.context.post_render_callbacks.indexOf(this.onAfterRender);
1074
- if (index2 >= 0) this.context.post_render_callbacks.splice(index2, 1);
1075
-
1076
- this.context.xr = null;
1077
- this.context.renderer.xr.enabled = false;
1078
- // apply the clearflags at the beginning of the next frame
1079
- this.context.pre_update_oneshot_callbacks.push(() => {
1080
- this.context.mainCameraComponent?.applyClearFlags()
1081
- this.context.mainCameraComponent?.applyClippingPlane();
1082
- });
1083
-
1084
- invokeXRSessionEnd({ session: this });
1085
-
1086
- for (const listener of NeedleXRSession._xrEndListeners) {
1087
- listener({ xr: this });
1088
- }
1089
-
1090
- // make sure we disconnect all controllers
1091
- // we copy the array because the disconnectInputSource method modifies the controllers array
1092
- const copy = [...this.controllers];
1093
- for (let i = 0; i < copy.length; i++) {
1094
- this.disconnectInputSource(copy[i].inputSource);
1095
- }
1096
- this._newControllers.length = 0;
1097
- this.controllers.length = 0;
1098
-
1099
- // we want to call leave XR for *all* scripts that are still registered
1100
- // even if they might already be destroyed e.g. by the WebXR component (it destroys the default controller scripts)
1101
- // they should still receive this callback to be properly cleaned up
1102
- for (const listener of this._xr_scripts) {
1103
- listener?.onLeaveXR?.({ xr: this });
1104
- }
1105
-
1106
- this.sync?.onExitXR(this);
1107
-
1108
-
1109
- if (this.context.mainCamera) {
1110
- // if we have a main camera we want to move it back to it's original parent
1111
- this._originalCameraParent?.add(this.context.mainCamera);
1112
-
1113
- if (this._originalCameraWorldPosition) {
1114
- setWorldPosition(this.context.mainCamera, this._originalCameraWorldPosition);
1115
- }
1116
- if (this._originalCameraWorldRotation) {
1117
- setWorldQuaternion(this.context.mainCamera, this._originalCameraWorldRotation);
1118
- }
1119
- if (this._originalCameraWorldScale) {
1120
- setWorldScale(this.context.mainCamera, this._originalCameraWorldScale);
1121
- }
1122
- }
1123
-
1124
- // mark for size change since DPI might have changed
1125
- this.context.requestSizeUpdate();
1126
-
1127
- this._defaultRig.gameObject.removeFromParent();
1128
-
1129
- enableSpatialConsole(false);
1130
-
1131
- performance.mark(measure_SessionEndedMarker);
1132
- performance.measure('NeedleXRSession', measure_SessionStartedMarker, measure_SessionEndedMarker);
1133
- };
1134
-
1135
- private _didStart: boolean = false;
1136
-
1137
- /** Called every frame by the engine */
1138
- private onBefore = (context: Context) => {
1139
- const frame = context.xrFrame;
1140
- if (!frame) return;
1141
-
1142
- performance.mark('NeedleXRSession onBefore start');
1143
-
1144
- // ensure that XR is always set to a running session
1145
- this.context.xr = this;
1146
-
1147
- // ensure that we always have the correct main camera reference
1148
- // we need to store the main camera reference here because the main camera can be disabled and then it's removed from the context
1149
- // but in XR we want to ensure we always have a active camera (or at least parent the camera to the active rig)
1150
- if (this.context.mainCameraComponent && this.context.mainCameraComponent !== this._mainCamera) {
1151
- this._mainCamera = this.context.mainCameraComponent;
1152
- }
1153
-
1154
- if (this.rig?.isActive == false) {
1155
- if (debug) console.warn("Latest rig is not active - trying to activate a different rig", this.rig);
1156
- this.updateActiveXRRig();
1157
- }
1158
-
1159
- // make sure the camera is parented to the active rig
1160
- if (this.rig && this._mainCamera?.gameObject) {
1161
- const currentParent = this._mainCamera?.gameObject?.parent;
1162
- if (currentParent !== this.rig.gameObject) {
1163
- this.rig.gameObject.add(this._mainCamera?.gameObject);
1164
- }
1165
- }
1166
-
1167
- this.internalUpdateState();
1168
-
1169
- // we apply the flip immediately and keep it while in XR so that regular raycasts just work
1170
- // otherwise rendering would fool us
1171
- this.applyCustomForward();
1172
-
1173
- const args: NeedleXREventArgs = { xr: this };
1174
-
1175
- // we want to invoke ENTERXR for NEW component nad EXITXR for REMOVED components
1176
- // we want to invoke onControllerAdded to components joining a running XR session if controllers are already connected
1177
- //TODO: handle REMOVED components during a session (we want to call leave session events and controller removed events)
1178
-
1179
- // deferred start because we need an XR frame
1180
- if (!this._didStart) {
1181
- this._didStart = true;
1182
-
1183
- // place default rig to view the scene
1184
- if (this.mode === "immersive-vr") {
1185
- const bounds = getBoundingBox(this.context.scene.children);
1186
- if (bounds) {
1187
- const size = bounds.getSize(getTempVector());
1188
- if (size.length() > 0) {
1189
- const rigobject = this._defaultRig.gameObject;
1190
- rigobject.position.set(bounds.min.x + size.x * .5, bounds.min.y, bounds.max.z + size.z * .5 + 1.5);
1191
- const centerLook = bounds.getCenter(getTempVector());
1192
- centerLook.y = rigobject.position.y;
1193
- rigobject.lookAt(centerLook);
1194
- }
1195
- }
1196
- }
1197
-
1198
- invokeXRSessionStart({ session: this });
1199
-
1200
- for (const listener of NeedleXRSession._xrStartListeners) {
1201
- listener(args);
1202
- }
1203
-
1204
- // invoke session listeners start
1205
- // we need to make a copy because the array might be modified during the loop (could also use a for loop and iterate backwards perhaps but then order of invocation would be changed OR check if the size has changed...)
1206
- const copy = [...this._xr_scripts];
1207
- if (debug) console.log("NeedleXRSession start, handle scripts:", copy);
1208
- for (const script of copy) {
1209
- if (script.destroyed) {
1210
- this._script_to_remove.push(script);
1211
- continue;
1212
- }
1213
- if (!script.activeAndEnabled) {
1214
- this.markInactive(script);
1215
- continue;
1216
- }
1217
- // if ((script as IComponent).activeAndEnabled === false) continue;
1218
- this.invokeCallback_EnterXR(script);
1219
- // also invoke all events for currently (already) connected controllers
1220
- for (const controller of this.controllers) {
1221
- this.invokeCallback_ControllerAdded(script, controller);
1222
- }
1223
- }
1224
- }
1225
- else if (this.context.new_scripts_xr.length > 0) {
1226
- // invoke start on all new scripts that were added during the session and that support the current mode
1227
- const copy = [...this.context.new_scripts_xr];
1228
- for (let i = 0; i < copy.length; i++) {
1229
- const script = this.context.new_scripts_xr[i] as IComponent & INeedleXRSessionEventReceiver;
1230
- if (!script || script.destroyed || script.supportsXR?.(this.mode) == false) {
1231
- this.context.new_scripts_xr.splice(i, 1);
1232
- continue;
1233
- }
1234
- if (!script.activeAndEnabled) {
1235
- this.context.new_scripts_xr.splice(i, 1);
1236
- this.markInactive(script);
1237
- continue;
1238
- }
1239
- // ignore inactive scripts
1240
- // if (script.activeAndEnabled === false) continue;
1241
- if (this.addScript(script)) {
1242
- // invoke onEnterXR on those scripts because they joined a running session
1243
- this.invokeCallback_EnterXR(script);
1244
- // also invoke all events for currently (already) connected controllers
1245
- for (const controller of this.controllers) {
1246
- this.invokeCallback_ControllerAdded(script, controller);
1247
- }
1248
- }
1249
- }
1250
- }
1251
-
1252
- // make sure camera layers are correct
1253
- // we do this every frame here but I think it would be enough to do it once after the first rendering
1254
- // since we want to override the settings in three's WebXRManager
1255
- // we also want to continuously sync the culling mask if a user changes it on the main cam while in XR
1256
- this.syncCameraCullingMask();
1257
-
1258
- // update controllers
1259
- for (const controller of this.controllers) {
1260
- controller.onUpdate(frame);
1261
- }
1262
-
1263
- // handle when new controllers have been added
1264
- if (this._newControllers.length > 0) {
1265
- const copy = [...this._newControllers];
1266
- this._newControllers.length = 0;
1267
- for (const controller of copy) {
1268
- if (!controller.connected) {
1269
- console.warn("New controller is not connected", controller);
1270
- continue;
1271
- }
1272
- this.controllers.push(controller);
1273
- for (const script of this._xr_scripts) {
1274
- if (script.destroyed) {
1275
- this._script_to_remove.push(script);
1276
- continue;
1277
- }
1278
- if (script.activeAndEnabled === false) {
1279
- continue;
1280
- }
1281
- this.invokeCallback_ControllerAdded(script, controller);
1282
- // if (script.onXRControllerAdded)
1283
- // script.onXRControllerAdded({ xr: this, controller, change: "added" });
1284
- }
1285
- }
1286
- this.controllers.sort((a, b) => a.index - b.index);
1287
- }
1288
-
1289
- if (debug && this.context.time.frame % 30 === 0 && this.controllers.length <= 0 && this.session.inputSources.length > 0) {
1290
- enableSpatialConsole(true)
1291
- console.error("XRControllers are not added but inputSources are present");
1292
- }
1293
-
1294
- performance.mark('NeedleXRSession update scripts start');
1295
- // invoke update on all scripts
1296
- for (const script of this._xr_update_scripts) {
1297
- if (script.destroyed === true) {
1298
- this._script_to_remove.push(script);
1299
- continue;
1300
- }
1301
- if (script.activeAndEnabled === false) {
1302
- this.markInactive(script);
1303
- continue;
1304
- }
1305
- if (script.onUpdateXR) script.onUpdateXR(args);
1306
- }
1307
- performance.mark('NeedleXRSession update scripts end');
1308
- performance.measure('NeedleXRSession update scripts', 'NeedleXRSession update scripts start', 'NeedleXRSession update scripts end');
1309
-
1310
- // handle inactive scripts
1311
- this.handleInactiveScripts();
1312
-
1313
- // handle removed scripts
1314
- if (this._script_to_remove.length > 0) {
1315
- // make sure we have no duplicates
1316
- const unique = [...new Set(this._script_to_remove)];
1317
- this._script_to_remove.length = 0;
1318
- for (const script of unique) {
1319
- if (!script.destroyed && this.running) {
1320
- script.onLeaveXR?.(args);
1321
- }
1322
- this.removeScript(script);
1323
- }
1324
- }
1325
-
1326
- this.sync?.onUpdate(this);
1327
-
1328
- this.onRenderDebug();
1329
- performance.mark('NeedleXRSession onBefore end');
1330
- performance.measure('NE XR frame', 'NeedleXRSession onBefore start', 'NeedleXRSession onBefore end');
1331
- }
1332
-
1333
- private onRenderDebug() {
1334
- if (debug) {
1335
- for (const controller of this.controllers) {
1336
- controller.onRenderDebug();
1337
- }
1338
- }
1339
- if ((debug || debugFPS) && this.rig) {
1340
- debugFPSFramesSinceLastUpdate++;
1341
- if (debugFPSFramesSinceLastUpdate >= 20) {
1342
- const pos = this.rig.gameObject.worldPosition;
1343
- const forward = this.rig.gameObject.worldForward;
1344
- pos.add(forward.multiplyScalar(1.5));
1345
- const upwards = this.rig.gameObject.worldUp;
1346
- pos.add(upwards.multiplyScalar(2.5));
1347
- let debugLabel = "";
1348
- debugLabel += `${this.context.time.smoothedFps.toFixed(0)} FPS`;
1349
- debugLabel += `, calls: ${this.context.renderer.info.render.calls}, tris: ${this.context.renderer.info.render.triangles.toLocaleString()}`;
1350
- if (debug || debugFPS) {
1351
- for (const ctrl of this.controllers) {
1352
- debugLabel += `\n${ctrl.hand ? "hand" : "ctrl"} ${ctrl.inputSource.handedness}[${ctrl.index}] con:${ctrl.connected} tr:${ctrl.isTracking} hts:${ctrl.hasHitTestSource ? "yes" : "no"}`;
1353
- }
1354
- }
1355
- debugFPSFramesSinceLastUpdate = 0;
1356
- Gizmos.DrawLabel(pos, debugLabel, undefined, 1 / 60 * 20);
1357
- }
1358
- }
1359
- }
1360
-
1361
- private onBeforeRender = () => {
1362
- if (this.context.mainCamera)
1363
- this.updateFade(this.context.mainCamera);
1364
- }
1365
-
1366
- private onAfterRender = () => {
1367
- this.onUpdateFade_PostRender();
1368
-
1369
- // render spectator view if we're in VR using Link
1370
- // __rendered_once is for when we are on device, but opening the browser should not show a blank space
1371
- if (DeviceUtilities.isDesktop() || !this["_renderOnceOnDevice"]) {
1372
- const renderer = this.context.renderer;
1373
- if (renderer.xr.isPresenting && this.context.mainCamera) {
1374
- this["_renderOnceOnDevice"] = true;
1375
- const wasXr = renderer.xr.enabled;
1376
- const previousRenderTarget = renderer.getRenderTarget();
1377
- const previousBackground = this.context.scene.background;
1378
- renderer.xr.enabled = false;
1379
- renderer.setRenderTarget(null);
1380
- if (this.isPassThrough) this.context.scene.background = null;
1381
- if (this.context.composer) {
1382
- this.context.composer.render(this.context.time.deltaTime);
1383
- }
1384
- else {
1385
- renderer.render(this.context.scene, this.context.mainCamera);
1386
- }
1387
- renderer.xr.enabled = wasXr;
1388
- renderer.setRenderTarget(previousRenderTarget);
1389
- this.context.scene.background = previousBackground;
1390
- }
1391
- }
1392
- }
1393
-
1394
- /** register a new XR script if it hasnt added yet */
1395
- private addScript(script: INeedleXRSessionEventReceiver) {
1396
- if (this._xr_scripts.includes(script)) return false;
1397
- if (debug) console.log("Register new XRScript", script);
1398
- this._xr_scripts.push(script);
1399
- if (typeof script.onUpdateXR === "function") {
1400
- this._xr_update_scripts.push(script);
1401
- }
1402
- return true;
1403
- }
1404
-
1405
- /** mark a script as inactive and invokes callbacks */
1406
- private markInactive(script: INeedleXRSessionEventReceiver) {
1407
- if (this._inactive_scripts.indexOf(script) >= 0) return;
1408
- // inactive scripts should not receive any regular callbacks anymore
1409
- this.removeScript(script, false);
1410
- this._inactive_scripts.push(script);
1411
- // inactive scripts receive callbacks as if the XR session has ended
1412
- for (const ctrl of this.controllers) this.invokeCallback_ControllerRemoved(script, ctrl);
1413
- this.invokeCallback_LeaveXR(script);
1414
- }
1415
- private handleInactiveScripts() {
1416
- if (this._inactive_scripts.length > 0) {
1417
- for (let i = this._inactive_scripts.length - 1; i >= 0; i--) {
1418
- const script = this._inactive_scripts[i];
1419
- if (script.activeAndEnabled) {
1420
- this._inactive_scripts.splice(i, 1);
1421
- this.addScript(script);
1422
- this.invokeCallback_EnterXR(script);
1423
- for (const ctrl of this.controllers) this.invokeCallback_ControllerAdded(script, ctrl);
1424
- }
1425
- }
1426
- }
1427
- }
1428
-
1429
- private readonly _script_to_remove: INeedleXRSessionEventReceiver[] = [];
1430
-
1431
- private removeScript(script: INeedleXRSessionEventReceiver, removeCompletely: boolean = true) {
1432
- if (debug) console.log("Remove XRScript", script);
1433
- const index = this._xr_scripts.indexOf(script);
1434
- if (index >= 0) this._xr_scripts.splice(index, 1);
1435
- const index2 = this._xr_update_scripts.indexOf(script);
1436
- if (index2 >= 0) this._xr_update_scripts.splice(index2, 1);
1437
- if (removeCompletely) {
1438
- const index3 = this._inactive_scripts.indexOf(script);
1439
- if (index3 >= 0) this._inactive_scripts.splice(index3, 1);
1440
- }
1441
- }
1442
-
1443
- private invokeCallback_EnterXR(script: INeedleXRSessionEventReceiver) {
1444
- if (script.onEnterXR) {
1445
- script.onEnterXR({ xr: this });
1446
- }
1447
- }
1448
- private invokeCallback_ControllerAdded(script: INeedleXRSessionEventReceiver, controller: NeedleXRController) {
1449
- if (script.onXRControllerAdded) {
1450
- script.onXRControllerAdded({ xr: this, controller, change: "added" });
1451
- }
1452
- }
1453
- private invokeCallback_ControllerRemoved(script: INeedleXRSessionEventReceiver, controller: NeedleXRController) {
1454
- if (script.onXRControllerRemoved) {
1455
- script.onXRControllerRemoved({ xr: this, controller, change: "removed" });
1456
- }
1457
- }
1458
- private invokeCallback_LeaveXR(script: INeedleXRSessionEventReceiver) {
1459
- if (script.onLeaveXR && !script.destroyed) {
1460
- script.onLeaveXR({ xr: this });
1461
- }
1462
- }
1463
-
1464
- private syncCameraCullingMask() {
1465
- // when we set unity layers objects will only be rendered on one eye
1466
- // we set layers to sync raycasting and have a similar behaviour to unity
1467
- const cam = this.context.xrCamera;
1468
- const cull = this.context.mainCameraComponent?.cullingMask;
1469
- if (cam && cull !== undefined) {
1470
- for (const c of cam.cameras) {
1471
- c.layers.mask = cull;
1472
- }
1473
- cam.layers.mask = cull;
1474
- }
1475
- else if (cam) {
1476
- for (const c of cam.cameras) {
1477
- c.layers.enableAll();
1478
- }
1479
- cam.layers.enableAll();
1480
- }
1481
- }
1482
-
1483
- private invokeControllerEvent(controller: NeedleXRController, listeners: ControllerChangedEvt[], change: "added" | "removed") {
1484
- for (let i = listeners.length - 1; i >= 0; i--) {
1485
- const listener = listeners[i];
1486
- if (!listener) continue;
1487
- try {
1488
- listener({
1489
- xr: this,
1490
- controller,
1491
- change
1492
- });
1493
- }
1494
- catch (e) {
1495
- console.error(e);
1496
- }
1497
- }
1498
- }
1499
-
1500
-
1501
- private _camera!: Object3D;
1502
- private readonly _cameraRenderParent: Object3D = new Object3D().rotateY(Math.PI);
1503
- private _previousCameraParent!: Object3D | null;
1504
- private readonly _customforward: boolean = true;
1505
- private originalCameraNearPlane?: number;
1506
- /** This is used to have the XR system camera look into threejs Z forward direction (instead of -z) */
1507
- private applyCustomForward() {
1508
- if (this.context.mainCamera && this._customforward) {
1509
- this._camera = this.context.mainCamera;
1510
- if (this._camera.parent !== this._cameraRenderParent) {
1511
- this._previousCameraParent = this._camera.parent;
1512
- this._previousCameraParent?.add(this._cameraRenderParent);
1513
- }
1514
- this._cameraRenderParent.name = "XR Camera Render Parent";
1515
- this._cameraRenderParent.add(this._camera);
1516
-
1517
- let minNearPlane = .02;
1518
- if (this.rig) {
1519
- const rigWorldScale = getWorldScale(this.rig.gameObject);
1520
- minNearPlane *= rigWorldScale.x;
1521
- }
1522
- if (this._camera instanceof PerspectiveCamera && this._camera.near > minNearPlane) {
1523
- this.originalCameraNearPlane = this._camera.near;
1524
- this._camera.near = minNearPlane;
1525
- }
1526
- }
1527
- }
1528
- private revertCustomForward() {
1529
- if (this._camera && this._previousCameraParent) {
1530
- this._previousCameraParent.add(this._camera);
1531
- }
1532
- this._previousCameraParent = null;
1533
-
1534
- if (this._camera instanceof PerspectiveCamera && this.originalCameraNearPlane != undefined) {
1535
- this._camera.near = this.originalCameraNearPlane;
1536
- }
1537
- }
1538
-
1539
-
1540
- private _viewerPose?: XRViewerPose;
1541
- private readonly _transformOrientation = new Quaternion();
1542
- private readonly _transformPosition = new Vector3();
1543
-
1544
- private internalUpdateState() {
1545
- const referenceSpace = this.context.renderer.xr.getReferenceSpace();
1546
- if (!referenceSpace) {
1547
- this._viewerPose = undefined;
1548
- return;
1549
- }
1550
- this._viewerPose = this.frame.getViewerPose(referenceSpace);
1551
- if (this._viewerPose) {
1552
- const transform: XRRigidTransform = this._viewerPose.transform;
1553
- this._transformPosition.set(transform.position.x, transform.position.y, transform.position.z);
1554
- this._transformOrientation.set(transform.orientation.x, transform.orientation.y, transform.orientation.z, transform.orientation.w);
1555
- }
1556
- }
1557
-
1558
- // TODO: for scene transitions (e.g. SceneSwitcher) where creating the scene might take a few moments we might want more control over when/how this fading occurs and how long the scene stays black
1559
- private _transition?: SceneTransition;
1560
-
1561
- public get transition() {
1562
- if (!this._transition) this._transition = new SceneTransition();
1563
- return this._transition;
1564
- }
1565
-
1566
- /** Call to fade rendering to black for a short moment (the returned promise will be resolved when fully black)
1567
- * This can be used to mask scene transitions or teleportation
1568
- * @returns a promise that is resolved when the screen is fully black
1569
- * @example `fadeTransition().then(() => { <fully_black> })`
1570
- */
1571
- fadeTransition() {
1572
- if (!this._transition) this._transition = new SceneTransition();
1573
- return this._transition.fadeTransition();
1574
- }
1575
-
1576
- /** e.g. FadeToBlack */
1577
- private updateFade(camera: Camera) {
1578
- if (this._transition && camera instanceof PerspectiveCamera)
1579
- this._transition.update(camera, this.context.time.deltaTime);
1580
- }
1581
-
1582
- private onUpdateFade_PostRender() {
1583
- this._transition?.remove();
1584
- }
1585
- }
1
+ import { Camera, Object3D, PerspectiveCamera, Quaternion, Vector3 } from "three";
2
+
3
+ import { enableSpatialConsole, isDevEnvironment, showBalloonMessage, showBalloonWarning } from "../debug/index.js";
4
+ import { Context, FrameEvent } from "../engine_context.js";
5
+ import { ContextEvent, ContextRegistry } from "../engine_context_registry.js";
6
+ import { isDestroyed } from "../engine_gameobject.js";
7
+ import { Gizmos } from "../engine_gizmos.js";
8
+ import { registerFrameEventCallback, unregisterFrameEventCallback } from "../engine_lifecycle_functions_internal.js";
9
+ import { getBoundingBox, getTempQuaternion, getTempVector, getWorldPosition, getWorldQuaternion, getWorldScale, setWorldPosition, setWorldQuaternion, setWorldScale } from "../engine_three_utils.js";
10
+ import type { ICamera, IComponent, INeedleXRSession } from "../engine_types.js";
11
+ import { delay, DeviceUtilities, getParam } from "../engine_utils.js";
12
+ import { invokeXRSessionEnd, invokeXRSessionStart } from "./events.js"
13
+ import { flipForwardMatrix, flipForwardQuaternion, ImplictXRRig } from "./internal.js";
14
+ import { NeedleXRController } from "./NeedleXRController.js";
15
+ import { NeedleXRSync } from "./NeedleXRSync.js";
16
+ import { SceneTransition } from "./SceneTransition.js";
17
+ import { SessionInfo, TemporaryXRContext } from "./TempXRContext.js";
18
+ import { InternalUSDZRegistry } from "./usdz.js";
19
+ import type { IXRRig } from "./XRRig.js";
20
+
21
+ const measure_SessionStartedMarker = "NeedleXRSession onStart";
22
+ const measure_SessionEndedMarker = "NeedleXRSession onEnd";
23
+
24
+
25
+ /** @link https://developer.mozilla.org/en-US/docs/Web/API/XRFrame/fillPoses */
26
+ declare type FillPosesFunction = (spaces: IterableIterator<XRJointSpace>, referenceSpace: XRSpace, targetArray: Float32Array) => void;
27
+ declare type NeedleXRFrame = XRFrame & { fillPoses?: FillPosesFunction };
28
+
29
+ /** NeedleXRSession event argument.
30
+ * Use `args.xr` to access the NeedleXRSession */
31
+ export type NeedleXREventArgs = { readonly xr: NeedleXRSession }
32
+ export type SessionChangedEvt = (args: NeedleXREventArgs) => void;
33
+ export type SessionRequestedEvent = (args: { readonly mode: XRSessionMode, readonly init: XRSessionInit }) => void;
34
+ export type SessionRequestedEndEvent = (args: { readonly mode: XRSessionMode, readonly init: XRSessionInit, newSession: XRSession | null }) => void;
35
+
36
+ /** Result of a XR hit-test
37
+ * @property {XRHitTestResult} hit The original XRHitTestResult
38
+ * @property {Vector3} position The hit position in world space
39
+ * @property {Quaternion} quaternion The hit rotation in world space
40
+ */
41
+ export type NeedleXRHitTestResult = { readonly hit: XRHitTestResult, readonly position: Vector3, readonly quaternion: Quaternion };
42
+
43
+ const debug = getParam("debugwebxr");
44
+ const debugFPS = getParam("stats");
45
+ let debugFPSFramesSinceLastUpdate = 0;
46
+
47
+ // TODO: move this into the IComponent interface!?
48
+ export interface INeedleXRSessionEventReceiver extends Pick<IComponent, "destroyed"> {
49
+ get activeAndEnabled(): boolean;
50
+ supportsXR?(mode: XRSessionMode): boolean;
51
+ /** Called before requesting a XR session */
52
+ onBeforeXR?(mode: XRSessionMode, args: XRSessionInit): void;
53
+ onEnterXR?(args: NeedleXREventArgs): void;
54
+ onUpdateXR?(args: NeedleXREventArgs): void;
55
+ onLeaveXR?(args: NeedleXREventArgs): void;
56
+ onXRControllerAdded?(args: NeedleXRControllerEventArgs): void;
57
+ onXRControllerRemoved?(args: NeedleXRControllerEventArgs): void;
58
+ }
59
+
60
+ /** Contains a reference to the currently active webxr session and the controller that has changed */
61
+ export type NeedleXRControllerEventArgs = NeedleXREventArgs & { controller: NeedleXRController, change: "added" | "removed" }
62
+ /** Event Arguments when a controller changed event is invoked (added or removed)
63
+ * Access the controller via `args.controller`, the `args.change` property indicates if the controller was added or removed
64
+ */
65
+ export type ControllerChangedEvt = (args: NeedleXRControllerEventArgs) => void;
66
+
67
+
68
+
69
+ function getDOMOverlayElement(domElement: HTMLElement) {
70
+ let arOverlayElement: HTMLElement | null = null;
71
+ // for react cases we dont have an Engine Element
72
+ const element: any = domElement;
73
+ if (element.getAROverlayContainer)
74
+ arOverlayElement = element.getAROverlayContainer();
75
+ else arOverlayElement = domElement;
76
+ return arOverlayElement;
77
+ }
78
+
79
+
80
+
81
+ handleSessionGranted();
82
+ async function handleSessionGranted() {
83
+
84
+ // TODO: asap session granted doesnt handle the pre-room yet
85
+ if (getParam("debugasap")) {
86
+ let asapSession = globalThis["needle:XRSession"] as XRSession | undefined | Promise<XRSession>;
87
+ // @ts-ignore // getting TS2848 here, not sure why
88
+ if (asapSession instanceof Promise<XRSession>) {
89
+ delete globalThis["needle:XRSession"];
90
+ ContextRegistry.addContextCreatedCallback(async cb => {
91
+ if (!asapSession) return;
92
+ // TODO: add support to pass this to the temporary room
93
+ enableSpatialConsole(true);
94
+ const session = await asapSession;
95
+ if (session) {
96
+ const sessionInit = NeedleXRSession.getDefaultSessionInit("immersive-vr");
97
+ NeedleXRSession.setSession("immersive-vr", session, sessionInit, cb.context);
98
+ }
99
+ else {
100
+ console.error("NeedleXRSession: ASAP session was rejected");
101
+ }
102
+ asapSession = undefined;
103
+ });
104
+ return;
105
+ }
106
+ }
107
+
108
+ if ('xr' in navigator) {
109
+ // WebXRViewer (based on Firefox) has a bug where addEventListener
110
+ // throws a silent exception and aborts execution entirely.
111
+ if (/WebXRViewer\//i.test(navigator.userAgent)) {
112
+ console.warn('WebXRViewer does not support addEventListener');
113
+ return;
114
+ }
115
+
116
+ navigator.xr?.addEventListener('sessiongranted', async () => {
117
+ enableSpatialConsole(true);
118
+
119
+ console.log("Received Session Granted...")
120
+ await delay(100);
121
+
122
+ const lastSessionMode = sessionStorage.getItem("needle_xr_session_mode") as XRSessionMode;
123
+ const lastSessionInit = sessionStorage.getItem("needle_xr_session_init") ?? null;
124
+ const init = lastSessionInit ? JSON.parse(lastSessionInit) : null;
125
+
126
+ let info: SessionInfo | null = null;
127
+ if (contextIsLoading()) {
128
+ await TemporaryXRContext.start(lastSessionMode || "immersive-vr", init || NeedleXRSession.getDefaultSessionInit("immersive-vr"));
129
+ await waitForContextLoadingFinished();
130
+ info = await TemporaryXRContext.handoff();
131
+ }
132
+ if (info) {
133
+ NeedleXRSession.setSession(info.mode, info.session, info.init, Context.Current);
134
+ }
135
+ else if (lastSessionMode && lastSessionInit) {
136
+ console.log("Session Granted: Restore last session")
137
+ const init = JSON.parse(lastSessionInit);
138
+ NeedleXRSession.start(lastSessionMode as XRSessionMode, init).catch(e => console.warn(e));
139
+ }
140
+ else {
141
+ // if no session was found we start VR by default
142
+ NeedleXRSession.start("immersive-vr").catch(e => console.warn("Session Granted failed:", e));
143
+ }
144
+ // make sure we only subscribe to the event once
145
+ }, { once: true });
146
+
147
+ }
148
+ }
149
+ function saveSessionInfo(mode: XRSessionMode, init: XRSessionInit) {
150
+ sessionStorage.setItem("needle_xr_session_mode", mode);
151
+ sessionStorage.setItem("needle_xr_session_init", JSON.stringify(init));
152
+ }
153
+ function deleteSessionInfo() {
154
+ sessionStorage.removeItem("needle_xr_session_mode");
155
+ sessionStorage.removeItem("needle_xr_session_init");
156
+ }
157
+
158
+ const contexts_loading: Set<Context> = new Set();
159
+ ContextRegistry.registerCallback(ContextEvent.ContextCreationStart, async cb => {
160
+ contexts_loading.add(cb.context);
161
+ });
162
+ ContextRegistry.registerCallback(ContextEvent.ContextCreated, async cb => {
163
+ contexts_loading.delete(cb.context);
164
+ });
165
+
166
+ function contextIsLoading() { return contexts_loading.size > 0; }
167
+ function waitForContextLoadingFinished(): Promise<void> {
168
+ return new Promise(res => {
169
+ const startTime = Date.now();
170
+ const interval = setInterval(() => {
171
+ if (!contextIsLoading() || Date.now() - startTime > 60000) {
172
+ clearInterval(interval);
173
+ res();
174
+ }
175
+ }, 100);
176
+ });
177
+ }
178
+
179
+
180
+ if (DeviceUtilities.isDesktop() && isDevEnvironment()) {
181
+ window.addEventListener("keydown", (evt) => {
182
+ if (evt.key === "x" || evt.key === "Escape") {
183
+ if (NeedleXRSession.active) {
184
+ NeedleXRSession.stop();
185
+ }
186
+ }
187
+ });
188
+ }
189
+
190
+ // if (getParam("simulatewebxrloading")) {
191
+ // ContextRegistry.registerCallback(ContextEvent.ContextCreationStart, async _cb => {
192
+ // await delay(3000);
193
+ // setTimeout(async () => {
194
+ // const info = await TemporaryXRContext.handoff();
195
+ // if (info) NeedleXRSession.setSession(info.mode, info.session, info.init, Context.Current);
196
+ // else
197
+ // NeedleXRSession.start("immersive-vr")
198
+ // }, 6000)
199
+ // });
200
+ // let triggered = false;
201
+ // window.addEventListener("click", () => {
202
+ // if (triggered) return;
203
+ // triggered = true;
204
+ // TemporaryXRContext.start("immersive-vr", NeedleXRSession.getDefaultSessionInit("immersive-vr"));
205
+ // });
206
+ // }
207
+
208
+ /**
209
+ * This class manages an XRSession to provide helper methods and events. It provides easy access to the XRInputSources (controllers and hands)
210
+ * - Start a XRSession with `NeedleXRSession.start(...)`
211
+ * - Stop a XRSession with `NeedleXRSession.stop()`
212
+ * - Access a running XRSession with `NeedleXRSession.active`
213
+ *
214
+ * If a XRSession is active you can use all XR-related event methods on your components to receive XR events e.g. `onEnterXR`, `onUpdateXR`, `onLeaveXR`
215
+ * ```ts
216
+ * export class MyComponent extends Behaviour {
217
+ * // callback invoked whenever the XRSession is started or your component is added to a scene with an active XRSession
218
+ * onEnterXR(args: NeedleXREventArgs) {
219
+ * console.log("Entered XR");
220
+ * // access the NeedleXRSession via args.xr
221
+ * }
222
+ * // callback invoked whenever a controller is added (or you switch from controller to hand tracking)
223
+ * onControllerAdded(args: NeedleXRControllerEventArgs) { }
224
+ * }
225
+ * ```
226
+ *
227
+ * ### XRRig
228
+ * The XRRig can be accessed via the `rig` property
229
+ * Set a custom XRRig via `NeedleXRSession.addRig(...)` or `NeedleXRSession.removeRig(...)`
230
+ * By default the active XRRig with the highest priority in the scene is used
231
+ */
232
+ export class NeedleXRSession implements INeedleXRSession {
233
+
234
+ private static _sync: NeedleXRSync | null = null;
235
+ static getXRSync(context: Context) {
236
+ if (!this._sync) this._sync = new NeedleXRSync(context);
237
+ return this._sync;
238
+ }
239
+
240
+ static get currentSessionRequest(): XRSessionMode | null { return this._currentSessionRequestMode; }
241
+ private static _currentSessionRequestMode: XRSessionMode | null = null;
242
+
243
+ /**
244
+ * @returns the active @type {NeedleXRSession} (if any active) or null
245
+ */
246
+ static get active(): NeedleXRSession | null { return this._activeSession; }
247
+ /** The active xr session mode (if any xr session is active)
248
+ * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSessionMode
249
+ */
250
+ static get activeMode() { return this._activeSession?.mode ?? null; }
251
+ /** XRSystem via navigator.xr access
252
+ * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSystem
253
+ */
254
+ static get xrSystem(): XRSystem | undefined {
255
+ return ('xr' in navigator) ? navigator.xr : undefined;
256
+ }
257
+ /**
258
+ * @returns true if the browser supports WebXR (`immersive-vr` or `immersive-ar`)
259
+ * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSystem/isSessionSupported
260
+ */
261
+ static isXRSupported() { return Promise.all([this.isVRSupported(), this.isARSupported()]).then(res => res.some(e => e)).catch(() => false); }
262
+ /**
263
+ * @returns true if the browser supports immersive-vr (WebXR)
264
+ * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSystem/isSessionSupported
265
+ */
266
+ static isVRSupported() { return this.isSessionSupported("immersive-vr"); }
267
+ /**
268
+ * @returns true if the browser supports immersive-ar (WebXR)
269
+ * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSystem/isSessionSupported
270
+ */
271
+ static isARSupported() { return this.isSessionSupported("immersive-ar"); }
272
+ /**
273
+ * @param mode The XRSessionMode to check if it is supported
274
+ * @returns true if the browser supports the given XRSessionMode
275
+ */
276
+ static isSessionSupported(mode: XRSessionMode) { return this.xrSystem?.isSessionSupported(mode).catch(err => { if (debug) console.error(err); return false }) ?? Promise.resolve(false); }
277
+
278
+ private static _currentSessionRequest?: Promise<XRSession>;
279
+ private static _activeSession: NeedleXRSession | null;
280
+
281
+ /** Register to listen to XRSession start events. Unsubscribe with `offXRSessionStart` */
282
+ static onSessionRequestStart(evt: SessionRequestedEvent) {
283
+ this._sessionRequestStartListeners.push(evt);
284
+ }
285
+ /** Unsubscribe from request start evt. Register with `onSessionRequestStart` */
286
+ static offSessionRequestStart(evt: SessionRequestedEvent) {
287
+ const index = this._sessionRequestStartListeners.indexOf(evt);
288
+ if (index >= 0) this._sessionRequestStartListeners.splice(index, 1);
289
+ }
290
+ private static readonly _sessionRequestStartListeners: SessionRequestedEvent[] = [];
291
+
292
+ /** Called after the session request has finished */
293
+ static onSessionRequestEnd(evt: SessionRequestedEndEvent) {
294
+ this._sessionRequestEndListeners.push(evt);
295
+ }
296
+ /** Unsubscribe from request end evt */
297
+ static offSessionRequestEnd(evt: SessionRequestedEndEvent) {
298
+ const index = this._sessionRequestEndListeners.indexOf(evt);
299
+ if (index >= 0) this._sessionRequestEndListeners.splice(index, 1);
300
+ }
301
+ private static readonly _sessionRequestEndListeners: SessionRequestedEndEvent[] = [];
302
+
303
+ /** Listen to XR session started. Unsubscribe with `offXRSessionStart` */
304
+ static onXRSessionStart(evt: SessionChangedEvt) {
305
+ this._xrStartListeners.push(evt);
306
+ };
307
+ /** Unsubscribe from XRSession started events */
308
+ static offXRSessionStart(evt: SessionChangedEvt) {
309
+ const index = this._xrStartListeners.indexOf(evt);
310
+ if (index >= 0) this._xrStartListeners.splice(index, 1);
311
+ }
312
+ private static readonly _xrStartListeners: SessionChangedEvt[] = [];
313
+
314
+ /** Listen to XR session ended. Unsubscribe with `offXRSessionEnd` */
315
+ static onXRSessionEnd(evt: SessionChangedEvt) {
316
+ this._xrEndListeners.push(evt);
317
+ };
318
+ /** Unsubscribe from XRSession started events */
319
+ static offXRSessionEnd(evt: SessionChangedEvt) {
320
+ const index = this._xrEndListeners.indexOf(evt);
321
+ if (index >= 0) this._xrEndListeners.splice(index, 1);
322
+ }
323
+ private static readonly _xrEndListeners: SessionChangedEvt[] = [];
324
+
325
+ /** Listen to controller added events.
326
+ * Events are cleared when starting a new session
327
+ **/
328
+ static onControllerAdded(evt: ControllerChangedEvt) {
329
+ this._controllerAddedListeners.push(evt);
330
+ }
331
+ /** Unsubscribe from controller added evts */
332
+ static offControllerAdded(evt: ControllerChangedEvt) {
333
+ const index = this._controllerAddedListeners.indexOf(evt);
334
+ if (index >= 0) this._controllerAddedListeners.splice(index, 1);
335
+ }
336
+ private static readonly _controllerAddedListeners: ControllerChangedEvt[] = [];
337
+
338
+ /** Listen to controller removed events
339
+ * Events are cleared when starting a new session
340
+ **/
341
+ static onControllerRemoved(evt: ControllerChangedEvt) {
342
+ this._controllerRemovedListeners.push(evt);
343
+ }
344
+ /** Unsubscribe from controller removed events */
345
+ static offControllerRemoved(evt: ControllerChangedEvt) {
346
+ const index = this._controllerRemovedListeners.indexOf(evt);
347
+ if (index >= 0) this._controllerRemovedListeners.splice(index, 1);
348
+ }
349
+ private static readonly _controllerRemovedListeners: ControllerChangedEvt[] = [];
350
+
351
+ /** If the browser supports offerSession - creating a VR or AR button in the browser navigation bar */
352
+ static offerSession(mode: XRSessionMode, init: XRSessionInit | "default", context: Context): boolean {
353
+ if ('xr' in navigator && navigator.xr && 'offerSession' in navigator.xr) {
354
+ if (typeof navigator.xr.offerSession === "function") {
355
+ console.log("WebXR offerSession is available - requesting mode: " + mode);
356
+ if (init == "default") {
357
+ init = this.getDefaultSessionInit(mode);
358
+ }
359
+ navigator.xr.offerSession(mode, {
360
+ ...init
361
+ }).then((session) => {
362
+ return NeedleXRSession.setSession(mode, session, init as XRSessionInit, context);
363
+ }).catch(_ => {
364
+ console.log("XRSession offer rejected (perhaps because another call to offerSession was made or a call to requestSession was made)")
365
+ });
366
+ }
367
+ return true;
368
+ }
369
+ return false;
370
+ }
371
+
372
+ /** @returns a new XRSession init object with defaults */
373
+ static getDefaultSessionInit(mode: Omit<XRSessionMode, "inline">): XRSessionInit {
374
+ switch (mode) {
375
+ case "immersive-ar":
376
+ const arFeatures = ['anchors', 'local-floor', 'layers', 'dom-overlay', 'hit-test', 'unbounded'];
377
+ // Don't request handtracking by default on VisionOS
378
+ if (!DeviceUtilities.isVisionOS())
379
+ arFeatures.push('hand-tracking');
380
+ return {
381
+ optionalFeatures: arFeatures,
382
+ }
383
+ case "immersive-vr":
384
+ const vrFeatures = ['local-floor', 'bounded-floor', 'high-fixed-foveation-level', 'layers'];
385
+ // Don't request handtracking by default on VisionOS
386
+ if (!DeviceUtilities.isVisionOS())
387
+ vrFeatures.push('hand-tracking');
388
+ return {
389
+ optionalFeatures: vrFeatures,
390
+ }
391
+ default:
392
+ console.warn("No default session init for mode", mode);
393
+ return {};
394
+ }
395
+ }
396
+
397
+ /** start a new webXR session (make sure to stop already running sessions before calling this method)
398
+ * @param mode The XRSessionMode to start (e.g. `immersive-vr` or `immersive-ar`) or `ar` to start `immersive-ar` on supported devices OR on iOS devices it will export an interactive USDZ and open in Quicklook.
399
+ * Get more information about WebXR modes: https://developer.mozilla.org/en-US/docs/Web/API/XRSessionMode
400
+ * @param init The XRSessionInit to use (optional), docs: https://developer.mozilla.org/en-US/docs/Web/API/XRSessionInit
401
+ * @param context The Needle Engine context to use
402
+ */
403
+ static async start(mode: XRSessionMode | "ar", init?: XRSessionInit, context?: Context): Promise<NeedleXRSession | null> {
404
+
405
+ // handle iOS platform where "immersive-ar" is not supported
406
+ // TODO: should we add a separate mode (e.g. "AR")? https://linear.app/needle/issue/NE-5303
407
+ if (DeviceUtilities.isiOS()) {
408
+ if (mode === "ar") {
409
+ const arSupported = await this.isARSupported();
410
+ if (!arSupported) {
411
+ InternalUSDZRegistry.exportAndOpen();
412
+ return null;
413
+ }
414
+ else {
415
+ mode = "immersive-ar";
416
+ }
417
+ }
418
+ }
419
+ else if (mode == "ar") {
420
+ mode = "immersive-ar";
421
+ }
422
+
423
+
424
+
425
+ if (isDevEnvironment() && getParam("debugxrpreroom")) {
426
+ console.warn("Debug: Starting temporary XR session");
427
+ await TemporaryXRContext.start(mode, init || NeedleXRSession.getDefaultSessionInit(mode));
428
+ return null;
429
+ }
430
+
431
+ if (this._currentSessionRequest) {
432
+ console.warn("A XRSession is already being requested");
433
+ if (debug || isDevEnvironment()) showBalloonWarning("A XRSession is already being requested");
434
+ return this._currentSessionRequest.then(() => this._activeSession!);
435
+ }
436
+
437
+ if (this._activeSession) {
438
+ console.error("A XRSession is already running");
439
+ return this._activeSession;
440
+ }
441
+
442
+ // Make sure we have a context
443
+ if (!context) context = Context.Current;
444
+ if (!context) context = ContextRegistry.All[0] as Context;
445
+ if (!context) throw new Error("No Needle Engine Context found");
446
+
447
+ performance.mark('NeedleXRSession start');
448
+
449
+ // setup session init args, make sure we have default values
450
+ if (!init) init = {};
451
+
452
+ switch (mode) {
453
+
454
+ // Setup VR initialization parameters
455
+ case "immersive-ar":
456
+ {
457
+ const supported = await this.xrSystem?.isSessionSupported('immersive-ar')
458
+ if (supported !== true) {
459
+ console.error(mode + ' is not supported by this browser.');
460
+ return null;
461
+ }
462
+ const defaultInit: XRSessionInit = this.getDefaultSessionInit(mode);
463
+ const domOverlayElement = getDOMOverlayElement(context.domElement);
464
+ if (domOverlayElement && !DeviceUtilities.isQuest()) { // excluding quest since dom-overlay breaks sessiongranted
465
+ defaultInit.domOverlay = { root: domOverlayElement };
466
+ defaultInit.optionalFeatures!.push('dom-overlay');
467
+ }
468
+ init = {
469
+ ...defaultInit,
470
+ ...init,
471
+ }
472
+ }
473
+ break;
474
+
475
+ // Setup AR initialization parameters
476
+ case "immersive-vr":
477
+ {
478
+ const supported = await this.xrSystem?.isSessionSupported('immersive-vr')
479
+ if (supported !== true) {
480
+ console.error(mode + ' is not supported by this browser.');
481
+ return null;
482
+ }
483
+ const defaultInit: XRSessionInit = this.getDefaultSessionInit(mode);
484
+ init = {
485
+ ...defaultInit,
486
+ ...init,
487
+ }
488
+ }
489
+ break;
490
+
491
+ default:
492
+ console.warn("No default session init for mode", mode);
493
+ break;
494
+ }
495
+
496
+ // Fix: define these here because VariantLauncher crashes otherwise. Spec: https://immersive-web.github.io/webxr/#feature-dependencies
497
+ // Issue: https://linear.app/needle/issue/NE-5136
498
+ init.optionalFeatures ??= [];
499
+ init.requiredFeatures ??= [];
500
+
501
+ // we stop a temporary session here (if any runs)
502
+ await TemporaryXRContext.stop();
503
+
504
+ const scripts = mode == "immersive-ar" ? context.scripts_immersive_ar : context.scripts_immersive_vr
505
+
506
+ if (debug)
507
+ console.log("%c" + `Requesting ${mode} session`, "font-weight:bold;", init, scripts);
508
+ else
509
+ console.log("%c" + `Requesting ${mode} session`, "font-weight:bold;");
510
+ for (const script of scripts) {
511
+ if (script.onBeforeXR) script.onBeforeXR(mode, init);
512
+ }
513
+ for (const listener of this._sessionRequestStartListeners) {
514
+ listener({ mode, init });
515
+ }
516
+ if (debug) showBalloonMessage("Requesting " + mode + " session (" + Date.now() + ")");
517
+ this._currentSessionRequest = navigator.xr?.requestSession(mode, init);
518
+ this._currentSessionRequestMode = mode;
519
+ /**@type {XRSystem} */
520
+ const newSession = await (this._currentSessionRequest)?.catch(e => {
521
+ console.error(e, "Code: " + e.code);
522
+ if (e.code === 9) showBalloonWarning("Make sure your device has the required permissions (e.g. camera access)")
523
+ console.log("If the specified XR configuration is not supported (e.g. entering AR doesnt work) - make sure you access the website on a secure connection (HTTPS) and your device has the required permissions (e.g. camera access)");
524
+ const notSecure = location.protocol === 'http:';
525
+ if (notSecure) showBalloonWarning("XR requires a secure connection (HTTPS)");
526
+ });
527
+ this._currentSessionRequest = undefined;
528
+ this._currentSessionRequestMode = null;
529
+ for (const listener of this._sessionRequestEndListeners) {
530
+ listener({ mode, init, newSession: newSession || null });
531
+ }
532
+ if (!newSession) {
533
+ console.warn("XR Session request was rejected");
534
+ return null;
535
+ }
536
+ const session = this.setSession(mode, newSession, init, context);
537
+ performance.mark('NeedleXRSession end');
538
+ performance.measure('NeedleXRSession Startup', 'NeedleXRSession start', 'NeedleXRSession end');
539
+ return session;
540
+ }
541
+
542
+ static setSession(mode: XRSessionMode, session: XRSession, init: XRSessionInit, context: Context) {
543
+ if (this._activeSession) {
544
+ console.error("A XRSession is already running");
545
+ return this._activeSession;
546
+ }
547
+ const scripts = mode == "immersive-ar" ? context.scripts_immersive_ar : context.scripts_immersive_vr;
548
+ this._activeSession = new NeedleXRSession(mode, session, context, {
549
+ scripts: scripts,
550
+ controller_added: this._controllerAddedListeners,
551
+ controller_removed: this._controllerRemovedListeners,
552
+ init: init
553
+ });
554
+ session.addEventListener("end", this.onEnd);
555
+ if (debug)
556
+ console.log("%c" + `Started ${mode} session`, "font-weight:bold;", scripts);
557
+ else
558
+ console.log("%c" + `Started ${mode} session`, "font-weight:bold;");
559
+ return this._activeSession;
560
+ }
561
+ /** stops the active XR session */
562
+ static stop() {
563
+ this._activeSession?.end();
564
+ }
565
+ private static onEnd = () => {
566
+ if (debug) console.log("XR Session ended");
567
+ this._activeSession = null;
568
+ }
569
+
570
+
571
+ /** The needle engine context this session was started from */
572
+ readonly context: Context;
573
+
574
+ get sync(): NeedleXRSync | null {
575
+ return NeedleXRSession._sync;
576
+ }
577
+
578
+ /** Returns true if the xr session is still active */
579
+ get running(): boolean { return !this._ended && this.session != null; }
580
+
581
+ /**
582
+ * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSession
583
+ */
584
+ readonly session: XRSession;
585
+
586
+ /** XR Session Mode: AR or VR */
587
+ readonly mode: XRSessionMode;
588
+
589
+ /**
590
+ * The XRSession interface's read-only interactionMode property describes the best space (according to the user agent) for the application to draw an interactive UI for the current session.
591
+ * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSession/interactionMode
592
+ */
593
+ get interactionMode(): "screen-space" | "world-space" { return this.session["interactionMode"]!; }
594
+
595
+ /**
596
+ * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSession/visibilityState
597
+ * @returns {XRVisibilityState} The visibility state of the XRSession
598
+ */
599
+ get visibilityState(): XRVisibilityState { return this.session.visibilityState; }
600
+
601
+ /**
602
+ * Check if the session is `visible-blurred` - this means e.g. the keyboard is shown
603
+ */
604
+ get isVisibleBlurred(): boolean { return this.session.visibilityState === 'visible-blurred' }
605
+
606
+ /**
607
+ * Check if the session has system keyboard support
608
+ */
609
+ get isSystemKeyboardSupported(): boolean { return this.session.isSystemKeyboardSupported; }
610
+
611
+ /**
612
+ * @link https://developer.mozilla.org/en-US/docs/Web/API/XRSession/environmentBlendMode
613
+ */
614
+ get environmentBlendMode(): XREnvironmentBlendMode { return this.session.environmentBlendMode; }
615
+
616
+ /**
617
+ * The current XR frame
618
+ * @link https://developer.mozilla.org/en-US/docs/Web/API/XRFrame
619
+ */
620
+ get frame(): NeedleXRFrame { return this.context.xrFrame! as NeedleXRFrame; }
621
+
622
+ /** The currently active/connected controllers */
623
+ readonly controllers: NeedleXRController[] = [];
624
+ /** shorthand to query the left controller. Use `controllers` to get access to all connected controllers */
625
+ get leftController() { return this.controllers.find(c => c.side === "left"); }
626
+ /** shorthand to query the right controller. Use `controllers` to get access to all connected controllers */
627
+ get rightController() { return this.controllers.find(c => c.side === "right"); }
628
+ /** @returns the given controller if it is connected */
629
+ getController(side: XRHandedness | number) {
630
+ if (typeof side === "number") return this.controllers[side] || null;
631
+ return this.controllers.find(c => c.side === side) || null;
632
+ }
633
+
634
+ /** Returns true if running in pass through mode in immersive AR (e.g. user is wearing a headset while in AR) */
635
+ get isPassThrough() {
636
+ if (this.environmentBlendMode !== 'opaque' && this.interactionMode === "world-space") return true;
637
+ // since we can not rely on interactionMode check we check the controllers too
638
+ // https://linear.app/needle/issue/NE-4057
639
+ // the following is a workaround for the issue above
640
+ if (this.mode === "immersive-ar" && this.environmentBlendMode !== 'opaque') {
641
+ // if we have any tracked pointer controllers we're also in passthrough
642
+ if (this.controllers.some(c => c.inputSource.targetRayMode === "tracked-pointer"))
643
+ return true;
644
+ }
645
+ if (isDevEnvironment() && DeviceUtilities.isDesktop() && this.mode === "immersive-ar") {
646
+ return true;
647
+ }
648
+ return false;
649
+ }
650
+ get isAR() { return this.mode === 'immersive-ar'; }
651
+ get isVR() { return this.mode === 'immersive-vr'; }
652
+ /** If the AR mode is not immersive (meaning the user is e.g. holding a phone instead of wearing a AR passthrough headset) */
653
+ get isScreenBasedAR() { return this.isAR && !this.isPassThrough; }
654
+
655
+ get posePosition() { return this._transformPosition; }
656
+ get poseOrientation() { return this._transformOrientation; }
657
+ /** @returns the context.renderer.xr.getReferenceSpace() result */
658
+ get referenceSpace(): XRSpace | null { return this.context.renderer.xr.getReferenceSpace(); }
659
+ /** @returns the XRFrame `viewerpose` using the xr `referenceSpace` */
660
+ get viewerPose(): XRViewerPose | undefined { return this._viewerPose; }
661
+
662
+
663
+ /** @returns `true` if any image is currently being tracked */
664
+ /** returns true if images are currently being tracked */
665
+ get isTrackingImages() {
666
+ if (this.frame && "getImageTrackingResults" in this.frame && typeof this.frame.getImageTrackingResults === "function") {
667
+ try {
668
+ const trackingResult = this.frame.getImageTrackingResults();
669
+ for (const result of trackingResult) {
670
+ const state = result.trackingState;
671
+ if (state === "tracked") return true;
672
+ }
673
+ }
674
+ catch {
675
+ // Looks like we get a NotSupportedException on Android since the method is known
676
+ // but the feature is not supported by the session
677
+ // TODO Can we check here if we even requested the image-tracking feature instead of catching?
678
+ return false;
679
+ }
680
+ }
681
+ return false;
682
+ }
683
+
684
+
685
+ /** The currently active XR rig */
686
+ get rig(): IXRRig | null {
687
+ const rig = this._rigs[0] ?? null;
688
+ if (rig?.gameObject && isDestroyed(rig.gameObject) || rig?.isActive === false) {
689
+ this.updateActiveXRRig();
690
+ return this._rigs[0] ?? null;
691
+ }
692
+ return rig;
693
+ }
694
+ private _rigScale: number = 1;
695
+ private _lastRigScaleUpdate: number = -1;
696
+
697
+ /** Get the XR Rig worldscale.
698
+ *
699
+ * **For AR**
700
+ * If you want to modify the scale in AR at runtime get the WebARSessionRoot component via `findObjectOfType(WebARSessionRoot)` and then set the `arScale` value.
701
+ *
702
+ */
703
+ get rigScale() {
704
+ if (!this._rigs[0]) return 1;
705
+ if (this._lastRigScaleUpdate !== this.context.time.frame) {
706
+ this._lastRigScaleUpdate = this.context.time.frame;
707
+ this._rigScale = this._rigs[0].gameObject.worldScale.x;
708
+ }
709
+ return this._rigScale;
710
+ }
711
+ /** add a rig to the available XR rigs - if it's priority is higher than the currently active rig it will be enabled */
712
+ addRig(rig: IXRRig) {
713
+ const i = this._rigs.indexOf(rig);
714
+ if (i >= 0) return;
715
+ if (rig.priority === undefined) rig.priority = 0;
716
+ this._rigs.push(rig);
717
+ this.updateActiveXRRig();
718
+ }
719
+ /** Remove a rig from the available XR Rigs */
720
+ removeRig(rig: IXRRig) {
721
+ const i = this._rigs.indexOf(rig);
722
+ if (i === -1) return;
723
+ this._rigs.splice(i, 1);
724
+ this.updateActiveXRRig();
725
+ }
726
+ /** Sets a XRRig to be active which will parent the camera to this rig */
727
+ setRigActive(rig: IXRRig) {
728
+ const i = this._rigs.indexOf(rig);
729
+ const currentlyActive = this._rigs[0];
730
+ this._rigs.splice(i, 1);
731
+ this._rigs.unshift(rig);
732
+ // if there's another rig currently active we need to make sure we have at least the same priority
733
+ rig.priority = currentlyActive?.priority ?? 0;
734
+ this.updateActiveXRRig();
735
+ }
736
+ /**
737
+ * @returns the user position in the rig space
738
+ */
739
+ getUserOffsetInRig() {
740
+ const positionInRig = this.context.mainCamera?.position;
741
+ if (!positionInRig || !this.rig) return getTempVector(0, 0, 0);
742
+ const vec = getTempVector(positionInRig);
743
+ vec.x *= -1;
744
+ vec.z *= -1;
745
+ vec.applyQuaternion(getTempQuaternion(this.rig.gameObject.quaternion));
746
+ return vec;
747
+ }
748
+ private updateActiveXRRig() {
749
+ const previouslyActiveRig = this._rigs[0] ?? null;
750
+
751
+ // ensure that the default rig is in the scene
752
+ if (this._defaultRig.gameObject.parent !== this.context.scene)
753
+ this.context.scene.add(this._defaultRig.gameObject);
754
+ // ensure the fallback rig is always active!!!
755
+ this._defaultRig.gameObject.visible = true;
756
+ // ensure that the default rig is in the list of available rigs
757
+ if (!this._rigs.includes(this._defaultRig))
758
+ this._rigs.push(this._defaultRig);
759
+
760
+ // find the rig with the highest priority and make sure it's at the beginning of the array
761
+ let highestPriorityRig: IXRRig = this._rigs[0];
762
+ if (highestPriorityRig && highestPriorityRig.priority === undefined) highestPriorityRig.priority = 0;
763
+
764
+ for (let i = 1; i < this._rigs.length; i++) {
765
+ const rig = this._rigs[i];
766
+ if (!rig.isActive) continue;
767
+ if (isDestroyed(rig.gameObject)) {
768
+ this._rigs.splice(i, 1);
769
+ i--;
770
+ continue;
771
+ }
772
+ if (!highestPriorityRig || highestPriorityRig.isActive === false || (rig.priority !== undefined && rig.priority > highestPriorityRig.priority!)) {
773
+ highestPriorityRig = rig;
774
+ }
775
+ }
776
+
777
+ // make sure the highest priority rig is at the beginning if it isnt already
778
+ if (previouslyActiveRig !== highestPriorityRig) {
779
+ const index = this._rigs.indexOf(highestPriorityRig);
780
+ if (index >= 0) this._rigs.splice(index, 1);
781
+ this._rigs.unshift(highestPriorityRig);
782
+ }
783
+
784
+ if (debug) {
785
+ if (previouslyActiveRig === highestPriorityRig)
786
+ console.log("Updated Active XR Rig:", highestPriorityRig, "prev:", previouslyActiveRig);
787
+ else console.log("Updated Active XRRig:", highestPriorityRig, " (the same as before)");
788
+ }
789
+ }
790
+ private _rigs: IXRRig[] = [];
791
+
792
+
793
+
794
+ private _viewerHitTestSource: XRHitTestSource | null = null;
795
+
796
+ /** Returns a XR hit test result (if hit-testing is available) in rig space
797
+ * @param source If provided, the hit test will be performed for the given controller
798
+ */
799
+ getHitTest(source?: NeedleXRController): NeedleXRHitTestResult | null {
800
+ if (source) {
801
+ return this.getControllerHitTest(source);
802
+ }
803
+
804
+ if (!this._viewerHitTestSource) return null;
805
+ const hitTestSource = this._viewerHitTestSource;
806
+ const hitTestResults = this.frame.getHitTestResults(hitTestSource);
807
+ if (hitTestResults.length > 0) {
808
+ const hit = hitTestResults[0];
809
+ return this.convertHitTestResult(hit);
810
+ }
811
+ return null;
812
+ }
813
+ private getControllerHitTest(controller: NeedleXRController): NeedleXRHitTestResult | null {
814
+ const hitTestSource = controller.getHitTestSource();
815
+ if (!hitTestSource) return null;
816
+ const res = this.frame.getHitTestResultsForTransientInput(hitTestSource);
817
+ for (const result of res) {
818
+ if (result.inputSource === controller.inputSource) {
819
+ for (const hit of result.results) {
820
+ return this.convertHitTestResult(hit);
821
+ }
822
+ }
823
+ }
824
+ return null;
825
+ }
826
+ private convertHitTestResult(result: XRHitTestResult): NeedleXRHitTestResult | null {
827
+ const referenceSpace = this.context.renderer.xr.getReferenceSpace();
828
+ const pose = referenceSpace && result.getPose(referenceSpace);
829
+ if (pose) {
830
+ const pos = getTempVector(pose.transform.position);
831
+ const rot = getTempQuaternion(pose.transform.orientation);
832
+ const camera = this.context.mainCamera;
833
+ if (camera?.parent !== this._cameraRenderParent) {
834
+ pos.applyMatrix4(flipForwardMatrix);
835
+ }
836
+ if (camera?.parent) {
837
+ pos.applyMatrix4(camera.parent.matrixWorld);
838
+ rot.multiply(flipForwardQuaternion);
839
+ // apply parent quaternion (if parent is moved/rotated)
840
+ const parentRotation = getWorldQuaternion(camera.parent);
841
+ // ensure that "up" (y+) is pointing away from the wall
842
+ parentRotation.premultiply(flipForwardQuaternion);
843
+ rot.premultiply(parentRotation);
844
+ }
845
+ return { hit: result, position: pos, quaternion: rot };
846
+ }
847
+ return null;
848
+ }
849
+
850
+
851
+ /** convert a XRRigidTransform from XR session space to threejs / Needle Engine XR space */
852
+ convertSpace(transform: XRRigidTransform): { position: Vector3, quaternion: Quaternion } {
853
+ const pos = getTempVector(transform.position);
854
+ pos.applyMatrix4(flipForwardMatrix);
855
+ const rot = getTempQuaternion(transform.orientation);
856
+ rot.premultiply(flipForwardQuaternion);
857
+ return { position: pos, quaternion: rot };
858
+ }
859
+
860
+ /** this is the implictly created XR rig */
861
+ private readonly _defaultRig: IXRRig;
862
+
863
+ /** all scripts that receive some sort of XR update event */
864
+ private readonly _xr_scripts: INeedleXRSessionEventReceiver[];
865
+ /** scripts that have onUpdateXR event methods */
866
+ private readonly _xr_update_scripts: INeedleXRSessionEventReceiver[] = [];
867
+ /** scripts that are in the scene but inactive (e.g. disabled parent gameObject) */
868
+ private readonly _inactive_scripts: INeedleXRSessionEventReceiver[] = [];
869
+ private readonly _controllerAdded: ControllerChangedEvt[];
870
+ private readonly _controllerRemoved: ControllerChangedEvt[];
871
+ private readonly _originalCameraWorldPosition?: Vector3 | null;
872
+ private readonly _originalCameraWorldRotation?: Quaternion | null;
873
+ private readonly _originalCameraWorldScale?: Vector3 | null;
874
+ private readonly _originalCameraParent?: Object3D | null;
875
+ /** we store the main camera reference here each frame to make sure we have a rendering camera
876
+ * this e.g. the case when the XR rig with the camera gets disabled (and thus this.context.mainCamera is unassigned)
877
+ */
878
+ private _mainCamera: ICamera | null = null;
879
+
880
+ private constructor(mode: XRSessionMode, session: XRSession, context: Context, extra: {
881
+ scripts: INeedleXRSessionEventReceiver[],
882
+ controller_added: ControllerChangedEvt[],
883
+ controller_removed: ControllerChangedEvt[],
884
+ /** the initialization arguments */
885
+ init: XRSessionInit,
886
+ }) {
887
+ performance.mark(measure_SessionStartedMarker);
888
+
889
+ saveSessionInfo(mode, extra.init);
890
+ this.session = session;
891
+ this.mode = mode;
892
+ this.context = context;
893
+
894
+
895
+ if (debug || getParam("console")) enableSpatialConsole(true);
896
+
897
+ this._xr_scripts = [...extra.scripts];
898
+ this._xr_update_scripts = this._xr_scripts.filter(e => typeof e.onUpdateXR === "function");
899
+ this._controllerAdded = extra.controller_added;
900
+ this._controllerRemoved = extra.controller_removed;
901
+
902
+ registerFrameEventCallback(this.onBefore, FrameEvent.LateUpdate);
903
+ this.context.pre_render_callbacks.push(this.onBeforeRender);
904
+ this.context.post_render_callbacks.push(this.onAfterRender);
905
+
906
+
907
+ if (extra.init.optionalFeatures?.includes("hit-test") || extra.init.requiredFeatures?.includes("hit-test")) {
908
+ session.requestReferenceSpace('viewer').then((referenceSpace) => {
909
+ return session.requestHitTestSource?.call(session, { space: referenceSpace })?.then((source) => {
910
+ return this._viewerHitTestSource = source;
911
+ }).catch(e => console.error(e));
912
+ }).catch(e => console.error(e));
913
+ }
914
+
915
+ if (this.context.mainCamera) {
916
+ this._originalCameraWorldPosition = getWorldPosition(this.context.mainCamera, new Vector3());
917
+ this._originalCameraWorldRotation = getWorldQuaternion(this.context.mainCamera, new Quaternion());
918
+ this._originalCameraWorldScale = getWorldScale(this.context.mainCamera, new Vector3());
919
+ this._originalCameraParent = this.context.mainCamera.parent;
920
+ }
921
+
922
+ this._defaultRig = new ImplictXRRig();
923
+ this.context.scene.add(this._defaultRig.gameObject);
924
+ this.addRig(this._defaultRig);
925
+
926
+ // register already connected input sources
927
+ // this is for when the session is already running (via a temporary xr session)
928
+ // and the controllers are already connected
929
+ for (let i = 0; i < session.inputSources.length; i++) {
930
+ const inputSource = session.inputSources[i];
931
+ if (!inputSource.handedness) {
932
+ console.warn("Input source in xr session has no handedness - ignoring", i);
933
+ continue;
934
+ }
935
+ this.onInputSourceAdded(inputSource);
936
+ }
937
+
938
+ // handle controller and input source changes changes
939
+ this.session.addEventListener('end', this.onEnd);
940
+ // handle input sources change
941
+ this.session.addEventListener("inputsourceschange",
942
+ /* @ts-ignore (ignore CI XRInputSourceChangeEvent mismatch) */
943
+ (evt: XRInputSourcesChangeEvent) => {
944
+ // handle removed controllers
945
+ for (const removedInputSource of evt.removed) {
946
+ this.disconnectInputSource(removedInputSource);
947
+ }
948
+ for (const newInputSource of evt.added) {
949
+ this.onInputSourceAdded(newInputSource);
950
+ }
951
+ });
952
+
953
+ // Unfortunately the code below doesnt work: the session never receives any input sources sometimes
954
+ // https://developer.mozilla.org/en-US/docs/Web/API/XRSession/visibilitychange_event
955
+ // this.session.addEventListener("visibilitychange", (evt: XRSessionEvent) => {
956
+ // // sometimes when entering an XR session the controllers are not added/not in the list and we don't receive an event
957
+ // // this is a workaround trying to add controllers when the scene visibility changes to "visible"
958
+ // // e.g. due to a user opening and closing the menu
959
+ // if (this.controllers.length === 0 && evt.session.visibilityState === "visible") {
960
+ // for (const controller of evt.session.inputSources) {
961
+ // this.onInputSourceAdded(controller);
962
+ // }
963
+ // }
964
+ // })
965
+
966
+ // we set the session on the webxr manager at the end because we want to receive inputsource events first
967
+ // e.g. in case there's a bug in the threejs codebase
968
+ this.context.xr = this;
969
+ this.context.renderer.xr.setSession(this.session).then(this.onRendererSessionSet);
970
+ // disable three.js renderer controller autoUpdate (added in ac67b31e3548386f8a93e23a4176554c92bbd0d9)
971
+ if ("controllerAutoUpdate" in this.context.renderer.xr) {
972
+ console.debug("Disabling three.js controllerAutoUpdate");
973
+ this.context.renderer.xr.controllerAutoUpdate = false;
974
+ }
975
+ else if (debug) {
976
+ console.warn("controllerAutoUpdate is not available in three.js - cannot disable it");
977
+ }
978
+ }
979
+
980
+ /** called when renderer.setSession is fulfilled */
981
+ private onRendererSessionSet = () => {
982
+ if (!this.running) return;
983
+ this.context.renderer.xr.enabled = true;
984
+ // calling update camera here once to prevent the xr camera left/right NaN in the first frame due to false near/far plane values, see NE-4126
985
+ this.context.renderer.xr.updateCamera(this.context.mainCamera as PerspectiveCamera);
986
+ this.context.mainCameraComponent?.applyClearFlags();
987
+ }
988
+
989
+ private onInputSourceAdded = (newInputSource: XRInputSource) => {
990
+ // do not create XR controllers for screen input sources
991
+ if (newInputSource.targetRayMode === "screen") {
992
+ return;
993
+ }
994
+ let index = 0;
995
+ for (let i = 0; i < this.session.inputSources.length; i++) {
996
+ if (this.session.inputSources[i] === newInputSource) {
997
+ index = i;
998
+ break;
999
+ }
1000
+ }
1001
+ // check if an xr controller for this input source already exists
1002
+ // in case we have both an event from inputsourceschange and from the construtor initial input sources
1003
+ if (this.controllers.find(c => c.inputSource === newInputSource)) {
1004
+ console.debug("Controller already exists for input source", index);
1005
+ return;
1006
+ }
1007
+ else if(this._newControllers.find(c => c.inputSource === newInputSource)) {
1008
+ console.debug("Controller already registered for input source", index);
1009
+ return;
1010
+ }
1011
+ // TODO: check if this is a transient input source AND we can figure out which existing controller it likely belongs to
1012
+ // TODO: do not draw raycasts for controllers that don't have primary input actions / until we know that they have primary input actions
1013
+ const newController = new NeedleXRController(this, newInputSource, index);
1014
+ this._newControllers.push(newController);
1015
+ }
1016
+
1017
+ /** Disconnects the controller, invokes events and notifies previou controller (if any) */
1018
+ private disconnectInputSource(inputSource: XRInputSource) {
1019
+ const handleRemove = (oldController: NeedleXRController, _array: Array<NeedleXRController>, i: number) => {
1020
+ if (oldController.inputSource === inputSource) {
1021
+ if (debug) console.log("Disconnecting controller", oldController.index);
1022
+ this.controllers.splice(i, 1);
1023
+ this.invokeControllerEvent(oldController, this._controllerRemoved, "removed");
1024
+ const args: NeedleXRControllerEventArgs = {
1025
+ xr: this,
1026
+ controller: oldController,
1027
+ change: "removed"
1028
+ };
1029
+ for (const script of this._xr_scripts) {
1030
+ if (script.onXRControllerRemoved) script.onXRControllerRemoved(args);
1031
+ }
1032
+ oldController.onDisconnected();
1033
+ }
1034
+ }
1035
+ for (let i = this.controllers.length - 1; i >= 0; i--) {
1036
+ const oldController = this.controllers[i];
1037
+ handleRemove(oldController, this.controllers, i);
1038
+ }
1039
+ for (let i = this._newControllers.length - 1; i >= 0; i--) {
1040
+ const oldController = this._newControllers[i];
1041
+ handleRemove(oldController, this._newControllers, i);
1042
+ }
1043
+ }
1044
+
1045
+ /** End the XR Session */
1046
+ end() {
1047
+ // this can be called by external code to end the session
1048
+ // the actual cleanup happens in onEnd which subscribes to the session end event
1049
+ // so users can also just regularly call session.end() and the cleanup will happen automatically
1050
+ if (this._ended) return;
1051
+ this.session.end().catch(e => console.warn(e));
1052
+ }
1053
+
1054
+ private _ended: boolean = false;
1055
+ private readonly _newControllers: NeedleXRController[] = [];
1056
+
1057
+ private onEnd = (_evt: XRSessionEvent) => {
1058
+ if (this._ended) return;
1059
+ this._ended = true;
1060
+
1061
+ console.debug("XR Session ended");
1062
+
1063
+ deleteSessionInfo();
1064
+
1065
+ this.onAfterRender();
1066
+ this.revertCustomForward();
1067
+ this._didStart = false;
1068
+ this._previousCameraParent = null;
1069
+
1070
+ unregisterFrameEventCallback(this.onBefore, FrameEvent.LateUpdate);
1071
+ const index = this.context.pre_render_callbacks.indexOf(this.onBeforeRender);
1072
+ if (index >= 0) this.context.pre_render_callbacks.splice(index, 1);
1073
+ const index2 = this.context.post_render_callbacks.indexOf(this.onAfterRender);
1074
+ if (index2 >= 0) this.context.post_render_callbacks.splice(index2, 1);
1075
+
1076
+ this.context.xr = null;
1077
+ this.context.renderer.xr.enabled = false;
1078
+ // apply the clearflags at the beginning of the next frame
1079
+ this.context.pre_update_oneshot_callbacks.push(() => {
1080
+ this.context.mainCameraComponent?.applyClearFlags()
1081
+ this.context.mainCameraComponent?.applyClippingPlane();
1082
+ });
1083
+
1084
+ invokeXRSessionEnd({ session: this });
1085
+
1086
+ for (const listener of NeedleXRSession._xrEndListeners) {
1087
+ listener({ xr: this });
1088
+ }
1089
+
1090
+ // make sure we disconnect all controllers
1091
+ // we copy the array because the disconnectInputSource method modifies the controllers array
1092
+ const copy = [...this.controllers];
1093
+ for (let i = 0; i < copy.length; i++) {
1094
+ this.disconnectInputSource(copy[i].inputSource);
1095
+ }
1096
+ this._newControllers.length = 0;
1097
+ this.controllers.length = 0;
1098
+
1099
+ // we want to call leave XR for *all* scripts that are still registered
1100
+ // even if they might already be destroyed e.g. by the WebXR component (it destroys the default controller scripts)
1101
+ // they should still receive this callback to be properly cleaned up
1102
+ for (const listener of this._xr_scripts) {
1103
+ listener?.onLeaveXR?.({ xr: this });
1104
+ }
1105
+
1106
+ this.sync?.onExitXR(this);
1107
+
1108
+
1109
+ if (this.context.mainCamera) {
1110
+ // if we have a main camera we want to move it back to it's original parent
1111
+ this._originalCameraParent?.add(this.context.mainCamera);
1112
+
1113
+ if (this._originalCameraWorldPosition) {
1114
+ setWorldPosition(this.context.mainCamera, this._originalCameraWorldPosition);
1115
+ }
1116
+ if (this._originalCameraWorldRotation) {
1117
+ setWorldQuaternion(this.context.mainCamera, this._originalCameraWorldRotation);
1118
+ }
1119
+ if (this._originalCameraWorldScale) {
1120
+ setWorldScale(this.context.mainCamera, this._originalCameraWorldScale);
1121
+ }
1122
+ }
1123
+
1124
+ // mark for size change since DPI might have changed
1125
+ this.context.requestSizeUpdate();
1126
+
1127
+ this._defaultRig.gameObject.removeFromParent();
1128
+
1129
+ enableSpatialConsole(false);
1130
+
1131
+ performance.mark(measure_SessionEndedMarker);
1132
+ performance.measure('NeedleXRSession', measure_SessionStartedMarker, measure_SessionEndedMarker);
1133
+ };
1134
+
1135
+ private _didStart: boolean = false;
1136
+
1137
+ /** Called every frame by the engine */
1138
+ private onBefore = (context: Context) => {
1139
+ const frame = context.xrFrame;
1140
+ if (!frame) return;
1141
+
1142
+ performance.mark('NeedleXRSession onBefore start');
1143
+
1144
+ // ensure that XR is always set to a running session
1145
+ this.context.xr = this;
1146
+
1147
+ // ensure that we always have the correct main camera reference
1148
+ // we need to store the main camera reference here because the main camera can be disabled and then it's removed from the context
1149
+ // but in XR we want to ensure we always have a active camera (or at least parent the camera to the active rig)
1150
+ if (this.context.mainCameraComponent && this.context.mainCameraComponent !== this._mainCamera) {
1151
+ this._mainCamera = this.context.mainCameraComponent;
1152
+ }
1153
+
1154
+ if (this.rig?.isActive == false) {
1155
+ if (debug) console.warn("Latest rig is not active - trying to activate a different rig", this.rig);
1156
+ this.updateActiveXRRig();
1157
+ }
1158
+
1159
+ // make sure the camera is parented to the active rig
1160
+ if (this.rig && this._mainCamera?.gameObject) {
1161
+ const currentParent = this._mainCamera?.gameObject?.parent;
1162
+ if (currentParent !== this.rig.gameObject) {
1163
+ this.rig.gameObject.add(this._mainCamera?.gameObject);
1164
+ }
1165
+ }
1166
+
1167
+ this.internalUpdateState();
1168
+
1169
+ // we apply the flip immediately and keep it while in XR so that regular raycasts just work
1170
+ // otherwise rendering would fool us
1171
+ this.applyCustomForward();
1172
+
1173
+ const args: NeedleXREventArgs = { xr: this };
1174
+
1175
+ // we want to invoke ENTERXR for NEW component nad EXITXR for REMOVED components
1176
+ // we want to invoke onControllerAdded to components joining a running XR session if controllers are already connected
1177
+ //TODO: handle REMOVED components during a session (we want to call leave session events and controller removed events)
1178
+
1179
+ // deferred start because we need an XR frame
1180
+ if (!this._didStart) {
1181
+ this._didStart = true;
1182
+
1183
+ // place default rig to view the scene
1184
+ if (this.mode === "immersive-vr") {
1185
+ const bounds = getBoundingBox(this.context.scene.children);
1186
+ if (bounds) {
1187
+ const size = bounds.getSize(getTempVector());
1188
+ if (size.length() > 0) {
1189
+ const rigobject = this._defaultRig.gameObject;
1190
+ rigobject.position.set(bounds.min.x + size.x * .5, bounds.min.y, bounds.max.z + size.z * .5 + 1.5);
1191
+ const centerLook = bounds.getCenter(getTempVector());
1192
+ centerLook.y = rigobject.position.y;
1193
+ rigobject.lookAt(centerLook);
1194
+ }
1195
+ }
1196
+ }
1197
+
1198
+ invokeXRSessionStart({ session: this });
1199
+
1200
+ for (const listener of NeedleXRSession._xrStartListeners) {
1201
+ listener(args);
1202
+ }
1203
+
1204
+ // invoke session listeners start
1205
+ // we need to make a copy because the array might be modified during the loop (could also use a for loop and iterate backwards perhaps but then order of invocation would be changed OR check if the size has changed...)
1206
+ const copy = [...this._xr_scripts];
1207
+ if (debug) console.log("NeedleXRSession start, handle scripts:", copy);
1208
+ for (const script of copy) {
1209
+ if (script.destroyed) {
1210
+ this._script_to_remove.push(script);
1211
+ continue;
1212
+ }
1213
+ if (!script.activeAndEnabled) {
1214
+ this.markInactive(script);
1215
+ continue;
1216
+ }
1217
+ // if ((script as IComponent).activeAndEnabled === false) continue;
1218
+ this.invokeCallback_EnterXR(script);
1219
+ // also invoke all events for currently (already) connected controllers
1220
+ for (const controller of this.controllers) {
1221
+ this.invokeCallback_ControllerAdded(script, controller);
1222
+ }
1223
+ }
1224
+ }
1225
+ else if (this.context.new_scripts_xr.length > 0) {
1226
+ // invoke start on all new scripts that were added during the session and that support the current mode
1227
+ const copy = [...this.context.new_scripts_xr];
1228
+ for (let i = 0; i < copy.length; i++) {
1229
+ const script = this.context.new_scripts_xr[i] as IComponent & INeedleXRSessionEventReceiver;
1230
+ if (!script || script.destroyed || script.supportsXR?.(this.mode) == false) {
1231
+ this.context.new_scripts_xr.splice(i, 1);
1232
+ continue;
1233
+ }
1234
+ if (!script.activeAndEnabled) {
1235
+ this.context.new_scripts_xr.splice(i, 1);
1236
+ this.markInactive(script);
1237
+ continue;
1238
+ }
1239
+ // ignore inactive scripts
1240
+ // if (script.activeAndEnabled === false) continue;
1241
+ if (this.addScript(script)) {
1242
+ // invoke onEnterXR on those scripts because they joined a running session
1243
+ this.invokeCallback_EnterXR(script);
1244
+ // also invoke all events for currently (already) connected controllers
1245
+ for (const controller of this.controllers) {
1246
+ this.invokeCallback_ControllerAdded(script, controller);
1247
+ }
1248
+ }
1249
+ }
1250
+ }
1251
+
1252
+ // make sure camera layers are correct
1253
+ // we do this every frame here but I think it would be enough to do it once after the first rendering
1254
+ // since we want to override the settings in three's WebXRManager
1255
+ // we also want to continuously sync the culling mask if a user changes it on the main cam while in XR
1256
+ this.syncCameraCullingMask();
1257
+
1258
+ // update controllers
1259
+ for (const controller of this.controllers) {
1260
+ controller.onUpdate(frame);
1261
+ }
1262
+
1263
+ // handle when new controllers have been added
1264
+ if (this._newControllers.length > 0) {
1265
+ const copy = [...this._newControllers];
1266
+ this._newControllers.length = 0;
1267
+ for (const controller of copy) {
1268
+ if (!controller.connected) {
1269
+ console.warn("New controller is not connected", controller);
1270
+ continue;
1271
+ }
1272
+ this.controllers.push(controller);
1273
+ for (const script of this._xr_scripts) {
1274
+ if (script.destroyed) {
1275
+ this._script_to_remove.push(script);
1276
+ continue;
1277
+ }
1278
+ if (script.activeAndEnabled === false) {
1279
+ continue;
1280
+ }
1281
+ this.invokeCallback_ControllerAdded(script, controller);
1282
+ // if (script.onXRControllerAdded)
1283
+ // script.onXRControllerAdded({ xr: this, controller, change: "added" });
1284
+ }
1285
+ }
1286
+ this.controllers.sort((a, b) => a.index - b.index);
1287
+ }
1288
+
1289
+ if (debug && this.context.time.frame % 30 === 0 && this.controllers.length <= 0 && this.session.inputSources.length > 0) {
1290
+ enableSpatialConsole(true)
1291
+ console.error("XRControllers are not added but inputSources are present");
1292
+ }
1293
+
1294
+ performance.mark('NeedleXRSession update scripts start');
1295
+ // invoke update on all scripts
1296
+ for (const script of this._xr_update_scripts) {
1297
+ if (script.destroyed === true) {
1298
+ this._script_to_remove.push(script);
1299
+ continue;
1300
+ }
1301
+ if (script.activeAndEnabled === false) {
1302
+ this.markInactive(script);
1303
+ continue;
1304
+ }
1305
+ if (script.onUpdateXR) script.onUpdateXR(args);
1306
+ }
1307
+ performance.mark('NeedleXRSession update scripts end');
1308
+ performance.measure('NeedleXRSession update scripts', 'NeedleXRSession update scripts start', 'NeedleXRSession update scripts end');
1309
+
1310
+ // handle inactive scripts
1311
+ this.handleInactiveScripts();
1312
+
1313
+ // handle removed scripts
1314
+ if (this._script_to_remove.length > 0) {
1315
+ // make sure we have no duplicates
1316
+ const unique = [...new Set(this._script_to_remove)];
1317
+ this._script_to_remove.length = 0;
1318
+ for (const script of unique) {
1319
+ if (!script.destroyed && this.running) {
1320
+ script.onLeaveXR?.(args);
1321
+ }
1322
+ this.removeScript(script);
1323
+ }
1324
+ }
1325
+
1326
+ this.sync?.onUpdate(this);
1327
+
1328
+ this.onRenderDebug();
1329
+ performance.mark('NeedleXRSession onBefore end');
1330
+ performance.measure('NE XR frame', 'NeedleXRSession onBefore start', 'NeedleXRSession onBefore end');
1331
+ }
1332
+
1333
+ private onRenderDebug() {
1334
+ if (debug) {
1335
+ for (const controller of this.controllers) {
1336
+ controller.onRenderDebug();
1337
+ }
1338
+ }
1339
+ if ((debug || debugFPS) && this.rig) {
1340
+ debugFPSFramesSinceLastUpdate++;
1341
+ if (debugFPSFramesSinceLastUpdate >= 20) {
1342
+ const pos = this.rig.gameObject.worldPosition;
1343
+ const forward = this.rig.gameObject.worldForward;
1344
+ pos.add(forward.multiplyScalar(1.5));
1345
+ const upwards = this.rig.gameObject.worldUp;
1346
+ pos.add(upwards.multiplyScalar(2.5));
1347
+ let debugLabel = "";
1348
+ debugLabel += `${this.context.time.smoothedFps.toFixed(0)} FPS`;
1349
+ debugLabel += `, calls: ${this.context.renderer.info.render.calls}, tris: ${this.context.renderer.info.render.triangles.toLocaleString()}`;
1350
+ if (debug || debugFPS) {
1351
+ for (const ctrl of this.controllers) {
1352
+ debugLabel += `\n${ctrl.hand ? "hand" : "ctrl"} ${ctrl.inputSource.handedness}[${ctrl.index}] con:${ctrl.connected} tr:${ctrl.isTracking} hts:${ctrl.hasHitTestSource ? "yes" : "no"}`;
1353
+ }
1354
+ }
1355
+ debugFPSFramesSinceLastUpdate = 0;
1356
+ Gizmos.DrawLabel(pos, debugLabel, undefined, 1 / 60 * 20);
1357
+ }
1358
+ }
1359
+ }
1360
+
1361
+ private onBeforeRender = () => {
1362
+ if (this.context.mainCamera)
1363
+ this.updateFade(this.context.mainCamera);
1364
+ }
1365
+
1366
+ private onAfterRender = () => {
1367
+ this.onUpdateFade_PostRender();
1368
+
1369
+ // render spectator view if we're in VR using Link
1370
+ // __rendered_once is for when we are on device, but opening the browser should not show a blank space
1371
+ if (DeviceUtilities.isDesktop() || !this["_renderOnceOnDevice"]) {
1372
+ const renderer = this.context.renderer;
1373
+ if (renderer.xr.isPresenting && this.context.mainCamera) {
1374
+ this["_renderOnceOnDevice"] = true;
1375
+ const wasXr = renderer.xr.enabled;
1376
+ const previousRenderTarget = renderer.getRenderTarget();
1377
+ const previousBackground = this.context.scene.background;
1378
+ renderer.xr.enabled = false;
1379
+ renderer.setRenderTarget(null);
1380
+ if (this.isPassThrough) this.context.scene.background = null;
1381
+ if (this.context.composer) {
1382
+ this.context.composer.render(this.context.time.deltaTime);
1383
+ }
1384
+ else {
1385
+ renderer.render(this.context.scene, this.context.mainCamera);
1386
+ }
1387
+ renderer.xr.enabled = wasXr;
1388
+ renderer.setRenderTarget(previousRenderTarget);
1389
+ this.context.scene.background = previousBackground;
1390
+ }
1391
+ }
1392
+ }
1393
+
1394
+ /** register a new XR script if it hasnt added yet */
1395
+ private addScript(script: INeedleXRSessionEventReceiver) {
1396
+ if (this._xr_scripts.includes(script)) return false;
1397
+ if (debug) console.log("Register new XRScript", script);
1398
+ this._xr_scripts.push(script);
1399
+ if (typeof script.onUpdateXR === "function") {
1400
+ this._xr_update_scripts.push(script);
1401
+ }
1402
+ return true;
1403
+ }
1404
+
1405
+ /** mark a script as inactive and invokes callbacks */
1406
+ private markInactive(script: INeedleXRSessionEventReceiver) {
1407
+ if (this._inactive_scripts.indexOf(script) >= 0) return;
1408
+ // inactive scripts should not receive any regular callbacks anymore
1409
+ this.removeScript(script, false);
1410
+ this._inactive_scripts.push(script);
1411
+ // inactive scripts receive callbacks as if the XR session has ended
1412
+ for (const ctrl of this.controllers) this.invokeCallback_ControllerRemoved(script, ctrl);
1413
+ this.invokeCallback_LeaveXR(script);
1414
+ }
1415
+ private handleInactiveScripts() {
1416
+ if (this._inactive_scripts.length > 0) {
1417
+ for (let i = this._inactive_scripts.length - 1; i >= 0; i--) {
1418
+ const script = this._inactive_scripts[i];
1419
+ if (script.activeAndEnabled) {
1420
+ this._inactive_scripts.splice(i, 1);
1421
+ this.addScript(script);
1422
+ this.invokeCallback_EnterXR(script);
1423
+ for (const ctrl of this.controllers) this.invokeCallback_ControllerAdded(script, ctrl);
1424
+ }
1425
+ }
1426
+ }
1427
+ }
1428
+
1429
+ private readonly _script_to_remove: INeedleXRSessionEventReceiver[] = [];
1430
+
1431
+ private removeScript(script: INeedleXRSessionEventReceiver, removeCompletely: boolean = true) {
1432
+ if (debug) console.log("Remove XRScript", script);
1433
+ const index = this._xr_scripts.indexOf(script);
1434
+ if (index >= 0) this._xr_scripts.splice(index, 1);
1435
+ const index2 = this._xr_update_scripts.indexOf(script);
1436
+ if (index2 >= 0) this._xr_update_scripts.splice(index2, 1);
1437
+ if (removeCompletely) {
1438
+ const index3 = this._inactive_scripts.indexOf(script);
1439
+ if (index3 >= 0) this._inactive_scripts.splice(index3, 1);
1440
+ }
1441
+ }
1442
+
1443
+ private invokeCallback_EnterXR(script: INeedleXRSessionEventReceiver) {
1444
+ if (script.onEnterXR) {
1445
+ script.onEnterXR({ xr: this });
1446
+ }
1447
+ }
1448
+ private invokeCallback_ControllerAdded(script: INeedleXRSessionEventReceiver, controller: NeedleXRController) {
1449
+ if (script.onXRControllerAdded) {
1450
+ script.onXRControllerAdded({ xr: this, controller, change: "added" });
1451
+ }
1452
+ }
1453
+ private invokeCallback_ControllerRemoved(script: INeedleXRSessionEventReceiver, controller: NeedleXRController) {
1454
+ if (script.onXRControllerRemoved) {
1455
+ script.onXRControllerRemoved({ xr: this, controller, change: "removed" });
1456
+ }
1457
+ }
1458
+ private invokeCallback_LeaveXR(script: INeedleXRSessionEventReceiver) {
1459
+ if (script.onLeaveXR && !script.destroyed) {
1460
+ script.onLeaveXR({ xr: this });
1461
+ }
1462
+ }
1463
+
1464
+ private syncCameraCullingMask() {
1465
+ // when we set unity layers objects will only be rendered on one eye
1466
+ // we set layers to sync raycasting and have a similar behaviour to unity
1467
+ const cam = this.context.xrCamera;
1468
+ const cull = this.context.mainCameraComponent?.cullingMask;
1469
+ if (cam && cull !== undefined) {
1470
+ for (const c of cam.cameras) {
1471
+ c.layers.mask = cull;
1472
+ }
1473
+ cam.layers.mask = cull;
1474
+ }
1475
+ else if (cam) {
1476
+ for (const c of cam.cameras) {
1477
+ c.layers.enableAll();
1478
+ }
1479
+ cam.layers.enableAll();
1480
+ }
1481
+ }
1482
+
1483
+ private invokeControllerEvent(controller: NeedleXRController, listeners: ControllerChangedEvt[], change: "added" | "removed") {
1484
+ for (let i = listeners.length - 1; i >= 0; i--) {
1485
+ const listener = listeners[i];
1486
+ if (!listener) continue;
1487
+ try {
1488
+ listener({
1489
+ xr: this,
1490
+ controller,
1491
+ change
1492
+ });
1493
+ }
1494
+ catch (e) {
1495
+ console.error(e);
1496
+ }
1497
+ }
1498
+ }
1499
+
1500
+
1501
+ private _camera!: Object3D;
1502
+ private readonly _cameraRenderParent: Object3D = new Object3D().rotateY(Math.PI);
1503
+ private _previousCameraParent!: Object3D | null;
1504
+ private readonly _customforward: boolean = true;
1505
+ private originalCameraNearPlane?: number;
1506
+ /** This is used to have the XR system camera look into threejs Z forward direction (instead of -z) */
1507
+ private applyCustomForward() {
1508
+ if (this.context.mainCamera && this._customforward) {
1509
+ this._camera = this.context.mainCamera;
1510
+ if (this._camera.parent !== this._cameraRenderParent) {
1511
+ this._previousCameraParent = this._camera.parent;
1512
+ this._previousCameraParent?.add(this._cameraRenderParent);
1513
+ }
1514
+ this._cameraRenderParent.name = "XR Camera Render Parent";
1515
+ this._cameraRenderParent.add(this._camera);
1516
+
1517
+ let minNearPlane = .02;
1518
+ if (this.rig) {
1519
+ const rigWorldScale = getWorldScale(this.rig.gameObject);
1520
+ minNearPlane *= rigWorldScale.x;
1521
+ }
1522
+ if (this._camera instanceof PerspectiveCamera && this._camera.near > minNearPlane) {
1523
+ this.originalCameraNearPlane = this._camera.near;
1524
+ this._camera.near = minNearPlane;
1525
+ }
1526
+ }
1527
+ }
1528
+ private revertCustomForward() {
1529
+ if (this._camera && this._previousCameraParent) {
1530
+ this._previousCameraParent.add(this._camera);
1531
+ }
1532
+ this._previousCameraParent = null;
1533
+
1534
+ if (this._camera instanceof PerspectiveCamera && this.originalCameraNearPlane != undefined) {
1535
+ this._camera.near = this.originalCameraNearPlane;
1536
+ }
1537
+ }
1538
+
1539
+
1540
+ private _viewerPose?: XRViewerPose;
1541
+ private readonly _transformOrientation = new Quaternion();
1542
+ private readonly _transformPosition = new Vector3();
1543
+
1544
+ private internalUpdateState() {
1545
+ const referenceSpace = this.context.renderer.xr.getReferenceSpace();
1546
+ if (!referenceSpace) {
1547
+ this._viewerPose = undefined;
1548
+ return;
1549
+ }
1550
+ this._viewerPose = this.frame.getViewerPose(referenceSpace);
1551
+ if (this._viewerPose) {
1552
+ const transform: XRRigidTransform = this._viewerPose.transform;
1553
+ this._transformPosition.set(transform.position.x, transform.position.y, transform.position.z);
1554
+ this._transformOrientation.set(transform.orientation.x, transform.orientation.y, transform.orientation.z, transform.orientation.w);
1555
+ }
1556
+ }
1557
+
1558
+ // TODO: for scene transitions (e.g. SceneSwitcher) where creating the scene might take a few moments we might want more control over when/how this fading occurs and how long the scene stays black
1559
+ private _transition?: SceneTransition;
1560
+
1561
+ public get transition() {
1562
+ if (!this._transition) this._transition = new SceneTransition();
1563
+ return this._transition;
1564
+ }
1565
+
1566
+ /** Call to fade rendering to black for a short moment (the returned promise will be resolved when fully black)
1567
+ * This can be used to mask scene transitions or teleportation
1568
+ * @returns a promise that is resolved when the screen is fully black
1569
+ * @example `fadeTransition().then(() => { <fully_black> })`
1570
+ */
1571
+ fadeTransition() {
1572
+ if (!this._transition) this._transition = new SceneTransition();
1573
+ return this._transition.fadeTransition();
1574
+ }
1575
+
1576
+ /** e.g. FadeToBlack */
1577
+ private updateFade(camera: Camera) {
1578
+ if (this._transition && camera instanceof PerspectiveCamera)
1579
+ this._transition.update(camera, this.context.time.deltaTime);
1580
+ }
1581
+
1582
+ private onUpdateFade_PostRender() {
1583
+ this._transition?.remove();
1584
+ }
1585
+ }