@needle-tools/engine 4.4.0-beta → 4.4.0-ci.0

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 (1046) hide show
  1. package/CHANGELOG.md +3604 -3604
  2. package/LICENSE.md +10 -10
  3. package/README.md +64 -64
  4. package/components.needle.json +1 -1
  5. package/dist/needle-engine.bundle.js +8 -8
  6. package/dist/needle-engine.bundle.light.js +8 -8
  7. package/dist/needle-engine.bundle.light.min.js +2 -2
  8. package/dist/needle-engine.bundle.light.umd.cjs +2 -2
  9. package/dist/needle-engine.bundle.min.js +2 -2
  10. package/dist/needle-engine.bundle.umd.cjs +2 -2
  11. package/dist/needle-engine.d.ts +130 -138
  12. package/dist/needle-engine.light.d.ts +130 -138
  13. package/dist/postprocessing.js +1673 -1527
  14. package/dist/postprocessing.light.js +1673 -1527
  15. package/dist/postprocessing.light.min.js +80 -66
  16. package/dist/postprocessing.light.umd.cjs +83 -69
  17. package/dist/postprocessing.min.js +80 -66
  18. package/dist/postprocessing.umd.cjs +83 -69
  19. package/dist/vendor.js +1 -1
  20. package/dist/vendor.light.js +1 -1
  21. package/lib/asap/needle-asap.d.ts +1 -1
  22. package/lib/asap/needle-asap.js +95 -95
  23. package/lib/asap/sessiongranted.d.ts +3 -3
  24. package/lib/asap/sessiongranted.js +65 -65
  25. package/lib/asap/utils.d.ts +1 -1
  26. package/lib/asap/utils.js +3 -3
  27. package/lib/engine/analytics/index.d.ts +6 -6
  28. package/lib/engine/analytics/index.js +12 -12
  29. package/lib/engine/analytics/lcp.d.ts +3 -3
  30. package/lib/engine/analytics/lcp.js +34 -34
  31. package/lib/engine/api.d.ts +81 -81
  32. package/lib/engine/api.js +80 -80
  33. package/lib/engine/assets/index.d.ts +11 -11
  34. package/lib/engine/assets/index.js +47 -47
  35. package/lib/engine/assets/static.d.ts +1 -1
  36. package/lib/engine/assets/static.js +4 -4
  37. package/lib/engine/codegen/register_types.d.ts +1 -1
  38. package/lib/engine/codegen/register_types.js +298 -298
  39. package/lib/engine/debug/debug.d.ts +15 -15
  40. package/lib/engine/debug/debug.js +44 -44
  41. package/lib/engine/debug/debug_console.d.ts +2 -2
  42. package/lib/engine/debug/debug_console.js +307 -307
  43. package/lib/engine/debug/debug_overlay.d.ts +22 -22
  44. package/lib/engine/debug/debug_overlay.js +316 -316
  45. package/lib/engine/debug/debug_spatial_console.d.ts +2 -2
  46. package/lib/engine/debug/debug_spatial_console.js +390 -390
  47. package/lib/engine/debug/index.d.ts +2 -2
  48. package/lib/engine/debug/index.js +2 -2
  49. package/lib/engine/engine_addressables.d.ts +166 -166
  50. package/lib/engine/engine_addressables.js +608 -608
  51. package/lib/engine/engine_animation.d.ts +43 -43
  52. package/lib/engine/engine_animation.js +133 -133
  53. package/lib/engine/engine_application.d.ts +40 -40
  54. package/lib/engine/engine_application.js +104 -104
  55. package/lib/engine/engine_assetdatabase.d.ts +25 -25
  56. package/lib/engine/engine_assetdatabase.js +344 -344
  57. package/lib/engine/engine_audio.d.ts +4 -4
  58. package/lib/engine/engine_audio.js +23 -23
  59. package/lib/engine/engine_camera.d.ts +13 -13
  60. package/lib/engine/engine_camera.js +30 -30
  61. package/lib/engine/engine_components.d.ts +110 -110
  62. package/lib/engine/engine_components.js +380 -380
  63. package/lib/engine/engine_components_internal.d.ts +9 -9
  64. package/lib/engine/engine_components_internal.js +36 -36
  65. package/lib/engine/engine_constants.d.ts +10 -10
  66. package/lib/engine/engine_constants.js +41 -41
  67. package/lib/engine/engine_context.d.ts +345 -345
  68. package/lib/engine/engine_context.js +1515 -1515
  69. package/lib/engine/engine_context_registry.d.ts +71 -71
  70. package/lib/engine/engine_context_registry.js +117 -117
  71. package/lib/engine/engine_coroutine.d.ts +35 -35
  72. package/lib/engine/engine_coroutine.js +52 -52
  73. package/lib/engine/engine_create_objects.d.ts +118 -118
  74. package/lib/engine/engine_create_objects.js +308 -308
  75. package/lib/engine/engine_default_parameters.d.ts +2 -2
  76. package/lib/engine/engine_default_parameters.js +3 -3
  77. package/lib/engine/engine_editor-sync.d.ts +21 -21
  78. package/lib/engine/engine_editor-sync.js +4 -4
  79. package/lib/engine/engine_element.d.ts +113 -113
  80. package/lib/engine/engine_element.js +830 -830
  81. package/lib/engine/engine_element_attributes.d.ts +72 -72
  82. package/lib/engine/engine_element_attributes.js +1 -1
  83. package/lib/engine/engine_element_extras.d.ts +6 -6
  84. package/lib/engine/engine_element_extras.js +13 -13
  85. package/lib/engine/engine_element_loading.d.ts +44 -44
  86. package/lib/engine/engine_element_loading.js +349 -349
  87. package/lib/engine/engine_element_overlay.d.ts +21 -21
  88. package/lib/engine/engine_element_overlay.js +166 -166
  89. package/lib/engine/engine_fileloader.d.ts +2 -2
  90. package/lib/engine/engine_fileloader.js +8 -8
  91. package/lib/engine/engine_gameobject.d.ts +68 -68
  92. package/lib/engine/engine_gameobject.js +591 -591
  93. package/lib/engine/engine_generic_utils.d.ts +1 -1
  94. package/lib/engine/engine_generic_utils.js +13 -13
  95. package/lib/engine/engine_gizmos.d.ts +149 -149
  96. package/lib/engine/engine_gizmos.js +530 -530
  97. package/lib/engine/engine_gltf.d.ts +12 -12
  98. package/lib/engine/engine_gltf.js +15 -15
  99. package/lib/engine/engine_gltf_builtin_components.d.ts +7 -7
  100. package/lib/engine/engine_gltf_builtin_components.js +341 -341
  101. package/lib/engine/engine_hot_reload.d.ts +7 -7
  102. package/lib/engine/engine_hot_reload.js +184 -184
  103. package/lib/engine/engine_input.d.ts +352 -352
  104. package/lib/engine/engine_input.js +1265 -1265
  105. package/lib/engine/engine_input_utils.d.ts +2 -2
  106. package/lib/engine/engine_input_utils.js +22 -22
  107. package/lib/engine/engine_instancing.d.ts +19 -19
  108. package/lib/engine/engine_instancing.js +39 -39
  109. package/lib/engine/engine_license.d.ts +9 -9
  110. package/lib/engine/engine_license.js +320 -320
  111. package/lib/engine/engine_lifecycle_api.d.ts +76 -76
  112. package/lib/engine/engine_lifecycle_api.js +99 -99
  113. package/lib/engine/engine_lifecycle_functions_internal.d.ts +32 -32
  114. package/lib/engine/engine_lifecycle_functions_internal.js +146 -146
  115. package/lib/engine/engine_lightdata.d.ts +23 -23
  116. package/lib/engine/engine_lightdata.js +91 -91
  117. package/lib/engine/engine_loaders.d.ts +13 -13
  118. package/lib/engine/engine_loaders.js +62 -62
  119. package/lib/engine/engine_lods.d.ts +31 -31
  120. package/lib/engine/engine_lods.js +146 -146
  121. package/lib/engine/engine_mainloop_utils.d.ts +32 -32
  122. package/lib/engine/engine_mainloop_utils.js +466 -466
  123. package/lib/engine/engine_math.d.ts +114 -114
  124. package/lib/engine/engine_math.js +247 -247
  125. package/lib/engine/engine_modules.d.ts +36 -36
  126. package/lib/engine/engine_modules.js +85 -85
  127. package/lib/engine/engine_networking.d.ts +252 -252
  128. package/lib/engine/engine_networking.js +743 -743
  129. package/lib/engine/engine_networking_auto.d.ts +24 -24
  130. package/lib/engine/engine_networking_auto.js +310 -310
  131. package/lib/engine/engine_networking_blob.d.ts +48 -48
  132. package/lib/engine/engine_networking_blob.js +212 -212
  133. package/lib/engine/engine_networking_files.d.ts +35 -35
  134. package/lib/engine/engine_networking_files.js +172 -172
  135. package/lib/engine/engine_networking_files_default_components.d.ts +6 -6
  136. package/lib/engine/engine_networking_files_default_components.js +42 -42
  137. package/lib/engine/engine_networking_instantiate.d.ts +100 -100
  138. package/lib/engine/engine_networking_instantiate.js +345 -345
  139. package/lib/engine/engine_networking_peer.d.ts +15 -15
  140. package/lib/engine/engine_networking_peer.js +132 -132
  141. package/lib/engine/engine_networking_streams.d.ts +123 -123
  142. package/lib/engine/engine_networking_streams.js +645 -645
  143. package/lib/engine/engine_networking_types.d.ts +22 -22
  144. package/lib/engine/engine_networking_types.js +7 -7
  145. package/lib/engine/engine_networking_utils.d.ts +2 -2
  146. package/lib/engine/engine_networking_utils.js +20 -20
  147. package/lib/engine/engine_networking_websocket.d.ts +1 -1
  148. package/lib/engine/engine_networking_websocket.js +2 -2
  149. package/lib/engine/engine_patcher.d.ts +10 -10
  150. package/lib/engine/engine_patcher.js +142 -142
  151. package/lib/engine/engine_physics.d.ts +152 -152
  152. package/lib/engine/engine_physics.js +645 -645
  153. package/lib/engine/engine_physics.types.d.ts +40 -40
  154. package/lib/engine/engine_physics.types.js +33 -33
  155. package/lib/engine/engine_physics_rapier.d.ts +147 -147
  156. package/lib/engine/engine_physics_rapier.js +1432 -1432
  157. package/lib/engine/engine_playerview.d.ts +26 -26
  158. package/lib/engine/engine_playerview.js +64 -64
  159. package/lib/engine/engine_scenelighting.d.ts +71 -71
  160. package/lib/engine/engine_scenelighting.js +226 -226
  161. package/lib/engine/engine_scenetools.d.ts +50 -50
  162. package/lib/engine/engine_scenetools.js +321 -321
  163. package/lib/engine/engine_serialization.d.ts +3 -3
  164. package/lib/engine/engine_serialization.js +3 -3
  165. package/lib/engine/engine_serialization_builtin_serializer.d.ts +72 -72
  166. package/lib/engine/engine_serialization_builtin_serializer.js +403 -403
  167. package/lib/engine/engine_serialization_core.d.ts +85 -85
  168. package/lib/engine/engine_serialization_core.js +602 -602
  169. package/lib/engine/engine_serialization_decorator.d.ts +23 -23
  170. package/lib/engine/engine_serialization_decorator.js +66 -66
  171. package/lib/engine/engine_setup.d.ts +1 -1
  172. package/lib/engine/engine_setup.js +2 -2
  173. package/lib/engine/engine_shaders.d.ts +53 -53
  174. package/lib/engine/engine_shaders.js +252 -252
  175. package/lib/engine/engine_shims.d.ts +4 -4
  176. package/lib/engine/engine_shims.js +24 -24
  177. package/lib/engine/engine_test_utils.d.ts +39 -39
  178. package/lib/engine/engine_test_utils.js +83 -83
  179. package/lib/engine/engine_texture.d.ts +28 -28
  180. package/lib/engine/engine_texture.js +64 -64
  181. package/lib/engine/engine_three_utils.d.ts +201 -201
  182. package/lib/engine/engine_three_utils.js +731 -731
  183. package/lib/engine/engine_time.d.ts +51 -51
  184. package/lib/engine/engine_time.js +82 -82
  185. package/lib/engine/engine_time_utils.d.ts +88 -88
  186. package/lib/engine/engine_time_utils.js +215 -215
  187. package/lib/engine/engine_tonemapping.d.ts +2 -2
  188. package/lib/engine/engine_tonemapping.js +194 -194
  189. package/lib/engine/engine_types.d.ts +572 -572
  190. package/lib/engine/engine_types.js +88 -88
  191. package/lib/engine/engine_typestore.d.ts +28 -28
  192. package/lib/engine/engine_typestore.js +55 -55
  193. package/lib/engine/engine_util_decorator.d.ts +13 -13
  194. package/lib/engine/engine_util_decorator.js +116 -116
  195. package/lib/engine/engine_utils.d.ts +266 -266
  196. package/lib/engine/engine_utils.js +878 -878
  197. package/lib/engine/engine_utils_format.d.ts +21 -21
  198. package/lib/engine/engine_utils_format.js +193 -193
  199. package/lib/engine/engine_utils_screenshot.d.ts +159 -159
  200. package/lib/engine/engine_utils_screenshot.js +513 -513
  201. package/lib/engine/engine_utils_screenshot.xr.d.ts +5 -5
  202. package/lib/engine/engine_utils_screenshot.xr.js +90 -90
  203. package/lib/engine/engine_xr.d.ts +1 -1
  204. package/lib/engine/engine_xr.js +1 -1
  205. package/lib/engine/export/gltf/Writers.d.ts +19 -19
  206. package/lib/engine/export/gltf/Writers.js +24 -24
  207. package/lib/engine/export/gltf/index.d.ts +11 -11
  208. package/lib/engine/export/gltf/index.js +123 -123
  209. package/lib/engine/export/index.d.ts +2 -2
  210. package/lib/engine/export/index.js +2 -2
  211. package/lib/engine/export/state.d.ts +7 -7
  212. package/lib/engine/export/state.js +17 -17
  213. package/lib/engine/export/utils.d.ts +2 -2
  214. package/lib/engine/export/utils.js +7 -7
  215. package/lib/engine/extensions/EXT_texture_exr.d.ts +8 -8
  216. package/lib/engine/extensions/EXT_texture_exr.js +32 -32
  217. package/lib/engine/extensions/NEEDLE_animator_controller_model.d.ts +122 -122
  218. package/lib/engine/extensions/NEEDLE_animator_controller_model.js +95 -95
  219. package/lib/engine/extensions/NEEDLE_components.d.ts +35 -35
  220. package/lib/engine/extensions/NEEDLE_components.js +220 -220
  221. package/lib/engine/extensions/NEEDLE_gameobject_data.d.ts +10 -10
  222. package/lib/engine/extensions/NEEDLE_gameobject_data.js +57 -57
  223. package/lib/engine/extensions/NEEDLE_lighting_settings.d.ts +37 -37
  224. package/lib/engine/extensions/NEEDLE_lighting_settings.js +157 -157
  225. package/lib/engine/extensions/NEEDLE_lightmaps.d.ts +18 -18
  226. package/lib/engine/extensions/NEEDLE_lightmaps.js +99 -99
  227. package/lib/engine/extensions/NEEDLE_persistent_assets.d.ts +11 -11
  228. package/lib/engine/extensions/NEEDLE_persistent_assets.js +63 -63
  229. package/lib/engine/extensions/NEEDLE_progressive.d.ts +1 -1
  230. package/lib/engine/extensions/NEEDLE_progressive.js +1 -1
  231. package/lib/engine/extensions/NEEDLE_render_objects.d.ts +13 -13
  232. package/lib/engine/extensions/NEEDLE_render_objects.js +159 -159
  233. package/lib/engine/extensions/NEEDLE_techniques_webgl.d.ts +38 -38
  234. package/lib/engine/extensions/NEEDLE_techniques_webgl.js +564 -564
  235. package/lib/engine/extensions/extension_resolver.d.ts +4 -4
  236. package/lib/engine/extensions/extension_resolver.js +1 -1
  237. package/lib/engine/extensions/extension_utils.d.ts +12 -12
  238. package/lib/engine/extensions/extension_utils.js +152 -152
  239. package/lib/engine/extensions/extensions.d.ts +31 -31
  240. package/lib/engine/extensions/extensions.js +103 -103
  241. package/lib/engine/extensions/index.d.ts +6 -6
  242. package/lib/engine/extensions/index.js +6 -6
  243. package/lib/engine/extensions/usage_tracker.d.ts +13 -13
  244. package/lib/engine/extensions/usage_tracker.js +65 -65
  245. package/lib/engine/js-extensions/Camera.d.ts +1 -1
  246. package/lib/engine/js-extensions/Camera.js +39 -39
  247. package/lib/engine/js-extensions/ExtensionUtils.d.ts +9 -9
  248. package/lib/engine/js-extensions/ExtensionUtils.js +67 -67
  249. package/lib/engine/js-extensions/Layers.d.ts +6 -6
  250. package/lib/engine/js-extensions/Layers.js +22 -22
  251. package/lib/engine/js-extensions/Object3D.d.ts +120 -120
  252. package/lib/engine/js-extensions/Object3D.js +136 -136
  253. package/lib/engine/js-extensions/RGBAColor.d.ts +22 -22
  254. package/lib/engine/js-extensions/RGBAColor.js +62 -62
  255. package/lib/engine/js-extensions/Vector.d.ts +3 -3
  256. package/lib/engine/js-extensions/Vector.js +13 -13
  257. package/lib/engine/js-extensions/index.d.ts +5 -5
  258. package/lib/engine/js-extensions/index.js +5 -5
  259. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.d.ts +4 -4
  260. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +75 -75
  261. package/lib/engine/shaders/shaderData.d.ts +55 -55
  262. package/lib/engine/shaders/shaderData.js +58 -58
  263. package/lib/engine/tests/test_utils.d.ts +2 -2
  264. package/lib/engine/tests/test_utils.js +53 -53
  265. package/lib/engine/webcomponents/WebXRButtons.d.ts +56 -56
  266. package/lib/engine/webcomponents/WebXRButtons.js +230 -230
  267. package/lib/engine/webcomponents/api.d.ts +5 -5
  268. package/lib/engine/webcomponents/api.js +4 -4
  269. package/lib/engine/webcomponents/buttons.d.ts +39 -39
  270. package/lib/engine/webcomponents/buttons.js +237 -237
  271. package/lib/engine/webcomponents/fonts.d.ts +9 -9
  272. package/lib/engine/webcomponents/fonts.js +32 -32
  273. package/lib/engine/webcomponents/icons.d.ts +9 -9
  274. package/lib/engine/webcomponents/icons.js +52 -52
  275. package/lib/engine/webcomponents/index.d.ts +1 -1
  276. package/lib/engine/webcomponents/index.js +1 -1
  277. package/lib/engine/webcomponents/logo-element.d.ts +10 -10
  278. package/lib/engine/webcomponents/logo-element.js +67 -67
  279. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.d.ts +37 -37
  280. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.js +513 -513
  281. package/lib/engine/webcomponents/needle menu/needle-menu.d.ts +151 -151
  282. package/lib/engine/webcomponents/needle menu/needle-menu.js +1018 -1018
  283. package/lib/engine/webcomponents/needle-button.d.ts +34 -34
  284. package/lib/engine/webcomponents/needle-button.js +161 -161
  285. package/lib/engine/xr/NeedleXRController.d.ts +313 -313
  286. package/lib/engine/xr/NeedleXRController.js +1008 -1008
  287. package/lib/engine/xr/NeedleXRSession.d.ts +339 -339
  288. package/lib/engine/xr/NeedleXRSession.js +1427 -1427
  289. package/lib/engine/xr/NeedleXRSync.d.ts +22 -22
  290. package/lib/engine/xr/NeedleXRSync.js +188 -188
  291. package/lib/engine/xr/SceneTransition.d.ts +18 -18
  292. package/lib/engine/xr/SceneTransition.js +69 -69
  293. package/lib/engine/xr/TempXRContext.d.ts +34 -34
  294. package/lib/engine/xr/TempXRContext.js +187 -187
  295. package/lib/engine/xr/XRRig.d.ts +7 -7
  296. package/lib/engine/xr/XRRig.js +1 -1
  297. package/lib/engine/xr/api.d.ts +6 -6
  298. package/lib/engine/xr/api.js +6 -6
  299. package/lib/engine/xr/events.d.ts +66 -66
  300. package/lib/engine/xr/events.js +93 -93
  301. package/lib/engine/xr/internal.d.ts +12 -12
  302. package/lib/engine/xr/internal.js +25 -25
  303. package/lib/engine/xr/usdz.d.ts +12 -12
  304. package/lib/engine/xr/usdz.js +29 -29
  305. package/lib/engine/xr/utils.d.ts +11 -11
  306. package/lib/engine/xr/utils.js +34 -34
  307. package/lib/engine-components/AlignmentConstraint.d.ts +10 -10
  308. package/lib/engine-components/AlignmentConstraint.js +39 -39
  309. package/lib/engine-components/Animation.d.ts +156 -156
  310. package/lib/engine-components/Animation.js +508 -508
  311. package/lib/engine-components/AnimationCurve.d.ts +40 -40
  312. package/lib/engine-components/AnimationCurve.js +159 -159
  313. package/lib/engine-components/AnimationUtils.d.ts +8 -8
  314. package/lib/engine-components/AnimationUtils.js +27 -27
  315. package/lib/engine-components/AnimationUtilsAutoplay.d.ts +1 -1
  316. package/lib/engine-components/AnimationUtilsAutoplay.js +39 -39
  317. package/lib/engine-components/Animator.d.ts +217 -217
  318. package/lib/engine-components/Animator.js +354 -354
  319. package/lib/engine-components/AnimatorController.d.ts +227 -227
  320. package/lib/engine-components/AnimatorController.js +1152 -1152
  321. package/lib/engine-components/AudioListener.d.ts +33 -33
  322. package/lib/engine-components/AudioListener.js +86 -86
  323. package/lib/engine-components/AudioSource.d.ts +217 -217
  324. package/lib/engine-components/AudioSource.js +627 -627
  325. package/lib/engine-components/AvatarLoader.d.ts +80 -80
  326. package/lib/engine-components/AvatarLoader.js +231 -231
  327. package/lib/engine-components/AxesHelper.d.ts +32 -32
  328. package/lib/engine-components/AxesHelper.js +67 -67
  329. package/lib/engine-components/BasicIKConstraint.d.ts +9 -9
  330. package/lib/engine-components/BasicIKConstraint.js +43 -43
  331. package/lib/engine-components/BoxCollider.d.ts +2 -2
  332. package/lib/engine-components/BoxCollider.js +2 -2
  333. package/lib/engine-components/BoxHelperComponent.d.ts +47 -47
  334. package/lib/engine-components/BoxHelperComponent.js +102 -102
  335. package/lib/engine-components/Camera.d.ts +231 -231
  336. package/lib/engine-components/Camera.js +694 -694
  337. package/lib/engine-components/CameraUtils.d.ts +1 -1
  338. package/lib/engine-components/CameraUtils.js +127 -127
  339. package/lib/engine-components/CharacterController.d.ts +55 -55
  340. package/lib/engine-components/CharacterController.js +236 -236
  341. package/lib/engine-components/Collider.d.ts +188 -188
  342. package/lib/engine-components/Collider.js +369 -369
  343. package/lib/engine-components/Component.d.ts +792 -792
  344. package/lib/engine-components/Component.js +915 -915
  345. package/lib/engine-components/ContactShadows.d.ts +82 -82
  346. package/lib/engine-components/ContactShadows.js +430 -430
  347. package/lib/engine-components/DeleteBox.d.ts +19 -19
  348. package/lib/engine-components/DeleteBox.js +58 -58
  349. package/lib/engine-components/DeviceFlag.d.ts +16 -16
  350. package/lib/engine-components/DeviceFlag.js +47 -47
  351. package/lib/engine-components/DragControls.d.ts +170 -170
  352. package/lib/engine-components/DragControls.js +1421 -1421
  353. package/lib/engine-components/DropListener.d.ts +215 -215
  354. package/lib/engine-components/DropListener.js +630 -630
  355. package/lib/engine-components/Duplicatable.d.ts +35 -35
  356. package/lib/engine-components/Duplicatable.js +202 -202
  357. package/lib/engine-components/EventList.d.ts +54 -54
  358. package/lib/engine-components/EventList.js +232 -232
  359. package/lib/engine-components/EventTrigger.d.ts +33 -33
  360. package/lib/engine-components/EventTrigger.js +75 -75
  361. package/lib/engine-components/EventType.d.ts +22 -22
  362. package/lib/engine-components/EventType.js +23 -23
  363. package/lib/engine-components/Fog.d.ts +22 -22
  364. package/lib/engine-components/Fog.js +61 -61
  365. package/lib/engine-components/Gizmos.d.ts +17 -17
  366. package/lib/engine-components/Gizmos.js +64 -64
  367. package/lib/engine-components/GridHelper.d.ts +20 -20
  368. package/lib/engine-components/GridHelper.js +54 -54
  369. package/lib/engine-components/GroundProjection.d.ts +67 -67
  370. package/lib/engine-components/GroundProjection.js +343 -343
  371. package/lib/engine-components/Interactable.d.ts +12 -12
  372. package/lib/engine-components/Interactable.js +12 -12
  373. package/lib/engine-components/Joints.d.ts +19 -19
  374. package/lib/engine-components/Joints.js +51 -51
  375. package/lib/engine-components/LODGroup.d.ts +35 -35
  376. package/lib/engine-components/LODGroup.js +152 -152
  377. package/lib/engine-components/Light.d.ts +180 -180
  378. package/lib/engine-components/Light.js +535 -535
  379. package/lib/engine-components/LookAtConstraint.d.ts +19 -19
  380. package/lib/engine-components/LookAtConstraint.js +35 -35
  381. package/lib/engine-components/NeedleMenu.d.ts +50 -50
  382. package/lib/engine-components/NeedleMenu.js +92 -92
  383. package/lib/engine-components/NestedGltf.d.ts +25 -25
  384. package/lib/engine-components/NestedGltf.js +88 -88
  385. package/lib/engine-components/Networking.d.ts +54 -54
  386. package/lib/engine-components/Networking.js +112 -112
  387. package/lib/engine-components/OffsetConstraint.d.ts +14 -14
  388. package/lib/engine-components/OffsetConstraint.js +65 -65
  389. package/lib/engine-components/OrbitControls.d.ts +266 -266
  390. package/lib/engine-components/OrbitControls.js +1009 -1009
  391. package/lib/engine-components/PlayerColor.d.ts +19 -19
  392. package/lib/engine-components/PlayerColor.js +94 -94
  393. package/lib/engine-components/ReflectionProbe.d.ts +26 -26
  394. package/lib/engine-components/ReflectionProbe.js +194 -194
  395. package/lib/engine-components/Renderer.d.ts +153 -153
  396. package/lib/engine-components/Renderer.js +830 -830
  397. package/lib/engine-components/RendererInstancing.d.ts +140 -140
  398. package/lib/engine-components/RendererInstancing.js +744 -744
  399. package/lib/engine-components/RendererLightmap.d.ts +24 -24
  400. package/lib/engine-components/RendererLightmap.js +182 -182
  401. package/lib/engine-components/RigidBody.d.ts +155 -155
  402. package/lib/engine-components/RigidBody.js +517 -517
  403. package/lib/engine-components/SceneSwitcher.d.ts +263 -263
  404. package/lib/engine-components/SceneSwitcher.js +951 -951
  405. package/lib/engine-components/ScreenCapture.d.ts +144 -144
  406. package/lib/engine-components/ScreenCapture.js +547 -547
  407. package/lib/engine-components/ShadowCatcher.d.ts +33 -33
  408. package/lib/engine-components/ShadowCatcher.js +166 -166
  409. package/lib/engine-components/Skybox.d.ts +82 -82
  410. package/lib/engine-components/Skybox.js +448 -448
  411. package/lib/engine-components/SmoothFollow.d.ts +34 -34
  412. package/lib/engine-components/SmoothFollow.js +82 -82
  413. package/lib/engine-components/SpatialTrigger.d.ts +102 -102
  414. package/lib/engine-components/SpatialTrigger.js +225 -225
  415. package/lib/engine-components/SpectatorCamera.d.ts +111 -111
  416. package/lib/engine-components/SpectatorCamera.js +715 -715
  417. package/lib/engine-components/SphereCollider.d.ts +2 -2
  418. package/lib/engine-components/SphereCollider.js +2 -2
  419. package/lib/engine-components/SpriteRenderer.d.ts +132 -132
  420. package/lib/engine-components/SpriteRenderer.js +472 -472
  421. package/lib/engine-components/SyncedCamera.d.ts +41 -41
  422. package/lib/engine-components/SyncedCamera.js +199 -199
  423. package/lib/engine-components/SyncedRoom.d.ts +106 -106
  424. package/lib/engine-components/SyncedRoom.js +371 -371
  425. package/lib/engine-components/SyncedTransform.d.ts +88 -88
  426. package/lib/engine-components/SyncedTransform.js +326 -326
  427. package/lib/engine-components/TestRunner.d.ts +16 -16
  428. package/lib/engine-components/TestRunner.js +102 -102
  429. package/lib/engine-components/TransformGizmo.d.ts +75 -75
  430. package/lib/engine-components/TransformGizmo.js +209 -209
  431. package/lib/engine-components/VideoPlayer.d.ts +184 -184
  432. package/lib/engine-components/VideoPlayer.js +978 -978
  433. package/lib/engine-components/Voip.d.ts +67 -67
  434. package/lib/engine-components/Voip.js +360 -360
  435. package/lib/engine-components/api.d.ts +51 -51
  436. package/lib/engine-components/api.js +50 -50
  437. package/lib/engine-components/avatar/AvatarBlink_Simple.d.ts +11 -11
  438. package/lib/engine-components/avatar/AvatarBlink_Simple.js +76 -76
  439. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.d.ts +14 -14
  440. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.js +68 -68
  441. package/lib/engine-components/avatar/Avatar_Brain_LookAt.d.ts +29 -29
  442. package/lib/engine-components/avatar/Avatar_Brain_LookAt.js +121 -121
  443. package/lib/engine-components/avatar/Avatar_MouthShapes.d.ts +15 -15
  444. package/lib/engine-components/avatar/Avatar_MouthShapes.js +79 -79
  445. package/lib/engine-components/avatar/Avatar_MustacheShake.d.ts +9 -9
  446. package/lib/engine-components/avatar/Avatar_MustacheShake.js +29 -29
  447. package/lib/engine-components/codegen/components.d.ts +215 -215
  448. package/lib/engine-components/codegen/components.js +217 -217
  449. package/lib/engine-components/debug/LogStats.d.ts +5 -5
  450. package/lib/engine-components/debug/LogStats.js +18 -18
  451. package/lib/engine-components/export/gltf/GltfExport.d.ts +30 -30
  452. package/lib/engine-components/export/gltf/GltfExport.js +246 -246
  453. package/lib/engine-components/export/gltf/index.d.ts +1 -1
  454. package/lib/engine-components/export/gltf/index.js +1 -1
  455. package/lib/engine-components/export/index.d.ts +1 -1
  456. package/lib/engine-components/export/index.js +1 -1
  457. package/lib/engine-components/export/usdz/Extension.d.ts +22 -22
  458. package/lib/engine-components/export/usdz/Extension.js +1 -1
  459. package/lib/engine-components/export/usdz/ThreeUSDZExporter.d.ts +160 -160
  460. package/lib/engine-components/export/usdz/ThreeUSDZExporter.js +1782 -1782
  461. package/lib/engine-components/export/usdz/USDZExporter.d.ts +130 -130
  462. package/lib/engine-components/export/usdz/USDZExporter.js +663 -663
  463. package/lib/engine-components/export/usdz/extensions/Animation.d.ts +106 -106
  464. package/lib/engine-components/export/usdz/extensions/Animation.js +1071 -1071
  465. package/lib/engine-components/export/usdz/extensions/DocumentExtension.d.ts +5 -5
  466. package/lib/engine-components/export/usdz/extensions/DocumentExtension.js +6 -6
  467. package/lib/engine-components/export/usdz/extensions/USDZText.d.ts +54 -54
  468. package/lib/engine-components/export/usdz/extensions/USDZText.js +203 -203
  469. package/lib/engine-components/export/usdz/extensions/USDZUI.d.ts +8 -8
  470. package/lib/engine-components/export/usdz/extensions/USDZUI.js +157 -157
  471. package/lib/engine-components/export/usdz/extensions/behavior/Actions.d.ts +30 -30
  472. package/lib/engine-components/export/usdz/extensions/behavior/Actions.js +88 -88
  473. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.d.ts +10 -10
  474. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.js +86 -86
  475. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.d.ts +28 -28
  476. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.js +290 -290
  477. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.d.ts +190 -190
  478. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.js +1060 -1060
  479. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.d.ts +135 -135
  480. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.js +548 -548
  481. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.d.ts +7 -7
  482. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.js +115 -115
  483. package/lib/engine-components/export/usdz/index.d.ts +3 -3
  484. package/lib/engine-components/export/usdz/index.js +2 -2
  485. package/lib/engine-components/export/usdz/utils/animationutils.d.ts +7 -7
  486. package/lib/engine-components/export/usdz/utils/animationutils.js +163 -163
  487. package/lib/engine-components/export/usdz/utils/quicklook.d.ts +2 -2
  488. package/lib/engine-components/export/usdz/utils/quicklook.js +43 -43
  489. package/lib/engine-components/particlesystem/ParticleSystem.d.ts +177 -177
  490. package/lib/engine-components/particlesystem/ParticleSystem.js +1176 -1176
  491. package/lib/engine-components/particlesystem/ParticleSystemModules.d.ts +526 -526
  492. package/lib/engine-components/particlesystem/ParticleSystemModules.js +1930 -1930
  493. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.d.ts +25 -25
  494. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.js +87 -87
  495. package/lib/engine-components/particlesystem/api.d.ts +2 -2
  496. package/lib/engine-components/particlesystem/api.js +2 -2
  497. package/lib/engine-components/postprocessing/Effects/Antialiasing.d.ts +17 -17
  498. package/lib/engine-components/postprocessing/Effects/Antialiasing.js +50 -50
  499. package/lib/engine-components/postprocessing/Effects/BloomEffect.d.ts +46 -46
  500. package/lib/engine-components/postprocessing/Effects/BloomEffect.js +113 -113
  501. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.d.ts +11 -11
  502. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.js +39 -39
  503. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.d.ts +15 -15
  504. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.js +92 -92
  505. package/lib/engine-components/postprocessing/Effects/DepthOfField.d.ts +25 -25
  506. package/lib/engine-components/postprocessing/Effects/DepthOfField.js +104 -104
  507. package/lib/engine-components/postprocessing/Effects/EffectWrapper.d.ts +12 -12
  508. package/lib/engine-components/postprocessing/Effects/EffectWrapper.js +18 -18
  509. package/lib/engine-components/postprocessing/Effects/Pixelation.d.ts +11 -11
  510. package/lib/engine-components/postprocessing/Effects/Pixelation.js +32 -32
  511. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.d.ts +18 -18
  512. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.js +91 -91
  513. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.d.ts +70 -70
  514. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.js +175 -175
  515. package/lib/engine-components/postprocessing/Effects/Sharpening.d.ts +17 -17
  516. package/lib/engine-components/postprocessing/Effects/Sharpening.js +123 -123
  517. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.d.ts +17 -17
  518. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.js +70 -70
  519. package/lib/engine-components/postprocessing/Effects/Tonemapping.d.ts +26 -26
  520. package/lib/engine-components/postprocessing/Effects/Tonemapping.js +138 -138
  521. package/lib/engine-components/postprocessing/Effects/Vignette.d.ts +15 -15
  522. package/lib/engine-components/postprocessing/Effects/Vignette.js +60 -60
  523. package/lib/engine-components/postprocessing/PostProcessingEffect.d.ts +72 -72
  524. package/lib/engine-components/postprocessing/PostProcessingEffect.js +149 -149
  525. package/lib/engine-components/postprocessing/PostProcessingHandler.d.ts +25 -25
  526. package/lib/engine-components/postprocessing/PostProcessingHandler.js +350 -350
  527. package/lib/engine-components/postprocessing/Volume.d.ts +89 -89
  528. package/lib/engine-components/postprocessing/Volume.js +367 -367
  529. package/lib/engine-components/postprocessing/VolumeParameter.d.ts +26 -26
  530. package/lib/engine-components/postprocessing/VolumeParameter.js +136 -136
  531. package/lib/engine-components/postprocessing/VolumeProfile.d.ts +15 -15
  532. package/lib/engine-components/postprocessing/VolumeProfile.js +60 -60
  533. package/lib/engine-components/postprocessing/index.d.ts +5 -5
  534. package/lib/engine-components/postprocessing/index.js +5 -5
  535. package/lib/engine-components/postprocessing/utils.d.ts +11 -11
  536. package/lib/engine-components/postprocessing/utils.js +37 -37
  537. package/lib/engine-components/timeline/PlayableDirector.d.ts +163 -163
  538. package/lib/engine-components/timeline/PlayableDirector.js +686 -686
  539. package/lib/engine-components/timeline/SignalAsset.d.ts +24 -24
  540. package/lib/engine-components/timeline/SignalAsset.js +130 -130
  541. package/lib/engine-components/timeline/TimelineModels.d.ts +89 -89
  542. package/lib/engine-components/timeline/TimelineModels.js +22 -22
  543. package/lib/engine-components/timeline/TimelineTracks.d.ts +110 -110
  544. package/lib/engine-components/timeline/TimelineTracks.js +879 -879
  545. package/lib/engine-components/timeline/index.d.ts +4 -4
  546. package/lib/engine-components/timeline/index.js +3 -3
  547. package/lib/engine-components/ui/BaseUIComponent.d.ts +49 -49
  548. package/lib/engine-components/ui/BaseUIComponent.js +170 -170
  549. package/lib/engine-components/ui/Button.d.ts +64 -64
  550. package/lib/engine-components/ui/Button.js +315 -315
  551. package/lib/engine-components/ui/Canvas.d.ts +74 -74
  552. package/lib/engine-components/ui/Canvas.js +407 -407
  553. package/lib/engine-components/ui/CanvasGroup.d.ts +19 -19
  554. package/lib/engine-components/ui/CanvasGroup.js +58 -58
  555. package/lib/engine-components/ui/EventSystem.d.ts +125 -125
  556. package/lib/engine-components/ui/EventSystem.js +764 -764
  557. package/lib/engine-components/ui/Graphic.d.ts +55 -55
  558. package/lib/engine-components/ui/Graphic.js +254 -254
  559. package/lib/engine-components/ui/Image.d.ts +35 -35
  560. package/lib/engine-components/ui/Image.js +116 -116
  561. package/lib/engine-components/ui/InputField.d.ts +42 -42
  562. package/lib/engine-components/ui/InputField.js +268 -268
  563. package/lib/engine-components/ui/Interfaces.d.ts +38 -38
  564. package/lib/engine-components/ui/Interfaces.js +12 -12
  565. package/lib/engine-components/ui/Layout.d.ts +84 -84
  566. package/lib/engine-components/ui/Layout.js +330 -330
  567. package/lib/engine-components/ui/Outline.d.ts +7 -7
  568. package/lib/engine-components/ui/Outline.js +20 -20
  569. package/lib/engine-components/ui/PointerEvents.d.ts +115 -115
  570. package/lib/engine-components/ui/PointerEvents.js +145 -145
  571. package/lib/engine-components/ui/RaycastUtils.d.ts +11 -11
  572. package/lib/engine-components/ui/RaycastUtils.js +67 -67
  573. package/lib/engine-components/ui/Raycaster.d.ts +30 -30
  574. package/lib/engine-components/ui/Raycaster.js +95 -95
  575. package/lib/engine-components/ui/RectTransform.d.ts +61 -61
  576. package/lib/engine-components/ui/RectTransform.js +353 -353
  577. package/lib/engine-components/ui/SpatialHtml.d.ts +8 -8
  578. package/lib/engine-components/ui/SpatialHtml.js +79 -79
  579. package/lib/engine-components/ui/Text.d.ts +78 -78
  580. package/lib/engine-components/ui/Text.js +539 -539
  581. package/lib/engine-components/ui/Utils.d.ts +24 -24
  582. package/lib/engine-components/ui/Utils.js +90 -90
  583. package/lib/engine-components/ui/index.d.ts +1 -1
  584. package/lib/engine-components/ui/index.js +1 -1
  585. package/lib/engine-components/utils/EnvironmentScene.d.ts +5 -5
  586. package/lib/engine-components/utils/EnvironmentScene.js +205 -205
  587. package/lib/engine-components/utils/LookAt.d.ts +31 -31
  588. package/lib/engine-components/utils/LookAt.js +82 -82
  589. package/lib/engine-components/utils/OpenURL.d.ts +42 -42
  590. package/lib/engine-components/utils/OpenURL.js +119 -119
  591. package/lib/engine-components/webxr/Avatar.d.ts +25 -25
  592. package/lib/engine-components/webxr/Avatar.js +255 -255
  593. package/lib/engine-components/webxr/TeleportTarget.d.ts +7 -7
  594. package/lib/engine-components/webxr/TeleportTarget.js +7 -7
  595. package/lib/engine-components/webxr/WebARCameraBackground.d.ts +30 -30
  596. package/lib/engine-components/webxr/WebARCameraBackground.js +155 -155
  597. package/lib/engine-components/webxr/WebARSessionRoot.d.ts +98 -98
  598. package/lib/engine-components/webxr/WebARSessionRoot.js +770 -770
  599. package/lib/engine-components/webxr/WebXR.d.ts +232 -232
  600. package/lib/engine-components/webxr/WebXR.js +561 -561
  601. package/lib/engine-components/webxr/WebXRAvatar.d.ts +27 -27
  602. package/lib/engine-components/webxr/WebXRAvatar.js +44 -44
  603. package/lib/engine-components/webxr/WebXRImageTracking.d.ts +86 -86
  604. package/lib/engine-components/webxr/WebXRImageTracking.js +470 -470
  605. package/lib/engine-components/webxr/WebXRPlaneTracking.d.ts +92 -92
  606. package/lib/engine-components/webxr/WebXRPlaneTracking.js +500 -500
  607. package/lib/engine-components/webxr/WebXRRig.d.ts +32 -32
  608. package/lib/engine-components/webxr/WebXRRig.js +72 -72
  609. package/lib/engine-components/webxr/XRFlag.d.ts +38 -38
  610. package/lib/engine-components/webxr/XRFlag.js +139 -139
  611. package/lib/engine-components/webxr/controllers/XRControllerFollow.d.ts +47 -47
  612. package/lib/engine-components/webxr/controllers/XRControllerFollow.js +120 -120
  613. package/lib/engine-components/webxr/controllers/XRControllerModel.d.ts +43 -43
  614. package/lib/engine-components/webxr/controllers/XRControllerModel.js +351 -351
  615. package/lib/engine-components/webxr/controllers/XRControllerMovement.d.ts +78 -78
  616. package/lib/engine-components/webxr/controllers/XRControllerMovement.js +506 -506
  617. package/lib/engine-components/webxr/index.d.ts +3 -3
  618. package/lib/engine-components/webxr/index.js +3 -3
  619. package/lib/engine-components/webxr/types.d.ts +3 -3
  620. package/lib/engine-components/webxr/types.js +1 -1
  621. package/lib/engine-components-experimental/Presentation.d.ts +6 -6
  622. package/lib/engine-components-experimental/Presentation.js +9 -9
  623. package/lib/engine-components-experimental/api.d.ts +4 -4
  624. package/lib/engine-components-experimental/api.js +4 -4
  625. package/lib/engine-components-experimental/networking/PlayerSync.d.ts +156 -156
  626. package/lib/engine-components-experimental/networking/PlayerSync.js +377 -377
  627. package/lib/engine-schemes/api.d.ts +12 -12
  628. package/lib/engine-schemes/api.js +12 -12
  629. package/lib/engine-schemes/schemes.d.ts +7 -7
  630. package/lib/engine-schemes/schemes.js +19 -19
  631. package/lib/engine-schemes/synced-camera-model.d.ts +25 -25
  632. package/lib/engine-schemes/synced-camera-model.js +67 -67
  633. package/lib/engine-schemes/synced-transform-model.d.ts +31 -31
  634. package/lib/engine-schemes/synced-transform-model.js +66 -66
  635. package/lib/engine-schemes/transform.d.ts +12 -12
  636. package/lib/engine-schemes/transform.js +39 -39
  637. package/lib/engine-schemes/vec2.d.ts +10 -10
  638. package/lib/engine-schemes/vec2.js +25 -25
  639. package/lib/engine-schemes/vec3.d.ts +11 -11
  640. package/lib/engine-schemes/vec3.js +29 -29
  641. package/lib/engine-schemes/vec4.d.ts +12 -12
  642. package/lib/engine-schemes/vec4.js +33 -33
  643. package/lib/engine-schemes/vr-user-state-buffer.d.ts +37 -37
  644. package/lib/engine-schemes/vr-user-state-buffer.js +110 -110
  645. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.d.ts +6 -6
  646. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.js +45 -45
  647. package/lib/needle-engine.d.ts +7 -7
  648. package/lib/needle-engine.js +64 -64
  649. package/package.json +1 -1
  650. package/plugins/common/buildinfo.js +64 -63
  651. package/plugins/common/cloud.js +2 -0
  652. package/plugins/common/config.cjs +31 -31
  653. package/plugins/common/config.js +35 -35
  654. package/plugins/common/files.js +31 -31
  655. package/plugins/common/generator.js +10 -10
  656. package/plugins/common/license.js +266 -224
  657. package/plugins/common/npm.js +15 -15
  658. package/plugins/common/timers.js +7 -7
  659. package/plugins/common/version.js +37 -37
  660. package/plugins/gltf-packer.mjs +1 -1
  661. package/plugins/next/alias.cjs +39 -39
  662. package/plugins/next/license.cjs +18 -18
  663. package/plugins/next/meshbvhworker.cjs +18 -18
  664. package/plugins/next/next.js +128 -128
  665. package/plugins/types/index.d.ts +2 -2
  666. package/plugins/types/license.d.ts +24 -24
  667. package/plugins/types/needleConfig.d.ts +27 -27
  668. package/plugins/types/userconfig.d.ts +105 -105
  669. package/plugins/types/webmanifest.d.ts +32 -32
  670. package/plugins/vite/alias.js +174 -174
  671. package/plugins/vite/asap.js +245 -245
  672. package/plugins/vite/build-pipeline.js +355 -354
  673. package/plugins/vite/build.js +19 -19
  674. package/plugins/vite/buildinfo.js +41 -41
  675. package/plugins/vite/config.js +106 -106
  676. package/plugins/vite/copyfiles.js +138 -138
  677. package/plugins/vite/defines.js +66 -66
  678. package/plugins/vite/dependencies.js +213 -213
  679. package/plugins/vite/dependency-watcher.js +231 -231
  680. package/plugins/vite/drop-client.js +76 -76
  681. package/plugins/vite/drop.js +87 -87
  682. package/plugins/vite/editor-connection.js +124 -124
  683. package/plugins/vite/facebook-instant-games.js +99 -99
  684. package/plugins/vite/gzip.js +5 -5
  685. package/plugins/vite/imports-logger.js +143 -143
  686. package/plugins/vite/index.js +139 -139
  687. package/plugins/vite/license.js +55 -55
  688. package/plugins/vite/meta.js +163 -163
  689. package/plugins/vite/npm.js +7 -7
  690. package/plugins/vite/peer.js +29 -29
  691. package/plugins/vite/poster-client.js +73 -73
  692. package/plugins/vite/poster.js +79 -79
  693. package/plugins/vite/pwa.js +604 -604
  694. package/plugins/vite/reload-client.js +15 -15
  695. package/plugins/vite/reload.js +363 -363
  696. package/plugins/vite/server.js +66 -66
  697. package/plugins/vite/transform-codegen.js +55 -55
  698. package/plugins/vite/transform.js +31 -31
  699. package/plugins/vite/vite-4.4-hack.js +31 -31
  700. package/src/asap/needle-asap.ts +111 -111
  701. package/src/asap/sessiongranted.ts +75 -75
  702. package/src/asap/utils.ts +4 -4
  703. package/src/engine/analytics/index.ts +10 -10
  704. package/src/engine/analytics/lcp.ts +35 -35
  705. package/src/engine/api.ts +81 -81
  706. package/src/engine/assets/index.ts +59 -59
  707. package/src/engine/assets/static.js +5 -5
  708. package/src/engine/codegen/register_types.ts +298 -298
  709. package/src/engine/debug/debug.ts +51 -51
  710. package/src/engine/debug/debug_console.ts +333 -333
  711. package/src/engine/debug/debug_overlay.ts +332 -332
  712. package/src/engine/debug/debug_spatial_console.ts +429 -429
  713. package/src/engine/debug/index.ts +1 -1
  714. package/src/engine/engine_addressables.ts +679 -679
  715. package/src/engine/engine_animation.ts +145 -145
  716. package/src/engine/engine_application.ts +113 -113
  717. package/src/engine/engine_assetdatabase.ts +387 -387
  718. package/src/engine/engine_audio.ts +24 -24
  719. package/src/engine/engine_camera.ts +39 -39
  720. package/src/engine/engine_components.ts +373 -373
  721. package/src/engine/engine_components_internal.ts +40 -40
  722. package/src/engine/engine_constants.ts +52 -52
  723. package/src/engine/engine_context.ts +1662 -1662
  724. package/src/engine/engine_context_registry.ts +129 -129
  725. package/src/engine/engine_coroutine.ts +54 -54
  726. package/src/engine/engine_create_objects.ts +398 -398
  727. package/src/engine/engine_default_parameters.ts +3 -3
  728. package/src/engine/engine_editor-sync.ts +28 -28
  729. package/src/engine/engine_element.ts +871 -871
  730. package/src/engine/engine_element_attributes.ts +85 -85
  731. package/src/engine/engine_element_extras.ts +16 -16
  732. package/src/engine/engine_element_loading.ts +381 -381
  733. package/src/engine/engine_element_overlay.ts +186 -186
  734. package/src/engine/engine_fileloader.js +9 -9
  735. package/src/engine/engine_gameobject.ts +684 -684
  736. package/src/engine/engine_generic_utils.js +13 -13
  737. package/src/engine/engine_gizmos.ts +577 -577
  738. package/src/engine/engine_gltf.ts +29 -29
  739. package/src/engine/engine_gltf_builtin_components.ts +403 -403
  740. package/src/engine/engine_hot_reload.ts +198 -198
  741. package/src/engine/engine_input.ts +1460 -1460
  742. package/src/engine/engine_input_utils.ts +23 -23
  743. package/src/engine/engine_instancing.ts +45 -45
  744. package/src/engine/engine_license.ts +329 -329
  745. package/src/engine/engine_lifecycle_api.ts +106 -106
  746. package/src/engine/engine_lifecycle_functions_internal.ts +193 -193
  747. package/src/engine/engine_lightdata.ts +117 -117
  748. package/src/engine/engine_loaders.ts +82 -82
  749. package/src/engine/engine_lods.ts +168 -168
  750. package/src/engine/engine_mainloop_utils.ts +472 -472
  751. package/src/engine/engine_math.ts +282 -282
  752. package/src/engine/engine_modules.ts +83 -83
  753. package/src/engine/engine_networking.ts +841 -841
  754. package/src/engine/engine_networking_auto.ts +352 -352
  755. package/src/engine/engine_networking_blob.ts +254 -254
  756. package/src/engine/engine_networking_files.ts +217 -217
  757. package/src/engine/engine_networking_files_default_components.ts +58 -58
  758. package/src/engine/engine_networking_instantiate.ts +419 -419
  759. package/src/engine/engine_networking_peer.ts +159 -159
  760. package/src/engine/engine_networking_streams.ts +713 -713
  761. package/src/engine/engine_networking_types.ts +24 -24
  762. package/src/engine/engine_networking_utils.ts +23 -23
  763. package/src/engine/engine_networking_websocket.ts +2 -2
  764. package/src/engine/engine_patcher.ts +199 -199
  765. package/src/engine/engine_physics.ts +783 -783
  766. package/src/engine/engine_physics.types.ts +46 -46
  767. package/src/engine/engine_physics_rapier.ts +1579 -1579
  768. package/src/engine/engine_playerview.ts +80 -80
  769. package/src/engine/engine_scenelighting.ts +294 -294
  770. package/src/engine/engine_scenetools.ts +365 -365
  771. package/src/engine/engine_serialization.ts +2 -2
  772. package/src/engine/engine_serialization_builtin_serializer.ts +473 -473
  773. package/src/engine/engine_serialization_core.ts +705 -705
  774. package/src/engine/engine_serialization_decorator.ts +80 -80
  775. package/src/engine/engine_setup.ts +1 -1
  776. package/src/engine/engine_shaders.ts +267 -267
  777. package/src/engine/engine_shims.ts +32 -32
  778. package/src/engine/engine_test_utils.ts +109 -109
  779. package/src/engine/engine_texture.ts +82 -82
  780. package/src/engine/engine_three_utils.ts +849 -849
  781. package/src/engine/engine_time.ts +94 -94
  782. package/src/engine/engine_time_utils.ts +237 -237
  783. package/src/engine/engine_tonemapping.ts +210 -210
  784. package/src/engine/engine_types.ts +714 -714
  785. package/src/engine/engine_typestore.ts +63 -63
  786. package/src/engine/engine_util_decorator.ts +136 -136
  787. package/src/engine/engine_utils.ts +972 -972
  788. package/src/engine/engine_utils_format.ts +212 -212
  789. package/src/engine/engine_utils_screenshot.ts +698 -698
  790. package/src/engine/engine_utils_screenshot.xr.ts +103 -103
  791. package/src/engine/export/gltf/Writers.ts +34 -34
  792. package/src/engine/export/gltf/index.ts +158 -158
  793. package/src/engine/export/index.ts +2 -2
  794. package/src/engine/export/state.ts +19 -19
  795. package/src/engine/export/utils.ts +9 -9
  796. package/src/engine/extensions/EXT_texture_exr.ts +50 -50
  797. package/src/engine/extensions/NEEDLE_animator_controller_model.ts +195 -195
  798. package/src/engine/extensions/NEEDLE_components.ts +268 -268
  799. package/src/engine/extensions/NEEDLE_gameobject_data.ts +81 -81
  800. package/src/engine/extensions/NEEDLE_lighting_settings.ts +185 -185
  801. package/src/engine/extensions/NEEDLE_lightmaps.ts +119 -119
  802. package/src/engine/extensions/NEEDLE_persistent_assets.ts +76 -76
  803. package/src/engine/extensions/NEEDLE_render_objects.ts +209 -209
  804. package/src/engine/extensions/NEEDLE_techniques_webgl.ts +640 -640
  805. package/src/engine/extensions/extension_resolver.ts +4 -4
  806. package/src/engine/extensions/extension_utils.ts +166 -166
  807. package/src/engine/extensions/extensions.ts +135 -135
  808. package/src/engine/extensions/index.ts +5 -5
  809. package/src/engine/extensions/usage_tracker.ts +100 -100
  810. package/src/engine/js-extensions/Camera.ts +37 -37
  811. package/src/engine/js-extensions/ExtensionUtils.ts +85 -85
  812. package/src/engine/js-extensions/Layers.ts +23 -23
  813. package/src/engine/js-extensions/Object3D.ts +296 -296
  814. package/src/engine/js-extensions/RGBAColor.ts +75 -75
  815. package/src/engine/js-extensions/Vector.ts +18 -18
  816. package/src/engine/js-extensions/index.ts +4 -4
  817. package/src/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +122 -122
  818. package/src/engine/shaders/shaderData.ts +67 -67
  819. package/src/engine/tests/test_utils.ts +63 -63
  820. package/src/engine/webcomponents/WebXRButtons.ts +260 -260
  821. package/src/engine/webcomponents/api.ts +6 -6
  822. package/src/engine/webcomponents/buttons.ts +262 -262
  823. package/src/engine/webcomponents/fonts.ts +41 -41
  824. package/src/engine/webcomponents/icons.ts +57 -57
  825. package/src/engine/webcomponents/index.ts +1 -1
  826. package/src/engine/webcomponents/logo-element.ts +78 -78
  827. package/src/engine/webcomponents/needle menu/needle-menu-spatial.ts +573 -573
  828. package/src/engine/webcomponents/needle menu/needle-menu.ts +1107 -1107
  829. package/src/engine/webcomponents/needle-button.ts +181 -181
  830. package/src/engine/xr/NeedleXRController.ts +1126 -1126
  831. package/src/engine/xr/NeedleXRSession.ts +1585 -1585
  832. package/src/engine/xr/NeedleXRSync.ts +220 -220
  833. package/src/engine/xr/SceneTransition.ts +78 -78
  834. package/src/engine/xr/TempXRContext.ts +216 -216
  835. package/src/engine/xr/XRRig.ts +9 -9
  836. package/src/engine/xr/api.ts +5 -5
  837. package/src/engine/xr/events.ts +102 -102
  838. package/src/engine/xr/internal.ts +34 -34
  839. package/src/engine/xr/usdz.ts +30 -30
  840. package/src/engine/xr/utils.ts +39 -39
  841. package/src/engine-components/AlignmentConstraint.ts +36 -36
  842. package/src/engine-components/Animation.ts +557 -557
  843. package/src/engine-components/AnimationCurve.ts +150 -150
  844. package/src/engine-components/AnimationUtils.ts +28 -28
  845. package/src/engine-components/AnimationUtilsAutoplay.ts +43 -43
  846. package/src/engine-components/Animator.ts +397 -397
  847. package/src/engine-components/AnimatorController.ts +1293 -1293
  848. package/src/engine-components/AudioListener.ts +92 -92
  849. package/src/engine-components/AudioSource.ts +639 -639
  850. package/src/engine-components/AvatarLoader.ts +263 -263
  851. package/src/engine-components/AxesHelper.ts +59 -59
  852. package/src/engine-components/BasicIKConstraint.ts +54 -54
  853. package/src/engine-components/BoxCollider.ts +1 -1
  854. package/src/engine-components/BoxHelperComponent.ts +114 -114
  855. package/src/engine-components/Camera.ts +707 -707
  856. package/src/engine-components/CameraUtils.ts +144 -144
  857. package/src/engine-components/CharacterController.ts +253 -253
  858. package/src/engine-components/Collider.ts +374 -374
  859. package/src/engine-components/Component.ts +1294 -1294
  860. package/src/engine-components/ContactShadows.ts +482 -482
  861. package/src/engine-components/DeleteBox.ts +62 -62
  862. package/src/engine-components/DeviceFlag.ts +46 -46
  863. package/src/engine-components/DragControls.ts +1623 -1623
  864. package/src/engine-components/DropListener.ts +698 -698
  865. package/src/engine-components/Duplicatable.ts +198 -198
  866. package/src/engine-components/EventList.ts +266 -266
  867. package/src/engine-components/EventTrigger.ts +74 -74
  868. package/src/engine-components/EventType.ts +22 -22
  869. package/src/engine-components/Fog.ts +60 -60
  870. package/src/engine-components/Gizmos.ts +56 -56
  871. package/src/engine-components/GridHelper.ts +48 -48
  872. package/src/engine-components/GroundProjection.ts +356 -356
  873. package/src/engine-components/Interactable.ts +14 -14
  874. package/src/engine-components/Joints.ts +52 -52
  875. package/src/engine-components/LODGroup.ts +153 -153
  876. package/src/engine-components/Light.ts +558 -558
  877. package/src/engine-components/LookAtConstraint.ts +25 -25
  878. package/src/engine-components/NeedleMenu.ts +84 -84
  879. package/src/engine-components/NestedGltf.ts +86 -86
  880. package/src/engine-components/Networking.ts +114 -114
  881. package/src/engine-components/OffsetConstraint.ts +60 -60
  882. package/src/engine-components/OrbitControls.ts +1068 -1068
  883. package/src/engine-components/PlayerColor.ts +103 -103
  884. package/src/engine-components/ReflectionProbe.ts +209 -209
  885. package/src/engine-components/Renderer.ts +900 -900
  886. package/src/engine-components/RendererInstancing.ts +855 -855
  887. package/src/engine-components/RendererLightmap.ts +198 -198
  888. package/src/engine-components/RigidBody.ts +526 -526
  889. package/src/engine-components/SceneSwitcher.ts +1013 -1013
  890. package/src/engine-components/ScreenCapture.ts +592 -592
  891. package/src/engine-components/ShadowCatcher.ts +172 -172
  892. package/src/engine-components/Skybox.ts +455 -455
  893. package/src/engine-components/SmoothFollow.ts +76 -76
  894. package/src/engine-components/SpatialTrigger.ts +229 -229
  895. package/src/engine-components/SpectatorCamera.ts +787 -787
  896. package/src/engine-components/SphereCollider.ts +1 -1
  897. package/src/engine-components/SpriteRenderer.ts +468 -468
  898. package/src/engine-components/SyncedCamera.ts +220 -220
  899. package/src/engine-components/SyncedRoom.ts +380 -380
  900. package/src/engine-components/SyncedTransform.ts +378 -378
  901. package/src/engine-components/TestRunner.ts +118 -118
  902. package/src/engine-components/TransformGizmo.ts +219 -219
  903. package/src/engine-components/VideoPlayer.ts +1025 -1025
  904. package/src/engine-components/Voip.ts +363 -363
  905. package/src/engine-components/api.ts +60 -60
  906. package/src/engine-components/avatar/AvatarBlink_Simple.ts +69 -69
  907. package/src/engine-components/avatar/AvatarEyeLook_Rotation.ts +63 -63
  908. package/src/engine-components/avatar/Avatar_Brain_LookAt.ts +139 -139
  909. package/src/engine-components/avatar/Avatar_MouthShapes.ts +83 -83
  910. package/src/engine-components/avatar/Avatar_MustacheShake.ts +31 -31
  911. package/src/engine-components/codegen/components.ts +216 -216
  912. package/src/engine-components/debug/LogStats.ts +21 -21
  913. package/src/engine-components/export/gltf/GltfExport.ts +265 -265
  914. package/src/engine-components/export/usdz/Extension.ts +24 -24
  915. package/src/engine-components/export/usdz/ThreeUSDZExporter.ts +2413 -2413
  916. package/src/engine-components/export/usdz/USDZExporter.ts +705 -705
  917. package/src/engine-components/export/usdz/extensions/Animation.ts +1204 -1204
  918. package/src/engine-components/export/usdz/extensions/DocumentExtension.ts +9 -9
  919. package/src/engine-components/export/usdz/extensions/USDZText.ts +240 -240
  920. package/src/engine-components/export/usdz/extensions/USDZUI.ts +189 -189
  921. package/src/engine-components/export/usdz/extensions/behavior/Actions.ts +99 -99
  922. package/src/engine-components/export/usdz/extensions/behavior/AudioExtension.ts +102 -102
  923. package/src/engine-components/export/usdz/extensions/behavior/Behaviour.ts +320 -320
  924. package/src/engine-components/export/usdz/extensions/behavior/BehaviourComponents.ts +1225 -1225
  925. package/src/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.ts +646 -646
  926. package/src/engine-components/export/usdz/extensions/behavior/PhysicsExtension.ts +132 -132
  927. package/src/engine-components/export/usdz/index.ts +2 -2
  928. package/src/engine-components/export/usdz/utils/animationutils.ts +191 -191
  929. package/src/engine-components/export/usdz/utils/quicklook.ts +50 -50
  930. package/src/engine-components/particlesystem/ParticleSystem.ts +1287 -1287
  931. package/src/engine-components/particlesystem/ParticleSystemModules.ts +1765 -1765
  932. package/src/engine-components/particlesystem/ParticleSystemSubEmitter.ts +111 -111
  933. package/src/engine-components/particlesystem/api.ts +1 -1
  934. package/src/engine-components/postprocessing/Effects/Antialiasing.ts +55 -55
  935. package/src/engine-components/postprocessing/Effects/BloomEffect.ts +116 -116
  936. package/src/engine-components/postprocessing/Effects/ChromaticAberration.ts +37 -37
  937. package/src/engine-components/postprocessing/Effects/ColorAdjustments.ts +95 -95
  938. package/src/engine-components/postprocessing/Effects/DepthOfField.ts +103 -103
  939. package/src/engine-components/postprocessing/Effects/EffectWrapper.ts +25 -25
  940. package/src/engine-components/postprocessing/Effects/Pixelation.ts +32 -32
  941. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.ts +90 -90
  942. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.ts +191 -191
  943. package/src/engine-components/postprocessing/Effects/Sharpening.ts +138 -138
  944. package/src/engine-components/postprocessing/Effects/TiltShiftEffect.ts +61 -61
  945. package/src/engine-components/postprocessing/Effects/Tonemapping.ts +155 -155
  946. package/src/engine-components/postprocessing/Effects/Vignette.ts +59 -59
  947. package/src/engine-components/postprocessing/PostProcessingEffect.ts +172 -172
  948. package/src/engine-components/postprocessing/PostProcessingHandler.ts +398 -398
  949. package/src/engine-components/postprocessing/Volume.ts +410 -410
  950. package/src/engine-components/postprocessing/VolumeParameter.ts +158 -158
  951. package/src/engine-components/postprocessing/VolumeProfile.ts +61 -61
  952. package/src/engine-components/postprocessing/index.ts +5 -5
  953. package/src/engine-components/postprocessing/utils.ts +52 -52
  954. package/src/engine-components/timeline/PlayableDirector.ts +722 -722
  955. package/src/engine-components/timeline/SignalAsset.ts +144 -144
  956. package/src/engine-components/timeline/TimelineModels.ts +92 -92
  957. package/src/engine-components/timeline/TimelineTracks.ts +967 -967
  958. package/src/engine-components/timeline/index.ts +3 -3
  959. package/src/engine-components/ui/BaseUIComponent.ts +203 -203
  960. package/src/engine-components/ui/Button.ts +307 -307
  961. package/src/engine-components/ui/Canvas.ts +419 -419
  962. package/src/engine-components/ui/CanvasGroup.ts +54 -54
  963. package/src/engine-components/ui/EventSystem.ts +853 -853
  964. package/src/engine-components/ui/Graphic.ts +275 -275
  965. package/src/engine-components/ui/Image.ts +112 -112
  966. package/src/engine-components/ui/InputField.ts +321 -321
  967. package/src/engine-components/ui/Interfaces.ts +57 -57
  968. package/src/engine-components/ui/Layout.ts +334 -334
  969. package/src/engine-components/ui/Outline.ts +13 -13
  970. package/src/engine-components/ui/PointerEvents.ts +206 -206
  971. package/src/engine-components/ui/RaycastUtils.ts +69 -69
  972. package/src/engine-components/ui/Raycaster.ts +102 -102
  973. package/src/engine-components/ui/RectTransform.ts +372 -372
  974. package/src/engine-components/ui/SpatialHtml.ts +79 -79
  975. package/src/engine-components/ui/Text.ts +578 -578
  976. package/src/engine-components/ui/Utils.ts +112 -112
  977. package/src/engine-components/utils/EnvironmentScene.ts +245 -245
  978. package/src/engine-components/utils/LookAt.ts +88 -88
  979. package/src/engine-components/utils/OpenURL.ts +114 -114
  980. package/src/engine-components/webxr/Avatar.ts +265 -265
  981. package/src/engine-components/webxr/TeleportTarget.ts +9 -9
  982. package/src/engine-components/webxr/WebARCameraBackground.ts +175 -175
  983. package/src/engine-components/webxr/WebARSessionRoot.ts +880 -880
  984. package/src/engine-components/webxr/WebXR.ts +585 -585
  985. package/src/engine-components/webxr/WebXRAvatar.ts +66 -66
  986. package/src/engine-components/webxr/WebXRImageTracking.ts +518 -518
  987. package/src/engine-components/webxr/WebXRPlaneTracking.ts +570 -570
  988. package/src/engine-components/webxr/WebXRRig.ts +77 -77
  989. package/src/engine-components/webxr/XRFlag.ts +147 -147
  990. package/src/engine-components/webxr/controllers/XRControllerFollow.ts +118 -118
  991. package/src/engine-components/webxr/controllers/XRControllerModel.ts +374 -374
  992. package/src/engine-components/webxr/controllers/XRControllerMovement.ts +550 -550
  993. package/src/engine-components/webxr/index.ts +2 -2
  994. package/src/engine-components/webxr/types.ts +3 -3
  995. package/src/engine-components-experimental/Presentation.ts +12 -12
  996. package/src/engine-components-experimental/api.ts +4 -4
  997. package/src/engine-components-experimental/networking/PlayerSync.ts +401 -401
  998. package/src/engine-schemes/COMPILE_SCHEMES.bat +3 -3
  999. package/src/engine-schemes/COMPILE_TS.bat +11 -11
  1000. package/src/engine-schemes/README.md +1 -1
  1001. package/src/engine-schemes/api.ts +12 -12
  1002. package/src/engine-schemes/schemes.ts +28 -28
  1003. package/src/engine-schemes/synced-camera-model.ts +92 -92
  1004. package/src/engine-schemes/synced-transform-model.ts +90 -90
  1005. package/src/engine-schemes/syncedCamera.fbs +10 -10
  1006. package/src/engine-schemes/transform.ts +50 -50
  1007. package/src/engine-schemes/transforms.fbs +25 -25
  1008. package/src/engine-schemes/vec.fbs +19 -19
  1009. package/src/engine-schemes/vec2.ts +33 -33
  1010. package/src/engine-schemes/vec3.ts +38 -38
  1011. package/src/engine-schemes/vec4.ts +43 -43
  1012. package/src/engine-schemes/vr-user-state-buffer.ts +145 -145
  1013. package/src/engine-schemes/vrUserStateBuffer.fbs +17 -17
  1014. package/src/include/draco/draco_decoder.js +34 -34
  1015. package/src/include/ktx2/basis_transcoder.js +21 -21
  1016. package/src/include/needle/arial-msdf.json +1471 -1471
  1017. package/src/include/three/DragControls.js +231 -231
  1018. package/src/include/three/EXT_mesh_gpu_instancing_exporter.js +66 -66
  1019. package/src/needle-engine.ts +70 -70
  1020. package/lib/engine/engine.d.ts +0 -4
  1021. package/lib/engine/engine.js +0 -12
  1022. package/lib/engine/engine.js.map +0 -1
  1023. package/lib/engine/engine_web_api.d.ts +0 -12
  1024. package/lib/engine/engine_web_api.js +0 -113
  1025. package/lib/engine/engine_web_api.js.map +0 -1
  1026. package/lib/engine-components/FlyControls.d.ts +0 -10
  1027. package/lib/engine-components/FlyControls.js +0 -29
  1028. package/lib/engine-components/FlyControls.js.map +0 -1
  1029. package/src/engine-schemes/dist/api.js +0 -17
  1030. package/src/engine-schemes/dist/api.js.meta +0 -7
  1031. package/src/engine-schemes/dist/schemes.js +0 -25
  1032. package/src/engine-schemes/dist/schemes.js.meta +0 -7
  1033. package/src/engine-schemes/dist/synced-camera-model.js +0 -74
  1034. package/src/engine-schemes/dist/synced-camera-model.js.meta +0 -7
  1035. package/src/engine-schemes/dist/synced-transform-model.js +0 -73
  1036. package/src/engine-schemes/dist/synced-transform-model.js.meta +0 -7
  1037. package/src/engine-schemes/dist/transform.js +0 -46
  1038. package/src/engine-schemes/dist/transform.js.meta +0 -7
  1039. package/src/engine-schemes/dist/vec2.js +0 -32
  1040. package/src/engine-schemes/dist/vec2.js.meta +0 -7
  1041. package/src/engine-schemes/dist/vec3.js +0 -36
  1042. package/src/engine-schemes/dist/vec3.js.meta +0 -7
  1043. package/src/engine-schemes/dist/vec4.js +0 -40
  1044. package/src/engine-schemes/dist/vec4.js.meta +0 -7
  1045. package/src/engine-schemes/dist/vr-user-state-buffer.js +0 -110
  1046. package/src/engine-schemes/dist/vr-user-state-buffer.js.meta +0 -7
