@needle-tools/engine 4.4.1 → 4.4.3-beta

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