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

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 (1051) hide show
  1. package/CHANGELOG.md +3614 -3608
  2. package/LICENSE.md +10 -10
  3. package/README.md +64 -64
  4. package/components.needle.json +1 -1
  5. package/dist/needle-engine.bundle.js +503 -460
  6. package/dist/needle-engine.bundle.light.js +502 -459
  7. package/dist/needle-engine.bundle.light.min.js +69 -69
  8. package/dist/needle-engine.bundle.light.umd.cjs +76 -76
  9. package/dist/needle-engine.bundle.min.js +69 -69
  10. package/dist/needle-engine.bundle.umd.cjs +67 -67
  11. package/dist/needle-engine.d.ts +138 -130
  12. package/dist/needle-engine.light.d.ts +138 -130
  13. package/dist/postprocessing.js +1513 -1659
  14. package/dist/postprocessing.light.js +1513 -1659
  15. package/dist/postprocessing.light.min.js +66 -80
  16. package/dist/postprocessing.light.umd.cjs +69 -83
  17. package/dist/postprocessing.min.js +66 -80
  18. package/dist/postprocessing.umd.cjs +69 -83
  19. package/dist/vendor.js +1 -1
  20. package/dist/vendor.light.js +1 -1
  21. package/lib/asap/needle-asap.d.ts +1 -1
  22. package/lib/asap/needle-asap.js +95 -95
  23. package/lib/asap/sessiongranted.d.ts +3 -3
  24. package/lib/asap/sessiongranted.js +65 -65
  25. package/lib/asap/utils.d.ts +1 -1
  26. package/lib/asap/utils.js +3 -3
  27. package/lib/engine/analytics/index.d.ts +6 -6
  28. package/lib/engine/analytics/index.js +12 -12
  29. package/lib/engine/analytics/lcp.d.ts +3 -3
  30. package/lib/engine/analytics/lcp.js +34 -34
  31. package/lib/engine/api.d.ts +81 -81
  32. package/lib/engine/api.js +80 -80
  33. package/lib/engine/assets/index.d.ts +11 -11
  34. package/lib/engine/assets/index.js +47 -47
  35. package/lib/engine/assets/static.d.ts +1 -1
  36. package/lib/engine/assets/static.js +4 -4
  37. package/lib/engine/codegen/register_types.d.ts +1 -1
  38. package/lib/engine/codegen/register_types.js +300 -300
  39. package/lib/engine/debug/debug.d.ts +15 -15
  40. package/lib/engine/debug/debug.js +44 -44
  41. package/lib/engine/debug/debug_console.d.ts +2 -2
  42. package/lib/engine/debug/debug_console.js +307 -307
  43. package/lib/engine/debug/debug_overlay.d.ts +22 -22
  44. package/lib/engine/debug/debug_overlay.js +316 -316
  45. package/lib/engine/debug/debug_spatial_console.d.ts +2 -2
  46. package/lib/engine/debug/debug_spatial_console.js +390 -390
  47. package/lib/engine/debug/index.d.ts +2 -2
  48. package/lib/engine/debug/index.js +2 -2
  49. package/lib/engine/engine.d.ts +4 -0
  50. package/lib/engine/engine.js +12 -0
  51. package/lib/engine/engine.js.map +1 -0
  52. package/lib/engine/engine_addressables.d.ts +166 -166
  53. package/lib/engine/engine_addressables.js +608 -608
  54. package/lib/engine/engine_animation.d.ts +43 -43
  55. package/lib/engine/engine_animation.js +133 -133
  56. package/lib/engine/engine_application.d.ts +40 -40
  57. package/lib/engine/engine_application.js +104 -104
  58. package/lib/engine/engine_assetdatabase.d.ts +25 -25
  59. package/lib/engine/engine_assetdatabase.js +344 -344
  60. package/lib/engine/engine_audio.d.ts +4 -4
  61. package/lib/engine/engine_audio.js +23 -23
  62. package/lib/engine/engine_camera.d.ts +13 -13
  63. package/lib/engine/engine_camera.js +30 -30
  64. package/lib/engine/engine_components.d.ts +110 -110
  65. package/lib/engine/engine_components.js +380 -380
  66. package/lib/engine/engine_components_internal.d.ts +9 -9
  67. package/lib/engine/engine_components_internal.js +36 -36
  68. package/lib/engine/engine_constants.d.ts +10 -10
  69. package/lib/engine/engine_constants.js +41 -41
  70. package/lib/engine/engine_context.d.ts +345 -345
  71. package/lib/engine/engine_context.js +1515 -1515
  72. package/lib/engine/engine_context_registry.d.ts +71 -71
  73. package/lib/engine/engine_context_registry.js +117 -117
  74. package/lib/engine/engine_coroutine.d.ts +35 -35
  75. package/lib/engine/engine_coroutine.js +52 -52
  76. package/lib/engine/engine_create_objects.d.ts +118 -118
  77. package/lib/engine/engine_create_objects.js +308 -308
  78. package/lib/engine/engine_default_parameters.d.ts +2 -2
  79. package/lib/engine/engine_default_parameters.js +3 -3
  80. package/lib/engine/engine_editor-sync.d.ts +21 -21
  81. package/lib/engine/engine_editor-sync.js +4 -4
  82. package/lib/engine/engine_element.d.ts +113 -113
  83. package/lib/engine/engine_element.js +829 -830
  84. package/lib/engine/engine_element.js.map +1 -1
  85. package/lib/engine/engine_element_attributes.d.ts +72 -72
  86. package/lib/engine/engine_element_attributes.js +1 -1
  87. package/lib/engine/engine_element_extras.d.ts +6 -6
  88. package/lib/engine/engine_element_extras.js +13 -13
  89. package/lib/engine/engine_element_loading.d.ts +44 -44
  90. package/lib/engine/engine_element_loading.js +349 -349
  91. package/lib/engine/engine_element_overlay.d.ts +21 -21
  92. package/lib/engine/engine_element_overlay.js +166 -166
  93. package/lib/engine/engine_fileloader.d.ts +2 -2
  94. package/lib/engine/engine_fileloader.js +8 -8
  95. package/lib/engine/engine_gameobject.d.ts +68 -68
  96. package/lib/engine/engine_gameobject.js +591 -591
  97. package/lib/engine/engine_generic_utils.d.ts +1 -1
  98. package/lib/engine/engine_generic_utils.js +13 -13
  99. package/lib/engine/engine_gizmos.d.ts +149 -149
  100. package/lib/engine/engine_gizmos.js +530 -530
  101. package/lib/engine/engine_gltf.d.ts +12 -12
  102. package/lib/engine/engine_gltf.js +15 -15
  103. package/lib/engine/engine_gltf_builtin_components.d.ts +7 -7
  104. package/lib/engine/engine_gltf_builtin_components.js +341 -341
  105. package/lib/engine/engine_hot_reload.d.ts +7 -7
  106. package/lib/engine/engine_hot_reload.js +184 -184
  107. package/lib/engine/engine_input.d.ts +352 -352
  108. package/lib/engine/engine_input.js +1265 -1265
  109. package/lib/engine/engine_input_utils.d.ts +2 -2
  110. package/lib/engine/engine_input_utils.js +22 -22
  111. package/lib/engine/engine_instancing.d.ts +19 -19
  112. package/lib/engine/engine_instancing.js +39 -39
  113. package/lib/engine/engine_license.d.ts +9 -9
  114. package/lib/engine/engine_license.js +320 -320
  115. package/lib/engine/engine_lifecycle_api.d.ts +76 -76
  116. package/lib/engine/engine_lifecycle_api.js +99 -99
  117. package/lib/engine/engine_lifecycle_functions_internal.d.ts +32 -32
  118. package/lib/engine/engine_lifecycle_functions_internal.js +146 -146
  119. package/lib/engine/engine_lightdata.d.ts +23 -23
  120. package/lib/engine/engine_lightdata.js +91 -91
  121. package/lib/engine/engine_loaders.d.ts +13 -13
  122. package/lib/engine/engine_loaders.js +62 -62
  123. package/lib/engine/engine_lods.d.ts +31 -31
  124. package/lib/engine/engine_lods.js +146 -146
  125. package/lib/engine/engine_mainloop_utils.d.ts +32 -32
  126. package/lib/engine/engine_mainloop_utils.js +466 -466
  127. package/lib/engine/engine_math.d.ts +114 -114
  128. package/lib/engine/engine_math.js +247 -247
  129. package/lib/engine/engine_modules.d.ts +36 -36
  130. package/lib/engine/engine_modules.js +85 -85
  131. package/lib/engine/engine_networking.d.ts +252 -252
  132. package/lib/engine/engine_networking.js +743 -743
  133. package/lib/engine/engine_networking_auto.d.ts +24 -24
  134. package/lib/engine/engine_networking_auto.js +310 -310
  135. package/lib/engine/engine_networking_blob.d.ts +48 -48
  136. package/lib/engine/engine_networking_blob.js +212 -212
  137. package/lib/engine/engine_networking_files.d.ts +35 -35
  138. package/lib/engine/engine_networking_files.js +172 -172
  139. package/lib/engine/engine_networking_files_default_components.d.ts +6 -6
  140. package/lib/engine/engine_networking_files_default_components.js +42 -42
  141. package/lib/engine/engine_networking_instantiate.d.ts +100 -100
  142. package/lib/engine/engine_networking_instantiate.js +345 -345
  143. package/lib/engine/engine_networking_peer.d.ts +15 -15
  144. package/lib/engine/engine_networking_peer.js +132 -132
  145. package/lib/engine/engine_networking_streams.d.ts +123 -123
  146. package/lib/engine/engine_networking_streams.js +645 -645
  147. package/lib/engine/engine_networking_types.d.ts +22 -22
  148. package/lib/engine/engine_networking_types.js +7 -7
  149. package/lib/engine/engine_networking_utils.d.ts +2 -2
  150. package/lib/engine/engine_networking_utils.js +20 -20
  151. package/lib/engine/engine_networking_websocket.d.ts +1 -1
  152. package/lib/engine/engine_networking_websocket.js +2 -2
  153. package/lib/engine/engine_patcher.d.ts +10 -10
  154. package/lib/engine/engine_patcher.js +142 -142
  155. package/lib/engine/engine_physics.d.ts +152 -152
  156. package/lib/engine/engine_physics.js +645 -645
  157. package/lib/engine/engine_physics.types.d.ts +40 -40
  158. package/lib/engine/engine_physics.types.js +33 -33
  159. package/lib/engine/engine_physics_rapier.d.ts +147 -147
  160. package/lib/engine/engine_physics_rapier.js +1432 -1432
  161. package/lib/engine/engine_playerview.d.ts +26 -26
  162. package/lib/engine/engine_playerview.js +64 -64
  163. package/lib/engine/engine_scenelighting.d.ts +71 -71
  164. package/lib/engine/engine_scenelighting.js +226 -226
  165. package/lib/engine/engine_scenetools.d.ts +50 -50
  166. package/lib/engine/engine_scenetools.js +321 -321
  167. package/lib/engine/engine_serialization.d.ts +3 -3
  168. package/lib/engine/engine_serialization.js +3 -3
  169. package/lib/engine/engine_serialization_builtin_serializer.d.ts +72 -72
  170. package/lib/engine/engine_serialization_builtin_serializer.js +403 -403
  171. package/lib/engine/engine_serialization_core.d.ts +85 -85
  172. package/lib/engine/engine_serialization_core.js +602 -602
  173. package/lib/engine/engine_serialization_decorator.d.ts +23 -23
  174. package/lib/engine/engine_serialization_decorator.js +66 -66
  175. package/lib/engine/engine_setup.d.ts +1 -1
  176. package/lib/engine/engine_setup.js +2 -2
  177. package/lib/engine/engine_shaders.d.ts +53 -53
  178. package/lib/engine/engine_shaders.js +252 -252
  179. package/lib/engine/engine_shims.d.ts +4 -4
  180. package/lib/engine/engine_shims.js +24 -24
  181. package/lib/engine/engine_test_utils.d.ts +39 -39
  182. package/lib/engine/engine_test_utils.js +83 -83
  183. package/lib/engine/engine_texture.d.ts +28 -28
  184. package/lib/engine/engine_texture.js +64 -64
  185. package/lib/engine/engine_three_utils.d.ts +201 -201
  186. package/lib/engine/engine_three_utils.js +731 -731
  187. package/lib/engine/engine_time.d.ts +51 -51
  188. package/lib/engine/engine_time.js +82 -82
  189. package/lib/engine/engine_time_utils.d.ts +88 -88
  190. package/lib/engine/engine_time_utils.js +215 -215
  191. package/lib/engine/engine_tonemapping.d.ts +2 -2
  192. package/lib/engine/engine_tonemapping.js +194 -194
  193. package/lib/engine/engine_types.d.ts +572 -572
  194. package/lib/engine/engine_types.js +88 -88
  195. package/lib/engine/engine_typestore.d.ts +28 -28
  196. package/lib/engine/engine_typestore.js +55 -55
  197. package/lib/engine/engine_util_decorator.d.ts +13 -13
  198. package/lib/engine/engine_util_decorator.js +116 -116
  199. package/lib/engine/engine_utils.d.ts +266 -266
  200. package/lib/engine/engine_utils.js +878 -878
  201. package/lib/engine/engine_utils_format.d.ts +21 -21
  202. package/lib/engine/engine_utils_format.js +193 -193
  203. package/lib/engine/engine_utils_screenshot.d.ts +159 -159
  204. package/lib/engine/engine_utils_screenshot.js +513 -513
  205. package/lib/engine/engine_utils_screenshot.xr.d.ts +5 -5
  206. package/lib/engine/engine_utils_screenshot.xr.js +90 -90
  207. package/lib/engine/engine_web_api.d.ts +12 -0
  208. package/lib/engine/engine_web_api.js +113 -0
  209. package/lib/engine/engine_web_api.js.map +1 -0
  210. package/lib/engine/engine_xr.d.ts +1 -1
  211. package/lib/engine/engine_xr.js +1 -1
  212. package/lib/engine/export/gltf/Writers.d.ts +19 -19
  213. package/lib/engine/export/gltf/Writers.js +24 -24
  214. package/lib/engine/export/gltf/index.d.ts +11 -11
  215. package/lib/engine/export/gltf/index.js +123 -123
  216. package/lib/engine/export/index.d.ts +2 -2
  217. package/lib/engine/export/index.js +2 -2
  218. package/lib/engine/export/state.d.ts +7 -7
  219. package/lib/engine/export/state.js +17 -17
  220. package/lib/engine/export/utils.d.ts +2 -2
  221. package/lib/engine/export/utils.js +7 -7
  222. package/lib/engine/extensions/EXT_texture_exr.d.ts +8 -8
  223. package/lib/engine/extensions/EXT_texture_exr.js +32 -32
  224. package/lib/engine/extensions/NEEDLE_animator_controller_model.d.ts +122 -122
  225. package/lib/engine/extensions/NEEDLE_animator_controller_model.js +95 -95
  226. package/lib/engine/extensions/NEEDLE_components.d.ts +35 -35
  227. package/lib/engine/extensions/NEEDLE_components.js +220 -220
  228. package/lib/engine/extensions/NEEDLE_gameobject_data.d.ts +10 -10
  229. package/lib/engine/extensions/NEEDLE_gameobject_data.js +57 -57
  230. package/lib/engine/extensions/NEEDLE_lighting_settings.d.ts +37 -37
  231. package/lib/engine/extensions/NEEDLE_lighting_settings.js +157 -157
  232. package/lib/engine/extensions/NEEDLE_lightmaps.d.ts +18 -18
  233. package/lib/engine/extensions/NEEDLE_lightmaps.js +99 -99
  234. package/lib/engine/extensions/NEEDLE_persistent_assets.d.ts +11 -11
  235. package/lib/engine/extensions/NEEDLE_persistent_assets.js +63 -63
  236. package/lib/engine/extensions/NEEDLE_progressive.d.ts +1 -1
  237. package/lib/engine/extensions/NEEDLE_progressive.js +1 -1
  238. package/lib/engine/extensions/NEEDLE_render_objects.d.ts +13 -13
  239. package/lib/engine/extensions/NEEDLE_render_objects.js +159 -159
  240. package/lib/engine/extensions/NEEDLE_techniques_webgl.d.ts +38 -38
  241. package/lib/engine/extensions/NEEDLE_techniques_webgl.js +564 -564
  242. package/lib/engine/extensions/extension_resolver.d.ts +4 -4
  243. package/lib/engine/extensions/extension_resolver.js +1 -1
  244. package/lib/engine/extensions/extension_utils.d.ts +12 -12
  245. package/lib/engine/extensions/extension_utils.js +152 -152
  246. package/lib/engine/extensions/extensions.d.ts +31 -31
  247. package/lib/engine/extensions/extensions.js +103 -103
  248. package/lib/engine/extensions/index.d.ts +6 -6
  249. package/lib/engine/extensions/index.js +6 -6
  250. package/lib/engine/extensions/usage_tracker.d.ts +13 -13
  251. package/lib/engine/extensions/usage_tracker.js +65 -65
  252. package/lib/engine/js-extensions/Camera.d.ts +1 -1
  253. package/lib/engine/js-extensions/Camera.js +39 -39
  254. package/lib/engine/js-extensions/ExtensionUtils.d.ts +9 -9
  255. package/lib/engine/js-extensions/ExtensionUtils.js +67 -67
  256. package/lib/engine/js-extensions/Layers.d.ts +6 -6
  257. package/lib/engine/js-extensions/Layers.js +22 -22
  258. package/lib/engine/js-extensions/Object3D.d.ts +120 -120
  259. package/lib/engine/js-extensions/Object3D.js +136 -136
  260. package/lib/engine/js-extensions/RGBAColor.d.ts +23 -22
  261. package/lib/engine/js-extensions/RGBAColor.js +110 -62
  262. package/lib/engine/js-extensions/RGBAColor.js.map +1 -1
  263. package/lib/engine/js-extensions/Vector.d.ts +3 -3
  264. package/lib/engine/js-extensions/Vector.js +13 -13
  265. package/lib/engine/js-extensions/index.d.ts +5 -5
  266. package/lib/engine/js-extensions/index.js +5 -5
  267. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.d.ts +4 -4
  268. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +75 -75
  269. package/lib/engine/shaders/shaderData.d.ts +55 -55
  270. package/lib/engine/shaders/shaderData.js +58 -58
  271. package/lib/engine/tests/test_utils.d.ts +2 -2
  272. package/lib/engine/tests/test_utils.js +53 -53
  273. package/lib/engine/webcomponents/WebXRButtons.d.ts +56 -56
  274. package/lib/engine/webcomponents/WebXRButtons.js +230 -230
  275. package/lib/engine/webcomponents/api.d.ts +5 -5
  276. package/lib/engine/webcomponents/api.js +4 -4
  277. package/lib/engine/webcomponents/buttons.d.ts +39 -39
  278. package/lib/engine/webcomponents/buttons.js +237 -237
  279. package/lib/engine/webcomponents/fonts.d.ts +9 -9
  280. package/lib/engine/webcomponents/fonts.js +32 -32
  281. package/lib/engine/webcomponents/icons.d.ts +9 -9
  282. package/lib/engine/webcomponents/icons.js +52 -52
  283. package/lib/engine/webcomponents/index.d.ts +1 -1
  284. package/lib/engine/webcomponents/index.js +1 -1
  285. package/lib/engine/webcomponents/logo-element.d.ts +10 -10
  286. package/lib/engine/webcomponents/logo-element.js +67 -67
  287. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.d.ts +37 -37
  288. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.js +513 -513
  289. package/lib/engine/webcomponents/needle menu/needle-menu.d.ts +151 -151
  290. package/lib/engine/webcomponents/needle menu/needle-menu.js +1018 -1018
  291. package/lib/engine/webcomponents/needle-button.d.ts +34 -34
  292. package/lib/engine/webcomponents/needle-button.js +161 -161
  293. package/lib/engine/xr/NeedleXRController.d.ts +313 -313
  294. package/lib/engine/xr/NeedleXRController.js +1008 -1008
  295. package/lib/engine/xr/NeedleXRSession.d.ts +339 -339
  296. package/lib/engine/xr/NeedleXRSession.js +1427 -1427
  297. package/lib/engine/xr/NeedleXRSync.d.ts +22 -22
  298. package/lib/engine/xr/NeedleXRSync.js +188 -188
  299. package/lib/engine/xr/SceneTransition.d.ts +18 -18
  300. package/lib/engine/xr/SceneTransition.js +69 -69
  301. package/lib/engine/xr/TempXRContext.d.ts +34 -34
  302. package/lib/engine/xr/TempXRContext.js +187 -187
  303. package/lib/engine/xr/XRRig.d.ts +7 -7
  304. package/lib/engine/xr/XRRig.js +1 -1
  305. package/lib/engine/xr/api.d.ts +6 -6
  306. package/lib/engine/xr/api.js +6 -6
  307. package/lib/engine/xr/events.d.ts +66 -66
  308. package/lib/engine/xr/events.js +93 -93
  309. package/lib/engine/xr/internal.d.ts +12 -12
  310. package/lib/engine/xr/internal.js +25 -25
  311. package/lib/engine/xr/usdz.d.ts +12 -12
  312. package/lib/engine/xr/usdz.js +29 -29
  313. package/lib/engine/xr/utils.d.ts +11 -11
  314. package/lib/engine/xr/utils.js +34 -34
  315. package/lib/engine-components/AlignmentConstraint.d.ts +10 -10
  316. package/lib/engine-components/AlignmentConstraint.js +39 -39
  317. package/lib/engine-components/Animation.d.ts +156 -156
  318. package/lib/engine-components/Animation.js +508 -508
  319. package/lib/engine-components/AnimationCurve.d.ts +40 -40
  320. package/lib/engine-components/AnimationCurve.js +159 -159
  321. package/lib/engine-components/AnimationUtils.d.ts +8 -8
  322. package/lib/engine-components/AnimationUtils.js +27 -27
  323. package/lib/engine-components/AnimationUtilsAutoplay.d.ts +1 -1
  324. package/lib/engine-components/AnimationUtilsAutoplay.js +39 -39
  325. package/lib/engine-components/Animator.d.ts +217 -217
  326. package/lib/engine-components/Animator.js +354 -354
  327. package/lib/engine-components/AnimatorController.d.ts +227 -227
  328. package/lib/engine-components/AnimatorController.js +1152 -1152
  329. package/lib/engine-components/AudioListener.d.ts +33 -33
  330. package/lib/engine-components/AudioListener.js +86 -86
  331. package/lib/engine-components/AudioSource.d.ts +217 -217
  332. package/lib/engine-components/AudioSource.js +627 -627
  333. package/lib/engine-components/AvatarLoader.d.ts +80 -80
  334. package/lib/engine-components/AvatarLoader.js +231 -231
  335. package/lib/engine-components/AxesHelper.d.ts +32 -32
  336. package/lib/engine-components/AxesHelper.js +67 -67
  337. package/lib/engine-components/BasicIKConstraint.d.ts +9 -9
  338. package/lib/engine-components/BasicIKConstraint.js +43 -43
  339. package/lib/engine-components/BoxCollider.d.ts +2 -2
  340. package/lib/engine-components/BoxCollider.js +2 -2
  341. package/lib/engine-components/BoxHelperComponent.d.ts +47 -47
  342. package/lib/engine-components/BoxHelperComponent.js +102 -102
  343. package/lib/engine-components/Camera.d.ts +231 -231
  344. package/lib/engine-components/Camera.js +700 -694
  345. package/lib/engine-components/Camera.js.map +1 -1
  346. package/lib/engine-components/CameraUtils.d.ts +1 -1
  347. package/lib/engine-components/CameraUtils.js +118 -127
  348. package/lib/engine-components/CameraUtils.js.map +1 -1
  349. package/lib/engine-components/CharacterController.d.ts +55 -55
  350. package/lib/engine-components/CharacterController.js +236 -236
  351. package/lib/engine-components/Collider.d.ts +188 -188
  352. package/lib/engine-components/Collider.js +369 -369
  353. package/lib/engine-components/Component.d.ts +792 -792
  354. package/lib/engine-components/Component.js +915 -915
  355. package/lib/engine-components/ContactShadows.d.ts +82 -82
  356. package/lib/engine-components/ContactShadows.js +430 -430
  357. package/lib/engine-components/DeleteBox.d.ts +19 -19
  358. package/lib/engine-components/DeleteBox.js +58 -58
  359. package/lib/engine-components/DeviceFlag.d.ts +16 -16
  360. package/lib/engine-components/DeviceFlag.js +47 -47
  361. package/lib/engine-components/DragControls.d.ts +170 -170
  362. package/lib/engine-components/DragControls.js +1421 -1421
  363. package/lib/engine-components/DropListener.d.ts +215 -215
  364. package/lib/engine-components/DropListener.js +630 -630
  365. package/lib/engine-components/Duplicatable.d.ts +35 -35
  366. package/lib/engine-components/Duplicatable.js +202 -202
  367. package/lib/engine-components/EventList.d.ts +54 -54
  368. package/lib/engine-components/EventList.js +232 -232
  369. package/lib/engine-components/EventTrigger.d.ts +33 -33
  370. package/lib/engine-components/EventTrigger.js +75 -75
  371. package/lib/engine-components/EventType.d.ts +22 -22
  372. package/lib/engine-components/EventType.js +23 -23
  373. package/lib/engine-components/FlyControls.d.ts +10 -0
  374. package/lib/engine-components/FlyControls.js +29 -0
  375. package/lib/engine-components/FlyControls.js.map +1 -0
  376. package/lib/engine-components/Fog.d.ts +22 -22
  377. package/lib/engine-components/Fog.js +61 -61
  378. package/lib/engine-components/Gizmos.d.ts +17 -17
  379. package/lib/engine-components/Gizmos.js +64 -64
  380. package/lib/engine-components/GridHelper.d.ts +20 -20
  381. package/lib/engine-components/GridHelper.js +54 -54
  382. package/lib/engine-components/GroundProjection.d.ts +67 -67
  383. package/lib/engine-components/GroundProjection.js +343 -343
  384. package/lib/engine-components/Interactable.d.ts +12 -12
  385. package/lib/engine-components/Interactable.js +12 -12
  386. package/lib/engine-components/Joints.d.ts +19 -19
  387. package/lib/engine-components/Joints.js +51 -51
  388. package/lib/engine-components/LODGroup.d.ts +35 -35
  389. package/lib/engine-components/LODGroup.js +152 -152
  390. package/lib/engine-components/Light.d.ts +180 -180
  391. package/lib/engine-components/Light.js +535 -535
  392. package/lib/engine-components/LookAtConstraint.d.ts +19 -19
  393. package/lib/engine-components/LookAtConstraint.js +35 -35
  394. package/lib/engine-components/NeedleMenu.d.ts +50 -50
  395. package/lib/engine-components/NeedleMenu.js +92 -92
  396. package/lib/engine-components/NestedGltf.d.ts +25 -25
  397. package/lib/engine-components/NestedGltf.js +88 -88
  398. package/lib/engine-components/Networking.d.ts +54 -54
  399. package/lib/engine-components/Networking.js +112 -112
  400. package/lib/engine-components/OffsetConstraint.d.ts +14 -14
  401. package/lib/engine-components/OffsetConstraint.js +65 -65
  402. package/lib/engine-components/OrbitControls.d.ts +266 -266
  403. package/lib/engine-components/OrbitControls.js +1009 -1009
  404. package/lib/engine-components/PlayerColor.d.ts +19 -19
  405. package/lib/engine-components/PlayerColor.js +94 -94
  406. package/lib/engine-components/ReflectionProbe.d.ts +26 -26
  407. package/lib/engine-components/ReflectionProbe.js +194 -194
  408. package/lib/engine-components/Renderer.d.ts +153 -153
  409. package/lib/engine-components/Renderer.js +830 -830
  410. package/lib/engine-components/RendererInstancing.d.ts +140 -140
  411. package/lib/engine-components/RendererInstancing.js +744 -744
  412. package/lib/engine-components/RendererLightmap.d.ts +24 -24
  413. package/lib/engine-components/RendererLightmap.js +182 -182
  414. package/lib/engine-components/RigidBody.d.ts +155 -155
  415. package/lib/engine-components/RigidBody.js +517 -517
  416. package/lib/engine-components/SceneSwitcher.d.ts +263 -263
  417. package/lib/engine-components/SceneSwitcher.js +951 -951
  418. package/lib/engine-components/ScreenCapture.d.ts +144 -144
  419. package/lib/engine-components/ScreenCapture.js +547 -547
  420. package/lib/engine-components/ShadowCatcher.d.ts +33 -33
  421. package/lib/engine-components/ShadowCatcher.js +166 -166
  422. package/lib/engine-components/Skybox.d.ts +82 -82
  423. package/lib/engine-components/Skybox.js +448 -448
  424. package/lib/engine-components/SmoothFollow.d.ts +34 -34
  425. package/lib/engine-components/SmoothFollow.js +82 -82
  426. package/lib/engine-components/SpatialTrigger.d.ts +102 -102
  427. package/lib/engine-components/SpatialTrigger.js +225 -225
  428. package/lib/engine-components/SpectatorCamera.d.ts +111 -111
  429. package/lib/engine-components/SpectatorCamera.js +715 -715
  430. package/lib/engine-components/SphereCollider.d.ts +2 -2
  431. package/lib/engine-components/SphereCollider.js +2 -2
  432. package/lib/engine-components/SpriteRenderer.d.ts +132 -132
  433. package/lib/engine-components/SpriteRenderer.js +472 -472
  434. package/lib/engine-components/SyncedCamera.d.ts +41 -41
  435. package/lib/engine-components/SyncedCamera.js +199 -199
  436. package/lib/engine-components/SyncedRoom.d.ts +106 -106
  437. package/lib/engine-components/SyncedRoom.js +371 -371
  438. package/lib/engine-components/SyncedTransform.d.ts +94 -88
  439. package/lib/engine-components/SyncedTransform.js +331 -326
  440. package/lib/engine-components/SyncedTransform.js.map +1 -1
  441. package/lib/engine-components/TestRunner.d.ts +16 -16
  442. package/lib/engine-components/TestRunner.js +102 -102
  443. package/lib/engine-components/TransformGizmo.d.ts +75 -75
  444. package/lib/engine-components/TransformGizmo.js +209 -209
  445. package/lib/engine-components/VideoPlayer.d.ts +184 -184
  446. package/lib/engine-components/VideoPlayer.js +978 -978
  447. package/lib/engine-components/Voip.d.ts +67 -67
  448. package/lib/engine-components/Voip.js +360 -360
  449. package/lib/engine-components/api.d.ts +51 -51
  450. package/lib/engine-components/api.js +50 -50
  451. package/lib/engine-components/avatar/AvatarBlink_Simple.d.ts +11 -11
  452. package/lib/engine-components/avatar/AvatarBlink_Simple.js +76 -76
  453. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.d.ts +14 -14
  454. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.js +68 -68
  455. package/lib/engine-components/avatar/Avatar_Brain_LookAt.d.ts +29 -29
  456. package/lib/engine-components/avatar/Avatar_Brain_LookAt.js +121 -121
  457. package/lib/engine-components/avatar/Avatar_MouthShapes.d.ts +15 -15
  458. package/lib/engine-components/avatar/Avatar_MouthShapes.js +79 -79
  459. package/lib/engine-components/avatar/Avatar_MustacheShake.d.ts +9 -9
  460. package/lib/engine-components/avatar/Avatar_MustacheShake.js +29 -29
  461. package/lib/engine-components/codegen/components.d.ts +216 -216
  462. package/lib/engine-components/codegen/components.js +218 -218
  463. package/lib/engine-components/debug/LogStats.d.ts +5 -5
  464. package/lib/engine-components/debug/LogStats.js +18 -18
  465. package/lib/engine-components/export/gltf/GltfExport.d.ts +30 -30
  466. package/lib/engine-components/export/gltf/GltfExport.js +246 -246
  467. package/lib/engine-components/export/gltf/index.d.ts +1 -1
  468. package/lib/engine-components/export/gltf/index.js +1 -1
  469. package/lib/engine-components/export/index.d.ts +1 -1
  470. package/lib/engine-components/export/index.js +1 -1
  471. package/lib/engine-components/export/usdz/Extension.d.ts +22 -22
  472. package/lib/engine-components/export/usdz/Extension.js +1 -1
  473. package/lib/engine-components/export/usdz/ThreeUSDZExporter.d.ts +160 -160
  474. package/lib/engine-components/export/usdz/ThreeUSDZExporter.js +1782 -1782
  475. package/lib/engine-components/export/usdz/USDZExporter.d.ts +130 -130
  476. package/lib/engine-components/export/usdz/USDZExporter.js +663 -663
  477. package/lib/engine-components/export/usdz/extensions/Animation.d.ts +106 -106
  478. package/lib/engine-components/export/usdz/extensions/Animation.js +1071 -1071
  479. package/lib/engine-components/export/usdz/extensions/DocumentExtension.d.ts +5 -5
  480. package/lib/engine-components/export/usdz/extensions/DocumentExtension.js +6 -6
  481. package/lib/engine-components/export/usdz/extensions/USDZText.d.ts +54 -54
  482. package/lib/engine-components/export/usdz/extensions/USDZText.js +203 -203
  483. package/lib/engine-components/export/usdz/extensions/USDZUI.d.ts +8 -8
  484. package/lib/engine-components/export/usdz/extensions/USDZUI.js +157 -157
  485. package/lib/engine-components/export/usdz/extensions/behavior/Actions.d.ts +30 -30
  486. package/lib/engine-components/export/usdz/extensions/behavior/Actions.js +88 -88
  487. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.d.ts +10 -10
  488. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.js +86 -86
  489. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.d.ts +28 -28
  490. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.js +290 -290
  491. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.d.ts +190 -190
  492. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.js +1060 -1060
  493. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.d.ts +135 -135
  494. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.js +548 -548
  495. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.d.ts +7 -7
  496. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.js +115 -115
  497. package/lib/engine-components/export/usdz/index.d.ts +3 -3
  498. package/lib/engine-components/export/usdz/index.js +2 -2
  499. package/lib/engine-components/export/usdz/utils/animationutils.d.ts +7 -7
  500. package/lib/engine-components/export/usdz/utils/animationutils.js +163 -163
  501. package/lib/engine-components/export/usdz/utils/quicklook.d.ts +2 -2
  502. package/lib/engine-components/export/usdz/utils/quicklook.js +43 -43
  503. package/lib/engine-components/particlesystem/ParticleSystem.d.ts +177 -177
  504. package/lib/engine-components/particlesystem/ParticleSystem.js +1176 -1176
  505. package/lib/engine-components/particlesystem/ParticleSystemModules.d.ts +526 -526
  506. package/lib/engine-components/particlesystem/ParticleSystemModules.js +1930 -1930
  507. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.d.ts +25 -25
  508. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.js +87 -87
  509. package/lib/engine-components/particlesystem/api.d.ts +2 -2
  510. package/lib/engine-components/particlesystem/api.js +2 -2
  511. package/lib/engine-components/postprocessing/Effects/Antialiasing.d.ts +17 -17
  512. package/lib/engine-components/postprocessing/Effects/Antialiasing.js +50 -50
  513. package/lib/engine-components/postprocessing/Effects/BloomEffect.d.ts +46 -46
  514. package/lib/engine-components/postprocessing/Effects/BloomEffect.js +113 -113
  515. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.d.ts +11 -11
  516. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.js +39 -39
  517. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.d.ts +15 -15
  518. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.js +92 -92
  519. package/lib/engine-components/postprocessing/Effects/DepthOfField.d.ts +25 -25
  520. package/lib/engine-components/postprocessing/Effects/DepthOfField.js +104 -104
  521. package/lib/engine-components/postprocessing/Effects/EffectWrapper.d.ts +12 -12
  522. package/lib/engine-components/postprocessing/Effects/EffectWrapper.js +18 -18
  523. package/lib/engine-components/postprocessing/Effects/Pixelation.d.ts +11 -11
  524. package/lib/engine-components/postprocessing/Effects/Pixelation.js +32 -32
  525. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.d.ts +18 -18
  526. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.js +91 -91
  527. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.d.ts +70 -70
  528. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.js +175 -175
  529. package/lib/engine-components/postprocessing/Effects/Sharpening.d.ts +17 -17
  530. package/lib/engine-components/postprocessing/Effects/Sharpening.js +123 -123
  531. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.d.ts +17 -17
  532. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.js +70 -70
  533. package/lib/engine-components/postprocessing/Effects/Tonemapping.d.ts +26 -26
  534. package/lib/engine-components/postprocessing/Effects/Tonemapping.js +138 -138
  535. package/lib/engine-components/postprocessing/Effects/Vignette.d.ts +15 -15
  536. package/lib/engine-components/postprocessing/Effects/Vignette.js +60 -60
  537. package/lib/engine-components/postprocessing/PostProcessingEffect.d.ts +72 -72
  538. package/lib/engine-components/postprocessing/PostProcessingEffect.js +149 -149
  539. package/lib/engine-components/postprocessing/PostProcessingHandler.d.ts +25 -25
  540. package/lib/engine-components/postprocessing/PostProcessingHandler.js +350 -350
  541. package/lib/engine-components/postprocessing/Volume.d.ts +89 -89
  542. package/lib/engine-components/postprocessing/Volume.js +367 -367
  543. package/lib/engine-components/postprocessing/VolumeParameter.d.ts +26 -26
  544. package/lib/engine-components/postprocessing/VolumeParameter.js +136 -136
  545. package/lib/engine-components/postprocessing/VolumeProfile.d.ts +15 -15
  546. package/lib/engine-components/postprocessing/VolumeProfile.js +60 -60
  547. package/lib/engine-components/postprocessing/index.d.ts +5 -5
  548. package/lib/engine-components/postprocessing/index.js +5 -5
  549. package/lib/engine-components/postprocessing/utils.d.ts +11 -11
  550. package/lib/engine-components/postprocessing/utils.js +37 -37
  551. package/lib/engine-components/timeline/PlayableDirector.d.ts +163 -163
  552. package/lib/engine-components/timeline/PlayableDirector.js +686 -686
  553. package/lib/engine-components/timeline/SignalAsset.d.ts +24 -24
  554. package/lib/engine-components/timeline/SignalAsset.js +130 -130
  555. package/lib/engine-components/timeline/TimelineModels.d.ts +89 -89
  556. package/lib/engine-components/timeline/TimelineModels.js +22 -22
  557. package/lib/engine-components/timeline/TimelineTracks.d.ts +110 -110
  558. package/lib/engine-components/timeline/TimelineTracks.js +879 -879
  559. package/lib/engine-components/timeline/index.d.ts +4 -4
  560. package/lib/engine-components/timeline/index.js +3 -3
  561. package/lib/engine-components/ui/BaseUIComponent.d.ts +49 -49
  562. package/lib/engine-components/ui/BaseUIComponent.js +170 -170
  563. package/lib/engine-components/ui/Button.d.ts +64 -64
  564. package/lib/engine-components/ui/Button.js +315 -315
  565. package/lib/engine-components/ui/Canvas.d.ts +74 -74
  566. package/lib/engine-components/ui/Canvas.js +407 -407
  567. package/lib/engine-components/ui/CanvasGroup.d.ts +19 -19
  568. package/lib/engine-components/ui/CanvasGroup.js +58 -58
  569. package/lib/engine-components/ui/EventSystem.d.ts +125 -125
  570. package/lib/engine-components/ui/EventSystem.js +764 -764
  571. package/lib/engine-components/ui/Graphic.d.ts +55 -55
  572. package/lib/engine-components/ui/Graphic.js +254 -254
  573. package/lib/engine-components/ui/Image.d.ts +35 -35
  574. package/lib/engine-components/ui/Image.js +116 -116
  575. package/lib/engine-components/ui/InputField.d.ts +42 -42
  576. package/lib/engine-components/ui/InputField.js +268 -268
  577. package/lib/engine-components/ui/Interfaces.d.ts +38 -38
  578. package/lib/engine-components/ui/Interfaces.js +12 -12
  579. package/lib/engine-components/ui/Layout.d.ts +84 -84
  580. package/lib/engine-components/ui/Layout.js +330 -330
  581. package/lib/engine-components/ui/Outline.d.ts +7 -7
  582. package/lib/engine-components/ui/Outline.js +20 -20
  583. package/lib/engine-components/ui/PointerEvents.d.ts +115 -115
  584. package/lib/engine-components/ui/PointerEvents.js +145 -145
  585. package/lib/engine-components/ui/RaycastUtils.d.ts +11 -11
  586. package/lib/engine-components/ui/RaycastUtils.js +67 -67
  587. package/lib/engine-components/ui/Raycaster.d.ts +30 -30
  588. package/lib/engine-components/ui/Raycaster.js +95 -95
  589. package/lib/engine-components/ui/RectTransform.d.ts +61 -61
  590. package/lib/engine-components/ui/RectTransform.js +353 -353
  591. package/lib/engine-components/ui/SpatialHtml.d.ts +8 -8
  592. package/lib/engine-components/ui/SpatialHtml.js +79 -79
  593. package/lib/engine-components/ui/Text.d.ts +78 -78
  594. package/lib/engine-components/ui/Text.js +539 -539
  595. package/lib/engine-components/ui/Utils.d.ts +24 -24
  596. package/lib/engine-components/ui/Utils.js +90 -90
  597. package/lib/engine-components/ui/index.d.ts +1 -1
  598. package/lib/engine-components/ui/index.js +1 -1
  599. package/lib/engine-components/utils/EnvironmentScene.d.ts +5 -5
  600. package/lib/engine-components/utils/EnvironmentScene.js +205 -205
  601. package/lib/engine-components/utils/LookAt.d.ts +31 -31
  602. package/lib/engine-components/utils/LookAt.js +82 -82
  603. package/lib/engine-components/utils/OpenURL.d.ts +42 -42
  604. package/lib/engine-components/utils/OpenURL.js +119 -119
  605. package/lib/engine-components/webxr/Avatar.d.ts +25 -25
  606. package/lib/engine-components/webxr/Avatar.js +255 -255
  607. package/lib/engine-components/webxr/TeleportTarget.d.ts +7 -7
  608. package/lib/engine-components/webxr/TeleportTarget.js +7 -7
  609. package/lib/engine-components/webxr/WebARCameraBackground.d.ts +30 -30
  610. package/lib/engine-components/webxr/WebARCameraBackground.js +155 -155
  611. package/lib/engine-components/webxr/WebARSessionRoot.d.ts +98 -98
  612. package/lib/engine-components/webxr/WebARSessionRoot.js +770 -770
  613. package/lib/engine-components/webxr/WebXR.d.ts +232 -232
  614. package/lib/engine-components/webxr/WebXR.js +561 -561
  615. package/lib/engine-components/webxr/WebXRAvatar.d.ts +27 -27
  616. package/lib/engine-components/webxr/WebXRAvatar.js +44 -44
  617. package/lib/engine-components/webxr/WebXRImageTracking.d.ts +86 -86
  618. package/lib/engine-components/webxr/WebXRImageTracking.js +470 -470
  619. package/lib/engine-components/webxr/WebXRPlaneTracking.d.ts +92 -92
  620. package/lib/engine-components/webxr/WebXRPlaneTracking.js +500 -500
  621. package/lib/engine-components/webxr/WebXRRig.d.ts +32 -32
  622. package/lib/engine-components/webxr/WebXRRig.js +72 -72
  623. package/lib/engine-components/webxr/XRFlag.d.ts +38 -38
  624. package/lib/engine-components/webxr/XRFlag.js +139 -139
  625. package/lib/engine-components/webxr/controllers/XRControllerFollow.d.ts +47 -47
  626. package/lib/engine-components/webxr/controllers/XRControllerFollow.js +120 -120
  627. package/lib/engine-components/webxr/controllers/XRControllerModel.d.ts +43 -43
  628. package/lib/engine-components/webxr/controllers/XRControllerModel.js +351 -351
  629. package/lib/engine-components/webxr/controllers/XRControllerMovement.d.ts +78 -78
  630. package/lib/engine-components/webxr/controllers/XRControllerMovement.js +506 -506
  631. package/lib/engine-components/webxr/index.d.ts +3 -3
  632. package/lib/engine-components/webxr/index.js +3 -3
  633. package/lib/engine-components/webxr/types.d.ts +3 -3
  634. package/lib/engine-components/webxr/types.js +1 -1
  635. package/lib/engine-components-experimental/Presentation.d.ts +6 -6
  636. package/lib/engine-components-experimental/Presentation.js +9 -9
  637. package/lib/engine-components-experimental/api.d.ts +4 -4
  638. package/lib/engine-components-experimental/api.js +4 -4
  639. package/lib/engine-components-experimental/networking/PlayerSync.d.ts +156 -156
  640. package/lib/engine-components-experimental/networking/PlayerSync.js +377 -377
  641. package/lib/engine-schemes/api.d.ts +12 -12
  642. package/lib/engine-schemes/api.js +12 -12
  643. package/lib/engine-schemes/schemes.d.ts +7 -7
  644. package/lib/engine-schemes/schemes.js +19 -19
  645. package/lib/engine-schemes/synced-camera-model.d.ts +25 -25
  646. package/lib/engine-schemes/synced-camera-model.js +67 -67
  647. package/lib/engine-schemes/synced-transform-model.d.ts +31 -31
  648. package/lib/engine-schemes/synced-transform-model.js +66 -66
  649. package/lib/engine-schemes/transform.d.ts +12 -12
  650. package/lib/engine-schemes/transform.js +39 -39
  651. package/lib/engine-schemes/vec2.d.ts +10 -10
  652. package/lib/engine-schemes/vec2.js +25 -25
  653. package/lib/engine-schemes/vec3.d.ts +11 -11
  654. package/lib/engine-schemes/vec3.js +29 -29
  655. package/lib/engine-schemes/vec4.d.ts +12 -12
  656. package/lib/engine-schemes/vec4.js +33 -33
  657. package/lib/engine-schemes/vr-user-state-buffer.d.ts +37 -37
  658. package/lib/engine-schemes/vr-user-state-buffer.js +110 -110
  659. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.d.ts +6 -6
  660. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.js +45 -45
  661. package/lib/needle-engine.d.ts +7 -7
  662. package/lib/needle-engine.js +64 -64
  663. package/package.json +1 -1
  664. package/plugins/common/buildinfo.js +64 -64
  665. package/plugins/common/cloud.js +1 -1
  666. package/plugins/common/config.cjs +31 -31
  667. package/plugins/common/config.js +35 -35
  668. package/plugins/common/files.js +31 -31
  669. package/plugins/common/generator.js +10 -10
  670. package/plugins/common/license.js +341 -330
  671. package/plugins/common/npm.js +15 -15
  672. package/plugins/common/timers.js +7 -7
  673. package/plugins/common/version.js +37 -37
  674. package/plugins/gltf-packer.mjs +1 -1
  675. package/plugins/next/alias.cjs +39 -39
  676. package/plugins/next/license.cjs +18 -18
  677. package/plugins/next/meshbvhworker.cjs +18 -18
  678. package/plugins/next/next.js +128 -128
  679. package/plugins/types/index.d.ts +2 -2
  680. package/plugins/types/license.d.ts +24 -24
  681. package/plugins/types/needleConfig.d.ts +27 -27
  682. package/plugins/types/userconfig.d.ts +105 -105
  683. package/plugins/types/webmanifest.d.ts +32 -32
  684. package/plugins/vite/alias.js +174 -174
  685. package/plugins/vite/asap.js +245 -245
  686. package/plugins/vite/build-pipeline.js +355 -355
  687. package/plugins/vite/build.js +19 -19
  688. package/plugins/vite/buildinfo.js +41 -41
  689. package/plugins/vite/config.js +106 -106
  690. package/plugins/vite/copyfiles.js +138 -138
  691. package/plugins/vite/defines.js +66 -66
  692. package/plugins/vite/dependencies.js +216 -216
  693. package/plugins/vite/dependency-watcher.js +231 -231
  694. package/plugins/vite/drop-client.js +76 -76
  695. package/plugins/vite/drop.js +87 -87
  696. package/plugins/vite/editor-connection.js +124 -124
  697. package/plugins/vite/facebook-instant-games.js +99 -99
  698. package/plugins/vite/gzip.js +5 -5
  699. package/plugins/vite/imports-logger.js +143 -143
  700. package/plugins/vite/index.js +139 -139
  701. package/plugins/vite/license.js +55 -55
  702. package/plugins/vite/meta.js +163 -163
  703. package/plugins/vite/npm.js +7 -7
  704. package/plugins/vite/peer.js +29 -29
  705. package/plugins/vite/poster-client.js +73 -73
  706. package/plugins/vite/poster.js +79 -79
  707. package/plugins/vite/pwa.js +604 -604
  708. package/plugins/vite/reload-client.js +15 -15
  709. package/plugins/vite/reload.js +363 -363
  710. package/plugins/vite/server.js +66 -66
  711. package/plugins/vite/transform-codegen.js +55 -55
  712. package/plugins/vite/transform.js +31 -31
  713. package/plugins/vite/vite-4.4-hack.js +31 -31
  714. package/src/asap/needle-asap.ts +111 -111
  715. package/src/asap/sessiongranted.ts +75 -75
  716. package/src/asap/utils.ts +4 -4
  717. package/src/engine/analytics/index.ts +10 -10
  718. package/src/engine/analytics/lcp.ts +35 -35
  719. package/src/engine/api.ts +81 -81
  720. package/src/engine/assets/index.ts +59 -59
  721. package/src/engine/assets/static.js +5 -5
  722. package/src/engine/codegen/register_types.ts +302 -302
  723. package/src/engine/debug/debug.ts +51 -51
  724. package/src/engine/debug/debug_console.ts +333 -333
  725. package/src/engine/debug/debug_overlay.ts +332 -332
  726. package/src/engine/debug/debug_spatial_console.ts +429 -429
  727. package/src/engine/debug/index.ts +1 -1
  728. package/src/engine/engine_addressables.ts +679 -679
  729. package/src/engine/engine_animation.ts +145 -145
  730. package/src/engine/engine_application.ts +113 -113
  731. package/src/engine/engine_assetdatabase.ts +387 -387
  732. package/src/engine/engine_audio.ts +24 -24
  733. package/src/engine/engine_camera.ts +39 -39
  734. package/src/engine/engine_components.ts +373 -373
  735. package/src/engine/engine_components_internal.ts +40 -40
  736. package/src/engine/engine_constants.ts +52 -52
  737. package/src/engine/engine_context.ts +1662 -1662
  738. package/src/engine/engine_context_registry.ts +129 -129
  739. package/src/engine/engine_coroutine.ts +54 -54
  740. package/src/engine/engine_create_objects.ts +398 -398
  741. package/src/engine/engine_default_parameters.ts +3 -3
  742. package/src/engine/engine_editor-sync.ts +28 -28
  743. package/src/engine/engine_element.ts +869 -871
  744. package/src/engine/engine_element_attributes.ts +85 -85
  745. package/src/engine/engine_element_extras.ts +16 -16
  746. package/src/engine/engine_element_loading.ts +381 -381
  747. package/src/engine/engine_element_overlay.ts +186 -186
  748. package/src/engine/engine_fileloader.js +9 -9
  749. package/src/engine/engine_gameobject.ts +684 -684
  750. package/src/engine/engine_generic_utils.js +13 -13
  751. package/src/engine/engine_gizmos.ts +577 -577
  752. package/src/engine/engine_gltf.ts +29 -29
  753. package/src/engine/engine_gltf_builtin_components.ts +403 -403
  754. package/src/engine/engine_hot_reload.ts +198 -198
  755. package/src/engine/engine_input.ts +1460 -1460
  756. package/src/engine/engine_input_utils.ts +23 -23
  757. package/src/engine/engine_instancing.ts +45 -45
  758. package/src/engine/engine_license.ts +329 -329
  759. package/src/engine/engine_lifecycle_api.ts +106 -106
  760. package/src/engine/engine_lifecycle_functions_internal.ts +193 -193
  761. package/src/engine/engine_lightdata.ts +117 -117
  762. package/src/engine/engine_loaders.ts +82 -82
  763. package/src/engine/engine_lods.ts +168 -168
  764. package/src/engine/engine_mainloop_utils.ts +472 -472
  765. package/src/engine/engine_math.ts +282 -282
  766. package/src/engine/engine_modules.ts +83 -83
  767. package/src/engine/engine_networking.ts +841 -841
  768. package/src/engine/engine_networking_auto.ts +352 -352
  769. package/src/engine/engine_networking_blob.ts +254 -254
  770. package/src/engine/engine_networking_files.ts +217 -217
  771. package/src/engine/engine_networking_files_default_components.ts +58 -58
  772. package/src/engine/engine_networking_instantiate.ts +419 -419
  773. package/src/engine/engine_networking_peer.ts +159 -159
  774. package/src/engine/engine_networking_streams.ts +713 -713
  775. package/src/engine/engine_networking_types.ts +24 -24
  776. package/src/engine/engine_networking_utils.ts +23 -23
  777. package/src/engine/engine_networking_websocket.ts +2 -2
  778. package/src/engine/engine_patcher.ts +199 -199
  779. package/src/engine/engine_physics.ts +783 -783
  780. package/src/engine/engine_physics.types.ts +46 -46
  781. package/src/engine/engine_physics_rapier.ts +1579 -1579
  782. package/src/engine/engine_playerview.ts +80 -80
  783. package/src/engine/engine_scenelighting.ts +294 -294
  784. package/src/engine/engine_scenetools.ts +365 -365
  785. package/src/engine/engine_serialization.ts +2 -2
  786. package/src/engine/engine_serialization_builtin_serializer.ts +473 -473
  787. package/src/engine/engine_serialization_core.ts +705 -705
  788. package/src/engine/engine_serialization_decorator.ts +80 -80
  789. package/src/engine/engine_setup.ts +1 -1
  790. package/src/engine/engine_shaders.ts +267 -267
  791. package/src/engine/engine_shims.ts +32 -32
  792. package/src/engine/engine_test_utils.ts +109 -109
  793. package/src/engine/engine_texture.ts +82 -82
  794. package/src/engine/engine_three_utils.ts +849 -849
  795. package/src/engine/engine_time.ts +94 -94
  796. package/src/engine/engine_time_utils.ts +237 -237
  797. package/src/engine/engine_tonemapping.ts +210 -210
  798. package/src/engine/engine_types.ts +714 -714
  799. package/src/engine/engine_typestore.ts +63 -63
  800. package/src/engine/engine_util_decorator.ts +136 -136
  801. package/src/engine/engine_utils.ts +972 -972
  802. package/src/engine/engine_utils_format.ts +212 -212
  803. package/src/engine/engine_utils_screenshot.ts +698 -698
  804. package/src/engine/engine_utils_screenshot.xr.ts +103 -103
  805. package/src/engine/export/gltf/Writers.ts +34 -34
  806. package/src/engine/export/gltf/index.ts +158 -158
  807. package/src/engine/export/index.ts +2 -2
  808. package/src/engine/export/state.ts +19 -19
  809. package/src/engine/export/utils.ts +9 -9
  810. package/src/engine/extensions/EXT_texture_exr.ts +50 -50
  811. package/src/engine/extensions/NEEDLE_animator_controller_model.ts +195 -195
  812. package/src/engine/extensions/NEEDLE_components.ts +268 -268
  813. package/src/engine/extensions/NEEDLE_gameobject_data.ts +81 -81
  814. package/src/engine/extensions/NEEDLE_lighting_settings.ts +185 -185
  815. package/src/engine/extensions/NEEDLE_lightmaps.ts +119 -119
  816. package/src/engine/extensions/NEEDLE_persistent_assets.ts +76 -76
  817. package/src/engine/extensions/NEEDLE_render_objects.ts +209 -209
  818. package/src/engine/extensions/NEEDLE_techniques_webgl.ts +640 -640
  819. package/src/engine/extensions/extension_resolver.ts +4 -4
  820. package/src/engine/extensions/extension_utils.ts +166 -166
  821. package/src/engine/extensions/extensions.ts +135 -135
  822. package/src/engine/extensions/index.ts +5 -5
  823. package/src/engine/extensions/usage_tracker.ts +100 -100
  824. package/src/engine/js-extensions/Camera.ts +37 -37
  825. package/src/engine/js-extensions/ExtensionUtils.ts +85 -85
  826. package/src/engine/js-extensions/Layers.ts +23 -23
  827. package/src/engine/js-extensions/Object3D.ts +296 -296
  828. package/src/engine/js-extensions/RGBAColor.ts +125 -75
  829. package/src/engine/js-extensions/Vector.ts +18 -18
  830. package/src/engine/js-extensions/index.ts +4 -4
  831. package/src/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +122 -122
  832. package/src/engine/shaders/shaderData.ts +67 -67
  833. package/src/engine/tests/test_utils.ts +63 -63
  834. package/src/engine/webcomponents/WebXRButtons.ts +260 -260
  835. package/src/engine/webcomponents/api.ts +6 -6
  836. package/src/engine/webcomponents/buttons.ts +262 -262
  837. package/src/engine/webcomponents/fonts.ts +41 -41
  838. package/src/engine/webcomponents/icons.ts +57 -57
  839. package/src/engine/webcomponents/index.ts +1 -1
  840. package/src/engine/webcomponents/logo-element.ts +78 -78
  841. package/src/engine/webcomponents/needle menu/needle-menu-spatial.ts +573 -573
  842. package/src/engine/webcomponents/needle menu/needle-menu.ts +1107 -1107
  843. package/src/engine/webcomponents/needle-button.ts +181 -181
  844. package/src/engine/xr/NeedleXRController.ts +1126 -1126
  845. package/src/engine/xr/NeedleXRSession.ts +1585 -1585
  846. package/src/engine/xr/NeedleXRSync.ts +220 -220
  847. package/src/engine/xr/SceneTransition.ts +78 -78
  848. package/src/engine/xr/TempXRContext.ts +216 -216
  849. package/src/engine/xr/XRRig.ts +9 -9
  850. package/src/engine/xr/api.ts +5 -5
  851. package/src/engine/xr/events.ts +102 -102
  852. package/src/engine/xr/internal.ts +34 -34
  853. package/src/engine/xr/usdz.ts +30 -30
  854. package/src/engine/xr/utils.ts +39 -39
  855. package/src/engine-components/AlignmentConstraint.ts +36 -36
  856. package/src/engine-components/Animation.ts +557 -557
  857. package/src/engine-components/AnimationCurve.ts +150 -150
  858. package/src/engine-components/AnimationUtils.ts +28 -28
  859. package/src/engine-components/AnimationUtilsAutoplay.ts +43 -43
  860. package/src/engine-components/Animator.ts +397 -397
  861. package/src/engine-components/AnimatorController.ts +1293 -1293
  862. package/src/engine-components/AudioListener.ts +92 -92
  863. package/src/engine-components/AudioSource.ts +639 -639
  864. package/src/engine-components/AvatarLoader.ts +263 -263
  865. package/src/engine-components/AxesHelper.ts +59 -59
  866. package/src/engine-components/BasicIKConstraint.ts +54 -54
  867. package/src/engine-components/BoxCollider.ts +1 -1
  868. package/src/engine-components/BoxHelperComponent.ts +114 -114
  869. package/src/engine-components/Camera.ts +719 -707
  870. package/src/engine-components/CameraUtils.ts +133 -142
  871. package/src/engine-components/CharacterController.ts +253 -253
  872. package/src/engine-components/Collider.ts +374 -374
  873. package/src/engine-components/Component.ts +1294 -1294
  874. package/src/engine-components/ContactShadows.ts +482 -482
  875. package/src/engine-components/DeleteBox.ts +62 -62
  876. package/src/engine-components/DeviceFlag.ts +46 -46
  877. package/src/engine-components/DragControls.ts +1623 -1623
  878. package/src/engine-components/DropListener.ts +698 -698
  879. package/src/engine-components/Duplicatable.ts +198 -198
  880. package/src/engine-components/EventList.ts +266 -266
  881. package/src/engine-components/EventTrigger.ts +74 -74
  882. package/src/engine-components/EventType.ts +22 -22
  883. package/src/engine-components/Fog.ts +60 -60
  884. package/src/engine-components/Gizmos.ts +56 -56
  885. package/src/engine-components/GridHelper.ts +48 -48
  886. package/src/engine-components/GroundProjection.ts +356 -356
  887. package/src/engine-components/Interactable.ts +14 -14
  888. package/src/engine-components/Joints.ts +52 -52
  889. package/src/engine-components/LODGroup.ts +153 -153
  890. package/src/engine-components/Light.ts +558 -558
  891. package/src/engine-components/LookAtConstraint.ts +25 -25
  892. package/src/engine-components/NeedleMenu.ts +84 -84
  893. package/src/engine-components/NestedGltf.ts +86 -86
  894. package/src/engine-components/Networking.ts +114 -114
  895. package/src/engine-components/OffsetConstraint.ts +60 -60
  896. package/src/engine-components/OrbitControls.ts +1068 -1068
  897. package/src/engine-components/PlayerColor.ts +103 -103
  898. package/src/engine-components/ReflectionProbe.ts +209 -209
  899. package/src/engine-components/Renderer.ts +900 -900
  900. package/src/engine-components/RendererInstancing.ts +855 -855
  901. package/src/engine-components/RendererLightmap.ts +198 -198
  902. package/src/engine-components/RigidBody.ts +526 -526
  903. package/src/engine-components/SceneSwitcher.ts +1013 -1013
  904. package/src/engine-components/ScreenCapture.ts +592 -592
  905. package/src/engine-components/ShadowCatcher.ts +172 -172
  906. package/src/engine-components/Skybox.ts +455 -455
  907. package/src/engine-components/SmoothFollow.ts +76 -76
  908. package/src/engine-components/SpatialTrigger.ts +229 -229
  909. package/src/engine-components/SpectatorCamera.ts +787 -787
  910. package/src/engine-components/SphereCollider.ts +1 -1
  911. package/src/engine-components/SpriteRenderer.ts +468 -468
  912. package/src/engine-components/SyncedCamera.ts +220 -220
  913. package/src/engine-components/SyncedRoom.ts +380 -380
  914. package/src/engine-components/SyncedTransform.ts +383 -378
  915. package/src/engine-components/TestRunner.ts +118 -118
  916. package/src/engine-components/TransformGizmo.ts +219 -219
  917. package/src/engine-components/VideoPlayer.ts +1025 -1025
  918. package/src/engine-components/Voip.ts +363 -363
  919. package/src/engine-components/api.ts +60 -60
  920. package/src/engine-components/avatar/AvatarBlink_Simple.ts +69 -69
  921. package/src/engine-components/avatar/AvatarEyeLook_Rotation.ts +63 -63
  922. package/src/engine-components/avatar/Avatar_Brain_LookAt.ts +139 -139
  923. package/src/engine-components/avatar/Avatar_MouthShapes.ts +83 -83
  924. package/src/engine-components/avatar/Avatar_MustacheShake.ts +31 -31
  925. package/src/engine-components/codegen/components.ts +217 -217
  926. package/src/engine-components/debug/LogStats.ts +21 -21
  927. package/src/engine-components/export/gltf/GltfExport.ts +265 -265
  928. package/src/engine-components/export/usdz/Extension.ts +24 -24
  929. package/src/engine-components/export/usdz/ThreeUSDZExporter.ts +2413 -2413
  930. package/src/engine-components/export/usdz/USDZExporter.ts +705 -705
  931. package/src/engine-components/export/usdz/extensions/Animation.ts +1204 -1204
  932. package/src/engine-components/export/usdz/extensions/DocumentExtension.ts +9 -9
  933. package/src/engine-components/export/usdz/extensions/USDZText.ts +240 -240
  934. package/src/engine-components/export/usdz/extensions/USDZUI.ts +189 -189
  935. package/src/engine-components/export/usdz/extensions/behavior/Actions.ts +99 -99
  936. package/src/engine-components/export/usdz/extensions/behavior/AudioExtension.ts +102 -102
  937. package/src/engine-components/export/usdz/extensions/behavior/Behaviour.ts +320 -320
  938. package/src/engine-components/export/usdz/extensions/behavior/BehaviourComponents.ts +1225 -1225
  939. package/src/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.ts +646 -646
  940. package/src/engine-components/export/usdz/extensions/behavior/PhysicsExtension.ts +132 -132
  941. package/src/engine-components/export/usdz/index.ts +2 -2
  942. package/src/engine-components/export/usdz/utils/animationutils.ts +191 -191
  943. package/src/engine-components/export/usdz/utils/quicklook.ts +50 -50
  944. package/src/engine-components/particlesystem/ParticleSystem.ts +1287 -1287
  945. package/src/engine-components/particlesystem/ParticleSystemModules.ts +1765 -1765
  946. package/src/engine-components/particlesystem/ParticleSystemSubEmitter.ts +111 -111
  947. package/src/engine-components/particlesystem/api.ts +1 -1
  948. package/src/engine-components/postprocessing/Effects/Antialiasing.ts +55 -55
  949. package/src/engine-components/postprocessing/Effects/BloomEffect.ts +116 -116
  950. package/src/engine-components/postprocessing/Effects/ChromaticAberration.ts +37 -37
  951. package/src/engine-components/postprocessing/Effects/ColorAdjustments.ts +95 -95
  952. package/src/engine-components/postprocessing/Effects/DepthOfField.ts +103 -103
  953. package/src/engine-components/postprocessing/Effects/EffectWrapper.ts +25 -25
  954. package/src/engine-components/postprocessing/Effects/Pixelation.ts +32 -32
  955. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.ts +90 -90
  956. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.ts +191 -191
  957. package/src/engine-components/postprocessing/Effects/Sharpening.ts +138 -138
  958. package/src/engine-components/postprocessing/Effects/TiltShiftEffect.ts +61 -61
  959. package/src/engine-components/postprocessing/Effects/Tonemapping.ts +155 -155
  960. package/src/engine-components/postprocessing/Effects/Vignette.ts +59 -59
  961. package/src/engine-components/postprocessing/PostProcessingEffect.ts +172 -172
  962. package/src/engine-components/postprocessing/PostProcessingHandler.ts +398 -398
  963. package/src/engine-components/postprocessing/Volume.ts +410 -410
  964. package/src/engine-components/postprocessing/VolumeParameter.ts +158 -158
  965. package/src/engine-components/postprocessing/VolumeProfile.ts +61 -61
  966. package/src/engine-components/postprocessing/index.ts +5 -5
  967. package/src/engine-components/postprocessing/utils.ts +52 -52
  968. package/src/engine-components/timeline/PlayableDirector.ts +722 -722
  969. package/src/engine-components/timeline/SignalAsset.ts +144 -144
  970. package/src/engine-components/timeline/TimelineModels.ts +92 -92
  971. package/src/engine-components/timeline/TimelineTracks.ts +967 -967
  972. package/src/engine-components/timeline/index.ts +3 -3
  973. package/src/engine-components/ui/BaseUIComponent.ts +203 -203
  974. package/src/engine-components/ui/Button.ts +307 -307
  975. package/src/engine-components/ui/Canvas.ts +419 -419
  976. package/src/engine-components/ui/CanvasGroup.ts +54 -54
  977. package/src/engine-components/ui/EventSystem.ts +853 -853
  978. package/src/engine-components/ui/Graphic.ts +275 -275
  979. package/src/engine-components/ui/Image.ts +112 -112
  980. package/src/engine-components/ui/InputField.ts +321 -321
  981. package/src/engine-components/ui/Interfaces.ts +57 -57
  982. package/src/engine-components/ui/Layout.ts +334 -334
  983. package/src/engine-components/ui/Outline.ts +13 -13
  984. package/src/engine-components/ui/PointerEvents.ts +206 -206
  985. package/src/engine-components/ui/RaycastUtils.ts +69 -69
  986. package/src/engine-components/ui/Raycaster.ts +102 -102
  987. package/src/engine-components/ui/RectTransform.ts +372 -372
  988. package/src/engine-components/ui/SpatialHtml.ts +79 -79
  989. package/src/engine-components/ui/Text.ts +578 -578
  990. package/src/engine-components/ui/Utils.ts +112 -112
  991. package/src/engine-components/utils/EnvironmentScene.ts +245 -245
  992. package/src/engine-components/utils/LookAt.ts +88 -88
  993. package/src/engine-components/utils/OpenURL.ts +114 -114
  994. package/src/engine-components/webxr/Avatar.ts +265 -265
  995. package/src/engine-components/webxr/TeleportTarget.ts +9 -9
  996. package/src/engine-components/webxr/WebARCameraBackground.ts +175 -175
  997. package/src/engine-components/webxr/WebARSessionRoot.ts +880 -880
  998. package/src/engine-components/webxr/WebXR.ts +585 -585
  999. package/src/engine-components/webxr/WebXRAvatar.ts +66 -66
  1000. package/src/engine-components/webxr/WebXRImageTracking.ts +518 -518
  1001. package/src/engine-components/webxr/WebXRPlaneTracking.ts +570 -570
  1002. package/src/engine-components/webxr/WebXRRig.ts +77 -77
  1003. package/src/engine-components/webxr/XRFlag.ts +147 -147
  1004. package/src/engine-components/webxr/controllers/XRControllerFollow.ts +118 -118
  1005. package/src/engine-components/webxr/controllers/XRControllerModel.ts +374 -374
  1006. package/src/engine-components/webxr/controllers/XRControllerMovement.ts +550 -550
  1007. package/src/engine-components/webxr/index.ts +2 -2
  1008. package/src/engine-components/webxr/types.ts +3 -3
  1009. package/src/engine-components-experimental/Presentation.ts +12 -12
  1010. package/src/engine-components-experimental/api.ts +4 -4
  1011. package/src/engine-components-experimental/networking/PlayerSync.ts +401 -401
  1012. package/src/engine-schemes/COMPILE_SCHEMES.bat +3 -3
  1013. package/src/engine-schemes/COMPILE_TS.bat +11 -11
  1014. package/src/engine-schemes/README.md +1 -1
  1015. package/src/engine-schemes/api.ts +12 -12
  1016. package/src/engine-schemes/dist/api.js +17 -0
  1017. package/src/engine-schemes/dist/api.js.meta +7 -0
  1018. package/src/engine-schemes/dist/schemes.js +25 -0
  1019. package/src/engine-schemes/dist/schemes.js.meta +7 -0
  1020. package/src/engine-schemes/dist/synced-camera-model.js +74 -0
  1021. package/src/engine-schemes/dist/synced-camera-model.js.meta +7 -0
  1022. package/src/engine-schemes/dist/synced-transform-model.js +73 -0
  1023. package/src/engine-schemes/dist/synced-transform-model.js.meta +7 -0
  1024. package/src/engine-schemes/dist/transform.js +46 -0
  1025. package/src/engine-schemes/dist/transform.js.meta +7 -0
  1026. package/src/engine-schemes/dist/vec2.js +32 -0
  1027. package/src/engine-schemes/dist/vec2.js.meta +7 -0
  1028. package/src/engine-schemes/dist/vec3.js +36 -0
  1029. package/src/engine-schemes/dist/vec3.js.meta +7 -0
  1030. package/src/engine-schemes/dist/vec4.js +40 -0
  1031. package/src/engine-schemes/dist/vec4.js.meta +7 -0
  1032. package/src/engine-schemes/dist/vr-user-state-buffer.js +110 -0
  1033. package/src/engine-schemes/dist/vr-user-state-buffer.js.meta +7 -0
  1034. package/src/engine-schemes/schemes.ts +28 -28
  1035. package/src/engine-schemes/synced-camera-model.ts +92 -92
  1036. package/src/engine-schemes/synced-transform-model.ts +90 -90
  1037. package/src/engine-schemes/syncedCamera.fbs +10 -10
  1038. package/src/engine-schemes/transform.ts +50 -50
  1039. package/src/engine-schemes/transforms.fbs +25 -25
  1040. package/src/engine-schemes/vec.fbs +19 -19
  1041. package/src/engine-schemes/vec2.ts +33 -33
  1042. package/src/engine-schemes/vec3.ts +38 -38
  1043. package/src/engine-schemes/vec4.ts +43 -43
  1044. package/src/engine-schemes/vr-user-state-buffer.ts +145 -145
  1045. package/src/engine-schemes/vrUserStateBuffer.fbs +17 -17
  1046. package/src/include/draco/draco_decoder.js +34 -34
  1047. package/src/include/ktx2/basis_transcoder.js +21 -21
  1048. package/src/include/needle/arial-msdf.json +1471 -1471
  1049. package/src/include/three/DragControls.js +231 -231
  1050. package/src/include/three/EXT_mesh_gpu_instancing_exporter.js +66 -66
  1051. package/src/needle-engine.ts +70 -70
