@needle-tools/engine 4.11.5-next.f5ee735 → 4.11.6

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