@needle-tools/engine 4.4.0-beta.3 → 4.4.0-beta.5

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 (1054) hide show
  1. package/CHANGELOG.md +3614 -3608
  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 +2399 -2347
  6. package/dist/needle-engine.bundle.light.js +2395 -2343
  7. package/dist/needle-engine.bundle.light.min.js +89 -89
  8. package/dist/needle-engine.bundle.light.umd.cjs +84 -84
  9. package/dist/needle-engine.bundle.min.js +89 -89
  10. package/dist/needle-engine.bundle.umd.cjs +79 -79
  11. package/dist/needle-engine.d.ts +138 -130
  12. package/dist/needle-engine.light.d.ts +138 -130
  13. package/dist/postprocessing.js +1513 -1659
  14. package/dist/postprocessing.light.js +1513 -1659
  15. package/dist/postprocessing.light.min.js +66 -80
  16. package/dist/postprocessing.light.umd.cjs +69 -83
  17. package/dist/postprocessing.min.js +66 -80
  18. package/dist/postprocessing.umd.cjs +69 -83
  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 +300 -300
  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.d.ts +4 -0
  50. package/lib/engine/engine.js +12 -0
  51. package/lib/engine/engine.js.map +1 -0
  52. package/lib/engine/engine_addressables.d.ts +166 -166
  53. package/lib/engine/engine_addressables.js +608 -608
  54. package/lib/engine/engine_animation.d.ts +43 -43
  55. package/lib/engine/engine_animation.js +133 -133
  56. package/lib/engine/engine_application.d.ts +40 -40
  57. package/lib/engine/engine_application.js +104 -104
  58. package/lib/engine/engine_assetdatabase.d.ts +25 -25
  59. package/lib/engine/engine_assetdatabase.js +344 -344
  60. package/lib/engine/engine_audio.d.ts +4 -4
  61. package/lib/engine/engine_audio.js +23 -23
  62. package/lib/engine/engine_camera.d.ts +13 -13
  63. package/lib/engine/engine_camera.js +30 -30
  64. package/lib/engine/engine_components.d.ts +110 -110
  65. package/lib/engine/engine_components.js +382 -380
  66. package/lib/engine/engine_components.js.map +1 -1
  67. package/lib/engine/engine_components_internal.d.ts +9 -9
  68. package/lib/engine/engine_components_internal.js +36 -36
  69. package/lib/engine/engine_constants.d.ts +10 -10
  70. package/lib/engine/engine_constants.js +41 -41
  71. package/lib/engine/engine_context.d.ts +345 -345
  72. package/lib/engine/engine_context.js +1515 -1515
  73. package/lib/engine/engine_context_registry.d.ts +71 -71
  74. package/lib/engine/engine_context_registry.js +117 -117
  75. package/lib/engine/engine_coroutine.d.ts +35 -35
  76. package/lib/engine/engine_coroutine.js +52 -52
  77. package/lib/engine/engine_create_objects.d.ts +118 -118
  78. package/lib/engine/engine_create_objects.js +308 -308
  79. package/lib/engine/engine_default_parameters.d.ts +2 -2
  80. package/lib/engine/engine_default_parameters.js +3 -3
  81. package/lib/engine/engine_editor-sync.d.ts +21 -21
  82. package/lib/engine/engine_editor-sync.js +4 -4
  83. package/lib/engine/engine_element.d.ts +113 -113
  84. package/lib/engine/engine_element.js +829 -830
  85. package/lib/engine/engine_element.js.map +1 -1
  86. package/lib/engine/engine_element_attributes.d.ts +72 -72
  87. package/lib/engine/engine_element_attributes.js +1 -1
  88. package/lib/engine/engine_element_extras.d.ts +6 -6
  89. package/lib/engine/engine_element_extras.js +13 -13
  90. package/lib/engine/engine_element_loading.d.ts +44 -44
  91. package/lib/engine/engine_element_loading.js +349 -349
  92. package/lib/engine/engine_element_overlay.d.ts +21 -21
  93. package/lib/engine/engine_element_overlay.js +166 -166
  94. package/lib/engine/engine_fileloader.d.ts +2 -2
  95. package/lib/engine/engine_fileloader.js +8 -8
  96. package/lib/engine/engine_gameobject.d.ts +68 -68
  97. package/lib/engine/engine_gameobject.js +591 -591
  98. package/lib/engine/engine_generic_utils.d.ts +1 -1
  99. package/lib/engine/engine_generic_utils.js +13 -13
  100. package/lib/engine/engine_gizmos.d.ts +149 -149
  101. package/lib/engine/engine_gizmos.js +530 -530
  102. package/lib/engine/engine_gltf.d.ts +12 -12
  103. package/lib/engine/engine_gltf.js +15 -15
  104. package/lib/engine/engine_gltf_builtin_components.d.ts +7 -7
  105. package/lib/engine/engine_gltf_builtin_components.js +341 -341
  106. package/lib/engine/engine_hot_reload.d.ts +7 -7
  107. package/lib/engine/engine_hot_reload.js +184 -184
  108. package/lib/engine/engine_input.d.ts +352 -352
  109. package/lib/engine/engine_input.js +1265 -1265
  110. package/lib/engine/engine_input_utils.d.ts +2 -2
  111. package/lib/engine/engine_input_utils.js +22 -22
  112. package/lib/engine/engine_instancing.d.ts +19 -19
  113. package/lib/engine/engine_instancing.js +39 -39
  114. package/lib/engine/engine_license.d.ts +9 -9
  115. package/lib/engine/engine_license.js +320 -320
  116. package/lib/engine/engine_lifecycle_api.d.ts +76 -76
  117. package/lib/engine/engine_lifecycle_api.js +99 -99
  118. package/lib/engine/engine_lifecycle_functions_internal.d.ts +32 -32
  119. package/lib/engine/engine_lifecycle_functions_internal.js +146 -146
  120. package/lib/engine/engine_lightdata.d.ts +23 -23
  121. package/lib/engine/engine_lightdata.js +91 -91
  122. package/lib/engine/engine_loaders.d.ts +13 -13
  123. package/lib/engine/engine_loaders.js +62 -62
  124. package/lib/engine/engine_lods.d.ts +31 -31
  125. package/lib/engine/engine_lods.js +146 -146
  126. package/lib/engine/engine_mainloop_utils.d.ts +32 -32
  127. package/lib/engine/engine_mainloop_utils.js +466 -466
  128. package/lib/engine/engine_math.d.ts +114 -114
  129. package/lib/engine/engine_math.js +247 -247
  130. package/lib/engine/engine_modules.d.ts +36 -36
  131. package/lib/engine/engine_modules.js +85 -85
  132. package/lib/engine/engine_networking.d.ts +252 -252
  133. package/lib/engine/engine_networking.js +743 -743
  134. package/lib/engine/engine_networking_auto.d.ts +24 -24
  135. package/lib/engine/engine_networking_auto.js +310 -310
  136. package/lib/engine/engine_networking_blob.d.ts +48 -48
  137. package/lib/engine/engine_networking_blob.js +212 -212
  138. package/lib/engine/engine_networking_files.d.ts +35 -35
  139. package/lib/engine/engine_networking_files.js +172 -172
  140. package/lib/engine/engine_networking_files_default_components.d.ts +6 -6
  141. package/lib/engine/engine_networking_files_default_components.js +42 -42
  142. package/lib/engine/engine_networking_instantiate.d.ts +100 -100
  143. package/lib/engine/engine_networking_instantiate.js +345 -345
  144. package/lib/engine/engine_networking_peer.d.ts +15 -15
  145. package/lib/engine/engine_networking_peer.js +132 -132
  146. package/lib/engine/engine_networking_streams.d.ts +123 -123
  147. package/lib/engine/engine_networking_streams.js +645 -645
  148. package/lib/engine/engine_networking_types.d.ts +22 -22
  149. package/lib/engine/engine_networking_types.js +7 -7
  150. package/lib/engine/engine_networking_utils.d.ts +2 -2
  151. package/lib/engine/engine_networking_utils.js +20 -20
  152. package/lib/engine/engine_networking_websocket.d.ts +1 -1
  153. package/lib/engine/engine_networking_websocket.js +2 -2
  154. package/lib/engine/engine_patcher.d.ts +10 -10
  155. package/lib/engine/engine_patcher.js +142 -142
  156. package/lib/engine/engine_physics.d.ts +152 -152
  157. package/lib/engine/engine_physics.js +645 -645
  158. package/lib/engine/engine_physics.types.d.ts +40 -40
  159. package/lib/engine/engine_physics.types.js +33 -33
  160. package/lib/engine/engine_physics_rapier.d.ts +147 -147
  161. package/lib/engine/engine_physics_rapier.js +1432 -1432
  162. package/lib/engine/engine_playerview.d.ts +26 -26
  163. package/lib/engine/engine_playerview.js +64 -64
  164. package/lib/engine/engine_scenelighting.d.ts +71 -71
  165. package/lib/engine/engine_scenelighting.js +226 -226
  166. package/lib/engine/engine_scenetools.d.ts +50 -50
  167. package/lib/engine/engine_scenetools.js +321 -321
  168. package/lib/engine/engine_serialization.d.ts +3 -3
  169. package/lib/engine/engine_serialization.js +3 -3
  170. package/lib/engine/engine_serialization_builtin_serializer.d.ts +72 -72
  171. package/lib/engine/engine_serialization_builtin_serializer.js +403 -403
  172. package/lib/engine/engine_serialization_core.d.ts +85 -85
  173. package/lib/engine/engine_serialization_core.js +602 -602
  174. package/lib/engine/engine_serialization_decorator.d.ts +23 -23
  175. package/lib/engine/engine_serialization_decorator.js +66 -66
  176. package/lib/engine/engine_setup.d.ts +1 -1
  177. package/lib/engine/engine_setup.js +2 -2
  178. package/lib/engine/engine_shaders.d.ts +53 -53
  179. package/lib/engine/engine_shaders.js +252 -252
  180. package/lib/engine/engine_shims.d.ts +4 -4
  181. package/lib/engine/engine_shims.js +24 -24
  182. package/lib/engine/engine_test_utils.d.ts +39 -39
  183. package/lib/engine/engine_test_utils.js +83 -83
  184. package/lib/engine/engine_texture.d.ts +28 -28
  185. package/lib/engine/engine_texture.js +64 -64
  186. package/lib/engine/engine_three_utils.d.ts +201 -201
  187. package/lib/engine/engine_three_utils.js +731 -731
  188. package/lib/engine/engine_time.d.ts +51 -51
  189. package/lib/engine/engine_time.js +82 -82
  190. package/lib/engine/engine_time_utils.d.ts +88 -88
  191. package/lib/engine/engine_time_utils.js +215 -215
  192. package/lib/engine/engine_tonemapping.d.ts +2 -2
  193. package/lib/engine/engine_tonemapping.js +194 -194
  194. package/lib/engine/engine_types.d.ts +572 -572
  195. package/lib/engine/engine_types.js +88 -88
  196. package/lib/engine/engine_typestore.d.ts +28 -28
  197. package/lib/engine/engine_typestore.js +55 -55
  198. package/lib/engine/engine_util_decorator.d.ts +13 -13
  199. package/lib/engine/engine_util_decorator.js +116 -116
  200. package/lib/engine/engine_utils.d.ts +266 -266
  201. package/lib/engine/engine_utils.js +878 -878
  202. package/lib/engine/engine_utils_format.d.ts +21 -21
  203. package/lib/engine/engine_utils_format.js +193 -193
  204. package/lib/engine/engine_utils_screenshot.d.ts +159 -159
  205. package/lib/engine/engine_utils_screenshot.js +513 -513
  206. package/lib/engine/engine_utils_screenshot.js.map +1 -1
  207. package/lib/engine/engine_utils_screenshot.xr.d.ts +5 -5
  208. package/lib/engine/engine_utils_screenshot.xr.js +90 -90
  209. package/lib/engine/engine_web_api.d.ts +12 -0
  210. package/lib/engine/engine_web_api.js +113 -0
  211. package/lib/engine/engine_web_api.js.map +1 -0
  212. package/lib/engine/engine_xr.d.ts +1 -1
  213. package/lib/engine/engine_xr.js +1 -1
  214. package/lib/engine/export/gltf/Writers.d.ts +19 -19
  215. package/lib/engine/export/gltf/Writers.js +24 -24
  216. package/lib/engine/export/gltf/index.d.ts +11 -11
  217. package/lib/engine/export/gltf/index.js +123 -123
  218. package/lib/engine/export/index.d.ts +2 -2
  219. package/lib/engine/export/index.js +2 -2
  220. package/lib/engine/export/state.d.ts +7 -7
  221. package/lib/engine/export/state.js +17 -17
  222. package/lib/engine/export/utils.d.ts +2 -2
  223. package/lib/engine/export/utils.js +7 -7
  224. package/lib/engine/extensions/EXT_texture_exr.d.ts +8 -8
  225. package/lib/engine/extensions/EXT_texture_exr.js +32 -32
  226. package/lib/engine/extensions/NEEDLE_animator_controller_model.d.ts +122 -122
  227. package/lib/engine/extensions/NEEDLE_animator_controller_model.js +95 -95
  228. package/lib/engine/extensions/NEEDLE_components.d.ts +35 -35
  229. package/lib/engine/extensions/NEEDLE_components.js +220 -220
  230. package/lib/engine/extensions/NEEDLE_gameobject_data.d.ts +10 -10
  231. package/lib/engine/extensions/NEEDLE_gameobject_data.js +57 -57
  232. package/lib/engine/extensions/NEEDLE_lighting_settings.d.ts +37 -37
  233. package/lib/engine/extensions/NEEDLE_lighting_settings.js +157 -157
  234. package/lib/engine/extensions/NEEDLE_lightmaps.d.ts +18 -18
  235. package/lib/engine/extensions/NEEDLE_lightmaps.js +99 -99
  236. package/lib/engine/extensions/NEEDLE_persistent_assets.d.ts +11 -11
  237. package/lib/engine/extensions/NEEDLE_persistent_assets.js +63 -63
  238. package/lib/engine/extensions/NEEDLE_progressive.d.ts +1 -1
  239. package/lib/engine/extensions/NEEDLE_progressive.js +1 -1
  240. package/lib/engine/extensions/NEEDLE_render_objects.d.ts +13 -13
  241. package/lib/engine/extensions/NEEDLE_render_objects.js +159 -159
  242. package/lib/engine/extensions/NEEDLE_techniques_webgl.d.ts +38 -38
  243. package/lib/engine/extensions/NEEDLE_techniques_webgl.js +564 -564
  244. package/lib/engine/extensions/extension_resolver.d.ts +4 -4
  245. package/lib/engine/extensions/extension_resolver.js +1 -1
  246. package/lib/engine/extensions/extension_utils.d.ts +12 -12
  247. package/lib/engine/extensions/extension_utils.js +152 -152
  248. package/lib/engine/extensions/extensions.d.ts +31 -31
  249. package/lib/engine/extensions/extensions.js +103 -103
  250. package/lib/engine/extensions/index.d.ts +6 -6
  251. package/lib/engine/extensions/index.js +6 -6
  252. package/lib/engine/extensions/usage_tracker.d.ts +13 -13
  253. package/lib/engine/extensions/usage_tracker.js +65 -65
  254. package/lib/engine/js-extensions/Camera.d.ts +1 -1
  255. package/lib/engine/js-extensions/Camera.js +39 -39
  256. package/lib/engine/js-extensions/ExtensionUtils.d.ts +9 -9
  257. package/lib/engine/js-extensions/ExtensionUtils.js +67 -67
  258. package/lib/engine/js-extensions/Layers.d.ts +6 -6
  259. package/lib/engine/js-extensions/Layers.js +22 -22
  260. package/lib/engine/js-extensions/Object3D.d.ts +120 -120
  261. package/lib/engine/js-extensions/Object3D.js +136 -136
  262. package/lib/engine/js-extensions/RGBAColor.d.ts +23 -22
  263. package/lib/engine/js-extensions/RGBAColor.js +110 -62
  264. package/lib/engine/js-extensions/RGBAColor.js.map +1 -1
  265. package/lib/engine/js-extensions/Vector.d.ts +3 -3
  266. package/lib/engine/js-extensions/Vector.js +13 -13
  267. package/lib/engine/js-extensions/index.d.ts +5 -5
  268. package/lib/engine/js-extensions/index.js +5 -5
  269. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.d.ts +4 -4
  270. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +75 -75
  271. package/lib/engine/shaders/shaderData.d.ts +55 -55
  272. package/lib/engine/shaders/shaderData.js +58 -58
  273. package/lib/engine/tests/test_utils.d.ts +2 -2
  274. package/lib/engine/tests/test_utils.js +53 -53
  275. package/lib/engine/webcomponents/WebXRButtons.d.ts +56 -56
  276. package/lib/engine/webcomponents/WebXRButtons.js +230 -230
  277. package/lib/engine/webcomponents/api.d.ts +5 -5
  278. package/lib/engine/webcomponents/api.js +4 -4
  279. package/lib/engine/webcomponents/buttons.d.ts +39 -39
  280. package/lib/engine/webcomponents/buttons.js +237 -237
  281. package/lib/engine/webcomponents/fonts.d.ts +9 -9
  282. package/lib/engine/webcomponents/fonts.js +32 -32
  283. package/lib/engine/webcomponents/icons.d.ts +9 -9
  284. package/lib/engine/webcomponents/icons.js +52 -52
  285. package/lib/engine/webcomponents/index.d.ts +1 -1
  286. package/lib/engine/webcomponents/index.js +1 -1
  287. package/lib/engine/webcomponents/logo-element.d.ts +10 -10
  288. package/lib/engine/webcomponents/logo-element.js +67 -67
  289. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.d.ts +37 -37
  290. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.js +513 -513
  291. package/lib/engine/webcomponents/needle menu/needle-menu.d.ts +151 -151
  292. package/lib/engine/webcomponents/needle menu/needle-menu.js +1018 -1018
  293. package/lib/engine/webcomponents/needle-button.d.ts +34 -34
  294. package/lib/engine/webcomponents/needle-button.js +161 -161
  295. package/lib/engine/xr/NeedleXRController.d.ts +313 -313
  296. package/lib/engine/xr/NeedleXRController.js +1008 -1008
  297. package/lib/engine/xr/NeedleXRSession.d.ts +339 -339
  298. package/lib/engine/xr/NeedleXRSession.js +1427 -1427
  299. package/lib/engine/xr/NeedleXRSync.d.ts +22 -22
  300. package/lib/engine/xr/NeedleXRSync.js +188 -188
  301. package/lib/engine/xr/SceneTransition.d.ts +18 -18
  302. package/lib/engine/xr/SceneTransition.js +69 -69
  303. package/lib/engine/xr/TempXRContext.d.ts +34 -34
  304. package/lib/engine/xr/TempXRContext.js +187 -187
  305. package/lib/engine/xr/XRRig.d.ts +7 -7
  306. package/lib/engine/xr/XRRig.js +1 -1
  307. package/lib/engine/xr/api.d.ts +6 -6
  308. package/lib/engine/xr/api.js +6 -6
  309. package/lib/engine/xr/events.d.ts +66 -66
  310. package/lib/engine/xr/events.js +93 -93
  311. package/lib/engine/xr/internal.d.ts +12 -12
  312. package/lib/engine/xr/internal.js +25 -25
  313. package/lib/engine/xr/usdz.d.ts +12 -12
  314. package/lib/engine/xr/usdz.js +29 -29
  315. package/lib/engine/xr/utils.d.ts +11 -11
  316. package/lib/engine/xr/utils.js +34 -34
  317. package/lib/engine-components/AlignmentConstraint.d.ts +10 -10
  318. package/lib/engine-components/AlignmentConstraint.js +39 -39
  319. package/lib/engine-components/Animation.d.ts +156 -156
  320. package/lib/engine-components/Animation.js +508 -508
  321. package/lib/engine-components/AnimationCurve.d.ts +40 -40
  322. package/lib/engine-components/AnimationCurve.js +159 -159
  323. package/lib/engine-components/AnimationUtils.d.ts +8 -8
  324. package/lib/engine-components/AnimationUtils.js +27 -27
  325. package/lib/engine-components/AnimationUtilsAutoplay.d.ts +1 -1
  326. package/lib/engine-components/AnimationUtilsAutoplay.js +39 -39
  327. package/lib/engine-components/Animator.d.ts +217 -217
  328. package/lib/engine-components/Animator.js +354 -354
  329. package/lib/engine-components/AnimatorController.d.ts +227 -227
  330. package/lib/engine-components/AnimatorController.js +1152 -1152
  331. package/lib/engine-components/AudioListener.d.ts +33 -33
  332. package/lib/engine-components/AudioListener.js +86 -86
  333. package/lib/engine-components/AudioSource.d.ts +217 -217
  334. package/lib/engine-components/AudioSource.js +627 -627
  335. package/lib/engine-components/AvatarLoader.d.ts +80 -80
  336. package/lib/engine-components/AvatarLoader.js +231 -231
  337. package/lib/engine-components/AxesHelper.d.ts +32 -32
  338. package/lib/engine-components/AxesHelper.js +67 -67
  339. package/lib/engine-components/BasicIKConstraint.d.ts +9 -9
  340. package/lib/engine-components/BasicIKConstraint.js +43 -43
  341. package/lib/engine-components/BoxCollider.d.ts +2 -2
  342. package/lib/engine-components/BoxCollider.js +2 -2
  343. package/lib/engine-components/BoxHelperComponent.d.ts +47 -47
  344. package/lib/engine-components/BoxHelperComponent.js +102 -102
  345. package/lib/engine-components/Camera.d.ts +231 -231
  346. package/lib/engine-components/Camera.js +700 -694
  347. package/lib/engine-components/Camera.js.map +1 -1
  348. package/lib/engine-components/CameraUtils.d.ts +1 -1
  349. package/lib/engine-components/CameraUtils.js +118 -127
  350. package/lib/engine-components/CameraUtils.js.map +1 -1
  351. package/lib/engine-components/CharacterController.d.ts +55 -55
  352. package/lib/engine-components/CharacterController.js +236 -236
  353. package/lib/engine-components/Collider.d.ts +188 -188
  354. package/lib/engine-components/Collider.js +369 -369
  355. package/lib/engine-components/Component.d.ts +792 -792
  356. package/lib/engine-components/Component.js +915 -915
  357. package/lib/engine-components/ContactShadows.d.ts +82 -82
  358. package/lib/engine-components/ContactShadows.js +430 -430
  359. package/lib/engine-components/DeleteBox.d.ts +19 -19
  360. package/lib/engine-components/DeleteBox.js +58 -58
  361. package/lib/engine-components/DeviceFlag.d.ts +16 -16
  362. package/lib/engine-components/DeviceFlag.js +47 -47
  363. package/lib/engine-components/DragControls.d.ts +170 -170
  364. package/lib/engine-components/DragControls.js +1421 -1421
  365. package/lib/engine-components/DropListener.d.ts +215 -215
  366. package/lib/engine-components/DropListener.js +630 -630
  367. package/lib/engine-components/Duplicatable.d.ts +35 -35
  368. package/lib/engine-components/Duplicatable.js +202 -202
  369. package/lib/engine-components/EventList.d.ts +54 -54
  370. package/lib/engine-components/EventList.js +232 -232
  371. package/lib/engine-components/EventTrigger.d.ts +33 -33
  372. package/lib/engine-components/EventTrigger.js +75 -75
  373. package/lib/engine-components/EventType.d.ts +22 -22
  374. package/lib/engine-components/EventType.js +23 -23
  375. package/lib/engine-components/FlyControls.d.ts +10 -0
  376. package/lib/engine-components/FlyControls.js +29 -0
  377. package/lib/engine-components/FlyControls.js.map +1 -0
  378. package/lib/engine-components/Fog.d.ts +22 -22
  379. package/lib/engine-components/Fog.js +61 -61
  380. package/lib/engine-components/Gizmos.d.ts +17 -17
  381. package/lib/engine-components/Gizmos.js +64 -64
  382. package/lib/engine-components/GridHelper.d.ts +20 -20
  383. package/lib/engine-components/GridHelper.js +54 -54
  384. package/lib/engine-components/GroundProjection.d.ts +67 -67
  385. package/lib/engine-components/GroundProjection.js +343 -343
  386. package/lib/engine-components/Interactable.d.ts +12 -12
  387. package/lib/engine-components/Interactable.js +12 -12
  388. package/lib/engine-components/Joints.d.ts +19 -19
  389. package/lib/engine-components/Joints.js +51 -51
  390. package/lib/engine-components/LODGroup.d.ts +35 -35
  391. package/lib/engine-components/LODGroup.js +152 -152
  392. package/lib/engine-components/Light.d.ts +180 -180
  393. package/lib/engine-components/Light.js +535 -535
  394. package/lib/engine-components/LookAtConstraint.d.ts +19 -19
  395. package/lib/engine-components/LookAtConstraint.js +35 -35
  396. package/lib/engine-components/NeedleMenu.d.ts +50 -50
  397. package/lib/engine-components/NeedleMenu.js +92 -92
  398. package/lib/engine-components/NestedGltf.d.ts +25 -25
  399. package/lib/engine-components/NestedGltf.js +88 -88
  400. package/lib/engine-components/Networking.d.ts +54 -54
  401. package/lib/engine-components/Networking.js +112 -112
  402. package/lib/engine-components/OffsetConstraint.d.ts +14 -14
  403. package/lib/engine-components/OffsetConstraint.js +65 -65
  404. package/lib/engine-components/OrbitControls.d.ts +266 -266
  405. package/lib/engine-components/OrbitControls.js +1009 -1009
  406. package/lib/engine-components/PlayerColor.d.ts +19 -19
  407. package/lib/engine-components/PlayerColor.js +94 -94
  408. package/lib/engine-components/ReflectionProbe.d.ts +27 -26
  409. package/lib/engine-components/ReflectionProbe.js +201 -194
  410. package/lib/engine-components/ReflectionProbe.js.map +1 -1
  411. package/lib/engine-components/Renderer.d.ts +153 -153
  412. package/lib/engine-components/Renderer.js +830 -830
  413. package/lib/engine-components/RendererInstancing.d.ts +140 -140
  414. package/lib/engine-components/RendererInstancing.js +744 -744
  415. package/lib/engine-components/RendererLightmap.d.ts +24 -24
  416. package/lib/engine-components/RendererLightmap.js +182 -182
  417. package/lib/engine-components/RigidBody.d.ts +155 -155
  418. package/lib/engine-components/RigidBody.js +517 -517
  419. package/lib/engine-components/SceneSwitcher.d.ts +263 -263
  420. package/lib/engine-components/SceneSwitcher.js +951 -951
  421. package/lib/engine-components/ScreenCapture.d.ts +144 -144
  422. package/lib/engine-components/ScreenCapture.js +547 -547
  423. package/lib/engine-components/ShadowCatcher.d.ts +33 -33
  424. package/lib/engine-components/ShadowCatcher.js +166 -166
  425. package/lib/engine-components/Skybox.d.ts +82 -82
  426. package/lib/engine-components/Skybox.js +448 -448
  427. package/lib/engine-components/SmoothFollow.d.ts +34 -34
  428. package/lib/engine-components/SmoothFollow.js +82 -82
  429. package/lib/engine-components/SpatialTrigger.d.ts +102 -102
  430. package/lib/engine-components/SpatialTrigger.js +225 -225
  431. package/lib/engine-components/SpectatorCamera.d.ts +111 -111
  432. package/lib/engine-components/SpectatorCamera.js +715 -715
  433. package/lib/engine-components/SphereCollider.d.ts +2 -2
  434. package/lib/engine-components/SphereCollider.js +2 -2
  435. package/lib/engine-components/SpriteRenderer.d.ts +132 -132
  436. package/lib/engine-components/SpriteRenderer.js +472 -472
  437. package/lib/engine-components/SyncedCamera.d.ts +41 -41
  438. package/lib/engine-components/SyncedCamera.js +199 -199
  439. package/lib/engine-components/SyncedRoom.d.ts +106 -106
  440. package/lib/engine-components/SyncedRoom.js +371 -371
  441. package/lib/engine-components/SyncedTransform.d.ts +94 -88
  442. package/lib/engine-components/SyncedTransform.js +331 -326
  443. package/lib/engine-components/SyncedTransform.js.map +1 -1
  444. package/lib/engine-components/TestRunner.d.ts +16 -16
  445. package/lib/engine-components/TestRunner.js +102 -102
  446. package/lib/engine-components/TransformGizmo.d.ts +75 -75
  447. package/lib/engine-components/TransformGizmo.js +209 -209
  448. package/lib/engine-components/VideoPlayer.d.ts +184 -184
  449. package/lib/engine-components/VideoPlayer.js +978 -978
  450. package/lib/engine-components/Voip.d.ts +67 -67
  451. package/lib/engine-components/Voip.js +360 -360
  452. package/lib/engine-components/api.d.ts +51 -51
  453. package/lib/engine-components/api.js +50 -50
  454. package/lib/engine-components/avatar/AvatarBlink_Simple.d.ts +11 -11
  455. package/lib/engine-components/avatar/AvatarBlink_Simple.js +76 -76
  456. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.d.ts +14 -14
  457. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.js +68 -68
  458. package/lib/engine-components/avatar/Avatar_Brain_LookAt.d.ts +29 -29
  459. package/lib/engine-components/avatar/Avatar_Brain_LookAt.js +121 -121
  460. package/lib/engine-components/avatar/Avatar_MouthShapes.d.ts +15 -15
  461. package/lib/engine-components/avatar/Avatar_MouthShapes.js +79 -79
  462. package/lib/engine-components/avatar/Avatar_MustacheShake.d.ts +9 -9
  463. package/lib/engine-components/avatar/Avatar_MustacheShake.js +29 -29
  464. package/lib/engine-components/codegen/components.d.ts +216 -216
  465. package/lib/engine-components/codegen/components.js +218 -218
  466. package/lib/engine-components/debug/LogStats.d.ts +5 -5
  467. package/lib/engine-components/debug/LogStats.js +18 -18
  468. package/lib/engine-components/export/gltf/GltfExport.d.ts +30 -30
  469. package/lib/engine-components/export/gltf/GltfExport.js +246 -246
  470. package/lib/engine-components/export/gltf/index.d.ts +1 -1
  471. package/lib/engine-components/export/gltf/index.js +1 -1
  472. package/lib/engine-components/export/index.d.ts +1 -1
  473. package/lib/engine-components/export/index.js +1 -1
  474. package/lib/engine-components/export/usdz/Extension.d.ts +22 -22
  475. package/lib/engine-components/export/usdz/Extension.js +1 -1
  476. package/lib/engine-components/export/usdz/ThreeUSDZExporter.d.ts +160 -160
  477. package/lib/engine-components/export/usdz/ThreeUSDZExporter.js +1782 -1782
  478. package/lib/engine-components/export/usdz/USDZExporter.d.ts +130 -130
  479. package/lib/engine-components/export/usdz/USDZExporter.js +663 -663
  480. package/lib/engine-components/export/usdz/extensions/Animation.d.ts +106 -106
  481. package/lib/engine-components/export/usdz/extensions/Animation.js +1071 -1071
  482. package/lib/engine-components/export/usdz/extensions/DocumentExtension.d.ts +5 -5
  483. package/lib/engine-components/export/usdz/extensions/DocumentExtension.js +6 -6
  484. package/lib/engine-components/export/usdz/extensions/USDZText.d.ts +54 -54
  485. package/lib/engine-components/export/usdz/extensions/USDZText.js +203 -203
  486. package/lib/engine-components/export/usdz/extensions/USDZUI.d.ts +8 -8
  487. package/lib/engine-components/export/usdz/extensions/USDZUI.js +157 -157
  488. package/lib/engine-components/export/usdz/extensions/behavior/Actions.d.ts +30 -30
  489. package/lib/engine-components/export/usdz/extensions/behavior/Actions.js +88 -88
  490. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.d.ts +10 -10
  491. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.js +86 -86
  492. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.d.ts +28 -28
  493. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.js +290 -290
  494. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.d.ts +190 -190
  495. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.js +1060 -1060
  496. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.d.ts +135 -135
  497. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.js +548 -548
  498. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.d.ts +7 -7
  499. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.js +115 -115
  500. package/lib/engine-components/export/usdz/index.d.ts +3 -3
  501. package/lib/engine-components/export/usdz/index.js +2 -2
  502. package/lib/engine-components/export/usdz/utils/animationutils.d.ts +7 -7
  503. package/lib/engine-components/export/usdz/utils/animationutils.js +163 -163
  504. package/lib/engine-components/export/usdz/utils/quicklook.d.ts +2 -2
  505. package/lib/engine-components/export/usdz/utils/quicklook.js +43 -43
  506. package/lib/engine-components/particlesystem/ParticleSystem.d.ts +177 -177
  507. package/lib/engine-components/particlesystem/ParticleSystem.js +1176 -1176
  508. package/lib/engine-components/particlesystem/ParticleSystemModules.d.ts +526 -526
  509. package/lib/engine-components/particlesystem/ParticleSystemModules.js +1930 -1930
  510. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.d.ts +25 -25
  511. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.js +87 -87
  512. package/lib/engine-components/particlesystem/api.d.ts +2 -2
  513. package/lib/engine-components/particlesystem/api.js +2 -2
  514. package/lib/engine-components/postprocessing/Effects/Antialiasing.d.ts +17 -17
  515. package/lib/engine-components/postprocessing/Effects/Antialiasing.js +50 -50
  516. package/lib/engine-components/postprocessing/Effects/BloomEffect.d.ts +46 -46
  517. package/lib/engine-components/postprocessing/Effects/BloomEffect.js +113 -113
  518. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.d.ts +11 -11
  519. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.js +39 -39
  520. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.d.ts +15 -15
  521. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.js +92 -92
  522. package/lib/engine-components/postprocessing/Effects/DepthOfField.d.ts +25 -25
  523. package/lib/engine-components/postprocessing/Effects/DepthOfField.js +104 -104
  524. package/lib/engine-components/postprocessing/Effects/EffectWrapper.d.ts +12 -12
  525. package/lib/engine-components/postprocessing/Effects/EffectWrapper.js +18 -18
  526. package/lib/engine-components/postprocessing/Effects/Pixelation.d.ts +11 -11
  527. package/lib/engine-components/postprocessing/Effects/Pixelation.js +32 -32
  528. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.d.ts +18 -18
  529. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.js +91 -91
  530. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.d.ts +70 -70
  531. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.js +175 -175
  532. package/lib/engine-components/postprocessing/Effects/Sharpening.d.ts +17 -17
  533. package/lib/engine-components/postprocessing/Effects/Sharpening.js +123 -123
  534. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.d.ts +17 -17
  535. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.js +70 -70
  536. package/lib/engine-components/postprocessing/Effects/Tonemapping.d.ts +26 -26
  537. package/lib/engine-components/postprocessing/Effects/Tonemapping.js +138 -138
  538. package/lib/engine-components/postprocessing/Effects/Vignette.d.ts +15 -15
  539. package/lib/engine-components/postprocessing/Effects/Vignette.js +60 -60
  540. package/lib/engine-components/postprocessing/PostProcessingEffect.d.ts +72 -72
  541. package/lib/engine-components/postprocessing/PostProcessingEffect.js +149 -149
  542. package/lib/engine-components/postprocessing/PostProcessingHandler.d.ts +25 -25
  543. package/lib/engine-components/postprocessing/PostProcessingHandler.js +350 -350
  544. package/lib/engine-components/postprocessing/Volume.d.ts +89 -89
  545. package/lib/engine-components/postprocessing/Volume.js +367 -367
  546. package/lib/engine-components/postprocessing/VolumeParameter.d.ts +26 -26
  547. package/lib/engine-components/postprocessing/VolumeParameter.js +136 -136
  548. package/lib/engine-components/postprocessing/VolumeProfile.d.ts +15 -15
  549. package/lib/engine-components/postprocessing/VolumeProfile.js +60 -60
  550. package/lib/engine-components/postprocessing/index.d.ts +5 -5
  551. package/lib/engine-components/postprocessing/index.js +5 -5
  552. package/lib/engine-components/postprocessing/utils.d.ts +11 -11
  553. package/lib/engine-components/postprocessing/utils.js +37 -37
  554. package/lib/engine-components/timeline/PlayableDirector.d.ts +163 -163
  555. package/lib/engine-components/timeline/PlayableDirector.js +686 -686
  556. package/lib/engine-components/timeline/SignalAsset.d.ts +24 -24
  557. package/lib/engine-components/timeline/SignalAsset.js +130 -130
  558. package/lib/engine-components/timeline/TimelineModels.d.ts +89 -89
  559. package/lib/engine-components/timeline/TimelineModels.js +22 -22
  560. package/lib/engine-components/timeline/TimelineTracks.d.ts +110 -110
  561. package/lib/engine-components/timeline/TimelineTracks.js +879 -879
  562. package/lib/engine-components/timeline/index.d.ts +4 -4
  563. package/lib/engine-components/timeline/index.js +3 -3
  564. package/lib/engine-components/ui/BaseUIComponent.d.ts +49 -49
  565. package/lib/engine-components/ui/BaseUIComponent.js +170 -170
  566. package/lib/engine-components/ui/Button.d.ts +64 -64
  567. package/lib/engine-components/ui/Button.js +315 -315
  568. package/lib/engine-components/ui/Canvas.d.ts +74 -74
  569. package/lib/engine-components/ui/Canvas.js +407 -407
  570. package/lib/engine-components/ui/CanvasGroup.d.ts +19 -19
  571. package/lib/engine-components/ui/CanvasGroup.js +58 -58
  572. package/lib/engine-components/ui/EventSystem.d.ts +125 -125
  573. package/lib/engine-components/ui/EventSystem.js +764 -764
  574. package/lib/engine-components/ui/Graphic.d.ts +55 -55
  575. package/lib/engine-components/ui/Graphic.js +254 -254
  576. package/lib/engine-components/ui/Image.d.ts +35 -35
  577. package/lib/engine-components/ui/Image.js +116 -116
  578. package/lib/engine-components/ui/InputField.d.ts +42 -42
  579. package/lib/engine-components/ui/InputField.js +268 -268
  580. package/lib/engine-components/ui/Interfaces.d.ts +38 -38
  581. package/lib/engine-components/ui/Interfaces.js +12 -12
  582. package/lib/engine-components/ui/Layout.d.ts +84 -84
  583. package/lib/engine-components/ui/Layout.js +330 -330
  584. package/lib/engine-components/ui/Outline.d.ts +7 -7
  585. package/lib/engine-components/ui/Outline.js +20 -20
  586. package/lib/engine-components/ui/PointerEvents.d.ts +115 -115
  587. package/lib/engine-components/ui/PointerEvents.js +145 -145
  588. package/lib/engine-components/ui/RaycastUtils.d.ts +11 -11
  589. package/lib/engine-components/ui/RaycastUtils.js +67 -67
  590. package/lib/engine-components/ui/Raycaster.d.ts +30 -30
  591. package/lib/engine-components/ui/Raycaster.js +95 -95
  592. package/lib/engine-components/ui/RectTransform.d.ts +61 -61
  593. package/lib/engine-components/ui/RectTransform.js +353 -353
  594. package/lib/engine-components/ui/SpatialHtml.d.ts +8 -8
  595. package/lib/engine-components/ui/SpatialHtml.js +79 -79
  596. package/lib/engine-components/ui/Text.d.ts +78 -78
  597. package/lib/engine-components/ui/Text.js +539 -539
  598. package/lib/engine-components/ui/Utils.d.ts +24 -24
  599. package/lib/engine-components/ui/Utils.js +90 -90
  600. package/lib/engine-components/ui/index.d.ts +1 -1
  601. package/lib/engine-components/ui/index.js +1 -1
  602. package/lib/engine-components/utils/EnvironmentScene.d.ts +5 -5
  603. package/lib/engine-components/utils/EnvironmentScene.js +205 -205
  604. package/lib/engine-components/utils/LookAt.d.ts +31 -31
  605. package/lib/engine-components/utils/LookAt.js +82 -82
  606. package/lib/engine-components/utils/OpenURL.d.ts +42 -42
  607. package/lib/engine-components/utils/OpenURL.js +119 -119
  608. package/lib/engine-components/webxr/Avatar.d.ts +25 -25
  609. package/lib/engine-components/webxr/Avatar.js +255 -255
  610. package/lib/engine-components/webxr/TeleportTarget.d.ts +7 -7
  611. package/lib/engine-components/webxr/TeleportTarget.js +7 -7
  612. package/lib/engine-components/webxr/WebARCameraBackground.d.ts +30 -30
  613. package/lib/engine-components/webxr/WebARCameraBackground.js +155 -155
  614. package/lib/engine-components/webxr/WebARSessionRoot.d.ts +98 -98
  615. package/lib/engine-components/webxr/WebARSessionRoot.js +770 -770
  616. package/lib/engine-components/webxr/WebXR.d.ts +232 -232
  617. package/lib/engine-components/webxr/WebXR.js +561 -561
  618. package/lib/engine-components/webxr/WebXRAvatar.d.ts +27 -27
  619. package/lib/engine-components/webxr/WebXRAvatar.js +44 -44
  620. package/lib/engine-components/webxr/WebXRImageTracking.d.ts +86 -86
  621. package/lib/engine-components/webxr/WebXRImageTracking.js +470 -470
  622. package/lib/engine-components/webxr/WebXRPlaneTracking.d.ts +92 -92
  623. package/lib/engine-components/webxr/WebXRPlaneTracking.js +500 -500
  624. package/lib/engine-components/webxr/WebXRRig.d.ts +32 -32
  625. package/lib/engine-components/webxr/WebXRRig.js +72 -72
  626. package/lib/engine-components/webxr/XRFlag.d.ts +38 -38
  627. package/lib/engine-components/webxr/XRFlag.js +139 -139
  628. package/lib/engine-components/webxr/controllers/XRControllerFollow.d.ts +47 -47
  629. package/lib/engine-components/webxr/controllers/XRControllerFollow.js +120 -120
  630. package/lib/engine-components/webxr/controllers/XRControllerModel.d.ts +43 -43
  631. package/lib/engine-components/webxr/controllers/XRControllerModel.js +351 -351
  632. package/lib/engine-components/webxr/controllers/XRControllerMovement.d.ts +78 -78
  633. package/lib/engine-components/webxr/controllers/XRControllerMovement.js +506 -506
  634. package/lib/engine-components/webxr/index.d.ts +3 -3
  635. package/lib/engine-components/webxr/index.js +3 -3
  636. package/lib/engine-components/webxr/types.d.ts +3 -3
  637. package/lib/engine-components/webxr/types.js +1 -1
  638. package/lib/engine-components-experimental/Presentation.d.ts +6 -6
  639. package/lib/engine-components-experimental/Presentation.js +9 -9
  640. package/lib/engine-components-experimental/api.d.ts +4 -4
  641. package/lib/engine-components-experimental/api.js +4 -4
  642. package/lib/engine-components-experimental/networking/PlayerSync.d.ts +156 -156
  643. package/lib/engine-components-experimental/networking/PlayerSync.js +377 -377
  644. package/lib/engine-schemes/api.d.ts +12 -12
  645. package/lib/engine-schemes/api.js +12 -12
  646. package/lib/engine-schemes/schemes.d.ts +7 -7
  647. package/lib/engine-schemes/schemes.js +19 -19
  648. package/lib/engine-schemes/synced-camera-model.d.ts +25 -25
  649. package/lib/engine-schemes/synced-camera-model.js +67 -67
  650. package/lib/engine-schemes/synced-transform-model.d.ts +31 -31
  651. package/lib/engine-schemes/synced-transform-model.js +66 -66
  652. package/lib/engine-schemes/transform.d.ts +12 -12
  653. package/lib/engine-schemes/transform.js +39 -39
  654. package/lib/engine-schemes/vec2.d.ts +10 -10
  655. package/lib/engine-schemes/vec2.js +25 -25
  656. package/lib/engine-schemes/vec3.d.ts +11 -11
  657. package/lib/engine-schemes/vec3.js +29 -29
  658. package/lib/engine-schemes/vec4.d.ts +12 -12
  659. package/lib/engine-schemes/vec4.js +33 -33
  660. package/lib/engine-schemes/vr-user-state-buffer.d.ts +37 -37
  661. package/lib/engine-schemes/vr-user-state-buffer.js +110 -110
  662. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.d.ts +6 -6
  663. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.js +45 -45
  664. package/lib/needle-engine.d.ts +7 -7
  665. package/lib/needle-engine.js +64 -64
  666. package/package.json +1 -1
  667. package/plugins/common/buildinfo.js +64 -64
  668. package/plugins/common/cloud.js +1 -1
  669. package/plugins/common/config.cjs +31 -31
  670. package/plugins/common/config.js +35 -35
  671. package/plugins/common/files.js +31 -31
  672. package/plugins/common/generator.js +10 -10
  673. package/plugins/common/license.js +341 -330
  674. package/plugins/common/npm.js +15 -15
  675. package/plugins/common/timers.js +7 -7
  676. package/plugins/common/version.js +37 -37
  677. package/plugins/gltf-packer.mjs +1 -1
  678. package/plugins/next/alias.cjs +39 -39
  679. package/plugins/next/license.cjs +18 -18
  680. package/plugins/next/meshbvhworker.cjs +18 -18
  681. package/plugins/next/next.js +128 -128
  682. package/plugins/types/index.d.ts +2 -2
  683. package/plugins/types/license.d.ts +24 -24
  684. package/plugins/types/needleConfig.d.ts +27 -27
  685. package/plugins/types/userconfig.d.ts +105 -105
  686. package/plugins/types/webmanifest.d.ts +32 -32
  687. package/plugins/vite/alias.js +174 -174
  688. package/plugins/vite/asap.js +245 -245
  689. package/plugins/vite/build-pipeline.js +355 -355
  690. package/plugins/vite/build.js +19 -19
  691. package/plugins/vite/buildinfo.js +41 -41
  692. package/plugins/vite/config.js +106 -106
  693. package/plugins/vite/copyfiles.js +138 -138
  694. package/plugins/vite/defines.js +66 -66
  695. package/plugins/vite/dependencies.js +216 -216
  696. package/plugins/vite/dependency-watcher.js +231 -231
  697. package/plugins/vite/drop-client.js +76 -76
  698. package/plugins/vite/drop.js +87 -87
  699. package/plugins/vite/editor-connection.js +124 -124
  700. package/plugins/vite/facebook-instant-games.js +99 -99
  701. package/plugins/vite/gzip.js +5 -5
  702. package/plugins/vite/imports-logger.js +143 -143
  703. package/plugins/vite/index.js +139 -139
  704. package/plugins/vite/license.js +55 -55
  705. package/plugins/vite/meta.js +163 -163
  706. package/plugins/vite/npm.js +7 -7
  707. package/plugins/vite/peer.js +29 -29
  708. package/plugins/vite/poster-client.js +73 -73
  709. package/plugins/vite/poster.js +79 -79
  710. package/plugins/vite/pwa.js +604 -604
  711. package/plugins/vite/reload-client.js +15 -15
  712. package/plugins/vite/reload.js +363 -363
  713. package/plugins/vite/server.js +66 -66
  714. package/plugins/vite/transform-codegen.js +55 -55
  715. package/plugins/vite/transform.js +31 -31
  716. package/plugins/vite/vite-4.4-hack.js +31 -31
  717. package/src/asap/needle-asap.ts +111 -111
  718. package/src/asap/sessiongranted.ts +75 -75
  719. package/src/asap/utils.ts +4 -4
  720. package/src/engine/analytics/index.ts +10 -10
  721. package/src/engine/analytics/lcp.ts +35 -35
  722. package/src/engine/api.ts +81 -81
  723. package/src/engine/assets/index.ts +59 -59
  724. package/src/engine/assets/static.js +5 -5
  725. package/src/engine/codegen/register_types.ts +300 -300
  726. package/src/engine/debug/debug.ts +51 -51
  727. package/src/engine/debug/debug_console.ts +333 -333
  728. package/src/engine/debug/debug_overlay.ts +332 -332
  729. package/src/engine/debug/debug_spatial_console.ts +429 -429
  730. package/src/engine/debug/index.ts +1 -1
  731. package/src/engine/engine_addressables.ts +679 -679
  732. package/src/engine/engine_animation.ts +145 -145
  733. package/src/engine/engine_application.ts +113 -113
  734. package/src/engine/engine_assetdatabase.ts +387 -387
  735. package/src/engine/engine_audio.ts +24 -24
  736. package/src/engine/engine_camera.ts +39 -39
  737. package/src/engine/engine_components.ts +374 -373
  738. package/src/engine/engine_components_internal.ts +40 -40
  739. package/src/engine/engine_constants.ts +52 -52
  740. package/src/engine/engine_context.ts +1662 -1662
  741. package/src/engine/engine_context_registry.ts +129 -129
  742. package/src/engine/engine_coroutine.ts +54 -54
  743. package/src/engine/engine_create_objects.ts +398 -398
  744. package/src/engine/engine_default_parameters.ts +3 -3
  745. package/src/engine/engine_editor-sync.ts +28 -28
  746. package/src/engine/engine_element.ts +869 -871
  747. package/src/engine/engine_element_attributes.ts +85 -85
  748. package/src/engine/engine_element_extras.ts +16 -16
  749. package/src/engine/engine_element_loading.ts +381 -381
  750. package/src/engine/engine_element_overlay.ts +186 -186
  751. package/src/engine/engine_fileloader.js +9 -9
  752. package/src/engine/engine_gameobject.ts +684 -684
  753. package/src/engine/engine_generic_utils.js +13 -13
  754. package/src/engine/engine_gizmos.ts +577 -577
  755. package/src/engine/engine_gltf.ts +29 -29
  756. package/src/engine/engine_gltf_builtin_components.ts +403 -403
  757. package/src/engine/engine_hot_reload.ts +198 -198
  758. package/src/engine/engine_input.ts +1460 -1460
  759. package/src/engine/engine_input_utils.ts +23 -23
  760. package/src/engine/engine_instancing.ts +45 -45
  761. package/src/engine/engine_license.ts +329 -329
  762. package/src/engine/engine_lifecycle_api.ts +106 -106
  763. package/src/engine/engine_lifecycle_functions_internal.ts +193 -193
  764. package/src/engine/engine_lightdata.ts +117 -117
  765. package/src/engine/engine_loaders.ts +82 -82
  766. package/src/engine/engine_lods.ts +168 -168
  767. package/src/engine/engine_mainloop_utils.ts +472 -472
  768. package/src/engine/engine_math.ts +282 -282
  769. package/src/engine/engine_modules.ts +83 -83
  770. package/src/engine/engine_networking.ts +841 -841
  771. package/src/engine/engine_networking_auto.ts +352 -352
  772. package/src/engine/engine_networking_blob.ts +254 -254
  773. package/src/engine/engine_networking_files.ts +217 -217
  774. package/src/engine/engine_networking_files_default_components.ts +58 -58
  775. package/src/engine/engine_networking_instantiate.ts +419 -419
  776. package/src/engine/engine_networking_peer.ts +159 -159
  777. package/src/engine/engine_networking_streams.ts +713 -713
  778. package/src/engine/engine_networking_types.ts +24 -24
  779. package/src/engine/engine_networking_utils.ts +23 -23
  780. package/src/engine/engine_networking_websocket.ts +2 -2
  781. package/src/engine/engine_patcher.ts +199 -199
  782. package/src/engine/engine_physics.ts +783 -783
  783. package/src/engine/engine_physics.types.ts +46 -46
  784. package/src/engine/engine_physics_rapier.ts +1579 -1579
  785. package/src/engine/engine_playerview.ts +80 -80
  786. package/src/engine/engine_scenelighting.ts +294 -294
  787. package/src/engine/engine_scenetools.ts +365 -365
  788. package/src/engine/engine_serialization.ts +2 -2
  789. package/src/engine/engine_serialization_builtin_serializer.ts +473 -473
  790. package/src/engine/engine_serialization_core.ts +705 -705
  791. package/src/engine/engine_serialization_decorator.ts +80 -80
  792. package/src/engine/engine_setup.ts +1 -1
  793. package/src/engine/engine_shaders.ts +267 -267
  794. package/src/engine/engine_shims.ts +32 -32
  795. package/src/engine/engine_test_utils.ts +109 -109
  796. package/src/engine/engine_texture.ts +82 -82
  797. package/src/engine/engine_three_utils.ts +849 -849
  798. package/src/engine/engine_time.ts +94 -94
  799. package/src/engine/engine_time_utils.ts +237 -237
  800. package/src/engine/engine_tonemapping.ts +210 -210
  801. package/src/engine/engine_types.ts +714 -714
  802. package/src/engine/engine_typestore.ts +63 -63
  803. package/src/engine/engine_util_decorator.ts +136 -136
  804. package/src/engine/engine_utils.ts +972 -972
  805. package/src/engine/engine_utils_format.ts +212 -212
  806. package/src/engine/engine_utils_screenshot.ts +698 -698
  807. package/src/engine/engine_utils_screenshot.xr.ts +103 -103
  808. package/src/engine/export/gltf/Writers.ts +34 -34
  809. package/src/engine/export/gltf/index.ts +158 -158
  810. package/src/engine/export/index.ts +2 -2
  811. package/src/engine/export/state.ts +19 -19
  812. package/src/engine/export/utils.ts +9 -9
  813. package/src/engine/extensions/EXT_texture_exr.ts +50 -50
  814. package/src/engine/extensions/NEEDLE_animator_controller_model.ts +195 -195
  815. package/src/engine/extensions/NEEDLE_components.ts +268 -268
  816. package/src/engine/extensions/NEEDLE_gameobject_data.ts +81 -81
  817. package/src/engine/extensions/NEEDLE_lighting_settings.ts +185 -185
  818. package/src/engine/extensions/NEEDLE_lightmaps.ts +119 -119
  819. package/src/engine/extensions/NEEDLE_persistent_assets.ts +76 -76
  820. package/src/engine/extensions/NEEDLE_render_objects.ts +209 -209
  821. package/src/engine/extensions/NEEDLE_techniques_webgl.ts +640 -640
  822. package/src/engine/extensions/extension_resolver.ts +4 -4
  823. package/src/engine/extensions/extension_utils.ts +166 -166
  824. package/src/engine/extensions/extensions.ts +135 -135
  825. package/src/engine/extensions/index.ts +5 -5
  826. package/src/engine/extensions/usage_tracker.ts +100 -100
  827. package/src/engine/js-extensions/Camera.ts +37 -37
  828. package/src/engine/js-extensions/ExtensionUtils.ts +85 -85
  829. package/src/engine/js-extensions/Layers.ts +23 -23
  830. package/src/engine/js-extensions/Object3D.ts +296 -296
  831. package/src/engine/js-extensions/RGBAColor.ts +125 -75
  832. package/src/engine/js-extensions/Vector.ts +18 -18
  833. package/src/engine/js-extensions/index.ts +4 -4
  834. package/src/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +122 -122
  835. package/src/engine/shaders/shaderData.ts +67 -67
  836. package/src/engine/tests/test_utils.ts +63 -63
  837. package/src/engine/webcomponents/WebXRButtons.ts +260 -260
  838. package/src/engine/webcomponents/api.ts +6 -6
  839. package/src/engine/webcomponents/buttons.ts +262 -262
  840. package/src/engine/webcomponents/fonts.ts +41 -41
  841. package/src/engine/webcomponents/icons.ts +57 -57
  842. package/src/engine/webcomponents/index.ts +1 -1
  843. package/src/engine/webcomponents/logo-element.ts +78 -78
  844. package/src/engine/webcomponents/needle menu/needle-menu-spatial.ts +573 -573
  845. package/src/engine/webcomponents/needle menu/needle-menu.ts +1107 -1107
  846. package/src/engine/webcomponents/needle-button.ts +181 -181
  847. package/src/engine/xr/NeedleXRController.ts +1126 -1126
  848. package/src/engine/xr/NeedleXRSession.ts +1585 -1585
  849. package/src/engine/xr/NeedleXRSync.ts +220 -220
  850. package/src/engine/xr/SceneTransition.ts +78 -78
  851. package/src/engine/xr/TempXRContext.ts +216 -216
  852. package/src/engine/xr/XRRig.ts +9 -9
  853. package/src/engine/xr/api.ts +5 -5
  854. package/src/engine/xr/events.ts +102 -102
  855. package/src/engine/xr/internal.ts +34 -34
  856. package/src/engine/xr/usdz.ts +30 -30
  857. package/src/engine/xr/utils.ts +39 -39
  858. package/src/engine-components/AlignmentConstraint.ts +36 -36
  859. package/src/engine-components/Animation.ts +557 -557
  860. package/src/engine-components/AnimationCurve.ts +150 -150
  861. package/src/engine-components/AnimationUtils.ts +28 -28
  862. package/src/engine-components/AnimationUtilsAutoplay.ts +43 -43
  863. package/src/engine-components/Animator.ts +397 -397
  864. package/src/engine-components/AnimatorController.ts +1293 -1293
  865. package/src/engine-components/AudioListener.ts +92 -92
  866. package/src/engine-components/AudioSource.ts +639 -639
  867. package/src/engine-components/AvatarLoader.ts +263 -263
  868. package/src/engine-components/AxesHelper.ts +59 -59
  869. package/src/engine-components/BasicIKConstraint.ts +54 -54
  870. package/src/engine-components/BoxCollider.ts +1 -1
  871. package/src/engine-components/BoxHelperComponent.ts +114 -114
  872. package/src/engine-components/Camera.ts +719 -707
  873. package/src/engine-components/CameraUtils.ts +133 -142
  874. package/src/engine-components/CharacterController.ts +253 -253
  875. package/src/engine-components/Collider.ts +374 -374
  876. package/src/engine-components/Component.ts +1294 -1294
  877. package/src/engine-components/ContactShadows.ts +482 -482
  878. package/src/engine-components/DeleteBox.ts +62 -62
  879. package/src/engine-components/DeviceFlag.ts +46 -46
  880. package/src/engine-components/DragControls.ts +1623 -1623
  881. package/src/engine-components/DropListener.ts +698 -698
  882. package/src/engine-components/Duplicatable.ts +198 -198
  883. package/src/engine-components/EventList.ts +266 -266
  884. package/src/engine-components/EventTrigger.ts +74 -74
  885. package/src/engine-components/EventType.ts +22 -22
  886. package/src/engine-components/Fog.ts +60 -60
  887. package/src/engine-components/Gizmos.ts +56 -56
  888. package/src/engine-components/GridHelper.ts +48 -48
  889. package/src/engine-components/GroundProjection.ts +356 -356
  890. package/src/engine-components/Interactable.ts +14 -14
  891. package/src/engine-components/Joints.ts +52 -52
  892. package/src/engine-components/LODGroup.ts +153 -153
  893. package/src/engine-components/Light.ts +558 -558
  894. package/src/engine-components/LookAtConstraint.ts +25 -25
  895. package/src/engine-components/NeedleMenu.ts +84 -84
  896. package/src/engine-components/NestedGltf.ts +86 -86
  897. package/src/engine-components/Networking.ts +114 -114
  898. package/src/engine-components/OffsetConstraint.ts +60 -60
  899. package/src/engine-components/OrbitControls.ts +1068 -1068
  900. package/src/engine-components/PlayerColor.ts +103 -103
  901. package/src/engine-components/ReflectionProbe.ts +216 -209
  902. package/src/engine-components/Renderer.ts +900 -900
  903. package/src/engine-components/RendererInstancing.ts +855 -855
  904. package/src/engine-components/RendererLightmap.ts +198 -198
  905. package/src/engine-components/RigidBody.ts +526 -526
  906. package/src/engine-components/SceneSwitcher.ts +1013 -1013
  907. package/src/engine-components/ScreenCapture.ts +592 -592
  908. package/src/engine-components/ShadowCatcher.ts +172 -172
  909. package/src/engine-components/Skybox.ts +455 -455
  910. package/src/engine-components/SmoothFollow.ts +76 -76
  911. package/src/engine-components/SpatialTrigger.ts +229 -229
  912. package/src/engine-components/SpectatorCamera.ts +787 -787
  913. package/src/engine-components/SphereCollider.ts +1 -1
  914. package/src/engine-components/SpriteRenderer.ts +468 -468
  915. package/src/engine-components/SyncedCamera.ts +220 -220
  916. package/src/engine-components/SyncedRoom.ts +380 -380
  917. package/src/engine-components/SyncedTransform.ts +383 -378
  918. package/src/engine-components/TestRunner.ts +118 -118
  919. package/src/engine-components/TransformGizmo.ts +219 -219
  920. package/src/engine-components/VideoPlayer.ts +1025 -1025
  921. package/src/engine-components/Voip.ts +363 -363
  922. package/src/engine-components/api.ts +60 -60
  923. package/src/engine-components/avatar/AvatarBlink_Simple.ts +69 -69
  924. package/src/engine-components/avatar/AvatarEyeLook_Rotation.ts +63 -63
  925. package/src/engine-components/avatar/Avatar_Brain_LookAt.ts +139 -139
  926. package/src/engine-components/avatar/Avatar_MouthShapes.ts +83 -83
  927. package/src/engine-components/avatar/Avatar_MustacheShake.ts +31 -31
  928. package/src/engine-components/codegen/components.ts +217 -217
  929. package/src/engine-components/debug/LogStats.ts +21 -21
  930. package/src/engine-components/export/gltf/GltfExport.ts +265 -265
  931. package/src/engine-components/export/usdz/Extension.ts +24 -24
  932. package/src/engine-components/export/usdz/ThreeUSDZExporter.ts +2413 -2413
  933. package/src/engine-components/export/usdz/USDZExporter.ts +705 -705
  934. package/src/engine-components/export/usdz/extensions/Animation.ts +1204 -1204
  935. package/src/engine-components/export/usdz/extensions/DocumentExtension.ts +9 -9
  936. package/src/engine-components/export/usdz/extensions/USDZText.ts +240 -240
  937. package/src/engine-components/export/usdz/extensions/USDZUI.ts +189 -189
  938. package/src/engine-components/export/usdz/extensions/behavior/Actions.ts +99 -99
  939. package/src/engine-components/export/usdz/extensions/behavior/AudioExtension.ts +102 -102
  940. package/src/engine-components/export/usdz/extensions/behavior/Behaviour.ts +320 -320
  941. package/src/engine-components/export/usdz/extensions/behavior/BehaviourComponents.ts +1225 -1225
  942. package/src/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.ts +646 -646
  943. package/src/engine-components/export/usdz/extensions/behavior/PhysicsExtension.ts +132 -132
  944. package/src/engine-components/export/usdz/index.ts +2 -2
  945. package/src/engine-components/export/usdz/utils/animationutils.ts +191 -191
  946. package/src/engine-components/export/usdz/utils/quicklook.ts +50 -50
  947. package/src/engine-components/particlesystem/ParticleSystem.ts +1287 -1287
  948. package/src/engine-components/particlesystem/ParticleSystemModules.ts +1765 -1765
  949. package/src/engine-components/particlesystem/ParticleSystemSubEmitter.ts +111 -111
  950. package/src/engine-components/particlesystem/api.ts +1 -1
  951. package/src/engine-components/postprocessing/Effects/Antialiasing.ts +55 -55
  952. package/src/engine-components/postprocessing/Effects/BloomEffect.ts +116 -116
  953. package/src/engine-components/postprocessing/Effects/ChromaticAberration.ts +37 -37
  954. package/src/engine-components/postprocessing/Effects/ColorAdjustments.ts +95 -95
  955. package/src/engine-components/postprocessing/Effects/DepthOfField.ts +103 -103
  956. package/src/engine-components/postprocessing/Effects/EffectWrapper.ts +25 -25
  957. package/src/engine-components/postprocessing/Effects/Pixelation.ts +32 -32
  958. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.ts +90 -90
  959. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.ts +191 -191
  960. package/src/engine-components/postprocessing/Effects/Sharpening.ts +138 -138
  961. package/src/engine-components/postprocessing/Effects/TiltShiftEffect.ts +61 -61
  962. package/src/engine-components/postprocessing/Effects/Tonemapping.ts +155 -155
  963. package/src/engine-components/postprocessing/Effects/Vignette.ts +59 -59
  964. package/src/engine-components/postprocessing/PostProcessingEffect.ts +172 -172
  965. package/src/engine-components/postprocessing/PostProcessingHandler.ts +398 -398
  966. package/src/engine-components/postprocessing/Volume.ts +410 -410
  967. package/src/engine-components/postprocessing/VolumeParameter.ts +158 -158
  968. package/src/engine-components/postprocessing/VolumeProfile.ts +61 -61
  969. package/src/engine-components/postprocessing/index.ts +5 -5
  970. package/src/engine-components/postprocessing/utils.ts +52 -52
  971. package/src/engine-components/timeline/PlayableDirector.ts +722 -722
  972. package/src/engine-components/timeline/SignalAsset.ts +144 -144
  973. package/src/engine-components/timeline/TimelineModels.ts +92 -92
  974. package/src/engine-components/timeline/TimelineTracks.ts +967 -967
  975. package/src/engine-components/timeline/index.ts +3 -3
  976. package/src/engine-components/ui/BaseUIComponent.ts +203 -203
  977. package/src/engine-components/ui/Button.ts +307 -307
  978. package/src/engine-components/ui/Canvas.ts +419 -419
  979. package/src/engine-components/ui/CanvasGroup.ts +54 -54
  980. package/src/engine-components/ui/EventSystem.ts +853 -853
  981. package/src/engine-components/ui/Graphic.ts +275 -275
  982. package/src/engine-components/ui/Image.ts +112 -112
  983. package/src/engine-components/ui/InputField.ts +321 -321
  984. package/src/engine-components/ui/Interfaces.ts +57 -57
  985. package/src/engine-components/ui/Layout.ts +334 -334
  986. package/src/engine-components/ui/Outline.ts +13 -13
  987. package/src/engine-components/ui/PointerEvents.ts +206 -206
  988. package/src/engine-components/ui/RaycastUtils.ts +69 -69
  989. package/src/engine-components/ui/Raycaster.ts +102 -102
  990. package/src/engine-components/ui/RectTransform.ts +372 -372
  991. package/src/engine-components/ui/SpatialHtml.ts +79 -79
  992. package/src/engine-components/ui/Text.ts +578 -578
  993. package/src/engine-components/ui/Utils.ts +112 -112
  994. package/src/engine-components/utils/EnvironmentScene.ts +245 -245
  995. package/src/engine-components/utils/LookAt.ts +88 -88
  996. package/src/engine-components/utils/OpenURL.ts +114 -114
  997. package/src/engine-components/webxr/Avatar.ts +265 -265
  998. package/src/engine-components/webxr/TeleportTarget.ts +9 -9
  999. package/src/engine-components/webxr/WebARCameraBackground.ts +175 -175
  1000. package/src/engine-components/webxr/WebARSessionRoot.ts +880 -880
  1001. package/src/engine-components/webxr/WebXR.ts +585 -585
  1002. package/src/engine-components/webxr/WebXRAvatar.ts +66 -66
  1003. package/src/engine-components/webxr/WebXRImageTracking.ts +518 -518
  1004. package/src/engine-components/webxr/WebXRPlaneTracking.ts +570 -570
  1005. package/src/engine-components/webxr/WebXRRig.ts +77 -77
  1006. package/src/engine-components/webxr/XRFlag.ts +147 -147
  1007. package/src/engine-components/webxr/controllers/XRControllerFollow.ts +118 -118
  1008. package/src/engine-components/webxr/controllers/XRControllerModel.ts +374 -374
  1009. package/src/engine-components/webxr/controllers/XRControllerMovement.ts +550 -550
  1010. package/src/engine-components/webxr/index.ts +2 -2
  1011. package/src/engine-components/webxr/types.ts +3 -3
  1012. package/src/engine-components-experimental/Presentation.ts +12 -12
  1013. package/src/engine-components-experimental/api.ts +4 -4
  1014. package/src/engine-components-experimental/networking/PlayerSync.ts +401 -401
  1015. package/src/engine-schemes/COMPILE_SCHEMES.bat +3 -3
  1016. package/src/engine-schemes/COMPILE_TS.bat +11 -11
  1017. package/src/engine-schemes/README.md +1 -1
  1018. package/src/engine-schemes/api.ts +12 -12
  1019. package/src/engine-schemes/dist/api.js +17 -0
  1020. package/src/engine-schemes/dist/api.js.meta +7 -0
  1021. package/src/engine-schemes/dist/schemes.js +25 -0
  1022. package/src/engine-schemes/dist/schemes.js.meta +7 -0
  1023. package/src/engine-schemes/dist/synced-camera-model.js +74 -0
  1024. package/src/engine-schemes/dist/synced-camera-model.js.meta +7 -0
  1025. package/src/engine-schemes/dist/synced-transform-model.js +73 -0
  1026. package/src/engine-schemes/dist/synced-transform-model.js.meta +7 -0
  1027. package/src/engine-schemes/dist/transform.js +46 -0
  1028. package/src/engine-schemes/dist/transform.js.meta +7 -0
  1029. package/src/engine-schemes/dist/vec2.js +32 -0
  1030. package/src/engine-schemes/dist/vec2.js.meta +7 -0
  1031. package/src/engine-schemes/dist/vec3.js +36 -0
  1032. package/src/engine-schemes/dist/vec3.js.meta +7 -0
  1033. package/src/engine-schemes/dist/vec4.js +40 -0
  1034. package/src/engine-schemes/dist/vec4.js.meta +7 -0
  1035. package/src/engine-schemes/dist/vr-user-state-buffer.js +110 -0
  1036. package/src/engine-schemes/dist/vr-user-state-buffer.js.meta +7 -0
  1037. package/src/engine-schemes/schemes.ts +28 -28
  1038. package/src/engine-schemes/synced-camera-model.ts +92 -92
  1039. package/src/engine-schemes/synced-transform-model.ts +90 -90
  1040. package/src/engine-schemes/syncedCamera.fbs +10 -10
  1041. package/src/engine-schemes/transform.ts +50 -50
  1042. package/src/engine-schemes/transforms.fbs +25 -25
  1043. package/src/engine-schemes/vec.fbs +19 -19
  1044. package/src/engine-schemes/vec2.ts +33 -33
  1045. package/src/engine-schemes/vec3.ts +38 -38
  1046. package/src/engine-schemes/vec4.ts +43 -43
  1047. package/src/engine-schemes/vr-user-state-buffer.ts +145 -145
  1048. package/src/engine-schemes/vrUserStateBuffer.fbs +17 -17
  1049. package/src/include/draco/draco_decoder.js +34 -34
  1050. package/src/include/ktx2/basis_transcoder.js +21 -21
  1051. package/src/include/needle/arial-msdf.json +1471 -1471
  1052. package/src/include/three/DragControls.js +231 -231
  1053. package/src/include/three/EXT_mesh_gpu_instancing_exporter.js +66 -66
  1054. package/src/needle-engine.ts +70 -70