@@ -1,705 +1,705 @@
1
- import { NEEDLE_progressive } from "@needle-tools/gltf-progressive";
2
- import { Euler, Matrix4, Mesh, Object3D, Quaternion, Vector3 } from "three";
3
-
4
- import { isDevEnvironment, showBalloonMessage, showBalloonWarning } from "../../../engine/debug/index.js";
5
- import { hasProLicense } from "../../../engine/engine_license.js";
6
- import { serializable } from "../../../engine/engine_serialization.js";
7
- import { getFormattedDate, Progress } from "../../../engine/engine_time_utils.js";
8
- import { DeviceUtilities, getParam } from "../../../engine/engine_utils.js";
9
- import { WebXRButtonFactory } from "../../../engine/webcomponents/WebXRButtons.js";
10
- import { InternalUSDZRegistry } from "../../../engine/xr/usdz.js"
11
- import { InstancingHandler } from "../../../engine-components/RendererInstancing.js";
12
- import { Collider } from "../../Collider.js";
13
- import { Behaviour, GameObject } from "../../Component.js";
14
- import { ContactShadows } from "../../ContactShadows.js";
15
- import { GroundProjectedEnv } from "../../GroundProjection.js";
16
- import { Renderer } from "../../Renderer.js"
17
- import { Rigidbody } from "../../RigidBody.js";
18
- import { SpriteRenderer } from "../../SpriteRenderer.js";
19
- import { WebARSessionRoot } from "../../webxr/WebARSessionRoot.js";
20
- import { WebXR } from "../../webxr/WebXR.js";
21
- import { XRState, XRStateFlag } from "../../webxr/XRFlag.js";
22
- import type { IUSDExporterExtension } from "./Extension.js";
23
- import { AnimationExtension } from "./extensions/Animation.js"
24
- import { AudioExtension } from "./extensions/behavior/AudioExtension.js";
25
- import { BehaviorExtension } from "./extensions/behavior/Behaviour.js";
26
- import { PhysicsExtension } from "./extensions/behavior/PhysicsExtension.js"
27
- import { TextExtension } from "./extensions/USDZText.js";
28
- import { USDZUIExtension } from "./extensions/USDZUI.js";
29
- import { USDZExporter as ThreeUSDZExporter } from "./ThreeUSDZExporter.js";
30
- import { disableObjectsAtStart, registerAnimatorsImplictly, registerAudioSourcesImplictly } from "./utils/animationutils.js";
31
- import { ensureQuicklookLinkIsCreated } from "./utils/quicklook.js";
32
-
33
- const debug = getParam("debugusdz");
34
- const debugUsdzPruning = getParam("debugusdzpruning");
35
-
36
- /**
37
- * Custom branding for the QuickLook overlay, used by {@link USDZExporter}.
38
- */
39
- export class CustomBranding {
40
- /** The call to action button text. If not set, the button will close the QuickLook overlay. */
41
- @serializable()
42
- callToAction?: string;
43
- /** The title of the overlay. */
44
- @serializable()
45
- checkoutTitle?: string;
46
- /** The subtitle of the overlay. */
47
- @serializable()
48
- checkoutSubtitle?: string;
49
-
50
- /** if assigned the call to action button in quicklook will open the URL. Otherwise it will just close quicklook. */
51
- @serializable()
52
- callToActionURL?: string;
53
- }
54
-
55
- /**
56
- * Exports the current scene or a specific object as USDZ file and opens it in QuickLook on iOS/iPadOS/visionOS.
57
- * The USDZ file is generated using the Needle Engine ThreeUSDZExporter.
58
- * The exporter supports various extensions to add custom behaviors and interactions to the USDZ file.
59
- * The exporter can automatically collect Animations and AudioSources and export them as playing at the start.
60
- * The exporter can also add a custom QuickLook overlay with a call to action button and custom branding.
61
- * @example
62
- * ```typescript
63
- * const usdz = new USDZExporter();
64
- * usdz.objectToExport = myObject;
65
- * usdz.autoExportAnimations = true;
66
- * usdz.autoExportAudioSources = true;
67
- * usdz.exportAsync();
68
- * ```
69
- * @category XR
70
- * @group Components
71
- */
72
- export class USDZExporter extends Behaviour {
73
-
74
- /**
75
- * Assign the object to export as USDZ file. If undefined or null, the whole scene will be exported.
76
- */
77
- @serializable(Object3D)
78
- objectToExport: Object3D | null | undefined = undefined;
79
-
80
- /** Collect all Animations/Animators automatically on export and emit them as playing at the start.
81
- * Animator state chains and loops will automatically be collected and exported in order as well.
82
- * If this setting is off, Animators need to be registered by components – for example from PlayAnimationOnClick.
83
- */
84
- @serializable()
85
- autoExportAnimations: boolean = true;
86
-
87
- /** Collect all AudioSources automatically on export and emit them as playing at the start.
88
- * They will loop according to their settings.
89
- * If this setting is off, Audio Sources need to be registered by components – for example from PlayAudioOnClick.
90
- */
91
- @serializable()
92
- autoExportAudioSources: boolean = true;
93
-
94
- @serializable()
95
- exportFileName: string | null | undefined = undefined;
96
-
97
- @serializable(URL)
98
- customUsdzFile: string | null | undefined = undefined;
99
-
100
- @serializable(CustomBranding)
101
- customBranding?: CustomBranding;
102
-
103
- // Currently not exposed to integrations - not fully tested. Set from code (e.g. image tracking)
104
- @serializable()
105
- anchoringType: "plane" | "image" | "face" | "none" = "plane";
106
-
107
- @serializable()
108
- maxTextureSize: 256 | 512 | 1024 | 2048 | 4096 | 8192 = 2048;
109
-
110
- // Currently not exposed to integrations - not fully tested. Set from code (e.g. image tracking)
111
- @serializable()
112
- planeAnchoringAlignment: "horizontal" | "vertical" | "any" = "horizontal";
113
-
114
- /** Enabling this option will export QuickLook-specific preliminary behaviours along with the USDZ files.
115
- * These extensions are only supported on QuickLook on iOS/visionOS/MacOS.
116
- * Keep this option off for general USDZ usage.
117
- */
118
- @serializable()
119
- interactive: boolean = true;
120
-
121
- /** Enabling this option will export the USDZ file with RealityKit physics components.
122
- * Rigidbody and Collider components will be converted to their RealityKit counterparts.
123
- * Physics are supported on QuickLook in iOS 18+ and VisionOS 1+.
124
- * Physics export is automatically turned off when there are no Rigidbody components anywhere on the exported object.
125
- */
126
- @serializable()
127
- physics: boolean = true;
128
-
129
- @serializable()
130
- allowCreateQuicklookButton: boolean = true;
131
-
132
- @serializable()
133
- quickLookCompatible: boolean = true;
134
-
135
- /**
136
- * Extensions to add custom behaviors and interactions to the USDZ file.
137
- * You can add your own extensions here by extending {@link IUSDExporterExtension}.
138
- */
139
- extensions: IUSDExporterExtension[] = [];
140
-
141
- private link!: HTMLAnchorElement;
142
- private button?: HTMLButtonElement;
143
-
144
- /** @internal */
145
- start() {
146
- if (debug) {
147
- console.log("USDZExporter", this);
148
- console.log("Debug USDZ Mode. Press 'T' to export")
149
- window.addEventListener("keydown", (evt) => {
150
- switch (evt.key) {
151
- case "t":
152
- this.exportAndOpen();
153
- break;
154
- }
155
- });
156
- }
157
-
158
- // fall back to this object or to the scene if it's empty and doesn't have a mesh
159
- if (!this.objectToExport)
160
- this.objectToExport = this.gameObject;
161
- if (!this.objectToExport?.children?.length && !(this.objectToExport as Mesh)?.isMesh)
162
- this.objectToExport = this.context.scene;
163
- }
164
-
165
- /** @internal */
166
- onEnable() {
167
- const supportsQuickLook = DeviceUtilities.supportsQuickLookAR();
168
- const ios = DeviceUtilities.isiOS() || DeviceUtilities.isiPad();
169
- if (!this.button && (debug || supportsQuickLook || ios)) {
170
- if (this.allowCreateQuicklookButton)
171
- this.button = this.createQuicklookButton();
172
-
173
- this.lastCallback = this.quicklookCallback.bind(this);
174
- this.link = ensureQuicklookLinkIsCreated(this.context, supportsQuickLook);
175
- this.link.addEventListener('message', this.lastCallback);
176
- }
177
- if (debug)
178
- showBalloonMessage("USDZ Exporter enabled: " + this.name);
179
-
180
- document.getElementById("open-in-ar")?.addEventListener("click", this.onClickedOpenInARElement);
181
- InternalUSDZRegistry.registerExporter(this);
182
- }
183
-
184
- /** @internal */
185
- onDisable() {
186
- this.button?.remove();
187
- this.link?.removeEventListener('message', this.lastCallback);
188
- if (debug)
189
- showBalloonMessage("USDZ Exporter disabled: " + this.name);
190
-
191
- document.getElementById("open-in-ar")?.removeEventListener("click", this.onClickedOpenInARElement);
192
- InternalUSDZRegistry.unregisterExporter(this);
193
- }
194
-
195
- private onClickedOpenInARElement = (evt) => {
196
- evt.preventDefault();
197
- this.exportAndOpen();
198
- }
199
-
200
- /**
201
- * Creates an USDZ file from the current scene or assigned objectToExport and opens it in QuickLook.
202
- * Use the various public properties of USDZExporter to customize export behaviour.
203
- * @deprecated use {@link exportAndOpen} instead
204
- */
205
- async exportAsync() {
206
- return this.exportAndOpen();
207
- }
208
-
209
- /**
210
- * Creates an USDZ file from the current scene or assigned objectToExport and opens it in QuickLook.
211
- * @returns a Promise<Blob> containing the USDZ file
212
- */
213
- async exportAndOpen() : Promise<Blob | null> {
214
-
215
- let name = this.exportFileName ?? this.objectToExport?.name ?? this.name;
216
- name += "-" + getFormattedDate(); // seems iOS caches the file in some cases, this ensures we always have a fresh file
217
-
218
- if (!hasProLicense()) {
219
- if (name !== "") name += "-";
220
- name += "MadeWithNeedle";
221
- }
222
-
223
- if (!this.link) this.link = ensureQuicklookLinkIsCreated(this.context, DeviceUtilities.supportsQuickLookAR());
224
-
225
- // ability to specify a custom USDZ file to be used instead of a dynamic one
226
- if (this.customUsdzFile) {
227
- if (debug) console.log("Exporting custom usdz", this.customUsdzFile)
228
- this.openInQuickLook(this.customUsdzFile, name);
229
- return null;
230
- }
231
-
232
- if (!this.objectToExport) {
233
- console.warn("No object to export", this);
234
- return null;
235
- }
236
-
237
- const blob = await this.export(this.objectToExport);
238
- if (!blob) {
239
- console.error("USDZ generation failed. Please report a bug", this);
240
- return null;
241
- }
242
-
243
- if (debug) console.log("USDZ generation done. Downloading as " + name);
244
-
245
- // TODO Potentially we have to detect QuickLook availability here,
246
- // and download the file instead. But browsers keep changing how they deal with non-user-initiated downloads...
247
- // https://webkit.org/blog/8421/viewing-augmented-reality-assets-in-safari-for-ios/#:~:text=inside%20the%20anchor.-,Feature%20Detection,-To%20detect%20support
248
- /*
249
- if (!DeviceUtilities.supportsQuickLookAR())
250
- this.download(blob, name);
251
- else
252
- */
253
- this.openInQuickLook(blob, name);
254
-
255
- return blob;
256
- }
257
-
258
- /**
259
- * Creates an USDZ file from the current scene or assigned objectToExport and opens it in QuickLook.
260
- * @returns a Promise<Blob> containing the USDZ file
261
- */
262
- async export(objectToExport: Object3D | undefined): Promise<Blob | null> {
263
- // make sure we have an object to export
264
- if (!objectToExport) {
265
- console.warn("No object to export");
266
- return null;
267
- }
268
-
269
- // if we are already exporting, wait for the current export to finish
270
- const taskForThisObject = this._currentExportTasks.get(objectToExport);
271
- if (taskForThisObject) {
272
- return taskForThisObject;
273
- }
274
-
275
- // start the export
276
- const task = this.internalExport(objectToExport);
277
- // store the task
278
- if (task instanceof Promise) {
279
- this._currentExportTasks.set(objectToExport, task);
280
- return task.then((blob) => {
281
- this._currentExportTasks.delete(objectToExport);
282
- return blob;
283
- }).catch((e) => {
284
- this._currentExportTasks.delete(objectToExport);
285
- console.error("Error during USDZ export – please report a bug!", e);
286
- return null;
287
- });
288
- }
289
-
290
- return task;
291
- }
292
-
293
- private readonly _currentExportTasks = new Map<Object3D, Promise<Blob | null>>();
294
- private _previousTimeScale: number = 1;
295
-
296
- private async internalExport(objectToExport: Object3D): Promise<Blob | null> {
297
-
298
- Progress.start("export-usdz", {
299
- onProgress: (progress) => {
300
- this.dispatchEvent(new CustomEvent("export-progress", { detail: { progress } }));
301
- }
302
- });
303
- Progress.report("export-usdz", { message: "Starting export", totalSteps: 40, currentStep: 0 });
304
- Progress.report("export-usdz", { message: "Load progressive textures", autoStep: 5 });
305
- Progress.start("export-usdz-textures", "export-usdz");
306
-
307
- // force Sprites to be created
308
- const sprites = GameObject.getComponentsInChildren(objectToExport, SpriteRenderer);
309
- for (const sprite of sprites) {
310
- if (sprite && sprite.enabled) {
311
- sprite.updateSprite(true); // force create
312
- }
313
- }
314
-
315
- // trigger progressive textures to be loaded:
316
- const renderers = GameObject.getComponentsInChildren(objectToExport, Renderer);
317
- const progressiveLoading = new Array<Promise<any>>();
318
- let progressiveTasks = 0;
319
- // TODO: it would be better to directly integrate this into the exporter and *on export* request the correct LOD level for textures and meshes instead of relying on the renderer etc
320
- for (const rend of renderers) {
321
- for (const mesh of rend.sharedMeshes) {
322
- if (mesh) {
323
- const task = NEEDLE_progressive.assignMeshLOD(mesh, 0);
324
- if (task instanceof Promise)
325
- progressiveLoading.push(new Promise<void>((resolve, reject) => {
326
- task.then(() => {
327
- progressiveTasks++;
328
- Progress.report("export-usdz-textures", { message: "Loaded progressive mesh", currentStep: progressiveTasks, totalSteps: progressiveLoading.length });
329
- resolve();
330
- }).catch((err) => reject(err));
331
- }));
332
- }
333
- }
334
- for (const mat of rend.sharedMaterials) {
335
- if (mat) {
336
- const task = NEEDLE_progressive.assignTextureLOD(mat, 0);
337
- if (task instanceof Promise)
338
- progressiveLoading.push(new Promise<void>((resolve, reject) => {
339
- task.then(() => {
340
- progressiveTasks++;
341
- Progress.report("export-usdz-textures", { message: "Loaded progressive texture", currentStep: progressiveTasks, totalSteps: progressiveLoading.length });
342
- resolve();
343
- }).catch((err) => reject(err));
344
- }));
345
- }
346
- }
347
- }
348
- if (debug) showBalloonMessage("Progressive Loading: " + progressiveLoading.length);
349
- await Promise.all(progressiveLoading);
350
- if (debug) showBalloonMessage("Progressive Loading: done");
351
- Progress.end("export-usdz-textures");
352
-
353
- // apply XRFlags
354
- const currentXRState = XRState.Global.Mask;
355
- XRState.Global.Set(XRStateFlag.AR);
356
-
357
- const exporter = new ThreeUSDZExporter();
358
- // We're creating a new animation extension on each export to avoid issues with multiple exports.
359
- // TODO we probably want to do that with all the extensions...
360
- // Ordering of extensions is important
361
- const animExt = new AnimationExtension(this.quickLookCompatible);
362
- let physicsExt: PhysicsExtension | undefined = undefined;
363
- const defaultExtensions: IUSDExporterExtension[] = [];
364
- if (this.interactive) {
365
- defaultExtensions.push(new BehaviorExtension());
366
- defaultExtensions.push(new AudioExtension());
367
-
368
- // If physics are enabled, and there are any Rigidbody components in the scene,
369
- // add the PhysicsExtension to the default extensions.
370
- if (globalThis["NEEDLE_USE_RAPIER"]) {
371
- const rigidbodies = GameObject.getComponentsInChildren(objectToExport, Rigidbody);
372
- if (rigidbodies.length > 0) {
373
- if (this.physics) {
374
- physicsExt = new PhysicsExtension();
375
- defaultExtensions.push(physicsExt);
376
- }
377
- else if (isDevEnvironment()) {
378
- console.warn("USDZExporter: Physics export is disabled, but there are active Rigidbody components in the scene. They will not be exported.");
379
- }
380
- }
381
- }
382
- defaultExtensions.push(new TextExtension());
383
- defaultExtensions.push(new USDZUIExtension());
384
- }
385
- const extensions: any = [animExt, ...defaultExtensions, ...this.extensions];
386
-
387
- const eventArgs = { self: this, exporter: exporter, extensions: extensions, object: objectToExport };
388
- Progress.report("export-usdz", "Invoking before-export");
389
- this.dispatchEvent(new CustomEvent("before-export", { detail: eventArgs }));
390
-
391
- // make sure we apply the AR scale
392
- this.applyWebARSessionRoot();
393
-
394
- // freeze time
395
- this._previousTimeScale = this.context.time.timeScale;
396
- this.context.time.timeScale = 0;
397
-
398
- // Implicit registration and actions for Animators and Animation components
399
- // Currently, Animators properly build PlayAnimation actions, but Animation components don't.
400
-
401
- Progress.report("export-usdz", "auto export animations and audio sources");
402
- const implicitBehaviors = new Array<Object3D>();
403
- if (this.autoExportAnimations) {
404
- implicitBehaviors.push(...registerAnimatorsImplictly(objectToExport, animExt));
405
- }
406
- const audioExt = extensions.find(ext => ext.extensionName === "Audio");
407
- if (audioExt && this.autoExportAudioSources)
408
- implicitBehaviors.push(...registerAudioSourcesImplictly(objectToExport, audioExt as AudioExtension));
409
-
410
- //@ts-ignore
411
- exporter.debug = debug;
412
- exporter.pruneUnusedNodes = !debugUsdzPruning;
413
- const instancedRenderers = InstancingHandler.instance.objs.map(x => x.batchedMesh);
414
- exporter.keepObject = (object) => {
415
- let keep = true;
416
- // This explicitly removes geometry and material data from disabled renderers.
417
- // Note that this is different to the object itself being active –
418
- // here, we have an active object with a disabled renderer.
419
- const renderer = GameObject.getComponent(object, Renderer);
420
- if (renderer && !renderer.enabled) keep = false;
421
- // Check if this is an instancing container.
422
- // Instances are already included in the export.
423
- if (keep && instancedRenderers.includes(object as any)) keep = false;
424
- if (keep && GameObject.getComponentInParent(object, ContactShadows)) keep = false;
425
- if (keep && GameObject.getComponentInParent(object, GroundProjectedEnv)) keep = false;
426
- if (debug && !keep) console.log("USDZExporter: Discarding object", object);
427
- return keep;
428
- }
429
-
430
- exporter.beforeWritingDocument = () => {
431
- // Warn if there are any physics components on animated objects or their children
432
- if (isDevEnvironment() && animExt && physicsExt) {
433
- const animatedObjects = animExt.animatedRoots;
434
- for (const object of animatedObjects) {
435
- const rigidBodySources = GameObject.getComponentsInChildren(object, Rigidbody).filter(c => c.enabled);
436
- const colliderSources = GameObject.getComponents(object, Collider).filter(c => c.enabled && !c.isTrigger);
437
- if (rigidBodySources.length > 0 || colliderSources.length > 0) {
438
- console.error("An animated object has physics components in its child hierarchy. This can lead to undefined behaviour due to a bug in Apple's QuickLook (FB15925487). Remove the physics components from child objects or verify that you get the expected results.", object);
439
- }
440
- }
441
- }
442
- };
443
-
444
- // Collect invisible objects so that we can disable them if
445
- // - we're exporting for QuickLook
446
- // - and interactive behaviors are allowed.
447
- // When exporting for regular USD, we're supporting the "visibility" attribute anyways.
448
- const objectsToDisableAtSceneStart = new Array<Object3D>();
449
- if (this.objectToExport && this.quickLookCompatible && this.interactive) {
450
- this.objectToExport.traverse((obj) => {
451
- if (!obj.visible) {
452
- objectsToDisableAtSceneStart.push(obj);
453
- }
454
- });
455
- }
456
-
457
- const behaviorExt = extensions.find(ext => ext.extensionName === "Behaviour") as BehaviorExtension | undefined;
458
- if (this.interactive && behaviorExt && objectsToDisableAtSceneStart.length > 0) {
459
- behaviorExt.addBehavior(disableObjectsAtStart(objectsToDisableAtSceneStart));
460
- }
461
-
462
- let exportInvisible = true;
463
- // The only case where we want to strip out invisible objects is
464
- // when we're exporting for QuickLook and we're NOT adding interactive behaviors,
465
- // since QuickLook on iOS does not support "visibility" tokens.
466
- if (this.quickLookCompatible && !this.interactive)
467
- exportInvisible = false;
468
-
469
- // sanitize anchoring types
470
- if (this.anchoringType !== "plane" && this.anchoringType !== "none" && this.anchoringType !== "image" && this.anchoringType !== "face")
471
- this.anchoringType = "plane";
472
- if (this.planeAnchoringAlignment !== "horizontal" && this.planeAnchoringAlignment !== "vertical" && this.planeAnchoringAlignment !== "any")
473
- this.planeAnchoringAlignment = "horizontal";
474
-
475
- Progress.report("export-usdz", "Invoking exporter.parse");
476
-
477
- //@ts-ignore
478
- const arraybuffer = await exporter.parse(this.objectToExport, {
479
- ar: {
480
- anchoring: {
481
- type: this.anchoringType,
482
- },
483
- planeAnchoring: {
484
- alignment: this.planeAnchoringAlignment,
485
- },
486
- },
487
- extensions: extensions,
488
- quickLookCompatible: this.quickLookCompatible,
489
- maxTextureSize: this.maxTextureSize,
490
- exportInvisible: exportInvisible,
491
- });
492
-
493
- const blob = new Blob([arraybuffer], { type: 'model/vnd.usdz+zip' });
494
-
495
- this.revertWebARSessionRoot();
496
-
497
- // unfreeze time
498
- this.context.time.timeScale = this._previousTimeScale;
499
-
500
- Progress.report("export-usdz", "Invoking after-export");
501
-
502
- this.dispatchEvent(new CustomEvent("after-export", { detail: eventArgs }))
503
-
504
- // cleanup – implicit animation behaviors need to be removed again
505
- for (const go of implicitBehaviors) {
506
- GameObject.destroy(go);
507
- }
508
-
509
- // restore XR flags
510
- XRState.Global.Set(currentXRState);
511
-
512
- // second file: USDA (without assets)
513
- //@ts-ignore
514
- // const usda = exporter.lastUsda;
515
- // const blob2 = new Blob([usda], { type: 'text/plain' });
516
- // this.link.download = name + ".usda";
517
- // this.link.href = URL.createObjectURL(blob2);
518
- // this.link.click();
519
-
520
- Progress.end("export-usdz");
521
- return blob;
522
- }
523
-
524
- /**
525
- * Opens QuickLook on iOS/iPadOS/visionOS with the given content in AR mode.
526
- * @param content The URL to the .usdz or .reality file or a blob containing an USDZ file.
527
- * @param name Download filename
528
- */
529
- openInQuickLook(content: Blob | string, name: string) {
530
-
531
- const url = content instanceof Blob ? URL.createObjectURL(content) : content;
532
-
533
- // see https://developer.apple.com/documentation/arkit/adding_an_apple_pay_button_or_a_custom_action_in_ar_quick_look
534
- const overlay = this.buildQuicklookOverlay();
535
- if (debug) console.log("QuickLook Overlay", overlay);
536
- const callToAction = overlay.callToAction ? encodeURIComponent(overlay.callToAction) : "";
537
- const checkoutTitle = overlay.checkoutTitle ? encodeURIComponent(overlay.checkoutTitle) : "";
538
- const checkoutSubtitle = overlay.checkoutSubtitle ? encodeURIComponent(overlay.checkoutSubtitle) : "";
539
- this.link.href = url + `#callToAction=${callToAction}&checkoutTitle=${checkoutTitle}&checkoutSubtitle=${checkoutSubtitle}&callToActionURL=${overlay.callToActionURL}`;
540
-
541
- if (!this.lastCallback) {
542
- this.lastCallback = this.quicklookCallback.bind(this)
543
- this.link.addEventListener('message', this.lastCallback);
544
- }
545
-
546
- // Open QuickLook
547
- this.link.download = name + ".usdz";
548
- this.link.click();
549
-
550
- // cleanup
551
- // TODO check if we can do that immediately or need to wait until the user returns
552
- // if (content instanceof Blob) URL.revokeObjectURL(url);
553
- }
554
-
555
- /**
556
- * Downloads the given blob as a file.
557
- */
558
- download(blob: Blob, name: string) {
559
- USDZExporter.save(blob, name);
560
- }
561
-
562
- // Matches GltfExport.save(blob, filename)
563
- private static save(blob, filename) {
564
- const link = document.createElement('a');
565
- link.style.display = 'none';
566
- document.body.appendChild(link); // Firefox workaround, see #6594
567
- if (typeof blob === "string")
568
- link.href = blob;
569
- else
570
- link.href = URL.createObjectURL(blob);
571
- link.download = filename;
572
- link.click();
573
- link.remove();
574
- // console.log(link.href);
575
- // URL.revokeObjectURL( url ); breaks Firefox...
576
- }
577
-
578
-
579
- private lastCallback?: any;
580
-
581
- private quicklookCallback(event: Event) {
582
- if ((event as any)?.data == '_apple_ar_quicklook_button_tapped') {
583
- if (debug) showBalloonWarning("Quicklook closed via call to action button");
584
- var evt = new CustomEvent("quicklook-button-tapped", { detail: this });
585
- this.dispatchEvent(evt);
586
- if (!evt.defaultPrevented) {
587
- const url = new URLSearchParams(this.link.href);
588
- if (url) {
589
- const callToActionURL = url.get("callToActionURL");
590
- if (debug)
591
- showBalloonMessage("Quicklook url: " + callToActionURL);
592
- if (callToActionURL) {
593
- if (!hasProLicense()) {
594
- console.warn("Quicklook closed: custom redirects require a Needle Engine Pro license: https://needle.tools/pricing", callToActionURL)
595
- }
596
- else {
597
- globalThis.open(callToActionURL, "_blank");
598
- }
599
- }
600
- }
601
- }
602
- }
603
- }
604
-
605
- private buildQuicklookOverlay(): CustomBranding {
606
- const obj: CustomBranding = {};
607
- if (this.customBranding) Object.assign(obj, this.customBranding);
608
- if (!hasProLicense()) {
609
- console.log("Custom Quicklook banner text requires pro license: https://needle.tools/pricing");
610
- obj.callToAction = "Close";
611
- obj.checkoutTitle = "🌵 Made with Needle";
612
- obj.checkoutSubtitle = "_";
613
- }
614
- const needsDefaultValues = obj.callToAction?.length || obj.checkoutTitle?.length || obj.checkoutSubtitle?.length;
615
- if (needsDefaultValues) {
616
- if (!obj.callToAction?.length)
617
- obj.callToAction = "\0";
618
- if (!obj.checkoutTitle?.length)
619
- obj.checkoutTitle = "\0";
620
- if (!obj.checkoutSubtitle?.length)
621
- obj.checkoutSubtitle = "\0";
622
- }
623
- // Use the quicklook-overlay event to customize the overlay
624
- this.dispatchEvent(new CustomEvent("quicklook-overlay", { detail: obj }));
625
- return obj;
626
- }
627
-
628
- private static invertForwardMatrix = new Matrix4().makeRotationY(Math.PI);
629
- private static invertForwardQuaternion = new Quaternion().setFromEuler(new Euler(0, Math.PI, 0));
630
-
631
- private _rootSessionRootWasAppliedTo: Object3D | null = null;
632
- private _rootPositionBeforeExport: Vector3 = new Vector3();
633
- private _rootRotationBeforeExport: Quaternion = new Quaternion();
634
- private _rootScaleBeforeExport: Vector3 = new Vector3();
635
-
636
- getARScaleAndTarget(): { scale: number, _invertForward: boolean, target: Object3D, sessionRoot: Object3D | null} {
637
- if (!this.objectToExport) return { scale: 1, _invertForward: false, target: this.gameObject, sessionRoot: null};
638
-
639
- const xr = GameObject.findObjectOfType(WebXR);
640
- let sessionRoot = GameObject.getComponentInParent(this.objectToExport, WebARSessionRoot);
641
- if(!sessionRoot) sessionRoot = GameObject.getComponentInChildren(this.objectToExport, WebARSessionRoot);
642
-
643
- let arScale = 1;
644
- let _invertForward = false;
645
- const target = this.objectToExport;
646
-
647
- // Note: when USDZ is exported, SessionRoot might not have the correct AR scale, since that is populated upon EnterXR from WebXR.
648
- if (xr) {
649
- arScale = xr.arScale;
650
- }
651
- else if (sessionRoot) {
652
- arScale = sessionRoot.arScale;
653
- // eslint-disable-next-line deprecation/deprecation
654
- _invertForward = sessionRoot.invertForward;
655
- }
656
-
657
- const scale = 1 / arScale;
658
- const result = { scale, _invertForward, target, sessionRoot: sessionRoot?.gameObject ?? null };
659
- return result;
660
- }
661
-
662
- private applyWebARSessionRoot() {
663
- if (!this.objectToExport) return;
664
-
665
- const { scale, _invertForward, target, sessionRoot } = this.getARScaleAndTarget();
666
- const sessionRootMatrixWorld = sessionRoot?.matrixWorld.clone().invert();
667
-
668
- this._rootSessionRootWasAppliedTo = target;
669
- this._rootPositionBeforeExport.copy(target.position);
670
- this._rootRotationBeforeExport.copy(target.quaternion);
671
- this._rootScaleBeforeExport.copy(target.scale);
672
-
673
- target.scale.multiplyScalar(scale);
674
- if (_invertForward)
675
- target.quaternion.multiply(USDZExporter.invertForwardQuaternion);
676
-
677
- // udate childs as well
678
- target.updateMatrix();
679
- target.updateMatrixWorld(true);
680
- if (sessionRoot && sessionRootMatrixWorld)
681
- target.matrix.premultiply(sessionRootMatrixWorld);
682
- }
683
-
684
- private revertWebARSessionRoot() {
685
- if (!this.objectToExport) return;
686
- if (!this._rootSessionRootWasAppliedTo) return;
687
-
688
- const target = this._rootSessionRootWasAppliedTo;
689
- target.position.copy(this._rootPositionBeforeExport);
690
- target.quaternion.copy(this._rootRotationBeforeExport);
691
- target.scale.copy(this._rootScaleBeforeExport);
692
-
693
- // udate childs as well
694
- target.updateMatrix();
695
- target.updateMatrixWorld(true);
696
- this._rootSessionRootWasAppliedTo = null;
697
- }
698
-
699
- private createQuicklookButton() {
700
- const buttoncontainer = WebXRButtonFactory.getOrCreate();
701
- const button = buttoncontainer.createQuicklookButton();
702
- if(!button.parentNode) this.context.menu.appendChild(button);
703
- return button;
704
- }
705
- }
1
+ import { NEEDLE_progressive } from "@needle-tools/gltf-progressive";
2
+ import { Euler, Matrix4, Mesh, Object3D, Quaternion, Vector3 } from "three";
3
+
4
+ import { isDevEnvironment, showBalloonMessage, showBalloonWarning } from "../../../engine/debug/index.js";
5
+ import { hasProLicense } from "../../../engine/engine_license.js";
6
+ import { serializable } from "../../../engine/engine_serialization.js";
7
+ import { getFormattedDate, Progress } from "../../../engine/engine_time_utils.js";
8
+ import { DeviceUtilities, getParam } from "../../../engine/engine_utils.js";
9
+ import { WebXRButtonFactory } from "../../../engine/webcomponents/WebXRButtons.js";
10
+ import { InternalUSDZRegistry } from "../../../engine/xr/usdz.js"
11
+ import { InstancingHandler } from "../../../engine-components/RendererInstancing.js";
12
+ import { Collider } from "../../Collider.js";
13
+ import { Behaviour, GameObject } from "../../Component.js";
14
+ import { ContactShadows } from "../../ContactShadows.js";
15
+ import { GroundProjectedEnv } from "../../GroundProjection.js";
16
+ import { Renderer } from "../../Renderer.js"
17
+ import { Rigidbody } from "../../RigidBody.js";
18
+ import { SpriteRenderer } from "../../SpriteRenderer.js";
19
+ import { WebARSessionRoot } from "../../webxr/WebARSessionRoot.js";
20
+ import { WebXR } from "../../webxr/WebXR.js";
21
+ import { XRState, XRStateFlag } from "../../webxr/XRFlag.js";
22
+ import type { IUSDExporterExtension } from "./Extension.js";
23
+ import { AnimationExtension } from "./extensions/Animation.js"
24
+ import { AudioExtension } from "./extensions/behavior/AudioExtension.js";
25
+ import { BehaviorExtension } from "./extensions/behavior/Behaviour.js";
26
+ import { PhysicsExtension } from "./extensions/behavior/PhysicsExtension.js"
27
+ import { TextExtension } from "./extensions/USDZText.js";
28
+ import { USDZUIExtension } from "./extensions/USDZUI.js";
29
+ import { USDZExporter as ThreeUSDZExporter } from "./ThreeUSDZExporter.js";
30
+ import { disableObjectsAtStart, registerAnimatorsImplictly, registerAudioSourcesImplictly } from "./utils/animationutils.js";
31
+ import { ensureQuicklookLinkIsCreated } from "./utils/quicklook.js";
32
+
33
+ const debug = getParam("debugusdz");
34
+ const debugUsdzPruning = getParam("debugusdzpruning");
35
+
36
+ /**
37
+ * Custom branding for the QuickLook overlay, used by {@link USDZExporter}.
38
+ */
39
+ export class CustomBranding {
40
+ /** The call to action button text. If not set, the button will close the QuickLook overlay. */
41
+ @serializable()
42
+ callToAction?: string;
43
+ /** The title of the overlay. */
44
+ @serializable()
45
+ checkoutTitle?: string;
46
+ /** The subtitle of the overlay. */
47
+ @serializable()
48
+ checkoutSubtitle?: string;
49
+
50
+ /** if assigned the call to action button in quicklook will open the URL. Otherwise it will just close quicklook. */
51
+ @serializable()
52
+ callToActionURL?: string;
53
+ }
54
+
55
+ /**
56
+ * Exports the current scene or a specific object as USDZ file and opens it in QuickLook on iOS/iPadOS/visionOS.
57
+ * The USDZ file is generated using the Needle Engine ThreeUSDZExporter.
58
+ * The exporter supports various extensions to add custom behaviors and interactions to the USDZ file.
59
+ * The exporter can automatically collect Animations and AudioSources and export them as playing at the start.
60
+ * The exporter can also add a custom QuickLook overlay with a call to action button and custom branding.
61
+ * @example
62
+ * ```typescript
63
+ * const usdz = new USDZExporter();
64
+ * usdz.objectToExport = myObject;
65
+ * usdz.autoExportAnimations = true;
66
+ * usdz.autoExportAudioSources = true;
67
+ * usdz.exportAsync();
68
+ * ```
69
+ * @category XR
70
+ * @group Components
71
+ */
72
+ export class USDZExporter extends Behaviour {
73
+
74
+ /**
75
+ * Assign the object to export as USDZ file. If undefined or null, the whole scene will be exported.
76
+ */
77
+ @serializable(Object3D)
78
+ objectToExport: Object3D | null | undefined = undefined;
79
+
80
+ /** Collect all Animations/Animators automatically on export and emit them as playing at the start.
81
+ * Animator state chains and loops will automatically be collected and exported in order as well.
82
+ * If this setting is off, Animators need to be registered by components – for example from PlayAnimationOnClick.
83
+ */
84
+ @serializable()
85
+ autoExportAnimations: boolean = true;
86
+
87
+ /** Collect all AudioSources automatically on export and emit them as playing at the start.
88
+ * They will loop according to their settings.
89
+ * If this setting is off, Audio Sources need to be registered by components – for example from PlayAudioOnClick.
90
+ */
91
+ @serializable()
92
+ autoExportAudioSources: boolean = true;
93
+
94
+ @serializable()
95
+ exportFileName: string | null | undefined = undefined;
96
+
97
+ @serializable(URL)
98
+ customUsdzFile: string | null | undefined = undefined;
99
+
100
+ @serializable(CustomBranding)
101
+ customBranding?: CustomBranding;
102
+
103
+ // Currently not exposed to integrations - not fully tested. Set from code (e.g. image tracking)
104
+ @serializable()
105
+ anchoringType: "plane" | "image" | "face" | "none" = "plane";
106
+
107
+ @serializable()
108
+ maxTextureSize: 256 | 512 | 1024 | 2048 | 4096 | 8192 = 2048;
109
+
110
+ // Currently not exposed to integrations - not fully tested. Set from code (e.g. image tracking)
111
+ @serializable()
112
+ planeAnchoringAlignment: "horizontal" | "vertical" | "any" = "horizontal";
113
+
114
+ /** Enabling this option will export QuickLook-specific preliminary behaviours along with the USDZ files.
115
+ * These extensions are only supported on QuickLook on iOS/visionOS/MacOS.
116
+ * Keep this option off for general USDZ usage.
117
+ */
118
+ @serializable()
119
+ interactive: boolean = true;
120
+
121
+ /** Enabling this option will export the USDZ file with RealityKit physics components.
122
+ * Rigidbody and Collider components will be converted to their RealityKit counterparts.
123
+ * Physics are supported on QuickLook in iOS 18+ and VisionOS 1+.
124
+ * Physics export is automatically turned off when there are no Rigidbody components anywhere on the exported object.
125
+ */
126
+ @serializable()
127
+ physics: boolean = true;
128
+
129
+ @serializable()
130
+ allowCreateQuicklookButton: boolean = true;
131
+
132
+ @serializable()
133
+ quickLookCompatible: boolean = true;
134
+
135
+ /**
136
+ * Extensions to add custom behaviors and interactions to the USDZ file.
137
+ * You can add your own extensions here by extending {@link IUSDExporterExtension}.
138
+ */
139
+ extensions: IUSDExporterExtension[] = [];
140
+
141
+ private link!: HTMLAnchorElement;
142
+ private button?: HTMLButtonElement;
143
+
144
+ /** @internal */
145
+ start() {
146
+ if (debug) {
147
+ console.log("USDZExporter", this);
148
+ console.log("Debug USDZ Mode. Press 'T' to export")
149
+ window.addEventListener("keydown", (evt) => {
150
+ switch (evt.key) {
151
+ case "t":
152
+ this.exportAndOpen();
153
+ break;
154
+ }
155
+ });
156
+ }
157
+
158
+ // fall back to this object or to the scene if it's empty and doesn't have a mesh
159
+ if (!this.objectToExport)
160
+ this.objectToExport = this.gameObject;
161
+ if (!this.objectToExport?.children?.length && !(this.objectToExport as Mesh)?.isMesh)
162
+ this.objectToExport = this.context.scene;
163
+ }
164
+
165
+ /** @internal */
166
+ onEnable() {
167
+ const supportsQuickLook = DeviceUtilities.supportsQuickLookAR();
168
+ const ios = DeviceUtilities.isiOS() || DeviceUtilities.isiPad();
169
+ if (!this.button && (debug || supportsQuickLook || ios)) {
170
+ if (this.allowCreateQuicklookButton)
171
+ this.button = this.createQuicklookButton();
172
+
173
+ this.lastCallback = this.quicklookCallback.bind(this);
174
+ this.link = ensureQuicklookLinkIsCreated(this.context, supportsQuickLook);
175
+ this.link.addEventListener('message', this.lastCallback);
176
+ }
177
+ if (debug)
178
+ showBalloonMessage("USDZ Exporter enabled: " + this.name);
179
+
180
+ document.getElementById("open-in-ar")?.addEventListener("click", this.onClickedOpenInARElement);
181
+ InternalUSDZRegistry.registerExporter(this);
182
+ }
183
+
184
+ /** @internal */
185
+ onDisable() {
186
+ this.button?.remove();
187
+ this.link?.removeEventListener('message', this.lastCallback);
188
+ if (debug)
189
+ showBalloonMessage("USDZ Exporter disabled: " + this.name);
190
+
191
+ document.getElementById("open-in-ar")?.removeEventListener("click", this.onClickedOpenInARElement);
192
+ InternalUSDZRegistry.unregisterExporter(this);
193
+ }
194
+
195
+ private onClickedOpenInARElement = (evt) => {
196
+ evt.preventDefault();
197
+ this.exportAndOpen();
198
+ }
199
+
200
+ /**
201
+ * Creates an USDZ file from the current scene or assigned objectToExport and opens it in QuickLook.
202
+ * Use the various public properties of USDZExporter to customize export behaviour.
203
+ * @deprecated use {@link exportAndOpen} instead
204
+ */
205
+ async exportAsync() {
206
+ return this.exportAndOpen();
207
+ }
208
+
209
+ /**
210
+ * Creates an USDZ file from the current scene or assigned objectToExport and opens it in QuickLook.
211
+ * @returns a Promise<Blob> containing the USDZ file
212
+ */
213
+ async exportAndOpen() : Promise<Blob | null> {
214
+
215
+ let name = this.exportFileName ?? this.objectToExport?.name ?? this.name;
216
+ name += "-" + getFormattedDate(); // seems iOS caches the file in some cases, this ensures we always have a fresh file
217
+
218
+ if (!hasProLicense()) {
219
+ if (name !== "") name += "-";
220
+ name += "MadeWithNeedle";
221
+ }
222
+
223
+ if (!this.link) this.link = ensureQuicklookLinkIsCreated(this.context, DeviceUtilities.supportsQuickLookAR());
224
+
225
+ // ability to specify a custom USDZ file to be used instead of a dynamic one
226
+ if (this.customUsdzFile) {
227
+ if (debug) console.log("Exporting custom usdz", this.customUsdzFile)
228
+ this.openInQuickLook(this.customUsdzFile, name);
229
+ return null;
230
+ }
231
+
232
+ if (!this.objectToExport) {
233
+ console.warn("No object to export", this);
234
+ return null;
235
+ }
236
+
237
+ const blob = await this.export(this.objectToExport);
238
+ if (!blob) {
239
+ console.error("USDZ generation failed. Please report a bug", this);
240
+ return null;
241
+ }
242
+
243
+ if (debug) console.log("USDZ generation done. Downloading as " + name);
244
+
245
+ // TODO Potentially we have to detect QuickLook availability here,
246
+ // and download the file instead. But browsers keep changing how they deal with non-user-initiated downloads...
247
+ // https://webkit.org/blog/8421/viewing-augmented-reality-assets-in-safari-for-ios/#:~:text=inside%20the%20anchor.-,Feature%20Detection,-To%20detect%20support
248
+ /*
249
+ if (!DeviceUtilities.supportsQuickLookAR())
250
+ this.download(blob, name);
251
+ else
252
+ */
253
+ this.openInQuickLook(blob, name);
254
+
255
+ return blob;
256
+ }
257
+
258
+ /**
259
+ * Creates an USDZ file from the current scene or assigned objectToExport and opens it in QuickLook.
260
+ * @returns a Promise<Blob> containing the USDZ file
261
+ */
262
+ async export(objectToExport: Object3D | undefined): Promise<Blob | null> {
263
+ // make sure we have an object to export
264
+ if (!objectToExport) {
265
+ console.warn("No object to export");
266
+ return null;
267
+ }
268
+
269
+ // if we are already exporting, wait for the current export to finish
270
+ const taskForThisObject = this._currentExportTasks.get(objectToExport);
271
+ if (taskForThisObject) {
272
+ return taskForThisObject;
273
+ }
274
+
275
+ // start the export
276
+ const task = this.internalExport(objectToExport);
277
+ // store the task
278
+ if (task instanceof Promise) {
279
+ this._currentExportTasks.set(objectToExport, task);
280
+ return task.then((blob) => {
281
+ this._currentExportTasks.delete(objectToExport);
282
+ return blob;
283
+ }).catch((e) => {
284
+ this._currentExportTasks.delete(objectToExport);
285
+ console.error("Error during USDZ export – please report a bug!", e);
286
+ return null;
287
+ });
288
+ }
289
+
290
+ return task;
291
+ }
292
+
293
+ private readonly _currentExportTasks = new Map<Object3D, Promise<Blob | null>>();
294
+ private _previousTimeScale: number = 1;
295
+
296
+ private async internalExport(objectToExport: Object3D): Promise<Blob | null> {
297
+
298
+ Progress.start("export-usdz", {
299
+ onProgress: (progress) => {
300
+ this.dispatchEvent(new CustomEvent("export-progress", { detail: { progress } }));
301
+ }
302
+ });
303
+ Progress.report("export-usdz", { message: "Starting export", totalSteps: 40, currentStep: 0 });
304
+ Progress.report("export-usdz", { message: "Load progressive textures", autoStep: 5 });
305
+ Progress.start("export-usdz-textures", "export-usdz");
306
+
307
+ // force Sprites to be created
308
+ const sprites = GameObject.getComponentsInChildren(objectToExport, SpriteRenderer);
309
+ for (const sprite of sprites) {
310
+ if (sprite && sprite.enabled) {
311
+ sprite.updateSprite(true); // force create
312
+ }
313
+ }
314
+
315
+ // trigger progressive textures to be loaded:
316
+ const renderers = GameObject.getComponentsInChildren(objectToExport, Renderer);
317
+ const progressiveLoading = new Array<Promise<any>>();
318
+ let progressiveTasks = 0;
319
+ // TODO: it would be better to directly integrate this into the exporter and *on export* request the correct LOD level for textures and meshes instead of relying on the renderer etc
320
+ for (const rend of renderers) {
321
+ for (const mesh of rend.sharedMeshes) {
322
+ if (mesh) {
323
+ const task = NEEDLE_progressive.assignMeshLOD(mesh, 0);
324
+ if (task instanceof Promise)
325
+ progressiveLoading.push(new Promise<void>((resolve, reject) => {
326
+ task.then(() => {
327
+ progressiveTasks++;
328
+ Progress.report("export-usdz-textures", { message: "Loaded progressive mesh", currentStep: progressiveTasks, totalSteps: progressiveLoading.length });
329
+ resolve();
330
+ }).catch((err) => reject(err));
331
+ }));
332
+ }
333
+ }
334
+ for (const mat of rend.sharedMaterials) {
335
+ if (mat) {
336
+ const task = NEEDLE_progressive.assignTextureLOD(mat, 0);
337
+ if (task instanceof Promise)
338
+ progressiveLoading.push(new Promise<void>((resolve, reject) => {
339
+ task.then(() => {
340
+ progressiveTasks++;
341
+ Progress.report("export-usdz-textures", { message: "Loaded progressive texture", currentStep: progressiveTasks, totalSteps: progressiveLoading.length });
342
+ resolve();
343
+ }).catch((err) => reject(err));
344
+ }));
345
+ }
346
+ }
347
+ }
348
+ if (debug) showBalloonMessage("Progressive Loading: " + progressiveLoading.length);
349
+ await Promise.all(progressiveLoading);
350
+ if (debug) showBalloonMessage("Progressive Loading: done");
351
+ Progress.end("export-usdz-textures");
352
+
353
+ // apply XRFlags
354
+ const currentXRState = XRState.Global.Mask;
355
+ XRState.Global.Set(XRStateFlag.AR);
356
+
357
+ const exporter = new ThreeUSDZExporter();
358
+ // We're creating a new animation extension on each export to avoid issues with multiple exports.
359
+ // TODO we probably want to do that with all the extensions...
360
+ // Ordering of extensions is important
361
+ const animExt = new AnimationExtension(this.quickLookCompatible);
362
+ let physicsExt: PhysicsExtension | undefined = undefined;
363
+ const defaultExtensions: IUSDExporterExtension[] = [];
364
+ if (this.interactive) {
365
+ defaultExtensions.push(new BehaviorExtension());
366
+ defaultExtensions.push(new AudioExtension());
367
+
368
+ // If physics are enabled, and there are any Rigidbody components in the scene,
369
+ // add the PhysicsExtension to the default extensions.
370
+ if (globalThis["NEEDLE_USE_RAPIER"]) {
371
+ const rigidbodies = GameObject.getComponentsInChildren(objectToExport, Rigidbody);
372
+ if (rigidbodies.length > 0) {
373
+ if (this.physics) {
374
+ physicsExt = new PhysicsExtension();
375
+ defaultExtensions.push(physicsExt);
376
+ }
377
+ else if (isDevEnvironment()) {
378
+ console.warn("USDZExporter: Physics export is disabled, but there are active Rigidbody components in the scene. They will not be exported.");
379
+ }
380
+ }
381
+ }
382
+ defaultExtensions.push(new TextExtension());
383
+ defaultExtensions.push(new USDZUIExtension());
384
+ }
385
+ const extensions: any = [animExt, ...defaultExtensions, ...this.extensions];
386
+
387
+ const eventArgs = { self: this, exporter: exporter, extensions: extensions, object: objectToExport };
388
+ Progress.report("export-usdz", "Invoking before-export");
389
+ this.dispatchEvent(new CustomEvent("before-export", { detail: eventArgs }));
390
+
391
+ // make sure we apply the AR scale
392
+ this.applyWebARSessionRoot();
393
+
394
+ // freeze time
395
+ this._previousTimeScale = this.context.time.timeScale;
396
+ this.context.time.timeScale = 0;
397
+
398
+ // Implicit registration and actions for Animators and Animation components
399
+ // Currently, Animators properly build PlayAnimation actions, but Animation components don't.
400
+
401
+ Progress.report("export-usdz", "auto export animations and audio sources");
402
+ const implicitBehaviors = new Array<Object3D>();
403
+ if (this.autoExportAnimations) {
404
+ implicitBehaviors.push(...registerAnimatorsImplictly(objectToExport, animExt));
405
+ }
406
+ const audioExt = extensions.find(ext => ext.extensionName === "Audio");
407
+ if (audioExt && this.autoExportAudioSources)
408
+ implicitBehaviors.push(...registerAudioSourcesImplictly(objectToExport, audioExt as AudioExtension));
409
+
410
+ //@ts-ignore
411
+ exporter.debug = debug;
412
+ exporter.pruneUnusedNodes = !debugUsdzPruning;
413
+ const instancedRenderers = InstancingHandler.instance.objs.map(x => x.batchedMesh);
414
+ exporter.keepObject = (object) => {
415
+ let keep = true;
416
+ // This explicitly removes geometry and material data from disabled renderers.
417
+ // Note that this is different to the object itself being active –
418
+ // here, we have an active object with a disabled renderer.
419
+ const renderer = GameObject.getComponent(object, Renderer);
420
+ if (renderer && !renderer.enabled) keep = false;
421
+ // Check if this is an instancing container.
422
+ // Instances are already included in the export.
423
+ if (keep && instancedRenderers.includes(object as any)) keep = false;
424
+ if (keep && GameObject.getComponentInParent(object, ContactShadows)) keep = false;
425
+ if (keep && GameObject.getComponentInParent(object, GroundProjectedEnv)) keep = false;
426
+ if (debug && !keep) console.log("USDZExporter: Discarding object", object);
427
+ return keep;
428
+ }
429
+
430
+ exporter.beforeWritingDocument = () => {
431
+ // Warn if there are any physics components on animated objects or their children
432
+ if (isDevEnvironment() && animExt && physicsExt) {
433
+ const animatedObjects = animExt.animatedRoots;
434
+ for (const object of animatedObjects) {
435
+ const rigidBodySources = GameObject.getComponentsInChildren(object, Rigidbody).filter(c => c.enabled);
436
+ const colliderSources = GameObject.getComponents(object, Collider).filter(c => c.enabled && !c.isTrigger);
437
+ if (rigidBodySources.length > 0 || colliderSources.length > 0) {
438
+ console.error("An animated object has physics components in its child hierarchy. This can lead to undefined behaviour due to a bug in Apple's QuickLook (FB15925487). Remove the physics components from child objects or verify that you get the expected results.", object);
439
+ }
440
+ }
441
+ }
442
+ };
443
+
444
+ // Collect invisible objects so that we can disable them if
445
+ // - we're exporting for QuickLook
446
+ // - and interactive behaviors are allowed.
447
+ // When exporting for regular USD, we're supporting the "visibility" attribute anyways.
448
+ const objectsToDisableAtSceneStart = new Array<Object3D>();
449
+ if (this.objectToExport && this.quickLookCompatible && this.interactive) {
450
+ this.objectToExport.traverse((obj) => {
451
+ if (!obj.visible) {
452
+ objectsToDisableAtSceneStart.push(obj);
453
+ }
454
+ });
455
+ }
456
+
457
+ const behaviorExt = extensions.find(ext => ext.extensionName === "Behaviour") as BehaviorExtension | undefined;
458
+ if (this.interactive && behaviorExt && objectsToDisableAtSceneStart.length > 0) {
459
+ behaviorExt.addBehavior(disableObjectsAtStart(objectsToDisableAtSceneStart));
460
+ }
461
+
462
+ let exportInvisible = true;
463
+ // The only case where we want to strip out invisible objects is
464
+ // when we're exporting for QuickLook and we're NOT adding interactive behaviors,
465
+ // since QuickLook on iOS does not support "visibility" tokens.
466
+ if (this.quickLookCompatible && !this.interactive)
467
+ exportInvisible = false;
468
+
469
+ // sanitize anchoring types
470
+ if (this.anchoringType !== "plane" && this.anchoringType !== "none" && this.anchoringType !== "image" && this.anchoringType !== "face")
471
+ this.anchoringType = "plane";
472
+ if (this.planeAnchoringAlignment !== "horizontal" && this.planeAnchoringAlignment !== "vertical" && this.planeAnchoringAlignment !== "any")
473
+ this.planeAnchoringAlignment = "horizontal";
474
+
475
+ Progress.report("export-usdz", "Invoking exporter.parse");
476
+
477
+ //@ts-ignore
478
+ const arraybuffer = await exporter.parse(this.objectToExport, {
479
+ ar: {
480
+ anchoring: {
481
+ type: this.anchoringType,
482
+ },
483
+ planeAnchoring: {
484
+ alignment: this.planeAnchoringAlignment,
485
+ },
486
+ },
487
+ extensions: extensions,
488
+ quickLookCompatible: this.quickLookCompatible,
489
+ maxTextureSize: this.maxTextureSize,
490
+ exportInvisible: exportInvisible,
491
+ });
492
+
493
+ const blob = new Blob([arraybuffer], { type: 'model/vnd.usdz+zip' });
494
+
495
+ this.revertWebARSessionRoot();
496
+
497
+ // unfreeze time
498
+ this.context.time.timeScale = this._previousTimeScale;
499
+
500
+ Progress.report("export-usdz", "Invoking after-export");
501
+
502
+ this.dispatchEvent(new CustomEvent("after-export", { detail: eventArgs }))
503
+
504
+ // cleanup – implicit animation behaviors need to be removed again
505
+ for (const go of implicitBehaviors) {
506
+ GameObject.destroy(go);
507
+ }
508
+
509
+ // restore XR flags
510
+ XRState.Global.Set(currentXRState);
511
+
512
+ // second file: USDA (without assets)
513
+ //@ts-ignore
514
+ // const usda = exporter.lastUsda;
515
+ // const blob2 = new Blob([usda], { type: 'text/plain' });
516
+ // this.link.download = name + ".usda";
517
+ // this.link.href = URL.createObjectURL(blob2);
518
+ // this.link.click();
519
+
520
+ Progress.end("export-usdz");
521
+ return blob;
522
+ }
523
+
524
+ /**
525
+ * Opens QuickLook on iOS/iPadOS/visionOS with the given content in AR mode.
526
+ * @param content The URL to the .usdz or .reality file or a blob containing an USDZ file.
527
+ * @param name Download filename
528
+ */
529
+ openInQuickLook(content: Blob | string, name: string) {
530
+
531
+ const url = content instanceof Blob ? URL.createObjectURL(content) : content;
532
+
533
+ // see https://developer.apple.com/documentation/arkit/adding_an_apple_pay_button_or_a_custom_action_in_ar_quick_look
534
+ const overlay = this.buildQuicklookOverlay();
535
+ if (debug) console.log("QuickLook Overlay", overlay);
536
+ const callToAction = overlay.callToAction ? encodeURIComponent(overlay.callToAction) : "";
537
+ const checkoutTitle = overlay.checkoutTitle ? encodeURIComponent(overlay.checkoutTitle) : "";
538
+ const checkoutSubtitle = overlay.checkoutSubtitle ? encodeURIComponent(overlay.checkoutSubtitle) : "";
539
+ this.link.href = url + `#callToAction=${callToAction}&checkoutTitle=${checkoutTitle}&checkoutSubtitle=${checkoutSubtitle}&callToActionURL=${overlay.callToActionURL}`;
540
+
541
+ if (!this.lastCallback) {
542
+ this.lastCallback = this.quicklookCallback.bind(this)
543
+ this.link.addEventListener('message', this.lastCallback);
544
+ }
545
+
546
+ // Open QuickLook
547
+ this.link.download = name + ".usdz";
548
+ this.link.click();
549
+
550
+ // cleanup
551
+ // TODO check if we can do that immediately or need to wait until the user returns
552
+ // if (content instanceof Blob) URL.revokeObjectURL(url);
553
+ }
554
+
555
+ /**
556
+ * Downloads the given blob as a file.
557
+ */
558
+ download(blob: Blob, name: string) {
559
+ USDZExporter.save(blob, name);
560
+ }
561
+
562
+ // Matches GltfExport.save(blob, filename)
563
+ private static save(blob, filename) {
564
+ const link = document.createElement('a');
565
+ link.style.display = 'none';
566
+ document.body.appendChild(link); // Firefox workaround, see #6594
567
+ if (typeof blob === "string")
568
+ link.href = blob;
569
+ else
570
+ link.href = URL.createObjectURL(blob);
571
+ link.download = filename;
572
+ link.click();
573
+ link.remove();
574
+ // console.log(link.href);
575
+ // URL.revokeObjectURL( url ); breaks Firefox...
576
+ }
577
+
578
+
579
+ private lastCallback?: any;
580
+
581
+ private quicklookCallback(event: Event) {
582
+ if ((event as any)?.data == '_apple_ar_quicklook_button_tapped') {
583
+ if (debug) showBalloonWarning("Quicklook closed via call to action button");
584
+ var evt = new CustomEvent("quicklook-button-tapped", { detail: this });
585
+ this.dispatchEvent(evt);
586
+ if (!evt.defaultPrevented) {
587
+ const url = new URLSearchParams(this.link.href);
588
+ if (url) {
589
+ const callToActionURL = url.get("callToActionURL");
590
+ if (debug)
591
+ showBalloonMessage("Quicklook url: " + callToActionURL);
592
+ if (callToActionURL) {
593
+ if (!hasProLicense()) {
594
+ console.warn("Quicklook closed: custom redirects require a Needle Engine Pro license: https://needle.tools/pricing", callToActionURL)
595
+ }
596
+ else {
597
+ globalThis.open(callToActionURL, "_blank");
598
+ }
599
+ }
600
+ }
601
+ }
602
+ }
603
+ }
604
+
605
+ private buildQuicklookOverlay(): CustomBranding {
606
+ const obj: CustomBranding = {};
607
+ if (this.customBranding) Object.assign(obj, this.customBranding);
608
+ if (!hasProLicense()) {
609
+ console.log("Custom Quicklook banner text requires pro license: https://needle.tools/pricing");
610
+ obj.callToAction = "Close";
611
+ obj.checkoutTitle = "🌵 Made with Needle";
612
+ obj.checkoutSubtitle = "_";
613
+ }
614
+ const needsDefaultValues = obj.callToAction?.length || obj.checkoutTitle?.length || obj.checkoutSubtitle?.length;
615
+ if (needsDefaultValues) {
616
+ if (!obj.callToAction?.length)
617
+ obj.callToAction = "\0";
618
+ if (!obj.checkoutTitle?.length)
619
+ obj.checkoutTitle = "\0";
620
+ if (!obj.checkoutSubtitle?.length)
621
+ obj.checkoutSubtitle = "\0";
622
+ }
623
+ // Use the quicklook-overlay event to customize the overlay
624
+ this.dispatchEvent(new CustomEvent("quicklook-overlay", { detail: obj }));
625
+ return obj;
626
+ }
627
+
628
+ private static invertForwardMatrix = new Matrix4().makeRotationY(Math.PI);
629
+ private static invertForwardQuaternion = new Quaternion().setFromEuler(new Euler(0, Math.PI, 0));
630
+
631
+ private _rootSessionRootWasAppliedTo: Object3D | null = null;
632
+ private _rootPositionBeforeExport: Vector3 = new Vector3();
633
+ private _rootRotationBeforeExport: Quaternion = new Quaternion();
634
+ private _rootScaleBeforeExport: Vector3 = new Vector3();
635
+
636
+ getARScaleAndTarget(): { scale: number, _invertForward: boolean, target: Object3D, sessionRoot: Object3D | null} {
637
+ if (!this.objectToExport) return { scale: 1, _invertForward: false, target: this.gameObject, sessionRoot: null};
638
+
639
+ const xr = GameObject.findObjectOfType(WebXR);
640
+ let sessionRoot = GameObject.getComponentInParent(this.objectToExport, WebARSessionRoot);
641
+ if(!sessionRoot) sessionRoot = GameObject.getComponentInChildren(this.objectToExport, WebARSessionRoot);
642
+
643
+ let arScale = 1;
644
+ let _invertForward = false;
645
+ const target = this.objectToExport;
646
+
647
+ // Note: when USDZ is exported, SessionRoot might not have the correct AR scale, since that is populated upon EnterXR from WebXR.
648
+ if (xr) {
649
+ arScale = xr.arScale;
650
+ }
651
+ else if (sessionRoot) {
652
+ arScale = sessionRoot.arScale;
653
+ // eslint-disable-next-line deprecation/deprecation
654
+ _invertForward = sessionRoot.invertForward;
655
+ }
656
+
657
+ const scale = 1 / arScale;
658
+ const result = { scale, _invertForward, target, sessionRoot: sessionRoot?.gameObject ?? null };
659
+ return result;
660
+ }
661
+
662
+ private applyWebARSessionRoot() {
663
+ if (!this.objectToExport) return;
664
+
665
+ const { scale, _invertForward, target, sessionRoot } = this.getARScaleAndTarget();
666
+ const sessionRootMatrixWorld = sessionRoot?.matrixWorld.clone().invert();
667
+
668
+ this._rootSessionRootWasAppliedTo = target;
669
+ this._rootPositionBeforeExport.copy(target.position);
670
+ this._rootRotationBeforeExport.copy(target.quaternion);
671
+ this._rootScaleBeforeExport.copy(target.scale);
672
+
673
+ target.scale.multiplyScalar(scale);
674
+ if (_invertForward)
675
+ target.quaternion.multiply(USDZExporter.invertForwardQuaternion);
676
+
677
+ // udate childs as well
678
+ target.updateMatrix();
679
+ target.updateMatrixWorld(true);
680
+ if (sessionRoot && sessionRootMatrixWorld)
681
+ target.matrix.premultiply(sessionRootMatrixWorld);
682
+ }
683
+
684
+ private revertWebARSessionRoot() {
685
+ if (!this.objectToExport) return;
686
+ if (!this._rootSessionRootWasAppliedTo) return;
687
+
688
+ const target = this._rootSessionRootWasAppliedTo;
689
+ target.position.copy(this._rootPositionBeforeExport);
690
+ target.quaternion.copy(this._rootRotationBeforeExport);
691
+ target.scale.copy(this._rootScaleBeforeExport);
692
+
693
+ // udate childs as well
694
+ target.updateMatrix();
695
+ target.updateMatrixWorld(true);
696
+ this._rootSessionRootWasAppliedTo = null;
697
+ }
698
+
699
+ private createQuicklookButton() {
700
+ const buttoncontainer = WebXRButtonFactory.getOrCreate();
701
+ const button = buttoncontainer.createQuicklookButton();
702
+ if(!button.parentNode) this.context.menu.appendChild(button);
703
+ return button;
704
+ }
705
+ }