@needle-tools/engine 4.7.1 → 4.7.2-alpha

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