@needle-tools/engine 4.6.2-next.fb486b2 → 4.6.3

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 (1067) hide show
  1. package/CHANGELOG.md +3773 -3768
  2. package/LICENSE.md +10 -10
  3. package/README.md +64 -64
  4. package/components.needle.json +1 -1
  5. package/dist/generateMeshBVH.worker-Cdfpaq5W.js +25 -0
  6. package/dist/{gltf-progressive-Bl4okF1b.min.js → gltf-progressive-Bm9eEfgu.min.js} +1 -1
  7. package/dist/{gltf-progressive-P8b8a0qY.umd.cjs → gltf-progressive-Dn6o99rH.umd.cjs} +1 -1
  8. package/dist/{gltf-progressive-DSpdn0QT.js → gltf-progressive-GjIqwSG3.js} +2 -2
  9. package/dist/{needle-engine.bundle-CQzZighj.js → needle-engine.bundle-B3xwa0ZL.js} +1319 -1308
  10. package/dist/{needle-engine.bundle-CdAK5p8o.umd.cjs → needle-engine.bundle-Bhmc3xq0.umd.cjs} +68 -65
  11. package/dist/{needle-engine.bundle-CJ4jhuta.min.js → needle-engine.bundle-DzStNbW2.min.js} +88 -85
  12. package/dist/needle-engine.d.ts +129 -130
  13. package/dist/needle-engine.js +4 -4
  14. package/dist/needle-engine.min.js +1 -1
  15. package/dist/needle-engine.umd.cjs +1 -1
  16. package/dist/{postprocessing-CjW23fio.umd.cjs → postprocessing-8AQTeZsr.umd.cjs} +2 -2
  17. package/dist/{postprocessing-xYQWCHFu.min.js → postprocessing-BDScN9yu.min.js} +2 -2
  18. package/dist/{postprocessing-DYLNOL3W.js → postprocessing-BkxN_08g.js} +3 -3
  19. package/dist/{three-DuDKwKB8.min.js → three-Boa-jOq-.min.js} +33 -33
  20. package/dist/{three-DrqIzZTH.js → three-Bz6X1mrw.js} +4198 -4198
  21. package/dist/{three-B_hneGZr.umd.cjs → three-DMrv-4ar.umd.cjs} +4 -4
  22. package/dist/{three-examples-X3OadjXB.umd.cjs → three-examples-C7ryg8vN.umd.cjs} +3 -3
  23. package/dist/{three-examples-DaDLBuy6.min.js → three-examples-DuVhxqft.min.js} +14 -14
  24. package/dist/{three-examples-B50TT3Iu.js → three-examples-GggCDHv0.js} +5 -5
  25. package/dist/{three-mesh-ui-CxuWt7m-.js → three-mesh-ui-CLNOfsWn.js} +1 -1
  26. package/dist/{three-mesh-ui-B3p3gyUz.min.js → three-mesh-ui-CY6Izc7C.min.js} +1 -1
  27. package/dist/{three-mesh-ui-CQiIQIlA.umd.cjs → three-mesh-ui-CwlN0FUC.umd.cjs} +1 -1
  28. package/dist/{vendor-BmYIgaS1.js → vendor-BSD1RQIh.js} +3 -3
  29. package/dist/{vendor-Cavtu3CP.umd.cjs → vendor-DHr4aqIZ.umd.cjs} +3 -3
  30. package/dist/{vendor-BlSxe9JJ.min.js → vendor-zxXa3Dmr.min.js} +3 -3
  31. package/lib/asap/needle-asap.d.ts +1 -1
  32. package/lib/asap/needle-asap.js +95 -95
  33. package/lib/asap/sessiongranted.d.ts +3 -3
  34. package/lib/asap/sessiongranted.js +65 -65
  35. package/lib/asap/utils.d.ts +1 -1
  36. package/lib/asap/utils.js +3 -3
  37. package/lib/engine/analytics/index.d.ts +6 -6
  38. package/lib/engine/analytics/index.js +12 -12
  39. package/lib/engine/analytics/lcp.d.ts +3 -3
  40. package/lib/engine/analytics/lcp.js +34 -34
  41. package/lib/engine/api.d.ts +82 -82
  42. package/lib/engine/api.js +81 -81
  43. package/lib/engine/assets/index.d.ts +11 -11
  44. package/lib/engine/assets/index.js +47 -47
  45. package/lib/engine/assets/static.d.ts +1 -1
  46. package/lib/engine/assets/static.js +4 -4
  47. package/lib/engine/codegen/register_types.d.ts +1 -1
  48. package/lib/engine/codegen/register_types.js +300 -300
  49. package/lib/engine/debug/debug.d.ts +15 -15
  50. package/lib/engine/debug/debug.js +44 -44
  51. package/lib/engine/debug/debug_console.d.ts +2 -2
  52. package/lib/engine/debug/debug_console.js +307 -307
  53. package/lib/engine/debug/debug_overlay.d.ts +22 -22
  54. package/lib/engine/debug/debug_overlay.js +316 -316
  55. package/lib/engine/debug/debug_spatial_console.d.ts +2 -2
  56. package/lib/engine/debug/debug_spatial_console.js +390 -390
  57. package/lib/engine/debug/index.d.ts +2 -2
  58. package/lib/engine/debug/index.js +2 -2
  59. package/lib/engine/engine_addressables.d.ts +166 -166
  60. package/lib/engine/engine_addressables.js +608 -608
  61. package/lib/engine/engine_animation.d.ts +43 -43
  62. package/lib/engine/engine_animation.js +133 -133
  63. package/lib/engine/engine_application.d.ts +45 -45
  64. package/lib/engine/engine_application.js +104 -104
  65. package/lib/engine/engine_assetdatabase.d.ts +25 -25
  66. package/lib/engine/engine_assetdatabase.js +346 -346
  67. package/lib/engine/engine_audio.d.ts +4 -4
  68. package/lib/engine/engine_audio.js +23 -23
  69. package/lib/engine/engine_camera.d.ts +13 -13
  70. package/lib/engine/engine_camera.js +30 -30
  71. package/lib/engine/engine_components.d.ts +110 -110
  72. package/lib/engine/engine_components.js +374 -374
  73. package/lib/engine/engine_components_internal.d.ts +9 -9
  74. package/lib/engine/engine_components_internal.js +36 -36
  75. package/lib/engine/engine_constants.d.ts +10 -10
  76. package/lib/engine/engine_constants.js +41 -41
  77. package/lib/engine/engine_context.d.ts +475 -475
  78. package/lib/engine/engine_context.js +1673 -1672
  79. package/lib/engine/engine_context.js.map +1 -1
  80. package/lib/engine/engine_context_registry.d.ts +71 -71
  81. package/lib/engine/engine_context_registry.js +117 -117
  82. package/lib/engine/engine_coroutine.d.ts +35 -35
  83. package/lib/engine/engine_coroutine.js +52 -52
  84. package/lib/engine/engine_create_objects.d.ts +119 -119
  85. package/lib/engine/engine_create_objects.js +320 -320
  86. package/lib/engine/engine_default_parameters.d.ts +2 -2
  87. package/lib/engine/engine_default_parameters.js +3 -3
  88. package/lib/engine/engine_editor-sync.d.ts +21 -21
  89. package/lib/engine/engine_editor-sync.js +4 -4
  90. package/lib/engine/engine_fileloader.d.ts +2 -2
  91. package/lib/engine/engine_fileloader.js +8 -8
  92. package/lib/engine/engine_gameobject.d.ts +68 -68
  93. package/lib/engine/engine_gameobject.js +619 -619
  94. package/lib/engine/engine_generic_utils.d.ts +1 -1
  95. package/lib/engine/engine_generic_utils.js +13 -13
  96. package/lib/engine/engine_gizmos.d.ts +149 -149
  97. package/lib/engine/engine_gizmos.js +530 -530
  98. package/lib/engine/engine_gltf.d.ts +12 -12
  99. package/lib/engine/engine_gltf.js +15 -15
  100. package/lib/engine/engine_gltf_builtin_components.d.ts +11 -11
  101. package/lib/engine/engine_gltf_builtin_components.js +341 -341
  102. package/lib/engine/engine_hot_reload.d.ts +8 -8
  103. package/lib/engine/engine_hot_reload.js +197 -197
  104. package/lib/engine/engine_input.d.ts +362 -362
  105. package/lib/engine/engine_input.js +1294 -1294
  106. package/lib/engine/engine_input_utils.d.ts +2 -2
  107. package/lib/engine/engine_input_utils.js +22 -22
  108. package/lib/engine/engine_instancing.d.ts +19 -19
  109. package/lib/engine/engine_instancing.js +39 -39
  110. package/lib/engine/engine_license.d.ts +11 -11
  111. package/lib/engine/engine_license.js +369 -369
  112. package/lib/engine/engine_lifecycle_api.d.ts +83 -83
  113. package/lib/engine/engine_lifecycle_api.js +106 -106
  114. package/lib/engine/engine_lifecycle_functions_internal.d.ts +32 -32
  115. package/lib/engine/engine_lifecycle_functions_internal.js +146 -146
  116. package/lib/engine/engine_lightdata.d.ts +23 -23
  117. package/lib/engine/engine_lightdata.js +91 -91
  118. package/lib/engine/engine_loaders.callbacks.d.ts +97 -97
  119. package/lib/engine/engine_loaders.callbacks.js +86 -86
  120. package/lib/engine/engine_loaders.d.ts +48 -48
  121. package/lib/engine/engine_loaders.gltf.d.ts +13 -13
  122. package/lib/engine/engine_loaders.gltf.js +62 -62
  123. package/lib/engine/engine_loaders.js +337 -337
  124. package/lib/engine/engine_lods.d.ts +31 -31
  125. package/lib/engine/engine_lods.js +146 -146
  126. package/lib/engine/engine_mainloop_utils.d.ts +32 -32
  127. package/lib/engine/engine_mainloop_utils.js +466 -466
  128. package/lib/engine/engine_math.d.ts +114 -114
  129. package/lib/engine/engine_math.js +247 -247
  130. package/lib/engine/engine_modules.d.ts +36 -36
  131. package/lib/engine/engine_modules.js +85 -85
  132. package/lib/engine/engine_networking.d.ts +260 -260
  133. package/lib/engine/engine_networking.js +764 -764
  134. package/lib/engine/engine_networking_auto.d.ts +24 -24
  135. package/lib/engine/engine_networking_auto.js +310 -310
  136. package/lib/engine/engine_networking_blob.d.ts +48 -48
  137. package/lib/engine/engine_networking_blob.js +228 -228
  138. package/lib/engine/engine_networking_files.d.ts +35 -35
  139. package/lib/engine/engine_networking_files.js +172 -172
  140. package/lib/engine/engine_networking_files_default_components.d.ts +6 -6
  141. package/lib/engine/engine_networking_files_default_components.js +42 -42
  142. package/lib/engine/engine_networking_instantiate.d.ts +100 -100
  143. package/lib/engine/engine_networking_instantiate.js +345 -345
  144. package/lib/engine/engine_networking_peer.d.ts +15 -15
  145. package/lib/engine/engine_networking_peer.js +132 -132
  146. package/lib/engine/engine_networking_streams.d.ts +123 -123
  147. package/lib/engine/engine_networking_streams.js +645 -645
  148. package/lib/engine/engine_networking_types.d.ts +22 -22
  149. package/lib/engine/engine_networking_types.js +7 -7
  150. package/lib/engine/engine_networking_utils.d.ts +2 -2
  151. package/lib/engine/engine_networking_utils.js +20 -20
  152. package/lib/engine/engine_networking_websocket.d.ts +1 -1
  153. package/lib/engine/engine_networking_websocket.js +2 -2
  154. package/lib/engine/engine_patcher.d.ts +10 -10
  155. package/lib/engine/engine_patcher.js +142 -142
  156. package/lib/engine/engine_physics.d.ts +152 -152
  157. package/lib/engine/engine_physics.js +645 -645
  158. package/lib/engine/engine_physics.types.d.ts +40 -40
  159. package/lib/engine/engine_physics.types.js +33 -33
  160. package/lib/engine/engine_physics_rapier.d.ts +147 -147
  161. package/lib/engine/engine_physics_rapier.js +1433 -1433
  162. package/lib/engine/engine_playerview.d.ts +26 -26
  163. package/lib/engine/engine_playerview.js +64 -64
  164. package/lib/engine/engine_scenelighting.d.ts +71 -71
  165. package/lib/engine/engine_scenelighting.js +226 -226
  166. package/lib/engine/engine_serialization.d.ts +3 -3
  167. package/lib/engine/engine_serialization.js +3 -3
  168. package/lib/engine/engine_serialization_builtin_serializer.d.ts +72 -72
  169. package/lib/engine/engine_serialization_builtin_serializer.js +403 -403
  170. package/lib/engine/engine_serialization_core.d.ts +94 -94
  171. package/lib/engine/engine_serialization_core.js +607 -607
  172. package/lib/engine/engine_serialization_decorator.d.ts +23 -23
  173. package/lib/engine/engine_serialization_decorator.js +66 -66
  174. package/lib/engine/engine_setup.d.ts +1 -1
  175. package/lib/engine/engine_setup.js +2 -2
  176. package/lib/engine/engine_shaders.d.ts +53 -53
  177. package/lib/engine/engine_shaders.js +252 -252
  178. package/lib/engine/engine_shims.d.ts +4 -4
  179. package/lib/engine/engine_shims.js +24 -24
  180. package/lib/engine/engine_test_utils.d.ts +39 -39
  181. package/lib/engine/engine_test_utils.js +83 -83
  182. package/lib/engine/engine_texture.d.ts +28 -28
  183. package/lib/engine/engine_texture.js +64 -64
  184. package/lib/engine/engine_three_utils.d.ts +204 -204
  185. package/lib/engine/engine_three_utils.js +784 -784
  186. package/lib/engine/engine_time.d.ts +51 -51
  187. package/lib/engine/engine_time.js +82 -82
  188. package/lib/engine/engine_time_utils.d.ts +88 -88
  189. package/lib/engine/engine_time_utils.js +215 -215
  190. package/lib/engine/engine_tonemapping.d.ts +6 -6
  191. package/lib/engine/engine_tonemapping.js +197 -197
  192. package/lib/engine/engine_types.d.ts +578 -578
  193. package/lib/engine/engine_types.js +95 -95
  194. package/lib/engine/engine_typestore.d.ts +28 -28
  195. package/lib/engine/engine_typestore.js +55 -55
  196. package/lib/engine/engine_util_decorator.d.ts +13 -13
  197. package/lib/engine/engine_util_decorator.js +116 -116
  198. package/lib/engine/engine_utils.d.ts +248 -248
  199. package/lib/engine/engine_utils.js +1012 -1012
  200. package/lib/engine/engine_utils_format.d.ts +24 -24
  201. package/lib/engine/engine_utils_format.js +239 -239
  202. package/lib/engine/engine_utils_screenshot.d.ts +159 -159
  203. package/lib/engine/engine_utils_screenshot.js +522 -522
  204. package/lib/engine/engine_utils_screenshot.xr.d.ts +5 -5
  205. package/lib/engine/engine_utils_screenshot.xr.js +90 -90
  206. package/lib/engine/engine_xr.d.ts +1 -1
  207. package/lib/engine/engine_xr.js +1 -1
  208. package/lib/engine/export/gltf/Writers.d.ts +19 -19
  209. package/lib/engine/export/gltf/Writers.js +24 -24
  210. package/lib/engine/export/gltf/index.d.ts +11 -11
  211. package/lib/engine/export/gltf/index.js +123 -123
  212. package/lib/engine/export/index.d.ts +2 -2
  213. package/lib/engine/export/index.js +2 -2
  214. package/lib/engine/export/state.d.ts +7 -7
  215. package/lib/engine/export/state.js +17 -17
  216. package/lib/engine/export/utils.d.ts +2 -2
  217. package/lib/engine/export/utils.js +7 -7
  218. package/lib/engine/extensions/EXT_texture_exr.d.ts +8 -8
  219. package/lib/engine/extensions/EXT_texture_exr.js +32 -32
  220. package/lib/engine/extensions/NEEDLE_animator_controller_model.d.ts +122 -122
  221. package/lib/engine/extensions/NEEDLE_animator_controller_model.js +95 -95
  222. package/lib/engine/extensions/NEEDLE_components.d.ts +35 -35
  223. package/lib/engine/extensions/NEEDLE_components.js +220 -220
  224. package/lib/engine/extensions/NEEDLE_gameobject_data.d.ts +10 -10
  225. package/lib/engine/extensions/NEEDLE_gameobject_data.js +57 -57
  226. package/lib/engine/extensions/NEEDLE_lighting_settings.d.ts +37 -37
  227. package/lib/engine/extensions/NEEDLE_lighting_settings.js +157 -157
  228. package/lib/engine/extensions/NEEDLE_lightmaps.d.ts +18 -18
  229. package/lib/engine/extensions/NEEDLE_lightmaps.js +99 -99
  230. package/lib/engine/extensions/NEEDLE_persistent_assets.d.ts +11 -11
  231. package/lib/engine/extensions/NEEDLE_persistent_assets.js +63 -63
  232. package/lib/engine/extensions/NEEDLE_progressive.d.ts +1 -1
  233. package/lib/engine/extensions/NEEDLE_progressive.js +1 -1
  234. package/lib/engine/extensions/NEEDLE_render_objects.d.ts +13 -13
  235. package/lib/engine/extensions/NEEDLE_render_objects.js +159 -159
  236. package/lib/engine/extensions/NEEDLE_techniques_webgl.d.ts +38 -38
  237. package/lib/engine/extensions/NEEDLE_techniques_webgl.js +564 -564
  238. package/lib/engine/extensions/extension_resolver.d.ts +4 -4
  239. package/lib/engine/extensions/extension_resolver.js +1 -1
  240. package/lib/engine/extensions/extension_utils.d.ts +12 -12
  241. package/lib/engine/extensions/extension_utils.js +152 -152
  242. package/lib/engine/extensions/extensions.d.ts +32 -32
  243. package/lib/engine/extensions/extensions.js +107 -107
  244. package/lib/engine/extensions/index.d.ts +6 -6
  245. package/lib/engine/extensions/index.js +6 -6
  246. package/lib/engine/extensions/usage_tracker.d.ts +13 -13
  247. package/lib/engine/extensions/usage_tracker.js +65 -65
  248. package/lib/engine/js-extensions/Camera.d.ts +1 -1
  249. package/lib/engine/js-extensions/Camera.js +39 -39
  250. package/lib/engine/js-extensions/ExtensionUtils.d.ts +9 -9
  251. package/lib/engine/js-extensions/ExtensionUtils.js +67 -67
  252. package/lib/engine/js-extensions/Layers.d.ts +6 -6
  253. package/lib/engine/js-extensions/Layers.js +22 -22
  254. package/lib/engine/js-extensions/Object3D.d.ts +120 -120
  255. package/lib/engine/js-extensions/Object3D.js +136 -136
  256. package/lib/engine/js-extensions/RGBAColor.d.ts +23 -23
  257. package/lib/engine/js-extensions/RGBAColor.js +111 -111
  258. package/lib/engine/js-extensions/Vector.d.ts +3 -3
  259. package/lib/engine/js-extensions/Vector.js +13 -13
  260. package/lib/engine/js-extensions/index.d.ts +5 -5
  261. package/lib/engine/js-extensions/index.js +5 -5
  262. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.d.ts +4 -4
  263. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +79 -79
  264. package/lib/engine/shaders/shaderData.d.ts +55 -55
  265. package/lib/engine/shaders/shaderData.js +58 -58
  266. package/lib/engine/tests/test_utils.d.ts +2 -2
  267. package/lib/engine/tests/test_utils.js +53 -53
  268. package/lib/engine/webcomponents/WebXRButtons.d.ts +56 -56
  269. package/lib/engine/webcomponents/WebXRButtons.js +230 -230
  270. package/lib/engine/webcomponents/api.d.ts +5 -5
  271. package/lib/engine/webcomponents/api.js +4 -4
  272. package/lib/engine/webcomponents/buttons.d.ts +51 -51
  273. package/lib/engine/webcomponents/buttons.js +264 -264
  274. package/lib/engine/webcomponents/fonts.d.ts +9 -9
  275. package/lib/engine/webcomponents/fonts.js +32 -32
  276. package/lib/engine/webcomponents/icons.d.ts +9 -9
  277. package/lib/engine/webcomponents/icons.js +52 -52
  278. package/lib/engine/webcomponents/index.d.ts +1 -1
  279. package/lib/engine/webcomponents/index.js +1 -1
  280. package/lib/engine/webcomponents/logo-element.d.ts +10 -10
  281. package/lib/engine/webcomponents/logo-element.js +67 -67
  282. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.d.ts +37 -37
  283. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.js +513 -513
  284. package/lib/engine/webcomponents/needle menu/needle-menu.d.ts +155 -155
  285. package/lib/engine/webcomponents/needle menu/needle-menu.js +1029 -1029
  286. package/lib/engine/webcomponents/needle-button.d.ts +34 -34
  287. package/lib/engine/webcomponents/needle-button.js +161 -161
  288. package/lib/engine/webcomponents/needle-engine.ar-overlay.d.ts +21 -21
  289. package/lib/engine/webcomponents/needle-engine.ar-overlay.js +166 -166
  290. package/lib/engine/webcomponents/needle-engine.attributes.d.ts +69 -69
  291. package/lib/engine/webcomponents/needle-engine.attributes.js +1 -1
  292. package/lib/engine/webcomponents/needle-engine.d.ts +116 -116
  293. package/lib/engine/webcomponents/needle-engine.extras.d.ts +6 -6
  294. package/lib/engine/webcomponents/needle-engine.extras.js +13 -13
  295. package/lib/engine/webcomponents/needle-engine.js +821 -821
  296. package/lib/engine/webcomponents/needle-engine.loading.d.ts +44 -44
  297. package/lib/engine/webcomponents/needle-engine.loading.js +341 -341
  298. package/lib/engine/xr/NeedleXRController.d.ts +313 -313
  299. package/lib/engine/xr/NeedleXRController.js +1007 -1007
  300. package/lib/engine/xr/NeedleXRSession.d.ts +340 -340
  301. package/lib/engine/xr/NeedleXRSession.js +1463 -1463
  302. package/lib/engine/xr/NeedleXRSync.d.ts +22 -22
  303. package/lib/engine/xr/NeedleXRSync.js +188 -188
  304. package/lib/engine/xr/SceneTransition.d.ts +18 -18
  305. package/lib/engine/xr/SceneTransition.js +69 -69
  306. package/lib/engine/xr/TempXRContext.d.ts +34 -34
  307. package/lib/engine/xr/TempXRContext.js +187 -187
  308. package/lib/engine/xr/XRRig.d.ts +7 -7
  309. package/lib/engine/xr/XRRig.js +1 -1
  310. package/lib/engine/xr/api.d.ts +6 -6
  311. package/lib/engine/xr/api.js +6 -6
  312. package/lib/engine/xr/events.d.ts +66 -66
  313. package/lib/engine/xr/events.js +93 -93
  314. package/lib/engine/xr/internal.d.ts +12 -12
  315. package/lib/engine/xr/internal.js +25 -25
  316. package/lib/engine/xr/usdz.d.ts +12 -12
  317. package/lib/engine/xr/usdz.js +29 -29
  318. package/lib/engine/xr/utils.d.ts +11 -11
  319. package/lib/engine/xr/utils.js +34 -34
  320. package/lib/engine-components/AlignmentConstraint.d.ts +10 -10
  321. package/lib/engine-components/AlignmentConstraint.js +39 -39
  322. package/lib/engine-components/Animation.d.ts +156 -156
  323. package/lib/engine-components/Animation.js +508 -508
  324. package/lib/engine-components/AnimationCurve.d.ts +40 -40
  325. package/lib/engine-components/AnimationCurve.js +159 -159
  326. package/lib/engine-components/AnimationUtils.d.ts +8 -8
  327. package/lib/engine-components/AnimationUtils.js +27 -27
  328. package/lib/engine-components/AnimationUtilsAutoplay.d.ts +1 -1
  329. package/lib/engine-components/AnimationUtilsAutoplay.js +39 -39
  330. package/lib/engine-components/Animator.d.ts +217 -217
  331. package/lib/engine-components/Animator.js +354 -354
  332. package/lib/engine-components/AnimatorController.d.ts +227 -227
  333. package/lib/engine-components/AnimatorController.js +1152 -1152
  334. package/lib/engine-components/AudioListener.d.ts +33 -33
  335. package/lib/engine-components/AudioListener.js +86 -86
  336. package/lib/engine-components/AudioSource.d.ts +217 -217
  337. package/lib/engine-components/AudioSource.js +635 -635
  338. package/lib/engine-components/AvatarLoader.d.ts +80 -80
  339. package/lib/engine-components/AvatarLoader.js +231 -231
  340. package/lib/engine-components/AxesHelper.d.ts +32 -32
  341. package/lib/engine-components/AxesHelper.js +67 -67
  342. package/lib/engine-components/BasicIKConstraint.d.ts +9 -9
  343. package/lib/engine-components/BasicIKConstraint.js +43 -43
  344. package/lib/engine-components/BoxCollider.d.ts +2 -2
  345. package/lib/engine-components/BoxCollider.js +2 -2
  346. package/lib/engine-components/BoxHelperComponent.d.ts +47 -47
  347. package/lib/engine-components/BoxHelperComponent.js +102 -102
  348. package/lib/engine-components/Camera.d.ts +231 -231
  349. package/lib/engine-components/Camera.js +700 -700
  350. package/lib/engine-components/CameraUtils.d.ts +1 -1
  351. package/lib/engine-components/CameraUtils.js +121 -121
  352. package/lib/engine-components/CharacterController.d.ts +55 -55
  353. package/lib/engine-components/CharacterController.js +236 -236
  354. package/lib/engine-components/Collider.d.ts +188 -188
  355. package/lib/engine-components/Collider.js +369 -369
  356. package/lib/engine-components/Component.d.ts +792 -792
  357. package/lib/engine-components/Component.js +920 -920
  358. package/lib/engine-components/ContactShadows.d.ts +94 -94
  359. package/lib/engine-components/ContactShadows.js +453 -453
  360. package/lib/engine-components/DeleteBox.d.ts +19 -19
  361. package/lib/engine-components/DeleteBox.js +58 -58
  362. package/lib/engine-components/DeviceFlag.d.ts +16 -16
  363. package/lib/engine-components/DeviceFlag.js +47 -47
  364. package/lib/engine-components/DragControls.d.ts +170 -170
  365. package/lib/engine-components/DragControls.js +1421 -1421
  366. package/lib/engine-components/DropListener.d.ts +215 -215
  367. package/lib/engine-components/DropListener.js +642 -642
  368. package/lib/engine-components/Duplicatable.d.ts +35 -35
  369. package/lib/engine-components/Duplicatable.js +202 -202
  370. package/lib/engine-components/EventList.d.ts +54 -54
  371. package/lib/engine-components/EventList.js +232 -232
  372. package/lib/engine-components/EventTrigger.d.ts +33 -33
  373. package/lib/engine-components/EventTrigger.js +75 -75
  374. package/lib/engine-components/EventType.d.ts +22 -22
  375. package/lib/engine-components/EventType.js +23 -23
  376. package/lib/engine-components/Fog.d.ts +22 -22
  377. package/lib/engine-components/Fog.js +61 -61
  378. package/lib/engine-components/Gizmos.d.ts +17 -17
  379. package/lib/engine-components/Gizmos.js +64 -64
  380. package/lib/engine-components/GridHelper.d.ts +20 -20
  381. package/lib/engine-components/GridHelper.js +54 -54
  382. package/lib/engine-components/GroundProjection.d.ts +67 -67
  383. package/lib/engine-components/GroundProjection.js +343 -343
  384. package/lib/engine-components/Interactable.d.ts +12 -12
  385. package/lib/engine-components/Interactable.js +12 -12
  386. package/lib/engine-components/Joints.d.ts +19 -19
  387. package/lib/engine-components/Joints.js +51 -51
  388. package/lib/engine-components/LODGroup.d.ts +35 -35
  389. package/lib/engine-components/LODGroup.js +152 -152
  390. package/lib/engine-components/Light.d.ts +180 -180
  391. package/lib/engine-components/Light.js +535 -535
  392. package/lib/engine-components/LookAtConstraint.d.ts +19 -19
  393. package/lib/engine-components/LookAtConstraint.js +35 -35
  394. package/lib/engine-components/NeedleMenu.d.ts +50 -50
  395. package/lib/engine-components/NeedleMenu.js +92 -92
  396. package/lib/engine-components/NestedGltf.d.ts +25 -25
  397. package/lib/engine-components/NestedGltf.js +88 -88
  398. package/lib/engine-components/Networking.d.ts +54 -54
  399. package/lib/engine-components/Networking.js +112 -112
  400. package/lib/engine-components/OffsetConstraint.d.ts +14 -14
  401. package/lib/engine-components/OffsetConstraint.js +65 -65
  402. package/lib/engine-components/OrbitControls.d.ts +268 -268
  403. package/lib/engine-components/OrbitControls.js +1015 -1015
  404. package/lib/engine-components/PlayerColor.d.ts +19 -19
  405. package/lib/engine-components/PlayerColor.js +94 -94
  406. package/lib/engine-components/ReflectionProbe.d.ts +28 -28
  407. package/lib/engine-components/ReflectionProbe.js +204 -204
  408. package/lib/engine-components/Renderer.d.ts +153 -153
  409. package/lib/engine-components/Renderer.js +834 -834
  410. package/lib/engine-components/RendererInstancing.d.ts +140 -140
  411. package/lib/engine-components/RendererInstancing.js +744 -744
  412. package/lib/engine-components/RendererLightmap.d.ts +24 -24
  413. package/lib/engine-components/RendererLightmap.js +182 -182
  414. package/lib/engine-components/RigidBody.d.ts +155 -155
  415. package/lib/engine-components/RigidBody.js +517 -517
  416. package/lib/engine-components/SceneSwitcher.d.ts +263 -263
  417. package/lib/engine-components/SceneSwitcher.js +971 -971
  418. package/lib/engine-components/ScreenCapture.d.ts +144 -144
  419. package/lib/engine-components/ScreenCapture.js +547 -547
  420. package/lib/engine-components/ShadowCatcher.d.ts +33 -33
  421. package/lib/engine-components/ShadowCatcher.js +166 -166
  422. package/lib/engine-components/Skybox.d.ts +88 -88
  423. package/lib/engine-components/Skybox.js +469 -469
  424. package/lib/engine-components/SmoothFollow.d.ts +34 -34
  425. package/lib/engine-components/SmoothFollow.js +82 -82
  426. package/lib/engine-components/SpatialTrigger.d.ts +102 -102
  427. package/lib/engine-components/SpatialTrigger.js +225 -225
  428. package/lib/engine-components/SpectatorCamera.d.ts +111 -111
  429. package/lib/engine-components/SpectatorCamera.js +715 -715
  430. package/lib/engine-components/SphereCollider.d.ts +2 -2
  431. package/lib/engine-components/SphereCollider.js +2 -2
  432. package/lib/engine-components/SpriteRenderer.d.ts +132 -132
  433. package/lib/engine-components/SpriteRenderer.js +472 -472
  434. package/lib/engine-components/SyncedCamera.d.ts +41 -41
  435. package/lib/engine-components/SyncedCamera.js +199 -199
  436. package/lib/engine-components/SyncedRoom.d.ts +106 -106
  437. package/lib/engine-components/SyncedRoom.js +371 -371
  438. package/lib/engine-components/SyncedTransform.d.ts +94 -94
  439. package/lib/engine-components/SyncedTransform.js +331 -331
  440. package/lib/engine-components/TestRunner.d.ts +16 -16
  441. package/lib/engine-components/TestRunner.js +102 -102
  442. package/lib/engine-components/TransformGizmo.d.ts +75 -75
  443. package/lib/engine-components/TransformGizmo.js +209 -209
  444. package/lib/engine-components/VideoPlayer.d.ts +184 -184
  445. package/lib/engine-components/VideoPlayer.js +978 -978
  446. package/lib/engine-components/Voip.d.ts +67 -67
  447. package/lib/engine-components/Voip.js +360 -360
  448. package/lib/engine-components/api.d.ts +51 -51
  449. package/lib/engine-components/api.js +50 -50
  450. package/lib/engine-components/avatar/AvatarBlink_Simple.d.ts +11 -11
  451. package/lib/engine-components/avatar/AvatarBlink_Simple.js +76 -76
  452. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.d.ts +14 -14
  453. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.js +68 -68
  454. package/lib/engine-components/avatar/Avatar_Brain_LookAt.d.ts +29 -29
  455. package/lib/engine-components/avatar/Avatar_Brain_LookAt.js +121 -121
  456. package/lib/engine-components/avatar/Avatar_MouthShapes.d.ts +15 -15
  457. package/lib/engine-components/avatar/Avatar_MouthShapes.js +79 -79
  458. package/lib/engine-components/avatar/Avatar_MustacheShake.d.ts +9 -9
  459. package/lib/engine-components/avatar/Avatar_MustacheShake.js +29 -29
  460. package/lib/engine-components/codegen/components.d.ts +216 -216
  461. package/lib/engine-components/codegen/components.js +218 -218
  462. package/lib/engine-components/debug/LogStats.d.ts +5 -5
  463. package/lib/engine-components/debug/LogStats.js +18 -18
  464. package/lib/engine-components/export/gltf/GltfExport.d.ts +30 -30
  465. package/lib/engine-components/export/gltf/GltfExport.js +246 -246
  466. package/lib/engine-components/export/gltf/index.d.ts +1 -1
  467. package/lib/engine-components/export/gltf/index.js +1 -1
  468. package/lib/engine-components/export/index.d.ts +1 -1
  469. package/lib/engine-components/export/index.js +1 -1
  470. package/lib/engine-components/export/usdz/Extension.d.ts +22 -22
  471. package/lib/engine-components/export/usdz/Extension.js +1 -1
  472. package/lib/engine-components/export/usdz/ThreeUSDZExporter.d.ts +160 -160
  473. package/lib/engine-components/export/usdz/ThreeUSDZExporter.js +1782 -1782
  474. package/lib/engine-components/export/usdz/USDZExporter.d.ts +130 -130
  475. package/lib/engine-components/export/usdz/USDZExporter.js +663 -663
  476. package/lib/engine-components/export/usdz/extensions/Animation.d.ts +106 -106
  477. package/lib/engine-components/export/usdz/extensions/Animation.js +1071 -1071
  478. package/lib/engine-components/export/usdz/extensions/DocumentExtension.d.ts +5 -5
  479. package/lib/engine-components/export/usdz/extensions/DocumentExtension.js +6 -6
  480. package/lib/engine-components/export/usdz/extensions/NodeMaterialConverter.d.ts +10 -0
  481. package/lib/engine-components/export/usdz/extensions/NodeMaterialConverter.js +452 -0
  482. package/lib/engine-components/export/usdz/extensions/NodeMaterialConverter.js.map +1 -0
  483. package/lib/engine-components/export/usdz/extensions/USDZText.d.ts +54 -54
  484. package/lib/engine-components/export/usdz/extensions/USDZText.js +203 -203
  485. package/lib/engine-components/export/usdz/extensions/USDZUI.d.ts +8 -8
  486. package/lib/engine-components/export/usdz/extensions/USDZUI.js +158 -158
  487. package/lib/engine-components/export/usdz/extensions/behavior/Actions.d.ts +30 -30
  488. package/lib/engine-components/export/usdz/extensions/behavior/Actions.js +88 -88
  489. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.d.ts +10 -10
  490. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.js +86 -86
  491. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.d.ts +28 -28
  492. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.js +290 -290
  493. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.d.ts +190 -190
  494. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.js +1060 -1060
  495. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.d.ts +135 -135
  496. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.js +548 -548
  497. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.d.ts +7 -7
  498. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.js +115 -115
  499. package/lib/engine-components/export/usdz/index.d.ts +3 -3
  500. package/lib/engine-components/export/usdz/index.js +2 -2
  501. package/lib/engine-components/export/usdz/utils/animationutils.d.ts +7 -7
  502. package/lib/engine-components/export/usdz/utils/animationutils.js +163 -163
  503. package/lib/engine-components/export/usdz/utils/quicklook.d.ts +2 -2
  504. package/lib/engine-components/export/usdz/utils/quicklook.js +43 -43
  505. package/lib/engine-components/particlesystem/ParticleSystem.d.ts +177 -177
  506. package/lib/engine-components/particlesystem/ParticleSystem.js +1176 -1176
  507. package/lib/engine-components/particlesystem/ParticleSystemModules.d.ts +526 -526
  508. package/lib/engine-components/particlesystem/ParticleSystemModules.js +1930 -1930
  509. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.d.ts +25 -25
  510. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.js +87 -87
  511. package/lib/engine-components/particlesystem/api.d.ts +2 -2
  512. package/lib/engine-components/particlesystem/api.js +2 -2
  513. package/lib/engine-components/postprocessing/Effects/Antialiasing.d.ts +17 -17
  514. package/lib/engine-components/postprocessing/Effects/Antialiasing.js +59 -52
  515. package/lib/engine-components/postprocessing/Effects/Antialiasing.js.map +1 -1
  516. package/lib/engine-components/postprocessing/Effects/BloomEffect.d.ts +46 -46
  517. package/lib/engine-components/postprocessing/Effects/BloomEffect.js +113 -113
  518. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.d.ts +11 -11
  519. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.js +39 -39
  520. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.d.ts +23 -23
  521. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.js +111 -111
  522. package/lib/engine-components/postprocessing/Effects/DepthOfField.d.ts +25 -25
  523. package/lib/engine-components/postprocessing/Effects/DepthOfField.js +104 -104
  524. package/lib/engine-components/postprocessing/Effects/EffectWrapper.d.ts +12 -12
  525. package/lib/engine-components/postprocessing/Effects/EffectWrapper.js +18 -18
  526. package/lib/engine-components/postprocessing/Effects/Pixelation.d.ts +11 -11
  527. package/lib/engine-components/postprocessing/Effects/Pixelation.js +32 -32
  528. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.d.ts +18 -18
  529. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.js +91 -91
  530. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.d.ts +70 -70
  531. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.js +176 -176
  532. package/lib/engine-components/postprocessing/Effects/Sharpening.d.ts +18 -18
  533. package/lib/engine-components/postprocessing/Effects/Sharpening.js +127 -127
  534. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.d.ts +17 -17
  535. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.js +70 -70
  536. package/lib/engine-components/postprocessing/Effects/Tonemapping.d.ts +19 -19
  537. package/lib/engine-components/postprocessing/Effects/Tonemapping.js +94 -94
  538. package/lib/engine-components/postprocessing/Effects/Tonemapping.utils.d.ts +13 -13
  539. package/lib/engine-components/postprocessing/Effects/Tonemapping.utils.js +51 -51
  540. package/lib/engine-components/postprocessing/Effects/Vignette.d.ts +15 -15
  541. package/lib/engine-components/postprocessing/Effects/Vignette.js +60 -60
  542. package/lib/engine-components/postprocessing/PostProcessingEffect.d.ts +90 -90
  543. package/lib/engine-components/postprocessing/PostProcessingEffect.js +168 -168
  544. package/lib/engine-components/postprocessing/PostProcessingHandler.d.ts +42 -42
  545. package/lib/engine-components/postprocessing/PostProcessingHandler.js +495 -480
  546. package/lib/engine-components/postprocessing/PostProcessingHandler.js.map +1 -1
  547. package/lib/engine-components/postprocessing/Volume.d.ts +90 -90
  548. package/lib/engine-components/postprocessing/Volume.js +385 -385
  549. package/lib/engine-components/postprocessing/Volume.js.map +1 -1
  550. package/lib/engine-components/postprocessing/VolumeParameter.d.ts +26 -26
  551. package/lib/engine-components/postprocessing/VolumeParameter.js +136 -136
  552. package/lib/engine-components/postprocessing/VolumeProfile.d.ts +15 -15
  553. package/lib/engine-components/postprocessing/VolumeProfile.js +60 -60
  554. package/lib/engine-components/postprocessing/index.d.ts +6 -6
  555. package/lib/engine-components/postprocessing/index.js +6 -6
  556. package/lib/engine-components/postprocessing/utils.d.ts +55 -55
  557. package/lib/engine-components/postprocessing/utils.js +119 -119
  558. package/lib/engine-components/timeline/PlayableDirector.d.ts +163 -163
  559. package/lib/engine-components/timeline/PlayableDirector.js +686 -686
  560. package/lib/engine-components/timeline/SignalAsset.d.ts +24 -24
  561. package/lib/engine-components/timeline/SignalAsset.js +130 -130
  562. package/lib/engine-components/timeline/TimelineModels.d.ts +89 -89
  563. package/lib/engine-components/timeline/TimelineModels.js +22 -22
  564. package/lib/engine-components/timeline/TimelineTracks.d.ts +110 -110
  565. package/lib/engine-components/timeline/TimelineTracks.js +879 -879
  566. package/lib/engine-components/timeline/index.d.ts +4 -4
  567. package/lib/engine-components/timeline/index.js +3 -3
  568. package/lib/engine-components/ui/BaseUIComponent.d.ts +48 -48
  569. package/lib/engine-components/ui/BaseUIComponent.js +170 -170
  570. package/lib/engine-components/ui/Button.d.ts +64 -64
  571. package/lib/engine-components/ui/Button.js +315 -315
  572. package/lib/engine-components/ui/Canvas.d.ts +74 -74
  573. package/lib/engine-components/ui/Canvas.js +407 -407
  574. package/lib/engine-components/ui/CanvasGroup.d.ts +19 -19
  575. package/lib/engine-components/ui/CanvasGroup.js +58 -58
  576. package/lib/engine-components/ui/EventSystem.d.ts +125 -125
  577. package/lib/engine-components/ui/EventSystem.js +765 -765
  578. package/lib/engine-components/ui/Graphic.d.ts +55 -55
  579. package/lib/engine-components/ui/Graphic.js +255 -255
  580. package/lib/engine-components/ui/Image.d.ts +35 -35
  581. package/lib/engine-components/ui/Image.js +116 -116
  582. package/lib/engine-components/ui/InputField.d.ts +42 -42
  583. package/lib/engine-components/ui/InputField.js +268 -268
  584. package/lib/engine-components/ui/Interfaces.d.ts +38 -38
  585. package/lib/engine-components/ui/Interfaces.js +12 -12
  586. package/lib/engine-components/ui/Layout.d.ts +84 -84
  587. package/lib/engine-components/ui/Layout.js +330 -330
  588. package/lib/engine-components/ui/Outline.d.ts +7 -7
  589. package/lib/engine-components/ui/Outline.js +20 -20
  590. package/lib/engine-components/ui/PointerEvents.d.ts +115 -115
  591. package/lib/engine-components/ui/PointerEvents.js +145 -145
  592. package/lib/engine-components/ui/RaycastUtils.d.ts +11 -11
  593. package/lib/engine-components/ui/RaycastUtils.js +67 -67
  594. package/lib/engine-components/ui/Raycaster.d.ts +30 -30
  595. package/lib/engine-components/ui/Raycaster.js +95 -95
  596. package/lib/engine-components/ui/RectTransform.d.ts +61 -61
  597. package/lib/engine-components/ui/RectTransform.js +356 -356
  598. package/lib/engine-components/ui/SpatialHtml.d.ts +8 -8
  599. package/lib/engine-components/ui/SpatialHtml.js +79 -79
  600. package/lib/engine-components/ui/Symbols.d.ts +1 -1
  601. package/lib/engine-components/ui/Symbols.js +1 -1
  602. package/lib/engine-components/ui/Text.d.ts +78 -78
  603. package/lib/engine-components/ui/Text.js +539 -539
  604. package/lib/engine-components/ui/Utils.d.ts +24 -24
  605. package/lib/engine-components/ui/Utils.js +90 -90
  606. package/lib/engine-components/ui/index.d.ts +1 -1
  607. package/lib/engine-components/ui/index.js +1 -1
  608. package/lib/engine-components/utils/EnvironmentScene.d.ts +5 -5
  609. package/lib/engine-components/utils/EnvironmentScene.js +205 -205
  610. package/lib/engine-components/utils/LookAt.d.ts +31 -31
  611. package/lib/engine-components/utils/LookAt.js +82 -82
  612. package/lib/engine-components/utils/OpenURL.d.ts +42 -42
  613. package/lib/engine-components/utils/OpenURL.js +119 -119
  614. package/lib/engine-components/webxr/Avatar.d.ts +25 -25
  615. package/lib/engine-components/webxr/Avatar.js +255 -255
  616. package/lib/engine-components/webxr/TeleportTarget.d.ts +7 -7
  617. package/lib/engine-components/webxr/TeleportTarget.js +7 -7
  618. package/lib/engine-components/webxr/WebARCameraBackground.d.ts +30 -30
  619. package/lib/engine-components/webxr/WebARCameraBackground.js +155 -155
  620. package/lib/engine-components/webxr/WebARSessionRoot.d.ts +98 -98
  621. package/lib/engine-components/webxr/WebARSessionRoot.js +770 -770
  622. package/lib/engine-components/webxr/WebXR.d.ts +232 -232
  623. package/lib/engine-components/webxr/WebXR.js +561 -561
  624. package/lib/engine-components/webxr/WebXRAvatar.d.ts +27 -27
  625. package/lib/engine-components/webxr/WebXRAvatar.js +44 -44
  626. package/lib/engine-components/webxr/WebXRImageTracking.d.ts +86 -86
  627. package/lib/engine-components/webxr/WebXRImageTracking.js +471 -471
  628. package/lib/engine-components/webxr/WebXRPlaneTracking.d.ts +92 -92
  629. package/lib/engine-components/webxr/WebXRPlaneTracking.js +500 -500
  630. package/lib/engine-components/webxr/WebXRRig.d.ts +32 -32
  631. package/lib/engine-components/webxr/WebXRRig.js +72 -72
  632. package/lib/engine-components/webxr/XRFlag.d.ts +38 -38
  633. package/lib/engine-components/webxr/XRFlag.js +139 -139
  634. package/lib/engine-components/webxr/controllers/XRControllerFollow.d.ts +47 -47
  635. package/lib/engine-components/webxr/controllers/XRControllerFollow.js +120 -120
  636. package/lib/engine-components/webxr/controllers/XRControllerModel.d.ts +43 -43
  637. package/lib/engine-components/webxr/controllers/XRControllerModel.js +352 -352
  638. package/lib/engine-components/webxr/controllers/XRControllerMovement.d.ts +78 -78
  639. package/lib/engine-components/webxr/controllers/XRControllerMovement.js +506 -506
  640. package/lib/engine-components/webxr/index.d.ts +3 -3
  641. package/lib/engine-components/webxr/index.js +3 -3
  642. package/lib/engine-components/webxr/types.d.ts +3 -3
  643. package/lib/engine-components/webxr/types.js +1 -1
  644. package/lib/engine-components-experimental/Presentation.d.ts +6 -6
  645. package/lib/engine-components-experimental/Presentation.js +9 -9
  646. package/lib/engine-components-experimental/api.d.ts +4 -4
  647. package/lib/engine-components-experimental/api.js +4 -4
  648. package/lib/engine-components-experimental/networking/PlayerSync.d.ts +156 -156
  649. package/lib/engine-components-experimental/networking/PlayerSync.js +377 -377
  650. package/lib/engine-schemes/api.d.ts +12 -12
  651. package/lib/engine-schemes/api.js +12 -12
  652. package/lib/engine-schemes/schemes.d.ts +7 -7
  653. package/lib/engine-schemes/schemes.js +19 -19
  654. package/lib/engine-schemes/synced-camera-model.d.ts +25 -25
  655. package/lib/engine-schemes/synced-camera-model.js +67 -67
  656. package/lib/engine-schemes/synced-transform-model.d.ts +31 -31
  657. package/lib/engine-schemes/synced-transform-model.js +66 -66
  658. package/lib/engine-schemes/transform.d.ts +12 -12
  659. package/lib/engine-schemes/transform.js +39 -39
  660. package/lib/engine-schemes/vec2.d.ts +10 -10
  661. package/lib/engine-schemes/vec2.js +25 -25
  662. package/lib/engine-schemes/vec3.d.ts +11 -11
  663. package/lib/engine-schemes/vec3.js +29 -29
  664. package/lib/engine-schemes/vec4.d.ts +12 -12
  665. package/lib/engine-schemes/vec4.js +33 -33
  666. package/lib/engine-schemes/vr-user-state-buffer.d.ts +37 -37
  667. package/lib/engine-schemes/vr-user-state-buffer.js +110 -110
  668. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.d.ts +6 -6
  669. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.js +45 -45
  670. package/lib/needle-engine.d.ts +7 -7
  671. package/lib/needle-engine.js +64 -64
  672. package/package.json +2 -2
  673. package/plugins/common/buildinfo.js +64 -64
  674. package/plugins/common/cloud.js +1 -1
  675. package/plugins/common/config.cjs +31 -31
  676. package/plugins/common/config.js +35 -35
  677. package/plugins/common/files.js +31 -31
  678. package/plugins/common/generator.js +10 -10
  679. package/plugins/common/license.js +452 -452
  680. package/plugins/common/npm.js +15 -15
  681. package/plugins/common/timers.js +7 -7
  682. package/plugins/common/version.js +37 -37
  683. package/plugins/gltf-packer.mjs +1 -1
  684. package/plugins/next/alias.cjs +39 -39
  685. package/plugins/next/license.cjs +24 -24
  686. package/plugins/next/meshbvhworker.cjs +18 -18
  687. package/plugins/next/next.js +141 -141
  688. package/plugins/types/index.d.ts +2 -2
  689. package/plugins/types/license.d.ts +24 -24
  690. package/plugins/types/needleConfig.d.ts +27 -27
  691. package/plugins/types/next.d.ts +2 -2
  692. package/plugins/types/userconfig.d.ts +120 -120
  693. package/plugins/types/vite.d.ts +13 -13
  694. package/plugins/types/webmanifest.d.ts +32 -32
  695. package/plugins/vite/alias.js +184 -174
  696. package/plugins/vite/asap.js +251 -251
  697. package/plugins/vite/build-pipeline.js +371 -371
  698. package/plugins/vite/build.js +19 -19
  699. package/plugins/vite/buildinfo.js +41 -41
  700. package/plugins/vite/config.js +106 -106
  701. package/plugins/vite/copyfiles.js +138 -138
  702. package/plugins/vite/defines.js +70 -70
  703. package/plugins/vite/dependencies.js +232 -232
  704. package/plugins/vite/dependency-watcher.js +237 -237
  705. package/plugins/vite/drop-client.js +76 -76
  706. package/plugins/vite/drop.js +87 -87
  707. package/plugins/vite/editor-connection.js +124 -124
  708. package/plugins/vite/facebook-instant-games.js +102 -102
  709. package/plugins/vite/gzip.js +5 -5
  710. package/plugins/vite/imports-logger.js +143 -143
  711. package/plugins/vite/index.js +143 -143
  712. package/plugins/vite/license.js +56 -56
  713. package/plugins/vite/local-files.js +440 -440
  714. package/plugins/vite/meta.js +163 -163
  715. package/plugins/vite/npm.js +7 -7
  716. package/plugins/vite/peer.js +29 -29
  717. package/plugins/vite/poster-client.js +73 -73
  718. package/plugins/vite/poster.js +79 -79
  719. package/plugins/vite/pwa.js +604 -604
  720. package/plugins/vite/reload-client.js +15 -15
  721. package/plugins/vite/reload.js +351 -351
  722. package/plugins/vite/server.js +66 -66
  723. package/plugins/vite/transform-codegen.js +55 -55
  724. package/plugins/vite/transform.js +31 -31
  725. package/plugins/vite/vite-4.4-hack.js +31 -31
  726. package/src/asap/needle-asap.ts +111 -111
  727. package/src/asap/sessiongranted.ts +75 -75
  728. package/src/asap/utils.ts +4 -4
  729. package/src/engine/analytics/index.ts +10 -10
  730. package/src/engine/analytics/lcp.ts +35 -35
  731. package/src/engine/api.ts +82 -82
  732. package/src/engine/assets/index.ts +59 -59
  733. package/src/engine/assets/static.js +5 -5
  734. package/src/engine/codegen/register_types.ts +300 -300
  735. package/src/engine/debug/debug.ts +51 -51
  736. package/src/engine/debug/debug_console.ts +333 -333
  737. package/src/engine/debug/debug_overlay.ts +332 -332
  738. package/src/engine/debug/debug_spatial_console.ts +429 -429
  739. package/src/engine/debug/index.ts +1 -1
  740. package/src/engine/engine_addressables.ts +680 -680
  741. package/src/engine/engine_animation.ts +145 -145
  742. package/src/engine/engine_application.ts +113 -113
  743. package/src/engine/engine_assetdatabase.ts +389 -389
  744. package/src/engine/engine_audio.ts +24 -24
  745. package/src/engine/engine_camera.ts +39 -39
  746. package/src/engine/engine_components.ts +366 -366
  747. package/src/engine/engine_components_internal.ts +40 -40
  748. package/src/engine/engine_constants.ts +52 -52
  749. package/src/engine/engine_context.ts +1824 -1823
  750. package/src/engine/engine_context_registry.ts +129 -129
  751. package/src/engine/engine_coroutine.ts +54 -54
  752. package/src/engine/engine_create_objects.ts +411 -411
  753. package/src/engine/engine_default_parameters.ts +3 -3
  754. package/src/engine/engine_editor-sync.ts +28 -28
  755. package/src/engine/engine_fileloader.js +9 -9
  756. package/src/engine/engine_gameobject.ts +712 -712
  757. package/src/engine/engine_generic_utils.js +13 -13
  758. package/src/engine/engine_gizmos.ts +577 -577
  759. package/src/engine/engine_gltf.ts +29 -29
  760. package/src/engine/engine_gltf_builtin_components.ts +403 -403
  761. package/src/engine/engine_hot_reload.ts +210 -210
  762. package/src/engine/engine_input.ts +1500 -1500
  763. package/src/engine/engine_input_utils.ts +23 -23
  764. package/src/engine/engine_instancing.ts +45 -45
  765. package/src/engine/engine_license.ts +386 -386
  766. package/src/engine/engine_lifecycle_api.ts +113 -113
  767. package/src/engine/engine_lifecycle_functions_internal.ts +193 -193
  768. package/src/engine/engine_lightdata.ts +117 -117
  769. package/src/engine/engine_loaders.callbacks.ts +136 -136
  770. package/src/engine/engine_loaders.gltf.ts +82 -82
  771. package/src/engine/engine_loaders.ts +378 -378
  772. package/src/engine/engine_lods.ts +168 -168
  773. package/src/engine/engine_mainloop_utils.ts +472 -472
  774. package/src/engine/engine_math.ts +282 -282
  775. package/src/engine/engine_modules.ts +83 -83
  776. package/src/engine/engine_networking.ts +862 -862
  777. package/src/engine/engine_networking_auto.ts +352 -352
  778. package/src/engine/engine_networking_blob.ts +275 -275
  779. package/src/engine/engine_networking_files.ts +217 -217
  780. package/src/engine/engine_networking_files_default_components.ts +58 -58
  781. package/src/engine/engine_networking_instantiate.ts +419 -419
  782. package/src/engine/engine_networking_peer.ts +159 -159
  783. package/src/engine/engine_networking_streams.ts +713 -713
  784. package/src/engine/engine_networking_types.ts +24 -24
  785. package/src/engine/engine_networking_utils.ts +23 -23
  786. package/src/engine/engine_networking_websocket.ts +2 -2
  787. package/src/engine/engine_patcher.ts +199 -199
  788. package/src/engine/engine_physics.ts +783 -783
  789. package/src/engine/engine_physics.types.ts +46 -46
  790. package/src/engine/engine_physics_rapier.ts +1577 -1577
  791. package/src/engine/engine_playerview.ts +80 -80
  792. package/src/engine/engine_scenelighting.ts +294 -294
  793. package/src/engine/engine_serialization.ts +2 -2
  794. package/src/engine/engine_serialization_builtin_serializer.ts +473 -473
  795. package/src/engine/engine_serialization_core.ts +720 -720
  796. package/src/engine/engine_serialization_decorator.ts +80 -80
  797. package/src/engine/engine_setup.ts +1 -1
  798. package/src/engine/engine_shaders.ts +267 -267
  799. package/src/engine/engine_shims.ts +32 -32
  800. package/src/engine/engine_test_utils.ts +109 -109
  801. package/src/engine/engine_texture.ts +82 -82
  802. package/src/engine/engine_three_utils.ts +925 -925
  803. package/src/engine/engine_time.ts +94 -94
  804. package/src/engine/engine_time_utils.ts +237 -237
  805. package/src/engine/engine_tonemapping.ts +208 -208
  806. package/src/engine/engine_types.ts +730 -730
  807. package/src/engine/engine_typestore.ts +63 -63
  808. package/src/engine/engine_util_decorator.ts +136 -136
  809. package/src/engine/engine_utils.ts +1115 -1115
  810. package/src/engine/engine_utils_format.ts +273 -273
  811. package/src/engine/engine_utils_screenshot.ts +708 -708
  812. package/src/engine/engine_utils_screenshot.xr.ts +103 -103
  813. package/src/engine/export/gltf/Writers.ts +34 -34
  814. package/src/engine/export/gltf/index.ts +158 -158
  815. package/src/engine/export/index.ts +2 -2
  816. package/src/engine/export/state.ts +19 -19
  817. package/src/engine/export/utils.ts +9 -9
  818. package/src/engine/extensions/EXT_texture_exr.ts +50 -50
  819. package/src/engine/extensions/NEEDLE_animator_controller_model.ts +195 -195
  820. package/src/engine/extensions/NEEDLE_components.ts +268 -268
  821. package/src/engine/extensions/NEEDLE_gameobject_data.ts +81 -81
  822. package/src/engine/extensions/NEEDLE_lighting_settings.ts +185 -185
  823. package/src/engine/extensions/NEEDLE_lightmaps.ts +119 -119
  824. package/src/engine/extensions/NEEDLE_persistent_assets.ts +76 -76
  825. package/src/engine/extensions/NEEDLE_render_objects.ts +209 -209
  826. package/src/engine/extensions/NEEDLE_techniques_webgl.ts +640 -640
  827. package/src/engine/extensions/extension_resolver.ts +4 -4
  828. package/src/engine/extensions/extension_utils.ts +166 -166
  829. package/src/engine/extensions/extensions.ts +140 -140
  830. package/src/engine/extensions/index.ts +5 -5
  831. package/src/engine/extensions/usage_tracker.ts +100 -100
  832. package/src/engine/js-extensions/Camera.ts +37 -37
  833. package/src/engine/js-extensions/ExtensionUtils.ts +85 -85
  834. package/src/engine/js-extensions/Layers.ts +23 -23
  835. package/src/engine/js-extensions/Object3D.ts +296 -296
  836. package/src/engine/js-extensions/RGBAColor.ts +126 -126
  837. package/src/engine/js-extensions/Vector.ts +18 -18
  838. package/src/engine/js-extensions/index.ts +4 -4
  839. package/src/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +125 -125
  840. package/src/engine/shaders/shaderData.ts +67 -67
  841. package/src/engine/tests/test_utils.ts +63 -63
  842. package/src/engine/webcomponents/WebXRButtons.ts +260 -260
  843. package/src/engine/webcomponents/api.ts +6 -6
  844. package/src/engine/webcomponents/buttons.ts +292 -292
  845. package/src/engine/webcomponents/fonts.ts +41 -41
  846. package/src/engine/webcomponents/icons.ts +57 -57
  847. package/src/engine/webcomponents/index.ts +1 -1
  848. package/src/engine/webcomponents/logo-element.ts +78 -78
  849. package/src/engine/webcomponents/needle menu/needle-menu-spatial.ts +573 -573
  850. package/src/engine/webcomponents/needle menu/needle-menu.ts +1118 -1118
  851. package/src/engine/webcomponents/needle-button.ts +181 -181
  852. package/src/engine/webcomponents/needle-engine.ar-overlay.ts +186 -186
  853. package/src/engine/webcomponents/needle-engine.attributes.ts +82 -82
  854. package/src/engine/webcomponents/needle-engine.extras.ts +16 -16
  855. package/src/engine/webcomponents/needle-engine.loading.ts +373 -373
  856. package/src/engine/webcomponents/needle-engine.ts +860 -860
  857. package/src/engine/xr/NeedleXRController.ts +1125 -1125
  858. package/src/engine/xr/NeedleXRSession.ts +1624 -1624
  859. package/src/engine/xr/NeedleXRSync.ts +220 -220
  860. package/src/engine/xr/SceneTransition.ts +78 -78
  861. package/src/engine/xr/TempXRContext.ts +216 -216
  862. package/src/engine/xr/XRRig.ts +9 -9
  863. package/src/engine/xr/api.ts +5 -5
  864. package/src/engine/xr/events.ts +102 -102
  865. package/src/engine/xr/internal.ts +34 -34
  866. package/src/engine/xr/usdz.ts +30 -30
  867. package/src/engine/xr/utils.ts +39 -39
  868. package/src/engine-components/AlignmentConstraint.ts +36 -36
  869. package/src/engine-components/Animation.ts +557 -557
  870. package/src/engine-components/AnimationCurve.ts +150 -150
  871. package/src/engine-components/AnimationUtils.ts +28 -28
  872. package/src/engine-components/AnimationUtilsAutoplay.ts +43 -43
  873. package/src/engine-components/Animator.ts +397 -397
  874. package/src/engine-components/AnimatorController.ts +1293 -1293
  875. package/src/engine-components/AudioListener.ts +92 -92
  876. package/src/engine-components/AudioSource.ts +644 -644
  877. package/src/engine-components/AvatarLoader.ts +263 -263
  878. package/src/engine-components/AxesHelper.ts +59 -59
  879. package/src/engine-components/BasicIKConstraint.ts +54 -54
  880. package/src/engine-components/BoxCollider.ts +1 -1
  881. package/src/engine-components/BoxHelperComponent.ts +114 -114
  882. package/src/engine-components/Camera.ts +719 -719
  883. package/src/engine-components/CameraUtils.ts +136 -136
  884. package/src/engine-components/CharacterController.ts +253 -253
  885. package/src/engine-components/Collider.ts +374 -374
  886. package/src/engine-components/Component.ts +1297 -1297
  887. package/src/engine-components/ContactShadows.ts +506 -506
  888. package/src/engine-components/DeleteBox.ts +62 -62
  889. package/src/engine-components/DeviceFlag.ts +46 -46
  890. package/src/engine-components/DragControls.ts +1623 -1623
  891. package/src/engine-components/DropListener.ts +713 -713
  892. package/src/engine-components/Duplicatable.ts +198 -198
  893. package/src/engine-components/EventList.ts +266 -266
  894. package/src/engine-components/EventTrigger.ts +74 -74
  895. package/src/engine-components/EventType.ts +22 -22
  896. package/src/engine-components/Fog.ts +60 -60
  897. package/src/engine-components/Gizmos.ts +56 -56
  898. package/src/engine-components/GridHelper.ts +48 -48
  899. package/src/engine-components/GroundProjection.ts +356 -356
  900. package/src/engine-components/Interactable.ts +14 -14
  901. package/src/engine-components/Joints.ts +52 -52
  902. package/src/engine-components/LODGroup.ts +153 -153
  903. package/src/engine-components/Light.ts +558 -558
  904. package/src/engine-components/LookAtConstraint.ts +25 -25
  905. package/src/engine-components/NeedleMenu.ts +84 -84
  906. package/src/engine-components/NestedGltf.ts +86 -86
  907. package/src/engine-components/Networking.ts +114 -114
  908. package/src/engine-components/OffsetConstraint.ts +60 -60
  909. package/src/engine-components/OrbitControls.ts +1074 -1074
  910. package/src/engine-components/PlayerColor.ts +103 -103
  911. package/src/engine-components/ReflectionProbe.ts +220 -220
  912. package/src/engine-components/Renderer.ts +903 -903
  913. package/src/engine-components/RendererInstancing.ts +855 -855
  914. package/src/engine-components/RendererLightmap.ts +198 -198
  915. package/src/engine-components/RigidBody.ts +526 -526
  916. package/src/engine-components/SceneSwitcher.ts +1030 -1030
  917. package/src/engine-components/ScreenCapture.ts +592 -592
  918. package/src/engine-components/ShadowCatcher.ts +172 -172
  919. package/src/engine-components/Skybox.ts +475 -475
  920. package/src/engine-components/SmoothFollow.ts +76 -76
  921. package/src/engine-components/SpatialTrigger.ts +229 -229
  922. package/src/engine-components/SpectatorCamera.ts +787 -787
  923. package/src/engine-components/SphereCollider.ts +1 -1
  924. package/src/engine-components/SpriteRenderer.ts +468 -468
  925. package/src/engine-components/SyncedCamera.ts +220 -220
  926. package/src/engine-components/SyncedRoom.ts +380 -380
  927. package/src/engine-components/SyncedTransform.ts +383 -383
  928. package/src/engine-components/TestRunner.ts +118 -118
  929. package/src/engine-components/TransformGizmo.ts +219 -219
  930. package/src/engine-components/VideoPlayer.ts +1025 -1025
  931. package/src/engine-components/Voip.ts +363 -363
  932. package/src/engine-components/api.ts +60 -60
  933. package/src/engine-components/avatar/AvatarBlink_Simple.ts +69 -69
  934. package/src/engine-components/avatar/AvatarEyeLook_Rotation.ts +63 -63
  935. package/src/engine-components/avatar/Avatar_Brain_LookAt.ts +139 -139
  936. package/src/engine-components/avatar/Avatar_MouthShapes.ts +83 -83
  937. package/src/engine-components/avatar/Avatar_MustacheShake.ts +31 -31
  938. package/src/engine-components/codegen/components.ts +217 -217
  939. package/src/engine-components/debug/LogStats.ts +21 -21
  940. package/src/engine-components/export/gltf/GltfExport.ts +265 -265
  941. package/src/engine-components/export/usdz/Extension.ts +24 -24
  942. package/src/engine-components/export/usdz/ThreeUSDZExporter.ts +2413 -2413
  943. package/src/engine-components/export/usdz/USDZExporter.ts +705 -705
  944. package/src/engine-components/export/usdz/extensions/Animation.ts +1204 -1204
  945. package/src/engine-components/export/usdz/extensions/DocumentExtension.ts +9 -9
  946. package/src/engine-components/export/usdz/extensions/USDZText.ts +240 -240
  947. package/src/engine-components/export/usdz/extensions/USDZUI.ts +189 -189
  948. package/src/engine-components/export/usdz/extensions/behavior/Actions.ts +99 -99
  949. package/src/engine-components/export/usdz/extensions/behavior/AudioExtension.ts +102 -102
  950. package/src/engine-components/export/usdz/extensions/behavior/Behaviour.ts +320 -320
  951. package/src/engine-components/export/usdz/extensions/behavior/BehaviourComponents.ts +1225 -1225
  952. package/src/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.ts +646 -646
  953. package/src/engine-components/export/usdz/extensions/behavior/PhysicsExtension.ts +132 -132
  954. package/src/engine-components/export/usdz/index.ts +2 -2
  955. package/src/engine-components/export/usdz/utils/animationutils.ts +191 -191
  956. package/src/engine-components/export/usdz/utils/quicklook.ts +50 -50
  957. package/src/engine-components/particlesystem/ParticleSystem.ts +1287 -1287
  958. package/src/engine-components/particlesystem/ParticleSystemModules.ts +1765 -1765
  959. package/src/engine-components/particlesystem/ParticleSystemSubEmitter.ts +111 -111
  960. package/src/engine-components/particlesystem/api.ts +1 -1
  961. package/src/engine-components/postprocessing/Effects/Antialiasing.ts +64 -57
  962. package/src/engine-components/postprocessing/Effects/BloomEffect.ts +116 -116
  963. package/src/engine-components/postprocessing/Effects/ChromaticAberration.ts +37 -37
  964. package/src/engine-components/postprocessing/Effects/ColorAdjustments.ts +106 -106
  965. package/src/engine-components/postprocessing/Effects/DepthOfField.ts +103 -103
  966. package/src/engine-components/postprocessing/Effects/EffectWrapper.ts +25 -25
  967. package/src/engine-components/postprocessing/Effects/Pixelation.ts +32 -32
  968. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.ts +90 -90
  969. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.ts +192 -192
  970. package/src/engine-components/postprocessing/Effects/Sharpening.ts +143 -143
  971. package/src/engine-components/postprocessing/Effects/TiltShiftEffect.ts +61 -61
  972. package/src/engine-components/postprocessing/Effects/Tonemapping.ts +103 -103
  973. package/src/engine-components/postprocessing/Effects/Tonemapping.utils.ts +60 -60
  974. package/src/engine-components/postprocessing/Effects/Vignette.ts +59 -59
  975. package/src/engine-components/postprocessing/PostProcessingEffect.ts +192 -192
  976. package/src/engine-components/postprocessing/PostProcessingHandler.ts +573 -560
  977. package/src/engine-components/postprocessing/Volume.ts +426 -426
  978. package/src/engine-components/postprocessing/VolumeParameter.ts +158 -158
  979. package/src/engine-components/postprocessing/VolumeProfile.ts +61 -61
  980. package/src/engine-components/postprocessing/index.ts +5 -5
  981. package/src/engine-components/postprocessing/utils.ts +154 -154
  982. package/src/engine-components/timeline/PlayableDirector.ts +722 -722
  983. package/src/engine-components/timeline/SignalAsset.ts +144 -144
  984. package/src/engine-components/timeline/TimelineModels.ts +92 -92
  985. package/src/engine-components/timeline/TimelineTracks.ts +967 -967
  986. package/src/engine-components/timeline/index.ts +3 -3
  987. package/src/engine-components/ui/BaseUIComponent.ts +203 -203
  988. package/src/engine-components/ui/Button.ts +307 -307
  989. package/src/engine-components/ui/Canvas.ts +419 -419
  990. package/src/engine-components/ui/CanvasGroup.ts +54 -54
  991. package/src/engine-components/ui/EventSystem.ts +854 -854
  992. package/src/engine-components/ui/Graphic.ts +275 -275
  993. package/src/engine-components/ui/Image.ts +112 -112
  994. package/src/engine-components/ui/InputField.ts +321 -321
  995. package/src/engine-components/ui/Interfaces.ts +57 -57
  996. package/src/engine-components/ui/Layout.ts +334 -334
  997. package/src/engine-components/ui/Outline.ts +13 -13
  998. package/src/engine-components/ui/PointerEvents.ts +206 -206
  999. package/src/engine-components/ui/RaycastUtils.ts +69 -69
  1000. package/src/engine-components/ui/Raycaster.ts +102 -102
  1001. package/src/engine-components/ui/RectTransform.ts +375 -375
  1002. package/src/engine-components/ui/SpatialHtml.ts +79 -79
  1003. package/src/engine-components/ui/Symbols.ts +1 -1
  1004. package/src/engine-components/ui/Text.ts +578 -578
  1005. package/src/engine-components/ui/Utils.ts +113 -113
  1006. package/src/engine-components/utils/EnvironmentScene.ts +245 -245
  1007. package/src/engine-components/utils/LookAt.ts +88 -88
  1008. package/src/engine-components/utils/OpenURL.ts +114 -114
  1009. package/src/engine-components/webxr/Avatar.ts +265 -265
  1010. package/src/engine-components/webxr/TeleportTarget.ts +9 -9
  1011. package/src/engine-components/webxr/WebARCameraBackground.ts +175 -175
  1012. package/src/engine-components/webxr/WebARSessionRoot.ts +880 -880
  1013. package/src/engine-components/webxr/WebXR.ts +585 -585
  1014. package/src/engine-components/webxr/WebXRAvatar.ts +66 -66
  1015. package/src/engine-components/webxr/WebXRImageTracking.ts +519 -519
  1016. package/src/engine-components/webxr/WebXRPlaneTracking.ts +570 -570
  1017. package/src/engine-components/webxr/WebXRRig.ts +77 -77
  1018. package/src/engine-components/webxr/XRFlag.ts +147 -147
  1019. package/src/engine-components/webxr/controllers/XRControllerFollow.ts +118 -118
  1020. package/src/engine-components/webxr/controllers/XRControllerModel.ts +373 -373
  1021. package/src/engine-components/webxr/controllers/XRControllerMovement.ts +550 -550
  1022. package/src/engine-components/webxr/index.ts +2 -2
  1023. package/src/engine-components/webxr/types.ts +3 -3
  1024. package/src/engine-components-experimental/Presentation.ts +12 -12
  1025. package/src/engine-components-experimental/api.ts +4 -4
  1026. package/src/engine-components-experimental/networking/PlayerSync.ts +401 -401
  1027. package/src/engine-schemes/COMPILE_SCHEMES.bat +3 -3
  1028. package/src/engine-schemes/COMPILE_TS.bat +11 -11
  1029. package/src/engine-schemes/README.md +1 -1
  1030. package/src/engine-schemes/api.ts +12 -12
  1031. package/src/engine-schemes/dist/api.js +17 -0
  1032. package/src/engine-schemes/dist/api.js.meta +7 -0
  1033. package/src/engine-schemes/dist/schemes.js +25 -0
  1034. package/src/engine-schemes/dist/schemes.js.meta +7 -0
  1035. package/src/engine-schemes/dist/synced-camera-model.js +74 -0
  1036. package/src/engine-schemes/dist/synced-camera-model.js.meta +7 -0
  1037. package/src/engine-schemes/dist/synced-transform-model.js +73 -0
  1038. package/src/engine-schemes/dist/synced-transform-model.js.meta +7 -0
  1039. package/src/engine-schemes/dist/transform.js +46 -0
  1040. package/src/engine-schemes/dist/transform.js.meta +7 -0
  1041. package/src/engine-schemes/dist/vec2.js +32 -0
  1042. package/src/engine-schemes/dist/vec2.js.meta +7 -0
  1043. package/src/engine-schemes/dist/vec3.js +36 -0
  1044. package/src/engine-schemes/dist/vec3.js.meta +7 -0
  1045. package/src/engine-schemes/dist/vec4.js +40 -0
  1046. package/src/engine-schemes/dist/vec4.js.meta +7 -0
  1047. package/src/engine-schemes/dist/vr-user-state-buffer.js +110 -0
  1048. package/src/engine-schemes/dist/vr-user-state-buffer.js.meta +7 -0
  1049. package/src/engine-schemes/schemes.ts +28 -28
  1050. package/src/engine-schemes/synced-camera-model.ts +92 -92
  1051. package/src/engine-schemes/synced-transform-model.ts +90 -90
  1052. package/src/engine-schemes/syncedCamera.fbs +10 -10
  1053. package/src/engine-schemes/transform.ts +50 -50
  1054. package/src/engine-schemes/transforms.fbs +25 -25
  1055. package/src/engine-schemes/vec.fbs +19 -19
  1056. package/src/engine-schemes/vec2.ts +33 -33
  1057. package/src/engine-schemes/vec3.ts +38 -38
  1058. package/src/engine-schemes/vec4.ts +43 -43
  1059. package/src/engine-schemes/vr-user-state-buffer.ts +145 -145
  1060. package/src/engine-schemes/vrUserStateBuffer.fbs +17 -17
  1061. package/src/include/draco/draco_decoder.js +34 -34
  1062. package/src/include/ktx2/basis_transcoder.js +21 -21
  1063. package/src/include/needle/arial-msdf.json +1471 -1471
  1064. package/src/include/three/DragControls.js +231 -231
  1065. package/src/include/three/EXT_mesh_gpu_instancing_exporter.js +66 -66
  1066. package/src/needle-engine.ts +70 -70
  1067. package/dist/generateMeshBVH.worker-BaNp_Xtp.js +0 -25
