@needle-tools/engine 4.5.5-next.f053174 → 4.5.6

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