@@ -1,1662 +1,1662 @@
1
- import 'three/examples/jsm/renderers/webgl-legacy/nodes/WebGLNodes.js';
2
-
3
- import type { EffectComposer } from "postprocessing";
4
- import {
5
- BufferGeometry, Camera, Color, DepthTexture, Group,
6
- Material, NearestFilter, NoToneMapping, Object3D, OrthographicCamera, PCFSoftShadowMap,
7
- PerspectiveCamera, RGBAFormat, Scene, SRGBColorSpace,
8
- Texture, WebGLRenderer, type WebGLRendererParameters, WebGLRenderTarget, type WebXRArrayCamera
9
- } from 'three';
10
- /** @ts-ignore (not yet in types?) */
11
- import { BasicNodeLibrary } from "three";
12
- import * as Stats from 'three/examples/jsm/libs/stats.module.js';
13
- import type { EffectComposer as ThreeEffectComposer } from "three/examples/jsm/postprocessing/EffectComposer.js";
14
- import { nodeFrame } from "three/examples/jsm/renderers/webgl-legacy/nodes/WebGLNodeBuilder.js";
15
-
16
- import { isDevEnvironment, LogType, showBalloonError, showBalloonMessage } from './debug/index.js';
17
- import { Addressables } from './engine_addressables.js';
18
- import { AnimationsRegistry } from './engine_animation.js';
19
- import { Application } from './engine_application.js';
20
- import { AssetDatabase } from './engine_assetdatabase.js';
21
- import { VERSION } from './engine_constants.js';
22
- import { ContextEvent, ContextRegistry } from './engine_context_registry.js';
23
- import { WaitForPromise } from './engine_coroutine.js';
24
- import { ObjectUtils } from "./engine_create_objects.js";
25
- import { destroy, foreachComponent } from './engine_gameobject.js';
26
- import { getLoader } from './engine_gltf.js';
27
- import { Input } from './engine_input.js';
28
- import { invokeLifecycleFunctions } from './engine_lifecycle_functions_internal.js';
29
- import { type ILightDataRegistry, LightDataRegistry } from './engine_lightdata.js';
30
- import { LODsManager } from "./engine_lods.js";
31
- import * as looputils from './engine_mainloop_utils.js';
32
- import { NetworkConnection } from './engine_networking.js';
33
- import { Physics } from './engine_physics.js';
34
- import { PlayerViewManager } from './engine_playerview.js';
35
- import { RendererData as SceneLighting } from './engine_scenelighting.js';
36
- import { logHierarchy } from './engine_three_utils.js';
37
- import { Time } from './engine_time.js';
38
- import { patchTonemapping } from './engine_tonemapping.js';
39
- import type { CoroutineData, ICamera, IComponent, IContext, ILight, LoadedModel, Model, Vec2 } from "./engine_types.js";
40
- import { deepClone, delay, DeviceUtilities, getParam } from './engine_utils.js';
41
- import type { INeedleXRSessionEventReceiver, NeedleXRSession } from './engine_xr.js';
42
- import { NeedleMenu } from './webcomponents/needle menu/needle-menu.js';
43
-
44
- const debug = getParam("debugcontext");
45
- const stats = getParam("stats");
46
- const debugActive = getParam("debugactive");
47
- const debugframerate = getParam("debugframerate");
48
- const debugCoroutine = getParam("debugcoroutine");
49
-
50
- // this is where functions that setup unity scenes will be pushed into
51
- // those will be accessed from our custom html element to load them into their context
52
- export const build_scene_functions: { [name: string]: (context: Context) => Promise<void> } = {};
53
-
54
-
55
- export declare class LoadingProgressArgs {
56
- /** the name or URL of the loaded file */
57
- name: string;
58
- /** the loading progress event from the loader */
59
- progress: ProgressEvent;
60
- /** the index of the loaded file */
61
- index: number;
62
- /** the total number of files to load */
63
- count: number;
64
- }
65
- export declare class ContextCreateArgs {
66
- /** list of glTF or GLB files to load */
67
- files: Array<string>;
68
- abortSignal?: AbortSignal;
69
- /** called when loading a provided glTF file started */
70
- onLoadingStart?: (index: number, file: string) => void;
71
- /** called on update for each loaded glTF file */
72
- onLoadingProgress?: (args: LoadingProgressArgs) => void;
73
- /** Called after a gLTF file has finished loading */
74
- onLoadingFinished?: (index: number, file: string, glTF: Model | null) => void;
75
- }
76
-
77
- export class ContextArgs {
78
- name?: string;
79
- /** for debugging only */
80
- alias?: string;
81
- /** the hash is used as a seed when initially loading the scene files */
82
- hash?: string;
83
-
84
- /** when true the context will not check if it's visible in the viewport and always update and render */
85
- runInBackground?: boolean;
86
- /** the DOM element the context belongs to or is inside of (this does not have to be the canvas. use renderer.domElement if you want to access the dom canvas) */
87
- domElement?: HTMLElement | null;
88
- /** externally owned renderer */
89
- renderer?: WebGLRenderer;
90
- /** externally owned camera */
91
- camera?: Camera;
92
- /** externally owned scene */
93
- scene?: Scene;
94
- }
95
-
96
- export enum FrameEvent {
97
- Start = -1,
98
- EarlyUpdate = 0,
99
- Update = 1,
100
- LateUpdate = 2,
101
- OnBeforeRender = 3,
102
- OnAfterRender = 4,
103
- PrePhysicsStep = 9,
104
- PostPhysicsStep = 10,
105
- Undefined = -1,
106
- }
107
-
108
- /** threejs callback event signature */
109
- export declare type OnRenderCallback = (renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry, material: Material, group: Group) => void
110
-
111
-
112
- export function registerComponent(script: IComponent, context?: Context) {
113
- if (!script) return;
114
- if (!script.isComponent) {
115
- if (isDevEnvironment() || debug)
116
- console.error("Registered script is not a Needle Engine component. \nThe script will be ignored. Please make sure your component extends \"Behaviour\" imported from \"@needle-tools/engine\"\n", script);
117
- return;
118
- }
119
- if (!context) {
120
- context = Context.Current;
121
- if (debug) console.warn("> Registering component without context");
122
- }
123
- const new_scripts = context?.new_scripts;
124
- if (!new_scripts.includes(script)) {
125
- new_scripts.push(script);
126
- }
127
- }
128
-
129
- /**
130
- * The context is the main object that holds all the data and state of the Needle Engine.
131
- * It can be used to access the scene, renderer, camera, input, physics, networking, and more.
132
- * @example
133
- * ```typescript
134
- * import { Behaviour } from "@needle-tools/engine";
135
- * import { Mesh, BoxGeometry, MeshBasicMaterial } from "three";
136
- * export class MyScript extends Behaviour {
137
- * start() {
138
- * console.log("Hello from MyScript");
139
- * this.context.scene.add(new Mesh(new BoxGeometry(), new MeshBasicMaterial()));
140
- * }
141
- * }
142
- * ```
143
- */
144
- export class Context implements IContext {
145
-
146
- private static _defaultTargetFramerate: { value?: number, toString?() } = { value: 90, toString() { return this.value; } }
147
- /** When a new context is created this is the framerate that will be used by default */
148
- static get DefaultTargetFrameRate(): number | undefined {
149
- return Context._defaultTargetFramerate.value;
150
- }
151
- /** When a new context is created this is the framerate that will be used by default */
152
- static set DefaultTargetFrameRate(val: number | undefined) {
153
- Context._defaultTargetFramerate.value = val;
154
- }
155
-
156
- private static _defaultWebglRendererParameters: WebGLRendererParameters = {
157
- antialias: true,
158
- alpha: false,
159
- // Note: this is due to a bug on OSX devices. See NE-5370
160
- powerPreference: (DeviceUtilities.isiOS() || DeviceUtilities.isMacOS()) ? "default" : "high-performance",
161
- stencil: true,
162
- // logarithmicDepthBuffer: true,
163
- // reverseDepthBuffer: true, // https://github.com/mrdoob/three.js/issues/29770
164
- };
165
- /** The default parameters that will be used when creating a new WebGLRenderer.
166
- * Modify in global context to change the default parameters for all new contexts.
167
- * @example
168
- * ```typescript
169
- * import { Context } from "@needle-tools/engine";
170
- * Context.DefaultWebGLRendererParameters.antialias = false;
171
- * ```
172
- */
173
- static get DefaultWebGLRendererParameters(): WebGLRendererParameters {
174
- return Context._defaultWebglRendererParameters;
175
- }
176
-
177
- /** The needle engine version */
178
- get version() {
179
- return VERSION;
180
- }
181
-
182
- /** The currently active context. Only set during the update loops */
183
- static get Current(): Context {
184
- return ContextRegistry.Current as Context;
185
- }
186
-
187
- /** @internal this property should not be set by user code */
188
- static set Current(context: Context) {
189
- ContextRegistry.Current = context;
190
- }
191
-
192
- static get All(): Context[] {
193
- return ContextRegistry.All as Context[];
194
- }
195
-
196
- /** The name of the context */
197
- name: string;
198
- /** An alias for the context */
199
- alias: string | undefined | null;
200
- /** When the renderer or camera are managed by an external process (e.g. when running in r3f context).
201
- * When this is false you are responsible to call update(timestamp, xframe.
202
- * It is also currently assumed that rendering is handled performed by an external process
203
- * */
204
- isManagedExternally: boolean = false;
205
- /** set to true to pause the update loop. You can receive an event for it in your components.
206
- * Note that script updates will not be called when paused */
207
- isPaused: boolean = false;
208
- /** When enabled the application will run while not visible on the page */
209
- runInBackground: boolean = false;
210
- /**
211
- * Set to the target framerate you want your application to run in (you can use ?stats to check the fps)
212
- * Set to undefined if you want to run at the maximum framerate
213
- */
214
- targetFrameRate?: number | { value?: number };
215
-
216
- /** Use a higher number for more accurate physics simulation.
217
- * When undefined physics steps will be 1 for mobile devices and 5 for desktop devices
218
- * Set to 0 to disable physics updates
219
- * TODO: changing physics steps is currently not supported because then forces that we get from the character controller and rigidbody et al are not correct anymore - this needs to be properly tested before making this configureable
220
- */
221
- private physicsSteps?: number = 1;
222
-
223
- /** used to append to loaded assets */
224
- hash?: string;
225
-
226
- /** The `<needle-engine>` web component */
227
- domElement: HTMLElement;
228
-
229
- appendHTMLElement(element: HTMLElement) {
230
- if (this.domElement.shadowRoot)
231
- return this.domElement.shadowRoot.appendChild(element);
232
- else return this.domElement.appendChild(element);
233
- }
234
-
235
- get resolutionScaleFactor() { return this._resolutionScaleFactor; }
236
- /** use to scale the resolution up or down of the renderer. default is 1 */
237
- set resolutionScaleFactor(val: number) {
238
- if (val === this._resolutionScaleFactor) return;
239
- if (typeof val !== "number") return;
240
- if (val <= 0) {
241
- console.error("Invalid resolution scale factor", val);
242
- return;
243
- }
244
- this._resolutionScaleFactor = val;
245
- this.updateSize();
246
- }
247
- private _resolutionScaleFactor: number = 1;
248
-
249
- // domElement.clientLeft etc doesnt return absolute position
250
- private _boundingClientRectFrame: number = -1;
251
- private _boundingClientRect: DOMRect | null = null;
252
- private _domX; private _domY;
253
- /** update bounding rects + domX, domY */
254
- private calculateBoundingClientRect() {
255
- // workaround for mozilla webXR viewer
256
- if (this.xr) {
257
- this._domX = 0;
258
- this._domY = 0;
259
- return;
260
- }
261
- // TODO: cache this
262
- if (this._boundingClientRectFrame === this.time.frame) return;
263
- this._boundingClientRectFrame = this.time.frame;
264
- this._boundingClientRect = this.domElement.getBoundingClientRect();
265
- this._domX = this._boundingClientRect.x;
266
- this._domY = this._boundingClientRect.y;
267
- }
268
-
269
- /** The width of the `<needle-engine>` element on the website */
270
- get domWidth(): number {
271
- // for mozilla XR
272
- if (this.isInAR) return window.innerWidth;
273
- return this.domElement.clientWidth;
274
- }
275
- /** The height of the `<needle-engine>` element on the website */
276
- get domHeight(): number {
277
- // for mozilla XR
278
- if (this.isInAR) return window.innerHeight;
279
- return this.domElement.clientHeight;
280
- }
281
- /** the X position of the Needle Engine element on the website */
282
- get domX(): number {
283
- this.calculateBoundingClientRect();
284
- return this._domX;
285
- }
286
- /** the Y position of the Needlee Engine element on the website */
287
- get domY(): number {
288
- this.calculateBoundingClientRect();
289
- return this._domY;
290
- }
291
- get isInXR() { return this.renderer?.xr?.isPresenting || false; }
292
- /** shorthand for `NeedleXRSession.active`
293
- * Automatically set by NeedleXRSession when a XR session is active
294
- * @returns the active XR session or null if no session is active
295
- * */
296
- xr: NeedleXRSession | null = null;
297
- get xrSessionMode() { return this.xr?.mode; }
298
- get isInVR() { return this.xrSessionMode === "immersive-vr"; }
299
- get isInAR() { return this.xrSessionMode === "immersive-ar"; }
300
- /** If a XR session is active and in pass through mode (immersive-ar on e.g. Quest) */
301
- get isInPassThrough() { return this.xr ? this.xr.isPassThrough : false; }
302
- /** access the raw `XRSession` object (shorthand for `context.renderer.xr.getSession()`). For more control use `NeedleXRSession.active` */
303
- get xrSession() { return this.renderer?.xr?.getSession(); }
304
- /** @returns the latest XRFrame (if a XRSession is currently active)
305
- * @link https://developer.mozilla.org/en-US/docs/Web/API/XRFrame
306
- */
307
- get xrFrame() { return this._xrFrame }
308
- /** @returns the current WebXR camera while the WebXRManager is active (shorthand for `context.renderer.xr.getCamera()`) */
309
- get xrCamera(): WebXRArrayCamera | undefined { return this.renderer.xr.isPresenting ? this.renderer?.xr?.getCamera() : undefined }
310
- private _xrFrame: XRFrame | null = null;
311
- get arOverlayElement(): HTMLElement {
312
- const el = this.domElement as any;
313
- if (typeof el.getAROverlayContainer === "function")
314
- return el.getAROverlayContainer();
315
- return this.domElement;
316
- }
317
- /** Current event of the update cycle */
318
- get currentFrameEvent(): FrameEvent {
319
- return this._currentFrameEvent;
320
- }
321
- private _currentFrameEvent: FrameEvent = FrameEvent.Undefined;
322
-
323
- scene: Scene;
324
- renderer!: WebGLRenderer;
325
- composer: EffectComposer | ThreeEffectComposer | null = null;
326
-
327
- // all scripts
328
- readonly scripts: IComponent[] = [];
329
- readonly scripts_pausedChanged: IComponent[] = [];
330
- // scripts with update event
331
- readonly scripts_earlyUpdate: IComponent[] = [];
332
- readonly scripts_update: IComponent[] = [];
333
- readonly scripts_lateUpdate: IComponent[] = [];
334
- readonly scripts_onBeforeRender: IComponent[] = [];
335
- readonly scripts_onAfterRender: IComponent[] = [];
336
- readonly scripts_WithCorroutines: IComponent[] = [];
337
- readonly scripts_immersive_vr: INeedleXRSessionEventReceiver[] = [];
338
- readonly scripts_immersive_ar: INeedleXRSessionEventReceiver[] = [];
339
- readonly coroutines: { [FrameEvent: number]: Array<CoroutineData> } = {}
340
-
341
- /** callbacks called once after the context has been created */
342
- readonly post_setup_callbacks: Function[] = [];
343
- /** called every frame at the beginning of the frame (after component start events and before earlyUpdate) */
344
- readonly pre_update_callbacks: Function[] = [];
345
- /** called every frame before rendering (after all component events) */
346
- readonly pre_render_callbacks: Array<(frame: XRFrame | null) => void> = [];
347
- /** called every frame after rendering (after all component events) */
348
- readonly post_render_callbacks: Function[] = [];
349
-
350
- /** called every frame befroe update (this list is emptied every frame) */
351
- readonly pre_update_oneshot_callbacks: Function[] = [];
352
-
353
- readonly new_scripts: IComponent[] = [];
354
- readonly new_script_start: IComponent[] = [];
355
- readonly new_scripts_pre_setup_callbacks: Function[] = [];
356
- readonly new_scripts_post_setup_callbacks: Function[] = [];
357
- readonly new_scripts_xr: INeedleXRSessionEventReceiver[] = [];
358
-
359
- /** The main camera component of the scene - this camera is used for rendering */
360
- mainCameraComponent: ICamera | undefined = undefined;
361
-
362
- /** The main camera of the scene - this camera is used for rendering */
363
- get mainCamera(): Camera {
364
- if (this._mainCamera) {
365
- return this._mainCamera;
366
- }
367
- if (this.mainCameraComponent) {
368
- const cam = this.mainCameraComponent as ICamera;
369
- if (!cam.threeCamera)
370
- cam.buildCamera();
371
- return cam.threeCamera;
372
- }
373
- if (!this._fallbackCamera) {
374
- this._fallbackCamera = new PerspectiveCamera(75, this.domWidth / this.domHeight, 0.1, 1000);
375
- }
376
- return this._fallbackCamera;
377
- }
378
- /** Set the main camera of the scene. If set to null the camera of the {@link mainCameraComponent} will be used - this camera is used for rendering */
379
- set mainCamera(cam: Camera | null) {
380
- this._mainCamera = cam;
381
- }
382
- private _mainCamera: Camera | null = null;
383
- private _fallbackCamera: PerspectiveCamera | null = null;
384
-
385
- application: Application;
386
- /** access animation mixer used by components in the scene */
387
- animations: AnimationsRegistry;
388
- /** access timings (current frame number, deltaTime, timeScale, ...) */
389
- time: Time;
390
- input: Input;
391
- /** access physics related methods (e.g. raycasting). To access the phyiscs engine use `context.physics.engine` */
392
- physics: Physics;
393
- /** access networking methods (use it to send or listen to messages or join a networking backend) */
394
- connection: NetworkConnection;
395
- /**
396
- * @deprecated AssetDataBase is deprecated
397
- */
398
- assets: AssetDatabase;
399
- mainLight: ILight | null = null;
400
- /** @deprecated Use sceneLighting */
401
- get rendererData() { return this.sceneLighting }
402
- sceneLighting: SceneLighting;
403
- addressables: Addressables;
404
- lightmaps: ILightDataRegistry;
405
- players: PlayerViewManager;
406
- readonly lodsManager: LODsManager;
407
- readonly menu: NeedleMenu;
408
-
409
- get isCreated() { return this._isCreated; }
410
-
411
- private _sizeChanged: boolean = false;
412
- private _isCreated: boolean = false;
413
- private _isCreating: boolean = false;
414
- private _isVisible: boolean = false;
415
-
416
- private _stats = stats ? new Stats.default() : null;
417
-
418
- constructor(args?: ContextArgs) {
419
- this.name = args?.name || "";
420
- this.alias = args?.alias;
421
- this.domElement = args?.domElement || document.body;
422
- this.hash = args?.hash;
423
-
424
- if (args?.renderer) {
425
- this.renderer = args.renderer;
426
- this.isManagedExternally = true;
427
- }
428
- if (args?.runInBackground !== undefined) this.runInBackground = args.runInBackground;
429
- if (args?.scene) this.scene = args.scene;
430
- else this.scene = new Scene();
431
- if (args?.camera) this._mainCamera = args.camera;
432
-
433
- this.application = new Application(this);
434
- this.time = new Time();
435
- this.input = new Input(this);
436
- this.physics = new Physics(this);
437
- this.connection = new NetworkConnection(this);
438
- // eslint-disable-next-line deprecation/deprecation
439
- this.assets = new AssetDatabase();
440
- this.sceneLighting = new SceneLighting(this);
441
- this.addressables = new Addressables(this);
442
- this.lightmaps = new LightDataRegistry(this);
443
- this.players = new PlayerViewManager(this);
444
- this.menu = new NeedleMenu(this);
445
- this.lodsManager = new LODsManager(this);
446
- this.animations = new AnimationsRegistry(this);
447
-
448
-
449
- const resizeCallback = () => this._sizeChanged = true;
450
- window.addEventListener('resize', resizeCallback);
451
- this._disposeCallbacks.push(() => window.removeEventListener('resize', resizeCallback));
452
-
453
- const resizeObserver = new ResizeObserver(_ => this._sizeChanged = true);
454
- resizeObserver.observe(this.domElement);
455
- this._disposeCallbacks.push(() => resizeObserver.disconnect());
456
-
457
- this._intersectionObserver = new IntersectionObserver(entries => {
458
- this._isVisible = entries[0].isIntersecting;
459
- });
460
- this._disposeCallbacks.push(() => this._intersectionObserver?.disconnect());
461
-
462
- ContextRegistry.register(this);
463
- }
464
-
465
- /** calling this function will dispose the current renderer and create a new one */
466
- createNewRenderer(params?: WebGLRendererParameters) {
467
- this.renderer?.dispose();
468
-
469
- params = { ...Context.DefaultWebGLRendererParameters, ...params };
470
- if (!params.canvas) {
471
- // get canvas already configured in the Needle Engine Web Component
472
- const canvas = this.domElement?.shadowRoot?.querySelector("canvas");
473
- if (canvas) {
474
- params.canvas = canvas;
475
- if (debug) {
476
- console.log("Using canvas from shadow root", canvas);
477
- }
478
- }
479
- }
480
- if (debug) console.log("Using Renderer Parameters:", params, this.domElement)
481
-
482
- this.renderer = new WebGLRenderer(params);
483
-
484
- this.renderer.debug.checkShaderErrors = isDevEnvironment() || getParam("checkshadererrors") === true;
485
-
486
- // some tonemapping other than "NONE" is required for adjusting exposure with EXR environments
487
- this.renderer.toneMappingExposure = 1; // range [0...inf] instead of the usual -15..15
488
- this.renderer.toneMapping = NoToneMapping; // could also set to LinearToneMapping, ACESFilmicToneMapping
489
-
490
- this.renderer.setClearColor(new Color('lightgrey'), 0);
491
- // // @ts-ignore
492
- // this.renderer.alpha = false;
493
- this.renderer.shadowMap.enabled = true;
494
- this.renderer.shadowMap.type = PCFSoftShadowMap;
495
- this.renderer.setSize(this.domWidth, this.domHeight);
496
- this.renderer.outputColorSpace = SRGBColorSpace;
497
-
498
- // Injecting the core nodes library here, like WebGPURenderer backends do
499
- //@ts-ignore
500
- this.renderer.nodes = {
501
- library: new BasicNodeLibrary(),
502
- modelViewMatrix: null,
503
- modelNormalViewMatrix: null,
504
- };
505
- // this.renderer.toneMapping = AgXToneMapping;
506
- this.lodsManager.setRenderer(this.renderer);
507
-
508
- this.input.bindEvents();
509
- }
510
-
511
-
512
- private _intersectionObserver: IntersectionObserver | null = null;
513
- private internalOnUpdateVisible() {
514
- this._intersectionObserver?.disconnect();
515
- this._intersectionObserver?.observe(this.domElement);
516
- }
517
-
518
- private _disposeCallbacks: Function[] = [];
519
-
520
-
521
- /** will request a renderer size update the next render call (will call updateSize the next update) */
522
- requestSizeUpdate() { this._sizeChanged = true; }
523
-
524
- /** Clamps the renderer max resolution. If undefined the max resolution is not clamped. Default is undefined */
525
- maxRenderResolution?: Vec2;
526
-
527
- /** update the renderer and canvas size */
528
- updateSize(force: boolean = false) {
529
- if (force || (!this.isManagedExternally && this.renderer.xr?.isPresenting === false)) {
530
- this._sizeChanged = false;
531
- const scaleFactor = this.resolutionScaleFactor;
532
- let width = this.domWidth * scaleFactor;
533
- let height = this.domHeight * scaleFactor;
534
- if (this.maxRenderResolution) {
535
- this.maxRenderResolution.x = Math.max(1, this.maxRenderResolution.x);
536
- width = Math.min(this.maxRenderResolution.x, width);
537
- this.maxRenderResolution.y = Math.max(1, this.maxRenderResolution.y);
538
- height = Math.min(this.maxRenderResolution.y, height);
539
- }
540
- const camera = this.mainCamera as PerspectiveCamera;
541
- this.updateAspect(camera);
542
- this.renderer.setSize(width, height, true);
543
- this.renderer.setPixelRatio(window.devicePixelRatio);
544
- // avoid setting pixel values here since this can cause pingpong updates
545
- // e.g. when system scale is set to 125%
546
- // https://github.com/needle-tools/needle-engine-support/issues/69
547
- this.renderer.domElement.style.width = "100%";
548
- this.renderer.domElement.style.height = "100%";
549
- if (this.composer) {
550
- this.composer.setSize?.call(this.composer, width, height);
551
- if ("setPixelRatio" in this.composer && typeof this.composer.setPixelRatio === "function")
552
- this.composer.setPixelRatio?.call(this.composer, window.devicePixelRatio);
553
- }
554
- }
555
- }
556
-
557
- updateAspect(camera: PerspectiveCamera | OrthographicCamera, width?: number, height?: number) {
558
- if (!camera) return;
559
- if (width === undefined)
560
- width = this.domWidth;
561
- if (height === undefined)
562
- height = this.domHeight;
563
- const aspectRatio = width / height;
564
- if ((camera as PerspectiveCamera).isPerspectiveCamera) {
565
- const cam = camera as PerspectiveCamera;
566
- const pa = cam.aspect;
567
- cam.aspect = aspectRatio;
568
- if (pa !== cam.aspect)
569
- camera.updateProjectionMatrix();
570
- }
571
- else if ((camera as OrthographicCamera).isOrthographicCamera) {
572
- const cam = camera as OrthographicCamera;
573
- // Maintain the camera's current vertical size (top - bottom)
574
- const verticalSize = cam.top - cam.bottom;
575
- // Calculate new horizontal size based on aspect ratio
576
- const horizontalSize = verticalSize * aspectRatio;
577
- // Update camera bounds while maintaining center position
578
- const halfWidth = horizontalSize / 2;
579
- const halfHeight = verticalSize / 2;
580
- if (cam.left != -halfWidth || cam.top != halfHeight) {
581
- cam.left = -halfWidth;
582
- cam.right = halfWidth;
583
- cam.top = halfHeight;
584
- cam.bottom = -halfHeight;
585
- camera.updateProjectionMatrix();
586
- }
587
- }
588
- }
589
-
590
- /** This will recreate the whole needle engine context and dispose the whole scene content
591
- * All content will be reloaded (loading times might be faster due to browser caches)
592
- * All scripts will be recreated */
593
- recreate() {
594
- this.clear();
595
- this.create(this._originalCreationArgs);
596
- }
597
-
598
- private _originalCreationArgs?: ContextCreateArgs;
599
-
600
- /** @deprecated use create. This method will be removed in a future version */
601
- async onCreate(opts?: ContextCreateArgs) {
602
- return this.create(opts);
603
- }
604
- async create(opts?: ContextCreateArgs) {
605
- try {
606
- this._isCreating = true;
607
- if (opts !== this._originalCreationArgs)
608
- this._originalCreationArgs = deepClone(opts);
609
- window.addEventListener("unhandledrejection", this.onUnhandledRejection)
610
- const res = await this.internalOnCreate(opts);
611
- this._isCreated = res;
612
- return res;
613
- }
614
- finally {
615
- window.removeEventListener("unhandledrejection", this.onUnhandledRejection)
616
- this._isCreating = false;
617
- }
618
- }
619
-
620
- private onUnhandledRejection = (event: PromiseRejectionEvent) => {
621
- this.onError(event.reason);
622
- };
623
-
624
- /** Dispatches an error */
625
- private onError(error: string) {
626
- this.domElement.dispatchEvent(new CustomEvent("error", { detail: error }));
627
- }
628
-
629
- /** Will destroy all scenes and objects in the scene
630
- */
631
- clear() {
632
- ContextRegistry.dispatchCallback(ContextEvent.ContextClearing, this);
633
- invokeLifecycleFunctions(this, ContextEvent.ContextClearing);
634
- // NOTE: this does dispose the environment/background image too
635
- // which is probably not desired if it is set via the skybox-image attribute
636
- destroy(this.scene, true, true);
637
- this.scene = new Scene();
638
- this.addressables?.dispose();
639
- this.lightmaps?.clear();
640
- this.physics?.engine?.clearCaches();
641
- this.lodsManager.disable();
642
-
643
- if (!this.isManagedExternally) {
644
- if (this.renderer) {
645
- this.renderer.renderLists.dispose();
646
- this.renderer.state.reset();
647
- this.renderer.resetState();
648
- }
649
- }
650
- // We do not want to clear the renderer here because when switching src we want to keep the last rendered frame in case the loading screen is not visible
651
- // if a user wants to see the background they can still call setClearAlpha(0) and clear manually
652
- ContextRegistry.dispatchCallback(ContextEvent.ContextCleared, this);
653
- }
654
-
655
- dispose() {
656
- this.internalOnDestroy();
657
- }
658
-
659
- /**@deprecated use dispose() */
660
- onDestroy() { this.internalOnDestroy(); }
661
- private internalOnDestroy() {
662
- Context.Current = this;
663
- ContextRegistry.dispatchCallback(ContextEvent.ContextDestroying, this);
664
- invokeLifecycleFunctions(this, ContextEvent.ContextDestroying);
665
- this.clear();
666
- this.renderer?.setAnimationLoop(null);
667
- if (this.renderer) {
668
- this.renderer.setClearAlpha(0);
669
- this.renderer.clear();
670
- if (!this.isManagedExternally) {
671
- if (debug) console.log("Disposing renderer");
672
- this.renderer.dispose();
673
- }
674
- }
675
- this.scene = null!;
676
- this.renderer = null!;
677
- this.input.dispose();
678
- this.menu.onDestroy();
679
- this.animations.onDestroy();
680
- for (const cb of this._disposeCallbacks) {
681
- try {
682
- cb();
683
- }
684
- catch (e) {
685
- console.error("Error in on dispose callback:", e, cb);
686
- }
687
- }
688
- if (this.domElement?.parentElement) {
689
- this.domElement.parentElement.removeChild(this.domElement);
690
- }
691
- this._isCreated = false;
692
- ContextRegistry.dispatchCallback(ContextEvent.ContextDestroyed, this);
693
- invokeLifecycleFunctions(this, ContextEvent.ContextDestroyed);
694
- ContextRegistry.unregister(this);
695
- if (Context.Current === this) {
696
- //@ts-ignore
697
- Context.Current = null;
698
- }
699
- }
700
-
701
- registerCoroutineUpdate(script: IComponent, coroutine: Generator, evt: FrameEvent): Generator {
702
- if (typeof coroutine?.next !== "function") {
703
- console.error("Registered invalid coroutine function from " + script.name + "\nCoroutine functions must be generators: \"*myCoroutine() {...}\"\nStart a coroutine from a component by calling \"this.startCoroutine(myCoroutine())\"")
704
- return coroutine;
705
- }
706
- if (!this.coroutines[evt]) this.coroutines[evt] = [];
707
- this.coroutines[evt].push({ comp: script, main: coroutine });
708
- return coroutine;
709
- }
710
-
711
- unregisterCoroutineUpdate(coroutine: Generator, evt: FrameEvent): void {
712
- if (!this.coroutines[evt]) return;
713
- const idx = this.coroutines[evt].findIndex(c => c.main === coroutine);
714
- if (idx >= 0) this.coroutines[evt].splice(idx, 1);
715
- }
716
-
717
- stopAllCoroutinesFrom(script: IComponent) {
718
- for (const evt in this.coroutines) {
719
- const rout: CoroutineData[] = this.coroutines[evt];
720
- for (let i = rout.length - 1; i >= 0; i--) {
721
- const r = rout[i];
722
- if (r.comp === script) {
723
- rout.splice(i, 1);
724
- }
725
- }
726
- }
727
- }
728
-
729
- private _cameraStack: ICamera[] = [];
730
-
731
- setCurrentCamera(cam: ICamera) {
732
- if (!cam) return;
733
- if (!cam.threeCamera) cam.buildCamera(); // < to build camera
734
- if (!cam.threeCamera) {
735
- console.warn("Camera component is missing camera", cam)
736
- return;
737
- }
738
- const index = this._cameraStack.indexOf(cam);
739
- if (index >= 0) this._cameraStack.splice(index, 1);
740
- this._cameraStack.push(cam);
741
- this.mainCameraComponent = cam;
742
- const camera = cam.threeCamera as PerspectiveCamera;
743
- if (camera.isPerspectiveCamera)
744
- this.updateAspect(camera);
745
- (this.mainCameraComponent as ICamera)?.applyClearFlagsIfIsActiveCamera();
746
- }
747
-
748
- removeCamera(cam?: ICamera | null) {
749
- if (!cam) return;
750
- const index = this._cameraStack.indexOf(cam);
751
- if (index >= 0) this._cameraStack.splice(index, 1);
752
-
753
- if (this.mainCameraComponent === cam) {
754
- this.mainCameraComponent = undefined;
755
-
756
- if (this._cameraStack.length > 0) {
757
- const last = this._cameraStack[this._cameraStack.length - 1];
758
- this.setCurrentCamera(last);
759
- }
760
- }
761
- }
762
-
763
-
764
-
765
- private _onBeforeRenderListeners = new Map<string, OnRenderCallback[]>();
766
- private _onAfterRenderListeners = new Map<string, OnRenderCallback[]>();
767
-
768
- /** use this to subscribe to onBeforeRender events on threejs objects */
769
- addBeforeRenderListener(target: Object3D, callback: OnRenderCallback) {
770
- if (!this._onBeforeRenderListeners.has(target.uuid)) {
771
- this._onBeforeRenderListeners.set(target.uuid, []);
772
- target.onBeforeRender = this._createRenderCallbackWrapper(target, this._onBeforeRenderListeners);
773
- }
774
- this._onBeforeRenderListeners.get(target.uuid)!.push(callback);
775
- }
776
- removeBeforeRenderListener(target: Object3D, callback: OnRenderCallback) {
777
- if (this._onBeforeRenderListeners.has(target.uuid)) {
778
- const arr = this._onBeforeRenderListeners.get(target.uuid)!;
779
- const idx = arr.indexOf(callback);
780
- if (idx >= 0) arr.splice(idx, 1);
781
- }
782
- }
783
-
784
- /** use this to subscribe to onAfterRender events on threejs objects */
785
- addAfterRenderListener(target: Object3D, callback: OnRenderCallback) {
786
- if (!this._onAfterRenderListeners.has(target.uuid)) {
787
- this._onAfterRenderListeners.set(target.uuid, []);
788
- target.onAfterRender = this._createRenderCallbackWrapper(target, this._onAfterRenderListeners);
789
- }
790
- this._onAfterRenderListeners.get(target.uuid)?.push(callback);
791
- }
792
- removeAfterRenderListener(target: Object3D, callback: OnRenderCallback) {
793
- if (this._onAfterRenderListeners.has(target.uuid)) {
794
- const arr = this._onAfterRenderListeners.get(target.uuid)!;
795
- const idx = arr.indexOf(callback);
796
- if (idx >= 0) arr.splice(idx, 1);
797
- }
798
- }
799
-
800
-
801
- private _createRenderCallbackWrapper(target: Object3D, array: Map<string, OnRenderCallback[]>): OnRenderCallback {
802
- return (renderer, scene, camera, geometry, material, group) => {
803
- const arr = array.get(target.uuid);
804
- if (!arr) return;
805
- for (let i = 0; i < arr.length; i++) {
806
- const fn = arr[i];
807
- fn(renderer, scene, camera, geometry, material, group);
808
- }
809
- }
810
- }
811
-
812
-
813
-
814
- private _requireDepthTexture: boolean = false;
815
- private _requireColorTexture: boolean = false;
816
- private _renderTarget?: WebGLRenderTarget;
817
- private _isRendering: boolean = false;
818
-
819
- get isRendering() { return this._isRendering; }
820
-
821
- setRequireDepth(val: boolean) {
822
- this._requireDepthTexture = val;
823
- }
824
-
825
- setRequireColor(val: boolean) {
826
- this._requireColorTexture = val;
827
- }
828
-
829
- get depthTexture(): DepthTexture | null {
830
- return this._renderTarget?.depthTexture || null;
831
- }
832
-
833
- get opaqueColorTexture(): Texture | null {
834
- return this._renderTarget?.texture || null;
835
- }
836
-
837
- /** returns true if the dom element is visible on screen */
838
- get isVisibleToUser() {
839
- if (this.isInXR) return true;
840
- if (!this._isVisible) return false;
841
- const style = getComputedStyle(this.domElement);
842
- return style.visibility !== "hidden" && style.display !== "none" && style.opacity !== "0";
843
- }
844
-
845
-
846
- private _createId: number = 0;
847
- private async internalOnCreate(opts?: ContextCreateArgs): Promise<boolean> {
848
- const createId = ++this._createId;
849
-
850
- if (debug) console.log("Creating context", this.name, opts);
851
-
852
- // wait for async imported dependencies to be loaded
853
- // see https://linear.app/needle/issue/NE-4445
854
- const dependenciesReady = globalThis["needle:dependencies:ready"];
855
- if (dependenciesReady instanceof Promise) {
856
- if (debug) console.log("Waiting for dependencies to be ready");
857
- await dependenciesReady
858
- .catch(err => {
859
- if (debug || isDevEnvironment()) {
860
- showBalloonError("Needle Engine dependencies failed to load. Please check the console for more details");
861
- const printedError = false;
862
- if (err instanceof ReferenceError) {
863
- let offendingComponentName = "YourComponentName";
864
- const offendingComponentStartIndex = err.message.indexOf("'");
865
- if (offendingComponentStartIndex > 0) {
866
- const offendingComponentEndIndex = err.message.indexOf("'", offendingComponentStartIndex + 1);
867
- if (offendingComponentEndIndex > 0) {
868
- const name = err.message.substring(offendingComponentStartIndex + 1, offendingComponentEndIndex);
869
- if (name.length > 3) offendingComponentName = name;
870
- }
871
- }
872
- console.error(`Needle Engine dependencies failed to load:\n\n# Make sure you don't have circular imports in your scripts!\n\nPossible solutions: \n→ Replace @serializable(${offendingComponentName}) in your script with @serializable(Behaviour)\n→ If you only need type information try importing the type only, e.g: import { type ${offendingComponentName} }\n\n---`, err)
873
- return;
874
- }
875
- if (!printedError) {
876
- console.error("Needle Engine dependencies failed to load", err);
877
- }
878
- }
879
- })
880
- .then(() => {
881
- if (debug) console.log("Needle Engine dependencies are ready");
882
- });
883
- }
884
-
885
- this.clear();
886
- // stop the animation loop if its running during creation
887
- // since we do not want to start enabling scripts etc before they are deserialized
888
- if (this.isManagedExternally === false) {
889
- this.createNewRenderer();
890
- this.renderer?.setAnimationLoop(null);
891
- }
892
-
893
- await delay(1);
894
-
895
- Context.Current = this;
896
- await ContextRegistry.dispatchCallback(ContextEvent.ContextCreationStart, this);
897
-
898
- // load and create scene
899
- let prepare_succeeded = true;
900
- let loadedFiles!: Array<LoadedModel | null>;
901
- try {
902
- Context.Current = this;
903
- if (opts) {
904
- loadedFiles = await this.internalLoadInitialContent(createId, opts);
905
- }
906
- else loadedFiles = [];
907
- }
908
- catch (err) {
909
- console.error(err);
910
- prepare_succeeded = false;
911
- }
912
- if (!prepare_succeeded) {
913
- this.onError("Failed to load initial content");
914
- return false;
915
- }
916
- if (createId !== this._createId || opts?.abortSignal?.aborted) {
917
- return false;
918
- }
919
-
920
- this.internalOnUpdateVisible();
921
-
922
- if (!this.renderer) {
923
- if (debug) console.warn("Context has no renderer (perhaps it was disconnected?", this.domElement.isConnected);
924
- return false;
925
- }
926
-
927
- if (!this.isManagedExternally && !this.domElement.shadowRoot) {
928
- this.domElement.prepend(this.renderer.domElement);
929
- }
930
-
931
- Context.Current = this;
932
-
933
- // TODO: we could configure if we need physics
934
- // await this.physics.engine?.initialize();
935
-
936
- // Setup
937
- Context.Current = this;
938
- for (let i = 0; i < this.new_scripts.length; i++) {
939
- const script = this.new_scripts[i];
940
- if (script.gameObject !== undefined && script.gameObject !== null) {
941
- if (script.gameObject.userData === undefined) script.gameObject.userData = {};
942
- if (script.gameObject.userData.components === undefined) script.gameObject.userData.components = [];
943
- const arr = script.gameObject.userData.components;
944
- if (!arr.includes(script)) arr.push(script);
945
- }
946
- // if (script.gameObject && !this.raycastTargets.includes(script.gameObject)) {
947
- // this.raycastTargets.push(script.gameObject);
948
- // }
949
- }
950
-
951
- // const context = new SerializationContext(this.scene);
952
- // for (let i = 0; i < this.new_scripts.length; i++) {
953
- // const script = this.new_scripts[i];
954
- // const ser = script as unknown as ISerializable;
955
- // if (ser.$serializedTypes === undefined) continue;
956
- // context.context = this;
957
- // context.object = script.gameObject;
958
- // deserializeObject(ser, script, context);
959
- // }
960
-
961
- // resolve post setup callbacks (things that rely on threejs objects having references to components)
962
- if (this.post_setup_callbacks) {
963
- for (let i = 0; i < this.post_setup_callbacks.length; i++) {
964
- Context.Current = this;
965
- await this.post_setup_callbacks[i](this);
966
- }
967
- }
968
-
969
- if (!this._mainCamera) {
970
- Context.Current = this;
971
- let camera: ICamera | null = null;
972
- foreachComponent(this.scene, comp => {
973
- const cam = comp as ICamera;
974
- if (cam?.isCamera) {
975
- looputils.updateActiveInHierarchyWithoutEventCall(cam.gameObject);
976
- if (!cam.activeAndEnabled) return undefined;
977
- if (cam.tag === "MainCamera") {
978
- camera = cam;
979
- return true;
980
- }
981
- else camera = cam;
982
- }
983
- return undefined;
984
- });
985
- if (camera) {
986
- this.setCurrentCamera(camera);
987
- }
988
- else {
989
- const res = ContextRegistry.dispatchCallback(ContextEvent.MissingCamera, this, { files: loadedFiles });
990
- if (!res && !this.mainCamera && !this.isManagedExternally)
991
- console.warn("Missing camera in main scene", this);
992
- }
993
- }
994
-
995
- this.input.bindEvents();
996
-
997
- Context.Current = this;
998
- looputils.processNewScripts(this);
999
-
1000
- // We have to step once so that colliders that have been created in onEnable can be raycasted in start
1001
- if (this.physics.engine) {
1002
- this.physics.engine?.step(0);
1003
- this.physics.engine?.postStep();
1004
- }
1005
-
1006
- // const mainCam = this.mainCameraComponent as Camera;
1007
- // if (mainCam) {
1008
- // mainCam.applyClearFlagsIfIsActiveCamera();
1009
- // }
1010
-
1011
- if (!this.isManagedExternally && this.composer && this.mainCamera) {
1012
- // TODO: import postprocessing async
1013
- // const renderPass = new RenderPass(this.scene, this.mainCamera);
1014
- // this.renderer.setSize(this.domWidth, this.domHeight);
1015
- // this.composer.addPass(renderPass);
1016
- // this.composer.setSize(this.domWidth, this.domHeight);
1017
- }
1018
-
1019
- this._sizeChanged = true;
1020
-
1021
- if (this._stats) {
1022
- this._stats.showPanel(0);
1023
- this._stats.dom.style.position = "absolute"; // (default is fixed)
1024
- this.domElement.shadowRoot?.appendChild(this._stats.dom);
1025
- }
1026
-
1027
- if (debug)
1028
- logHierarchy(this.scene, true);
1029
-
1030
- // If no target framerate was set we use the default
1031
- if (this.targetFrameRate === undefined) {
1032
- if (debug) console.warn("No target framerate set, using default", Context.DefaultTargetFrameRate);
1033
- // the _defaultTargetFramerate is intentionally an object so it can be changed at any time if not explictly set by the user
1034
- this.targetFrameRate = Context._defaultTargetFramerate;
1035
- }
1036
- else if (debug) console.log("Target framerate set to", this.targetFrameRate);
1037
-
1038
- this._dispatchReadyAfterFrame = true;
1039
- const res = ContextRegistry.dispatchCallback(ContextEvent.ContextCreated, this, { files: loadedFiles });
1040
- if (res) {
1041
- if ("internalSetLoadingMessage" in this.domElement && typeof this.domElement.internalSetLoadingMessage === "function")
1042
- this.domElement?.internalSetLoadingMessage("finish loading");
1043
- await res;
1044
- }
1045
- if (opts?.abortSignal?.aborted) {
1046
- return false;
1047
- }
1048
- invokeLifecycleFunctions(this, ContextEvent.ContextCreated);
1049
- if (debug) console.log("Context Created...", this.renderer, this.renderer.domElement)
1050
-
1051
- this._isCreating = false;
1052
- if (!this.isManagedExternally && !opts?.abortSignal?.aborted)
1053
- this.restartRenderLoop();
1054
- return true;
1055
- }
1056
-
1057
- private async internalLoadInitialContent(createId: number, args: ContextCreateArgs): Promise<Array<LoadedModel>> {
1058
- const results = new Array<LoadedModel>();
1059
- // early out if we dont have any files to load
1060
- if (args.files.length === 0) return results;
1061
-
1062
-
1063
- const files = [...args.files];
1064
- const progressArg: LoadingProgressArgs = {
1065
- name: "",
1066
- progress: null!,
1067
- index: 0,
1068
- count: files.length
1069
- }
1070
-
1071
- const loader = getLoader();
1072
- // this hash should be constant since it is used to initialize the UIDProvider per initially loaded scene
1073
- const loadingHash = 0;
1074
- for (let i = 0; i < files.length; i++) {
1075
- if (args.abortSignal?.aborted) {
1076
- if (debug) console.log("Aborting loading because of abort signal");
1077
- break;
1078
- }
1079
- // abort loading if the create id has changed
1080
- if (createId !== this._createId) {
1081
- if (debug) console.log("Aborting loading because create id changed", createId, this._createId);
1082
- break;
1083
- }
1084
- const file = files[i];
1085
- args?.onLoadingStart?.call(this, i, file);
1086
- if (debug) console.log("Context Load " + file);
1087
- const res = await loader.loadSync(this, file, file, loadingHash, prog => {
1088
- if (args.abortSignal?.aborted) return;
1089
- progressArg.name = file;
1090
- progressArg.progress = prog;
1091
- progressArg.index = i;
1092
- progressArg.count = files.length;
1093
- args.onLoadingProgress?.call(this, progressArg);
1094
- });
1095
- args?.onLoadingFinished?.call(this, i, file, res ?? null);
1096
- if (res) {
1097
- results.push({
1098
- src: file,
1099
- file: res
1100
- });
1101
- }
1102
- else {
1103
- // a file could not be loaded
1104
- console.warn("Could not load file: " + file);
1105
- }
1106
- }
1107
-
1108
- // if the id was changed while still loading
1109
- // then we want to cleanup/destroy previously loaded files
1110
- if (createId !== this._createId || args.abortSignal?.aborted) {
1111
- if (debug) console.log("Aborting loading because create id changed or abort signal was set", createId, this._createId);
1112
- for (const res of results) {
1113
- if (res && res.file) {
1114
- for (const scene of res.file.scenes)
1115
- destroy(scene, true, true);
1116
- }
1117
- }
1118
- }
1119
- // otherwise we want to add the loaded files to the current scene
1120
- else {
1121
- let anyModelFound = false;
1122
- for (const res of results) {
1123
- if (res && res.file) {
1124
- // TODO: should we load all scenes in a glTF here?
1125
- if (res.file.scene) {
1126
- anyModelFound = true;
1127
- this.scene.add(res.file.scene);
1128
- }
1129
- else {
1130
- console.warn("No scene found in loaded file");
1131
- }
1132
- }
1133
- }
1134
- // If the loaded files do not contain ANY model
1135
- // We then attempt to create a mesh from each material in the loaded files to visualize it
1136
- // It's ok to do this at this point because we know the context has been cleared because the whole `src` attribute has been set
1137
- if (!anyModelFound) {
1138
- for (const res of results) {
1139
- if (res && res.file && "parser" in res.file) {
1140
- let y = 0;
1141
- if (!Array.isArray(res.file.parser.json.materials)) continue;
1142
- for (let i = 0; i < res.file.parser.json.materials.length; i++) {
1143
- const mat = await res.file.parser.getDependency("material", i);
1144
- const parent = new Object3D();
1145
- parent.position.x = i * 1.1;
1146
- parent.position.y = y;
1147
- this.scene.add(parent);
1148
- ObjectUtils.createPrimitive("ShaderBall", {
1149
- parent,
1150
- material: mat
1151
- });
1152
- }
1153
- y += 1;
1154
- }
1155
- }
1156
- }
1157
- }
1158
-
1159
- return results;
1160
- }
1161
-
1162
-
1163
- /** Sets the animation loop.
1164
- * Can not be done while creating the context or when disposed
1165
- **/
1166
- public restartRenderLoop(): boolean {
1167
- if (!this.renderer) {
1168
- console.error("Can not start render loop without renderer");
1169
- return false;
1170
- }
1171
- if (this._isCreating) {
1172
- console.warn("Can not start render loop while creating context");
1173
- return false;
1174
- }
1175
- this.renderer.setAnimationLoop((timestamp, frame: XRFrame | null) => {
1176
- if (this.isManagedExternally) return;
1177
- this.update(timestamp, frame)
1178
- });
1179
- return true;
1180
- }
1181
-
1182
- private _renderlooperrors = 0;
1183
-
1184
- /** Performs a full update step including script callbacks, rendering (unless isManagedExternally is set to false) and post render callbacks */
1185
- public update(timestamp: DOMHighResTimeStamp, frame?: XRFrame | null) {
1186
- if (frame === undefined) frame = null;
1187
- if (isDevEnvironment() || debug || looputils.hasNewScripts()) {
1188
- try {
1189
- performance.mark('update.start');
1190
- this.internalStep(timestamp, frame);
1191
- this._renderlooperrors = 0;
1192
- performance.mark('update.end');
1193
- performance.measure('NE Frame', 'update.start', 'update.end');
1194
- }
1195
- catch (err) {
1196
- this._renderlooperrors += 1;
1197
- if ((isDevEnvironment() || debug) && (err instanceof Error || err instanceof TypeError))
1198
- showBalloonMessage(`Caught unhandled exception during render-loop - see console for details.`, LogType.Error);
1199
- console.error("Frame #" + this.time.frame + "\n", err);
1200
- if (this._renderlooperrors >= 3) {
1201
- console.warn("Stopping render loop due to error")
1202
- this.renderer.setAnimationLoop(null);
1203
- }
1204
- this.domElement.dispatchEvent(new CustomEvent("error", { detail: err }));
1205
- }
1206
- }
1207
- else {
1208
- this.internalStep(timestamp, frame);
1209
- }
1210
- }
1211
-
1212
- /** Call to **manually** perform physics steps.
1213
- * By default the context uses the `physicsSteps` property to perform steps during the update loop
1214
- * If you just want to increase the accuracy of physics you can instead set the `physicsSteps` property to a higher value
1215
- * */
1216
- public updatePhysics(steps: number) {
1217
- this.internalUpdatePhysics(steps);
1218
- }
1219
-
1220
- private _lastTimestamp = 0;
1221
- private _accumulatedTime = 0;
1222
- private _dispatchReadyAfterFrame = false;
1223
-
1224
- // TODO: we need to skip after render callbacks if the render loop is managed externally. When changing this we also need to to update the r3f sample
1225
- private internalStep(timestamp: DOMHighResTimeStamp, frame: XRFrame | null) {
1226
- if (this.internalOnBeforeRender(timestamp, frame) === false) return;
1227
- this.internalOnRender();
1228
- this.internalOnAfterRender();
1229
- }
1230
-
1231
- private internalOnBeforeRender(timestamp: DOMHighResTimeStamp, frame: XRFrame | null) {
1232
-
1233
- // If we don't auto reset we get wrong stats in WebXR. AutoReset was turned off to support custom blits and count them too
1234
- this.renderer.info.autoReset = true;
1235
-
1236
-
1237
- const sessionStarted = frame !== null && this._xrFrame === null;
1238
- this._xrFrame = frame;
1239
- if (sessionStarted) {
1240
- this.domElement.dispatchEvent(new CustomEvent("xr-session-started", { detail: { context: this, session: this.xrSession, frame: frame } }));
1241
- }
1242
-
1243
- this._currentFrameEvent = FrameEvent.Undefined;
1244
-
1245
- if (this.isManagedExternally === false && this.isInXR === false && this.targetFrameRate !== undefined) {
1246
- if (this._lastTimestamp === 0) this._lastTimestamp = timestamp;
1247
- this._accumulatedTime += (timestamp - this._lastTimestamp) / 1000;
1248
- this._lastTimestamp = timestamp;
1249
- let targetFrameRate = this.targetFrameRate;
1250
- if (typeof targetFrameRate === "object") targetFrameRate = targetFrameRate.value!;
1251
- // if(debug) console.log(this._accumulatedTime, (1 / (targetFrameRate)))
1252
- if (this._accumulatedTime < (1 / (targetFrameRate + 1))) {
1253
- return false;
1254
- }
1255
- this._accumulatedTime = 0;
1256
- }
1257
-
1258
- this._stats?.begin();
1259
-
1260
- Context.Current = this;
1261
- if (this.onHandlePaused()) return false;
1262
-
1263
- Context.Current = this;
1264
- this.time.update();
1265
- if (debugframerate)
1266
- console.log("FPS", (this.time.smoothedFps).toFixed(0));
1267
-
1268
-
1269
- looputils.processNewScripts(this);
1270
- looputils.updateIsActive(this.scene);
1271
- looputils.processStart(this);
1272
- invokeLifecycleFunctions(this, FrameEvent.Start);
1273
-
1274
- while (this._cameraStack.length > 0 && (!this.mainCameraComponent || this.mainCameraComponent.destroyed)) {
1275
- this._cameraStack.splice(this._cameraStack.length - 1, 1);
1276
- const last = this._cameraStack[this._cameraStack.length - 1];
1277
- this.setCurrentCamera(last);
1278
- }
1279
-
1280
- if (this.pre_update_oneshot_callbacks) {
1281
- for (const i in this.pre_update_oneshot_callbacks) {
1282
- this.pre_update_oneshot_callbacks[i]();
1283
- }
1284
- this.pre_update_oneshot_callbacks.length = 0;
1285
- }
1286
-
1287
- if (this.pre_update_callbacks) {
1288
- for (const i in this.pre_update_callbacks) {
1289
- this.pre_update_callbacks[i]();
1290
- }
1291
- }
1292
-
1293
- this._currentFrameEvent = FrameEvent.EarlyUpdate;
1294
-
1295
- for (let i = 0; i < this.scripts_earlyUpdate.length; i++) {
1296
- const script = this.scripts_earlyUpdate[i];
1297
- if (!script.activeAndEnabled) continue;
1298
- if (script.earlyUpdate !== undefined) {
1299
- Context.Current = this;
1300
- script.earlyUpdate();
1301
- }
1302
- }
1303
- this.executeCoroutines(FrameEvent.EarlyUpdate);
1304
- invokeLifecycleFunctions(this, FrameEvent.EarlyUpdate);
1305
- if (this.onHandlePaused()) return false;
1306
-
1307
- this._currentFrameEvent = FrameEvent.Update;
1308
-
1309
- for (let i = 0; i < this.scripts_update.length; i++) {
1310
- const script = this.scripts_update[i];
1311
- if (!script.activeAndEnabled) continue;
1312
- if (script.update !== undefined) {
1313
- Context.Current = this;
1314
- script.update();
1315
- }
1316
- }
1317
- this.executeCoroutines(FrameEvent.Update);
1318
- invokeLifecycleFunctions(this, FrameEvent.Update);
1319
- if (this.onHandlePaused()) return false;
1320
-
1321
- this._currentFrameEvent = FrameEvent.LateUpdate;
1322
-
1323
- for (let i = 0; i < this.scripts_lateUpdate.length; i++) {
1324
- const script = this.scripts_lateUpdate[i];
1325
- if (!script.activeAndEnabled) continue;
1326
- if (script.lateUpdate !== undefined) {
1327
- Context.Current = this;
1328
- script.lateUpdate();
1329
- }
1330
- }
1331
-
1332
- // this.mainLight = null;
1333
- this.executeCoroutines(FrameEvent.LateUpdate);
1334
- invokeLifecycleFunctions(this, FrameEvent.LateUpdate);
1335
- if (this.onHandlePaused()) return false;
1336
-
1337
- if (this.physicsSteps === undefined) {
1338
- this.physicsSteps = 1;
1339
- }
1340
- if (this.physics.engine && this.physicsSteps > 0) {
1341
- this.internalUpdatePhysics(this.physicsSteps);
1342
- }
1343
-
1344
- if (this.onHandlePaused()) return false;
1345
-
1346
- if (this.isVisibleToUser || this.runInBackground) {
1347
-
1348
- this._currentFrameEvent = FrameEvent.OnBeforeRender;
1349
-
1350
- // should we move these callbacks in the regular three onBeforeRender events?
1351
- for (let i = 0; i < this.scripts_onBeforeRender.length; i++) {
1352
- const script = this.scripts_onBeforeRender[i];
1353
- if (!script.activeAndEnabled) continue;
1354
- // if(script.isActiveAndEnabled === false) continue;
1355
- if (script.onBeforeRender !== undefined) {
1356
- Context.Current = this;
1357
- script.onBeforeRender(frame);
1358
- }
1359
- }
1360
-
1361
- this.executeCoroutines(FrameEvent.OnBeforeRender);
1362
- invokeLifecycleFunctions(this, FrameEvent.OnBeforeRender);
1363
-
1364
- if (this._sizeChanged)
1365
- this.updateSize();
1366
-
1367
- if (this.pre_render_callbacks) {
1368
- for (const i in this.pre_render_callbacks) {
1369
- this.pre_render_callbacks[i](frame);
1370
- }
1371
- }
1372
-
1373
- }
1374
-
1375
- return true;
1376
- }
1377
-
1378
- private internalUpdatePhysics(steps: number) {
1379
- if (!this.physics.engine) return false;
1380
- const physicsSteps = steps;
1381
- const dt = this.time.deltaTime / physicsSteps;
1382
- for (let i = 0; i < physicsSteps; i++) {
1383
- this._currentFrameEvent = FrameEvent.PrePhysicsStep;
1384
- this.executeCoroutines(FrameEvent.PrePhysicsStep);
1385
- this.physics.engine.step(dt);
1386
- this._currentFrameEvent = FrameEvent.PostPhysicsStep;
1387
- this.executeCoroutines(FrameEvent.PostPhysicsStep);
1388
- }
1389
- this.physics.engine.postStep();
1390
- return true;
1391
- }
1392
-
1393
- private internalOnRender() {
1394
- if (!this.isManagedExternally) {
1395
- // when loading assets we compile them async after GLTFLoader is done
1396
- // but as a fallback we still register them (if e.g. there's no camera for compile async)
1397
- looputils.runPrewarm(this);
1398
- this._currentFrameEvent = FrameEvent.Undefined;
1399
- nodeFrame.update();
1400
- this.renderNow();
1401
- this._currentFrameEvent = FrameEvent.OnAfterRender;
1402
- }
1403
- }
1404
-
1405
- private internalOnAfterRender() {
1406
- if (this.isVisibleToUser || this.runInBackground) {
1407
- for (let i = 0; i < this.scripts_onAfterRender.length; i++) {
1408
- const script = this.scripts_onAfterRender[i];
1409
- if (!script.activeAndEnabled) continue;
1410
- if (script.onAfterRender !== undefined) {
1411
- Context.Current = this;
1412
- script.onAfterRender();
1413
- }
1414
- }
1415
-
1416
- this.executeCoroutines(FrameEvent.OnAfterRender);
1417
- invokeLifecycleFunctions(this, FrameEvent.OnAfterRender);
1418
-
1419
- if (this.post_render_callbacks) {
1420
- for (const i in this.post_render_callbacks) {
1421
- this.post_render_callbacks[i]();
1422
- }
1423
- }
1424
- }
1425
-
1426
- this._currentFrameEvent = -1;
1427
-
1428
- this.connection.sendBufferedMessagesNow();
1429
-
1430
- if (this._stats) {
1431
- this._stats.end();
1432
- if (this.time.frameCount % 150 === 0)
1433
- console.log(this.renderer.info.render.calls + " DrawCalls", "\nRender:", { ...this.renderer.info.render }, "\nMemory:", { ...this.renderer.info.memory }, "\nTarget Framerate: " + this.targetFrameRate);
1434
- }
1435
-
1436
- if (this._dispatchReadyAfterFrame) {
1437
- this._dispatchReadyAfterFrame = false;
1438
- this.domElement.dispatchEvent(new CustomEvent("ready"));
1439
- ContextRegistry.dispatchCallback(ContextEvent.ContextFirstFrameRendered, this);
1440
- }
1441
- }
1442
-
1443
- renderNow(camera?: Camera) {
1444
- if (!camera) {
1445
- camera = this.mainCamera as Camera;
1446
- if (!camera) return false;
1447
- }
1448
- this.handleRendererContextLost();
1449
-
1450
- this._isRendering = true;
1451
- this.renderRequiredTextures();
1452
-
1453
- if (this.renderer.toneMapping !== NoToneMapping)
1454
- patchTonemapping(this);
1455
-
1456
- if (this.composer && !this.isInXR) {
1457
- // if a camera is passed in we need to check if we need to update the composer's camera
1458
- if (camera && "setMainCamera" in this.composer) {
1459
- const currentPassesCamera = this.composer.passes[0]?.mainCamera;
1460
- if (currentPassesCamera != camera)
1461
- this.composer.setMainCamera(camera);
1462
- }
1463
- this.composer.render(this.time.deltaTime);
1464
- }
1465
- else if (camera) {
1466
- // Workaround for issue on Vision Pro –
1467
- // depth buffer is not cleared between eye draws, despite the spec...
1468
- if (this.isInXR && DeviceUtilities.isMacOS())
1469
- this.renderer.clearDepth();
1470
- this.renderer.render(this.scene, camera);
1471
- }
1472
- this._isRendering = false;
1473
- return true;
1474
- }
1475
-
1476
- private _contextRestoreTries = 0;
1477
- private handleRendererContextLost() {
1478
- // Try to restore the context every x frames
1479
- if (this.time.frame % 10 && this.renderer.getContext().isContextLost()) {
1480
- if (this._contextRestoreTries++ < 100) {
1481
- console.warn("Attempting to recover WebGL context...");
1482
- this.renderer.forceContextRestore();
1483
- }
1484
- }
1485
- }
1486
-
1487
- /** returns true if we should return out of the frame loop */
1488
- private _wasPaused: boolean = false;
1489
- private onHandlePaused(): boolean {
1490
- const paused = this.evaluatePaused();
1491
- if (this._wasPaused !== paused) {
1492
- if (debugActive) console.log("Paused?", paused, "context:" + this.alias);
1493
- for (let i = 0; i < this.scripts_pausedChanged.length; i++) {
1494
- const script = this.scripts_pausedChanged[i];
1495
- if (!script.activeAndEnabled) continue;
1496
- if (script.onPausedChanged !== undefined) {
1497
- Context.Current = this;
1498
- script.onPausedChanged(paused, this._wasPaused);
1499
- }
1500
- }
1501
- }
1502
- this._wasPaused = paused;
1503
- return paused;
1504
- }
1505
-
1506
- private evaluatePaused(): boolean {
1507
- if (this.isInXR) return false;
1508
- if (this.isPaused) return true;
1509
- // if the element is not visible use the runInBackground flag to determine if we should continue
1510
- if (this.runInBackground) {
1511
- return false;
1512
- }
1513
- const paused = !this.isVisibleToUser;
1514
- return paused;
1515
- }
1516
-
1517
- private renderRequiredTextures() {
1518
- if (!this.mainCamera) return;
1519
- if (!this._requireDepthTexture && !this._requireColorTexture) return;
1520
- if (!this._renderTarget) {
1521
- this._renderTarget = new WebGLRenderTarget(this.domWidth, this.domHeight);
1522
- if (this._requireDepthTexture) {
1523
- const dt = new DepthTexture(this.domWidth, this.domHeight);;
1524
- this._renderTarget.depthTexture = dt;
1525
- }
1526
- if (this._requireColorTexture) {
1527
- this._renderTarget.texture = new Texture();
1528
- this._renderTarget.texture.generateMipmaps = false;
1529
- this._renderTarget.texture.minFilter = NearestFilter;
1530
- this._renderTarget.texture.magFilter = NearestFilter;
1531
- this._renderTarget.texture.format = RGBAFormat;
1532
- }
1533
- }
1534
- const rt = this._renderTarget;
1535
- if (rt.texture) {
1536
- rt.texture.colorSpace = this.renderer.outputColorSpace;
1537
- }
1538
- const prevTarget = this.renderer.getRenderTarget();
1539
- this.renderer.setRenderTarget(rt);
1540
- this.renderer.render(this.scene, this.mainCamera);
1541
- this.renderer.setRenderTarget(prevTarget);
1542
- }
1543
-
1544
- private executeCoroutines(evt: FrameEvent) {
1545
- if (this.coroutines[evt]) {
1546
- const evts = this.coroutines[evt];
1547
- for (let i = 0; i < evts.length; i++) {
1548
- try {
1549
- const evt = evts[i];
1550
- // TODO we might want to keep coroutines playing even if the component is disabled or inactive
1551
- const remove = !evt.comp || evt.comp.destroyed || !evt.main || evt.comp["enabled"] === false;
1552
- if (remove) {
1553
- if (debugCoroutine) console.log("Removing coroutine", evt.comp, evt.comp["enabled"])
1554
- evts.splice(i, 1);
1555
- --i;
1556
- continue;
1557
- }
1558
- const iter = evt.chained;
1559
- if (iter && iter.length > 0) {
1560
- const last: Generator = iter[iter.length - 1];
1561
- const res = last.next();
1562
- if (res.done) {
1563
- iter.pop();
1564
- }
1565
- if (isGenerator(res)) {
1566
- if (!evt.chained) evt.chained = [];
1567
- evt.chained.push(res.value);
1568
- }
1569
- if (!res.done) continue;
1570
- }
1571
-
1572
- const res = evt.main.next();
1573
- if (res.done === true) {
1574
- evts.splice(i, 1);
1575
- --i;
1576
- continue;
1577
- }
1578
- const val = res.value;
1579
- if (isGenerator(val)) {
1580
- // invoke once if its a generator
1581
- // this means e.g. WaitForFrame(1) works and will capture
1582
- // the frame it was created
1583
- const gen = val as Generator;
1584
- const res = gen.next();
1585
- if (res.done) continue;
1586
- if (!evt.chained) evt.chained = [];
1587
- evt.chained.push(val as Generator);
1588
- }
1589
- else if (val instanceof Promise) {
1590
- // If its a promise we want to wait for it to resolve
1591
- const prom = val as Promise<any>;
1592
- if (!evt.chained) evt.chained = [];
1593
- const nested = WaitForPromise(prom);
1594
- evt.chained?.push(nested);
1595
- continue;
1596
- }
1597
- }
1598
- catch (e) {
1599
- console.error(e);
1600
- }
1601
- }
1602
- }
1603
-
1604
- function isGenerator(val: any): boolean {
1605
- if (val) {
1606
- if (val.next && val.return) {
1607
- return true;
1608
- }
1609
- }
1610
- return false;
1611
- }
1612
- }
1613
-
1614
- }
1615
-
1616
-
1617
- // const scene = new Scene();
1618
- // const useComposer = utils.getParam("postfx");
1619
- // const renderer = new WebGLRenderer({ antialias: true });
1620
- // const composer = useComposer ? new EffectComposer(renderer) : undefined;
1621
-
1622
- // renderer.setClearColor(new Color('lightgrey'), 0)
1623
- // renderer.antialias = true;
1624
- // renderer.alpha = false;
1625
- // renderer.shadowMap.enabled = true;
1626
- // renderer.shadowMap.type = PCFSoftShadowMap;
1627
- // renderer.setSize(window.innerWidth, window.innerHeight);
1628
- // renderer.outputEncoding = sRGBEncoding;
1629
- // renderer.physicallyCorrectLights = true;
1630
- // document.body.appendChild(renderer.domElement);
1631
-
1632
- // // generation pushes loading requests in this array
1633
- // const sceneData: {
1634
- // mainCamera: Camera | undefined
1635
- // } = {
1636
- // preparing: [],
1637
- // resolving: [],
1638
- // scripts: [],
1639
- // raycastTargets: [],
1640
- // mainCamera: undefined,
1641
- // mainCameraComponent: undefined,
1642
- // };
1643
-
1644
- // // contains a list of functions to be called after loading is done
1645
- // const post_setup_callbacks = [];
1646
-
1647
- // const pre_render_Callbacks = [];
1648
- // const post_render_callbacks = [];
1649
-
1650
- // const new_scripts = [];
1651
- // const new_scripts_post_setup_callbacks = [];
1652
- // const new_scripts_pre_setup_callbacks = [];
1653
-
1654
- // export {
1655
- // scene, renderer, composer,
1656
- // new_scripts,
1657
- // new_scripts_post_setup_callbacks, new_scripts_pre_setup_callbacks,
1658
- // sceneData,
1659
- // post_setup_callbacks,
1660
- // pre_render_Callbacks,
1661
- // post_render_callbacks
1662
- // }
1
+ import 'three/examples/jsm/renderers/webgl-legacy/nodes/WebGLNodes.js';
2
+
3
+ import type { EffectComposer } from "postprocessing";
4
+ import {
5
+ BufferGeometry, Camera, Color, DepthTexture, Group,
6
+ Material, NearestFilter, NoToneMapping, Object3D, OrthographicCamera, PCFSoftShadowMap,
7
+ PerspectiveCamera, RGBAFormat, Scene, SRGBColorSpace,
8
+ Texture, WebGLRenderer, type WebGLRendererParameters, WebGLRenderTarget, type WebXRArrayCamera
9
+ } from 'three';
10
+ /** @ts-ignore (not yet in types?) */
11
+ import { BasicNodeLibrary } from "three";
12
+ import * as Stats from 'three/examples/jsm/libs/stats.module.js';
13
+ import type { EffectComposer as ThreeEffectComposer } from "three/examples/jsm/postprocessing/EffectComposer.js";
14
+ import { nodeFrame } from "three/examples/jsm/renderers/webgl-legacy/nodes/WebGLNodeBuilder.js";
15
+
16
+ import { isDevEnvironment, LogType, showBalloonError, showBalloonMessage } from './debug/index.js';
17
+ import { Addressables } from './engine_addressables.js';
18
+ import { AnimationsRegistry } from './engine_animation.js';
19
+ import { Application } from './engine_application.js';
20
+ import { AssetDatabase } from './engine_assetdatabase.js';
21
+ import { VERSION } from './engine_constants.js';
22
+ import { ContextEvent, ContextRegistry } from './engine_context_registry.js';
23
+ import { WaitForPromise } from './engine_coroutine.js';
24
+ import { ObjectUtils } from "./engine_create_objects.js";
25
+ import { destroy, foreachComponent } from './engine_gameobject.js';
26
+ import { getLoader } from './engine_gltf.js';
27
+ import { Input } from './engine_input.js';
28
+ import { invokeLifecycleFunctions } from './engine_lifecycle_functions_internal.js';
29
+ import { type ILightDataRegistry, LightDataRegistry } from './engine_lightdata.js';
30
+ import { LODsManager } from "./engine_lods.js";
31
+ import * as looputils from './engine_mainloop_utils.js';
32
+ import { NetworkConnection } from './engine_networking.js';
33
+ import { Physics } from './engine_physics.js';
34
+ import { PlayerViewManager } from './engine_playerview.js';
35
+ import { RendererData as SceneLighting } from './engine_scenelighting.js';
36
+ import { logHierarchy } from './engine_three_utils.js';
37
+ import { Time } from './engine_time.js';
38
+ import { patchTonemapping } from './engine_tonemapping.js';
39
+ import type { CoroutineData, ICamera, IComponent, IContext, ILight, LoadedModel, Model, Vec2 } from "./engine_types.js";
40
+ import { deepClone, delay, DeviceUtilities, getParam } from './engine_utils.js';
41
+ import type { INeedleXRSessionEventReceiver, NeedleXRSession } from './engine_xr.js';
42
+ import { NeedleMenu } from './webcomponents/needle menu/needle-menu.js';
43
+
44
+ const debug = getParam("debugcontext");
45
+ const stats = getParam("stats");
46
+ const debugActive = getParam("debugactive");
47
+ const debugframerate = getParam("debugframerate");
48
+ const debugCoroutine = getParam("debugcoroutine");
49
+
50
+ // this is where functions that setup unity scenes will be pushed into
51
+ // those will be accessed from our custom html element to load them into their context
52
+ export const build_scene_functions: { [name: string]: (context: Context) => Promise<void> } = {};
53
+
54
+
55
+ export declare class LoadingProgressArgs {
56
+ /** the name or URL of the loaded file */
57
+ name: string;
58
+ /** the loading progress event from the loader */
59
+ progress: ProgressEvent;
60
+ /** the index of the loaded file */
61
+ index: number;
62
+ /** the total number of files to load */
63
+ count: number;
64
+ }
65
+ export declare class ContextCreateArgs {
66
+ /** list of glTF or GLB files to load */
67
+ files: Array<string>;
68
+ abortSignal?: AbortSignal;
69
+ /** called when loading a provided glTF file started */
70
+ onLoadingStart?: (index: number, file: string) => void;
71
+ /** called on update for each loaded glTF file */
72
+ onLoadingProgress?: (args: LoadingProgressArgs) => void;
73
+ /** Called after a gLTF file has finished loading */
74
+ onLoadingFinished?: (index: number, file: string, glTF: Model | null) => void;
75
+ }
76
+
77
+ export class ContextArgs {
78
+ name?: string;
79
+ /** for debugging only */
80
+ alias?: string;
81
+ /** the hash is used as a seed when initially loading the scene files */
82
+ hash?: string;
83
+
84
+ /** when true the context will not check if it's visible in the viewport and always update and render */
85
+ runInBackground?: boolean;
86
+ /** the DOM element the context belongs to or is inside of (this does not have to be the canvas. use renderer.domElement if you want to access the dom canvas) */
87
+ domElement?: HTMLElement | null;
88
+ /** externally owned renderer */
89
+ renderer?: WebGLRenderer;
90
+ /** externally owned camera */
91
+ camera?: Camera;
92
+ /** externally owned scene */
93
+ scene?: Scene;
94
+ }
95
+
96
+ export enum FrameEvent {
97
+ Start = -1,
98
+ EarlyUpdate = 0,
99
+ Update = 1,
100
+ LateUpdate = 2,
101
+ OnBeforeRender = 3,
102
+ OnAfterRender = 4,
103
+ PrePhysicsStep = 9,
104
+ PostPhysicsStep = 10,
105
+ Undefined = -1,
106
+ }
107
+
108
+ /** threejs callback event signature */
109
+ export declare type OnRenderCallback = (renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry, material: Material, group: Group) => void
110
+
111
+
112
+ export function registerComponent(script: IComponent, context?: Context) {
113
+ if (!script) return;
114
+ if (!script.isComponent) {
115
+ if (isDevEnvironment() || debug)
116
+ console.error("Registered script is not a Needle Engine component. \nThe script will be ignored. Please make sure your component extends \"Behaviour\" imported from \"@needle-tools/engine\"\n", script);
117
+ return;
118
+ }
119
+ if (!context) {
120
+ context = Context.Current;
121
+ if (debug) console.warn("> Registering component without context");
122
+ }
123
+ const new_scripts = context?.new_scripts;
124
+ if (!new_scripts.includes(script)) {
125
+ new_scripts.push(script);
126
+ }
127
+ }
128
+
129
+ /**
130
+ * The context is the main object that holds all the data and state of the Needle Engine.
131
+ * It can be used to access the scene, renderer, camera, input, physics, networking, and more.
132
+ * @example
133
+ * ```typescript
134
+ * import { Behaviour } from "@needle-tools/engine";
135
+ * import { Mesh, BoxGeometry, MeshBasicMaterial } from "three";
136
+ * export class MyScript extends Behaviour {
137
+ * start() {
138
+ * console.log("Hello from MyScript");
139
+ * this.context.scene.add(new Mesh(new BoxGeometry(), new MeshBasicMaterial()));
140
+ * }
141
+ * }
142
+ * ```
143
+ */
144
+ export class Context implements IContext {
145
+
146
+ private static _defaultTargetFramerate: { value?: number, toString?() } = { value: 90, toString() { return this.value; } }
147
+ /** When a new context is created this is the framerate that will be used by default */
148
+ static get DefaultTargetFrameRate(): number | undefined {
149
+ return Context._defaultTargetFramerate.value;
150
+ }
151
+ /** When a new context is created this is the framerate that will be used by default */
152
+ static set DefaultTargetFrameRate(val: number | undefined) {
153
+ Context._defaultTargetFramerate.value = val;
154
+ }
155
+
156
+ private static _defaultWebglRendererParameters: WebGLRendererParameters = {
157
+ antialias: true,
158
+ alpha: false,
159
+ // Note: this is due to a bug on OSX devices. See NE-5370
160
+ powerPreference: (DeviceUtilities.isiOS() || DeviceUtilities.isMacOS()) ? "default" : "high-performance",
161
+ stencil: true,
162
+ // logarithmicDepthBuffer: true,
163
+ // reverseDepthBuffer: true, // https://github.com/mrdoob/three.js/issues/29770
164
+ };
165
+ /** The default parameters that will be used when creating a new WebGLRenderer.
166
+ * Modify in global context to change the default parameters for all new contexts.
167
+ * @example
168
+ * ```typescript
169
+ * import { Context } from "@needle-tools/engine";
170
+ * Context.DefaultWebGLRendererParameters.antialias = false;
171
+ * ```
172
+ */
173
+ static get DefaultWebGLRendererParameters(): WebGLRendererParameters {
174
+ return Context._defaultWebglRendererParameters;
175
+ }
176
+
177
+ /** The needle engine version */
178
+ get version() {
179
+ return VERSION;
180
+ }
181
+
182
+ /** The currently active context. Only set during the update loops */
183
+ static get Current(): Context {
184
+ return ContextRegistry.Current as Context;
185
+ }
186
+
187
+ /** @internal this property should not be set by user code */
188
+ static set Current(context: Context) {
189
+ ContextRegistry.Current = context;
190
+ }
191
+
192
+ static get All(): Context[] {
193
+ return ContextRegistry.All as Context[];
194
+ }
195
+
196
+ /** The name of the context */
197
+ name: string;
198
+ /** An alias for the context */
199
+ alias: string | undefined | null;
200
+ /** When the renderer or camera are managed by an external process (e.g. when running in r3f context).
201
+ * When this is false you are responsible to call update(timestamp, xframe.
202
+ * It is also currently assumed that rendering is handled performed by an external process
203
+ * */
204
+ isManagedExternally: boolean = false;
205
+ /** set to true to pause the update loop. You can receive an event for it in your components.
206
+ * Note that script updates will not be called when paused */
207
+ isPaused: boolean = false;
208
+ /** When enabled the application will run while not visible on the page */
209
+ runInBackground: boolean = false;
210
+ /**
211
+ * Set to the target framerate you want your application to run in (you can use ?stats to check the fps)
212
+ * Set to undefined if you want to run at the maximum framerate
213
+ */
214
+ targetFrameRate?: number | { value?: number };
215
+
216
+ /** Use a higher number for more accurate physics simulation.
217
+ * When undefined physics steps will be 1 for mobile devices and 5 for desktop devices
218
+ * Set to 0 to disable physics updates
219
+ * TODO: changing physics steps is currently not supported because then forces that we get from the character controller and rigidbody et al are not correct anymore - this needs to be properly tested before making this configureable
220
+ */
221
+ private physicsSteps?: number = 1;
222
+
223
+ /** used to append to loaded assets */
224
+ hash?: string;
225
+
226
+ /** The `<needle-engine>` web component */
227
+ domElement: HTMLElement;
228
+
229
+ appendHTMLElement(element: HTMLElement) {
230
+ if (this.domElement.shadowRoot)
231
+ return this.domElement.shadowRoot.appendChild(element);
232
+ else return this.domElement.appendChild(element);
233
+ }
234
+
235
+ get resolutionScaleFactor() { return this._resolutionScaleFactor; }
236
+ /** use to scale the resolution up or down of the renderer. default is 1 */
237
+ set resolutionScaleFactor(val: number) {
238
+ if (val === this._resolutionScaleFactor) return;
239
+ if (typeof val !== "number") return;
240
+ if (val <= 0) {
241
+ console.error("Invalid resolution scale factor", val);
242
+ return;
243
+ }
244
+ this._resolutionScaleFactor = val;
245
+ this.updateSize();
246
+ }
247
+ private _resolutionScaleFactor: number = 1;
248
+
249
+ // domElement.clientLeft etc doesnt return absolute position
250
+ private _boundingClientRectFrame: number = -1;
251
+ private _boundingClientRect: DOMRect | null = null;
252
+ private _domX; private _domY;
253
+ /** update bounding rects + domX, domY */
254
+ private calculateBoundingClientRect() {
255
+ // workaround for mozilla webXR viewer
256
+ if (this.xr) {
257
+ this._domX = 0;
258
+ this._domY = 0;
259
+ return;
260
+ }
261
+ // TODO: cache this
262
+ if (this._boundingClientRectFrame === this.time.frame) return;
263
+ this._boundingClientRectFrame = this.time.frame;
264
+ this._boundingClientRect = this.domElement.getBoundingClientRect();
265
+ this._domX = this._boundingClientRect.x;
266
+ this._domY = this._boundingClientRect.y;
267
+ }
268
+
269
+ /** The width of the `<needle-engine>` element on the website */
270
+ get domWidth(): number {
271
+ // for mozilla XR
272
+ if (this.isInAR) return window.innerWidth;
273
+ return this.domElement.clientWidth;
274
+ }
275
+ /** The height of the `<needle-engine>` element on the website */
276
+ get domHeight(): number {
277
+ // for mozilla XR
278
+ if (this.isInAR) return window.innerHeight;
279
+ return this.domElement.clientHeight;
280
+ }
281
+ /** the X position of the Needle Engine element on the website */
282
+ get domX(): number {
283
+ this.calculateBoundingClientRect();
284
+ return this._domX;
285
+ }
286
+ /** the Y position of the Needlee Engine element on the website */
287
+ get domY(): number {
288
+ this.calculateBoundingClientRect();
289
+ return this._domY;
290
+ }
291
+ get isInXR() { return this.renderer?.xr?.isPresenting || false; }
292
+ /** shorthand for `NeedleXRSession.active`
293
+ * Automatically set by NeedleXRSession when a XR session is active
294
+ * @returns the active XR session or null if no session is active
295
+ * */
296
+ xr: NeedleXRSession | null = null;
297
+ get xrSessionMode() { return this.xr?.mode; }
298
+ get isInVR() { return this.xrSessionMode === "immersive-vr"; }
299
+ get isInAR() { return this.xrSessionMode === "immersive-ar"; }
300
+ /** If a XR session is active and in pass through mode (immersive-ar on e.g. Quest) */
301
+ get isInPassThrough() { return this.xr ? this.xr.isPassThrough : false; }
302
+ /** access the raw `XRSession` object (shorthand for `context.renderer.xr.getSession()`). For more control use `NeedleXRSession.active` */
303
+ get xrSession() { return this.renderer?.xr?.getSession(); }
304
+ /** @returns the latest XRFrame (if a XRSession is currently active)
305
+ * @link https://developer.mozilla.org/en-US/docs/Web/API/XRFrame
306
+ */
307
+ get xrFrame() { return this._xrFrame }
308
+ /** @returns the current WebXR camera while the WebXRManager is active (shorthand for `context.renderer.xr.getCamera()`) */
309
+ get xrCamera(): WebXRArrayCamera | undefined { return this.renderer.xr.isPresenting ? this.renderer?.xr?.getCamera() : undefined }
310
+ private _xrFrame: XRFrame | null = null;
311
+ get arOverlayElement(): HTMLElement {
312
+ const el = this.domElement as any;
313
+ if (typeof el.getAROverlayContainer === "function")
314
+ return el.getAROverlayContainer();
315
+ return this.domElement;
316
+ }
317
+ /** Current event of the update cycle */
318
+ get currentFrameEvent(): FrameEvent {
319
+ return this._currentFrameEvent;
320
+ }
321
+ private _currentFrameEvent: FrameEvent = FrameEvent.Undefined;
322
+
323
+ scene: Scene;
324
+ renderer!: WebGLRenderer;
325
+ composer: EffectComposer | ThreeEffectComposer | null = null;
326
+
327
+ // all scripts
328
+ readonly scripts: IComponent[] = [];
329
+ readonly scripts_pausedChanged: IComponent[] = [];
330
+ // scripts with update event
331
+ readonly scripts_earlyUpdate: IComponent[] = [];
332
+ readonly scripts_update: IComponent[] = [];
333
+ readonly scripts_lateUpdate: IComponent[] = [];
334
+ readonly scripts_onBeforeRender: IComponent[] = [];
335
+ readonly scripts_onAfterRender: IComponent[] = [];
336
+ readonly scripts_WithCorroutines: IComponent[] = [];
337
+ readonly scripts_immersive_vr: INeedleXRSessionEventReceiver[] = [];
338
+ readonly scripts_immersive_ar: INeedleXRSessionEventReceiver[] = [];
339
+ readonly coroutines: { [FrameEvent: number]: Array<CoroutineData> } = {}
340
+
341
+ /** callbacks called once after the context has been created */
342
+ readonly post_setup_callbacks: Function[] = [];
343
+ /** called every frame at the beginning of the frame (after component start events and before earlyUpdate) */
344
+ readonly pre_update_callbacks: Function[] = [];
345
+ /** called every frame before rendering (after all component events) */
346
+ readonly pre_render_callbacks: Array<(frame: XRFrame | null) => void> = [];
347
+ /** called every frame after rendering (after all component events) */
348
+ readonly post_render_callbacks: Function[] = [];
349
+
350
+ /** called every frame befroe update (this list is emptied every frame) */
351
+ readonly pre_update_oneshot_callbacks: Function[] = [];
352
+
353
+ readonly new_scripts: IComponent[] = [];
354
+ readonly new_script_start: IComponent[] = [];
355
+ readonly new_scripts_pre_setup_callbacks: Function[] = [];
356
+ readonly new_scripts_post_setup_callbacks: Function[] = [];
357
+ readonly new_scripts_xr: INeedleXRSessionEventReceiver[] = [];
358
+
359
+ /** The main camera component of the scene - this camera is used for rendering */
360
+ mainCameraComponent: ICamera | undefined = undefined;
361
+
362
+ /** The main camera of the scene - this camera is used for rendering */
363
+ get mainCamera(): Camera {
364
+ if (this._mainCamera) {
365
+ return this._mainCamera;
366
+ }
367
+ if (this.mainCameraComponent) {
368
+ const cam = this.mainCameraComponent as ICamera;
369
+ if (!cam.threeCamera)
370
+ cam.buildCamera();
371
+ return cam.threeCamera;
372
+ }
373
+ if (!this._fallbackCamera) {
374
+ this._fallbackCamera = new PerspectiveCamera(75, this.domWidth / this.domHeight, 0.1, 1000);
375
+ }
376
+ return this._fallbackCamera;
377
+ }
378
+ /** Set the main camera of the scene. If set to null the camera of the {@link mainCameraComponent} will be used - this camera is used for rendering */
379
+ set mainCamera(cam: Camera | null) {
380
+ this._mainCamera = cam;
381
+ }
382
+ private _mainCamera: Camera | null = null;
383
+ private _fallbackCamera: PerspectiveCamera | null = null;
384
+
385
+ application: Application;
386
+ /** access animation mixer used by components in the scene */
387
+ animations: AnimationsRegistry;
388
+ /** access timings (current frame number, deltaTime, timeScale, ...) */
389
+ time: Time;
390
+ input: Input;
391
+ /** access physics related methods (e.g. raycasting). To access the phyiscs engine use `context.physics.engine` */
392
+ physics: Physics;
393
+ /** access networking methods (use it to send or listen to messages or join a networking backend) */
394
+ connection: NetworkConnection;
395
+ /**
396
+ * @deprecated AssetDataBase is deprecated
397
+ */
398
+ assets: AssetDatabase;
399
+ mainLight: ILight | null = null;
400
+ /** @deprecated Use sceneLighting */
401
+ get rendererData() { return this.sceneLighting }
402
+ sceneLighting: SceneLighting;
403
+ addressables: Addressables;
404
+ lightmaps: ILightDataRegistry;
405
+ players: PlayerViewManager;
406
+ readonly lodsManager: LODsManager;
407
+ readonly menu: NeedleMenu;
408
+
409
+ get isCreated() { return this._isCreated; }
410
+
411
+ private _sizeChanged: boolean = false;
412
+ private _isCreated: boolean = false;
413
+ private _isCreating: boolean = false;
414
+ private _isVisible: boolean = false;
415
+
416
+ private _stats = stats ? new Stats.default() : null;
417
+
418
+ constructor(args?: ContextArgs) {
419
+ this.name = args?.name || "";
420
+ this.alias = args?.alias;
421
+ this.domElement = args?.domElement || document.body;
422
+ this.hash = args?.hash;
423
+
424
+ if (args?.renderer) {
425
+ this.renderer = args.renderer;
426
+ this.isManagedExternally = true;
427
+ }
428
+ if (args?.runInBackground !== undefined) this.runInBackground = args.runInBackground;
429
+ if (args?.scene) this.scene = args.scene;
430
+ else this.scene = new Scene();
431
+ if (args?.camera) this._mainCamera = args.camera;
432
+
433
+ this.application = new Application(this);
434
+ this.time = new Time();
435
+ this.input = new Input(this);
436
+ this.physics = new Physics(this);
437
+ this.connection = new NetworkConnection(this);
438
+ // eslint-disable-next-line deprecation/deprecation
439
+ this.assets = new AssetDatabase();
440
+ this.sceneLighting = new SceneLighting(this);
441
+ this.addressables = new Addressables(this);
442
+ this.lightmaps = new LightDataRegistry(this);
443
+ this.players = new PlayerViewManager(this);
444
+ this.menu = new NeedleMenu(this);
445
+ this.lodsManager = new LODsManager(this);
446
+ this.animations = new AnimationsRegistry(this);
447
+
448
+
449
+ const resizeCallback = () => this._sizeChanged = true;
450
+ window.addEventListener('resize', resizeCallback);
451
+ this._disposeCallbacks.push(() => window.removeEventListener('resize', resizeCallback));
452
+
453
+ const resizeObserver = new ResizeObserver(_ => this._sizeChanged = true);
454
+ resizeObserver.observe(this.domElement);
455
+ this._disposeCallbacks.push(() => resizeObserver.disconnect());
456
+
457
+ this._intersectionObserver = new IntersectionObserver(entries => {
458
+ this._isVisible = entries[0].isIntersecting;
459
+ });
460
+ this._disposeCallbacks.push(() => this._intersectionObserver?.disconnect());
461
+
462
+ ContextRegistry.register(this);
463
+ }
464
+
465
+ /** calling this function will dispose the current renderer and create a new one */
466
+ createNewRenderer(params?: WebGLRendererParameters) {
467
+ this.renderer?.dispose();
468
+
469
+ params = { ...Context.DefaultWebGLRendererParameters, ...params };
470
+ if (!params.canvas) {
471
+ // get canvas already configured in the Needle Engine Web Component
472
+ const canvas = this.domElement?.shadowRoot?.querySelector("canvas");
473
+ if (canvas) {
474
+ params.canvas = canvas;
475
+ if (debug) {
476
+ console.log("Using canvas from shadow root", canvas);
477
+ }
478
+ }
479
+ }
480
+ if (debug) console.log("Using Renderer Parameters:", params, this.domElement)
481
+
482
+ this.renderer = new WebGLRenderer(params);
483
+
484
+ this.renderer.debug.checkShaderErrors = isDevEnvironment() || getParam("checkshadererrors") === true;
485
+
486
+ // some tonemapping other than "NONE" is required for adjusting exposure with EXR environments
487
+ this.renderer.toneMappingExposure = 1; // range [0...inf] instead of the usual -15..15
488
+ this.renderer.toneMapping = NoToneMapping; // could also set to LinearToneMapping, ACESFilmicToneMapping
489
+
490
+ this.renderer.setClearColor(new Color('lightgrey'), 0);
491
+ // // @ts-ignore
492
+ // this.renderer.alpha = false;
493
+ this.renderer.shadowMap.enabled = true;
494
+ this.renderer.shadowMap.type = PCFSoftShadowMap;
495
+ this.renderer.setSize(this.domWidth, this.domHeight);
496
+ this.renderer.outputColorSpace = SRGBColorSpace;
497
+
498
+ // Injecting the core nodes library here, like WebGPURenderer backends do
499
+ //@ts-ignore
500
+ this.renderer.nodes = {
501
+ library: new BasicNodeLibrary(),
502
+ modelViewMatrix: null,
503
+ modelNormalViewMatrix: null,
504
+ };
505
+ // this.renderer.toneMapping = AgXToneMapping;
506
+ this.lodsManager.setRenderer(this.renderer);
507
+
508
+ this.input.bindEvents();
509
+ }
510
+
511
+
512
+ private _intersectionObserver: IntersectionObserver | null = null;
513
+ private internalOnUpdateVisible() {
514
+ this._intersectionObserver?.disconnect();
515
+ this._intersectionObserver?.observe(this.domElement);
516
+ }
517
+
518
+ private _disposeCallbacks: Function[] = [];
519
+
520
+
521
+ /** will request a renderer size update the next render call (will call updateSize the next update) */
522
+ requestSizeUpdate() { this._sizeChanged = true; }
523
+
524
+ /** Clamps the renderer max resolution. If undefined the max resolution is not clamped. Default is undefined */
525
+ maxRenderResolution?: Vec2;
526
+
527
+ /** update the renderer and canvas size */
528
+ updateSize(force: boolean = false) {
529
+ if (force || (!this.isManagedExternally && this.renderer.xr?.isPresenting === false)) {
530
+ this._sizeChanged = false;
531
+ const scaleFactor = this.resolutionScaleFactor;
532
+ let width = this.domWidth * scaleFactor;
533
+ let height = this.domHeight * scaleFactor;
534
+ if (this.maxRenderResolution) {
535
+ this.maxRenderResolution.x = Math.max(1, this.maxRenderResolution.x);
536
+ width = Math.min(this.maxRenderResolution.x, width);
537
+ this.maxRenderResolution.y = Math.max(1, this.maxRenderResolution.y);
538
+ height = Math.min(this.maxRenderResolution.y, height);
539
+ }
540
+ const camera = this.mainCamera as PerspectiveCamera;
541
+ this.updateAspect(camera);
542
+ this.renderer.setSize(width, height, true);
543
+ this.renderer.setPixelRatio(window.devicePixelRatio);
544
+ // avoid setting pixel values here since this can cause pingpong updates
545
+ // e.g. when system scale is set to 125%
546
+ // https://github.com/needle-tools/needle-engine-support/issues/69
547
+ this.renderer.domElement.style.width = "100%";
548
+ this.renderer.domElement.style.height = "100%";
549
+ if (this.composer) {
550
+ this.composer.setSize?.call(this.composer, width, height);
551
+ if ("setPixelRatio" in this.composer && typeof this.composer.setPixelRatio === "function")
552
+ this.composer.setPixelRatio?.call(this.composer, window.devicePixelRatio);
553
+ }
554
+ }
555
+ }
556
+
557
+ updateAspect(camera: PerspectiveCamera | OrthographicCamera, width?: number, height?: number) {
558
+ if (!camera) return;
559
+ if (width === undefined)
560
+ width = this.domWidth;
561
+ if (height === undefined)
562
+ height = this.domHeight;
563
+ const aspectRatio = width / height;
564
+ if ((camera as PerspectiveCamera).isPerspectiveCamera) {
565
+ const cam = camera as PerspectiveCamera;
566
+ const pa = cam.aspect;
567
+ cam.aspect = aspectRatio;
568
+ if (pa !== cam.aspect)
569
+ camera.updateProjectionMatrix();
570
+ }
571
+ else if ((camera as OrthographicCamera).isOrthographicCamera) {
572
+ const cam = camera as OrthographicCamera;
573
+ // Maintain the camera's current vertical size (top - bottom)
574
+ const verticalSize = cam.top - cam.bottom;
575
+ // Calculate new horizontal size based on aspect ratio
576
+ const horizontalSize = verticalSize * aspectRatio;
577
+ // Update camera bounds while maintaining center position
578
+ const halfWidth = horizontalSize / 2;
579
+ const halfHeight = verticalSize / 2;
580
+ if (cam.left != -halfWidth || cam.top != halfHeight) {
581
+ cam.left = -halfWidth;
582
+ cam.right = halfWidth;
583
+ cam.top = halfHeight;
584
+ cam.bottom = -halfHeight;
585
+ camera.updateProjectionMatrix();
586
+ }
587
+ }
588
+ }
589
+
590
+ /** This will recreate the whole needle engine context and dispose the whole scene content
591
+ * All content will be reloaded (loading times might be faster due to browser caches)
592
+ * All scripts will be recreated */
593
+ recreate() {
594
+ this.clear();
595
+ this.create(this._originalCreationArgs);
596
+ }
597
+
598
+ private _originalCreationArgs?: ContextCreateArgs;
599
+
600
+ /** @deprecated use create. This method will be removed in a future version */
601
+ async onCreate(opts?: ContextCreateArgs) {
602
+ return this.create(opts);
603
+ }
604
+ async create(opts?: ContextCreateArgs) {
605
+ try {
606
+ this._isCreating = true;
607
+ if (opts !== this._originalCreationArgs)
608
+ this._originalCreationArgs = deepClone(opts);
609
+ window.addEventListener("unhandledrejection", this.onUnhandledRejection)
610
+ const res = await this.internalOnCreate(opts);
611
+ this._isCreated = res;
612
+ return res;
613
+ }
614
+ finally {
615
+ window.removeEventListener("unhandledrejection", this.onUnhandledRejection)
616
+ this._isCreating = false;
617
+ }
618
+ }
619
+
620
+ private onUnhandledRejection = (event: PromiseRejectionEvent) => {
621
+ this.onError(event.reason);
622
+ };
623
+
624
+ /** Dispatches an error */
625
+ private onError(error: string) {
626
+ this.domElement.dispatchEvent(new CustomEvent("error", { detail: error }));
627
+ }
628
+
629
+ /** Will destroy all scenes and objects in the scene
630
+ */
631
+ clear() {
632
+ ContextRegistry.dispatchCallback(ContextEvent.ContextClearing, this);
633
+ invokeLifecycleFunctions(this, ContextEvent.ContextClearing);
634
+ // NOTE: this does dispose the environment/background image too
635
+ // which is probably not desired if it is set via the skybox-image attribute
636
+ destroy(this.scene, true, true);
637
+ this.scene = new Scene();
638
+ this.addressables?.dispose();
639
+ this.lightmaps?.clear();
640
+ this.physics?.engine?.clearCaches();
641
+ this.lodsManager.disable();
642
+
643
+ if (!this.isManagedExternally) {
644
+ if (this.renderer) {
645
+ this.renderer.renderLists.dispose();
646
+ this.renderer.state.reset();
647
+ this.renderer.resetState();
648
+ }
649
+ }
650
+ // We do not want to clear the renderer here because when switching src we want to keep the last rendered frame in case the loading screen is not visible
651
+ // if a user wants to see the background they can still call setClearAlpha(0) and clear manually
652
+ ContextRegistry.dispatchCallback(ContextEvent.ContextCleared, this);
653
+ }
654
+
655
+ dispose() {
656
+ this.internalOnDestroy();
657
+ }
658
+
659
+ /**@deprecated use dispose() */
660
+ onDestroy() { this.internalOnDestroy(); }
661
+ private internalOnDestroy() {
662
+ Context.Current = this;
663
+ ContextRegistry.dispatchCallback(ContextEvent.ContextDestroying, this);
664
+ invokeLifecycleFunctions(this, ContextEvent.ContextDestroying);
665
+ this.clear();
666
+ this.renderer?.setAnimationLoop(null);
667
+ if (this.renderer) {
668
+ this.renderer.setClearAlpha(0);
669
+ this.renderer.clear();
670
+ if (!this.isManagedExternally) {
671
+ if (debug) console.log("Disposing renderer");
672
+ this.renderer.dispose();
673
+ }
674
+ }
675
+ this.scene = null!;
676
+ this.renderer = null!;
677
+ this.input.dispose();
678
+ this.menu.onDestroy();
679
+ this.animations.onDestroy();
680
+ for (const cb of this._disposeCallbacks) {
681
+ try {
682
+ cb();
683
+ }
684
+ catch (e) {
685
+ console.error("Error in on dispose callback:", e, cb);
686
+ }
687
+ }
688
+ if (this.domElement?.parentElement) {
689
+ this.domElement.parentElement.removeChild(this.domElement);
690
+ }
691
+ this._isCreated = false;
692
+ ContextRegistry.dispatchCallback(ContextEvent.ContextDestroyed, this);
693
+ invokeLifecycleFunctions(this, ContextEvent.ContextDestroyed);
694
+ ContextRegistry.unregister(this);
695
+ if (Context.Current === this) {
696
+ //@ts-ignore
697
+ Context.Current = null;
698
+ }
699
+ }
700
+
701
+ registerCoroutineUpdate(script: IComponent, coroutine: Generator, evt: FrameEvent): Generator {
702
+ if (typeof coroutine?.next !== "function") {
703
+ console.error("Registered invalid coroutine function from " + script.name + "\nCoroutine functions must be generators: \"*myCoroutine() {...}\"\nStart a coroutine from a component by calling \"this.startCoroutine(myCoroutine())\"")
704
+ return coroutine;
705
+ }
706
+ if (!this.coroutines[evt]) this.coroutines[evt] = [];
707
+ this.coroutines[evt].push({ comp: script, main: coroutine });
708
+ return coroutine;
709
+ }
710
+
711
+ unregisterCoroutineUpdate(coroutine: Generator, evt: FrameEvent): void {
712
+ if (!this.coroutines[evt]) return;
713
+ const idx = this.coroutines[evt].findIndex(c => c.main === coroutine);
714
+ if (idx >= 0) this.coroutines[evt].splice(idx, 1);
715
+ }
716
+
717
+ stopAllCoroutinesFrom(script: IComponent) {
718
+ for (const evt in this.coroutines) {
719
+ const rout: CoroutineData[] = this.coroutines[evt];
720
+ for (let i = rout.length - 1; i >= 0; i--) {
721
+ const r = rout[i];
722
+ if (r.comp === script) {
723
+ rout.splice(i, 1);
724
+ }
725
+ }
726
+ }
727
+ }
728
+
729
+ private _cameraStack: ICamera[] = [];
730
+
731
+ setCurrentCamera(cam: ICamera) {
732
+ if (!cam) return;
733
+ if (!cam.threeCamera) cam.buildCamera(); // < to build camera
734
+ if (!cam.threeCamera) {
735
+ console.warn("Camera component is missing camera", cam)
736
+ return;
737
+ }
738
+ const index = this._cameraStack.indexOf(cam);
739
+ if (index >= 0) this._cameraStack.splice(index, 1);
740
+ this._cameraStack.push(cam);
741
+ this.mainCameraComponent = cam;
742
+ const camera = cam.threeCamera as PerspectiveCamera;
743
+ if (camera.isPerspectiveCamera)
744
+ this.updateAspect(camera);
745
+ (this.mainCameraComponent as ICamera)?.applyClearFlagsIfIsActiveCamera();
746
+ }
747
+
748
+ removeCamera(cam?: ICamera | null) {
749
+ if (!cam) return;
750
+ const index = this._cameraStack.indexOf(cam);
751
+ if (index >= 0) this._cameraStack.splice(index, 1);
752
+
753
+ if (this.mainCameraComponent === cam) {
754
+ this.mainCameraComponent = undefined;
755
+
756
+ if (this._cameraStack.length > 0) {
757
+ const last = this._cameraStack[this._cameraStack.length - 1];
758
+ this.setCurrentCamera(last);
759
+ }
760
+ }
761
+ }
762
+
763
+
764
+
765
+ private _onBeforeRenderListeners = new Map<string, OnRenderCallback[]>();
766
+ private _onAfterRenderListeners = new Map<string, OnRenderCallback[]>();
767
+
768
+ /** use this to subscribe to onBeforeRender events on threejs objects */
769
+ addBeforeRenderListener(target: Object3D, callback: OnRenderCallback) {
770
+ if (!this._onBeforeRenderListeners.has(target.uuid)) {
771
+ this._onBeforeRenderListeners.set(target.uuid, []);
772
+ target.onBeforeRender = this._createRenderCallbackWrapper(target, this._onBeforeRenderListeners);
773
+ }
774
+ this._onBeforeRenderListeners.get(target.uuid)!.push(callback);
775
+ }
776
+ removeBeforeRenderListener(target: Object3D, callback: OnRenderCallback) {
777
+ if (this._onBeforeRenderListeners.has(target.uuid)) {
778
+ const arr = this._onBeforeRenderListeners.get(target.uuid)!;
779
+ const idx = arr.indexOf(callback);
780
+ if (idx >= 0) arr.splice(idx, 1);
781
+ }
782
+ }
783
+
784
+ /** use this to subscribe to onAfterRender events on threejs objects */
785
+ addAfterRenderListener(target: Object3D, callback: OnRenderCallback) {
786
+ if (!this._onAfterRenderListeners.has(target.uuid)) {
787
+ this._onAfterRenderListeners.set(target.uuid, []);
788
+ target.onAfterRender = this._createRenderCallbackWrapper(target, this._onAfterRenderListeners);
789
+ }
790
+ this._onAfterRenderListeners.get(target.uuid)?.push(callback);
791
+ }
792
+ removeAfterRenderListener(target: Object3D, callback: OnRenderCallback) {
793
+ if (this._onAfterRenderListeners.has(target.uuid)) {
794
+ const arr = this._onAfterRenderListeners.get(target.uuid)!;
795
+ const idx = arr.indexOf(callback);
796
+ if (idx >= 0) arr.splice(idx, 1);
797
+ }
798
+ }
799
+
800
+
801
+ private _createRenderCallbackWrapper(target: Object3D, array: Map<string, OnRenderCallback[]>): OnRenderCallback {
802
+ return (renderer, scene, camera, geometry, material, group) => {
803
+ const arr = array.get(target.uuid);
804
+ if (!arr) return;
805
+ for (let i = 0; i < arr.length; i++) {
806
+ const fn = arr[i];
807
+ fn(renderer, scene, camera, geometry, material, group);
808
+ }
809
+ }
810
+ }
811
+
812
+
813
+
814
+ private _requireDepthTexture: boolean = false;
815
+ private _requireColorTexture: boolean = false;
816
+ private _renderTarget?: WebGLRenderTarget;
817
+ private _isRendering: boolean = false;
818
+
819
+ get isRendering() { return this._isRendering; }
820
+
821
+ setRequireDepth(val: boolean) {
822
+ this._requireDepthTexture = val;
823
+ }
824
+
825
+ setRequireColor(val: boolean) {
826
+ this._requireColorTexture = val;
827
+ }
828
+
829
+ get depthTexture(): DepthTexture | null {
830
+ return this._renderTarget?.depthTexture || null;
831
+ }
832
+
833
+ get opaqueColorTexture(): Texture | null {
834
+ return this._renderTarget?.texture || null;
835
+ }
836
+
837
+ /** returns true if the dom element is visible on screen */
838
+ get isVisibleToUser() {
839
+ if (this.isInXR) return true;
840
+ if (!this._isVisible) return false;
841
+ const style = getComputedStyle(this.domElement);
842
+ return style.visibility !== "hidden" && style.display !== "none" && style.opacity !== "0";
843
+ }
844
+
845
+
846
+ private _createId: number = 0;
847
+ private async internalOnCreate(opts?: ContextCreateArgs): Promise<boolean> {
848
+ const createId = ++this._createId;
849
+
850
+ if (debug) console.log("Creating context", this.name, opts);
851
+
852
+ // wait for async imported dependencies to be loaded
853
+ // see https://linear.app/needle/issue/NE-4445
854
+ const dependenciesReady = globalThis["needle:dependencies:ready"];
855
+ if (dependenciesReady instanceof Promise) {
856
+ if (debug) console.log("Waiting for dependencies to be ready");
857
+ await dependenciesReady
858
+ .catch(err => {
859
+ if (debug || isDevEnvironment()) {
860
+ showBalloonError("Needle Engine dependencies failed to load. Please check the console for more details");
861
+ const printedError = false;
862
+ if (err instanceof ReferenceError) {
863
+ let offendingComponentName = "YourComponentName";
864
+ const offendingComponentStartIndex = err.message.indexOf("'");
865
+ if (offendingComponentStartIndex > 0) {
866
+ const offendingComponentEndIndex = err.message.indexOf("'", offendingComponentStartIndex + 1);
867
+ if (offendingComponentEndIndex > 0) {
868
+ const name = err.message.substring(offendingComponentStartIndex + 1, offendingComponentEndIndex);
869
+ if (name.length > 3) offendingComponentName = name;
870
+ }
871
+ }
872
+ console.error(`Needle Engine dependencies failed to load:\n\n# Make sure you don't have circular imports in your scripts!\n\nPossible solutions: \n→ Replace @serializable(${offendingComponentName}) in your script with @serializable(Behaviour)\n→ If you only need type information try importing the type only, e.g: import { type ${offendingComponentName} }\n\n---`, err)
873
+ return;
874
+ }
875
+ if (!printedError) {
876
+ console.error("Needle Engine dependencies failed to load", err);
877
+ }
878
+ }
879
+ })
880
+ .then(() => {
881
+ if (debug) console.log("Needle Engine dependencies are ready");
882
+ });
883
+ }
884
+
885
+ this.clear();
886
+ // stop the animation loop if its running during creation
887
+ // since we do not want to start enabling scripts etc before they are deserialized
888
+ if (this.isManagedExternally === false) {
889
+ this.createNewRenderer();
890
+ this.renderer?.setAnimationLoop(null);
891
+ }
892
+
893
+ await delay(1);
894
+
895
+ Context.Current = this;
896
+ await ContextRegistry.dispatchCallback(ContextEvent.ContextCreationStart, this);
897
+
898
+ // load and create scene
899
+ let prepare_succeeded = true;
900
+ let loadedFiles!: Array<LoadedModel | null>;
901
+ try {
902
+ Context.Current = this;
903
+ if (opts) {
904
+ loadedFiles = await this.internalLoadInitialContent(createId, opts);
905
+ }
906
+ else loadedFiles = [];
907
+ }
908
+ catch (err) {
909
+ console.error(err);
910
+ prepare_succeeded = false;
911
+ }
912
+ if (!prepare_succeeded) {
913
+ this.onError("Failed to load initial content");
914
+ return false;
915
+ }
916
+ if (createId !== this._createId || opts?.abortSignal?.aborted) {
917
+ return false;
918
+ }
919
+
920
+ this.internalOnUpdateVisible();
921
+
922
+ if (!this.renderer) {
923
+ if (debug) console.warn("Context has no renderer (perhaps it was disconnected?", this.domElement.isConnected);
924
+ return false;
925
+ }
926
+
927
+ if (!this.isManagedExternally && !this.domElement.shadowRoot) {
928
+ this.domElement.prepend(this.renderer.domElement);
929
+ }
930
+
931
+ Context.Current = this;
932
+
933
+ // TODO: we could configure if we need physics
934
+ // await this.physics.engine?.initialize();
935
+
936
+ // Setup
937
+ Context.Current = this;
938
+ for (let i = 0; i < this.new_scripts.length; i++) {
939
+ const script = this.new_scripts[i];
940
+ if (script.gameObject !== undefined && script.gameObject !== null) {
941
+ if (script.gameObject.userData === undefined) script.gameObject.userData = {};
942
+ if (script.gameObject.userData.components === undefined) script.gameObject.userData.components = [];
943
+ const arr = script.gameObject.userData.components;
944
+ if (!arr.includes(script)) arr.push(script);
945
+ }
946
+ // if (script.gameObject && !this.raycastTargets.includes(script.gameObject)) {
947
+ // this.raycastTargets.push(script.gameObject);
948
+ // }
949
+ }
950
+
951
+ // const context = new SerializationContext(this.scene);
952
+ // for (let i = 0; i < this.new_scripts.length; i++) {
953
+ // const script = this.new_scripts[i];
954
+ // const ser = script as unknown as ISerializable;
955
+ // if (ser.$serializedTypes === undefined) continue;
956
+ // context.context = this;
957
+ // context.object = script.gameObject;
958
+ // deserializeObject(ser, script, context);
959
+ // }
960
+
961
+ // resolve post setup callbacks (things that rely on threejs objects having references to components)
962
+ if (this.post_setup_callbacks) {
963
+ for (let i = 0; i < this.post_setup_callbacks.length; i++) {
964
+ Context.Current = this;
965
+ await this.post_setup_callbacks[i](this);
966
+ }
967
+ }
968
+
969
+ if (!this._mainCamera) {
970
+ Context.Current = this;
971
+ let camera: ICamera | null = null;
972
+ foreachComponent(this.scene, comp => {
973
+ const cam = comp as ICamera;
974
+ if (cam?.isCamera) {
975
+ looputils.updateActiveInHierarchyWithoutEventCall(cam.gameObject);
976
+ if (!cam.activeAndEnabled) return undefined;
977
+ if (cam.tag === "MainCamera") {
978
+ camera = cam;
979
+ return true;
980
+ }
981
+ else camera = cam;
982
+ }
983
+ return undefined;
984
+ });
985
+ if (camera) {
986
+ this.setCurrentCamera(camera);
987
+ }
988
+ else {
989
+ const res = ContextRegistry.dispatchCallback(ContextEvent.MissingCamera, this, { files: loadedFiles });
990
+ if (!res && !this.mainCamera && !this.isManagedExternally)
991
+ console.warn("Missing camera in main scene", this);
992
+ }
993
+ }
994
+
995
+ this.input.bindEvents();
996
+
997
+ Context.Current = this;
998
+ looputils.processNewScripts(this);
999
+
1000
+ // We have to step once so that colliders that have been created in onEnable can be raycasted in start
1001
+ if (this.physics.engine) {
1002
+ this.physics.engine?.step(0);
1003
+ this.physics.engine?.postStep();
1004
+ }
1005
+
1006
+ // const mainCam = this.mainCameraComponent as Camera;
1007
+ // if (mainCam) {
1008
+ // mainCam.applyClearFlagsIfIsActiveCamera();
1009
+ // }
1010
+
1011
+ if (!this.isManagedExternally && this.composer && this.mainCamera) {
1012
+ // TODO: import postprocessing async
1013
+ // const renderPass = new RenderPass(this.scene, this.mainCamera);
1014
+ // this.renderer.setSize(this.domWidth, this.domHeight);
1015
+ // this.composer.addPass(renderPass);
1016
+ // this.composer.setSize(this.domWidth, this.domHeight);
1017
+ }
1018
+
1019
+ this._sizeChanged = true;
1020
+
1021
+ if (this._stats) {
1022
+ this._stats.showPanel(0);
1023
+ this._stats.dom.style.position = "absolute"; // (default is fixed)
1024
+ this.domElement.shadowRoot?.appendChild(this._stats.dom);
1025
+ }
1026
+
1027
+ if (debug)
1028
+ logHierarchy(this.scene, true);
1029
+
1030
+ // If no target framerate was set we use the default
1031
+ if (this.targetFrameRate === undefined) {
1032
+ if (debug) console.warn("No target framerate set, using default", Context.DefaultTargetFrameRate);
1033
+ // the _defaultTargetFramerate is intentionally an object so it can be changed at any time if not explictly set by the user
1034
+ this.targetFrameRate = Context._defaultTargetFramerate;
1035
+ }
1036
+ else if (debug) console.log("Target framerate set to", this.targetFrameRate);
1037
+
1038
+ this._dispatchReadyAfterFrame = true;
1039
+ const res = ContextRegistry.dispatchCallback(ContextEvent.ContextCreated, this, { files: loadedFiles });
1040
+ if (res) {
1041
+ if ("internalSetLoadingMessage" in this.domElement && typeof this.domElement.internalSetLoadingMessage === "function")
1042
+ this.domElement?.internalSetLoadingMessage("finish loading");
1043
+ await res;
1044
+ }
1045
+ if (opts?.abortSignal?.aborted) {
1046
+ return false;
1047
+ }
1048
+ invokeLifecycleFunctions(this, ContextEvent.ContextCreated);
1049
+ if (debug) console.log("Context Created...", this.renderer, this.renderer.domElement)
1050
+
1051
+ this._isCreating = false;
1052
+ if (!this.isManagedExternally && !opts?.abortSignal?.aborted)
1053
+ this.restartRenderLoop();
1054
+ return true;
1055
+ }
1056
+
1057
+ private async internalLoadInitialContent(createId: number, args: ContextCreateArgs): Promise<Array<LoadedModel>> {
1058
+ const results = new Array<LoadedModel>();
1059
+ // early out if we dont have any files to load
1060
+ if (args.files.length === 0) return results;
1061
+
1062
+
1063
+ const files = [...args.files];
1064
+ const progressArg: LoadingProgressArgs = {
1065
+ name: "",
1066
+ progress: null!,
1067
+ index: 0,
1068
+ count: files.length
1069
+ }
1070
+
1071
+ const loader = getLoader();
1072
+ // this hash should be constant since it is used to initialize the UIDProvider per initially loaded scene
1073
+ const loadingHash = 0;
1074
+ for (let i = 0; i < files.length; i++) {
1075
+ if (args.abortSignal?.aborted) {
1076
+ if (debug) console.log("Aborting loading because of abort signal");
1077
+ break;
1078
+ }
1079
+ // abort loading if the create id has changed
1080
+ if (createId !== this._createId) {
1081
+ if (debug) console.log("Aborting loading because create id changed", createId, this._createId);
1082
+ break;
1083
+ }
1084
+ const file = files[i];
1085
+ args?.onLoadingStart?.call(this, i, file);
1086
+ if (debug) console.log("Context Load " + file);
1087
+ const res = await loader.loadSync(this, file, file, loadingHash, prog => {
1088
+ if (args.abortSignal?.aborted) return;
1089
+ progressArg.name = file;
1090
+ progressArg.progress = prog;
1091
+ progressArg.index = i;
1092
+ progressArg.count = files.length;
1093
+ args.onLoadingProgress?.call(this, progressArg);
1094
+ });
1095
+ args?.onLoadingFinished?.call(this, i, file, res ?? null);
1096
+ if (res) {
1097
+ results.push({
1098
+ src: file,
1099
+ file: res
1100
+ });
1101
+ }
1102
+ else {
1103
+ // a file could not be loaded
1104
+ console.warn("Could not load file: " + file);
1105
+ }
1106
+ }
1107
+
1108
+ // if the id was changed while still loading
1109
+ // then we want to cleanup/destroy previously loaded files
1110
+ if (createId !== this._createId || args.abortSignal?.aborted) {
1111
+ if (debug) console.log("Aborting loading because create id changed or abort signal was set", createId, this._createId);
1112
+ for (const res of results) {
1113
+ if (res && res.file) {
1114
+ for (const scene of res.file.scenes)
1115
+ destroy(scene, true, true);
1116
+ }
1117
+ }
1118
+ }
1119
+ // otherwise we want to add the loaded files to the current scene
1120
+ else {
1121
+ let anyModelFound = false;
1122
+ for (const res of results) {
1123
+ if (res && res.file) {
1124
+ // TODO: should we load all scenes in a glTF here?
1125
+ if (res.file.scene) {
1126
+ anyModelFound = true;
1127
+ this.scene.add(res.file.scene);
1128
+ }
1129
+ else {
1130
+ console.warn("No scene found in loaded file");
1131
+ }
1132
+ }
1133
+ }
1134
+ // If the loaded files do not contain ANY model
1135
+ // We then attempt to create a mesh from each material in the loaded files to visualize it
1136
+ // It's ok to do this at this point because we know the context has been cleared because the whole `src` attribute has been set
1137
+ if (!anyModelFound) {
1138
+ for (const res of results) {
1139
+ if (res && res.file && "parser" in res.file) {
1140
+ let y = 0;
1141
+ if (!Array.isArray(res.file.parser.json.materials)) continue;
1142
+ for (let i = 0; i < res.file.parser.json.materials.length; i++) {
1143
+ const mat = await res.file.parser.getDependency("material", i);
1144
+ const parent = new Object3D();
1145
+ parent.position.x = i * 1.1;
1146
+ parent.position.y = y;
1147
+ this.scene.add(parent);
1148
+ ObjectUtils.createPrimitive("ShaderBall", {
1149
+ parent,
1150
+ material: mat
1151
+ });
1152
+ }
1153
+ y += 1;
1154
+ }
1155
+ }
1156
+ }
1157
+ }
1158
+
1159
+ return results;
1160
+ }
1161
+
1162
+
1163
+ /** Sets the animation loop.
1164
+ * Can not be done while creating the context or when disposed
1165
+ **/
1166
+ public restartRenderLoop(): boolean {
1167
+ if (!this.renderer) {
1168
+ console.error("Can not start render loop without renderer");
1169
+ return false;
1170
+ }
1171
+ if (this._isCreating) {
1172
+ console.warn("Can not start render loop while creating context");
1173
+ return false;
1174
+ }
1175
+ this.renderer.setAnimationLoop((timestamp, frame: XRFrame | null) => {
1176
+ if (this.isManagedExternally) return;
1177
+ this.update(timestamp, frame)
1178
+ });
1179
+ return true;
1180
+ }
1181
+
1182
+ private _renderlooperrors = 0;
1183
+
1184
+ /** Performs a full update step including script callbacks, rendering (unless isManagedExternally is set to false) and post render callbacks */
1185
+ public update(timestamp: DOMHighResTimeStamp, frame?: XRFrame | null) {
1186
+ if (frame === undefined) frame = null;
1187
+ if (isDevEnvironment() || debug || looputils.hasNewScripts()) {
1188
+ try {
1189
+ performance.mark('update.start');
1190
+ this.internalStep(timestamp, frame);
1191
+ this._renderlooperrors = 0;
1192
+ performance.mark('update.end');
1193
+ performance.measure('NE Frame', 'update.start', 'update.end');
1194
+ }
1195
+ catch (err) {
1196
+ this._renderlooperrors += 1;
1197
+ if ((isDevEnvironment() || debug) && (err instanceof Error || err instanceof TypeError))
1198
+ showBalloonMessage(`Caught unhandled exception during render-loop - see console for details.`, LogType.Error);
1199
+ console.error("Frame #" + this.time.frame + "\n", err);
1200
+ if (this._renderlooperrors >= 3) {
1201
+ console.warn("Stopping render loop due to error")
1202
+ this.renderer.setAnimationLoop(null);
1203
+ }
1204
+ this.domElement.dispatchEvent(new CustomEvent("error", { detail: err }));
1205
+ }
1206
+ }
1207
+ else {
1208
+ this.internalStep(timestamp, frame);
1209
+ }
1210
+ }
1211
+
1212
+ /** Call to **manually** perform physics steps.
1213
+ * By default the context uses the `physicsSteps` property to perform steps during the update loop
1214
+ * If you just want to increase the accuracy of physics you can instead set the `physicsSteps` property to a higher value
1215
+ * */
1216
+ public updatePhysics(steps: number) {
1217
+ this.internalUpdatePhysics(steps);
1218
+ }
1219
+
1220
+ private _lastTimestamp = 0;
1221
+ private _accumulatedTime = 0;
1222
+ private _dispatchReadyAfterFrame = false;
1223
+
1224
+ // TODO: we need to skip after render callbacks if the render loop is managed externally. When changing this we also need to to update the r3f sample
1225
+ private internalStep(timestamp: DOMHighResTimeStamp, frame: XRFrame | null) {
1226
+ if (this.internalOnBeforeRender(timestamp, frame) === false) return;
1227
+ this.internalOnRender();
1228
+ this.internalOnAfterRender();
1229
+ }
1230
+
1231
+ private internalOnBeforeRender(timestamp: DOMHighResTimeStamp, frame: XRFrame | null) {
1232
+
1233
+ // If we don't auto reset we get wrong stats in WebXR. AutoReset was turned off to support custom blits and count them too
1234
+ this.renderer.info.autoReset = true;
1235
+
1236
+
1237
+ const sessionStarted = frame !== null && this._xrFrame === null;
1238
+ this._xrFrame = frame;
1239
+ if (sessionStarted) {
1240
+ this.domElement.dispatchEvent(new CustomEvent("xr-session-started", { detail: { context: this, session: this.xrSession, frame: frame } }));
1241
+ }
1242
+
1243
+ this._currentFrameEvent = FrameEvent.Undefined;
1244
+
1245
+ if (this.isManagedExternally === false && this.isInXR === false && this.targetFrameRate !== undefined) {
1246
+ if (this._lastTimestamp === 0) this._lastTimestamp = timestamp;
1247
+ this._accumulatedTime += (timestamp - this._lastTimestamp) / 1000;
1248
+ this._lastTimestamp = timestamp;
1249
+ let targetFrameRate = this.targetFrameRate;
1250
+ if (typeof targetFrameRate === "object") targetFrameRate = targetFrameRate.value!;
1251
+ // if(debug) console.log(this._accumulatedTime, (1 / (targetFrameRate)))
1252
+ if (this._accumulatedTime < (1 / (targetFrameRate + 1))) {
1253
+ return false;
1254
+ }
1255
+ this._accumulatedTime = 0;
1256
+ }
1257
+
1258
+ this._stats?.begin();
1259
+
1260
+ Context.Current = this;
1261
+ if (this.onHandlePaused()) return false;
1262
+
1263
+ Context.Current = this;
1264
+ this.time.update();
1265
+ if (debugframerate)
1266
+ console.log("FPS", (this.time.smoothedFps).toFixed(0));
1267
+
1268
+
1269
+ looputils.processNewScripts(this);
1270
+ looputils.updateIsActive(this.scene);
1271
+ looputils.processStart(this);
1272
+ invokeLifecycleFunctions(this, FrameEvent.Start);
1273
+
1274
+ while (this._cameraStack.length > 0 && (!this.mainCameraComponent || this.mainCameraComponent.destroyed)) {
1275
+ this._cameraStack.splice(this._cameraStack.length - 1, 1);
1276
+ const last = this._cameraStack[this._cameraStack.length - 1];
1277
+ this.setCurrentCamera(last);
1278
+ }
1279
+
1280
+ if (this.pre_update_oneshot_callbacks) {
1281
+ for (const i in this.pre_update_oneshot_callbacks) {
1282
+ this.pre_update_oneshot_callbacks[i]();
1283
+ }
1284
+ this.pre_update_oneshot_callbacks.length = 0;
1285
+ }
1286
+
1287
+ if (this.pre_update_callbacks) {
1288
+ for (const i in this.pre_update_callbacks) {
1289
+ this.pre_update_callbacks[i]();
1290
+ }
1291
+ }
1292
+
1293
+ this._currentFrameEvent = FrameEvent.EarlyUpdate;
1294
+
1295
+ for (let i = 0; i < this.scripts_earlyUpdate.length; i++) {
1296
+ const script = this.scripts_earlyUpdate[i];
1297
+ if (!script.activeAndEnabled) continue;
1298
+ if (script.earlyUpdate !== undefined) {
1299
+ Context.Current = this;
1300
+ script.earlyUpdate();
1301
+ }
1302
+ }
1303
+ this.executeCoroutines(FrameEvent.EarlyUpdate);
1304
+ invokeLifecycleFunctions(this, FrameEvent.EarlyUpdate);
1305
+ if (this.onHandlePaused()) return false;
1306
+
1307
+ this._currentFrameEvent = FrameEvent.Update;
1308
+
1309
+ for (let i = 0; i < this.scripts_update.length; i++) {
1310
+ const script = this.scripts_update[i];
1311
+ if (!script.activeAndEnabled) continue;
1312
+ if (script.update !== undefined) {
1313
+ Context.Current = this;
1314
+ script.update();
1315
+ }
1316
+ }
1317
+ this.executeCoroutines(FrameEvent.Update);
1318
+ invokeLifecycleFunctions(this, FrameEvent.Update);
1319
+ if (this.onHandlePaused()) return false;
1320
+
1321
+ this._currentFrameEvent = FrameEvent.LateUpdate;
1322
+
1323
+ for (let i = 0; i < this.scripts_lateUpdate.length; i++) {
1324
+ const script = this.scripts_lateUpdate[i];
1325
+ if (!script.activeAndEnabled) continue;
1326
+ if (script.lateUpdate !== undefined) {
1327
+ Context.Current = this;
1328
+ script.lateUpdate();
1329
+ }
1330
+ }
1331
+
1332
+ // this.mainLight = null;
1333
+ this.executeCoroutines(FrameEvent.LateUpdate);
1334
+ invokeLifecycleFunctions(this, FrameEvent.LateUpdate);
1335
+ if (this.onHandlePaused()) return false;
1336
+
1337
+ if (this.physicsSteps === undefined) {
1338
+ this.physicsSteps = 1;
1339
+ }
1340
+ if (this.physics.engine && this.physicsSteps > 0) {
1341
+ this.internalUpdatePhysics(this.physicsSteps);
1342
+ }
1343
+
1344
+ if (this.onHandlePaused()) return false;
1345
+
1346
+ if (this.isVisibleToUser || this.runInBackground) {
1347
+
1348
+ this._currentFrameEvent = FrameEvent.OnBeforeRender;
1349
+
1350
+ // should we move these callbacks in the regular three onBeforeRender events?
1351
+ for (let i = 0; i < this.scripts_onBeforeRender.length; i++) {
1352
+ const script = this.scripts_onBeforeRender[i];
1353
+ if (!script.activeAndEnabled) continue;
1354
+ // if(script.isActiveAndEnabled === false) continue;
1355
+ if (script.onBeforeRender !== undefined) {
1356
+ Context.Current = this;
1357
+ script.onBeforeRender(frame);
1358
+ }
1359
+ }
1360
+
1361
+ this.executeCoroutines(FrameEvent.OnBeforeRender);
1362
+ invokeLifecycleFunctions(this, FrameEvent.OnBeforeRender);
1363
+
1364
+ if (this._sizeChanged)
1365
+ this.updateSize();
1366
+
1367
+ if (this.pre_render_callbacks) {
1368
+ for (const i in this.pre_render_callbacks) {
1369
+ this.pre_render_callbacks[i](frame);
1370
+ }
1371
+ }
1372
+
1373
+ }
1374
+
1375
+ return true;
1376
+ }
1377
+
1378
+ private internalUpdatePhysics(steps: number) {
1379
+ if (!this.physics.engine) return false;
1380
+ const physicsSteps = steps;
1381
+ const dt = this.time.deltaTime / physicsSteps;
1382
+ for (let i = 0; i < physicsSteps; i++) {
1383
+ this._currentFrameEvent = FrameEvent.PrePhysicsStep;
1384
+ this.executeCoroutines(FrameEvent.PrePhysicsStep);
1385
+ this.physics.engine.step(dt);
1386
+ this._currentFrameEvent = FrameEvent.PostPhysicsStep;
1387
+ this.executeCoroutines(FrameEvent.PostPhysicsStep);
1388
+ }
1389
+ this.physics.engine.postStep();
1390
+ return true;
1391
+ }
1392
+
1393
+ private internalOnRender() {
1394
+ if (!this.isManagedExternally) {
1395
+ // when loading assets we compile them async after GLTFLoader is done
1396
+ // but as a fallback we still register them (if e.g. there's no camera for compile async)
1397
+ looputils.runPrewarm(this);
1398
+ this._currentFrameEvent = FrameEvent.Undefined;
1399
+ nodeFrame.update();
1400
+ this.renderNow();
1401
+ this._currentFrameEvent = FrameEvent.OnAfterRender;
1402
+ }
1403
+ }
1404
+
1405
+ private internalOnAfterRender() {
1406
+ if (this.isVisibleToUser || this.runInBackground) {
1407
+ for (let i = 0; i < this.scripts_onAfterRender.length; i++) {
1408
+ const script = this.scripts_onAfterRender[i];
1409
+ if (!script.activeAndEnabled) continue;
1410
+ if (script.onAfterRender !== undefined) {
1411
+ Context.Current = this;
1412
+ script.onAfterRender();
1413
+ }
1414
+ }
1415
+
1416
+ this.executeCoroutines(FrameEvent.OnAfterRender);
1417
+ invokeLifecycleFunctions(this, FrameEvent.OnAfterRender);
1418
+
1419
+ if (this.post_render_callbacks) {
1420
+ for (const i in this.post_render_callbacks) {
1421
+ this.post_render_callbacks[i]();
1422
+ }
1423
+ }
1424
+ }
1425
+
1426
+ this._currentFrameEvent = -1;
1427
+
1428
+ this.connection.sendBufferedMessagesNow();
1429
+
1430
+ if (this._stats) {
1431
+ this._stats.end();
1432
+ if (this.time.frameCount % 150 === 0)
1433
+ console.log(this.renderer.info.render.calls + " DrawCalls", "\nRender:", { ...this.renderer.info.render }, "\nMemory:", { ...this.renderer.info.memory }, "\nTarget Framerate: " + this.targetFrameRate);
1434
+ }
1435
+
1436
+ if (this._dispatchReadyAfterFrame) {
1437
+ this._dispatchReadyAfterFrame = false;
1438
+ this.domElement.dispatchEvent(new CustomEvent("ready"));
1439
+ ContextRegistry.dispatchCallback(ContextEvent.ContextFirstFrameRendered, this);
1440
+ }
1441
+ }
1442
+
1443
+ renderNow(camera?: Camera) {
1444
+ if (!camera) {
1445
+ camera = this.mainCamera as Camera;
1446
+ if (!camera) return false;
1447
+ }
1448
+ this.handleRendererContextLost();
1449
+
1450
+ this._isRendering = true;
1451
+ this.renderRequiredTextures();
1452
+
1453
+ if (this.renderer.toneMapping !== NoToneMapping)
1454
+ patchTonemapping(this);
1455
+
1456
+ if (this.composer && !this.isInXR) {
1457
+ // if a camera is passed in we need to check if we need to update the composer's camera
1458
+ if (camera && "setMainCamera" in this.composer) {
1459
+ const currentPassesCamera = this.composer.passes[0]?.mainCamera;
1460
+ if (currentPassesCamera != camera)
1461
+ this.composer.setMainCamera(camera);
1462
+ }
1463
+ this.composer.render(this.time.deltaTime);
1464
+ }
1465
+ else if (camera) {
1466
+ // Workaround for issue on Vision Pro –
1467
+ // depth buffer is not cleared between eye draws, despite the spec...
1468
+ if (this.isInXR && DeviceUtilities.isMacOS())
1469
+ this.renderer.clearDepth();
1470
+ this.renderer.render(this.scene, camera);
1471
+ }
1472
+ this._isRendering = false;
1473
+ return true;
1474
+ }
1475
+
1476
+ private _contextRestoreTries = 0;
1477
+ private handleRendererContextLost() {
1478
+ // Try to restore the context every x frames
1479
+ if (this.time.frame % 10 && this.renderer.getContext().isContextLost()) {
1480
+ if (this._contextRestoreTries++ < 100) {
1481
+ console.warn("Attempting to recover WebGL context...");
1482
+ this.renderer.forceContextRestore();
1483
+ }
1484
+ }
1485
+ }
1486
+
1487
+ /** returns true if we should return out of the frame loop */
1488
+ private _wasPaused: boolean = false;
1489
+ private onHandlePaused(): boolean {
1490
+ const paused = this.evaluatePaused();
1491
+ if (this._wasPaused !== paused) {
1492
+ if (debugActive) console.log("Paused?", paused, "context:" + this.alias);
1493
+ for (let i = 0; i < this.scripts_pausedChanged.length; i++) {
1494
+ const script = this.scripts_pausedChanged[i];
1495
+ if (!script.activeAndEnabled) continue;
1496
+ if (script.onPausedChanged !== undefined) {
1497
+ Context.Current = this;
1498
+ script.onPausedChanged(paused, this._wasPaused);
1499
+ }
1500
+ }
1501
+ }
1502
+ this._wasPaused = paused;
1503
+ return paused;
1504
+ }
1505
+
1506
+ private evaluatePaused(): boolean {
1507
+ if (this.isInXR) return false;
1508
+ if (this.isPaused) return true;
1509
+ // if the element is not visible use the runInBackground flag to determine if we should continue
1510
+ if (this.runInBackground) {
1511
+ return false;
1512
+ }
1513
+ const paused = !this.isVisibleToUser;
1514
+ return paused;
1515
+ }
1516
+
1517
+ private renderRequiredTextures() {
1518
+ if (!this.mainCamera) return;
1519
+ if (!this._requireDepthTexture && !this._requireColorTexture) return;
1520
+ if (!this._renderTarget) {
1521
+ this._renderTarget = new WebGLRenderTarget(this.domWidth, this.domHeight);
1522
+ if (this._requireDepthTexture) {
1523
+ const dt = new DepthTexture(this.domWidth, this.domHeight);;
1524
+ this._renderTarget.depthTexture = dt;
1525
+ }
1526
+ if (this._requireColorTexture) {
1527
+ this._renderTarget.texture = new Texture();
1528
+ this._renderTarget.texture.generateMipmaps = false;
1529
+ this._renderTarget.texture.minFilter = NearestFilter;
1530
+ this._renderTarget.texture.magFilter = NearestFilter;
1531
+ this._renderTarget.texture.format = RGBAFormat;
1532
+ }
1533
+ }
1534
+ const rt = this._renderTarget;
1535
+ if (rt.texture) {
1536
+ rt.texture.colorSpace = this.renderer.outputColorSpace;
1537
+ }
1538
+ const prevTarget = this.renderer.getRenderTarget();
1539
+ this.renderer.setRenderTarget(rt);
1540
+ this.renderer.render(this.scene, this.mainCamera);
1541
+ this.renderer.setRenderTarget(prevTarget);
1542
+ }
1543
+
1544
+ private executeCoroutines(evt: FrameEvent) {
1545
+ if (this.coroutines[evt]) {
1546
+ const evts = this.coroutines[evt];
1547
+ for (let i = 0; i < evts.length; i++) {
1548
+ try {
1549
+ const evt = evts[i];
1550
+ // TODO we might want to keep coroutines playing even if the component is disabled or inactive
1551
+ const remove = !evt.comp || evt.comp.destroyed || !evt.main || evt.comp["enabled"] === false;
1552
+ if (remove) {
1553
+ if (debugCoroutine) console.log("Removing coroutine", evt.comp, evt.comp["enabled"])
1554
+ evts.splice(i, 1);
1555
+ --i;
1556
+ continue;
1557
+ }
1558
+ const iter = evt.chained;
1559
+ if (iter && iter.length > 0) {
1560
+ const last: Generator = iter[iter.length - 1];
1561
+ const res = last.next();
1562
+ if (res.done) {
1563
+ iter.pop();
1564
+ }
1565
+ if (isGenerator(res)) {
1566
+ if (!evt.chained) evt.chained = [];
1567
+ evt.chained.push(res.value);
1568
+ }
1569
+ if (!res.done) continue;
1570
+ }
1571
+
1572
+ const res = evt.main.next();
1573
+ if (res.done === true) {
1574
+ evts.splice(i, 1);
1575
+ --i;
1576
+ continue;
1577
+ }
1578
+ const val = res.value;
1579
+ if (isGenerator(val)) {
1580
+ // invoke once if its a generator
1581
+ // this means e.g. WaitForFrame(1) works and will capture
1582
+ // the frame it was created
1583
+ const gen = val as Generator;
1584
+ const res = gen.next();
1585
+ if (res.done) continue;
1586
+ if (!evt.chained) evt.chained = [];
1587
+ evt.chained.push(val as Generator);
1588
+ }
1589
+ else if (val instanceof Promise) {
1590
+ // If its a promise we want to wait for it to resolve
1591
+ const prom = val as Promise<any>;
1592
+ if (!evt.chained) evt.chained = [];
1593
+ const nested = WaitForPromise(prom);
1594
+ evt.chained?.push(nested);
1595
+ continue;
1596
+ }
1597
+ }
1598
+ catch (e) {
1599
+ console.error(e);
1600
+ }
1601
+ }
1602
+ }
1603
+
1604
+ function isGenerator(val: any): boolean {
1605
+ if (val) {
1606
+ if (val.next && val.return) {
1607
+ return true;
1608
+ }
1609
+ }
1610
+ return false;
1611
+ }
1612
+ }
1613
+
1614
+ }
1615
+
1616
+
1617
+ // const scene = new Scene();
1618
+ // const useComposer = utils.getParam("postfx");
1619
+ // const renderer = new WebGLRenderer({ antialias: true });
1620
+ // const composer = useComposer ? new EffectComposer(renderer) : undefined;
1621
+
1622
+ // renderer.setClearColor(new Color('lightgrey'), 0)
1623
+ // renderer.antialias = true;
1624
+ // renderer.alpha = false;
1625
+ // renderer.shadowMap.enabled = true;
1626
+ // renderer.shadowMap.type = PCFSoftShadowMap;
1627
+ // renderer.setSize(window.innerWidth, window.innerHeight);
1628
+ // renderer.outputEncoding = sRGBEncoding;
1629
+ // renderer.physicallyCorrectLights = true;
1630
+ // document.body.appendChild(renderer.domElement);
1631
+
1632
+ // // generation pushes loading requests in this array
1633
+ // const sceneData: {
1634
+ // mainCamera: Camera | undefined
1635
+ // } = {
1636
+ // preparing: [],
1637
+ // resolving: [],
1638
+ // scripts: [],
1639
+ // raycastTargets: [],
1640
+ // mainCamera: undefined,
1641
+ // mainCameraComponent: undefined,
1642
+ // };
1643
+
1644
+ // // contains a list of functions to be called after loading is done
1645
+ // const post_setup_callbacks = [];
1646
+
1647
+ // const pre_render_Callbacks = [];
1648
+ // const post_render_callbacks = [];
1649
+
1650
+ // const new_scripts = [];
1651
+ // const new_scripts_post_setup_callbacks = [];
1652
+ // const new_scripts_pre_setup_callbacks = [];
1653
+
1654
+ // export {
1655
+ // scene, renderer, composer,
1656
+ // new_scripts,
1657
+ // new_scripts_post_setup_callbacks, new_scripts_pre_setup_callbacks,
1658
+ // sceneData,
1659
+ // post_setup_callbacks,
1660
+ // pre_render_Callbacks,
1661
+ // post_render_callbacks
1662
+ // }