@@ -1,1501 +1,1501 @@
1
- import { Intersection, Matrix4, Object3D, Ray, Vector2, Vector3 } from 'three';
2
-
3
- import { showBalloonMessage, showBalloonWarning } from './debug/debug.js';
4
- import { Context } from './engine_setup.js';
5
- import { getTempVector, getWorldQuaternion } from './engine_three_utils.js';
6
- import type { ButtonName, CursorTypeName, IGameObject, IInput, MouseButtonName, Vec2 } from './engine_types.js';
7
- import { DeviceUtilities, type EnumToPrimitiveUnion, getParam } from './engine_utils.js';
8
-
9
- const debug = getParam("debuginput");
10
-
11
-
12
- export const enum PointerType {
13
- Mouse = "mouse",
14
- Touch = "touch",
15
- Controller = "controller",
16
- Hand = "hand"
17
- }
18
- export type PointerTypeNames = EnumToPrimitiveUnion<PointerType>;
19
-
20
- const enum PointerEnumType {
21
- PointerDown = "pointerdown",
22
- PointerUp = "pointerup",
23
- PointerMove = "pointermove",
24
- }
25
- const enum KeyboardEnumType {
26
- KeyDown = "keydown",
27
- KeyUp = "keyup",
28
- KeyPressed = "keypress"
29
- }
30
-
31
- export const enum InputEvents {
32
- PointerDown = "pointerdown",
33
- PointerUp = "pointerup",
34
- PointerMove = "pointermove",
35
- KeyDown = "keydown",
36
- KeyUp = "keyup",
37
- KeyPressed = "keypress"
38
- }
39
-
40
- /** e.g. `pointerdown` */
41
- type PointerEventNames = EnumToPrimitiveUnion<PointerEnumType>;
42
- type KeyboardEventNames = EnumToPrimitiveUnion<KeyboardEnumType>;
43
- export type InputEventNames = PointerEventNames | KeyboardEventNames;
44
-
45
- declare type PointerEventListener = (evt: NEPointerEvent) => void;
46
- declare type KeyboardEventListener = (evt: NEKeyboardEvent) => void;
47
- declare type InputEventListener = PointerEventListener | KeyboardEventListener;
48
-
49
-
50
-
51
- export declare type NEPointerEventInit = PointerEventInit &
52
- {
53
- clientZ?: number;
54
- origin: object;
55
- pointerId: number;
56
- /** the index of the device */
57
- deviceIndex: number;
58
- pointerType: PointerTypeNames;
59
- mode: XRTargetRayMode,
60
- ray?: Ray;
61
- /** The control object for this input. In the case of spatial devices the controller,
62
- * otherwise a generated object in screen space. The object may not be in the scene. */
63
- device: IGameObject;
64
- buttonName: ButtonName | "none";
65
- }
66
-
67
- declare type OnPointerHitsEvent = (args: OnPointerHitEvent) => void;
68
- declare type OnPointerHitEvent = {
69
- /** The object that raised the event */
70
- sender: object;
71
- /** The pointer event that invoked the event */
72
- event: NEPointerEvent;
73
- /** The intersections that were generated from this event (or are associated with this event in any way) */
74
- hits: Intersection[];
75
- }
76
- export interface IPointerHitEventReceiver {
77
- onPointerHits: OnPointerHitsEvent;
78
- }
79
-
80
- /** An intersection that is potentially associated with a pointer event */
81
- export declare type NEPointerEventIntersection = Intersection & { event?: NEPointerEvent };
82
-
83
- /**
84
- * The Needle Engine Pointer Event is a custom event that extends the PointerEvent. It holds additional information like the device index, the origin of the event, the mode of the event (e.g. screen or spatial), the ray in world space, the space of the device, and more.
85
- */
86
- export class NEPointerEvent extends PointerEvent {
87
-
88
- /**
89
- * Spatial input data
90
- */
91
- clientZ?: number;
92
-
93
- /** the device index: mouse and touch are always 0, otherwise e.g. index of the connected Gamepad or XRController */
94
- readonly deviceIndex: number;
95
-
96
- /** The origin of the event contains a reference to the creator of this event.
97
- * This can be the Needle Engine input system or e.g. a XR controller.
98
- * Implement `onPointerHits` to receive the intersections of this event.
99
- */
100
- readonly origin: object & Partial<IPointerHitEventReceiver>;
101
-
102
- /** the browser event that triggered this event (if any) */
103
- readonly source: Event | null;
104
-
105
- /** Is the pointer event created via a touch on screen or a spatial device like a XR controller or hand tracking? */
106
- readonly mode: XRTargetRayMode | "transient-pointer";
107
-
108
- /** Returns true if the input was emitted in 3D space (and not by e.g. clicking on a 2D screen). You can use {@link mode} if you need more information about the input source */
109
- get isSpatial() {
110
- return this.mode != "screen";
111
- }
112
-
113
- /** A ray in worldspace for the event.
114
- * If the ray is undefined you can also use `space.worldForward` and `space.worldPosition` */
115
- get ray(): Ray {
116
- if (!this._ray) {
117
- this._ray = new Ray(this.space.worldPosition.clone(), this.space.worldForward.clone());
118
- }
119
- return this._ray;
120
- }
121
- private set ray(value: Ray) { this._ray = value; }
122
- /**@returns true if this event has a ray. If you access the ray property a ray will automatically created */
123
- get hasRay() { return this._ray !== undefined; }
124
- private _ray: Ray | undefined;
125
-
126
- /** The device space (this object is not necessarily rendered in the scene but you can access or copy the matrix)
127
- * E.g. you can access the input world space source position with `space.worldPosition` or world direction with `space.worldForward`
128
- */
129
- readonly space: IGameObject;
130
-
131
- /** true if this event is a click */
132
- isClick: boolean = false;
133
- /** true if this event is a double click */
134
- isDoubleClick: boolean = false;
135
-
136
- /** @returns `true` if the event is marked to be used (when `use()` has been called). Default: `false` */
137
- get used() { return this._used; }
138
- private _used: boolean = false;
139
- /** Call to mark an event to be used */
140
- use() {
141
- this._used = true;
142
- }
143
-
144
- /** Unique identifier for this input: a combination of the deviceIndex + button to uniquely identify the exact input (e.g. LeftController:Button0 = 0, RightController:Button1 = 11) */
145
- override get pointerId(): number { return this._pointerid; }
146
- private readonly _pointerid;
147
-
148
- // this is set via the init arguments (we override it here for intellisense to show the string options)
149
- /** What type of input created this event: touch, mouse, xr controller, xr hand tracking... */
150
- override get pointerType(): PointerTypeNames { return this._pointerType; }
151
- private readonly _pointerType: PointerTypeNames;
152
-
153
- // this is set via the init arguments (we override it here for intellisense to show the string options)
154
- /** The input that raised this event like `pointerdown` */
155
- override get type(): InputEventNames { return this._type; }
156
- private readonly _type: InputEventNames;
157
-
158
- /** metadata can be used to associate additional information with the event */
159
- readonly metadata = {}
160
-
161
- /** intersections that were generated from this event (or are associated with this event in any way) */
162
- readonly intersections = new Array<NEPointerEventIntersection>();
163
-
164
- constructor(type: InputEvents | InputEventNames, source: Event | null, init: NEPointerEventInit) {
165
- super(type, init);
166
- this.clientZ = init.clientZ;
167
- // apply the init arguments. Otherwise the arguments will be undefined in the bundled / published version of needle engine
168
- // so we have to be careful if we override properties - we then also need to set them in the constructor
169
- this._pointerid = init.pointerId;
170
- this._pointerType = init.pointerType;
171
- this._type = type;
172
-
173
- this.deviceIndex = init.deviceIndex;
174
- this.origin = init.origin;
175
- this.source = source;
176
- this.mode = init.mode;
177
- this._ray = init.ray;
178
- this.space = init.device;
179
- }
180
-
181
- private _immediatePropagationStopped = false;
182
- get immediatePropagationStopped() {
183
- return this._immediatePropagationStopped;
184
- }
185
- private _propagationStopped = false;
186
- get propagationStopped() {
187
- return this._immediatePropagationStopped || this._propagationStopped;
188
- }
189
-
190
- stopImmediatePropagation(): void {
191
- this._immediatePropagationStopped = true;
192
- super.stopImmediatePropagation();
193
- this.source?.stopImmediatePropagation();
194
- }
195
- stopPropagation(): void {
196
- this._propagationStopped = true;
197
- super.stopPropagation();
198
- this.source?.stopPropagation();
199
- if (debug) console.warn("Stop propagation...", this.pointerId, this.pointerType)
200
- }
201
- }
202
- export class NEKeyboardEvent extends KeyboardEvent {
203
- source?: Event
204
- constructor(type: InputEvents, source: Event, init: KeyboardEventInit) {
205
- super(type, init)
206
- this.source = source;
207
- }
208
- stopImmediatePropagation(): void {
209
- super.stopImmediatePropagation();
210
- this.source?.stopImmediatePropagation();
211
- }
212
- }
213
-
214
- export class KeyEventArgs {
215
- key: string;
216
- keyType: string;
217
- source?: Event;
218
- constructor(evt: KeyboardEvent) {
219
- this.key = evt.key;
220
- this.keyType = evt.type;
221
- this.source = evt;
222
- }
223
- }
224
-
225
-
226
-
227
- export enum InputEventQueue {
228
- Early = -100,
229
- Default = 0,
230
- Late = 100,
231
- }
232
-
233
- declare type EventListenerOptions = {
234
- /** For addEventListener: The queue to add the listener to. Listeners in the same queue are called in the order they were added. Default is 0.
235
- * For removeEventListener: The queue to remove the listener from. If no queue is specified the listener will be removed from all queues
236
- */
237
- queue?: InputEventQueue | number;
238
- /** If true, the listener will be removed after it is invoked once. */
239
- once?: boolean;
240
- /** The listener will be removed when the given AbortSignal object's `abort()` method is called. If not specified, no AbortSignal is associated with the listener. */
241
- signal?: AbortSignal;
242
- }
243
-
244
- /**
245
- * The input system is responsible for handling all input events like pointer events (mouse, touch, xr controllers) and keyboard events.
246
- */
247
- export class Input implements IInput {
248
-
249
- /** This is a list of event listeners per event type (e.g. pointerdown, pointerup, keydown...). Each entry contains a priority and list of listeners.
250
- * That way users can control if they want to receive events before or after other listeners (e.g subscribe to pointer events before the EventSystem receives them) - this allows certain listeners to be always invoked first (or last) and stop propagation
251
- * Listeners per event are sorted
252
- */
253
- private readonly _eventListeners: { [key: string]: Array<{ priority: number, listeners: Array<{ callback: InputEventListener, options: EventListenerOptions }> }> } = {};
254
-
255
- /** Adds an event listener for the specified event type. The callback will be called when the event is triggered.
256
- * @param type The event type to listen for
257
- * @param callback The callback to call when the event is triggered
258
- * @param options The options for adding the event listener.
259
- * @example Basic usage:
260
- * ```ts
261
- * input.addEventListener("pointerdown", (evt) => {
262
- * console.log("Pointer down", evt.pointerId, evt.pointerType);
263
- * });
264
- * ```
265
- * @example Adding a listener that is called after all other listeners
266
- * By using a higher value for the queue the listener will be called after other listeners (default queue is 0).
267
- * ```ts
268
- * input.addEventListener("pointerdown", (evt) => {
269
- * console.log("Pointer down", evt.pointerId, evt.pointerType);
270
- * }, { queue: 10 });
271
- * ```
272
- * @example Adding a listener that is only called once
273
- * ```ts
274
- * input.addEventListener("pointerdown", (evt) => {
275
- * console.log("Pointer down", evt.pointerId, evt.pointerType);
276
- * }, { once: true });
277
- * ```
278
- */
279
- addEventListener(type: PointerEventNames, callback: PointerEventListener, options?: EventListenerOptions);
280
- addEventListener(type: KeyboardEventNames, callback: KeyboardEventListener, options?: EventListenerOptions);
281
- addEventListener(type: InputEvents | InputEventNames, callback: InputEventListener, options?: EventListenerOptions): void {
282
- if (!this._eventListeners[type]) this._eventListeners[type] = [];
283
-
284
- if (!callback || typeof callback !== "function") {
285
- console.error("Invalid call to addEventListener: callback is required and must be a function!");
286
- return;
287
- }
288
-
289
- if (!options) options = {};
290
- // create a copy of the options object to avoid the original object being modified
291
- else options = { ...options };
292
-
293
- let queue = 0;
294
- if (options?.queue != undefined) queue = options.queue;
295
-
296
- const listeners = this._eventListeners[type];
297
- const queueListeners = listeners.find(l => l.priority === queue);
298
- if (!queueListeners) {
299
- listeners.push({ priority: queue, listeners: [{ callback, options }] });
300
- // ensure we sort the listeners by priority
301
- listeners.sort((a, b) => a.priority - b.priority);
302
- } else {
303
- queueListeners.listeners.push({ callback, options });
304
- }
305
- }
306
- /** Removes the event listener from the specified event type. If no queue is specified the listener will be removed from all queues.
307
- * @param type The event type to remove the listener from
308
- * @param callback The callback to remove
309
- * @param options The options for removing the event listener
310
- */
311
- removeEventListener(type: PointerEventNames, callback: PointerEventListener, options?: EventListenerOptions);
312
- removeEventListener(type: KeyboardEventNames, callback: KeyboardEventListener, options?: EventListenerOptions);
313
- removeEventListener(type: InputEvents | InputEventNames, callback: InputEventListener, options?: EventListenerOptions): void {
314
- if (!this._eventListeners[type]) return;
315
- if (!callback) return;
316
- const listeners = this._eventListeners[type];
317
- // if a specific queue is requested the callback should only be removed from that queue
318
- if (options?.queue != undefined) {
319
- const queueListeners = listeners.find(l => l.priority === options.queue);
320
- if (!queueListeners) return;
321
- const index = queueListeners.listeners.findIndex(l => l.callback === callback);
322
- if (index >= 0) queueListeners.listeners.splice(index, 1);
323
- }
324
- // if no queue is requested the callback will be removed from all queues
325
- else {
326
- for (const l of listeners) {
327
- const index = l.listeners.findIndex(l => l.callback === callback);
328
- if (index >= 0) l.listeners.splice(index, 1);
329
- }
330
- }
331
- }
332
- private dispatchEvent(evt: NEPointerEvent | NEKeyboardEvent) {
333
- /** True when the next event queue should not be invoked */
334
- let preventNextEventQueue = false;
335
-
336
- // Handle keyboard event
337
- if (evt instanceof NEKeyboardEvent) {
338
- const listeners = this._eventListeners[evt.type];
339
- if (listeners) {
340
- for (const queue of listeners) {
341
- for (let i = 0; i < queue.listeners.length; i++) {
342
- const entry = queue.listeners[i];
343
- // if the abort signal is aborted we remove the listener and will not invoke it
344
- if (entry.options?.signal?.aborted) {
345
- queue.listeners.splice(i, 1);
346
- i--;
347
- continue;
348
- }
349
- // if the event should only be invoked once then we remove the listener before invoking it
350
- if (entry.options.once) {
351
- queue.listeners.splice(i, 1);
352
- i--;
353
- }
354
- (entry.callback as KeyboardEventListener)(evt);
355
- }
356
- }
357
- }
358
- }
359
-
360
- // Hnadle pointer event
361
- if (evt instanceof NEPointerEvent) {
362
- const listeners = this._eventListeners[evt.type];
363
- if (listeners) {
364
- for (const queue of listeners) {
365
- if (preventNextEventQueue) break;
366
- for (let i = 0; i < queue.listeners.length; i++) {
367
- const entry = queue.listeners[i];
368
-
369
- // if the abort signal is aborted we remove the listener and will not invoke it
370
- if (entry.options?.signal?.aborted) {
371
- queue.listeners.splice(i, 1);
372
- i--;
373
- continue;
374
- }
375
- // if immediatePropagationStopped is true we stop propagation altogether
376
- if (evt.immediatePropagationStopped) {
377
- preventNextEventQueue = true;
378
- if (debug) console.log("immediatePropagationStopped", evt.type);
379
- break;
380
- }
381
- // if propagationStopped is true we continue invoking the current queue but then not invoke the next queue
382
- else if (evt.propagationStopped) {
383
- preventNextEventQueue = true;
384
- if (debug) console.log("propagationStopped", evt.type);
385
- // we do not break here but continue invoking the listeners in the queue
386
- }
387
-
388
- // if the event should only be invoked once then we remove the listener before invoking it
389
- if (entry.options.once) {
390
- queue.listeners.splice(i, 1);
391
- i--;
392
- }
393
- (entry.callback as PointerEventListener)(evt);
394
- }
395
- }
396
- }
397
- }
398
- }
399
-
400
-
401
- _doubleClickTimeThreshold = .2;
402
- _longPressTimeThreshold = 1;
403
-
404
- get mousePosition(): Vector2 { return this._pointerPositions[0]; };
405
- get mousePositionRC(): Vector2 { return this._pointerPositionsRC[0]; }
406
- get mouseDown(): boolean { return this._pointerDown[0]; }
407
- get mouseUp(): boolean { return this._pointerUp[0]; }
408
- /** Is the primary pointer clicked (usually the left button). This is equivalent to `input.click` */
409
- get mouseClick(): boolean { return this._pointerClick[0]; }
410
- /** Was a double click detected for the primary pointer? This is equivalent to `input.doubleClick` */
411
- get mouseDoubleClick(): boolean { return this._pointerDoubleClick[0]; }
412
- get mousePressed(): boolean { return this._pointerPressed[0]; }
413
- get mouseWheelChanged(): boolean { return this.getMouseWheelChanged(0); }
414
-
415
- /** Is the primary pointer double clicked (usually the left button). This is equivalent to `input.mouseDoubleClick` */
416
- get click(): boolean { return this._pointerClick[0]; }
417
- /** Was a double click detected for the primary pointer? */
418
- get doubleClick(): boolean { return this._pointerDoubleClick[0]; }
419
-
420
- /**
421
- * Get a connected Gamepad
422
- * Note: For a gamepad to be available to the browser it must have received input before while the page was focused.
423
- * @link https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
424
- * @returns The gamepad or null if no gamepad is connected
425
- */
426
- getGamepad(index: number = 0): Gamepad | null {
427
- if (typeof navigator !== "undefined" && "getGamepads" in navigator) {
428
- return navigator.getGamepads()[index] || null;
429
- }
430
- return null;
431
- }
432
-
433
- private readonly _setCursorTypes: CursorTypeName[] = [];
434
-
435
- /** @deprecated use setCursor("pointer") */
436
- setCursorPointer() {
437
- this.setCursor("pointer");
438
- }
439
- /** @deprecated use unsetCursor() */
440
- setCursorNormal() {
441
- this.unsetCursor("pointer");
442
- }
443
- /**
444
- * Set a custom cursor. This will set the cursor type until unsetCursor is called
445
- */
446
- setCursor(type: CursorTypeName) {
447
- this._setCursorTypes.push(type);
448
- if (this._setCursorTypes.length > 10) {
449
- this._setCursorTypes.shift();
450
- }
451
- this.updateCursor();
452
- }
453
- /**
454
- * Unset a custom cursor. This will set the cursor type to the previous type or default
455
- */
456
- unsetCursor(type: CursorTypeName) {
457
- for (let i = this._setCursorTypes.length - 1; i >= 0; i--) {
458
- if (this._setCursorTypes[i] === type) {
459
- this._setCursorTypes.splice(i, 1);
460
- this.updateCursor();
461
- break;
462
- }
463
- }
464
- }
465
- private updateCursor() {
466
- if (this._setCursorTypes?.length == 0)
467
- this.context.domElement.style.cursor = "default";
468
- else this.context.domElement.style.cursor = this._setCursorTypes[this._setCursorTypes.length - 1];
469
- }
470
-
471
- /**
472
- * Check if a pointer id is currently used.
473
- */
474
- getIsPointerIdInUse(pointerId: number) {
475
- for (const evt of this._pointerEventsPressed) {
476
- if (evt.pointerId === pointerId) {
477
- if (evt.used) return true;
478
- }
479
- }
480
- return false;
481
- }
482
- /** how many pointers are currently pressed */
483
- getPointerPressedCount(): number {
484
- let count = 0;
485
- for (let i = 0; i < this._pointerPressed.length; i++) {
486
- if (this._pointerPressed[i]) {
487
- count++;
488
- }
489
- }
490
- return count;
491
- }
492
-
493
- /**
494
- * Gets the position of the given pointer index in pixel
495
- * @param i The pointer index
496
- * @returns The position of the pointer in pixel
497
- */
498
- getPointerPosition(i: number): Vector2 | null {
499
- if (i >= this._pointerPositions.length) return null;
500
- return this._pointerPositions[i];
501
- }
502
- getPointerPositionLastFrame(i: number): Vector2 | null {
503
- if (i >= this._pointerPositionsLastFrame.length) return null;
504
- return this._pointerPositionsLastFrame[i];
505
- }
506
- getPointerPositionDelta(i: number): Vector2 | null {
507
- if (i >= this._pointerPositionsDelta.length) return null;
508
- return this._pointerPositionsDelta[i];
509
- }
510
- /**
511
- * The pointer position in screenspace coordinates (-1 to 1) where 0 is the center of the screen.
512
- * This can be useful for e.g. raycasting (see https://threejs.org/docs/#api/en/core/Raycaster.setFromCamera)
513
- */
514
- getPointerPositionRC(i: number): Vector2 | null {
515
- if (i >= this._pointerPositionsRC.length) return null;
516
- return this._pointerPositionsRC[i];
517
- }
518
- getPointerDown(i: number): boolean {
519
- if (i >= this._pointerDown.length) return false;
520
- return this._pointerDown[i];
521
- }
522
- getPointerUp(i: number): boolean {
523
- if (i >= this._pointerUp.length) return false;
524
- return this._pointerUp[i];
525
- }
526
- getPointerPressed(i: number): boolean {
527
- if (i >= this._pointerPressed.length) return false;
528
- const res = this._pointerPressed[i];
529
- // if (i === 0) console.log(...this._pointerIds);
530
- return res;
531
- }
532
- getPointerClicked(i: number): boolean {
533
- if (i >= this._pointerClick.length) return false;
534
- return this._pointerClick[i];
535
- }
536
- getPointerDoubleClicked(i: number): boolean {
537
- if (i >= this._pointerDoubleClick.length) return false;
538
- return this._pointerDoubleClick[i];
539
- }
540
- getPointerDownTime(i: number): number {
541
- if (i >= this._pointerDownTime.length) return -1;
542
- return this._pointerDownTime[i];
543
- }
544
- getPointerUpTime(i: number): number {
545
- if (i >= this._pointerUpTime.length) return -1;
546
- return this._pointerUpTime[i];
547
- }
548
- getPointerLongPress(i: number): boolean {
549
- if (i >= this._pointerDownTime.length) return false;
550
- return this.getPointerPressed(i) && this.context.time.time - this._pointerDownTime[i] > this._longPressTimeThreshold;
551
- }
552
- getIsMouse(i: number): boolean {
553
- if (i < 0 || i >= this._pointerTypes.length) return false;
554
- return this._pointerTypes[i] === PointerType.Mouse;
555
- }
556
- getIsTouch(i: number): boolean {
557
- if (i < 0 || i >= this._pointerTypes.length) return false;
558
- return this._pointerTypes[i] === PointerType.Touch;
559
- }
560
- getTouchesPressedCount(): number {
561
- let count = 0;
562
- for (let i = 0; i < this._pointerPressed.length; i++) {
563
- if (this._pointerPressed[i] && this.getIsTouch(i)) {
564
- count++;
565
- }
566
- }
567
- return count;
568
- }
569
- getMouseWheelChanged(i: number = 0): boolean {
570
- if (i >= this._mouseWheelChanged.length) return false;
571
- return this._mouseWheelChanged[i];
572
- }
573
- getMouseWheelDeltaY(i: number = 0): number {
574
- if (i >= this._mouseWheelDeltaY.length) return 0;
575
- return this._mouseWheelDeltaY[i];
576
- }
577
- getPointerEvent(i: number): Event | undefined {
578
- if (i >= this._pointerEvent.length) return undefined;
579
- return this._pointerEvent[i] ?? undefined;
580
- }
581
- *foreachPointerId(pointerType?: string | PointerType | string[] | PointerType[]): Generator<number> {
582
- for (let i = 0; i < this._pointerTypes.length; i++) {
583
- // check if the pointer is active
584
- if (this._pointerIsActive(i)) {
585
- // if specific pointer types are requested
586
- if (pointerType !== undefined) {
587
- const type = this._pointerTypes[i];
588
- if (Array.isArray(pointerType)) {
589
- let isInArray = false;
590
- for (const t of pointerType) {
591
- if (type === t) {
592
- isInArray = true;
593
- break;
594
- }
595
- }
596
- if (!isInArray) continue;
597
- } else {
598
- if (pointerType !== type) continue;
599
- }
600
- }
601
- yield i;
602
- }
603
- }
604
- }
605
- *foreachTouchId(): Generator<number> {
606
- for (let i = 0; i < this._pointerTypes.length; i++) {
607
- const type = this._pointerTypes[i];
608
- if (type !== PointerType.Touch) continue;
609
- if (this._pointerIsActive[i])
610
- yield i;
611
- }
612
- }
613
-
614
- private _pointerIsActive(index: number) {
615
- if (index < 0) return false;
616
- return this._pointerPressed[index] || this._pointerDown[index] || this._pointerUp[index];
617
- }
618
-
619
- private context: Context;
620
-
621
- private _pointerDown: boolean[] = [false];
622
- private _pointerUp: boolean[] = [false];
623
- private _pointerClick: boolean[] = [false];
624
- private _pointerDoubleClick: boolean[] = [false];
625
- private _pointerPressed: boolean[] = [false];
626
- private _pointerPositions: Vector2[] = [new Vector2()];
627
- private _pointerPositionsLastFrame: Vector2[] = [new Vector2()];
628
- private _pointerPositionsDelta: Vector2[] = [new Vector2()];
629
- private _pointerPositionsRC: Vector2[] = [new Vector2()];
630
- private _pointerPositionDown: Vector3[] = [new Vector3()];
631
- private _pointerDownTime: number[] = [];
632
- private _pointerUpTime: number[] = [];
633
- private _pointerUpTimestamp: number[] = [];
634
- private _pointerIds: number[] = [];
635
- private _pointerTypes: string[] = [""];
636
- private _mouseWheelChanged: boolean[] = [false];
637
- private _mouseWheelDeltaY: number[] = [0];
638
- private _pointerEvent: Event[] = [];
639
- /** current pressed pointer events. Used to check if any of those events was used */
640
- private _pointerEventsPressed: NEPointerEvent[] = [];
641
- /** This is added/updated for pointers. screenspace pointers set this to the camera near plane */
642
- private _pointerSpace: IGameObject[] = [];
643
-
644
-
645
- private readonly _pressedStack = new Map<number, number[]>();
646
- private onDownButton(pointerId: number, button: number) {
647
- let stack = this._pressedStack.get(pointerId);
648
- if (!stack) {
649
- stack = [];
650
- this._pressedStack.set(pointerId, stack);
651
- }
652
- stack.push(button);
653
- }
654
- private onReleaseButton(pointerId: number, button: number) {
655
- const stack = this._pressedStack.get(pointerId);
656
- if (!stack) return;
657
- const index = stack.indexOf(button);
658
- if (index >= 0) stack.splice(index, 1);
659
- }
660
- /** the first button that was down and is currently pressed */
661
- getFirstPressedButtonForPointer(pointerId: number): number | undefined {
662
- const stack = this._pressedStack.get(pointerId);
663
- if (!stack) return undefined;
664
- return stack[0];
665
- }
666
- /** the last (most recent) button that was down and is currently pressed */
667
- getLatestPressedButtonForPointer(pointerId: number): number | undefined {
668
- const stack = this._pressedStack.get(pointerId);
669
- if (!stack) return undefined;
670
- return stack[stack.length - 1];
671
- }
672
-
673
-
674
- /** Get a key (if any) that was just pressed this frame (this is only true for the frame it was pressed down) */
675
- getKeyDown(): string | null;
676
- /** Get true or false if the given key was pressed this frame */
677
- getKeyDown(key: KeyCode | ({} & string)): boolean;
678
- getKeyDown(key?: KeyCode | ({} & string)): boolean | string | null {
679
- // If a key is provided check if it was pressed this frame
680
- if (key !== undefined) {
681
- return this.isKeyDown(key);
682
- }
683
- // If no key was provided get the first key that was pressed this frame
684
- for (const key in this.keysPressed) {
685
- const k = this.keysPressed[key];
686
- if (k.startFrame === this.context.time.frameCount) return k.key;
687
- }
688
- return null;
689
- }
690
- /** Get a key (if any) that is currently being pressed (held down) */
691
- getKeyPressed(): string | null;
692
- /** Get true or false if the given key is pressed */
693
- getKeyPressed(key: KeyCode | ({} & string)): boolean
694
- getKeyPressed(key?: KeyCode | ({} & string)): boolean | string | null {
695
- if (key !== undefined) {
696
- return this.isKeyPressed(key);
697
- }
698
- for (const key in this.keysPressed) {
699
- const k = this.keysPressed[key];
700
- if (k.pressed)
701
- return k.key;
702
- }
703
- return null;
704
- }
705
-
706
- /** Get a key (if any) that was released in this frame */
707
- getKeyUp(): string | null;
708
- /** Get true or false if the given key was released this frame */
709
- getKeyUp(key: KeyCode | ({} & string)): boolean;
710
- getKeyUp(key?: KeyCode | ({} & string)): boolean | string | null {
711
-
712
- if (key !== undefined) {
713
- return this.isKeyUp(key);
714
- }
715
- for (const key in this.keysPressed) {
716
- const k = this.keysPressed[key];
717
- if (k.pressed === false && k.frame === this.context.time.frameCount) return true;
718
- return false;
719
- }
720
-
721
- return null;
722
- }
723
-
724
- isKeyDown(keyCode: KeyCode | ({} & string)) {
725
- if (!this.context.application.isVisible || !this.context.application.hasFocus) return false;
726
- const codes = this.getCodeForCommonKeyName(keyCode);
727
- if (codes !== null) {
728
- for (const code of codes) if (this.isKeyDown(code)) return true;
729
- return false;
730
- }
731
- const k = this.keysPressed[keyCode];
732
- if (!k) return false;
733
- return k.startFrame === this.context.time.frameCount && k.pressed;
734
- }
735
- isKeyUp(keyCode: KeyCode | ({} & string)) {
736
- if (!this.context.application.isVisible || !this.context.application.hasFocus) return false;
737
- const codes = this.getCodeForCommonKeyName(keyCode);
738
- if (codes !== null) {
739
- for (const code of codes) if (this.isKeyUp(code)) return true;
740
- return false;
741
- }
742
- const k = this.keysPressed[keyCode];
743
- if (!k) return false;
744
- return k.frame === this.context.time.frameCount && k.pressed === false;
745
- }
746
- isKeyPressed(keyCode: KeyCode | ({} & string)): boolean {
747
- if (!this.context.application.isVisible || !this.context.application.hasFocus) return false;
748
- const codes = this.getCodeForCommonKeyName(keyCode);
749
- if (codes !== null) {
750
- for (const code of codes) if (this.isKeyPressed(code)) return true;
751
- return false;
752
- }
753
- const k = this.keysPressed[keyCode];
754
- if (!k) return false;
755
- return k.pressed || false;
756
- }
757
-
758
- // utility helper for mapping common names to actual codes; e.g. "Shift" -> "ShiftLeft" and "ShiftRight" or "a" -> "KeyA"
759
- private getCodeForCommonKeyName(keyName: string): string[] | null {
760
- if (keyName.length === 1) {
761
- // check if this is a digit
762
- if (keyName >= "0" && keyName <= "9")
763
- return ["Digit" + keyName];
764
- // check if this is a letter
765
- if (keyName >= "a" && keyName <= "z")
766
- return ["Key" + keyName.toUpperCase()];
767
- if (keyName == " ")
768
- return ["Space"];
769
- }
770
- switch (keyName) {
771
- case "shift":
772
- case "Shift":
773
- return ["ShiftLeft", "ShiftRight"];
774
- case "control":
775
- case "Control":
776
- return ["ControlLeft", "ControlRight"];
777
- case "alt":
778
- case "Alt":
779
- return ["AltLeft", "AltRight"];
780
- }
781
- return null;
782
- }
783
-
784
- createInputEvent(args: NEPointerEvent) {
785
- // TODO: technically we would need to check for circular invocations here!
786
- switch (args.type) {
787
- case InputEvents.PointerDown:
788
- if (debug) showBalloonMessage("Create Pointer down");
789
- this.onDownButton(args.deviceIndex, args.button);
790
- this.onDown(args);
791
- break;
792
- case InputEvents.PointerMove:
793
- if (debug) showBalloonMessage("Create Pointer move");
794
- this.onMove(args);
795
- break;
796
- case InputEvents.PointerUp:
797
- if (debug) showBalloonMessage("Create Pointer up");
798
- this.onUp(args);
799
- this.onReleaseButton(args.deviceIndex, args.button);
800
- break;
801
- }
802
- }
803
-
804
- convertScreenspaceToRaycastSpace<T extends Vec2 | Vector2>(vec2: T): T {
805
- vec2.x = (vec2.x - this.context.domX) / this.context.domWidth * 2 - 1;
806
- vec2.y = -((vec2.y - this.context.domY) / this.context.domHeight) * 2 + 1;
807
- return vec2;
808
- }
809
-
810
- /** @internal */
811
- constructor(context: Context) {
812
- this.context = context;
813
- this.context.post_render_callbacks.push(this.onEndOfFrame);
814
- }
815
-
816
- /** this is the html element we subscribed to for events */
817
- private _htmlEventSource!: HTMLElement;
818
-
819
- bindEvents() {
820
- this.unbindEvents();
821
-
822
- // we subscribe to the canvas element because we don't want to receive events when the user is interacting with the UI
823
- // e.g. if we have slotted HTML elements in the needle engine DOM elements we don't want to receive input events for those
824
- this._htmlEventSource = this.context.renderer.domElement;
825
-
826
- window.addEventListener('contextmenu', this.onContextMenu);
827
-
828
- this._htmlEventSource.addEventListener('pointerdown', this.onPointerDown, { passive: true });
829
- window.addEventListener('pointermove', this.onPointerMove, { passive: true, capture: true, });
830
- window.addEventListener('pointerup', this.onPointerUp, { passive: true });
831
- window.addEventListener('pointercancel', this.onPointerCancel, { passive: true })
832
-
833
- window.addEventListener("touchstart", this.onTouchStart, { passive: true });
834
- window.addEventListener("touchmove", this.onTouchMove, { passive: true });
835
- window.addEventListener("touchend", this.onTouchEnd, { passive: true });
836
-
837
- this._htmlEventSource.addEventListener('wheel', this.onMouseWheel, { passive: true });
838
- window.addEventListener("wheel", this.onWheelWindow, { passive: true })
839
-
840
- window.addEventListener("keydown", this.onKeyDown, false);
841
- window.addEventListener("keypress", this.onKeyPressed, false);
842
- window.addEventListener("keyup", this.onKeyUp, false);
843
-
844
- // e.g. when using sharex to capture we loose focus thus dont get e.g. key up events
845
- window.addEventListener('blur', this.onLostFocus);
846
- }
847
-
848
- unbindEvents() {
849
- window.removeEventListener('contextmenu', this.onContextMenu);
850
-
851
- this._htmlEventSource?.removeEventListener('pointerdown', this.onPointerDown);
852
- window.removeEventListener('pointermove', this.onPointerMove);
853
- window.removeEventListener('pointerup', this.onPointerUp);
854
- window.removeEventListener('pointercancel', this.onPointerCancel);
855
-
856
- window.removeEventListener("touchstart", this.onTouchStart);
857
- window.removeEventListener("touchmove", this.onTouchMove);
858
- window.removeEventListener("touchend", this.onTouchEnd);
859
-
860
- this._htmlEventSource?.removeEventListener('wheel', this.onMouseWheel, false);
861
- window.removeEventListener("wheel", this.onWheelWindow, false);
862
-
863
- window.removeEventListener("keydown", this.onKeyDown, false);
864
- window.removeEventListener("keypress", this.onKeyPressed, false);
865
- window.removeEventListener("keyup", this.onKeyUp, false);
866
-
867
- window.removeEventListener('blur', this.onLostFocus);
868
- }
869
-
870
- dispose() {
871
- const index = this.context.post_render_callbacks.indexOf(this.onEndOfFrame);
872
- if (index >= 0) this.context.post_render_callbacks.splice(index, 1);
873
- this.unbindEvents();
874
- }
875
-
876
- private onLostFocus = () => {
877
- for (const kp in this.keysPressed) {
878
- this.keysPressed[kp].pressed = false;
879
- }
880
- }
881
-
882
- private readonly _receivedPointerMoveEventsThisFrame = new Array<number>;
883
-
884
- private onEndOfFrame = () => {
885
- this._receivedPointerMoveEventsThisFrame.length = 0;
886
- for (let i = 0; i < this._pointerUp.length; i++)
887
- this._pointerUp[i] = false;
888
- for (let i = 0; i < this._pointerDown.length; i++)
889
- this._pointerDown[i] = false;
890
- for (let i = 0; i < this._pointerClick.length; i++)
891
- this._pointerClick[i] = false;
892
- for (let i = 0; i < this._pointerDoubleClick.length; i++)
893
- this._pointerDoubleClick[i] = false;
894
- for (const pt of this._pointerPositionsDelta)
895
- pt.set(0, 0);
896
- for (let i = 0; i < this._mouseWheelChanged.length; i++)
897
- this._mouseWheelChanged[i] = false;
898
- for (let i = 0; i < this._mouseWheelDeltaY.length; i++)
899
- this._mouseWheelDeltaY[i] = 0;
900
- }
901
-
902
- private canReceiveInput(evt: Event) {
903
- // If the user has HTML objects ontop of the canvas
904
- // if(evt.target === this.context.renderer.domElement) return true;
905
- // const css = window.getComputedStyle(evt.target as HTMLElement);
906
- // if(css.pointerEvents === "all") return false;
907
- // We only check the target elements here since the canvas may be overlapped by other elements
908
- // in which case we do not want to use the input (e.g. if a HTML element is being triggered)
909
- if (evt.target === this.context.renderer?.domElement) return true;
910
- if (evt.target === this.context.domElement) return true;
911
-
912
- // if we are in AR we always want to receive touches because the canvas is the whole screen.
913
- // See https://linear.app/needle/issue/NE-4345
914
- if (this.context.isInAR) {
915
- return true;
916
- }
917
-
918
- // looks like in Mozilla WebXR viewer the target element is the body
919
- if (this.context.isInAR && evt.target === document.body && DeviceUtilities.isMozillaXR()) return true;
920
-
921
- if (debug) console.warn("CanReceiveInput:False for", evt.target);
922
- return false;
923
- }
924
-
925
- private onContextMenu = (evt: Event) => {
926
- if (this.canReceiveInput(evt) === false)
927
- return;
928
- if (evt instanceof PointerEvent) {
929
- // for longpress on touch there might open a context menu
930
- // in which case we set the pointer pressed back to false (resetting the pressed pointer)
931
- // we need to emit a pointer up event here as well
932
- if (evt.pointerType === "touch") {
933
- // for (const index in this._pointerPressed) {
934
- // if (this._pointerTypes[index] === PointerType.Touch) {
935
- // // this._pointerPressed[index] = false;
936
- // // this throws orbit controls?
937
- // // const ne = this.createPointerEventFromTouch("pointerup", parseInt(index), this._pointerPositions[index].x, this._pointerPositions[index].y, 0, evt);
938
- // // this.onUp(ne);
939
- // }
940
- // }
941
- }
942
- }
943
- }
944
-
945
- private keysPressed: { [key: KeyCode | string]: { pressed: boolean, frame: number, startFrame: number, key: string, code: KeyCode | string } } = {};
946
-
947
- private onKeyDown = (evt: KeyboardEvent) => {
948
- if (debug) console.log(`key down ${evt.code}, ${this.context.application.hasFocus}`, evt);
949
- if (!this.context.application.hasFocus)
950
- return;
951
- const ex = this.keysPressed[evt.code];
952
- if (ex && ex.pressed) return;
953
- this.keysPressed[evt.code] = { pressed: true, frame: this.context.time.frameCount + 1, startFrame: this.context.time.frameCount + 1, key: evt.key, code: evt.code };
954
- const ne = new NEKeyboardEvent(InputEvents.KeyDown, evt, evt);
955
- this.onDispatchEvent(ne);
956
- }
957
- private onKeyPressed = (evt: KeyboardEvent) => {
958
- if (!this.context.application.hasFocus)
959
- return;
960
- const p = this.keysPressed[evt.code];
961
- if (!p) return;
962
- p.pressed = true;
963
- p.frame = this.context.time.frameCount + 1;
964
- const ne = new NEKeyboardEvent(InputEvents.KeyPressed, evt, evt);
965
- this.onDispatchEvent(ne);
966
-
967
- }
968
- private onKeyUp = (evt: KeyboardEvent) => {
969
- if (!this.context.application.hasFocus)
970
- return;
971
- const p = this.keysPressed[evt.code];
972
- if (!p) return;
973
- p.pressed = false;
974
- p.frame = this.context.time.frameCount + 1;
975
- const ne = new NEKeyboardEvent(InputEvents.KeyUp, evt, evt);
976
- this.onDispatchEvent(ne);
977
- }
978
-
979
- private onWheelWindow = (evt: WheelEvent) => {
980
- // check if we are in pointer lock mode
981
- if (document.pointerLockElement) {
982
- // only if yes we want to use the mouse wheel as a pointer event
983
- this.onMouseWheel(evt);
984
- }
985
- };
986
- private onMouseWheel = (evt: WheelEvent) => {
987
- if (this.canReceiveInput(evt) === false) return;
988
- if (this._mouseWheelDeltaY.length <= 0) this._mouseWheelDeltaY.push(0);
989
- if (this._mouseWheelChanged.length <= 0) this._mouseWheelChanged.push(false);
990
- this._mouseWheelChanged[0] = true;
991
- const current = this._mouseWheelDeltaY[0];
992
- this._mouseWheelDeltaY[0] = current + evt.deltaY;
993
- }
994
- private onPointerDown = (evt: PointerEvent) => {
995
- if (this.context.isInAR) return;
996
- if (this.canReceiveInput(evt) === false) return;
997
- if (evt.target instanceof HTMLElement) {
998
- evt.target.setPointerCapture(evt.pointerId);
999
- }
1000
- const id = this.getPointerId(evt);
1001
- if (debug) showBalloonMessage(`pointer down #${id}, identifier:${evt.pointerId}`);
1002
- const space = this.getAndUpdateSpatialObjectForScreenPosition(id, evt.clientX, evt.clientY);
1003
- const ne = new NEPointerEvent(InputEvents.PointerDown, evt, { origin: this, mode: "screen", deviceIndex: 0, pointerId: id, button: evt.button, clientX: evt.clientX, clientY: evt.clientY, pointerType: evt.pointerType as PointerTypeNames, buttonName: this.getButtonName(evt), device: space, pressure: evt.pressure });
1004
- this.onDown(ne);
1005
- }
1006
- private onPointerMove = (evt: PointerEvent) => {
1007
- if (this.context.isInAR) return;
1008
-
1009
- // Prevent multiple pointerMove events per frame
1010
- if (this._receivedPointerMoveEventsThisFrame.includes(evt.pointerId)) return;
1011
- this._receivedPointerMoveEventsThisFrame.push(evt.pointerId);
1012
-
1013
- // We want to keep receiving move events until pointerUp and not stop handling events just because we're hovering over *some* HTML element
1014
- // if (this.canReceiveInput(evt) === false) return;
1015
-
1016
- let button = evt.button;
1017
- if (evt.pointerType === "mouse") {
1018
- const pressedButton = this.getFirstPressedButtonForPointer(0);
1019
- button = pressedButton ?? 0;
1020
- }
1021
- const id = this.getPointerId(evt, button);
1022
- if (button === -1) {
1023
- button = id;
1024
- }
1025
- const space = this.getAndUpdateSpatialObjectForScreenPosition(id, evt.clientX, evt.clientY);
1026
- const ne = new NEPointerEvent(InputEvents.PointerMove, evt, { origin: this, mode: "screen", deviceIndex: 0, pointerId: id, button: button, clientX: evt.clientX, clientY: evt.clientY, pointerType: evt.pointerType as PointerTypeNames, buttonName: this.getButtonName(evt), device: space, pressure: evt.pressure });
1027
- this.onMove(ne);
1028
- }
1029
- private onPointerCancel = (evt: PointerEvent) => {
1030
- if (this.context.isInAR) return;
1031
- if (debug) console.log("Pointer cancel", evt);
1032
- // we treat this as an up event for now to make sure we don't have any pointers stuck in a pressed state etc. Technically we dont want to invoke a up event for cancels...
1033
- this.onPointerUp(evt);
1034
- }
1035
- private onPointerUp = (evt: PointerEvent) => {
1036
- if (this.context.isInAR) return;
1037
- if (evt.target instanceof HTMLElement) {
1038
- evt.target.releasePointerCapture(evt.pointerId);
1039
- }
1040
- // the pointer up event should always be handled
1041
- // if (this.canReceiveInput(evt) === false) return;
1042
- const id = this.getPointerId(evt);
1043
- // if (!this.isNewEvent(evt.timeStamp, id, this._pointerUpTimestamp)) return;
1044
- const ne = new NEPointerEvent(InputEvents.PointerUp, evt, { origin: this, mode: "screen", deviceIndex: 0, pointerId: id, button: evt.button, clientX: evt.clientX, clientY: evt.clientY, pointerType: evt.pointerType as PointerTypeNames, buttonName: this.getButtonName(evt), device: this.getAndUpdateSpatialObjectForScreenPosition(id, evt.clientX, evt.clientY), pressure: evt.pressure });
1045
- this.onUp(ne);
1046
- this._pointerIds[id] = -1;
1047
- if (debug) console.log("ID=" + id, "PointerId=" + evt.pointerId, "ALL:", [...this._pointerIds]);
1048
- }
1049
-
1050
- private getPointerId(evt: PointerEvent, button?: number): number {
1051
- if (evt.pointerType === "mouse") return 0 + (button ?? evt.button);
1052
- return this.getPointerIndex(evt.pointerId);
1053
- }
1054
- private getButtonName(evt: PointerEvent): MouseButtonName | "unknown" {
1055
- const button = evt.button;
1056
- if (evt.pointerType === "mouse") {
1057
- switch (button) {
1058
- case 0: return "left";
1059
- case 1: return "middle";
1060
- case 2: return "right";
1061
- }
1062
- }
1063
- return "unknown";
1064
- }
1065
-
1066
- // the touch events are currently only used for AR support on android
1067
- private onTouchStart = (evt: TouchEvent) => {
1068
- if (!this.context.isInAR) return;
1069
- for (let i = 0; i < evt.changedTouches.length; i++) {
1070
- const touch = evt.changedTouches[i];
1071
- const id = this.getPointerIndex(touch.identifier);
1072
- const space = this.getAndUpdateSpatialObjectForScreenPosition(id, touch.clientX, touch.clientY);
1073
- const ne = new NEPointerEvent(InputEvents.PointerDown, evt, { origin: this, mode: "screen", deviceIndex: 0, pointerId: id, button: 0, clientX: touch.clientX, clientY: touch.clientY, pointerType: "touch", buttonName: "unknown", device: space, pressure: touch.force });
1074
- this.onDown(ne);
1075
- };
1076
- };
1077
- private onTouchMove = (evt: TouchEvent) => {
1078
- if (!this.context.isInAR) return;
1079
- for (let i = 0; i < evt.changedTouches.length; i++) {
1080
- const touch = evt.changedTouches[i];
1081
- const id = this.getPointerIndex(touch.identifier);
1082
- const space = this.getAndUpdateSpatialObjectForScreenPosition(id, touch.clientX, touch.clientY);
1083
- const ne = new NEPointerEvent(InputEvents.PointerMove, evt, { origin: this, mode: "screen", deviceIndex: 0, pointerId: id, button: 0, clientX: touch.clientX, clientY: touch.clientY, pointerType: "touch", buttonName: "unknown", device: space, pressure: touch.force });
1084
- this.onMove(ne);
1085
- };
1086
- }
1087
- private onTouchEnd = (evt: TouchEvent) => {
1088
- if (!this.context.isInAR) return;
1089
- for (let i = 0; i < evt.changedTouches.length; i++) {
1090
- const touch = evt.changedTouches[i];
1091
- const id = this.getPointerIndex(touch.identifier);
1092
- const ne = new NEPointerEvent(InputEvents.PointerUp, evt, { origin: this, mode: "screen", deviceIndex: 0, pointerId: id, button: 0, clientX: touch.clientX, clientY: touch.clientY, pointerType: "touch", buttonName: "unknown", device: this.getAndUpdateSpatialObjectForScreenPosition(id, touch.clientX, touch.clientY), pressure: touch.force });
1093
- this.onUp(ne);
1094
- this._pointerIds[id] = -1;
1095
- };
1096
- }
1097
-
1098
- private readonly tempNearPlaneVector = new Vector3();
1099
- private readonly tempFarPlaneVector = new Vector3();
1100
- private readonly tempLookMatrix = new Matrix4();
1101
- private getAndUpdateSpatialObjectForScreenPosition(id: number, screenX: number, screenY: number): IGameObject {
1102
- let space = this._pointerSpace[id]
1103
- if (!space) {
1104
- space = new Object3D() as unknown as IGameObject;
1105
- this._pointerSpace[id] = space;
1106
- }
1107
- this._pointerSpace[id] = space;
1108
- const camera = this.context.mainCamera;
1109
- if (camera) {
1110
- const pointOnNearPlane = this.tempNearPlaneVector.set(screenX, screenY, -1);
1111
- this.convertScreenspaceToRaycastSpace(pointOnNearPlane);
1112
- const pointOnFarPlane = this.tempFarPlaneVector.set(pointOnNearPlane.x, pointOnNearPlane.y, 1);
1113
- pointOnNearPlane.unproject(camera);
1114
- pointOnFarPlane.unproject(camera);
1115
- const worldUp = (camera as any as IGameObject).worldUp || getTempVector(0, 1, 0).applyQuaternion(getWorldQuaternion(camera))
1116
- this.tempLookMatrix.lookAt(pointOnFarPlane, pointOnNearPlane, worldUp);
1117
- space.position.set(pointOnNearPlane.x, pointOnNearPlane.y, pointOnNearPlane.z);
1118
- space.quaternion.setFromRotationMatrix(this.tempLookMatrix);
1119
- }
1120
- return space;
1121
- }
1122
-
1123
- // Prevent the same event being handled twice (e.g. on touch we get a mouseUp and touchUp evt with the same timestamp)
1124
- // private isNewEvent(timestamp: number, index: number, arr: number[]): boolean {
1125
- // while (arr.length <= index) arr.push(-1);
1126
- // if (timestamp === arr[index]) return false;
1127
- // arr[index] = timestamp;
1128
- // return true;
1129
- // }
1130
-
1131
- private isInRect(e: { clientX: number, clientY: number }): boolean {
1132
- if (this.context.isInXR) return true;
1133
- const rect = this.context.domElement.getBoundingClientRect();
1134
- const px = e.clientX;
1135
- const py = e.clientY;
1136
- const isInRect = px >= rect.x && px <= rect.right && py >= rect.y && py <= rect.bottom;
1137
- if (debug && !isInRect) console.log("Not in rect", rect, px, py);
1138
- return isInRect;
1139
-
1140
- }
1141
-
1142
- private onDown(evt: NEPointerEvent) {
1143
- const index = evt.pointerId;
1144
- if (this.getPointerPressed(index)) {
1145
- console.warn(`Received pointerDown for pointerId that is already pressed: ${index}`, debug ? evt : '');
1146
- }
1147
- if (debug) console.log(evt.pointerType, "DOWN", index);
1148
- if (!this.isInRect(evt)) return;
1149
- // if (this.isMouseEventFromTouch(evt)) return;
1150
-
1151
- this.setPointerState(index, this._pointerPressed, true);
1152
- this.setPointerState(index, this._pointerDown, true);
1153
- this.setPointerStateT(index, this._pointerEvent, evt.source);
1154
-
1155
- while (index >= this._pointerTypes.length) this._pointerTypes.push(evt.pointerType);
1156
- this._pointerTypes[index] = evt.pointerType;
1157
-
1158
- while (index >= this._pointerPositionDown.length) this._pointerPositionDown.push(new Vector3());
1159
- this._pointerPositionDown[index].set(evt.clientX, evt.clientY, evt.clientZ ?? 0);
1160
- while (index >= this._pointerPositions.length) this._pointerPositions.push(new Vector2());
1161
- this._pointerPositions[index].set(evt.clientX, evt.clientY);
1162
-
1163
- if (index >= this._pointerDownTime.length) this._pointerDownTime.push(0);
1164
- this._pointerDownTime[index] = this.context.time.realtimeSinceStartup;
1165
-
1166
- this.updatePointerPosition(evt);
1167
-
1168
- this._pointerEventsPressed.push(evt);
1169
- this.onDispatchEvent(evt);
1170
- }
1171
- // moveEvent?: Event;
1172
- private onMove(evt: NEPointerEvent) {
1173
- const index = evt.pointerId;
1174
-
1175
- const isDown = this.getPointerPressed(index);
1176
- if (isDown === false && !this.isInRect(evt)) return;
1177
- if (evt.pointerType === PointerType.Touch && !isDown) return;
1178
- // if (this.isMouseEventFromTouch(evt)) return;
1179
- // if (debug) console.log(evt.pointerType, "MOVE", index, "hasSpace=" + evt.space != null);
1180
-
1181
- this.updatePointerPosition(evt);
1182
- this.setPointerStateT(index, this._pointerEvent, evt.source);
1183
- this.onDispatchEvent(evt);
1184
- }
1185
- private onUp(evt: NEPointerEvent) {
1186
- const index = evt.pointerId;
1187
- const wasDown = this.getPointerPressed(index);
1188
- if (!wasDown) {
1189
- if (debug) console.log(evt.pointerType, "UP", index, "was not down");
1190
- return;
1191
- }
1192
- // if (this.isMouseEventFromTouch(evt)) return;
1193
- if (debug) console.log(evt.pointerType, "UP", index);
1194
-
1195
- this.setPointerState(index, this._pointerPressed, false);
1196
- this.setPointerStateT(index, this._pointerEvent, evt.source);
1197
- this.setPointerState(index, this._pointerUp, true);
1198
-
1199
- this.updatePointerPosition(evt);
1200
-
1201
- for (let i = this._pointerEventsPressed.length - 1; i >= 0; i--) {
1202
- const ptr = this._pointerEventsPressed[i];
1203
- if (ptr.pointerId === index) {
1204
- this._pointerEventsPressed.splice(i, 1);
1205
- break;
1206
- }
1207
- }
1208
-
1209
- if (!this._pointerPositionDown[index]) {
1210
- if (debug) showBalloonWarning("Received pointer up event without matching down event for button: " + index);
1211
- console.warn("Received pointer up event without matching down event for button: " + index)
1212
- return;
1213
- }
1214
-
1215
-
1216
- const lastUpTime = this._pointerUpTime[index];
1217
- const downTime = this._pointerDownTime[index];
1218
- const upTime = this.context.time.realtimeSinceStartup;
1219
- const dt = upTime - downTime;
1220
- if (index >= this._pointerUpTime.length) this._pointerUpTime.push(-99);
1221
- this._pointerUpTime[index] = upTime;
1222
-
1223
- // If the time from down to up is less than 1 second check if it was a click
1224
- if (dt < 1) {
1225
- let dx = evt.clientX - this._pointerPositionDown[index].x;
1226
- let dy = evt.clientY - this._pointerPositionDown[index].y;
1227
- let dz = 0;
1228
- if (evt.isSpatial && evt.clientZ != undefined) {
1229
- dz = evt.clientZ - this._pointerPositionDown[index].z;
1230
- // spatial clicks remapping
1231
- dx *= 200;
1232
- dy *= 200;
1233
- dz *= 200;
1234
- }
1235
-
1236
- if (Math.abs(dx) < 5 && Math.abs(dy) < 5 && Math.abs(dz) < 5) {
1237
- this.setPointerState(index, this._pointerClick, true);
1238
- evt.isClick = true;
1239
-
1240
- // handle double click
1241
- const dt = upTime - lastUpTime;
1242
- if (debug) console.log("CLICK", index, dx, dy, dz, dt)
1243
- if (dt < this._doubleClickTimeThreshold && dt > 0) {
1244
- this.setPointerState(index, this._pointerDoubleClick, true);
1245
- evt.isDoubleClick = true;
1246
- }
1247
- }
1248
- }
1249
-
1250
-
1251
- this.onDispatchEvent(evt);
1252
- }
1253
-
1254
- private updatePointerPosition(evt: NEPointerEvent) {
1255
- const index = evt.pointerId;
1256
-
1257
- while (index >= this._pointerPositions.length) this._pointerPositions.push(new Vector2());
1258
- while (index >= this._pointerPositionsLastFrame.length) this._pointerPositionsLastFrame.push(new Vector2());
1259
- while (index >= this._pointerPositionsDelta.length) this._pointerPositionsDelta.push(new Vector2());
1260
-
1261
- const lf = this._pointerPositionsLastFrame[index];
1262
- lf.copy(this._pointerPositions[index]);
1263
- // accumulate delta (it's reset in end of frame), if we just write it here it's not correct when the browser console is open
1264
- const delta = this._pointerPositionsDelta[index];
1265
- let dx = evt.clientX - lf.x;
1266
- let dy = evt.clientY - lf.y;
1267
- // if pointer is locked, clientX and Y are not changed, but Movement is.
1268
- if (evt.source instanceof MouseEvent || evt.source instanceof TouchEvent) {
1269
- const source = evt.source as PointerEvent;
1270
- if (dx === 0 && source.movementX !== 0)
1271
- dx = source.movementX || 0;
1272
- if (dy === 0 && source.movementY !== 0)
1273
- dy = source.movementY || 0;
1274
- }
1275
- delta.x += dx;
1276
- delta.y += dy;
1277
-
1278
- this._pointerPositions[index].x = evt.clientX;
1279
- this._pointerPositions[index].y = evt.clientY;
1280
-
1281
- // we want to have the position 01 on the canvas for raycasting
1282
- const px = evt.clientX;
1283
- const py = evt.clientY;
1284
- while (index >= this._pointerPositionsRC.length) this._pointerPositionsRC.push(new Vector2());
1285
- const rc = this._pointerPositionsRC[index];
1286
- rc.set(px, py);
1287
- this.convertScreenspaceToRaycastSpace(rc);
1288
- // console.log(this.context.alias, rc);
1289
- // this._pointerPositionsRC[evt.button].x = (px - this.context.domX) / this.context.domWidth * 2 - 1;
1290
- // this._pointerPositionsRC[evt.button].y = -((py - this.context.domY) / this.context.domHeight) * 2 + 1;
1291
- // console.log(evt.button)
1292
- }
1293
-
1294
- /** get the next free id */
1295
- private getPointerIndex(pointerId: number) {
1296
- // test if theres a pointer with the id
1297
- let firstFreeIndex = -1;
1298
- for (let i = 0; i < this._pointerIds.length; i++) {
1299
- if (this._pointerIds[i] === pointerId) return i;
1300
- else if (firstFreeIndex === -1 && this._pointerIds[i] === -1) {
1301
- firstFreeIndex = i;
1302
- }
1303
- }
1304
- // if not take the free slot if any
1305
- if (firstFreeIndex !== -1) {
1306
- this._pointerIds[firstFreeIndex] = pointerId;
1307
- return firstFreeIndex;
1308
- }
1309
- if (debug) console.log("PUSH pointerId:", pointerId)
1310
- this._pointerIds.push(pointerId);
1311
- return this._pointerIds.length - 1;
1312
- }
1313
-
1314
- private setPointerState(index: number, arr: boolean[], value: boolean) {
1315
- arr[index] = value;
1316
- }
1317
-
1318
- private setPointerStateT<T>(index: number, arr: T[], value: T) {
1319
- // while (arr.length <= index) arr.push(null as any);
1320
- arr[index] = value;
1321
- return value;
1322
- }
1323
-
1324
- private onDispatchEvent(evt: NEPointerEvent | NEKeyboardEvent) {
1325
- const prevContext = Context.Current;
1326
- try {
1327
- Context.Current = this.context;
1328
- this.dispatchEvent(evt);
1329
- }
1330
- finally {
1331
- Context.Current = prevContext;
1332
- }
1333
- }
1334
- }
1335
-
1336
- export declare type KeyCode =
1337
- | "Tab"
1338
- | "Enter"
1339
- | "ShiftLeft"
1340
- | "ShiftRight"
1341
- | "ControlLeft"
1342
- | "ControlRight"
1343
- | "AltLeft"
1344
- | "AltRight"
1345
- | "Pause"
1346
- | "CapsLock"
1347
- | "Escape"
1348
- | "Space"
1349
- | "PageUp"
1350
- | "PageDown"
1351
- | "End"
1352
- | "Home"
1353
- | "ArrowLeft"
1354
- | "ArrowUp"
1355
- | "ArrowRight"
1356
- | "ArrowDown"
1357
- | "Insert"
1358
- | "Delete"
1359
- | "Digit0"
1360
- | "Digit1"
1361
- | "Digit2"
1362
- | "Digit3"
1363
- | "Digit4"
1364
- | "Digit5"
1365
- | "Digit6"
1366
- | "Digit7"
1367
- | "Digit8"
1368
- | "Digit9"
1369
- | "KeyA"
1370
- | "KeyB"
1371
- | "KeyC"
1372
- | "KeyD"
1373
- | "KeyE"
1374
- | "KeyF"
1375
- | "KeyG"
1376
- | "KeyH"
1377
- | "KeyI"
1378
- | "KeyJ"
1379
- | "KeyK"
1380
- | "KeyL"
1381
- | "KeyM"
1382
- | "KeyN"
1383
- | "KeyO"
1384
- | "KeyP"
1385
- | "KeyQ"
1386
- | "KeyR"
1387
- | "KeyS"
1388
- | "KeyT"
1389
- | "KeyU"
1390
- | "KeyV"
1391
- | "KeyW"
1392
- | "KeyX"
1393
- | "KeyY"
1394
- | "KeyZ"
1395
- | "Select"
1396
- | "Numpad0"
1397
- | "Numpad1"
1398
- | "Numpad2"
1399
- | "Numpad3"
1400
- | "Numpad4"
1401
- | "Numpad5"
1402
- | "Numpad6"
1403
- | "Numpad7"
1404
- | "Numpad8"
1405
- | "Numpad9"
1406
- | "Multiply"
1407
- | "Add"
1408
- | "Subtract"
1409
- | "Decimal"
1410
- | "Divide"
1411
- | "F1"
1412
- | "F2"
1413
- | "F3"
1414
- | "F4"
1415
- | "F5"
1416
- | "F6"
1417
- | "F7"
1418
- | "F8"
1419
- | "F9"
1420
- | "F10"
1421
- | "F11"
1422
- | "F12";
1423
-
1424
- // KEY_1 = 49,
1425
- // KEY_2 = 50,
1426
- // KEY_3 = 51,
1427
- // KEY_4 = 52,
1428
- // KEY_5 = 53,
1429
- // KEY_6 = 54,
1430
- // KEY_7 = 55,
1431
- // KEY_8 = 56,
1432
- // KEY_9 = 57,
1433
- // KEY_A = 65,
1434
- // KEY_B = 66,
1435
- // KEY_C = 67,
1436
- // KEY_D = "d",
1437
- // KEY_E = 69,
1438
- // KEY_F = 70,
1439
- // KEY_G = 71,
1440
- // KEY_H = 72,
1441
- // KEY_I = 73,
1442
- // KEY_J = 74,
1443
- // KEY_K = 75,
1444
- // KEY_L = 76,
1445
- // KEY_M = 77,
1446
- // KEY_N = 78,
1447
- // KEY_O = 79,
1448
- // KEY_P = 80,
1449
- // KEY_Q = 81,
1450
- // KEY_R = 82,
1451
- // KEY_S = 83,
1452
- // KEY_T = 84,
1453
- // KEY_U = 85,
1454
- // KEY_V = 86,
1455
- // KEY_W = 87,
1456
- // KEY_X = 88,
1457
- // KEY_Y = 89,
1458
- // KEY_Z = 90,
1459
- // LEFT_META = 91,
1460
- // RIGHT_META = 92,
1461
- // SELECT = 93,
1462
- // NUMPAD_0 = 96,
1463
- // NUMPAD_1 = 97,
1464
- // NUMPAD_2 = 98,
1465
- // NUMPAD_3 = 99,
1466
- // NUMPAD_4 = 100,
1467
- // NUMPAD_5 = 101,
1468
- // NUMPAD_6 = 102,
1469
- // NUMPAD_7 = 103,
1470
- // NUMPAD_8 = 104,
1471
- // NUMPAD_9 = 105,
1472
- // MULTIPLY = 106,
1473
- // ADD = 107,
1474
- // SUBTRACT = 109,
1475
- // DECIMAL = 110,
1476
- // DIVIDE = 111,
1477
- // F1 = 112,
1478
- // F2 = 113,
1479
- // F3 = 114,
1480
- // F4 = 115,
1481
- // F5 = 116,
1482
- // F6 = 117,
1483
- // F7 = 118,
1484
- // F8 = 119,
1485
- // F9 = 120,
1486
- // F10 = 121,
1487
- // F11 = 122,
1488
- // F12 = 123,
1489
- // NUM_LOCK = 144,
1490
- // SCROLL_LOCK = 145,
1491
- // SEMICOLON = 186,
1492
- // EQUALS = 187,
1493
- // COMMA = 188,
1494
- // DASH = 189,
1495
- // PERIOD = 190,
1496
- // FORWARD_SLASH = 191,
1497
- // GRAVE_ACCENT = 192,
1498
- // OPEN_BRACKET = 219,
1499
- // BACK_SLASH = 220,
1500
- // CLOSE_BRACKET = 221,
1
+ import { Intersection, Matrix4, Object3D, Ray, Vector2, Vector3 } from 'three';
2
+
3
+ import { showBalloonMessage, showBalloonWarning } from './debug/debug.js';
4
+ import { Context } from './engine_setup.js';
5
+ import { getTempVector, getWorldQuaternion } from './engine_three_utils.js';
6
+ import type { ButtonName, CursorTypeName, IGameObject, IInput, MouseButtonName, Vec2 } from './engine_types.js';
7
+ import { DeviceUtilities, type EnumToPrimitiveUnion, getParam } from './engine_utils.js';
8
+
9
+ const debug = getParam("debuginput");
10
+
11
+
12
+ export const enum PointerType {
13
+ Mouse = "mouse",
14
+ Touch = "touch",
15
+ Controller = "controller",
16
+ Hand = "hand"
17
+ }
18
+ export type PointerTypeNames = EnumToPrimitiveUnion<PointerType>;
19
+
20
+ const enum PointerEnumType {
21
+ PointerDown = "pointerdown",
22
+ PointerUp = "pointerup",
23
+ PointerMove = "pointermove",
24
+ }
25
+ const enum KeyboardEnumType {
26
+ KeyDown = "keydown",
27
+ KeyUp = "keyup",
28
+ KeyPressed = "keypress"
29
+ }
30
+
31
+ export const enum InputEvents {
32
+ PointerDown = "pointerdown",
33
+ PointerUp = "pointerup",
34
+ PointerMove = "pointermove",
35
+ KeyDown = "keydown",
36
+ KeyUp = "keyup",
37
+ KeyPressed = "keypress"
38
+ }
39
+
40
+ /** e.g. `pointerdown` */
41
+ type PointerEventNames = EnumToPrimitiveUnion<PointerEnumType>;
42
+ type KeyboardEventNames = EnumToPrimitiveUnion<KeyboardEnumType>;
43
+ export type InputEventNames = PointerEventNames | KeyboardEventNames;
44
+
45
+ declare type PointerEventListener = (evt: NEPointerEvent) => void;
46
+ declare type KeyboardEventListener = (evt: NEKeyboardEvent) => void;
47
+ declare type InputEventListener = PointerEventListener | KeyboardEventListener;
48
+
49
+
50
+
51
+ export declare type NEPointerEventInit = PointerEventInit &
52
+ {
53
+ clientZ?: number;
54
+ origin: object;
55
+ pointerId: number;
56
+ /** the index of the device */
57
+ deviceIndex: number;
58
+ pointerType: PointerTypeNames;
59
+ mode: XRTargetRayMode,
60
+ ray?: Ray;
61
+ /** The control object for this input. In the case of spatial devices the controller,
62
+ * otherwise a generated object in screen space. The object may not be in the scene. */
63
+ device: IGameObject;
64
+ buttonName: ButtonName | "none";
65
+ }
66
+
67
+ declare type OnPointerHitsEvent = (args: OnPointerHitEvent) => void;
68
+ declare type OnPointerHitEvent = {
69
+ /** The object that raised the event */
70
+ sender: object;
71
+ /** The pointer event that invoked the event */
72
+ event: NEPointerEvent;
73
+ /** The intersections that were generated from this event (or are associated with this event in any way) */
74
+ hits: Intersection[];
75
+ }
76
+ export interface IPointerHitEventReceiver {
77
+ onPointerHits: OnPointerHitsEvent;
78
+ }
79
+
80
+ /** An intersection that is potentially associated with a pointer event */
81
+ export declare type NEPointerEventIntersection = Intersection & { event?: NEPointerEvent };
82
+
83
+ /**
84
+ * The Needle Engine Pointer Event is a custom event that extends the PointerEvent. It holds additional information like the device index, the origin of the event, the mode of the event (e.g. screen or spatial), the ray in world space, the space of the device, and more.
85
+ */
86
+ export class NEPointerEvent extends PointerEvent {
87
+
88
+ /**
89
+ * Spatial input data
90
+ */
91
+ clientZ?: number;
92
+
93
+ /** the device index: mouse and touch are always 0, otherwise e.g. index of the connected Gamepad or XRController */
94
+ readonly deviceIndex: number;
95
+
96
+ /** The origin of the event contains a reference to the creator of this event.
97
+ * This can be the Needle Engine input system or e.g. a XR controller.
98
+ * Implement `onPointerHits` to receive the intersections of this event.
99
+ */
100
+ readonly origin: object & Partial<IPointerHitEventReceiver>;
101
+
102
+ /** the browser event that triggered this event (if any) */
103
+ readonly source: Event | null;
104
+
105
+ /** Is the pointer event created via a touch on screen or a spatial device like a XR controller or hand tracking? */
106
+ readonly mode: XRTargetRayMode | "transient-pointer";
107
+
108
+ /** Returns true if the input was emitted in 3D space (and not by e.g. clicking on a 2D screen). You can use {@link mode} if you need more information about the input source */
109
+ get isSpatial() {
110
+ return this.mode != "screen";
111
+ }
112
+
113
+ /** A ray in worldspace for the event.
114
+ * If the ray is undefined you can also use `space.worldForward` and `space.worldPosition` */
115
+ get ray(): Ray {
116
+ if (!this._ray) {
117
+ this._ray = new Ray(this.space.worldPosition.clone(), this.space.worldForward.clone());
118
+ }
119
+ return this._ray;
120
+ }
121
+ private set ray(value: Ray) { this._ray = value; }
122
+ /**@returns true if this event has a ray. If you access the ray property a ray will automatically created */
123
+ get hasRay() { return this._ray !== undefined; }
124
+ private _ray: Ray | undefined;
125
+
126
+ /** The device space (this object is not necessarily rendered in the scene but you can access or copy the matrix)
127
+ * E.g. you can access the input world space source position with `space.worldPosition` or world direction with `space.worldForward`
128
+ */
129
+ readonly space: IGameObject;
130
+
131
+ /** true if this event is a click */
132
+ isClick: boolean = false;
133
+ /** true if this event is a double click */
134
+ isDoubleClick: boolean = false;
135
+
136
+ /** @returns `true` if the event is marked to be used (when `use()` has been called). Default: `false` */
137
+ get used() { return this._used; }
138
+ private _used: boolean = false;
139
+ /** Call to mark an event to be used */
140
+ use() {
141
+ this._used = true;
142
+ }
143
+
144
+ /** Unique identifier for this input: a combination of the deviceIndex + button to uniquely identify the exact input (e.g. LeftController:Button0 = 0, RightController:Button1 = 11) */
145
+ override get pointerId(): number { return this._pointerid; }
146
+ private readonly _pointerid;
147
+
148
+ // this is set via the init arguments (we override it here for intellisense to show the string options)
149
+ /** What type of input created this event: touch, mouse, xr controller, xr hand tracking... */
150
+ override get pointerType(): PointerTypeNames { return this._pointerType; }
151
+ private readonly _pointerType: PointerTypeNames;
152
+
153
+ // this is set via the init arguments (we override it here for intellisense to show the string options)
154
+ /** The input that raised this event like `pointerdown` */
155
+ override get type(): InputEventNames { return this._type; }
156
+ private readonly _type: InputEventNames;
157
+
158
+ /** metadata can be used to associate additional information with the event */
159
+ readonly metadata = {}
160
+
161
+ /** intersections that were generated from this event (or are associated with this event in any way) */
162
+ readonly intersections = new Array<NEPointerEventIntersection>();
163
+
164
+ constructor(type: InputEvents | InputEventNames, source: Event | null, init: NEPointerEventInit) {
165
+ super(type, init);
166
+ this.clientZ = init.clientZ;
167
+ // apply the init arguments. Otherwise the arguments will be undefined in the bundled / published version of needle engine
168
+ // so we have to be careful if we override properties - we then also need to set them in the constructor
169
+ this._pointerid = init.pointerId;
170
+ this._pointerType = init.pointerType;
171
+ this._type = type;
172
+
173
+ this.deviceIndex = init.deviceIndex;
174
+ this.origin = init.origin;
175
+ this.source = source;
176
+ this.mode = init.mode;
177
+ this._ray = init.ray;
178
+ this.space = init.device;
179
+ }
180
+
181
+ private _immediatePropagationStopped = false;
182
+ get immediatePropagationStopped() {
183
+ return this._immediatePropagationStopped;
184
+ }
185
+ private _propagationStopped = false;
186
+ get propagationStopped() {
187
+ return this._immediatePropagationStopped || this._propagationStopped;
188
+ }
189
+
190
+ stopImmediatePropagation(): void {
191
+ this._immediatePropagationStopped = true;
192
+ super.stopImmediatePropagation();
193
+ this.source?.stopImmediatePropagation();
194
+ }
195
+ stopPropagation(): void {
196
+ this._propagationStopped = true;
197
+ super.stopPropagation();
198
+ this.source?.stopPropagation();
199
+ if (debug) console.warn("Stop propagation...", this.pointerId, this.pointerType)
200
+ }
201
+ }
202
+ export class NEKeyboardEvent extends KeyboardEvent {
203
+ source?: Event
204
+ constructor(type: InputEvents, source: Event, init: KeyboardEventInit) {
205
+ super(type, init)
206
+ this.source = source;
207
+ }
208
+ stopImmediatePropagation(): void {
209
+ super.stopImmediatePropagation();
210
+ this.source?.stopImmediatePropagation();
211
+ }
212
+ }
213
+
214
+ export class KeyEventArgs {
215
+ key: string;
216
+ keyType: string;
217
+ source?: Event;
218
+ constructor(evt: KeyboardEvent) {
219
+ this.key = evt.key;
220
+ this.keyType = evt.type;
221
+ this.source = evt;
222
+ }
223
+ }
224
+
225
+
226
+
227
+ export enum InputEventQueue {
228
+ Early = -100,
229
+ Default = 0,
230
+ Late = 100,
231
+ }
232
+
233
+ declare type EventListenerOptions = {
234
+ /** For addEventListener: The queue to add the listener to. Listeners in the same queue are called in the order they were added. Default is 0.
235
+ * For removeEventListener: The queue to remove the listener from. If no queue is specified the listener will be removed from all queues
236
+ */
237
+ queue?: InputEventQueue | number;
238
+ /** If true, the listener will be removed after it is invoked once. */
239
+ once?: boolean;
240
+ /** The listener will be removed when the given AbortSignal object's `abort()` method is called. If not specified, no AbortSignal is associated with the listener. */
241
+ signal?: AbortSignal;
242
+ }
243
+
244
+ /**
245
+ * The input system is responsible for handling all input events like pointer events (mouse, touch, xr controllers) and keyboard events.
246
+ */
247
+ export class Input implements IInput {
248
+
249
+ /** This is a list of event listeners per event type (e.g. pointerdown, pointerup, keydown...). Each entry contains a priority and list of listeners.
250
+ * That way users can control if they want to receive events before or after other listeners (e.g subscribe to pointer events before the EventSystem receives them) - this allows certain listeners to be always invoked first (or last) and stop propagation
251
+ * Listeners per event are sorted
252
+ */
253
+ private readonly _eventListeners: { [key: string]: Array<{ priority: number, listeners: Array<{ callback: InputEventListener, options: EventListenerOptions }> }> } = {};
254
+
255
+ /** Adds an event listener for the specified event type. The callback will be called when the event is triggered.
256
+ * @param type The event type to listen for
257
+ * @param callback The callback to call when the event is triggered
258
+ * @param options The options for adding the event listener.
259
+ * @example Basic usage:
260
+ * ```ts
261
+ * input.addEventListener("pointerdown", (evt) => {
262
+ * console.log("Pointer down", evt.pointerId, evt.pointerType);
263
+ * });
264
+ * ```
265
+ * @example Adding a listener that is called after all other listeners
266
+ * By using a higher value for the queue the listener will be called after other listeners (default queue is 0).
267
+ * ```ts
268
+ * input.addEventListener("pointerdown", (evt) => {
269
+ * console.log("Pointer down", evt.pointerId, evt.pointerType);
270
+ * }, { queue: 10 });
271
+ * ```
272
+ * @example Adding a listener that is only called once
273
+ * ```ts
274
+ * input.addEventListener("pointerdown", (evt) => {
275
+ * console.log("Pointer down", evt.pointerId, evt.pointerType);
276
+ * }, { once: true });
277
+ * ```
278
+ */
279
+ addEventListener(type: PointerEventNames, callback: PointerEventListener, options?: EventListenerOptions);
280
+ addEventListener(type: KeyboardEventNames, callback: KeyboardEventListener, options?: EventListenerOptions);
281
+ addEventListener(type: InputEvents | InputEventNames, callback: InputEventListener, options?: EventListenerOptions): void {
282
+ if (!this._eventListeners[type]) this._eventListeners[type] = [];
283
+
284
+ if (!callback || typeof callback !== "function") {
285
+ console.error("Invalid call to addEventListener: callback is required and must be a function!");
286
+ return;
287
+ }
288
+
289
+ if (!options) options = {};
290
+ // create a copy of the options object to avoid the original object being modified
291
+ else options = { ...options };
292
+
293
+ let queue = 0;
294
+ if (options?.queue != undefined) queue = options.queue;
295
+
296
+ const listeners = this._eventListeners[type];
297
+ const queueListeners = listeners.find(l => l.priority === queue);
298
+ if (!queueListeners) {
299
+ listeners.push({ priority: queue, listeners: [{ callback, options }] });
300
+ // ensure we sort the listeners by priority
301
+ listeners.sort((a, b) => a.priority - b.priority);
302
+ } else {
303
+ queueListeners.listeners.push({ callback, options });
304
+ }
305
+ }
306
+ /** Removes the event listener from the specified event type. If no queue is specified the listener will be removed from all queues.
307
+ * @param type The event type to remove the listener from
308
+ * @param callback The callback to remove
309
+ * @param options The options for removing the event listener
310
+ */
311
+ removeEventListener(type: PointerEventNames, callback: PointerEventListener, options?: EventListenerOptions);
312
+ removeEventListener(type: KeyboardEventNames, callback: KeyboardEventListener, options?: EventListenerOptions);
313
+ removeEventListener(type: InputEvents | InputEventNames, callback: InputEventListener, options?: EventListenerOptions): void {
314
+ if (!this._eventListeners[type]) return;
315
+ if (!callback) return;
316
+ const listeners = this._eventListeners[type];
317
+ // if a specific queue is requested the callback should only be removed from that queue
318
+ if (options?.queue != undefined) {
319
+ const queueListeners = listeners.find(l => l.priority === options.queue);
320
+ if (!queueListeners) return;
321
+ const index = queueListeners.listeners.findIndex(l => l.callback === callback);
322
+ if (index >= 0) queueListeners.listeners.splice(index, 1);
323
+ }
324
+ // if no queue is requested the callback will be removed from all queues
325
+ else {
326
+ for (const l of listeners) {
327
+ const index = l.listeners.findIndex(l => l.callback === callback);
328
+ if (index >= 0) l.listeners.splice(index, 1);
329
+ }
330
+ }
331
+ }
332
+ private dispatchEvent(evt: NEPointerEvent | NEKeyboardEvent) {
333
+ /** True when the next event queue should not be invoked */
334
+ let preventNextEventQueue = false;
335
+
336
+ // Handle keyboard event
337
+ if (evt instanceof NEKeyboardEvent) {
338
+ const listeners = this._eventListeners[evt.type];
339
+ if (listeners) {
340
+ for (const queue of listeners) {
341
+ for (let i = 0; i < queue.listeners.length; i++) {
342
+ const entry = queue.listeners[i];
343
+ // if the abort signal is aborted we remove the listener and will not invoke it
344
+ if (entry.options?.signal?.aborted) {
345
+ queue.listeners.splice(i, 1);
346
+ i--;
347
+ continue;
348
+ }
349
+ // if the event should only be invoked once then we remove the listener before invoking it
350
+ if (entry.options.once) {
351
+ queue.listeners.splice(i, 1);
352
+ i--;
353
+ }
354
+ (entry.callback as KeyboardEventListener)(evt);
355
+ }
356
+ }
357
+ }
358
+ }
359
+
360
+ // Hnadle pointer event
361
+ if (evt instanceof NEPointerEvent) {
362
+ const listeners = this._eventListeners[evt.type];
363
+ if (listeners) {
364
+ for (const queue of listeners) {
365
+ if (preventNextEventQueue) break;
366
+ for (let i = 0; i < queue.listeners.length; i++) {
367
+ const entry = queue.listeners[i];
368
+
369
+ // if the abort signal is aborted we remove the listener and will not invoke it
370
+ if (entry.options?.signal?.aborted) {
371
+ queue.listeners.splice(i, 1);
372
+ i--;
373
+ continue;
374
+ }
375
+ // if immediatePropagationStopped is true we stop propagation altogether
376
+ if (evt.immediatePropagationStopped) {
377
+ preventNextEventQueue = true;
378
+ if (debug) console.log("immediatePropagationStopped", evt.type);
379
+ break;
380
+ }
381
+ // if propagationStopped is true we continue invoking the current queue but then not invoke the next queue
382
+ else if (evt.propagationStopped) {
383
+ preventNextEventQueue = true;
384
+ if (debug) console.log("propagationStopped", evt.type);
385
+ // we do not break here but continue invoking the listeners in the queue
386
+ }
387
+
388
+ // if the event should only be invoked once then we remove the listener before invoking it
389
+ if (entry.options.once) {
390
+ queue.listeners.splice(i, 1);
391
+ i--;
392
+ }
393
+ (entry.callback as PointerEventListener)(evt);
394
+ }
395
+ }
396
+ }
397
+ }
398
+ }
399
+
400
+
401
+ _doubleClickTimeThreshold = .2;
402
+ _longPressTimeThreshold = 1;
403
+
404
+ get mousePosition(): Vector2 { return this._pointerPositions[0]; };
405
+ get mousePositionRC(): Vector2 { return this._pointerPositionsRC[0]; }
406
+ get mouseDown(): boolean { return this._pointerDown[0]; }
407
+ get mouseUp(): boolean { return this._pointerUp[0]; }
408
+ /** Is the primary pointer clicked (usually the left button). This is equivalent to `input.click` */
409
+ get mouseClick(): boolean { return this._pointerClick[0]; }
410
+ /** Was a double click detected for the primary pointer? This is equivalent to `input.doubleClick` */
411
+ get mouseDoubleClick(): boolean { return this._pointerDoubleClick[0]; }
412
+ get mousePressed(): boolean { return this._pointerPressed[0]; }
413
+ get mouseWheelChanged(): boolean { return this.getMouseWheelChanged(0); }
414
+
415
+ /** Is the primary pointer double clicked (usually the left button). This is equivalent to `input.mouseDoubleClick` */
416
+ get click(): boolean { return this._pointerClick[0]; }
417
+ /** Was a double click detected for the primary pointer? */
418
+ get doubleClick(): boolean { return this._pointerDoubleClick[0]; }
419
+
420
+ /**
421
+ * Get a connected Gamepad
422
+ * Note: For a gamepad to be available to the browser it must have received input before while the page was focused.
423
+ * @link https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
424
+ * @returns The gamepad or null if no gamepad is connected
425
+ */
426
+ getGamepad(index: number = 0): Gamepad | null {
427
+ if (typeof navigator !== "undefined" && "getGamepads" in navigator) {
428
+ return navigator.getGamepads()[index] || null;
429
+ }
430
+ return null;
431
+ }
432
+
433
+ private readonly _setCursorTypes: CursorTypeName[] = [];
434
+
435
+ /** @deprecated use setCursor("pointer") */
436
+ setCursorPointer() {
437
+ this.setCursor("pointer");
438
+ }
439
+ /** @deprecated use unsetCursor() */
440
+ setCursorNormal() {
441
+ this.unsetCursor("pointer");
442
+ }
443
+ /**
444
+ * Set a custom cursor. This will set the cursor type until unsetCursor is called
445
+ */
446
+ setCursor(type: CursorTypeName) {
447
+ this._setCursorTypes.push(type);
448
+ if (this._setCursorTypes.length > 10) {
449
+ this._setCursorTypes.shift();
450
+ }
451
+ this.updateCursor();
452
+ }
453
+ /**
454
+ * Unset a custom cursor. This will set the cursor type to the previous type or default
455
+ */
456
+ unsetCursor(type: CursorTypeName) {
457
+ for (let i = this._setCursorTypes.length - 1; i >= 0; i--) {
458
+ if (this._setCursorTypes[i] === type) {
459
+ this._setCursorTypes.splice(i, 1);
460
+ this.updateCursor();
461
+ break;
462
+ }
463
+ }
464
+ }
465
+ private updateCursor() {
466
+ if (this._setCursorTypes?.length == 0)
467
+ this.context.domElement.style.cursor = "default";
468
+ else this.context.domElement.style.cursor = this._setCursorTypes[this._setCursorTypes.length - 1];
469
+ }
470
+
471
+ /**
472
+ * Check if a pointer id is currently used.
473
+ */
474
+ getIsPointerIdInUse(pointerId: number) {
475
+ for (const evt of this._pointerEventsPressed) {
476
+ if (evt.pointerId === pointerId) {
477
+ if (evt.used) return true;
478
+ }
479
+ }
480
+ return false;
481
+ }
482
+ /** how many pointers are currently pressed */
483
+ getPointerPressedCount(): number {
484
+ let count = 0;
485
+ for (let i = 0; i < this._pointerPressed.length; i++) {
486
+ if (this._pointerPressed[i]) {
487
+ count++;
488
+ }
489
+ }
490
+ return count;
491
+ }
492
+
493
+ /**
494
+ * Gets the position of the given pointer index in pixel
495
+ * @param i The pointer index
496
+ * @returns The position of the pointer in pixel
497
+ */
498
+ getPointerPosition(i: number): Vector2 | null {
499
+ if (i >= this._pointerPositions.length) return null;
500
+ return this._pointerPositions[i];
501
+ }
502
+ getPointerPositionLastFrame(i: number): Vector2 | null {
503
+ if (i >= this._pointerPositionsLastFrame.length) return null;
504
+ return this._pointerPositionsLastFrame[i];
505
+ }
506
+ getPointerPositionDelta(i: number): Vector2 | null {
507
+ if (i >= this._pointerPositionsDelta.length) return null;
508
+ return this._pointerPositionsDelta[i];
509
+ }
510
+ /**
511
+ * The pointer position in screenspace coordinates (-1 to 1) where 0 is the center of the screen.
512
+ * This can be useful for e.g. raycasting (see https://threejs.org/docs/#api/en/core/Raycaster.setFromCamera)
513
+ */
514
+ getPointerPositionRC(i: number): Vector2 | null {
515
+ if (i >= this._pointerPositionsRC.length) return null;
516
+ return this._pointerPositionsRC[i];
517
+ }
518
+ getPointerDown(i: number): boolean {
519
+ if (i >= this._pointerDown.length) return false;
520
+ return this._pointerDown[i];
521
+ }
522
+ getPointerUp(i: number): boolean {
523
+ if (i >= this._pointerUp.length) return false;
524
+ return this._pointerUp[i];
525
+ }
526
+ getPointerPressed(i: number): boolean {
527
+ if (i >= this._pointerPressed.length) return false;
528
+ const res = this._pointerPressed[i];
529
+ // if (i === 0) console.log(...this._pointerIds);
530
+ return res;
531
+ }
532
+ getPointerClicked(i: number): boolean {
533
+ if (i >= this._pointerClick.length) return false;
534
+ return this._pointerClick[i];
535
+ }
536
+ getPointerDoubleClicked(i: number): boolean {
537
+ if (i >= this._pointerDoubleClick.length) return false;
538
+ return this._pointerDoubleClick[i];
539
+ }
540
+ getPointerDownTime(i: number): number {
541
+ if (i >= this._pointerDownTime.length) return -1;
542
+ return this._pointerDownTime[i];
543
+ }
544
+ getPointerUpTime(i: number): number {
545
+ if (i >= this._pointerUpTime.length) return -1;
546
+ return this._pointerUpTime[i];
547
+ }
548
+ getPointerLongPress(i: number): boolean {
549
+ if (i >= this._pointerDownTime.length) return false;
550
+ return this.getPointerPressed(i) && this.context.time.time - this._pointerDownTime[i] > this._longPressTimeThreshold;
551
+ }
552
+ getIsMouse(i: number): boolean {
553
+ if (i < 0 || i >= this._pointerTypes.length) return false;
554
+ return this._pointerTypes[i] === PointerType.Mouse;
555
+ }
556
+ getIsTouch(i: number): boolean {
557
+ if (i < 0 || i >= this._pointerTypes.length) return false;
558
+ return this._pointerTypes[i] === PointerType.Touch;
559
+ }
560
+ getTouchesPressedCount(): number {
561
+ let count = 0;
562
+ for (let i = 0; i < this._pointerPressed.length; i++) {
563
+ if (this._pointerPressed[i] && this.getIsTouch(i)) {
564
+ count++;
565
+ }
566
+ }
567
+ return count;
568
+ }
569
+ getMouseWheelChanged(i: number = 0): boolean {
570
+ if (i >= this._mouseWheelChanged.length) return false;
571
+ return this._mouseWheelChanged[i];
572
+ }
573
+ getMouseWheelDeltaY(i: number = 0): number {
574
+ if (i >= this._mouseWheelDeltaY.length) return 0;
575
+ return this._mouseWheelDeltaY[i];
576
+ }
577
+ getPointerEvent(i: number): Event | undefined {
578
+ if (i >= this._pointerEvent.length) return undefined;
579
+ return this._pointerEvent[i] ?? undefined;
580
+ }
581
+ *foreachPointerId(pointerType?: string | PointerType | string[] | PointerType[]): Generator<number> {
582
+ for (let i = 0; i < this._pointerTypes.length; i++) {
583
+ // check if the pointer is active
584
+ if (this._pointerIsActive(i)) {
585
+ // if specific pointer types are requested
586
+ if (pointerType !== undefined) {
587
+ const type = this._pointerTypes[i];
588
+ if (Array.isArray(pointerType)) {
589
+ let isInArray = false;
590
+ for (const t of pointerType) {
591
+ if (type === t) {
592
+ isInArray = true;
593
+ break;
594
+ }
595
+ }
596
+ if (!isInArray) continue;
597
+ } else {
598
+ if (pointerType !== type) continue;
599
+ }
600
+ }
601
+ yield i;
602
+ }
603
+ }
604
+ }
605
+ *foreachTouchId(): Generator<number> {
606
+ for (let i = 0; i < this._pointerTypes.length; i++) {
607
+ const type = this._pointerTypes[i];
608
+ if (type !== PointerType.Touch) continue;
609
+ if (this._pointerIsActive[i])
610
+ yield i;
611
+ }
612
+ }
613
+
614
+ private _pointerIsActive(index: number) {
615
+ if (index < 0) return false;
616
+ return this._pointerPressed[index] || this._pointerDown[index] || this._pointerUp[index];
617
+ }
618
+
619
+ private context: Context;
620
+
621
+ private _pointerDown: boolean[] = [false];
622
+ private _pointerUp: boolean[] = [false];
623
+ private _pointerClick: boolean[] = [false];
624
+ private _pointerDoubleClick: boolean[] = [false];
625
+ private _pointerPressed: boolean[] = [false];
626
+ private _pointerPositions: Vector2[] = [new Vector2()];
627
+ private _pointerPositionsLastFrame: Vector2[] = [new Vector2()];
628
+ private _pointerPositionsDelta: Vector2[] = [new Vector2()];
629
+ private _pointerPositionsRC: Vector2[] = [new Vector2()];
630
+ private _pointerPositionDown: Vector3[] = [new Vector3()];
631
+ private _pointerDownTime: number[] = [];
632
+ private _pointerUpTime: number[] = [];
633
+ private _pointerUpTimestamp: number[] = [];
634
+ private _pointerIds: number[] = [];
635
+ private _pointerTypes: string[] = [""];
636
+ private _mouseWheelChanged: boolean[] = [false];
637
+ private _mouseWheelDeltaY: number[] = [0];
638
+ private _pointerEvent: Event[] = [];
639
+ /** current pressed pointer events. Used to check if any of those events was used */
640
+ private _pointerEventsPressed: NEPointerEvent[] = [];
641
+ /** This is added/updated for pointers. screenspace pointers set this to the camera near plane */
642
+ private _pointerSpace: IGameObject[] = [];
643
+
644
+
645
+ private readonly _pressedStack = new Map<number, number[]>();
646
+ private onDownButton(pointerId: number, button: number) {
647
+ let stack = this._pressedStack.get(pointerId);
648
+ if (!stack) {
649
+ stack = [];
650
+ this._pressedStack.set(pointerId, stack);
651
+ }
652
+ stack.push(button);
653
+ }
654
+ private onReleaseButton(pointerId: number, button: number) {
655
+ const stack = this._pressedStack.get(pointerId);
656
+ if (!stack) return;
657
+ const index = stack.indexOf(button);
658
+ if (index >= 0) stack.splice(index, 1);
659
+ }
660
+ /** the first button that was down and is currently pressed */
661
+ getFirstPressedButtonForPointer(pointerId: number): number | undefined {
662
+ const stack = this._pressedStack.get(pointerId);
663
+ if (!stack) return undefined;
664
+ return stack[0];
665
+ }
666
+ /** the last (most recent) button that was down and is currently pressed */
667
+ getLatestPressedButtonForPointer(pointerId: number): number | undefined {
668
+ const stack = this._pressedStack.get(pointerId);
669
+ if (!stack) return undefined;
670
+ return stack[stack.length - 1];
671
+ }
672
+
673
+
674
+ /** Get a key (if any) that was just pressed this frame (this is only true for the frame it was pressed down) */
675
+ getKeyDown(): string | null;
676
+ /** Get true or false if the given key was pressed this frame */
677
+ getKeyDown(key: KeyCode | ({} & string)): boolean;
678
+ getKeyDown(key?: KeyCode | ({} & string)): boolean | string | null {
679
+ // If a key is provided check if it was pressed this frame
680
+ if (key !== undefined) {
681
+ return this.isKeyDown(key);
682
+ }
683
+ // If no key was provided get the first key that was pressed this frame
684
+ for (const key in this.keysPressed) {
685
+ const k = this.keysPressed[key];
686
+ if (k.startFrame === this.context.time.frameCount) return k.key;
687
+ }
688
+ return null;
689
+ }
690
+ /** Get a key (if any) that is currently being pressed (held down) */
691
+ getKeyPressed(): string | null;
692
+ /** Get true or false if the given key is pressed */
693
+ getKeyPressed(key: KeyCode | ({} & string)): boolean
694
+ getKeyPressed(key?: KeyCode | ({} & string)): boolean | string | null {
695
+ if (key !== undefined) {
696
+ return this.isKeyPressed(key);
697
+ }
698
+ for (const key in this.keysPressed) {
699
+ const k = this.keysPressed[key];
700
+ if (k.pressed)
701
+ return k.key;
702
+ }
703
+ return null;
704
+ }
705
+
706
+ /** Get a key (if any) that was released in this frame */
707
+ getKeyUp(): string | null;
708
+ /** Get true or false if the given key was released this frame */
709
+ getKeyUp(key: KeyCode | ({} & string)): boolean;
710
+ getKeyUp(key?: KeyCode | ({} & string)): boolean | string | null {
711
+
712
+ if (key !== undefined) {
713
+ return this.isKeyUp(key);
714
+ }
715
+ for (const key in this.keysPressed) {
716
+ const k = this.keysPressed[key];
717
+ if (k.pressed === false && k.frame === this.context.time.frameCount) return true;
718
+ return false;
719
+ }
720
+
721
+ return null;
722
+ }
723
+
724
+ isKeyDown(keyCode: KeyCode | ({} & string)) {
725
+ if (!this.context.application.isVisible || !this.context.application.hasFocus) return false;
726
+ const codes = this.getCodeForCommonKeyName(keyCode);
727
+ if (codes !== null) {
728
+ for (const code of codes) if (this.isKeyDown(code)) return true;
729
+ return false;
730
+ }
731
+ const k = this.keysPressed[keyCode];
732
+ if (!k) return false;
733
+ return k.startFrame === this.context.time.frameCount && k.pressed;
734
+ }
735
+ isKeyUp(keyCode: KeyCode | ({} & string)) {
736
+ if (!this.context.application.isVisible || !this.context.application.hasFocus) return false;
737
+ const codes = this.getCodeForCommonKeyName(keyCode);
738
+ if (codes !== null) {
739
+ for (const code of codes) if (this.isKeyUp(code)) return true;
740
+ return false;
741
+ }
742
+ const k = this.keysPressed[keyCode];
743
+ if (!k) return false;
744
+ return k.frame === this.context.time.frameCount && k.pressed === false;
745
+ }
746
+ isKeyPressed(keyCode: KeyCode | ({} & string)): boolean {
747
+ if (!this.context.application.isVisible || !this.context.application.hasFocus) return false;
748
+ const codes = this.getCodeForCommonKeyName(keyCode);
749
+ if (codes !== null) {
750
+ for (const code of codes) if (this.isKeyPressed(code)) return true;
751
+ return false;
752
+ }
753
+ const k = this.keysPressed[keyCode];
754
+ if (!k) return false;
755
+ return k.pressed || false;
756
+ }
757
+
758
+ // utility helper for mapping common names to actual codes; e.g. "Shift" -> "ShiftLeft" and "ShiftRight" or "a" -> "KeyA"
759
+ private getCodeForCommonKeyName(keyName: string): string[] | null {
760
+ if (keyName.length === 1) {
761
+ // check if this is a digit
762
+ if (keyName >= "0" && keyName <= "9")
763
+ return ["Digit" + keyName];
764
+ // check if this is a letter
765
+ if (keyName >= "a" && keyName <= "z")
766
+ return ["Key" + keyName.toUpperCase()];
767
+ if (keyName == " ")
768
+ return ["Space"];
769
+ }
770
+ switch (keyName) {
771
+ case "shift":
772
+ case "Shift":
773
+ return ["ShiftLeft", "ShiftRight"];
774
+ case "control":
775
+ case "Control":
776
+ return ["ControlLeft", "ControlRight"];
777
+ case "alt":
778
+ case "Alt":
779
+ return ["AltLeft", "AltRight"];
780
+ }
781
+ return null;
782
+ }
783
+
784
+ createInputEvent(args: NEPointerEvent) {
785
+ // TODO: technically we would need to check for circular invocations here!
786
+ switch (args.type) {
787
+ case InputEvents.PointerDown:
788
+ if (debug) showBalloonMessage("Create Pointer down");
789
+ this.onDownButton(args.deviceIndex, args.button);
790
+ this.onDown(args);
791
+ break;
792
+ case InputEvents.PointerMove:
793
+ if (debug) showBalloonMessage("Create Pointer move");
794
+ this.onMove(args);
795
+ break;
796
+ case InputEvents.PointerUp:
797
+ if (debug) showBalloonMessage("Create Pointer up");
798
+ this.onUp(args);
799
+ this.onReleaseButton(args.deviceIndex, args.button);
800
+ break;
801
+ }
802
+ }
803
+
804
+ convertScreenspaceToRaycastSpace<T extends Vec2 | Vector2>(vec2: T): T {
805
+ vec2.x = (vec2.x - this.context.domX) / this.context.domWidth * 2 - 1;
806
+ vec2.y = -((vec2.y - this.context.domY) / this.context.domHeight) * 2 + 1;
807
+ return vec2;
808
+ }
809
+
810
+ /** @internal */
811
+ constructor(context: Context) {
812
+ this.context = context;
813
+ this.context.post_render_callbacks.push(this.onEndOfFrame);
814
+ }
815
+
816
+ /** this is the html element we subscribed to for events */
817
+ private _htmlEventSource!: HTMLElement;
818
+
819
+ bindEvents() {
820
+ this.unbindEvents();
821
+
822
+ // we subscribe to the canvas element because we don't want to receive events when the user is interacting with the UI
823
+ // e.g. if we have slotted HTML elements in the needle engine DOM elements we don't want to receive input events for those
824
+ this._htmlEventSource = this.context.renderer.domElement;
825
+
826
+ window.addEventListener('contextmenu', this.onContextMenu);
827
+
828
+ this._htmlEventSource.addEventListener('pointerdown', this.onPointerDown, { passive: true });
829
+ window.addEventListener('pointermove', this.onPointerMove, { passive: true, capture: true, });
830
+ window.addEventListener('pointerup', this.onPointerUp, { passive: true });
831
+ window.addEventListener('pointercancel', this.onPointerCancel, { passive: true })
832
+
833
+ window.addEventListener("touchstart", this.onTouchStart, { passive: true });
834
+ window.addEventListener("touchmove", this.onTouchMove, { passive: true });
835
+ window.addEventListener("touchend", this.onTouchEnd, { passive: true });
836
+
837
+ this._htmlEventSource.addEventListener('wheel', this.onMouseWheel, { passive: true });
838
+ window.addEventListener("wheel", this.onWheelWindow, { passive: true })
839
+
840
+ window.addEventListener("keydown", this.onKeyDown, false);
841
+ window.addEventListener("keypress", this.onKeyPressed, false);
842
+ window.addEventListener("keyup", this.onKeyUp, false);
843
+
844
+ // e.g. when using sharex to capture we loose focus thus dont get e.g. key up events
845
+ window.addEventListener('blur', this.onLostFocus);
846
+ }
847
+
848
+ unbindEvents() {
849
+ window.removeEventListener('contextmenu', this.onContextMenu);
850
+
851
+ this._htmlEventSource?.removeEventListener('pointerdown', this.onPointerDown);
852
+ window.removeEventListener('pointermove', this.onPointerMove);
853
+ window.removeEventListener('pointerup', this.onPointerUp);
854
+ window.removeEventListener('pointercancel', this.onPointerCancel);
855
+
856
+ window.removeEventListener("touchstart", this.onTouchStart);
857
+ window.removeEventListener("touchmove", this.onTouchMove);
858
+ window.removeEventListener("touchend", this.onTouchEnd);
859
+
860
+ this._htmlEventSource?.removeEventListener('wheel', this.onMouseWheel, false);
861
+ window.removeEventListener("wheel", this.onWheelWindow, false);
862
+
863
+ window.removeEventListener("keydown", this.onKeyDown, false);
864
+ window.removeEventListener("keypress", this.onKeyPressed, false);
865
+ window.removeEventListener("keyup", this.onKeyUp, false);
866
+
867
+ window.removeEventListener('blur', this.onLostFocus);
868
+ }
869
+
870
+ dispose() {
871
+ const index = this.context.post_render_callbacks.indexOf(this.onEndOfFrame);
872
+ if (index >= 0) this.context.post_render_callbacks.splice(index, 1);
873
+ this.unbindEvents();
874
+ }
875
+
876
+ private onLostFocus = () => {
877
+ for (const kp in this.keysPressed) {
878
+ this.keysPressed[kp].pressed = false;
879
+ }
880
+ }
881
+
882
+ private readonly _receivedPointerMoveEventsThisFrame = new Array<number>;
883
+
884
+ private onEndOfFrame = () => {
885
+ this._receivedPointerMoveEventsThisFrame.length = 0;
886
+ for (let i = 0; i < this._pointerUp.length; i++)
887
+ this._pointerUp[i] = false;
888
+ for (let i = 0; i < this._pointerDown.length; i++)
889
+ this._pointerDown[i] = false;
890
+ for (let i = 0; i < this._pointerClick.length; i++)
891
+ this._pointerClick[i] = false;
892
+ for (let i = 0; i < this._pointerDoubleClick.length; i++)
893
+ this._pointerDoubleClick[i] = false;
894
+ for (const pt of this._pointerPositionsDelta)
895
+ pt.set(0, 0);
896
+ for (let i = 0; i < this._mouseWheelChanged.length; i++)
897
+ this._mouseWheelChanged[i] = false;
898
+ for (let i = 0; i < this._mouseWheelDeltaY.length; i++)
899
+ this._mouseWheelDeltaY[i] = 0;
900
+ }
901
+
902
+ private canReceiveInput(evt: Event) {
903
+ // If the user has HTML objects ontop of the canvas
904
+ // if(evt.target === this.context.renderer.domElement) return true;
905
+ // const css = window.getComputedStyle(evt.target as HTMLElement);
906
+ // if(css.pointerEvents === "all") return false;
907
+ // We only check the target elements here since the canvas may be overlapped by other elements
908
+ // in which case we do not want to use the input (e.g. if a HTML element is being triggered)
909
+ if (evt.target === this.context.renderer?.domElement) return true;
910
+ if (evt.target === this.context.domElement) return true;
911
+
912
+ // if we are in AR we always want to receive touches because the canvas is the whole screen.
913
+ // See https://linear.app/needle/issue/NE-4345
914
+ if (this.context.isInAR) {
915
+ return true;
916
+ }
917
+
918
+ // looks like in Mozilla WebXR viewer the target element is the body
919
+ if (this.context.isInAR && evt.target === document.body && DeviceUtilities.isMozillaXR()) return true;
920
+
921
+ if (debug) console.warn("CanReceiveInput:False for", evt.target);
922
+ return false;
923
+ }
924
+
925
+ private onContextMenu = (evt: Event) => {
926
+ if (this.canReceiveInput(evt) === false)
927
+ return;
928
+ if (evt instanceof PointerEvent) {
929
+ // for longpress on touch there might open a context menu
930
+ // in which case we set the pointer pressed back to false (resetting the pressed pointer)
931
+ // we need to emit a pointer up event here as well
932
+ if (evt.pointerType === "touch") {
933
+ // for (const index in this._pointerPressed) {
934
+ // if (this._pointerTypes[index] === PointerType.Touch) {
935
+ // // this._pointerPressed[index] = false;
936
+ // // this throws orbit controls?
937
+ // // const ne = this.createPointerEventFromTouch("pointerup", parseInt(index), this._pointerPositions[index].x, this._pointerPositions[index].y, 0, evt);
938
+ // // this.onUp(ne);
939
+ // }
940
+ // }
941
+ }
942
+ }
943
+ }
944
+
945
+ private keysPressed: { [key: KeyCode | string]: { pressed: boolean, frame: number, startFrame: number, key: string, code: KeyCode | string } } = {};
946
+
947
+ private onKeyDown = (evt: KeyboardEvent) => {
948
+ if (debug) console.log(`key down ${evt.code}, ${this.context.application.hasFocus}`, evt);
949
+ if (!this.context.application.hasFocus)
950
+ return;
951
+ const ex = this.keysPressed[evt.code];
952
+ if (ex && ex.pressed) return;
953
+ this.keysPressed[evt.code] = { pressed: true, frame: this.context.time.frameCount + 1, startFrame: this.context.time.frameCount + 1, key: evt.key, code: evt.code };
954
+ const ne = new NEKeyboardEvent(InputEvents.KeyDown, evt, evt);
955
+ this.onDispatchEvent(ne);
956
+ }
957
+ private onKeyPressed = (evt: KeyboardEvent) => {
958
+ if (!this.context.application.hasFocus)
959
+ return;
960
+ const p = this.keysPressed[evt.code];
961
+ if (!p) return;
962
+ p.pressed = true;
963
+ p.frame = this.context.time.frameCount + 1;
964
+ const ne = new NEKeyboardEvent(InputEvents.KeyPressed, evt, evt);
965
+ this.onDispatchEvent(ne);
966
+
967
+ }
968
+ private onKeyUp = (evt: KeyboardEvent) => {
969
+ if (!this.context.application.hasFocus)
970
+ return;
971
+ const p = this.keysPressed[evt.code];
972
+ if (!p) return;
973
+ p.pressed = false;
974
+ p.frame = this.context.time.frameCount + 1;
975
+ const ne = new NEKeyboardEvent(InputEvents.KeyUp, evt, evt);
976
+ this.onDispatchEvent(ne);
977
+ }
978
+
979
+ private onWheelWindow = (evt: WheelEvent) => {
980
+ // check if we are in pointer lock mode
981
+ if (document.pointerLockElement) {
982
+ // only if yes we want to use the mouse wheel as a pointer event
983
+ this.onMouseWheel(evt);
984
+ }
985
+ };
986
+ private onMouseWheel = (evt: WheelEvent) => {
987
+ if (this.canReceiveInput(evt) === false) return;
988
+ if (this._mouseWheelDeltaY.length <= 0) this._mouseWheelDeltaY.push(0);
989
+ if (this._mouseWheelChanged.length <= 0) this._mouseWheelChanged.push(false);
990
+ this._mouseWheelChanged[0] = true;
991
+ const current = this._mouseWheelDeltaY[0];
992
+ this._mouseWheelDeltaY[0] = current + evt.deltaY;
993
+ }
994
+ private onPointerDown = (evt: PointerEvent) => {
995
+ if (this.context.isInAR) return;
996
+ if (this.canReceiveInput(evt) === false) return;
997
+ if (evt.target instanceof HTMLElement) {
998
+ evt.target.setPointerCapture(evt.pointerId);
999
+ }
1000
+ const id = this.getPointerId(evt);
1001
+ if (debug) showBalloonMessage(`pointer down #${id}, identifier:${evt.pointerId}`);
1002
+ const space = this.getAndUpdateSpatialObjectForScreenPosition(id, evt.clientX, evt.clientY);
1003
+ const ne = new NEPointerEvent(InputEvents.PointerDown, evt, { origin: this, mode: "screen", deviceIndex: 0, pointerId: id, button: evt.button, clientX: evt.clientX, clientY: evt.clientY, pointerType: evt.pointerType as PointerTypeNames, buttonName: this.getButtonName(evt), device: space, pressure: evt.pressure });
1004
+ this.onDown(ne);
1005
+ }
1006
+ private onPointerMove = (evt: PointerEvent) => {
1007
+ if (this.context.isInAR) return;
1008
+
1009
+ // Prevent multiple pointerMove events per frame
1010
+ if (this._receivedPointerMoveEventsThisFrame.includes(evt.pointerId)) return;
1011
+ this._receivedPointerMoveEventsThisFrame.push(evt.pointerId);
1012
+
1013
+ // We want to keep receiving move events until pointerUp and not stop handling events just because we're hovering over *some* HTML element
1014
+ // if (this.canReceiveInput(evt) === false) return;
1015
+
1016
+ let button = evt.button;
1017
+ if (evt.pointerType === "mouse") {
1018
+ const pressedButton = this.getFirstPressedButtonForPointer(0);
1019
+ button = pressedButton ?? 0;
1020
+ }
1021
+ const id = this.getPointerId(evt, button);
1022
+ if (button === -1) {
1023
+ button = id;
1024
+ }
1025
+ const space = this.getAndUpdateSpatialObjectForScreenPosition(id, evt.clientX, evt.clientY);
1026
+ const ne = new NEPointerEvent(InputEvents.PointerMove, evt, { origin: this, mode: "screen", deviceIndex: 0, pointerId: id, button: button, clientX: evt.clientX, clientY: evt.clientY, pointerType: evt.pointerType as PointerTypeNames, buttonName: this.getButtonName(evt), device: space, pressure: evt.pressure });
1027
+ this.onMove(ne);
1028
+ }
1029
+ private onPointerCancel = (evt: PointerEvent) => {
1030
+ if (this.context.isInAR) return;
1031
+ if (debug) console.log("Pointer cancel", evt);
1032
+ // we treat this as an up event for now to make sure we don't have any pointers stuck in a pressed state etc. Technically we dont want to invoke a up event for cancels...
1033
+ this.onPointerUp(evt);
1034
+ }
1035
+ private onPointerUp = (evt: PointerEvent) => {
1036
+ if (this.context.isInAR) return;
1037
+ if (evt.target instanceof HTMLElement) {
1038
+ evt.target.releasePointerCapture(evt.pointerId);
1039
+ }
1040
+ // the pointer up event should always be handled
1041
+ // if (this.canReceiveInput(evt) === false) return;
1042
+ const id = this.getPointerId(evt);
1043
+ // if (!this.isNewEvent(evt.timeStamp, id, this._pointerUpTimestamp)) return;
1044
+ const ne = new NEPointerEvent(InputEvents.PointerUp, evt, { origin: this, mode: "screen", deviceIndex: 0, pointerId: id, button: evt.button, clientX: evt.clientX, clientY: evt.clientY, pointerType: evt.pointerType as PointerTypeNames, buttonName: this.getButtonName(evt), device: this.getAndUpdateSpatialObjectForScreenPosition(id, evt.clientX, evt.clientY), pressure: evt.pressure });
1045
+ this.onUp(ne);
1046
+ this._pointerIds[id] = -1;
1047
+ if (debug) console.log("ID=" + id, "PointerId=" + evt.pointerId, "ALL:", [...this._pointerIds]);
1048
+ }
1049
+
1050
+ private getPointerId(evt: PointerEvent, button?: number): number {
1051
+ if (evt.pointerType === "mouse") return 0 + (button ?? evt.button);
1052
+ return this.getPointerIndex(evt.pointerId);
1053
+ }
1054
+ private getButtonName(evt: PointerEvent): MouseButtonName | "unknown" {
1055
+ const button = evt.button;
1056
+ if (evt.pointerType === "mouse") {
1057
+ switch (button) {
1058
+ case 0: return "left";
1059
+ case 1: return "middle";
1060
+ case 2: return "right";
1061
+ }
1062
+ }
1063
+ return "unknown";
1064
+ }
1065
+
1066
+ // the touch events are currently only used for AR support on android
1067
+ private onTouchStart = (evt: TouchEvent) => {
1068
+ if (!this.context.isInAR) return;
1069
+ for (let i = 0; i < evt.changedTouches.length; i++) {
1070
+ const touch = evt.changedTouches[i];
1071
+ const id = this.getPointerIndex(touch.identifier);
1072
+ const space = this.getAndUpdateSpatialObjectForScreenPosition(id, touch.clientX, touch.clientY);
1073
+ const ne = new NEPointerEvent(InputEvents.PointerDown, evt, { origin: this, mode: "screen", deviceIndex: 0, pointerId: id, button: 0, clientX: touch.clientX, clientY: touch.clientY, pointerType: "touch", buttonName: "unknown", device: space, pressure: touch.force });
1074
+ this.onDown(ne);
1075
+ };
1076
+ };
1077
+ private onTouchMove = (evt: TouchEvent) => {
1078
+ if (!this.context.isInAR) return;
1079
+ for (let i = 0; i < evt.changedTouches.length; i++) {
1080
+ const touch = evt.changedTouches[i];
1081
+ const id = this.getPointerIndex(touch.identifier);
1082
+ const space = this.getAndUpdateSpatialObjectForScreenPosition(id, touch.clientX, touch.clientY);
1083
+ const ne = new NEPointerEvent(InputEvents.PointerMove, evt, { origin: this, mode: "screen", deviceIndex: 0, pointerId: id, button: 0, clientX: touch.clientX, clientY: touch.clientY, pointerType: "touch", buttonName: "unknown", device: space, pressure: touch.force });
1084
+ this.onMove(ne);
1085
+ };
1086
+ }
1087
+ private onTouchEnd = (evt: TouchEvent) => {
1088
+ if (!this.context.isInAR) return;
1089
+ for (let i = 0; i < evt.changedTouches.length; i++) {
1090
+ const touch = evt.changedTouches[i];
1091
+ const id = this.getPointerIndex(touch.identifier);
1092
+ const ne = new NEPointerEvent(InputEvents.PointerUp, evt, { origin: this, mode: "screen", deviceIndex: 0, pointerId: id, button: 0, clientX: touch.clientX, clientY: touch.clientY, pointerType: "touch", buttonName: "unknown", device: this.getAndUpdateSpatialObjectForScreenPosition(id, touch.clientX, touch.clientY), pressure: touch.force });
1093
+ this.onUp(ne);
1094
+ this._pointerIds[id] = -1;
1095
+ };
1096
+ }
1097
+
1098
+ private readonly tempNearPlaneVector = new Vector3();
1099
+ private readonly tempFarPlaneVector = new Vector3();
1100
+ private readonly tempLookMatrix = new Matrix4();
1101
+ private getAndUpdateSpatialObjectForScreenPosition(id: number, screenX: number, screenY: number): IGameObject {
1102
+ let space = this._pointerSpace[id]
1103
+ if (!space) {
1104
+ space = new Object3D() as unknown as IGameObject;
1105
+ this._pointerSpace[id] = space;
1106
+ }
1107
+ this._pointerSpace[id] = space;
1108
+ const camera = this.context.mainCamera;
1109
+ if (camera) {
1110
+ const pointOnNearPlane = this.tempNearPlaneVector.set(screenX, screenY, -1);
1111
+ this.convertScreenspaceToRaycastSpace(pointOnNearPlane);
1112
+ const pointOnFarPlane = this.tempFarPlaneVector.set(pointOnNearPlane.x, pointOnNearPlane.y, 1);
1113
+ pointOnNearPlane.unproject(camera);
1114
+ pointOnFarPlane.unproject(camera);
1115
+ const worldUp = (camera as any as IGameObject).worldUp || getTempVector(0, 1, 0).applyQuaternion(getWorldQuaternion(camera))
1116
+ this.tempLookMatrix.lookAt(pointOnFarPlane, pointOnNearPlane, worldUp);
1117
+ space.position.set(pointOnNearPlane.x, pointOnNearPlane.y, pointOnNearPlane.z);
1118
+ space.quaternion.setFromRotationMatrix(this.tempLookMatrix);
1119
+ }
1120
+ return space;
1121
+ }
1122
+
1123
+ // Prevent the same event being handled twice (e.g. on touch we get a mouseUp and touchUp evt with the same timestamp)
1124
+ // private isNewEvent(timestamp: number, index: number, arr: number[]): boolean {
1125
+ // while (arr.length <= index) arr.push(-1);
1126
+ // if (timestamp === arr[index]) return false;
1127
+ // arr[index] = timestamp;
1128
+ // return true;
1129
+ // }
1130
+
1131
+ private isInRect(e: { clientX: number, clientY: number }): boolean {
1132
+ if (this.context.isInXR) return true;
1133
+ const rect = this.context.domElement.getBoundingClientRect();
1134
+ const px = e.clientX;
1135
+ const py = e.clientY;
1136
+ const isInRect = px >= rect.x && px <= rect.right && py >= rect.y && py <= rect.bottom;
1137
+ if (debug && !isInRect) console.log("Not in rect", rect, px, py);
1138
+ return isInRect;
1139
+
1140
+ }
1141
+
1142
+ private onDown(evt: NEPointerEvent) {
1143
+ const index = evt.pointerId;
1144
+ if (this.getPointerPressed(index)) {
1145
+ console.warn(`Received pointerDown for pointerId that is already pressed: ${index}`, debug ? evt : '');
1146
+ }
1147
+ if (debug) console.log(evt.pointerType, "DOWN", index);
1148
+ if (!this.isInRect(evt)) return;
1149
+ // if (this.isMouseEventFromTouch(evt)) return;
1150
+
1151
+ this.setPointerState(index, this._pointerPressed, true);
1152
+ this.setPointerState(index, this._pointerDown, true);
1153
+ this.setPointerStateT(index, this._pointerEvent, evt.source);
1154
+
1155
+ while (index >= this._pointerTypes.length) this._pointerTypes.push(evt.pointerType);
1156
+ this._pointerTypes[index] = evt.pointerType;
1157
+
1158
+ while (index >= this._pointerPositionDown.length) this._pointerPositionDown.push(new Vector3());
1159
+ this._pointerPositionDown[index].set(evt.clientX, evt.clientY, evt.clientZ ?? 0);
1160
+ while (index >= this._pointerPositions.length) this._pointerPositions.push(new Vector2());
1161
+ this._pointerPositions[index].set(evt.clientX, evt.clientY);
1162
+
1163
+ if (index >= this._pointerDownTime.length) this._pointerDownTime.push(0);
1164
+ this._pointerDownTime[index] = this.context.time.realtimeSinceStartup;
1165
+
1166
+ this.updatePointerPosition(evt);
1167
+
1168
+ this._pointerEventsPressed.push(evt);
1169
+ this.onDispatchEvent(evt);
1170
+ }
1171
+ // moveEvent?: Event;
1172
+ private onMove(evt: NEPointerEvent) {
1173
+ const index = evt.pointerId;
1174
+
1175
+ const isDown = this.getPointerPressed(index);
1176
+ if (isDown === false && !this.isInRect(evt)) return;
1177
+ if (evt.pointerType === PointerType.Touch && !isDown) return;
1178
+ // if (this.isMouseEventFromTouch(evt)) return;
1179
+ // if (debug) console.log(evt.pointerType, "MOVE", index, "hasSpace=" + evt.space != null);
1180
+
1181
+ this.updatePointerPosition(evt);
1182
+ this.setPointerStateT(index, this._pointerEvent, evt.source);
1183
+ this.onDispatchEvent(evt);
1184
+ }
1185
+ private onUp(evt: NEPointerEvent) {
1186
+ const index = evt.pointerId;
1187
+ const wasDown = this.getPointerPressed(index);
1188
+ if (!wasDown) {
1189
+ if (debug) console.log(evt.pointerType, "UP", index, "was not down");
1190
+ return;
1191
+ }
1192
+ // if (this.isMouseEventFromTouch(evt)) return;
1193
+ if (debug) console.log(evt.pointerType, "UP", index);
1194
+
1195
+ this.setPointerState(index, this._pointerPressed, false);
1196
+ this.setPointerStateT(index, this._pointerEvent, evt.source);
1197
+ this.setPointerState(index, this._pointerUp, true);
1198
+
1199
+ this.updatePointerPosition(evt);
1200
+
1201
+ for (let i = this._pointerEventsPressed.length - 1; i >= 0; i--) {
1202
+ const ptr = this._pointerEventsPressed[i];
1203
+ if (ptr.pointerId === index) {
1204
+ this._pointerEventsPressed.splice(i, 1);
1205
+ break;
1206
+ }
1207
+ }
1208
+
1209
+ if (!this._pointerPositionDown[index]) {
1210
+ if (debug) showBalloonWarning("Received pointer up event without matching down event for button: " + index);
1211
+ console.warn("Received pointer up event without matching down event for button: " + index)
1212
+ return;
1213
+ }
1214
+
1215
+
1216
+ const lastUpTime = this._pointerUpTime[index];
1217
+ const downTime = this._pointerDownTime[index];
1218
+ const upTime = this.context.time.realtimeSinceStartup;
1219
+ const dt = upTime - downTime;
1220
+ if (index >= this._pointerUpTime.length) this._pointerUpTime.push(-99);
1221
+ this._pointerUpTime[index] = upTime;
1222
+
1223
+ // If the time from down to up is less than 1 second check if it was a click
1224
+ if (dt < 1) {
1225
+ let dx = evt.clientX - this._pointerPositionDown[index].x;
1226
+ let dy = evt.clientY - this._pointerPositionDown[index].y;
1227
+ let dz = 0;
1228
+ if (evt.isSpatial && evt.clientZ != undefined) {
1229
+ dz = evt.clientZ - this._pointerPositionDown[index].z;
1230
+ // spatial clicks remapping
1231
+ dx *= 200;
1232
+ dy *= 200;
1233
+ dz *= 200;
1234
+ }
1235
+
1236
+ if (Math.abs(dx) < 5 && Math.abs(dy) < 5 && Math.abs(dz) < 5) {
1237
+ this.setPointerState(index, this._pointerClick, true);
1238
+ evt.isClick = true;
1239
+
1240
+ // handle double click
1241
+ const dt = upTime - lastUpTime;
1242
+ if (debug) console.log("CLICK", index, dx, dy, dz, dt)
1243
+ if (dt < this._doubleClickTimeThreshold && dt > 0) {
1244
+ this.setPointerState(index, this._pointerDoubleClick, true);
1245
+ evt.isDoubleClick = true;
1246
+ }
1247
+ }
1248
+ }
1249
+
1250
+
1251
+ this.onDispatchEvent(evt);
1252
+ }
1253
+
1254
+ private updatePointerPosition(evt: NEPointerEvent) {
1255
+ const index = evt.pointerId;
1256
+
1257
+ while (index >= this._pointerPositions.length) this._pointerPositions.push(new Vector2());
1258
+ while (index >= this._pointerPositionsLastFrame.length) this._pointerPositionsLastFrame.push(new Vector2());
1259
+ while (index >= this._pointerPositionsDelta.length) this._pointerPositionsDelta.push(new Vector2());
1260
+
1261
+ const lf = this._pointerPositionsLastFrame[index];
1262
+ lf.copy(this._pointerPositions[index]);
1263
+ // accumulate delta (it's reset in end of frame), if we just write it here it's not correct when the browser console is open
1264
+ const delta = this._pointerPositionsDelta[index];
1265
+ let dx = evt.clientX - lf.x;
1266
+ let dy = evt.clientY - lf.y;
1267
+ // if pointer is locked, clientX and Y are not changed, but Movement is.
1268
+ if (evt.source instanceof MouseEvent || evt.source instanceof TouchEvent) {
1269
+ const source = evt.source as PointerEvent;
1270
+ if (dx === 0 && source.movementX !== 0)
1271
+ dx = source.movementX || 0;
1272
+ if (dy === 0 && source.movementY !== 0)
1273
+ dy = source.movementY || 0;
1274
+ }
1275
+ delta.x += dx;
1276
+ delta.y += dy;
1277
+
1278
+ this._pointerPositions[index].x = evt.clientX;
1279
+ this._pointerPositions[index].y = evt.clientY;
1280
+
1281
+ // we want to have the position 01 on the canvas for raycasting
1282
+ const px = evt.clientX;
1283
+ const py = evt.clientY;
1284
+ while (index >= this._pointerPositionsRC.length) this._pointerPositionsRC.push(new Vector2());
1285
+ const rc = this._pointerPositionsRC[index];
1286
+ rc.set(px, py);
1287
+ this.convertScreenspaceToRaycastSpace(rc);
1288
+ // console.log(this.context.alias, rc);
1289
+ // this._pointerPositionsRC[evt.button].x = (px - this.context.domX) / this.context.domWidth * 2 - 1;
1290
+ // this._pointerPositionsRC[evt.button].y = -((py - this.context.domY) / this.context.domHeight) * 2 + 1;
1291
+ // console.log(evt.button)
1292
+ }
1293
+
1294
+ /** get the next free id */
1295
+ private getPointerIndex(pointerId: number) {
1296
+ // test if theres a pointer with the id
1297
+ let firstFreeIndex = -1;
1298
+ for (let i = 0; i < this._pointerIds.length; i++) {
1299
+ if (this._pointerIds[i] === pointerId) return i;
1300
+ else if (firstFreeIndex === -1 && this._pointerIds[i] === -1) {
1301
+ firstFreeIndex = i;
1302
+ }
1303
+ }
1304
+ // if not take the free slot if any
1305
+ if (firstFreeIndex !== -1) {
1306
+ this._pointerIds[firstFreeIndex] = pointerId;
1307
+ return firstFreeIndex;
1308
+ }
1309
+ if (debug) console.log("PUSH pointerId:", pointerId)
1310
+ this._pointerIds.push(pointerId);
1311
+ return this._pointerIds.length - 1;
1312
+ }
1313
+
1314
+ private setPointerState(index: number, arr: boolean[], value: boolean) {
1315
+ arr[index] = value;
1316
+ }
1317
+
1318
+ private setPointerStateT<T>(index: number, arr: T[], value: T) {
1319
+ // while (arr.length <= index) arr.push(null as any);
1320
+ arr[index] = value;
1321
+ return value;
1322
+ }
1323
+
1324
+ private onDispatchEvent(evt: NEPointerEvent | NEKeyboardEvent) {
1325
+ const prevContext = Context.Current;
1326
+ try {
1327
+ Context.Current = this.context;
1328
+ this.dispatchEvent(evt);
1329
+ }
1330
+ finally {
1331
+ Context.Current = prevContext;
1332
+ }
1333
+ }
1334
+ }
1335
+
1336
+ export declare type KeyCode =
1337
+ | "Tab"
1338
+ | "Enter"
1339
+ | "ShiftLeft"
1340
+ | "ShiftRight"
1341
+ | "ControlLeft"
1342
+ | "ControlRight"
1343
+ | "AltLeft"
1344
+ | "AltRight"
1345
+ | "Pause"
1346
+ | "CapsLock"
1347
+ | "Escape"
1348
+ | "Space"
1349
+ | "PageUp"
1350
+ | "PageDown"
1351
+ | "End"
1352
+ | "Home"
1353
+ | "ArrowLeft"
1354
+ | "ArrowUp"
1355
+ | "ArrowRight"
1356
+ | "ArrowDown"
1357
+ | "Insert"
1358
+ | "Delete"
1359
+ | "Digit0"
1360
+ | "Digit1"
1361
+ | "Digit2"
1362
+ | "Digit3"
1363
+ | "Digit4"
1364
+ | "Digit5"
1365
+ | "Digit6"
1366
+ | "Digit7"
1367
+ | "Digit8"
1368
+ | "Digit9"
1369
+ | "KeyA"
1370
+ | "KeyB"
1371
+ | "KeyC"
1372
+ | "KeyD"
1373
+ | "KeyE"
1374
+ | "KeyF"
1375
+ | "KeyG"
1376
+ | "KeyH"
1377
+ | "KeyI"
1378
+ | "KeyJ"
1379
+ | "KeyK"
1380
+ | "KeyL"
1381
+ | "KeyM"
1382
+ | "KeyN"
1383
+ | "KeyO"
1384
+ | "KeyP"
1385
+ | "KeyQ"
1386
+ | "KeyR"
1387
+ | "KeyS"
1388
+ | "KeyT"
1389
+ | "KeyU"
1390
+ | "KeyV"
1391
+ | "KeyW"
1392
+ | "KeyX"
1393
+ | "KeyY"
1394
+ | "KeyZ"
1395
+ | "Select"
1396
+ | "Numpad0"
1397
+ | "Numpad1"
1398
+ | "Numpad2"
1399
+ | "Numpad3"
1400
+ | "Numpad4"
1401
+ | "Numpad5"
1402
+ | "Numpad6"
1403
+ | "Numpad7"
1404
+ | "Numpad8"
1405
+ | "Numpad9"
1406
+ | "Multiply"
1407
+ | "Add"
1408
+ | "Subtract"
1409
+ | "Decimal"
1410
+ | "Divide"
1411
+ | "F1"
1412
+ | "F2"
1413
+ | "F3"
1414
+ | "F4"
1415
+ | "F5"
1416
+ | "F6"
1417
+ | "F7"
1418
+ | "F8"
1419
+ | "F9"
1420
+ | "F10"
1421
+ | "F11"
1422
+ | "F12";
1423
+
1424
+ // KEY_1 = 49,
1425
+ // KEY_2 = 50,
1426
+ // KEY_3 = 51,
1427
+ // KEY_4 = 52,
1428
+ // KEY_5 = 53,
1429
+ // KEY_6 = 54,
1430
+ // KEY_7 = 55,
1431
+ // KEY_8 = 56,
1432
+ // KEY_9 = 57,
1433
+ // KEY_A = 65,
1434
+ // KEY_B = 66,
1435
+ // KEY_C = 67,
1436
+ // KEY_D = "d",
1437
+ // KEY_E = 69,
1438
+ // KEY_F = 70,
1439
+ // KEY_G = 71,
1440
+ // KEY_H = 72,
1441
+ // KEY_I = 73,
1442
+ // KEY_J = 74,
1443
+ // KEY_K = 75,
1444
+ // KEY_L = 76,
1445
+ // KEY_M = 77,
1446
+ // KEY_N = 78,
1447
+ // KEY_O = 79,
1448
+ // KEY_P = 80,
1449
+ // KEY_Q = 81,
1450
+ // KEY_R = 82,
1451
+ // KEY_S = 83,
1452
+ // KEY_T = 84,
1453
+ // KEY_U = 85,
1454
+ // KEY_V = 86,
1455
+ // KEY_W = 87,
1456
+ // KEY_X = 88,
1457
+ // KEY_Y = 89,
1458
+ // KEY_Z = 90,
1459
+ // LEFT_META = 91,
1460
+ // RIGHT_META = 92,
1461
+ // SELECT = 93,
1462
+ // NUMPAD_0 = 96,
1463
+ // NUMPAD_1 = 97,
1464
+ // NUMPAD_2 = 98,
1465
+ // NUMPAD_3 = 99,
1466
+ // NUMPAD_4 = 100,
1467
+ // NUMPAD_5 = 101,
1468
+ // NUMPAD_6 = 102,
1469
+ // NUMPAD_7 = 103,
1470
+ // NUMPAD_8 = 104,
1471
+ // NUMPAD_9 = 105,
1472
+ // MULTIPLY = 106,
1473
+ // ADD = 107,
1474
+ // SUBTRACT = 109,
1475
+ // DECIMAL = 110,
1476
+ // DIVIDE = 111,
1477
+ // F1 = 112,
1478
+ // F2 = 113,
1479
+ // F3 = 114,
1480
+ // F4 = 115,
1481
+ // F5 = 116,
1482
+ // F6 = 117,
1483
+ // F7 = 118,
1484
+ // F8 = 119,
1485
+ // F9 = 120,
1486
+ // F10 = 121,
1487
+ // F11 = 122,
1488
+ // F12 = 123,
1489
+ // NUM_LOCK = 144,
1490
+ // SCROLL_LOCK = 145,
1491
+ // SEMICOLON = 186,
1492
+ // EQUALS = 187,
1493
+ // COMMA = 188,
1494
+ // DASH = 189,
1495
+ // PERIOD = 190,
1496
+ // FORWARD_SLASH = 191,
1497
+ // GRAVE_ACCENT = 192,
1498
+ // OPEN_BRACKET = 219,
1499
+ // BACK_SLASH = 220,
1500
+ // CLOSE_BRACKET = 221,
1501
1501
  // SINGLE_QUOTE = 222