@@ -1,1294 +1,1294 @@
1
- import { Euler, Object3D, Quaternion, Scene, Vector3 } from "three";
2
-
3
- import { isDevEnvironment } from "../engine/debug/index.js";
4
- import { type AssetReference } from "../engine/engine_addressables.js";
5
- import { addComponent, destroyComponentInstance, findObjectOfType, findObjectsOfType, getComponent, getComponentInChildren, getComponentInParent, getComponents, getComponentsInChildren, getComponentsInParent, getOrAddComponent, removeComponent } from "../engine/engine_components.js";
6
- import { activeInHierarchyFieldName } from "../engine/engine_constants.js";
7
- import { destroy, findByGuid, foreachComponent, type IInstantiateOptions, instantiate, isActiveInHierarchy, isActiveSelf, isDestroyed, isUsingInstancing, markAsInstancedRendered, setActive } from "../engine/engine_gameobject.js";
8
- import * as main from "../engine/engine_mainloop_utils.js";
9
- import { syncDestroy, syncInstantiate, SyncInstantiateOptions } from "../engine/engine_networking_instantiate.js";
10
- import { Context, FrameEvent } from "../engine/engine_setup.js";
11
- import * as threeutils from "../engine/engine_three_utils.js";
12
- import type { Collision, ComponentInit, Constructor, ConstructorConcrete, GuidsMap, ICollider, IComponent, IGameObject, SourceIdentifier } from "../engine/engine_types.js";
13
- import type { INeedleXRSessionEventReceiver, NeedleXRControllerEventArgs, NeedleXREventArgs } from "../engine/engine_xr.js";
14
- import { type IPointerEventHandler, PointerEventData } from "./ui/PointerEvents.js";
15
-
16
-
17
- // export interface ISerializationCallbackReceiver {
18
- // onBeforeSerialize?(): object | void;
19
- // onAfterSerialize?();
20
- // onBeforeDeserialize?(data?: any);
21
- // onAfterDeserialize?();
22
- // onDeserialize?(key: string, value: any): any | void;
23
- // }
24
-
25
- /**
26
- * Base class for objects in Needle Engine. Extends {@link Object3D} from three.js.
27
- * GameObjects can have components attached to them, which can be used to add functionality to the object.
28
- * They manage their components and provide methods to add, remove and get components.
29
- *
30
- * All {@link Object3D} types loaded in Needle Engine have methods like {@link addComponent}.
31
- * These methods are available directly on the GameObject instance:
32
- * ```typescript
33
- * target.addComponent(MyComponent);
34
- * ```
35
- *
36
- * And can be called statically on the GameObject class as well:
37
- * ```typescript
38
- * GameObject.setActive(target, true);
39
- * ```
40
- */
41
- export abstract class GameObject extends Object3D implements Object3D, IGameObject {
42
-
43
- /**
44
- * Indicates if the GameObject is currently active. Inactive GameObjects will not be rendered or updated.
45
- * When the activeSelf state changes, components will receive {@link Component.onEnable} or {@link Component.onDisable} callbacks.
46
- */
47
- abstract activeSelf: boolean;
48
-
49
- /** @deprecated Use {@link addComponent} instead */
50
- // eslint-disable-next-line deprecation/deprecation
51
- abstract addNewComponent<T extends IComponent>(type: ConstructorConcrete<T>, init?: ComponentInit<T>): T;
52
-
53
- /**
54
- * Creates a new component on this gameObject or adds an existing component instance
55
- * @param comp Component type constructor or existing component instance
56
- * @param init Optional initialization values for the component
57
- * @returns The newly created or added component
58
- */
59
- abstract addComponent<T extends IComponent>(comp: T | ConstructorConcrete<T>, init?: ComponentInit<T>): T;
60
-
61
- /**
62
- * Removes a component from this GameObject
63
- * @param comp Component instance to remove
64
- * @returns The removed component
65
- */
66
- abstract removeComponent<T extends IComponent>(comp: T): T;
67
-
68
- /**
69
- * Gets an existing component of the specified type or adds a new one if it doesn't exist
70
- * @param typeName Constructor of the component type to get or add
71
- * @returns The existing or newly added component
72
- */
73
- abstract getOrAddComponent<T>(typeName: ConstructorConcrete<T> | null): T;
74
-
75
- /**
76
- * Gets a component of the specified type attached to this GameObject
77
- * @param type Constructor of the component type to get
78
- * @returns The component if found, otherwise null
79
- */
80
- abstract getComponent<T>(type: Constructor<T>): T | null;
81
-
82
- /**
83
- * Gets all components of the specified type attached to this GameObject
84
- * @param type Constructor of the component type to get
85
- * @param arr Optional array to populate with the components
86
- * @returns Array of components
87
- */
88
- abstract getComponents<T>(type: Constructor<T>, arr?: T[]): Array<T>;
89
-
90
- /**
91
- * Gets a component of the specified type in this GameObject's children hierarchy
92
- * @param type Constructor of the component type to get
93
- * @returns The first matching component if found, otherwise null
94
- */
95
- abstract getComponentInChildren<T>(type: Constructor<T>): T | null;
96
-
97
- /**
98
- * Gets all components of the specified type in this GameObject's children hierarchy
99
- * @param type Constructor of the component type to get
100
- * @param arr Optional array to populate with the components
101
- * @returns Array of components
102
- */
103
- abstract getComponentsInChildren<T>(type: Constructor<T>, arr?: T[]): Array<T>;
104
-
105
- /**
106
- * Gets a component of the specified type in this GameObject's parent hierarchy
107
- * @param type Constructor of the component type to get
108
- * @returns The first matching component if found, otherwise null
109
- */
110
- abstract getComponentInParent<T>(type: Constructor<T>): T | null;
111
-
112
- /**
113
- * Gets all components of the specified type in this GameObject's parent hierarchy
114
- * @param type Constructor of the component type to get
115
- * @param arr Optional array to populate with the components
116
- * @returns Array of components
117
- */
118
- abstract getComponentsInParent<T>(type: Constructor<T>, arr?: T[]): Array<T>;
119
-
120
-
121
- /**
122
- * The position of this GameObject in world space
123
- */
124
- abstract get worldPosition(): Vector3
125
- abstract set worldPosition(val: Vector3);
126
-
127
- /**
128
- * The rotation of this GameObject in world space as a quaternion
129
- */
130
- abstract set worldQuaternion(val: Quaternion);
131
- abstract get worldQuaternion(): Quaternion;
132
-
133
- /**
134
- * The rotation of this GameObject in world space in euler angles (degrees)
135
- */
136
- abstract set worldRotation(val: Vector3);
137
- abstract get worldRotation(): Vector3;
138
-
139
- /**
140
- * The scale of this GameObject in world space
141
- */
142
- abstract set worldScale(val: Vector3);
143
- abstract get worldScale(): Vector3;
144
-
145
- /**
146
- * The forward direction vector of this GameObject in world space
147
- */
148
- abstract get worldForward(): Vector3;
149
-
150
- /**
151
- * The right direction vector of this GameObject in world space
152
- */
153
- abstract get worldRight(): Vector3;
154
-
155
- /**
156
- * The up direction vector of this GameObject in world space
157
- */
158
- abstract get worldUp(): Vector3;
159
-
160
- /**
161
- * Unique identifier for this GameObject
162
- */
163
- guid: string | undefined;
164
-
165
- /**
166
- * Destroys this GameObject and all its components.
167
- * Internally, this is added to the three.js {@link Object3D} prototype.
168
- */
169
- abstract destroy();
170
-
171
-
172
- /**
173
- * Checks if a GameObject has been destroyed
174
- * @param go The GameObject to check
175
- * @returns True if the GameObject has been destroyed
176
- */
177
- public static isDestroyed(go: Object3D): boolean {
178
- return isDestroyed(go);
179
- }
180
-
181
- /**
182
- * Sets the active state of a GameObject
183
- * @param go The GameObject to modify
184
- * @param active Whether the GameObject should be active
185
- * @param processStart Whether to process the start callbacks if being activated
186
- */
187
- public static setActive(go: Object3D, active: boolean, processStart: boolean = true) {
188
- if (!go) return;
189
- setActive(go, active);
190
-
191
- // TODO: do we still need this?:
192
- main.updateIsActive(go);
193
- if (active && processStart)
194
- main.processStart(Context.Current, go);
195
- }
196
-
197
- /**
198
- * Checks if the GameObject itself is active (same as go.visible)
199
- * @param go The GameObject to check
200
- * @returns True if the GameObject is active
201
- */
202
- public static isActiveSelf(go: Object3D): boolean {
203
- return isActiveSelf(go);
204
- }
205
-
206
- /**
207
- * Checks if the GameObject is active in the hierarchy (e.g. if any parent is invisible or not in the scene it will be false)
208
- * @param go The GameObject to check
209
- * @returns True if the GameObject is active in the hierarchy
210
- */
211
- public static isActiveInHierarchy(go: Object3D): boolean {
212
- return isActiveInHierarchy(go);
213
- }
214
-
215
- /**
216
- * Marks a GameObject to be rendered using instancing
217
- * @param go The GameObject to mark
218
- * @param instanced Whether the GameObject should use instanced rendering
219
- */
220
- public static markAsInstancedRendered(go: Object3D, instanced: boolean) {
221
- markAsInstancedRendered(go, instanced);
222
- }
223
-
224
- /**
225
- * Checks if a GameObject is using instanced rendering
226
- * @param instance The GameObject to check
227
- * @returns True if the GameObject is using instanced rendering
228
- */
229
- public static isUsingInstancing(instance: Object3D): boolean { return isUsingInstancing(instance); }
230
-
231
- /**
232
- * Executes a callback for all components of the provided type on the provided object and its children
233
- * @param instance Object to run the method on
234
- * @param cb Callback to run on each component, "return undefined;" to continue and "return <anything>;" to break the loop
235
- * @param recursive If true, the method will be run on all children as well
236
- * @returns The last return value of the callback
237
- */
238
- public static foreachComponent(instance: Object3D, cb: (comp: Component) => any, recursive: boolean = true): any {
239
- return foreachComponent(instance, cb as (comp: IComponent) => any, recursive);
240
- }
241
-
242
- /**
243
- * Creates a new instance of the provided object that will be replicated to all connected clients
244
- * @param instance Object to instantiate
245
- * @param opts Options for the instantiation
246
- * @returns The newly created instance or null if creation failed
247
- */
248
- public static instantiateSynced(instance: GameObject | Object3D | null, opts: SyncInstantiateOptions): GameObject | null {
249
- if (!instance) return null;
250
- return syncInstantiate(instance, opts) as GameObject | null;
251
- }
252
-
253
- /**
254
- * Creates a new instance of the provided object (like cloning it including all components and children)
255
- * @param instance Object to instantiate
256
- * @param opts Options for the instantiation (e.g. with what parent, position, etc.)
257
- * @returns The newly created instance
258
- */
259
- public static instantiate(instance: AssetReference, opts?: IInstantiateOptions | null | undefined): Promise<Object3D | null>
260
- public static instantiate(instance: GameObject | Object3D, opts?: IInstantiateOptions | null | undefined): GameObject
261
- public static instantiate(instance: AssetReference | GameObject | Object3D, opts: IInstantiateOptions | null | undefined = null): GameObject | Promise<Object3D | null> {
262
- if ('isAssetReference' in instance) {
263
- return instantiate(instance as AssetReference, opts);
264
- }
265
- return instantiate(instance as GameObject | Object3D, opts) as GameObject;
266
- }
267
-
268
- /**
269
- * Destroys an object on all connected clients (if in a networked session)
270
- * @param instance Object to destroy
271
- * @param context Optional context to use
272
- * @param recursive If true, all children will be destroyed as well
273
- */
274
- public static destroySynced(instance: Object3D | Component, context?: Context, recursive: boolean = true) {
275
- if (!instance) return;
276
- const go = instance as GameObject;
277
- context = context ?? Context.Current;
278
- syncDestroy(go as any, context.connection, recursive);
279
- }
280
-
281
- /**
282
- * Destroys an object
283
- * @param instance Object to destroy
284
- * @param recursive If true, all children will be destroyed as well. Default: true
285
- */
286
- public static destroy(instance: Object3D | Component, recursive: boolean = true) {
287
- return destroy(instance, recursive);
288
- }
289
-
290
- /**
291
- * Adds an object to parent and ensures all components are properly registered
292
- * @param instance Object to add
293
- * @param parent Parent to add the object to
294
- * @param context Optional context to use
295
- */
296
- public static add(instance: Object3D | null | undefined, parent: Object3D, context?: Context) {
297
- if (!instance || !parent) return;
298
- if (instance === parent) {
299
- console.warn("Can not add object to self", instance);
300
- return;
301
- }
302
- if (!context) {
303
- context = Context.Current;
304
- }
305
- parent.add(instance);
306
- setActive(instance, true);
307
- main.updateIsActive(instance);
308
- if (context) {
309
- GameObject.foreachComponent(instance, (comp: Component) => {
310
- main.addScriptToArrays(comp, context!);
311
- if (comp.__internalDidAwakeAndStart) return;
312
- if (context!.new_script_start.includes(comp) === false) {
313
- context!.new_script_start.push(comp as Component);
314
- }
315
- }, true);
316
- }
317
- else {
318
- console.warn("Missing context");
319
- }
320
- }
321
-
322
- /**
323
- * Removes the object from its parent and deactivates all of its components
324
- * @param instance Object to remove
325
- */
326
- public static remove(instance: Object3D | null | undefined) {
327
- if (!instance) return;
328
- instance.parent?.remove(instance);
329
- setActive(instance, false);
330
- main.updateIsActive(instance);
331
- GameObject.foreachComponent(instance, (comp) => {
332
- main.processRemoveFromScene(comp);
333
- }, true);
334
- }
335
-
336
- /**
337
- * Invokes a method on all components including children (if a method with that name exists)
338
- * @param go GameObject to invoke the method on
339
- * @param functionName Name of the method to invoke
340
- * @param args Arguments to pass to the method
341
- */
342
- public static invokeOnChildren(go: Object3D | null | undefined, functionName: string, ...args: any) {
343
- this.invoke(go, functionName, true, args);
344
- }
345
-
346
- /**
347
- * Invokes a method on all components that have a method matching the provided name
348
- * @param go GameObject to invoke the method on
349
- * @param functionName Name of the method to invoke
350
- * @param children Whether to invoke on children as well
351
- * @param args Arguments to pass to the method
352
- */
353
- public static invoke(go: Object3D | null | undefined, functionName: string, children: boolean = false, ...args: any) {
354
- if (!go) return;
355
- this.foreachComponent(go, c => {
356
- const fn = c[functionName];
357
- if (fn && typeof fn === "function") {
358
- fn?.call(c, ...args)
359
- }
360
- }, children);
361
- }
362
-
363
- /** @deprecated use `addComponent` */
364
- // eslint-disable-next-line deprecation/deprecation
365
- public static addNewComponent<T extends IComponent>(go: IGameObject | Object3D, type: T | ConstructorConcrete<T>, init?: ComponentInit<T>, callAwake: boolean = true): T {
366
- return addComponent(go, type, init, { callAwake });
367
- }
368
-
369
- /**
370
- * Adds a new component (or moves an existing component) to the provided object
371
- * @param go Object to add the component to
372
- * @param instanceOrType If an instance is provided it will be moved to the new object, if a type is provided a new instance will be created
373
- * @param init Optional init object to initialize the component with
374
- * @param opts Optional options for adding the component
375
- * @returns The added or moved component
376
- */
377
- public static addComponent<T extends IComponent>(go: IGameObject | Object3D, instanceOrType: T | ConstructorConcrete<T>, init?: ComponentInit<T>, opts?: { callAwake: boolean }): T {
378
- return addComponent(go, instanceOrType, init, opts);
379
- }
380
-
381
- /**
382
- * Moves a component to a new object
383
- * @param go GameObject to move the component to
384
- * @param instance Component to move
385
- * @returns The moved component
386
- */
387
- public static moveComponent<T extends IComponent>(go: IGameObject | Object3D, instance: T | ConstructorConcrete<T>): T {
388
- return addComponent(go, instance);
389
- }
390
-
391
- /**
392
- * Removes a component from its object
393
- * @param instance Component to remove
394
- * @returns The removed component
395
- */
396
- public static removeComponent<T extends IComponent>(instance: T): T {
397
- removeComponent(instance.gameObject, instance as any);
398
- return instance;
399
- }
400
-
401
- /**
402
- * Gets or adds a component of the specified type
403
- * @param go GameObject to get or add the component to
404
- * @param typeName Constructor of the component type
405
- * @returns The existing or newly added component
406
- */
407
- public static getOrAddComponent<T extends IComponent>(go: IGameObject | Object3D, typeName: ConstructorConcrete<T>): T {
408
- return getOrAddComponent<any>(go, typeName);
409
- }
410
-
411
- /**
412
- * Gets a component on the provided object
413
- * @param go GameObject to get the component from
414
- * @param typeName Constructor of the component type
415
- * @returns The component if found, otherwise null
416
- */
417
- public static getComponent<T extends IComponent>(go: IGameObject | Object3D | null, typeName: Constructor<T> | null): T | null {
418
- if (go === null) return null;
419
- // if names are minified we could also use the type store and work with strings everywhere
420
- // not ideal, but I dont know a good/sane way to do this otherwise
421
- // const res = TypeStore.get(typeName);
422
- // if(res) typeName = res;
423
- return getComponent(go, typeName as any);
424
- }
425
-
426
- /**
427
- * Gets all components of the specified type on the provided object
428
- * @param go GameObject to get the components from
429
- * @param typeName Constructor of the component type
430
- * @param arr Optional array to populate with the components
431
- * @returns Array of components
432
- */
433
- public static getComponents<T extends IComponent>(go: IGameObject | Object3D | null, typeName: Constructor<T>, arr: T[] | null = null): T[] {
434
- if (go === null) return arr ?? [];
435
- return getComponents(go, typeName, arr);
436
- }
437
-
438
- /**
439
- * Finds an object or component by its unique identifier
440
- * @param guid Unique identifier to search for
441
- * @param hierarchy Root object to search in
442
- * @returns The found GameObject or Component, or null/undefined if not found
443
- */
444
- public static findByGuid(guid: string, hierarchy: Object3D): GameObject | Component | null | undefined {
445
- const res = findByGuid(guid, hierarchy);
446
- return res as GameObject | Component | null | undefined;
447
- }
448
-
449
- /**
450
- * Finds the first object of the specified component type in the scene
451
- * @param typeName Constructor of the component type
452
- * @param context Context or root object to search in
453
- * @param includeInactive Whether to include inactive objects in the search
454
- * @returns The first matching component if found, otherwise null
455
- */
456
- public static findObjectOfType<T extends IComponent>(typeName: Constructor<T>, context?: Context | Object3D, includeInactive: boolean = true): T | null {
457
- return findObjectOfType(typeName, context ?? Context.Current, includeInactive);
458
- }
459
-
460
- /**
461
- * Finds all objects of the specified component type in the scene
462
- * @param typeName Constructor of the component type
463
- * @param context Context or root object to search in
464
- * @returns Array of matching components
465
- */
466
- public static findObjectsOfType<T extends IComponent>(typeName: Constructor<T>, context?: Context | Object3D): Array<T> {
467
- const arr = [];
468
- findObjectsOfType(typeName, arr, context);
469
- return arr;
470
- }
471
-
472
- /**
473
- * Gets a component of the specified type in the gameObject's children hierarchy
474
- * @param go GameObject to search in
475
- * @param typeName Constructor of the component type
476
- * @returns The first matching component if found, otherwise null
477
- */
478
- public static getComponentInChildren<T extends IComponent>(go: IGameObject | Object3D, typeName: Constructor<T>): T | null {
479
- return getComponentInChildren(go, typeName);
480
- }
481
-
482
- /**
483
- * Gets all components of the specified type in the gameObject's children hierarchy
484
- * @param go GameObject to search in
485
- * @param typeName Constructor of the component type
486
- * @param arr Optional array to populate with the components
487
- * @returns Array of components
488
- */
489
- public static getComponentsInChildren<T extends IComponent>(go: IGameObject | Object3D, typeName: Constructor<T>, arr: T[] | null = null): Array<T> {
490
- return getComponentsInChildren<T>(go, typeName, arr ?? undefined) as T[]
491
- }
492
-
493
- /**
494
- * Gets a component of the specified type in the gameObject's parent hierarchy
495
- * @param go GameObject to search in
496
- * @param typeName Constructor of the component type
497
- * @returns The first matching component if found, otherwise null
498
- */
499
- public static getComponentInParent<T extends IComponent>(go: IGameObject | Object3D, typeName: Constructor<T>): T | null {
500
- return getComponentInParent(go, typeName);
501
- }
502
-
503
- /**
504
- * Gets all components of the specified type in the gameObject's parent hierarchy
505
- * @param go GameObject to search in
506
- * @param typeName Constructor of the component type
507
- * @param arr Optional array to populate with the components
508
- * @returns Array of components
509
- */
510
- public static getComponentsInParent<T extends IComponent>(go: IGameObject | Object3D, typeName: Constructor<T>, arr: Array<T> | null = null): Array<T> {
511
- return getComponentsInParent(go, typeName, arr);
512
- }
513
-
514
- /**
515
- * Gets all components on the gameObject
516
- * @param go GameObject to get components from
517
- * @returns Array of all components
518
- */
519
- public static getAllComponents(go: IGameObject | Object3D): Component[] {
520
- const componentsList = go.userData?.components;
521
- if (!componentsList) return [];
522
- const newList = [...componentsList];
523
- return newList;
524
- }
525
-
526
- /**
527
- * Iterates through all components on the gameObject
528
- * @param go GameObject to iterate components on
529
- * @returns Generator yielding each component
530
- */
531
- public static *iterateComponents(go: IGameObject | Object3D) {
532
- const list = go?.userData?.components;
533
- if (list && Array.isArray(list)) {
534
- for (let i = 0; i < list.length; i++) {
535
- yield list[i];
536
- }
537
- }
538
- }
539
- }
540
-
541
-
542
-
543
- /**
544
- * Needle Engine component base class. Component's are the main building blocks of the Needle Engine.
545
- * Derive from {@link Behaviour} to implement your own using the provided lifecycle methods.
546
- * Components can be added to any {@link Object3D} using {@link addComponent} or {@link GameObject.addComponent}.
547
- *
548
- * The most common lifecycle methods are {@link update}, {@link awake}, {@link start}, {@link onEnable}, {@link onDisable} and {@link onDestroy}.
549
- *
550
- * XR specific callbacks include {@link onEnterXR}, {@link onLeaveXR}, {@link onUpdateXR}, {@link onXRControllerAdded} and {@link onXRControllerRemoved}.
551
- *
552
- * To receive pointer events implement {@link onPointerDown}, {@link onPointerUp}, {@link onPointerEnter}, {@link onPointerExit} and {@link onPointerMove}.
553
- *
554
- * @example
555
- * ```typescript
556
- * import { Behaviour } from "@needle-tools/engine";
557
- * export class MyComponent extends Behaviour {
558
- * start() {
559
- * console.log("Hello World");
560
- * }
561
- * update() {
562
- * console.log("Frame", this.context.time.frame);
563
- * }
564
- * }
565
- * ```
566
- *
567
- * @group Components
568
- */
569
- export abstract class Component implements IComponent, EventTarget,
570
- Partial<INeedleXRSessionEventReceiver>,
571
- Partial<IPointerEventHandler>
572
- {
573
- /**
574
- * Indicates whether this object is a component
575
- * @internal
576
- */
577
- get isComponent(): boolean { return true; }
578
-
579
- private __context: Context | undefined;
580
-
581
- /**
582
- * The context this component belongs to, providing access to the runtime environment
583
- * including physics, timing utilities, camera, and scene
584
- */
585
- get context(): Context {
586
- return this.__context ?? Context.Current;
587
- }
588
- set context(context: Context) {
589
- this.__context = context;
590
- }
591
-
592
- /**
593
- * Shorthand accessor for the current scene from the context
594
- * @returns The scene this component belongs to
595
- */
596
- get scene(): Scene { return this.context.scene; }
597
-
598
- /**
599
- * The layer value of the GameObject this component is attached to
600
- * Used for visibility and physics filtering
601
- */
602
- get layer(): number {
603
- return this.gameObject?.userData?.layer;
604
- }
605
-
606
- /**
607
- * The name of the GameObject this component is attached to
608
- * Used for debugging and finding objects
609
- */
610
- get name(): string {
611
- if (this.gameObject?.name) {
612
- return this.gameObject.name;
613
- }
614
- return this.gameObject?.userData.name;
615
- }
616
- private __name?: string;
617
- set name(str: string) {
618
- if (this.gameObject) {
619
- if (!this.gameObject.userData) this.gameObject.userData = {}
620
- this.gameObject.userData.name = str;
621
- this.__name = str;
622
- }
623
- else {
624
- this.__name = str;
625
- }
626
- }
627
-
628
- /**
629
- * The tag of the GameObject this component is attached to
630
- * Used for categorizing objects and efficient lookup
631
- */
632
- get tag(): string {
633
- return this.gameObject?.userData.tag;
634
- }
635
- set tag(str: string) {
636
- if (this.gameObject) {
637
- if (!this.gameObject.userData) this.gameObject.userData = {}
638
- this.gameObject.userData.tag = str;
639
- }
640
- }
641
-
642
- /**
643
- * Indicates whether the GameObject is marked as static
644
- * Static objects typically don't move and can be optimized by the engine
645
- */
646
- get static() {
647
- return this.gameObject?.userData.static;
648
- }
649
- set static(value: boolean) {
650
- if (this.gameObject) {
651
- if (!this.gameObject.userData) this.gameObject.userData = {}
652
- this.gameObject.userData.static = value;
653
- }
654
- }
655
- // get hideFlags(): HideFlags {
656
- // return this.gameObject?.hideFlags;
657
- // }
658
-
659
- /**
660
- * Checks if this component is currently active (enabled and part of an active GameObject hierarchy)
661
- * Components that are inactive won't receive lifecycle method calls
662
- * @returns True if the component is enabled and all parent GameObjects are active
663
- */
664
- get activeAndEnabled(): boolean {
665
- if (this.destroyed) return false;
666
- if (this.__isEnabled === false) return false;
667
- if (!this.__isActiveInHierarchy) return false;
668
- // let go = this.gameObject;
669
- // do {
670
- // // console.log(go.name, go.visible)
671
- // if (!go.visible) return false;
672
- // go = go.parent as GameObject;
673
- // }
674
- // while (go);
675
- return true;
676
- }
677
-
678
- private get __isActive(): boolean {
679
- return this.gameObject.visible;
680
- }
681
-
682
- private get __isActiveInHierarchy(): boolean {
683
- if (!this.gameObject) return false;
684
- const res = this.gameObject[activeInHierarchyFieldName];
685
- if (res === undefined) return true;
686
- return res;
687
- }
688
-
689
- private set __isActiveInHierarchy(val: boolean) {
690
- if (!this.gameObject) return;
691
- this.gameObject[activeInHierarchyFieldName] = val;
692
- }
693
-
694
- /**
695
- * Reference to the GameObject this component is attached to
696
- * This is a three.js Object3D with additional GameObject functionality
697
- */
698
- gameObject!: GameObject;
699
-
700
- /**
701
- * Unique identifier for this component instance,
702
- * used for finding and tracking components
703
- */
704
- guid: string = "invalid";
705
-
706
- /**
707
- * Identifier for the source asset that created this component.
708
- * For example, URL to the glTF file this component was loaded from
709
- */
710
- sourceId?: SourceIdentifier;
711
-
712
- /**
713
- * Called when this component needs to remap guids after an instantiate operation.
714
- * @param guidsMap Mapping from old guids to newly generated guids
715
- */
716
- resolveGuids?(guidsMap: GuidsMap): void;
717
-
718
- /**
719
- * Called once when the component becomes active for the first time.
720
- * This is the first lifecycle callback to be invoked
721
- */
722
- awake() { }
723
-
724
- /**
725
- * Called every time the component becomes enabled or active in the hierarchy.
726
- * Invoked after {@link awake} and before {@link start}.
727
- */
728
- onEnable() { }
729
-
730
- /**
731
- * Called every time the component becomes disabled or inactive in the hierarchy.
732
- * Invoked when the component or any parent GameObject becomes invisible
733
- */
734
- onDisable() { }
735
-
736
- /**
737
- * Called when the component is destroyed.
738
- * Use for cleanup operations like removing event listeners
739
- */
740
- onDestroy() {
741
- this.__destroyed = true;
742
- }
743
-
744
- /**
745
- * Called when a field decorated with @validate() is modified.
746
- * @param prop The name of the field that was changed
747
- */
748
- onValidate?(prop?: string): void;
749
-
750
- /**
751
- * Called when the context's pause state changes.
752
- * @param isPaused Whether the context is currently paused
753
- * @param wasPaused The previous pause state
754
- */
755
- onPausedChanged?(isPaused: boolean, wasPaused: boolean): void;
756
-
757
- /**
758
- * Called once at the beginning of the first frame after the component is enabled.
759
- * Use for initialization that requires other components to be awake.
760
- */
761
- start?(): void;
762
-
763
- /**
764
- * Called at the beginning of each frame before regular updates.
765
- * Use for logic that needs to run before standard update callbacks.
766
- */
767
- earlyUpdate?(): void;
768
-
769
- /**
770
- * Called once per frame during the main update loop.
771
- * The primary location for frame-based game logic.
772
- */
773
- update?(): void;
774
-
775
- /**
776
- * Called after all update functions have been called.
777
- * Use for calculations that depend on other components being updated first.
778
- */
779
- lateUpdate?(): void;
780
-
781
- /**
782
- * Called immediately before the scene is rendered.
783
- * @param frame Current XRFrame if in an XR session, null otherwise
784
- */
785
- onBeforeRender?(frame: XRFrame | null): void;
786
-
787
- /**
788
- * Called after the scene has been rendered.
789
- * Use for post-processing or UI updates that should happen after rendering
790
- */
791
- onAfterRender?(): void;
792
-
793
- /**
794
- * Called when this component's collider begins colliding with another collider.
795
- * @param col Information about the collision that occurred
796
- */
797
- onCollisionEnter?(col: Collision);
798
-
799
- /**
800
- * Called when this component's collider stops colliding with another collider.
801
- * @param col Information about the collision that ended
802
- */
803
- onCollisionExit?(col: Collision);
804
-
805
- /**
806
- * Called each frame while this component's collider is colliding with another collider
807
- * @param col Information about the ongoing collision
808
- */
809
- onCollisionStay?(col: Collision);
810
-
811
- /**
812
- * Called when this component's trigger collider is entered by another collider
813
- * @param col The collider that entered this trigger
814
- */
815
- onTriggerEnter?(col: ICollider);
816
-
817
- /**
818
- * Called each frame while another collider is inside this component's trigger collider
819
- * @param col The collider that is inside this trigger
820
- */
821
- onTriggerStay?(col: ICollider);
822
-
823
- /**
824
- * Called when another collider exits this component's trigger collider
825
- * @param col The collider that exited this trigger
826
- */
827
- onTriggerExit?(col: ICollider);
828
-
829
- /**
830
- * Determines if this component supports a specific XR mode
831
- * @param mode The XR session mode to check support for
832
- * @returns True if the component supports the specified mode
833
- */
834
- supportsXR?(mode: XRSessionMode): boolean;
835
-
836
- /**
837
- * Called before an XR session is requested
838
- * Use to modify session initialization parameters
839
- * @param mode The XR session mode being requested
840
- * @param args The session initialization parameters that can be modified
841
- */
842
- onBeforeXR?(mode: XRSessionMode, args: XRSessionInit): void;
843
-
844
- /**
845
- * Called when this component joins an XR session or becomes active in a running session
846
- * @param args Event data for the XR session
847
- */
848
- onEnterXR?(args: NeedleXREventArgs): void;
849
-
850
- /**
851
- * Called each frame while this component is active in an XR session
852
- * @param args Event data for the current XR frame
853
- */
854
- onUpdateXR?(args: NeedleXREventArgs): void;
855
-
856
- /**
857
- * Called when this component exits an XR session or becomes inactive during a session
858
- * @param args Event data for the XR session
859
- */
860
- onLeaveXR?(args: NeedleXREventArgs): void;
861
-
862
- /**
863
- * Called when an XR controller is connected or when this component becomes active
864
- * in a session with existing controllers
865
- * @param args Event data for the controller that was added
866
- */
867
- onXRControllerAdded?(args: NeedleXRControllerEventArgs): void;
868
-
869
- /**
870
- * Called when an XR controller is disconnected or when this component becomes inactive
871
- * during a session with controllers
872
- * @param args Event data for the controller that was removed
873
- */
874
- onXRControllerRemoved?(args: NeedleXRControllerEventArgs): void;
875
-
876
- /**
877
- * Called when a pointer enters this component's GameObject
878
- * @param args Data about the pointer event
879
- */
880
- onPointerEnter?(args: PointerEventData);
881
-
882
- /**
883
- * Called when a pointer moves while over this component's GameObject
884
- * @param args Data about the pointer event
885
- */
886
- onPointerMove?(args: PointerEventData);
887
-
888
- /**
889
- * Called when a pointer exits this component's GameObject
890
- * @param args Data about the pointer event
891
- */
892
- onPointerExit?(args: PointerEventData);
893
-
894
- /**
895
- * Called when a pointer button is pressed while over this component's GameObject
896
- * @param args Data about the pointer event
897
- */
898
- onPointerDown?(args: PointerEventData);
899
-
900
- /**
901
- * Called when a pointer button is released while over this component's GameObject
902
- * @param args Data about the pointer event
903
- */
904
- onPointerUp?(args: PointerEventData);
905
-
906
- /**
907
- * Called when a pointer completes a click interaction with this component's GameObject
908
- * @param args Data about the pointer event
909
- */
910
- onPointerClick?(args: PointerEventData);
911
-
912
- /**
913
- * Starts a coroutine that can yield to wait for events.
914
- * Coroutines allow for time-based sequencing of operations without blocking.
915
- * Coroutines are based on generator functions, a JavaScript language feature.
916
- *
917
- * @param routine Generator function to start
918
- * @param evt Event to register the coroutine for (default: FrameEvent.Update)
919
- * @returns The generator function that can be used to stop the coroutine
920
- * @example
921
- * Time-based sequencing of operations
922
- * ```ts
923
- * *myCoroutine() {
924
- * yield WaitForSeconds(1); // wait for 1 second
925
- * yield WaitForFrames(10); // wait for 10 frames
926
- * yield new Promise(resolve => setTimeout(resolve, 1000)); // wait for a promise to resolve
927
- * }
928
- * ```
929
- * @example
930
- * Coroutine that logs a message every 5 frames
931
- * ```ts
932
- * onEnable() {
933
- * this.startCoroutine(this.myCoroutine());
934
- * }
935
- * private *myCoroutine() {
936
- * while(this.activeAndEnabled) {
937
- * console.log("Hello World", this.context.time.frame);
938
- * // wait for 5 frames
939
- * for(let i = 0; i < 5; i++) yield;
940
- * }
941
- * }
942
- * ```
943
- */
944
- startCoroutine(routine: Generator, evt: FrameEvent = FrameEvent.Update): Generator {
945
- return this.context.registerCoroutineUpdate(this, routine, evt);
946
- }
947
-
948
- /**
949
- * Stops a coroutine that was previously started with startCoroutine
950
- * @param routine The routine to be stopped
951
- * @param evt The frame event the routine was registered with
952
- */
953
- stopCoroutine(routine: Generator, evt: FrameEvent = FrameEvent.Update): void {
954
- this.context.unregisterCoroutineUpdate(routine, evt);
955
- }
956
-
957
- /**
958
- * Checks if this component has been destroyed
959
- * @returns True if the component or its GameObject has been destroyed
960
- */
961
- public get destroyed(): boolean {
962
- return this.__destroyed;
963
- }
964
-
965
- /**
966
- * Destroys this component and removes it from its GameObject
967
- * After destruction, the component will no longer receive lifecycle callbacks
968
- */
969
- public destroy() {
970
- if (this.__destroyed) return;
971
- this.__internalDestroy();
972
- }
973
-
974
- /** @internal */
975
- protected __didAwake: boolean = false;
976
-
977
- /** @internal */
978
- private __didStart: boolean = false;
979
-
980
- /** @internal */
981
- protected __didEnable: boolean = false;
982
-
983
- /** @internal */
984
- protected __isEnabled: boolean | undefined = undefined;
985
-
986
- /** @internal */
987
- private __destroyed: boolean = false;
988
-
989
- /** @internal */
990
- get __internalDidAwakeAndStart() { return this.__didAwake && this.__didStart; }
991
-
992
- /** @internal */
993
- constructor(init?: ComponentInit<Component>) {
994
- this.__didAwake = false;
995
- this.__didStart = false;
996
- this.__didEnable = false;
997
- this.__isEnabled = undefined;
998
- this.__destroyed = false;
999
- this._internalInit(init as ComponentInit<this>);
1000
- }
1001
-
1002
- /** @internal */
1003
- __internalNewInstanceCreated(init?: ComponentInit<this>): this {
1004
- this.__didAwake = false;
1005
- this.__didStart = false;
1006
- this.__didEnable = false;
1007
- this.__isEnabled = undefined;
1008
- this.__destroyed = false;
1009
- this._internalInit(init);
1010
- return this;
1011
- }
1012
-
1013
- /**
1014
- * Initializes component properties from an initialization object
1015
- * @param init Object with properties to copy to this component
1016
- * @internal
1017
- */
1018
- _internalInit(init?: ComponentInit<this>) {
1019
- if (typeof init === "object") {
1020
- for (const key of Object.keys(init)) {
1021
- const value = init[key];
1022
- // we don't want to allow overriding functions via init
1023
- if (typeof value === "function") continue;
1024
- (this as any)[key] = value;
1025
- }
1026
- }
1027
- }
1028
-
1029
- /** @internal */
1030
- __internalAwake() {
1031
- if (this.__didAwake) return;
1032
- this.__didAwake = true;
1033
- this.awake();
1034
- }
1035
-
1036
-
1037
- /** @internal */
1038
- __internalStart() {
1039
- if (this.__didStart) return;
1040
- this.__didStart = true;
1041
- if (this.start) this.start();
1042
- }
1043
-
1044
-
1045
- /** @internal */
1046
- __internalEnable(isAddingToScene?: boolean): boolean {
1047
- if (this.__destroyed) {
1048
- if (isDevEnvironment()) {
1049
- console.warn("[Needle Engine Dev] Trying to enable destroyed component");
1050
- }
1051
- return false;
1052
- }
1053
- // Don't change enable before awake
1054
- // But a user can change enable during awake
1055
- if (!this.__didAwake) return false;
1056
- if (this.__didEnable) {
1057
- // We dont want to change the enable state if we are adding to scene
1058
- // But we want to change the state when e.g. a user changes the enable state during awake
1059
- if (isAddingToScene !== true)
1060
- this.__isEnabled = true;
1061
- return false;
1062
- }
1063
- // console.trace("INTERNAL ENABLE");
1064
- this.__didEnable = true;
1065
- this.__isEnabled = true;
1066
- this.onEnable();
1067
- return true;
1068
- }
1069
-
1070
- /** @internal */
1071
- __internalDisable(isRemovingFromScene?: boolean) {
1072
- // Don't change enable before awake
1073
- // But a user can change enable during awake
1074
- if (!this.__didAwake) return;
1075
- if (!this.__didEnable) {
1076
- // We dont want to change the enable state if we are removing from a scene
1077
- if (isRemovingFromScene !== true)
1078
- this.__isEnabled = false;
1079
- return;
1080
- }
1081
- this.__didEnable = false;
1082
- this.__isEnabled = false;
1083
- this.onDisable();
1084
- }
1085
-
1086
- /** @internal */
1087
- __internalDestroy() {
1088
- if (this.__destroyed) return;
1089
- this.__destroyed = true;
1090
- if (this.__didAwake) {
1091
- this.onDestroy?.call(this);
1092
- this.dispatchEvent(new CustomEvent("destroyed", { detail: this }));
1093
- }
1094
- destroyComponentInstance(this as any);
1095
- }
1096
-
1097
- /**
1098
- * Controls whether this component is enabled
1099
- * Disabled components don't receive lifecycle callbacks
1100
- */
1101
- get enabled(): boolean {
1102
- return typeof this.__isEnabled === "boolean" ? this.__isEnabled : true; // if it has no enabled field it is always enabled
1103
- }
1104
- set enabled(val: boolean) {
1105
- if (this.__destroyed) {
1106
- if (isDevEnvironment()) {
1107
- console.warn(`[Needle Engine Dev] Trying to ${val ? "enable" : "disable"} destroyed component`);
1108
- }
1109
- return;
1110
- }
1111
- // when called from animationclip we receive numbers
1112
- // due to interpolation they can be anything between 0 and 1
1113
- if (typeof val === "number") {
1114
- if (val >= 0.5) val = true;
1115
- else val = false;
1116
- }
1117
-
1118
- // need to check here because codegen is calling this before everything is setup
1119
- if (!this.__didAwake) {
1120
- this.__isEnabled = val;
1121
- return;
1122
- }
1123
- if (val) {
1124
- this.__internalEnable();
1125
- } else {
1126
- this.__internalDisable();
1127
- }
1128
- }
1129
-
1130
- /**
1131
- * Gets the position of this component's GameObject in world space.
1132
- * Note: This is equivalent to calling `this.gameObject.worldPosition`
1133
- */
1134
- get worldPosition(): Vector3 {
1135
- return threeutils.getWorldPosition(this.gameObject);
1136
- }
1137
-
1138
- /**
1139
- * Sets the position of this component's GameObject in world space
1140
- * @param val The world position vector to set
1141
- */
1142
- set worldPosition(val: Vector3) {
1143
- threeutils.setWorldPosition(this.gameObject, val);
1144
- }
1145
-
1146
- /**
1147
- * Sets the position of this component's GameObject in world space using individual coordinates
1148
- * @param x X-coordinate in world space
1149
- * @param y Y-coordinate in world space
1150
- * @param z Z-coordinate in world space
1151
- */
1152
- setWorldPosition(x: number, y: number, z: number) {
1153
- threeutils.setWorldPositionXYZ(this.gameObject, x, y, z);
1154
- }
1155
-
1156
- /**
1157
- * Gets the rotation of this component's GameObject in world space as a quaternion
1158
- * Note: This is equivalent to calling `this.gameObject.worldQuaternion`
1159
- */
1160
- get worldQuaternion(): Quaternion {
1161
- return threeutils.getWorldQuaternion(this.gameObject);
1162
- }
1163
-
1164
- /**
1165
- * Sets the rotation of this component's GameObject in world space using a quaternion
1166
- * @param val The world rotation quaternion to set
1167
- */
1168
- set worldQuaternion(val: Quaternion) {
1169
- threeutils.setWorldQuaternion(this.gameObject, val);
1170
- }
1171
-
1172
- /**
1173
- * Sets the rotation of this component's GameObject in world space using quaternion components
1174
- * @param x X component of the quaternion
1175
- * @param y Y component of the quaternion
1176
- * @param z Z component of the quaternion
1177
- * @param w W component of the quaternion
1178
- */
1179
- setWorldQuaternion(x: number, y: number, z: number, w: number) {
1180
- threeutils.setWorldQuaternionXYZW(this.gameObject, x, y, z, w);
1181
- }
1182
-
1183
- /**
1184
- * Gets the rotation of this component's GameObject in world space as Euler angles (in radians)
1185
- */
1186
- get worldEuler(): Euler {
1187
- return threeutils.getWorldEuler(this.gameObject);
1188
- }
1189
-
1190
- /**
1191
- * Sets the rotation of this component's GameObject in world space using Euler angles (in radians)
1192
- * @param val The world rotation Euler angles to set
1193
- */
1194
- set worldEuler(val: Euler) {
1195
- threeutils.setWorldEuler(this.gameObject, val);
1196
- }
1197
-
1198
- /**
1199
- * Gets the rotation of this component's GameObject in world space as Euler angles (in degrees)
1200
- * Note: This is equivalent to calling `this.gameObject.worldRotation`
1201
- */
1202
- get worldRotation(): Vector3 {
1203
- return this.gameObject.worldRotation;
1204
- }
1205
-
1206
- /**
1207
- * Sets the rotation of this component's GameObject in world space using Euler angles (in degrees)
1208
- * @param val The world rotation vector to set (in degrees)
1209
- */
1210
- set worldRotation(val: Vector3) {
1211
- this.setWorldRotation(val.x, val.y, val.z, true);
1212
- }
1213
-
1214
- /**
1215
- * Sets the rotation of this component's GameObject in world space using individual Euler angles
1216
- * @param x X-axis rotation
1217
- * @param y Y-axis rotation
1218
- * @param z Z-axis rotation
1219
- * @param degrees Whether the values are in degrees (true) or radians (false)
1220
- */
1221
- setWorldRotation(x: number, y: number, z: number, degrees: boolean = true) {
1222
- threeutils.setWorldRotationXYZ(this.gameObject, x, y, z, degrees);
1223
- }
1224
-
1225
- private static _forward: Vector3 = new Vector3();
1226
- /**
1227
- * Gets the forward direction vector (0,0,-1) of this component's GameObject in world space
1228
- */
1229
- public get forward(): Vector3 {
1230
- return Component._forward.set(0, 0, -1).applyQuaternion(this.worldQuaternion);
1231
- }
1232
- private static _right: Vector3 = new Vector3();
1233
- /**
1234
- * Gets the right direction vector (1,0,0) of this component's GameObject in world space
1235
- */
1236
- public get right(): Vector3 {
1237
- return Component._right.set(1, 0, 0).applyQuaternion(this.worldQuaternion);
1238
- }
1239
- private static _up: Vector3 = new Vector3();
1240
- /**
1241
- * Gets the up direction vector (0,1,0) of this component's GameObject in world space
1242
- */
1243
- public get up(): Vector3 {
1244
- return Component._up.set(0, 1, 0).applyQuaternion(this.worldQuaternion);
1245
- }
1246
-
1247
- // EventTarget implementation:
1248
-
1249
- /**
1250
- * Storage for event listeners registered to this component
1251
- * @private
1252
- */
1253
- private _eventListeners = new Map<string, EventListener[]>();
1254
-
1255
- /**
1256
- * Registers an event listener for the specified event type
1257
- * @param type The event type to listen for
1258
- * @param listener The callback function to execute when the event occurs
1259
- */
1260
- addEventListener<T extends Event>(type: string, listener: (evt: T) => any) {
1261
- this._eventListeners[type] = this._eventListeners[type] || [];
1262
- this._eventListeners[type].push(listener);
1263
- }
1264
-
1265
- /**
1266
- * Removes a previously registered event listener
1267
- * @param type The event type the listener was registered for
1268
- * @param listener The callback function to remove
1269
- */
1270
- removeEventListener<T extends Event>(type: string, listener: (arg: T) => any) {
1271
- if (!this._eventListeners[type]) return;
1272
- const index = this._eventListeners[type].indexOf(listener);
1273
- if (index >= 0) this._eventListeners[type].splice(index, 1);
1274
- }
1275
-
1276
- /**
1277
- * Dispatches an event to all registered listeners
1278
- * @param evt The event object to dispatch
1279
- * @returns Always returns false (standard implementation of EventTarget)
1280
- */
1281
- dispatchEvent(evt: Event): boolean {
1282
- if (!evt || !this._eventListeners[evt.type]) return false;
1283
- const listeners = this._eventListeners[evt.type];
1284
- for (let i = 0; i < listeners.length; i++) {
1285
- listeners[i](evt);
1286
- }
1287
-
1288
- return false;
1289
- }
1290
- }
1291
-
1292
- // For legacy reasons we need to export this as well
1293
- // (and we don't use extend to inherit the component docs)
1294
- export { Component as Behaviour };
1
+ import { Euler, Object3D, Quaternion, Scene, Vector3 } from "three";
2
+
3
+ import { isDevEnvironment } from "../engine/debug/index.js";
4
+ import { type AssetReference } from "../engine/engine_addressables.js";
5
+ import { addComponent, destroyComponentInstance, findObjectOfType, findObjectsOfType, getComponent, getComponentInChildren, getComponentInParent, getComponents, getComponentsInChildren, getComponentsInParent, getOrAddComponent, removeComponent } from "../engine/engine_components.js";
6
+ import { activeInHierarchyFieldName } from "../engine/engine_constants.js";
7
+ import { destroy, findByGuid, foreachComponent, type IInstantiateOptions, instantiate, isActiveInHierarchy, isActiveSelf, isDestroyed, isUsingInstancing, markAsInstancedRendered, setActive } from "../engine/engine_gameobject.js";
8
+ import * as main from "../engine/engine_mainloop_utils.js";
9
+ import { syncDestroy, syncInstantiate, SyncInstantiateOptions } from "../engine/engine_networking_instantiate.js";
10
+ import { Context, FrameEvent } from "../engine/engine_setup.js";
11
+ import * as threeutils from "../engine/engine_three_utils.js";
12
+ import type { Collision, ComponentInit, Constructor, ConstructorConcrete, GuidsMap, ICollider, IComponent, IGameObject, SourceIdentifier } from "../engine/engine_types.js";
13
+ import type { INeedleXRSessionEventReceiver, NeedleXRControllerEventArgs, NeedleXREventArgs } from "../engine/engine_xr.js";
14
+ import { type IPointerEventHandler, PointerEventData } from "./ui/PointerEvents.js";
15
+
16
+
17
+ // export interface ISerializationCallbackReceiver {
18
+ // onBeforeSerialize?(): object | void;
19
+ // onAfterSerialize?();
20
+ // onBeforeDeserialize?(data?: any);
21
+ // onAfterDeserialize?();
22
+ // onDeserialize?(key: string, value: any): any | void;
23
+ // }
24
+
25
+ /**
26
+ * Base class for objects in Needle Engine. Extends {@link Object3D} from three.js.
27
+ * GameObjects can have components attached to them, which can be used to add functionality to the object.
28
+ * They manage their components and provide methods to add, remove and get components.
29
+ *
30
+ * All {@link Object3D} types loaded in Needle Engine have methods like {@link addComponent}.
31
+ * These methods are available directly on the GameObject instance:
32
+ * ```typescript
33
+ * target.addComponent(MyComponent);
34
+ * ```
35
+ *
36
+ * And can be called statically on the GameObject class as well:
37
+ * ```typescript
38
+ * GameObject.setActive(target, true);
39
+ * ```
40
+ */
41
+ export abstract class GameObject extends Object3D implements Object3D, IGameObject {
42
+
43
+ /**
44
+ * Indicates if the GameObject is currently active. Inactive GameObjects will not be rendered or updated.
45
+ * When the activeSelf state changes, components will receive {@link Component.onEnable} or {@link Component.onDisable} callbacks.
46
+ */
47
+ abstract activeSelf: boolean;
48
+
49
+ /** @deprecated Use {@link addComponent} instead */
50
+ // eslint-disable-next-line deprecation/deprecation
51
+ abstract addNewComponent<T extends IComponent>(type: ConstructorConcrete<T>, init?: ComponentInit<T>): T;
52
+
53
+ /**
54
+ * Creates a new component on this gameObject or adds an existing component instance
55
+ * @param comp Component type constructor or existing component instance
56
+ * @param init Optional initialization values for the component
57
+ * @returns The newly created or added component
58
+ */
59
+ abstract addComponent<T extends IComponent>(comp: T | ConstructorConcrete<T>, init?: ComponentInit<T>): T;
60
+
61
+ /**
62
+ * Removes a component from this GameObject
63
+ * @param comp Component instance to remove
64
+ * @returns The removed component
65
+ */
66
+ abstract removeComponent<T extends IComponent>(comp: T): T;
67
+
68
+ /**
69
+ * Gets an existing component of the specified type or adds a new one if it doesn't exist
70
+ * @param typeName Constructor of the component type to get or add
71
+ * @returns The existing or newly added component
72
+ */
73
+ abstract getOrAddComponent<T>(typeName: ConstructorConcrete<T> | null): T;
74
+
75
+ /**
76
+ * Gets a component of the specified type attached to this GameObject
77
+ * @param type Constructor of the component type to get
78
+ * @returns The component if found, otherwise null
79
+ */
80
+ abstract getComponent<T>(type: Constructor<T>): T | null;
81
+
82
+ /**
83
+ * Gets all components of the specified type attached to this GameObject
84
+ * @param type Constructor of the component type to get
85
+ * @param arr Optional array to populate with the components
86
+ * @returns Array of components
87
+ */
88
+ abstract getComponents<T>(type: Constructor<T>, arr?: T[]): Array<T>;
89
+
90
+ /**
91
+ * Gets a component of the specified type in this GameObject's children hierarchy
92
+ * @param type Constructor of the component type to get
93
+ * @returns The first matching component if found, otherwise null
94
+ */
95
+ abstract getComponentInChildren<T>(type: Constructor<T>): T | null;
96
+
97
+ /**
98
+ * Gets all components of the specified type in this GameObject's children hierarchy
99
+ * @param type Constructor of the component type to get
100
+ * @param arr Optional array to populate with the components
101
+ * @returns Array of components
102
+ */
103
+ abstract getComponentsInChildren<T>(type: Constructor<T>, arr?: T[]): Array<T>;
104
+
105
+ /**
106
+ * Gets a component of the specified type in this GameObject's parent hierarchy
107
+ * @param type Constructor of the component type to get
108
+ * @returns The first matching component if found, otherwise null
109
+ */
110
+ abstract getComponentInParent<T>(type: Constructor<T>): T | null;
111
+
112
+ /**
113
+ * Gets all components of the specified type in this GameObject's parent hierarchy
114
+ * @param type Constructor of the component type to get
115
+ * @param arr Optional array to populate with the components
116
+ * @returns Array of components
117
+ */
118
+ abstract getComponentsInParent<T>(type: Constructor<T>, arr?: T[]): Array<T>;
119
+
120
+
121
+ /**
122
+ * The position of this GameObject in world space
123
+ */
124
+ abstract get worldPosition(): Vector3
125
+ abstract set worldPosition(val: Vector3);
126
+
127
+ /**
128
+ * The rotation of this GameObject in world space as a quaternion
129
+ */
130
+ abstract set worldQuaternion(val: Quaternion);
131
+ abstract get worldQuaternion(): Quaternion;
132
+
133
+ /**
134
+ * The rotation of this GameObject in world space in euler angles (degrees)
135
+ */
136
+ abstract set worldRotation(val: Vector3);
137
+ abstract get worldRotation(): Vector3;
138
+
139
+ /**
140
+ * The scale of this GameObject in world space
141
+ */
142
+ abstract set worldScale(val: Vector3);
143
+ abstract get worldScale(): Vector3;
144
+
145
+ /**
146
+ * The forward direction vector of this GameObject in world space
147
+ */
148
+ abstract get worldForward(): Vector3;
149
+
150
+ /**
151
+ * The right direction vector of this GameObject in world space
152
+ */
153
+ abstract get worldRight(): Vector3;
154
+
155
+ /**
156
+ * The up direction vector of this GameObject in world space
157
+ */
158
+ abstract get worldUp(): Vector3;
159
+
160
+ /**
161
+ * Unique identifier for this GameObject
162
+ */
163
+ guid: string | undefined;
164
+
165
+ /**
166
+ * Destroys this GameObject and all its components.
167
+ * Internally, this is added to the three.js {@link Object3D} prototype.
168
+ */
169
+ abstract destroy();
170
+
171
+
172
+ /**
173
+ * Checks if a GameObject has been destroyed
174
+ * @param go The GameObject to check
175
+ * @returns True if the GameObject has been destroyed
176
+ */
177
+ public static isDestroyed(go: Object3D): boolean {
178
+ return isDestroyed(go);
179
+ }
180
+
181
+ /**
182
+ * Sets the active state of a GameObject
183
+ * @param go The GameObject to modify
184
+ * @param active Whether the GameObject should be active
185
+ * @param processStart Whether to process the start callbacks if being activated
186
+ */
187
+ public static setActive(go: Object3D, active: boolean, processStart: boolean = true) {
188
+ if (!go) return;
189
+ setActive(go, active);
190
+
191
+ // TODO: do we still need this?:
192
+ main.updateIsActive(go);
193
+ if (active && processStart)
194
+ main.processStart(Context.Current, go);
195
+ }
196
+
197
+ /**
198
+ * Checks if the GameObject itself is active (same as go.visible)
199
+ * @param go The GameObject to check
200
+ * @returns True if the GameObject is active
201
+ */
202
+ public static isActiveSelf(go: Object3D): boolean {
203
+ return isActiveSelf(go);
204
+ }
205
+
206
+ /**
207
+ * Checks if the GameObject is active in the hierarchy (e.g. if any parent is invisible or not in the scene it will be false)
208
+ * @param go The GameObject to check
209
+ * @returns True if the GameObject is active in the hierarchy
210
+ */
211
+ public static isActiveInHierarchy(go: Object3D): boolean {
212
+ return isActiveInHierarchy(go);
213
+ }
214
+
215
+ /**
216
+ * Marks a GameObject to be rendered using instancing
217
+ * @param go The GameObject to mark
218
+ * @param instanced Whether the GameObject should use instanced rendering
219
+ */
220
+ public static markAsInstancedRendered(go: Object3D, instanced: boolean) {
221
+ markAsInstancedRendered(go, instanced);
222
+ }
223
+
224
+ /**
225
+ * Checks if a GameObject is using instanced rendering
226
+ * @param instance The GameObject to check
227
+ * @returns True if the GameObject is using instanced rendering
228
+ */
229
+ public static isUsingInstancing(instance: Object3D): boolean { return isUsingInstancing(instance); }
230
+
231
+ /**
232
+ * Executes a callback for all components of the provided type on the provided object and its children
233
+ * @param instance Object to run the method on
234
+ * @param cb Callback to run on each component, "return undefined;" to continue and "return <anything>;" to break the loop
235
+ * @param recursive If true, the method will be run on all children as well
236
+ * @returns The last return value of the callback
237
+ */
238
+ public static foreachComponent(instance: Object3D, cb: (comp: Component) => any, recursive: boolean = true): any {
239
+ return foreachComponent(instance, cb as (comp: IComponent) => any, recursive);
240
+ }
241
+
242
+ /**
243
+ * Creates a new instance of the provided object that will be replicated to all connected clients
244
+ * @param instance Object to instantiate
245
+ * @param opts Options for the instantiation
246
+ * @returns The newly created instance or null if creation failed
247
+ */
248
+ public static instantiateSynced(instance: GameObject | Object3D | null, opts: SyncInstantiateOptions): GameObject | null {
249
+ if (!instance) return null;
250
+ return syncInstantiate(instance, opts) as GameObject | null;
251
+ }
252
+
253
+ /**
254
+ * Creates a new instance of the provided object (like cloning it including all components and children)
255
+ * @param instance Object to instantiate
256
+ * @param opts Options for the instantiation (e.g. with what parent, position, etc.)
257
+ * @returns The newly created instance
258
+ */
259
+ public static instantiate(instance: AssetReference, opts?: IInstantiateOptions | null | undefined): Promise<Object3D | null>
260
+ public static instantiate(instance: GameObject | Object3D, opts?: IInstantiateOptions | null | undefined): GameObject
261
+ public static instantiate(instance: AssetReference | GameObject | Object3D, opts: IInstantiateOptions | null | undefined = null): GameObject | Promise<Object3D | null> {
262
+ if ('isAssetReference' in instance) {
263
+ return instantiate(instance as AssetReference, opts);
264
+ }
265
+ return instantiate(instance as GameObject | Object3D, opts) as GameObject;
266
+ }
267
+
268
+ /**
269
+ * Destroys an object on all connected clients (if in a networked session)
270
+ * @param instance Object to destroy
271
+ * @param context Optional context to use
272
+ * @param recursive If true, all children will be destroyed as well
273
+ */
274
+ public static destroySynced(instance: Object3D | Component, context?: Context, recursive: boolean = true) {
275
+ if (!instance) return;
276
+ const go = instance as GameObject;
277
+ context = context ?? Context.Current;
278
+ syncDestroy(go as any, context.connection, recursive);
279
+ }
280
+
281
+ /**
282
+ * Destroys an object
283
+ * @param instance Object to destroy
284
+ * @param recursive If true, all children will be destroyed as well. Default: true
285
+ */
286
+ public static destroy(instance: Object3D | Component, recursive: boolean = true) {
287
+ return destroy(instance, recursive);
288
+ }
289
+
290
+ /**
291
+ * Adds an object to parent and ensures all components are properly registered
292
+ * @param instance Object to add
293
+ * @param parent Parent to add the object to
294
+ * @param context Optional context to use
295
+ */
296
+ public static add(instance: Object3D | null | undefined, parent: Object3D, context?: Context) {
297
+ if (!instance || !parent) return;
298
+ if (instance === parent) {
299
+ console.warn("Can not add object to self", instance);
300
+ return;
301
+ }
302
+ if (!context) {
303
+ context = Context.Current;
304
+ }
305
+ parent.add(instance);
306
+ setActive(instance, true);
307
+ main.updateIsActive(instance);
308
+ if (context) {
309
+ GameObject.foreachComponent(instance, (comp: Component) => {
310
+ main.addScriptToArrays(comp, context!);
311
+ if (comp.__internalDidAwakeAndStart) return;
312
+ if (context!.new_script_start.includes(comp) === false) {
313
+ context!.new_script_start.push(comp as Component);
314
+ }
315
+ }, true);
316
+ }
317
+ else {
318
+ console.warn("Missing context");
319
+ }
320
+ }
321
+
322
+ /**
323
+ * Removes the object from its parent and deactivates all of its components
324
+ * @param instance Object to remove
325
+ */
326
+ public static remove(instance: Object3D | null | undefined) {
327
+ if (!instance) return;
328
+ instance.parent?.remove(instance);
329
+ setActive(instance, false);
330
+ main.updateIsActive(instance);
331
+ GameObject.foreachComponent(instance, (comp) => {
332
+ main.processRemoveFromScene(comp);
333
+ }, true);
334
+ }
335
+
336
+ /**
337
+ * Invokes a method on all components including children (if a method with that name exists)
338
+ * @param go GameObject to invoke the method on
339
+ * @param functionName Name of the method to invoke
340
+ * @param args Arguments to pass to the method
341
+ */
342
+ public static invokeOnChildren(go: Object3D | null | undefined, functionName: string, ...args: any) {
343
+ this.invoke(go, functionName, true, args);
344
+ }
345
+
346
+ /**
347
+ * Invokes a method on all components that have a method matching the provided name
348
+ * @param go GameObject to invoke the method on
349
+ * @param functionName Name of the method to invoke
350
+ * @param children Whether to invoke on children as well
351
+ * @param args Arguments to pass to the method
352
+ */
353
+ public static invoke(go: Object3D | null | undefined, functionName: string, children: boolean = false, ...args: any) {
354
+ if (!go) return;
355
+ this.foreachComponent(go, c => {
356
+ const fn = c[functionName];
357
+ if (fn && typeof fn === "function") {
358
+ fn?.call(c, ...args)
359
+ }
360
+ }, children);
361
+ }
362
+
363
+ /** @deprecated use `addComponent` */
364
+ // eslint-disable-next-line deprecation/deprecation
365
+ public static addNewComponent<T extends IComponent>(go: IGameObject | Object3D, type: T | ConstructorConcrete<T>, init?: ComponentInit<T>, callAwake: boolean = true): T {
366
+ return addComponent(go, type, init, { callAwake });
367
+ }
368
+
369
+ /**
370
+ * Adds a new component (or moves an existing component) to the provided object
371
+ * @param go Object to add the component to
372
+ * @param instanceOrType If an instance is provided it will be moved to the new object, if a type is provided a new instance will be created
373
+ * @param init Optional init object to initialize the component with
374
+ * @param opts Optional options for adding the component
375
+ * @returns The added or moved component
376
+ */
377
+ public static addComponent<T extends IComponent>(go: IGameObject | Object3D, instanceOrType: T | ConstructorConcrete<T>, init?: ComponentInit<T>, opts?: { callAwake: boolean }): T {
378
+ return addComponent(go, instanceOrType, init, opts);
379
+ }
380
+
381
+ /**
382
+ * Moves a component to a new object
383
+ * @param go GameObject to move the component to
384
+ * @param instance Component to move
385
+ * @returns The moved component
386
+ */
387
+ public static moveComponent<T extends IComponent>(go: IGameObject | Object3D, instance: T | ConstructorConcrete<T>): T {
388
+ return addComponent(go, instance);
389
+ }
390
+
391
+ /**
392
+ * Removes a component from its object
393
+ * @param instance Component to remove
394
+ * @returns The removed component
395
+ */
396
+ public static removeComponent<T extends IComponent>(instance: T): T {
397
+ removeComponent(instance.gameObject, instance as any);
398
+ return instance;
399
+ }
400
+
401
+ /**
402
+ * Gets or adds a component of the specified type
403
+ * @param go GameObject to get or add the component to
404
+ * @param typeName Constructor of the component type
405
+ * @returns The existing or newly added component
406
+ */
407
+ public static getOrAddComponent<T extends IComponent>(go: IGameObject | Object3D, typeName: ConstructorConcrete<T>): T {
408
+ return getOrAddComponent<any>(go, typeName);
409
+ }
410
+
411
+ /**
412
+ * Gets a component on the provided object
413
+ * @param go GameObject to get the component from
414
+ * @param typeName Constructor of the component type
415
+ * @returns The component if found, otherwise null
416
+ */
417
+ public static getComponent<T extends IComponent>(go: IGameObject | Object3D | null, typeName: Constructor<T> | null): T | null {
418
+ if (go === null) return null;
419
+ // if names are minified we could also use the type store and work with strings everywhere
420
+ // not ideal, but I dont know a good/sane way to do this otherwise
421
+ // const res = TypeStore.get(typeName);
422
+ // if(res) typeName = res;
423
+ return getComponent(go, typeName as any);
424
+ }
425
+
426
+ /**
427
+ * Gets all components of the specified type on the provided object
428
+ * @param go GameObject to get the components from
429
+ * @param typeName Constructor of the component type
430
+ * @param arr Optional array to populate with the components
431
+ * @returns Array of components
432
+ */
433
+ public static getComponents<T extends IComponent>(go: IGameObject | Object3D | null, typeName: Constructor<T>, arr: T[] | null = null): T[] {
434
+ if (go === null) return arr ?? [];
435
+ return getComponents(go, typeName, arr);
436
+ }
437
+
438
+ /**
439
+ * Finds an object or component by its unique identifier
440
+ * @param guid Unique identifier to search for
441
+ * @param hierarchy Root object to search in
442
+ * @returns The found GameObject or Component, or null/undefined if not found
443
+ */
444
+ public static findByGuid(guid: string, hierarchy: Object3D): GameObject | Component | null | undefined {
445
+ const res = findByGuid(guid, hierarchy);
446
+ return res as GameObject | Component | null | undefined;
447
+ }
448
+
449
+ /**
450
+ * Finds the first object of the specified component type in the scene
451
+ * @param typeName Constructor of the component type
452
+ * @param context Context or root object to search in
453
+ * @param includeInactive Whether to include inactive objects in the search
454
+ * @returns The first matching component if found, otherwise null
455
+ */
456
+ public static findObjectOfType<T extends IComponent>(typeName: Constructor<T>, context?: Context | Object3D, includeInactive: boolean = true): T | null {
457
+ return findObjectOfType(typeName, context ?? Context.Current, includeInactive);
458
+ }
459
+
460
+ /**
461
+ * Finds all objects of the specified component type in the scene
462
+ * @param typeName Constructor of the component type
463
+ * @param context Context or root object to search in
464
+ * @returns Array of matching components
465
+ */
466
+ public static findObjectsOfType<T extends IComponent>(typeName: Constructor<T>, context?: Context | Object3D): Array<T> {
467
+ const arr = [];
468
+ findObjectsOfType(typeName, arr, context);
469
+ return arr;
470
+ }
471
+
472
+ /**
473
+ * Gets a component of the specified type in the gameObject's children hierarchy
474
+ * @param go GameObject to search in
475
+ * @param typeName Constructor of the component type
476
+ * @returns The first matching component if found, otherwise null
477
+ */
478
+ public static getComponentInChildren<T extends IComponent>(go: IGameObject | Object3D, typeName: Constructor<T>): T | null {
479
+ return getComponentInChildren(go, typeName);
480
+ }
481
+
482
+ /**
483
+ * Gets all components of the specified type in the gameObject's children hierarchy
484
+ * @param go GameObject to search in
485
+ * @param typeName Constructor of the component type
486
+ * @param arr Optional array to populate with the components
487
+ * @returns Array of components
488
+ */
489
+ public static getComponentsInChildren<T extends IComponent>(go: IGameObject | Object3D, typeName: Constructor<T>, arr: T[] | null = null): Array<T> {
490
+ return getComponentsInChildren<T>(go, typeName, arr ?? undefined) as T[]
491
+ }
492
+
493
+ /**
494
+ * Gets a component of the specified type in the gameObject's parent hierarchy
495
+ * @param go GameObject to search in
496
+ * @param typeName Constructor of the component type
497
+ * @returns The first matching component if found, otherwise null
498
+ */
499
+ public static getComponentInParent<T extends IComponent>(go: IGameObject | Object3D, typeName: Constructor<T>): T | null {
500
+ return getComponentInParent(go, typeName);
501
+ }
502
+
503
+ /**
504
+ * Gets all components of the specified type in the gameObject's parent hierarchy
505
+ * @param go GameObject to search in
506
+ * @param typeName Constructor of the component type
507
+ * @param arr Optional array to populate with the components
508
+ * @returns Array of components
509
+ */
510
+ public static getComponentsInParent<T extends IComponent>(go: IGameObject | Object3D, typeName: Constructor<T>, arr: Array<T> | null = null): Array<T> {
511
+ return getComponentsInParent(go, typeName, arr);
512
+ }
513
+
514
+ /**
515
+ * Gets all components on the gameObject
516
+ * @param go GameObject to get components from
517
+ * @returns Array of all components
518
+ */
519
+ public static getAllComponents(go: IGameObject | Object3D): Component[] {
520
+ const componentsList = go.userData?.components;
521
+ if (!componentsList) return [];
522
+ const newList = [...componentsList];
523
+ return newList;
524
+ }
525
+
526
+ /**
527
+ * Iterates through all components on the gameObject
528
+ * @param go GameObject to iterate components on
529
+ * @returns Generator yielding each component
530
+ */
531
+ public static *iterateComponents(go: IGameObject | Object3D) {
532
+ const list = go?.userData?.components;
533
+ if (list && Array.isArray(list)) {
534
+ for (let i = 0; i < list.length; i++) {
535
+ yield list[i];
536
+ }
537
+ }
538
+ }
539
+ }
540
+
541
+
542
+
543
+ /**
544
+ * Needle Engine component base class. Component's are the main building blocks of the Needle Engine.
545
+ * Derive from {@link Behaviour} to implement your own using the provided lifecycle methods.
546
+ * Components can be added to any {@link Object3D} using {@link addComponent} or {@link GameObject.addComponent}.
547
+ *
548
+ * The most common lifecycle methods are {@link update}, {@link awake}, {@link start}, {@link onEnable}, {@link onDisable} and {@link onDestroy}.
549
+ *
550
+ * XR specific callbacks include {@link onEnterXR}, {@link onLeaveXR}, {@link onUpdateXR}, {@link onXRControllerAdded} and {@link onXRControllerRemoved}.
551
+ *
552
+ * To receive pointer events implement {@link onPointerDown}, {@link onPointerUp}, {@link onPointerEnter}, {@link onPointerExit} and {@link onPointerMove}.
553
+ *
554
+ * @example
555
+ * ```typescript
556
+ * import { Behaviour } from "@needle-tools/engine";
557
+ * export class MyComponent extends Behaviour {
558
+ * start() {
559
+ * console.log("Hello World");
560
+ * }
561
+ * update() {
562
+ * console.log("Frame", this.context.time.frame);
563
+ * }
564
+ * }
565
+ * ```
566
+ *
567
+ * @group Components
568
+ */
569
+ export abstract class Component implements IComponent, EventTarget,
570
+ Partial<INeedleXRSessionEventReceiver>,
571
+ Partial<IPointerEventHandler>
572
+ {
573
+ /**
574
+ * Indicates whether this object is a component
575
+ * @internal
576
+ */
577
+ get isComponent(): boolean { return true; }
578
+
579
+ private __context: Context | undefined;
580
+
581
+ /**
582
+ * The context this component belongs to, providing access to the runtime environment
583
+ * including physics, timing utilities, camera, and scene
584
+ */
585
+ get context(): Context {
586
+ return this.__context ?? Context.Current;
587
+ }
588
+ set context(context: Context) {
589
+ this.__context = context;
590
+ }
591
+
592
+ /**
593
+ * Shorthand accessor for the current scene from the context
594
+ * @returns The scene this component belongs to
595
+ */
596
+ get scene(): Scene { return this.context.scene; }
597
+
598
+ /**
599
+ * The layer value of the GameObject this component is attached to
600
+ * Used for visibility and physics filtering
601
+ */
602
+ get layer(): number {
603
+ return this.gameObject?.userData?.layer;
604
+ }
605
+
606
+ /**
607
+ * The name of the GameObject this component is attached to
608
+ * Used for debugging and finding objects
609
+ */
610
+ get name(): string {
611
+ if (this.gameObject?.name) {
612
+ return this.gameObject.name;
613
+ }
614
+ return this.gameObject?.userData.name;
615
+ }
616
+ private __name?: string;
617
+ set name(str: string) {
618
+ if (this.gameObject) {
619
+ if (!this.gameObject.userData) this.gameObject.userData = {}
620
+ this.gameObject.userData.name = str;
621
+ this.__name = str;
622
+ }
623
+ else {
624
+ this.__name = str;
625
+ }
626
+ }
627
+
628
+ /**
629
+ * The tag of the GameObject this component is attached to
630
+ * Used for categorizing objects and efficient lookup
631
+ */
632
+ get tag(): string {
633
+ return this.gameObject?.userData.tag;
634
+ }
635
+ set tag(str: string) {
636
+ if (this.gameObject) {
637
+ if (!this.gameObject.userData) this.gameObject.userData = {}
638
+ this.gameObject.userData.tag = str;
639
+ }
640
+ }
641
+
642
+ /**
643
+ * Indicates whether the GameObject is marked as static
644
+ * Static objects typically don't move and can be optimized by the engine
645
+ */
646
+ get static() {
647
+ return this.gameObject?.userData.static;
648
+ }
649
+ set static(value: boolean) {
650
+ if (this.gameObject) {
651
+ if (!this.gameObject.userData) this.gameObject.userData = {}
652
+ this.gameObject.userData.static = value;
653
+ }
654
+ }
655
+ // get hideFlags(): HideFlags {
656
+ // return this.gameObject?.hideFlags;
657
+ // }
658
+
659
+ /**
660
+ * Checks if this component is currently active (enabled and part of an active GameObject hierarchy)
661
+ * Components that are inactive won't receive lifecycle method calls
662
+ * @returns True if the component is enabled and all parent GameObjects are active
663
+ */
664
+ get activeAndEnabled(): boolean {
665
+ if (this.destroyed) return false;
666
+ if (this.__isEnabled === false) return false;
667
+ if (!this.__isActiveInHierarchy) return false;
668
+ // let go = this.gameObject;
669
+ // do {
670
+ // // console.log(go.name, go.visible)
671
+ // if (!go.visible) return false;
672
+ // go = go.parent as GameObject;
673
+ // }
674
+ // while (go);
675
+ return true;
676
+ }
677
+
678
+ private get __isActive(): boolean {
679
+ return this.gameObject.visible;
680
+ }
681
+
682
+ private get __isActiveInHierarchy(): boolean {
683
+ if (!this.gameObject) return false;
684
+ const res = this.gameObject[activeInHierarchyFieldName];
685
+ if (res === undefined) return true;
686
+ return res;
687
+ }
688
+
689
+ private set __isActiveInHierarchy(val: boolean) {
690
+ if (!this.gameObject) return;
691
+ this.gameObject[activeInHierarchyFieldName] = val;
692
+ }
693
+
694
+ /**
695
+ * Reference to the GameObject this component is attached to
696
+ * This is a three.js Object3D with additional GameObject functionality
697
+ */
698
+ gameObject!: GameObject;
699
+
700
+ /**
701
+ * Unique identifier for this component instance,
702
+ * used for finding and tracking components
703
+ */
704
+ guid: string = "invalid";
705
+
706
+ /**
707
+ * Identifier for the source asset that created this component.
708
+ * For example, URL to the glTF file this component was loaded from
709
+ */
710
+ sourceId?: SourceIdentifier;
711
+
712
+ /**
713
+ * Called when this component needs to remap guids after an instantiate operation.
714
+ * @param guidsMap Mapping from old guids to newly generated guids
715
+ */
716
+ resolveGuids?(guidsMap: GuidsMap): void;
717
+
718
+ /**
719
+ * Called once when the component becomes active for the first time.
720
+ * This is the first lifecycle callback to be invoked
721
+ */
722
+ awake() { }
723
+
724
+ /**
725
+ * Called every time the component becomes enabled or active in the hierarchy.
726
+ * Invoked after {@link awake} and before {@link start}.
727
+ */
728
+ onEnable() { }
729
+
730
+ /**
731
+ * Called every time the component becomes disabled or inactive in the hierarchy.
732
+ * Invoked when the component or any parent GameObject becomes invisible
733
+ */
734
+ onDisable() { }
735
+
736
+ /**
737
+ * Called when the component is destroyed.
738
+ * Use for cleanup operations like removing event listeners
739
+ */
740
+ onDestroy() {
741
+ this.__destroyed = true;
742
+ }
743
+
744
+ /**
745
+ * Called when a field decorated with @validate() is modified.
746
+ * @param prop The name of the field that was changed
747
+ */
748
+ onValidate?(prop?: string): void;
749
+
750
+ /**
751
+ * Called when the context's pause state changes.
752
+ * @param isPaused Whether the context is currently paused
753
+ * @param wasPaused The previous pause state
754
+ */
755
+ onPausedChanged?(isPaused: boolean, wasPaused: boolean): void;
756
+
757
+ /**
758
+ * Called once at the beginning of the first frame after the component is enabled.
759
+ * Use for initialization that requires other components to be awake.
760
+ */
761
+ start?(): void;
762
+
763
+ /**
764
+ * Called at the beginning of each frame before regular updates.
765
+ * Use for logic that needs to run before standard update callbacks.
766
+ */
767
+ earlyUpdate?(): void;
768
+
769
+ /**
770
+ * Called once per frame during the main update loop.
771
+ * The primary location for frame-based game logic.
772
+ */
773
+ update?(): void;
774
+
775
+ /**
776
+ * Called after all update functions have been called.
777
+ * Use for calculations that depend on other components being updated first.
778
+ */
779
+ lateUpdate?(): void;
780
+
781
+ /**
782
+ * Called immediately before the scene is rendered.
783
+ * @param frame Current XRFrame if in an XR session, null otherwise
784
+ */
785
+ onBeforeRender?(frame: XRFrame | null): void;
786
+
787
+ /**
788
+ * Called after the scene has been rendered.
789
+ * Use for post-processing or UI updates that should happen after rendering
790
+ */
791
+ onAfterRender?(): void;
792
+
793
+ /**
794
+ * Called when this component's collider begins colliding with another collider.
795
+ * @param col Information about the collision that occurred
796
+ */
797
+ onCollisionEnter?(col: Collision);
798
+
799
+ /**
800
+ * Called when this component's collider stops colliding with another collider.
801
+ * @param col Information about the collision that ended
802
+ */
803
+ onCollisionExit?(col: Collision);
804
+
805
+ /**
806
+ * Called each frame while this component's collider is colliding with another collider
807
+ * @param col Information about the ongoing collision
808
+ */
809
+ onCollisionStay?(col: Collision);
810
+
811
+ /**
812
+ * Called when this component's trigger collider is entered by another collider
813
+ * @param col The collider that entered this trigger
814
+ */
815
+ onTriggerEnter?(col: ICollider);
816
+
817
+ /**
818
+ * Called each frame while another collider is inside this component's trigger collider
819
+ * @param col The collider that is inside this trigger
820
+ */
821
+ onTriggerStay?(col: ICollider);
822
+
823
+ /**
824
+ * Called when another collider exits this component's trigger collider
825
+ * @param col The collider that exited this trigger
826
+ */
827
+ onTriggerExit?(col: ICollider);
828
+
829
+ /**
830
+ * Determines if this component supports a specific XR mode
831
+ * @param mode The XR session mode to check support for
832
+ * @returns True if the component supports the specified mode
833
+ */
834
+ supportsXR?(mode: XRSessionMode): boolean;
835
+
836
+ /**
837
+ * Called before an XR session is requested
838
+ * Use to modify session initialization parameters
839
+ * @param mode The XR session mode being requested
840
+ * @param args The session initialization parameters that can be modified
841
+ */
842
+ onBeforeXR?(mode: XRSessionMode, args: XRSessionInit): void;
843
+
844
+ /**
845
+ * Called when this component joins an XR session or becomes active in a running session
846
+ * @param args Event data for the XR session
847
+ */
848
+ onEnterXR?(args: NeedleXREventArgs): void;
849
+
850
+ /**
851
+ * Called each frame while this component is active in an XR session
852
+ * @param args Event data for the current XR frame
853
+ */
854
+ onUpdateXR?(args: NeedleXREventArgs): void;
855
+
856
+ /**
857
+ * Called when this component exits an XR session or becomes inactive during a session
858
+ * @param args Event data for the XR session
859
+ */
860
+ onLeaveXR?(args: NeedleXREventArgs): void;
861
+
862
+ /**
863
+ * Called when an XR controller is connected or when this component becomes active
864
+ * in a session with existing controllers
865
+ * @param args Event data for the controller that was added
866
+ */
867
+ onXRControllerAdded?(args: NeedleXRControllerEventArgs): void;
868
+
869
+ /**
870
+ * Called when an XR controller is disconnected or when this component becomes inactive
871
+ * during a session with controllers
872
+ * @param args Event data for the controller that was removed
873
+ */
874
+ onXRControllerRemoved?(args: NeedleXRControllerEventArgs): void;
875
+
876
+ /**
877
+ * Called when a pointer enters this component's GameObject
878
+ * @param args Data about the pointer event
879
+ */
880
+ onPointerEnter?(args: PointerEventData);
881
+
882
+ /**
883
+ * Called when a pointer moves while over this component's GameObject
884
+ * @param args Data about the pointer event
885
+ */
886
+ onPointerMove?(args: PointerEventData);
887
+
888
+ /**
889
+ * Called when a pointer exits this component's GameObject
890
+ * @param args Data about the pointer event
891
+ */
892
+ onPointerExit?(args: PointerEventData);
893
+
894
+ /**
895
+ * Called when a pointer button is pressed while over this component's GameObject
896
+ * @param args Data about the pointer event
897
+ */
898
+ onPointerDown?(args: PointerEventData);
899
+
900
+ /**
901
+ * Called when a pointer button is released while over this component's GameObject
902
+ * @param args Data about the pointer event
903
+ */
904
+ onPointerUp?(args: PointerEventData);
905
+
906
+ /**
907
+ * Called when a pointer completes a click interaction with this component's GameObject
908
+ * @param args Data about the pointer event
909
+ */
910
+ onPointerClick?(args: PointerEventData);
911
+
912
+ /**
913
+ * Starts a coroutine that can yield to wait for events.
914
+ * Coroutines allow for time-based sequencing of operations without blocking.
915
+ * Coroutines are based on generator functions, a JavaScript language feature.
916
+ *
917
+ * @param routine Generator function to start
918
+ * @param evt Event to register the coroutine for (default: FrameEvent.Update)
919
+ * @returns The generator function that can be used to stop the coroutine
920
+ * @example
921
+ * Time-based sequencing of operations
922
+ * ```ts
923
+ * *myCoroutine() {
924
+ * yield WaitForSeconds(1); // wait for 1 second
925
+ * yield WaitForFrames(10); // wait for 10 frames
926
+ * yield new Promise(resolve => setTimeout(resolve, 1000)); // wait for a promise to resolve
927
+ * }
928
+ * ```
929
+ * @example
930
+ * Coroutine that logs a message every 5 frames
931
+ * ```ts
932
+ * onEnable() {
933
+ * this.startCoroutine(this.myCoroutine());
934
+ * }
935
+ * private *myCoroutine() {
936
+ * while(this.activeAndEnabled) {
937
+ * console.log("Hello World", this.context.time.frame);
938
+ * // wait for 5 frames
939
+ * for(let i = 0; i < 5; i++) yield;
940
+ * }
941
+ * }
942
+ * ```
943
+ */
944
+ startCoroutine(routine: Generator, evt: FrameEvent = FrameEvent.Update): Generator {
945
+ return this.context.registerCoroutineUpdate(this, routine, evt);
946
+ }
947
+
948
+ /**
949
+ * Stops a coroutine that was previously started with startCoroutine
950
+ * @param routine The routine to be stopped
951
+ * @param evt The frame event the routine was registered with
952
+ */
953
+ stopCoroutine(routine: Generator, evt: FrameEvent = FrameEvent.Update): void {
954
+ this.context.unregisterCoroutineUpdate(routine, evt);
955
+ }
956
+
957
+ /**
958
+ * Checks if this component has been destroyed
959
+ * @returns True if the component or its GameObject has been destroyed
960
+ */
961
+ public get destroyed(): boolean {
962
+ return this.__destroyed;
963
+ }
964
+
965
+ /**
966
+ * Destroys this component and removes it from its GameObject
967
+ * After destruction, the component will no longer receive lifecycle callbacks
968
+ */
969
+ public destroy() {
970
+ if (this.__destroyed) return;
971
+ this.__internalDestroy();
972
+ }
973
+
974
+ /** @internal */
975
+ protected __didAwake: boolean = false;
976
+
977
+ /** @internal */
978
+ private __didStart: boolean = false;
979
+
980
+ /** @internal */
981
+ protected __didEnable: boolean = false;
982
+
983
+ /** @internal */
984
+ protected __isEnabled: boolean | undefined = undefined;
985
+
986
+ /** @internal */
987
+ private __destroyed: boolean = false;
988
+
989
+ /** @internal */
990
+ get __internalDidAwakeAndStart() { return this.__didAwake && this.__didStart; }
991
+
992
+ /** @internal */
993
+ constructor(init?: ComponentInit<Component>) {
994
+ this.__didAwake = false;
995
+ this.__didStart = false;
996
+ this.__didEnable = false;
997
+ this.__isEnabled = undefined;
998
+ this.__destroyed = false;
999
+ this._internalInit(init as ComponentInit<this>);
1000
+ }
1001
+
1002
+ /** @internal */
1003
+ __internalNewInstanceCreated(init?: ComponentInit<this>): this {
1004
+ this.__didAwake = false;
1005
+ this.__didStart = false;
1006
+ this.__didEnable = false;
1007
+ this.__isEnabled = undefined;
1008
+ this.__destroyed = false;
1009
+ this._internalInit(init);
1010
+ return this;
1011
+ }
1012
+
1013
+ /**
1014
+ * Initializes component properties from an initialization object
1015
+ * @param init Object with properties to copy to this component
1016
+ * @internal
1017
+ */
1018
+ _internalInit(init?: ComponentInit<this>) {
1019
+ if (typeof init === "object") {
1020
+ for (const key of Object.keys(init)) {
1021
+ const value = init[key];
1022
+ // we don't want to allow overriding functions via init
1023
+ if (typeof value === "function") continue;
1024
+ (this as any)[key] = value;
1025
+ }
1026
+ }
1027
+ }
1028
+
1029
+ /** @internal */
1030
+ __internalAwake() {
1031
+ if (this.__didAwake) return;
1032
+ this.__didAwake = true;
1033
+ this.awake();
1034
+ }
1035
+
1036
+
1037
+ /** @internal */
1038
+ __internalStart() {
1039
+ if (this.__didStart) return;
1040
+ this.__didStart = true;
1041
+ if (this.start) this.start();
1042
+ }
1043
+
1044
+
1045
+ /** @internal */
1046
+ __internalEnable(isAddingToScene?: boolean): boolean {
1047
+ if (this.__destroyed) {
1048
+ if (isDevEnvironment()) {
1049
+ console.warn("[Needle Engine Dev] Trying to enable destroyed component");
1050
+ }
1051
+ return false;
1052
+ }
1053
+ // Don't change enable before awake
1054
+ // But a user can change enable during awake
1055
+ if (!this.__didAwake) return false;
1056
+ if (this.__didEnable) {
1057
+ // We dont want to change the enable state if we are adding to scene
1058
+ // But we want to change the state when e.g. a user changes the enable state during awake
1059
+ if (isAddingToScene !== true)
1060
+ this.__isEnabled = true;
1061
+ return false;
1062
+ }
1063
+ // console.trace("INTERNAL ENABLE");
1064
+ this.__didEnable = true;
1065
+ this.__isEnabled = true;
1066
+ this.onEnable();
1067
+ return true;
1068
+ }
1069
+
1070
+ /** @internal */
1071
+ __internalDisable(isRemovingFromScene?: boolean) {
1072
+ // Don't change enable before awake
1073
+ // But a user can change enable during awake
1074
+ if (!this.__didAwake) return;
1075
+ if (!this.__didEnable) {
1076
+ // We dont want to change the enable state if we are removing from a scene
1077
+ if (isRemovingFromScene !== true)
1078
+ this.__isEnabled = false;
1079
+ return;
1080
+ }
1081
+ this.__didEnable = false;
1082
+ this.__isEnabled = false;
1083
+ this.onDisable();
1084
+ }
1085
+
1086
+ /** @internal */
1087
+ __internalDestroy() {
1088
+ if (this.__destroyed) return;
1089
+ this.__destroyed = true;
1090
+ if (this.__didAwake) {
1091
+ this.onDestroy?.call(this);
1092
+ this.dispatchEvent(new CustomEvent("destroyed", { detail: this }));
1093
+ }
1094
+ destroyComponentInstance(this as any);
1095
+ }
1096
+
1097
+ /**
1098
+ * Controls whether this component is enabled
1099
+ * Disabled components don't receive lifecycle callbacks
1100
+ */
1101
+ get enabled(): boolean {
1102
+ return typeof this.__isEnabled === "boolean" ? this.__isEnabled : true; // if it has no enabled field it is always enabled
1103
+ }
1104
+ set enabled(val: boolean) {
1105
+ if (this.__destroyed) {
1106
+ if (isDevEnvironment()) {
1107
+ console.warn(`[Needle Engine Dev] Trying to ${val ? "enable" : "disable"} destroyed component`);
1108
+ }
1109
+ return;
1110
+ }
1111
+ // when called from animationclip we receive numbers
1112
+ // due to interpolation they can be anything between 0 and 1
1113
+ if (typeof val === "number") {
1114
+ if (val >= 0.5) val = true;
1115
+ else val = false;
1116
+ }
1117
+
1118
+ // need to check here because codegen is calling this before everything is setup
1119
+ if (!this.__didAwake) {
1120
+ this.__isEnabled = val;
1121
+ return;
1122
+ }
1123
+ if (val) {
1124
+ this.__internalEnable();
1125
+ } else {
1126
+ this.__internalDisable();
1127
+ }
1128
+ }
1129
+
1130
+ /**
1131
+ * Gets the position of this component's GameObject in world space.
1132
+ * Note: This is equivalent to calling `this.gameObject.worldPosition`
1133
+ */
1134
+ get worldPosition(): Vector3 {
1135
+ return threeutils.getWorldPosition(this.gameObject);
1136
+ }
1137
+
1138
+ /**
1139
+ * Sets the position of this component's GameObject in world space
1140
+ * @param val The world position vector to set
1141
+ */
1142
+ set worldPosition(val: Vector3) {
1143
+ threeutils.setWorldPosition(this.gameObject, val);
1144
+ }
1145
+
1146
+ /**
1147
+ * Sets the position of this component's GameObject in world space using individual coordinates
1148
+ * @param x X-coordinate in world space
1149
+ * @param y Y-coordinate in world space
1150
+ * @param z Z-coordinate in world space
1151
+ */
1152
+ setWorldPosition(x: number, y: number, z: number) {
1153
+ threeutils.setWorldPositionXYZ(this.gameObject, x, y, z);
1154
+ }
1155
+
1156
+ /**
1157
+ * Gets the rotation of this component's GameObject in world space as a quaternion
1158
+ * Note: This is equivalent to calling `this.gameObject.worldQuaternion`
1159
+ */
1160
+ get worldQuaternion(): Quaternion {
1161
+ return threeutils.getWorldQuaternion(this.gameObject);
1162
+ }
1163
+
1164
+ /**
1165
+ * Sets the rotation of this component's GameObject in world space using a quaternion
1166
+ * @param val The world rotation quaternion to set
1167
+ */
1168
+ set worldQuaternion(val: Quaternion) {
1169
+ threeutils.setWorldQuaternion(this.gameObject, val);
1170
+ }
1171
+
1172
+ /**
1173
+ * Sets the rotation of this component's GameObject in world space using quaternion components
1174
+ * @param x X component of the quaternion
1175
+ * @param y Y component of the quaternion
1176
+ * @param z Z component of the quaternion
1177
+ * @param w W component of the quaternion
1178
+ */
1179
+ setWorldQuaternion(x: number, y: number, z: number, w: number) {
1180
+ threeutils.setWorldQuaternionXYZW(this.gameObject, x, y, z, w);
1181
+ }
1182
+
1183
+ /**
1184
+ * Gets the rotation of this component's GameObject in world space as Euler angles (in radians)
1185
+ */
1186
+ get worldEuler(): Euler {
1187
+ return threeutils.getWorldEuler(this.gameObject);
1188
+ }
1189
+
1190
+ /**
1191
+ * Sets the rotation of this component's GameObject in world space using Euler angles (in radians)
1192
+ * @param val The world rotation Euler angles to set
1193
+ */
1194
+ set worldEuler(val: Euler) {
1195
+ threeutils.setWorldEuler(this.gameObject, val);
1196
+ }
1197
+
1198
+ /**
1199
+ * Gets the rotation of this component's GameObject in world space as Euler angles (in degrees)
1200
+ * Note: This is equivalent to calling `this.gameObject.worldRotation`
1201
+ */
1202
+ get worldRotation(): Vector3 {
1203
+ return this.gameObject.worldRotation;
1204
+ }
1205
+
1206
+ /**
1207
+ * Sets the rotation of this component's GameObject in world space using Euler angles (in degrees)
1208
+ * @param val The world rotation vector to set (in degrees)
1209
+ */
1210
+ set worldRotation(val: Vector3) {
1211
+ this.setWorldRotation(val.x, val.y, val.z, true);
1212
+ }
1213
+
1214
+ /**
1215
+ * Sets the rotation of this component's GameObject in world space using individual Euler angles
1216
+ * @param x X-axis rotation
1217
+ * @param y Y-axis rotation
1218
+ * @param z Z-axis rotation
1219
+ * @param degrees Whether the values are in degrees (true) or radians (false)
1220
+ */
1221
+ setWorldRotation(x: number, y: number, z: number, degrees: boolean = true) {
1222
+ threeutils.setWorldRotationXYZ(this.gameObject, x, y, z, degrees);
1223
+ }
1224
+
1225
+ private static _forward: Vector3 = new Vector3();
1226
+ /**
1227
+ * Gets the forward direction vector (0,0,-1) of this component's GameObject in world space
1228
+ */
1229
+ public get forward(): Vector3 {
1230
+ return Component._forward.set(0, 0, -1).applyQuaternion(this.worldQuaternion);
1231
+ }
1232
+ private static _right: Vector3 = new Vector3();
1233
+ /**
1234
+ * Gets the right direction vector (1,0,0) of this component's GameObject in world space
1235
+ */
1236
+ public get right(): Vector3 {
1237
+ return Component._right.set(1, 0, 0).applyQuaternion(this.worldQuaternion);
1238
+ }
1239
+ private static _up: Vector3 = new Vector3();
1240
+ /**
1241
+ * Gets the up direction vector (0,1,0) of this component's GameObject in world space
1242
+ */
1243
+ public get up(): Vector3 {
1244
+ return Component._up.set(0, 1, 0).applyQuaternion(this.worldQuaternion);
1245
+ }
1246
+
1247
+ // EventTarget implementation:
1248
+
1249
+ /**
1250
+ * Storage for event listeners registered to this component
1251
+ * @private
1252
+ */
1253
+ private _eventListeners = new Map<string, EventListener[]>();
1254
+
1255
+ /**
1256
+ * Registers an event listener for the specified event type
1257
+ * @param type The event type to listen for
1258
+ * @param listener The callback function to execute when the event occurs
1259
+ */
1260
+ addEventListener<T extends Event>(type: string, listener: (evt: T) => any) {
1261
+ this._eventListeners[type] = this._eventListeners[type] || [];
1262
+ this._eventListeners[type].push(listener);
1263
+ }
1264
+
1265
+ /**
1266
+ * Removes a previously registered event listener
1267
+ * @param type The event type the listener was registered for
1268
+ * @param listener The callback function to remove
1269
+ */
1270
+ removeEventListener<T extends Event>(type: string, listener: (arg: T) => any) {
1271
+ if (!this._eventListeners[type]) return;
1272
+ const index = this._eventListeners[type].indexOf(listener);
1273
+ if (index >= 0) this._eventListeners[type].splice(index, 1);
1274
+ }
1275
+
1276
+ /**
1277
+ * Dispatches an event to all registered listeners
1278
+ * @param evt The event object to dispatch
1279
+ * @returns Always returns false (standard implementation of EventTarget)
1280
+ */
1281
+ dispatchEvent(evt: Event): boolean {
1282
+ if (!evt || !this._eventListeners[evt.type]) return false;
1283
+ const listeners = this._eventListeners[evt.type];
1284
+ for (let i = 0; i < listeners.length; i++) {
1285
+ listeners[i](evt);
1286
+ }
1287
+
1288
+ return false;
1289
+ }
1290
+ }
1291
+
1292
+ // For legacy reasons we need to export this as well
1293
+ // (and we don't use extend to inherit the component docs)
1294
+ export { Component as Behaviour };