@needle-tools/engine 4.5.0-alpha.7 → 4.5.1

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