@needle-tools/engine 4.5.5-next.f053174 → 4.5.6

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