@needle-tools/engine 4.4.0-beta → 4.4.0-ci.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1046) hide show
  1. package/CHANGELOG.md +3604 -3604
  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 +8 -8
  6. package/dist/needle-engine.bundle.light.js +8 -8
  7. package/dist/needle-engine.bundle.light.min.js +2 -2
  8. package/dist/needle-engine.bundle.light.umd.cjs +2 -2
  9. package/dist/needle-engine.bundle.min.js +2 -2
  10. package/dist/needle-engine.bundle.umd.cjs +2 -2
  11. package/dist/needle-engine.d.ts +130 -138
  12. package/dist/needle-engine.light.d.ts +130 -138
  13. package/dist/postprocessing.js +1673 -1527
  14. package/dist/postprocessing.light.js +1673 -1527
  15. package/dist/postprocessing.light.min.js +80 -66
  16. package/dist/postprocessing.light.umd.cjs +83 -69
  17. package/dist/postprocessing.min.js +80 -66
  18. package/dist/postprocessing.umd.cjs +83 -69
  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 +298 -298
  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_addressables.d.ts +166 -166
  50. package/lib/engine/engine_addressables.js +608 -608
  51. package/lib/engine/engine_animation.d.ts +43 -43
  52. package/lib/engine/engine_animation.js +133 -133
  53. package/lib/engine/engine_application.d.ts +40 -40
  54. package/lib/engine/engine_application.js +104 -104
  55. package/lib/engine/engine_assetdatabase.d.ts +25 -25
  56. package/lib/engine/engine_assetdatabase.js +344 -344
  57. package/lib/engine/engine_audio.d.ts +4 -4
  58. package/lib/engine/engine_audio.js +23 -23
  59. package/lib/engine/engine_camera.d.ts +13 -13
  60. package/lib/engine/engine_camera.js +30 -30
  61. package/lib/engine/engine_components.d.ts +110 -110
  62. package/lib/engine/engine_components.js +380 -380
  63. package/lib/engine/engine_components_internal.d.ts +9 -9
  64. package/lib/engine/engine_components_internal.js +36 -36
  65. package/lib/engine/engine_constants.d.ts +10 -10
  66. package/lib/engine/engine_constants.js +41 -41
  67. package/lib/engine/engine_context.d.ts +345 -345
  68. package/lib/engine/engine_context.js +1515 -1515
  69. package/lib/engine/engine_context_registry.d.ts +71 -71
  70. package/lib/engine/engine_context_registry.js +117 -117
  71. package/lib/engine/engine_coroutine.d.ts +35 -35
  72. package/lib/engine/engine_coroutine.js +52 -52
  73. package/lib/engine/engine_create_objects.d.ts +118 -118
  74. package/lib/engine/engine_create_objects.js +308 -308
  75. package/lib/engine/engine_default_parameters.d.ts +2 -2
  76. package/lib/engine/engine_default_parameters.js +3 -3
  77. package/lib/engine/engine_editor-sync.d.ts +21 -21
  78. package/lib/engine/engine_editor-sync.js +4 -4
  79. package/lib/engine/engine_element.d.ts +113 -113
  80. package/lib/engine/engine_element.js +830 -830
  81. package/lib/engine/engine_element_attributes.d.ts +72 -72
  82. package/lib/engine/engine_element_attributes.js +1 -1
  83. package/lib/engine/engine_element_extras.d.ts +6 -6
  84. package/lib/engine/engine_element_extras.js +13 -13
  85. package/lib/engine/engine_element_loading.d.ts +44 -44
  86. package/lib/engine/engine_element_loading.js +349 -349
  87. package/lib/engine/engine_element_overlay.d.ts +21 -21
  88. package/lib/engine/engine_element_overlay.js +166 -166
  89. package/lib/engine/engine_fileloader.d.ts +2 -2
  90. package/lib/engine/engine_fileloader.js +8 -8
  91. package/lib/engine/engine_gameobject.d.ts +68 -68
  92. package/lib/engine/engine_gameobject.js +591 -591
  93. package/lib/engine/engine_generic_utils.d.ts +1 -1
  94. package/lib/engine/engine_generic_utils.js +13 -13
  95. package/lib/engine/engine_gizmos.d.ts +149 -149
  96. package/lib/engine/engine_gizmos.js +530 -530
  97. package/lib/engine/engine_gltf.d.ts +12 -12
  98. package/lib/engine/engine_gltf.js +15 -15
  99. package/lib/engine/engine_gltf_builtin_components.d.ts +7 -7
  100. package/lib/engine/engine_gltf_builtin_components.js +341 -341
  101. package/lib/engine/engine_hot_reload.d.ts +7 -7
  102. package/lib/engine/engine_hot_reload.js +184 -184
  103. package/lib/engine/engine_input.d.ts +352 -352
  104. package/lib/engine/engine_input.js +1265 -1265
  105. package/lib/engine/engine_input_utils.d.ts +2 -2
  106. package/lib/engine/engine_input_utils.js +22 -22
  107. package/lib/engine/engine_instancing.d.ts +19 -19
  108. package/lib/engine/engine_instancing.js +39 -39
  109. package/lib/engine/engine_license.d.ts +9 -9
  110. package/lib/engine/engine_license.js +320 -320
  111. package/lib/engine/engine_lifecycle_api.d.ts +76 -76
  112. package/lib/engine/engine_lifecycle_api.js +99 -99
  113. package/lib/engine/engine_lifecycle_functions_internal.d.ts +32 -32
  114. package/lib/engine/engine_lifecycle_functions_internal.js +146 -146
  115. package/lib/engine/engine_lightdata.d.ts +23 -23
  116. package/lib/engine/engine_lightdata.js +91 -91
  117. package/lib/engine/engine_loaders.d.ts +13 -13
  118. package/lib/engine/engine_loaders.js +62 -62
  119. package/lib/engine/engine_lods.d.ts +31 -31
  120. package/lib/engine/engine_lods.js +146 -146
  121. package/lib/engine/engine_mainloop_utils.d.ts +32 -32
  122. package/lib/engine/engine_mainloop_utils.js +466 -466
  123. package/lib/engine/engine_math.d.ts +114 -114
  124. package/lib/engine/engine_math.js +247 -247
  125. package/lib/engine/engine_modules.d.ts +36 -36
  126. package/lib/engine/engine_modules.js +85 -85
  127. package/lib/engine/engine_networking.d.ts +252 -252
  128. package/lib/engine/engine_networking.js +743 -743
  129. package/lib/engine/engine_networking_auto.d.ts +24 -24
  130. package/lib/engine/engine_networking_auto.js +310 -310
  131. package/lib/engine/engine_networking_blob.d.ts +48 -48
  132. package/lib/engine/engine_networking_blob.js +212 -212
  133. package/lib/engine/engine_networking_files.d.ts +35 -35
  134. package/lib/engine/engine_networking_files.js +172 -172
  135. package/lib/engine/engine_networking_files_default_components.d.ts +6 -6
  136. package/lib/engine/engine_networking_files_default_components.js +42 -42
  137. package/lib/engine/engine_networking_instantiate.d.ts +100 -100
  138. package/lib/engine/engine_networking_instantiate.js +345 -345
  139. package/lib/engine/engine_networking_peer.d.ts +15 -15
  140. package/lib/engine/engine_networking_peer.js +132 -132
  141. package/lib/engine/engine_networking_streams.d.ts +123 -123
  142. package/lib/engine/engine_networking_streams.js +645 -645
  143. package/lib/engine/engine_networking_types.d.ts +22 -22
  144. package/lib/engine/engine_networking_types.js +7 -7
  145. package/lib/engine/engine_networking_utils.d.ts +2 -2
  146. package/lib/engine/engine_networking_utils.js +20 -20
  147. package/lib/engine/engine_networking_websocket.d.ts +1 -1
  148. package/lib/engine/engine_networking_websocket.js +2 -2
  149. package/lib/engine/engine_patcher.d.ts +10 -10
  150. package/lib/engine/engine_patcher.js +142 -142
  151. package/lib/engine/engine_physics.d.ts +152 -152
  152. package/lib/engine/engine_physics.js +645 -645
  153. package/lib/engine/engine_physics.types.d.ts +40 -40
  154. package/lib/engine/engine_physics.types.js +33 -33
  155. package/lib/engine/engine_physics_rapier.d.ts +147 -147
  156. package/lib/engine/engine_physics_rapier.js +1432 -1432
  157. package/lib/engine/engine_playerview.d.ts +26 -26
  158. package/lib/engine/engine_playerview.js +64 -64
  159. package/lib/engine/engine_scenelighting.d.ts +71 -71
  160. package/lib/engine/engine_scenelighting.js +226 -226
  161. package/lib/engine/engine_scenetools.d.ts +50 -50
  162. package/lib/engine/engine_scenetools.js +321 -321
  163. package/lib/engine/engine_serialization.d.ts +3 -3
  164. package/lib/engine/engine_serialization.js +3 -3
  165. package/lib/engine/engine_serialization_builtin_serializer.d.ts +72 -72
  166. package/lib/engine/engine_serialization_builtin_serializer.js +403 -403
  167. package/lib/engine/engine_serialization_core.d.ts +85 -85
  168. package/lib/engine/engine_serialization_core.js +602 -602
  169. package/lib/engine/engine_serialization_decorator.d.ts +23 -23
  170. package/lib/engine/engine_serialization_decorator.js +66 -66
  171. package/lib/engine/engine_setup.d.ts +1 -1
  172. package/lib/engine/engine_setup.js +2 -2
  173. package/lib/engine/engine_shaders.d.ts +53 -53
  174. package/lib/engine/engine_shaders.js +252 -252
  175. package/lib/engine/engine_shims.d.ts +4 -4
  176. package/lib/engine/engine_shims.js +24 -24
  177. package/lib/engine/engine_test_utils.d.ts +39 -39
  178. package/lib/engine/engine_test_utils.js +83 -83
  179. package/lib/engine/engine_texture.d.ts +28 -28
  180. package/lib/engine/engine_texture.js +64 -64
  181. package/lib/engine/engine_three_utils.d.ts +201 -201
  182. package/lib/engine/engine_three_utils.js +731 -731
  183. package/lib/engine/engine_time.d.ts +51 -51
  184. package/lib/engine/engine_time.js +82 -82
  185. package/lib/engine/engine_time_utils.d.ts +88 -88
  186. package/lib/engine/engine_time_utils.js +215 -215
  187. package/lib/engine/engine_tonemapping.d.ts +2 -2
  188. package/lib/engine/engine_tonemapping.js +194 -194
  189. package/lib/engine/engine_types.d.ts +572 -572
  190. package/lib/engine/engine_types.js +88 -88
  191. package/lib/engine/engine_typestore.d.ts +28 -28
  192. package/lib/engine/engine_typestore.js +55 -55
  193. package/lib/engine/engine_util_decorator.d.ts +13 -13
  194. package/lib/engine/engine_util_decorator.js +116 -116
  195. package/lib/engine/engine_utils.d.ts +266 -266
  196. package/lib/engine/engine_utils.js +878 -878
  197. package/lib/engine/engine_utils_format.d.ts +21 -21
  198. package/lib/engine/engine_utils_format.js +193 -193
  199. package/lib/engine/engine_utils_screenshot.d.ts +159 -159
  200. package/lib/engine/engine_utils_screenshot.js +513 -513
  201. package/lib/engine/engine_utils_screenshot.xr.d.ts +5 -5
  202. package/lib/engine/engine_utils_screenshot.xr.js +90 -90
  203. package/lib/engine/engine_xr.d.ts +1 -1
  204. package/lib/engine/engine_xr.js +1 -1
  205. package/lib/engine/export/gltf/Writers.d.ts +19 -19
  206. package/lib/engine/export/gltf/Writers.js +24 -24
  207. package/lib/engine/export/gltf/index.d.ts +11 -11
  208. package/lib/engine/export/gltf/index.js +123 -123
  209. package/lib/engine/export/index.d.ts +2 -2
  210. package/lib/engine/export/index.js +2 -2
  211. package/lib/engine/export/state.d.ts +7 -7
  212. package/lib/engine/export/state.js +17 -17
  213. package/lib/engine/export/utils.d.ts +2 -2
  214. package/lib/engine/export/utils.js +7 -7
  215. package/lib/engine/extensions/EXT_texture_exr.d.ts +8 -8
  216. package/lib/engine/extensions/EXT_texture_exr.js +32 -32
  217. package/lib/engine/extensions/NEEDLE_animator_controller_model.d.ts +122 -122
  218. package/lib/engine/extensions/NEEDLE_animator_controller_model.js +95 -95
  219. package/lib/engine/extensions/NEEDLE_components.d.ts +35 -35
  220. package/lib/engine/extensions/NEEDLE_components.js +220 -220
  221. package/lib/engine/extensions/NEEDLE_gameobject_data.d.ts +10 -10
  222. package/lib/engine/extensions/NEEDLE_gameobject_data.js +57 -57
  223. package/lib/engine/extensions/NEEDLE_lighting_settings.d.ts +37 -37
  224. package/lib/engine/extensions/NEEDLE_lighting_settings.js +157 -157
  225. package/lib/engine/extensions/NEEDLE_lightmaps.d.ts +18 -18
  226. package/lib/engine/extensions/NEEDLE_lightmaps.js +99 -99
  227. package/lib/engine/extensions/NEEDLE_persistent_assets.d.ts +11 -11
  228. package/lib/engine/extensions/NEEDLE_persistent_assets.js +63 -63
  229. package/lib/engine/extensions/NEEDLE_progressive.d.ts +1 -1
  230. package/lib/engine/extensions/NEEDLE_progressive.js +1 -1
  231. package/lib/engine/extensions/NEEDLE_render_objects.d.ts +13 -13
  232. package/lib/engine/extensions/NEEDLE_render_objects.js +159 -159
  233. package/lib/engine/extensions/NEEDLE_techniques_webgl.d.ts +38 -38
  234. package/lib/engine/extensions/NEEDLE_techniques_webgl.js +564 -564
  235. package/lib/engine/extensions/extension_resolver.d.ts +4 -4
  236. package/lib/engine/extensions/extension_resolver.js +1 -1
  237. package/lib/engine/extensions/extension_utils.d.ts +12 -12
  238. package/lib/engine/extensions/extension_utils.js +152 -152
  239. package/lib/engine/extensions/extensions.d.ts +31 -31
  240. package/lib/engine/extensions/extensions.js +103 -103
  241. package/lib/engine/extensions/index.d.ts +6 -6
  242. package/lib/engine/extensions/index.js +6 -6
  243. package/lib/engine/extensions/usage_tracker.d.ts +13 -13
  244. package/lib/engine/extensions/usage_tracker.js +65 -65
  245. package/lib/engine/js-extensions/Camera.d.ts +1 -1
  246. package/lib/engine/js-extensions/Camera.js +39 -39
  247. package/lib/engine/js-extensions/ExtensionUtils.d.ts +9 -9
  248. package/lib/engine/js-extensions/ExtensionUtils.js +67 -67
  249. package/lib/engine/js-extensions/Layers.d.ts +6 -6
  250. package/lib/engine/js-extensions/Layers.js +22 -22
  251. package/lib/engine/js-extensions/Object3D.d.ts +120 -120
  252. package/lib/engine/js-extensions/Object3D.js +136 -136
  253. package/lib/engine/js-extensions/RGBAColor.d.ts +22 -22
  254. package/lib/engine/js-extensions/RGBAColor.js +62 -62
  255. package/lib/engine/js-extensions/Vector.d.ts +3 -3
  256. package/lib/engine/js-extensions/Vector.js +13 -13
  257. package/lib/engine/js-extensions/index.d.ts +5 -5
  258. package/lib/engine/js-extensions/index.js +5 -5
  259. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.d.ts +4 -4
  260. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +75 -75
  261. package/lib/engine/shaders/shaderData.d.ts +55 -55
  262. package/lib/engine/shaders/shaderData.js +58 -58
  263. package/lib/engine/tests/test_utils.d.ts +2 -2
  264. package/lib/engine/tests/test_utils.js +53 -53
  265. package/lib/engine/webcomponents/WebXRButtons.d.ts +56 -56
  266. package/lib/engine/webcomponents/WebXRButtons.js +230 -230
  267. package/lib/engine/webcomponents/api.d.ts +5 -5
  268. package/lib/engine/webcomponents/api.js +4 -4
  269. package/lib/engine/webcomponents/buttons.d.ts +39 -39
  270. package/lib/engine/webcomponents/buttons.js +237 -237
  271. package/lib/engine/webcomponents/fonts.d.ts +9 -9
  272. package/lib/engine/webcomponents/fonts.js +32 -32
  273. package/lib/engine/webcomponents/icons.d.ts +9 -9
  274. package/lib/engine/webcomponents/icons.js +52 -52
  275. package/lib/engine/webcomponents/index.d.ts +1 -1
  276. package/lib/engine/webcomponents/index.js +1 -1
  277. package/lib/engine/webcomponents/logo-element.d.ts +10 -10
  278. package/lib/engine/webcomponents/logo-element.js +67 -67
  279. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.d.ts +37 -37
  280. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.js +513 -513
  281. package/lib/engine/webcomponents/needle menu/needle-menu.d.ts +151 -151
  282. package/lib/engine/webcomponents/needle menu/needle-menu.js +1018 -1018
  283. package/lib/engine/webcomponents/needle-button.d.ts +34 -34
  284. package/lib/engine/webcomponents/needle-button.js +161 -161
  285. package/lib/engine/xr/NeedleXRController.d.ts +313 -313
  286. package/lib/engine/xr/NeedleXRController.js +1008 -1008
  287. package/lib/engine/xr/NeedleXRSession.d.ts +339 -339
  288. package/lib/engine/xr/NeedleXRSession.js +1427 -1427
  289. package/lib/engine/xr/NeedleXRSync.d.ts +22 -22
  290. package/lib/engine/xr/NeedleXRSync.js +188 -188
  291. package/lib/engine/xr/SceneTransition.d.ts +18 -18
  292. package/lib/engine/xr/SceneTransition.js +69 -69
  293. package/lib/engine/xr/TempXRContext.d.ts +34 -34
  294. package/lib/engine/xr/TempXRContext.js +187 -187
  295. package/lib/engine/xr/XRRig.d.ts +7 -7
  296. package/lib/engine/xr/XRRig.js +1 -1
  297. package/lib/engine/xr/api.d.ts +6 -6
  298. package/lib/engine/xr/api.js +6 -6
  299. package/lib/engine/xr/events.d.ts +66 -66
  300. package/lib/engine/xr/events.js +93 -93
  301. package/lib/engine/xr/internal.d.ts +12 -12
  302. package/lib/engine/xr/internal.js +25 -25
  303. package/lib/engine/xr/usdz.d.ts +12 -12
  304. package/lib/engine/xr/usdz.js +29 -29
  305. package/lib/engine/xr/utils.d.ts +11 -11
  306. package/lib/engine/xr/utils.js +34 -34
  307. package/lib/engine-components/AlignmentConstraint.d.ts +10 -10
  308. package/lib/engine-components/AlignmentConstraint.js +39 -39
  309. package/lib/engine-components/Animation.d.ts +156 -156
  310. package/lib/engine-components/Animation.js +508 -508
  311. package/lib/engine-components/AnimationCurve.d.ts +40 -40
  312. package/lib/engine-components/AnimationCurve.js +159 -159
  313. package/lib/engine-components/AnimationUtils.d.ts +8 -8
  314. package/lib/engine-components/AnimationUtils.js +27 -27
  315. package/lib/engine-components/AnimationUtilsAutoplay.d.ts +1 -1
  316. package/lib/engine-components/AnimationUtilsAutoplay.js +39 -39
  317. package/lib/engine-components/Animator.d.ts +217 -217
  318. package/lib/engine-components/Animator.js +354 -354
  319. package/lib/engine-components/AnimatorController.d.ts +227 -227
  320. package/lib/engine-components/AnimatorController.js +1152 -1152
  321. package/lib/engine-components/AudioListener.d.ts +33 -33
  322. package/lib/engine-components/AudioListener.js +86 -86
  323. package/lib/engine-components/AudioSource.d.ts +217 -217
  324. package/lib/engine-components/AudioSource.js +627 -627
  325. package/lib/engine-components/AvatarLoader.d.ts +80 -80
  326. package/lib/engine-components/AvatarLoader.js +231 -231
  327. package/lib/engine-components/AxesHelper.d.ts +32 -32
  328. package/lib/engine-components/AxesHelper.js +67 -67
  329. package/lib/engine-components/BasicIKConstraint.d.ts +9 -9
  330. package/lib/engine-components/BasicIKConstraint.js +43 -43
  331. package/lib/engine-components/BoxCollider.d.ts +2 -2
  332. package/lib/engine-components/BoxCollider.js +2 -2
  333. package/lib/engine-components/BoxHelperComponent.d.ts +47 -47
  334. package/lib/engine-components/BoxHelperComponent.js +102 -102
  335. package/lib/engine-components/Camera.d.ts +231 -231
  336. package/lib/engine-components/Camera.js +694 -694
  337. package/lib/engine-components/CameraUtils.d.ts +1 -1
  338. package/lib/engine-components/CameraUtils.js +127 -127
  339. package/lib/engine-components/CharacterController.d.ts +55 -55
  340. package/lib/engine-components/CharacterController.js +236 -236
  341. package/lib/engine-components/Collider.d.ts +188 -188
  342. package/lib/engine-components/Collider.js +369 -369
  343. package/lib/engine-components/Component.d.ts +792 -792
  344. package/lib/engine-components/Component.js +915 -915
  345. package/lib/engine-components/ContactShadows.d.ts +82 -82
  346. package/lib/engine-components/ContactShadows.js +430 -430
  347. package/lib/engine-components/DeleteBox.d.ts +19 -19
  348. package/lib/engine-components/DeleteBox.js +58 -58
  349. package/lib/engine-components/DeviceFlag.d.ts +16 -16
  350. package/lib/engine-components/DeviceFlag.js +47 -47
  351. package/lib/engine-components/DragControls.d.ts +170 -170
  352. package/lib/engine-components/DragControls.js +1421 -1421
  353. package/lib/engine-components/DropListener.d.ts +215 -215
  354. package/lib/engine-components/DropListener.js +630 -630
  355. package/lib/engine-components/Duplicatable.d.ts +35 -35
  356. package/lib/engine-components/Duplicatable.js +202 -202
  357. package/lib/engine-components/EventList.d.ts +54 -54
  358. package/lib/engine-components/EventList.js +232 -232
  359. package/lib/engine-components/EventTrigger.d.ts +33 -33
  360. package/lib/engine-components/EventTrigger.js +75 -75
  361. package/lib/engine-components/EventType.d.ts +22 -22
  362. package/lib/engine-components/EventType.js +23 -23
  363. package/lib/engine-components/Fog.d.ts +22 -22
  364. package/lib/engine-components/Fog.js +61 -61
  365. package/lib/engine-components/Gizmos.d.ts +17 -17
  366. package/lib/engine-components/Gizmos.js +64 -64
  367. package/lib/engine-components/GridHelper.d.ts +20 -20
  368. package/lib/engine-components/GridHelper.js +54 -54
  369. package/lib/engine-components/GroundProjection.d.ts +67 -67
  370. package/lib/engine-components/GroundProjection.js +343 -343
  371. package/lib/engine-components/Interactable.d.ts +12 -12
  372. package/lib/engine-components/Interactable.js +12 -12
  373. package/lib/engine-components/Joints.d.ts +19 -19
  374. package/lib/engine-components/Joints.js +51 -51
  375. package/lib/engine-components/LODGroup.d.ts +35 -35
  376. package/lib/engine-components/LODGroup.js +152 -152
  377. package/lib/engine-components/Light.d.ts +180 -180
  378. package/lib/engine-components/Light.js +535 -535
  379. package/lib/engine-components/LookAtConstraint.d.ts +19 -19
  380. package/lib/engine-components/LookAtConstraint.js +35 -35
  381. package/lib/engine-components/NeedleMenu.d.ts +50 -50
  382. package/lib/engine-components/NeedleMenu.js +92 -92
  383. package/lib/engine-components/NestedGltf.d.ts +25 -25
  384. package/lib/engine-components/NestedGltf.js +88 -88
  385. package/lib/engine-components/Networking.d.ts +54 -54
  386. package/lib/engine-components/Networking.js +112 -112
  387. package/lib/engine-components/OffsetConstraint.d.ts +14 -14
  388. package/lib/engine-components/OffsetConstraint.js +65 -65
  389. package/lib/engine-components/OrbitControls.d.ts +266 -266
  390. package/lib/engine-components/OrbitControls.js +1009 -1009
  391. package/lib/engine-components/PlayerColor.d.ts +19 -19
  392. package/lib/engine-components/PlayerColor.js +94 -94
  393. package/lib/engine-components/ReflectionProbe.d.ts +26 -26
  394. package/lib/engine-components/ReflectionProbe.js +194 -194
  395. package/lib/engine-components/Renderer.d.ts +153 -153
  396. package/lib/engine-components/Renderer.js +830 -830
  397. package/lib/engine-components/RendererInstancing.d.ts +140 -140
  398. package/lib/engine-components/RendererInstancing.js +744 -744
  399. package/lib/engine-components/RendererLightmap.d.ts +24 -24
  400. package/lib/engine-components/RendererLightmap.js +182 -182
  401. package/lib/engine-components/RigidBody.d.ts +155 -155
  402. package/lib/engine-components/RigidBody.js +517 -517
  403. package/lib/engine-components/SceneSwitcher.d.ts +263 -263
  404. package/lib/engine-components/SceneSwitcher.js +951 -951
  405. package/lib/engine-components/ScreenCapture.d.ts +144 -144
  406. package/lib/engine-components/ScreenCapture.js +547 -547
  407. package/lib/engine-components/ShadowCatcher.d.ts +33 -33
  408. package/lib/engine-components/ShadowCatcher.js +166 -166
  409. package/lib/engine-components/Skybox.d.ts +82 -82
  410. package/lib/engine-components/Skybox.js +448 -448
  411. package/lib/engine-components/SmoothFollow.d.ts +34 -34
  412. package/lib/engine-components/SmoothFollow.js +82 -82
  413. package/lib/engine-components/SpatialTrigger.d.ts +102 -102
  414. package/lib/engine-components/SpatialTrigger.js +225 -225
  415. package/lib/engine-components/SpectatorCamera.d.ts +111 -111
  416. package/lib/engine-components/SpectatorCamera.js +715 -715
  417. package/lib/engine-components/SphereCollider.d.ts +2 -2
  418. package/lib/engine-components/SphereCollider.js +2 -2
  419. package/lib/engine-components/SpriteRenderer.d.ts +132 -132
  420. package/lib/engine-components/SpriteRenderer.js +472 -472
  421. package/lib/engine-components/SyncedCamera.d.ts +41 -41
  422. package/lib/engine-components/SyncedCamera.js +199 -199
  423. package/lib/engine-components/SyncedRoom.d.ts +106 -106
  424. package/lib/engine-components/SyncedRoom.js +371 -371
  425. package/lib/engine-components/SyncedTransform.d.ts +88 -88
  426. package/lib/engine-components/SyncedTransform.js +326 -326
  427. package/lib/engine-components/TestRunner.d.ts +16 -16
  428. package/lib/engine-components/TestRunner.js +102 -102
  429. package/lib/engine-components/TransformGizmo.d.ts +75 -75
  430. package/lib/engine-components/TransformGizmo.js +209 -209
  431. package/lib/engine-components/VideoPlayer.d.ts +184 -184
  432. package/lib/engine-components/VideoPlayer.js +978 -978
  433. package/lib/engine-components/Voip.d.ts +67 -67
  434. package/lib/engine-components/Voip.js +360 -360
  435. package/lib/engine-components/api.d.ts +51 -51
  436. package/lib/engine-components/api.js +50 -50
  437. package/lib/engine-components/avatar/AvatarBlink_Simple.d.ts +11 -11
  438. package/lib/engine-components/avatar/AvatarBlink_Simple.js +76 -76
  439. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.d.ts +14 -14
  440. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.js +68 -68
  441. package/lib/engine-components/avatar/Avatar_Brain_LookAt.d.ts +29 -29
  442. package/lib/engine-components/avatar/Avatar_Brain_LookAt.js +121 -121
  443. package/lib/engine-components/avatar/Avatar_MouthShapes.d.ts +15 -15
  444. package/lib/engine-components/avatar/Avatar_MouthShapes.js +79 -79
  445. package/lib/engine-components/avatar/Avatar_MustacheShake.d.ts +9 -9
  446. package/lib/engine-components/avatar/Avatar_MustacheShake.js +29 -29
  447. package/lib/engine-components/codegen/components.d.ts +215 -215
  448. package/lib/engine-components/codegen/components.js +217 -217
  449. package/lib/engine-components/debug/LogStats.d.ts +5 -5
  450. package/lib/engine-components/debug/LogStats.js +18 -18
  451. package/lib/engine-components/export/gltf/GltfExport.d.ts +30 -30
  452. package/lib/engine-components/export/gltf/GltfExport.js +246 -246
  453. package/lib/engine-components/export/gltf/index.d.ts +1 -1
  454. package/lib/engine-components/export/gltf/index.js +1 -1
  455. package/lib/engine-components/export/index.d.ts +1 -1
  456. package/lib/engine-components/export/index.js +1 -1
  457. package/lib/engine-components/export/usdz/Extension.d.ts +22 -22
  458. package/lib/engine-components/export/usdz/Extension.js +1 -1
  459. package/lib/engine-components/export/usdz/ThreeUSDZExporter.d.ts +160 -160
  460. package/lib/engine-components/export/usdz/ThreeUSDZExporter.js +1782 -1782
  461. package/lib/engine-components/export/usdz/USDZExporter.d.ts +130 -130
  462. package/lib/engine-components/export/usdz/USDZExporter.js +663 -663
  463. package/lib/engine-components/export/usdz/extensions/Animation.d.ts +106 -106
  464. package/lib/engine-components/export/usdz/extensions/Animation.js +1071 -1071
  465. package/lib/engine-components/export/usdz/extensions/DocumentExtension.d.ts +5 -5
  466. package/lib/engine-components/export/usdz/extensions/DocumentExtension.js +6 -6
  467. package/lib/engine-components/export/usdz/extensions/USDZText.d.ts +54 -54
  468. package/lib/engine-components/export/usdz/extensions/USDZText.js +203 -203
  469. package/lib/engine-components/export/usdz/extensions/USDZUI.d.ts +8 -8
  470. package/lib/engine-components/export/usdz/extensions/USDZUI.js +157 -157
  471. package/lib/engine-components/export/usdz/extensions/behavior/Actions.d.ts +30 -30
  472. package/lib/engine-components/export/usdz/extensions/behavior/Actions.js +88 -88
  473. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.d.ts +10 -10
  474. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.js +86 -86
  475. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.d.ts +28 -28
  476. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.js +290 -290
  477. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.d.ts +190 -190
  478. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.js +1060 -1060
  479. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.d.ts +135 -135
  480. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.js +548 -548
  481. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.d.ts +7 -7
  482. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.js +115 -115
  483. package/lib/engine-components/export/usdz/index.d.ts +3 -3
  484. package/lib/engine-components/export/usdz/index.js +2 -2
  485. package/lib/engine-components/export/usdz/utils/animationutils.d.ts +7 -7
  486. package/lib/engine-components/export/usdz/utils/animationutils.js +163 -163
  487. package/lib/engine-components/export/usdz/utils/quicklook.d.ts +2 -2
  488. package/lib/engine-components/export/usdz/utils/quicklook.js +43 -43
  489. package/lib/engine-components/particlesystem/ParticleSystem.d.ts +177 -177
  490. package/lib/engine-components/particlesystem/ParticleSystem.js +1176 -1176
  491. package/lib/engine-components/particlesystem/ParticleSystemModules.d.ts +526 -526
  492. package/lib/engine-components/particlesystem/ParticleSystemModules.js +1930 -1930
  493. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.d.ts +25 -25
  494. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.js +87 -87
  495. package/lib/engine-components/particlesystem/api.d.ts +2 -2
  496. package/lib/engine-components/particlesystem/api.js +2 -2
  497. package/lib/engine-components/postprocessing/Effects/Antialiasing.d.ts +17 -17
  498. package/lib/engine-components/postprocessing/Effects/Antialiasing.js +50 -50
  499. package/lib/engine-components/postprocessing/Effects/BloomEffect.d.ts +46 -46
  500. package/lib/engine-components/postprocessing/Effects/BloomEffect.js +113 -113
  501. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.d.ts +11 -11
  502. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.js +39 -39
  503. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.d.ts +15 -15
  504. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.js +92 -92
  505. package/lib/engine-components/postprocessing/Effects/DepthOfField.d.ts +25 -25
  506. package/lib/engine-components/postprocessing/Effects/DepthOfField.js +104 -104
  507. package/lib/engine-components/postprocessing/Effects/EffectWrapper.d.ts +12 -12
  508. package/lib/engine-components/postprocessing/Effects/EffectWrapper.js +18 -18
  509. package/lib/engine-components/postprocessing/Effects/Pixelation.d.ts +11 -11
  510. package/lib/engine-components/postprocessing/Effects/Pixelation.js +32 -32
  511. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.d.ts +18 -18
  512. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.js +91 -91
  513. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.d.ts +70 -70
  514. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.js +175 -175
  515. package/lib/engine-components/postprocessing/Effects/Sharpening.d.ts +17 -17
  516. package/lib/engine-components/postprocessing/Effects/Sharpening.js +123 -123
  517. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.d.ts +17 -17
  518. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.js +70 -70
  519. package/lib/engine-components/postprocessing/Effects/Tonemapping.d.ts +26 -26
  520. package/lib/engine-components/postprocessing/Effects/Tonemapping.js +138 -138
  521. package/lib/engine-components/postprocessing/Effects/Vignette.d.ts +15 -15
  522. package/lib/engine-components/postprocessing/Effects/Vignette.js +60 -60
  523. package/lib/engine-components/postprocessing/PostProcessingEffect.d.ts +72 -72
  524. package/lib/engine-components/postprocessing/PostProcessingEffect.js +149 -149
  525. package/lib/engine-components/postprocessing/PostProcessingHandler.d.ts +25 -25
  526. package/lib/engine-components/postprocessing/PostProcessingHandler.js +350 -350
  527. package/lib/engine-components/postprocessing/Volume.d.ts +89 -89
  528. package/lib/engine-components/postprocessing/Volume.js +367 -367
  529. package/lib/engine-components/postprocessing/VolumeParameter.d.ts +26 -26
  530. package/lib/engine-components/postprocessing/VolumeParameter.js +136 -136
  531. package/lib/engine-components/postprocessing/VolumeProfile.d.ts +15 -15
  532. package/lib/engine-components/postprocessing/VolumeProfile.js +60 -60
  533. package/lib/engine-components/postprocessing/index.d.ts +5 -5
  534. package/lib/engine-components/postprocessing/index.js +5 -5
  535. package/lib/engine-components/postprocessing/utils.d.ts +11 -11
  536. package/lib/engine-components/postprocessing/utils.js +37 -37
  537. package/lib/engine-components/timeline/PlayableDirector.d.ts +163 -163
  538. package/lib/engine-components/timeline/PlayableDirector.js +686 -686
  539. package/lib/engine-components/timeline/SignalAsset.d.ts +24 -24
  540. package/lib/engine-components/timeline/SignalAsset.js +130 -130
  541. package/lib/engine-components/timeline/TimelineModels.d.ts +89 -89
  542. package/lib/engine-components/timeline/TimelineModels.js +22 -22
  543. package/lib/engine-components/timeline/TimelineTracks.d.ts +110 -110
  544. package/lib/engine-components/timeline/TimelineTracks.js +879 -879
  545. package/lib/engine-components/timeline/index.d.ts +4 -4
  546. package/lib/engine-components/timeline/index.js +3 -3
  547. package/lib/engine-components/ui/BaseUIComponent.d.ts +49 -49
  548. package/lib/engine-components/ui/BaseUIComponent.js +170 -170
  549. package/lib/engine-components/ui/Button.d.ts +64 -64
  550. package/lib/engine-components/ui/Button.js +315 -315
  551. package/lib/engine-components/ui/Canvas.d.ts +74 -74
  552. package/lib/engine-components/ui/Canvas.js +407 -407
  553. package/lib/engine-components/ui/CanvasGroup.d.ts +19 -19
  554. package/lib/engine-components/ui/CanvasGroup.js +58 -58
  555. package/lib/engine-components/ui/EventSystem.d.ts +125 -125
  556. package/lib/engine-components/ui/EventSystem.js +764 -764
  557. package/lib/engine-components/ui/Graphic.d.ts +55 -55
  558. package/lib/engine-components/ui/Graphic.js +254 -254
  559. package/lib/engine-components/ui/Image.d.ts +35 -35
  560. package/lib/engine-components/ui/Image.js +116 -116
  561. package/lib/engine-components/ui/InputField.d.ts +42 -42
  562. package/lib/engine-components/ui/InputField.js +268 -268
  563. package/lib/engine-components/ui/Interfaces.d.ts +38 -38
  564. package/lib/engine-components/ui/Interfaces.js +12 -12
  565. package/lib/engine-components/ui/Layout.d.ts +84 -84
  566. package/lib/engine-components/ui/Layout.js +330 -330
  567. package/lib/engine-components/ui/Outline.d.ts +7 -7
  568. package/lib/engine-components/ui/Outline.js +20 -20
  569. package/lib/engine-components/ui/PointerEvents.d.ts +115 -115
  570. package/lib/engine-components/ui/PointerEvents.js +145 -145
  571. package/lib/engine-components/ui/RaycastUtils.d.ts +11 -11
  572. package/lib/engine-components/ui/RaycastUtils.js +67 -67
  573. package/lib/engine-components/ui/Raycaster.d.ts +30 -30
  574. package/lib/engine-components/ui/Raycaster.js +95 -95
  575. package/lib/engine-components/ui/RectTransform.d.ts +61 -61
  576. package/lib/engine-components/ui/RectTransform.js +353 -353
  577. package/lib/engine-components/ui/SpatialHtml.d.ts +8 -8
  578. package/lib/engine-components/ui/SpatialHtml.js +79 -79
  579. package/lib/engine-components/ui/Text.d.ts +78 -78
  580. package/lib/engine-components/ui/Text.js +539 -539
  581. package/lib/engine-components/ui/Utils.d.ts +24 -24
  582. package/lib/engine-components/ui/Utils.js +90 -90
  583. package/lib/engine-components/ui/index.d.ts +1 -1
  584. package/lib/engine-components/ui/index.js +1 -1
  585. package/lib/engine-components/utils/EnvironmentScene.d.ts +5 -5
  586. package/lib/engine-components/utils/EnvironmentScene.js +205 -205
  587. package/lib/engine-components/utils/LookAt.d.ts +31 -31
  588. package/lib/engine-components/utils/LookAt.js +82 -82
  589. package/lib/engine-components/utils/OpenURL.d.ts +42 -42
  590. package/lib/engine-components/utils/OpenURL.js +119 -119
  591. package/lib/engine-components/webxr/Avatar.d.ts +25 -25
  592. package/lib/engine-components/webxr/Avatar.js +255 -255
  593. package/lib/engine-components/webxr/TeleportTarget.d.ts +7 -7
  594. package/lib/engine-components/webxr/TeleportTarget.js +7 -7
  595. package/lib/engine-components/webxr/WebARCameraBackground.d.ts +30 -30
  596. package/lib/engine-components/webxr/WebARCameraBackground.js +155 -155
  597. package/lib/engine-components/webxr/WebARSessionRoot.d.ts +98 -98
  598. package/lib/engine-components/webxr/WebARSessionRoot.js +770 -770
  599. package/lib/engine-components/webxr/WebXR.d.ts +232 -232
  600. package/lib/engine-components/webxr/WebXR.js +561 -561
  601. package/lib/engine-components/webxr/WebXRAvatar.d.ts +27 -27
  602. package/lib/engine-components/webxr/WebXRAvatar.js +44 -44
  603. package/lib/engine-components/webxr/WebXRImageTracking.d.ts +86 -86
  604. package/lib/engine-components/webxr/WebXRImageTracking.js +470 -470
  605. package/lib/engine-components/webxr/WebXRPlaneTracking.d.ts +92 -92
  606. package/lib/engine-components/webxr/WebXRPlaneTracking.js +500 -500
  607. package/lib/engine-components/webxr/WebXRRig.d.ts +32 -32
  608. package/lib/engine-components/webxr/WebXRRig.js +72 -72
  609. package/lib/engine-components/webxr/XRFlag.d.ts +38 -38
  610. package/lib/engine-components/webxr/XRFlag.js +139 -139
  611. package/lib/engine-components/webxr/controllers/XRControllerFollow.d.ts +47 -47
  612. package/lib/engine-components/webxr/controllers/XRControllerFollow.js +120 -120
  613. package/lib/engine-components/webxr/controllers/XRControllerModel.d.ts +43 -43
  614. package/lib/engine-components/webxr/controllers/XRControllerModel.js +351 -351
  615. package/lib/engine-components/webxr/controllers/XRControllerMovement.d.ts +78 -78
  616. package/lib/engine-components/webxr/controllers/XRControllerMovement.js +506 -506
  617. package/lib/engine-components/webxr/index.d.ts +3 -3
  618. package/lib/engine-components/webxr/index.js +3 -3
  619. package/lib/engine-components/webxr/types.d.ts +3 -3
  620. package/lib/engine-components/webxr/types.js +1 -1
  621. package/lib/engine-components-experimental/Presentation.d.ts +6 -6
  622. package/lib/engine-components-experimental/Presentation.js +9 -9
  623. package/lib/engine-components-experimental/api.d.ts +4 -4
  624. package/lib/engine-components-experimental/api.js +4 -4
  625. package/lib/engine-components-experimental/networking/PlayerSync.d.ts +156 -156
  626. package/lib/engine-components-experimental/networking/PlayerSync.js +377 -377
  627. package/lib/engine-schemes/api.d.ts +12 -12
  628. package/lib/engine-schemes/api.js +12 -12
  629. package/lib/engine-schemes/schemes.d.ts +7 -7
  630. package/lib/engine-schemes/schemes.js +19 -19
  631. package/lib/engine-schemes/synced-camera-model.d.ts +25 -25
  632. package/lib/engine-schemes/synced-camera-model.js +67 -67
  633. package/lib/engine-schemes/synced-transform-model.d.ts +31 -31
  634. package/lib/engine-schemes/synced-transform-model.js +66 -66
  635. package/lib/engine-schemes/transform.d.ts +12 -12
  636. package/lib/engine-schemes/transform.js +39 -39
  637. package/lib/engine-schemes/vec2.d.ts +10 -10
  638. package/lib/engine-schemes/vec2.js +25 -25
  639. package/lib/engine-schemes/vec3.d.ts +11 -11
  640. package/lib/engine-schemes/vec3.js +29 -29
  641. package/lib/engine-schemes/vec4.d.ts +12 -12
  642. package/lib/engine-schemes/vec4.js +33 -33
  643. package/lib/engine-schemes/vr-user-state-buffer.d.ts +37 -37
  644. package/lib/engine-schemes/vr-user-state-buffer.js +110 -110
  645. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.d.ts +6 -6
  646. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.js +45 -45
  647. package/lib/needle-engine.d.ts +7 -7
  648. package/lib/needle-engine.js +64 -64
  649. package/package.json +1 -1
  650. package/plugins/common/buildinfo.js +64 -63
  651. package/plugins/common/cloud.js +2 -0
  652. package/plugins/common/config.cjs +31 -31
  653. package/plugins/common/config.js +35 -35
  654. package/plugins/common/files.js +31 -31
  655. package/plugins/common/generator.js +10 -10
  656. package/plugins/common/license.js +266 -224
  657. package/plugins/common/npm.js +15 -15
  658. package/plugins/common/timers.js +7 -7
  659. package/plugins/common/version.js +37 -37
  660. package/plugins/gltf-packer.mjs +1 -1
  661. package/plugins/next/alias.cjs +39 -39
  662. package/plugins/next/license.cjs +18 -18
  663. package/plugins/next/meshbvhworker.cjs +18 -18
  664. package/plugins/next/next.js +128 -128
  665. package/plugins/types/index.d.ts +2 -2
  666. package/plugins/types/license.d.ts +24 -24
  667. package/plugins/types/needleConfig.d.ts +27 -27
  668. package/plugins/types/userconfig.d.ts +105 -105
  669. package/plugins/types/webmanifest.d.ts +32 -32
  670. package/plugins/vite/alias.js +174 -174
  671. package/plugins/vite/asap.js +245 -245
  672. package/plugins/vite/build-pipeline.js +355 -354
  673. package/plugins/vite/build.js +19 -19
  674. package/plugins/vite/buildinfo.js +41 -41
  675. package/plugins/vite/config.js +106 -106
  676. package/plugins/vite/copyfiles.js +138 -138
  677. package/plugins/vite/defines.js +66 -66
  678. package/plugins/vite/dependencies.js +213 -213
  679. package/plugins/vite/dependency-watcher.js +231 -231
  680. package/plugins/vite/drop-client.js +76 -76
  681. package/plugins/vite/drop.js +87 -87
  682. package/plugins/vite/editor-connection.js +124 -124
  683. package/plugins/vite/facebook-instant-games.js +99 -99
  684. package/plugins/vite/gzip.js +5 -5
  685. package/plugins/vite/imports-logger.js +143 -143
  686. package/plugins/vite/index.js +139 -139
  687. package/plugins/vite/license.js +55 -55
  688. package/plugins/vite/meta.js +163 -163
  689. package/plugins/vite/npm.js +7 -7
  690. package/plugins/vite/peer.js +29 -29
  691. package/plugins/vite/poster-client.js +73 -73
  692. package/plugins/vite/poster.js +79 -79
  693. package/plugins/vite/pwa.js +604 -604
  694. package/plugins/vite/reload-client.js +15 -15
  695. package/plugins/vite/reload.js +363 -363
  696. package/plugins/vite/server.js +66 -66
  697. package/plugins/vite/transform-codegen.js +55 -55
  698. package/plugins/vite/transform.js +31 -31
  699. package/plugins/vite/vite-4.4-hack.js +31 -31
  700. package/src/asap/needle-asap.ts +111 -111
  701. package/src/asap/sessiongranted.ts +75 -75
  702. package/src/asap/utils.ts +4 -4
  703. package/src/engine/analytics/index.ts +10 -10
  704. package/src/engine/analytics/lcp.ts +35 -35
  705. package/src/engine/api.ts +81 -81
  706. package/src/engine/assets/index.ts +59 -59
  707. package/src/engine/assets/static.js +5 -5
  708. package/src/engine/codegen/register_types.ts +298 -298
  709. package/src/engine/debug/debug.ts +51 -51
  710. package/src/engine/debug/debug_console.ts +333 -333
  711. package/src/engine/debug/debug_overlay.ts +332 -332
  712. package/src/engine/debug/debug_spatial_console.ts +429 -429
  713. package/src/engine/debug/index.ts +1 -1
  714. package/src/engine/engine_addressables.ts +679 -679
  715. package/src/engine/engine_animation.ts +145 -145
  716. package/src/engine/engine_application.ts +113 -113
  717. package/src/engine/engine_assetdatabase.ts +387 -387
  718. package/src/engine/engine_audio.ts +24 -24
  719. package/src/engine/engine_camera.ts +39 -39
  720. package/src/engine/engine_components.ts +373 -373
  721. package/src/engine/engine_components_internal.ts +40 -40
  722. package/src/engine/engine_constants.ts +52 -52
  723. package/src/engine/engine_context.ts +1662 -1662
  724. package/src/engine/engine_context_registry.ts +129 -129
  725. package/src/engine/engine_coroutine.ts +54 -54
  726. package/src/engine/engine_create_objects.ts +398 -398
  727. package/src/engine/engine_default_parameters.ts +3 -3
  728. package/src/engine/engine_editor-sync.ts +28 -28
  729. package/src/engine/engine_element.ts +871 -871
  730. package/src/engine/engine_element_attributes.ts +85 -85
  731. package/src/engine/engine_element_extras.ts +16 -16
  732. package/src/engine/engine_element_loading.ts +381 -381
  733. package/src/engine/engine_element_overlay.ts +186 -186
  734. package/src/engine/engine_fileloader.js +9 -9
  735. package/src/engine/engine_gameobject.ts +684 -684
  736. package/src/engine/engine_generic_utils.js +13 -13
  737. package/src/engine/engine_gizmos.ts +577 -577
  738. package/src/engine/engine_gltf.ts +29 -29
  739. package/src/engine/engine_gltf_builtin_components.ts +403 -403
  740. package/src/engine/engine_hot_reload.ts +198 -198
  741. package/src/engine/engine_input.ts +1460 -1460
  742. package/src/engine/engine_input_utils.ts +23 -23
  743. package/src/engine/engine_instancing.ts +45 -45
  744. package/src/engine/engine_license.ts +329 -329
  745. package/src/engine/engine_lifecycle_api.ts +106 -106
  746. package/src/engine/engine_lifecycle_functions_internal.ts +193 -193
  747. package/src/engine/engine_lightdata.ts +117 -117
  748. package/src/engine/engine_loaders.ts +82 -82
  749. package/src/engine/engine_lods.ts +168 -168
  750. package/src/engine/engine_mainloop_utils.ts +472 -472
  751. package/src/engine/engine_math.ts +282 -282
  752. package/src/engine/engine_modules.ts +83 -83
  753. package/src/engine/engine_networking.ts +841 -841
  754. package/src/engine/engine_networking_auto.ts +352 -352
  755. package/src/engine/engine_networking_blob.ts +254 -254
  756. package/src/engine/engine_networking_files.ts +217 -217
  757. package/src/engine/engine_networking_files_default_components.ts +58 -58
  758. package/src/engine/engine_networking_instantiate.ts +419 -419
  759. package/src/engine/engine_networking_peer.ts +159 -159
  760. package/src/engine/engine_networking_streams.ts +713 -713
  761. package/src/engine/engine_networking_types.ts +24 -24
  762. package/src/engine/engine_networking_utils.ts +23 -23
  763. package/src/engine/engine_networking_websocket.ts +2 -2
  764. package/src/engine/engine_patcher.ts +199 -199
  765. package/src/engine/engine_physics.ts +783 -783
  766. package/src/engine/engine_physics.types.ts +46 -46
  767. package/src/engine/engine_physics_rapier.ts +1579 -1579
  768. package/src/engine/engine_playerview.ts +80 -80
  769. package/src/engine/engine_scenelighting.ts +294 -294
  770. package/src/engine/engine_scenetools.ts +365 -365
  771. package/src/engine/engine_serialization.ts +2 -2
  772. package/src/engine/engine_serialization_builtin_serializer.ts +473 -473
  773. package/src/engine/engine_serialization_core.ts +705 -705
  774. package/src/engine/engine_serialization_decorator.ts +80 -80
  775. package/src/engine/engine_setup.ts +1 -1
  776. package/src/engine/engine_shaders.ts +267 -267
  777. package/src/engine/engine_shims.ts +32 -32
  778. package/src/engine/engine_test_utils.ts +109 -109
  779. package/src/engine/engine_texture.ts +82 -82
  780. package/src/engine/engine_three_utils.ts +849 -849
  781. package/src/engine/engine_time.ts +94 -94
  782. package/src/engine/engine_time_utils.ts +237 -237
  783. package/src/engine/engine_tonemapping.ts +210 -210
  784. package/src/engine/engine_types.ts +714 -714
  785. package/src/engine/engine_typestore.ts +63 -63
  786. package/src/engine/engine_util_decorator.ts +136 -136
  787. package/src/engine/engine_utils.ts +972 -972
  788. package/src/engine/engine_utils_format.ts +212 -212
  789. package/src/engine/engine_utils_screenshot.ts +698 -698
  790. package/src/engine/engine_utils_screenshot.xr.ts +103 -103
  791. package/src/engine/export/gltf/Writers.ts +34 -34
  792. package/src/engine/export/gltf/index.ts +158 -158
  793. package/src/engine/export/index.ts +2 -2
  794. package/src/engine/export/state.ts +19 -19
  795. package/src/engine/export/utils.ts +9 -9
  796. package/src/engine/extensions/EXT_texture_exr.ts +50 -50
  797. package/src/engine/extensions/NEEDLE_animator_controller_model.ts +195 -195
  798. package/src/engine/extensions/NEEDLE_components.ts +268 -268
  799. package/src/engine/extensions/NEEDLE_gameobject_data.ts +81 -81
  800. package/src/engine/extensions/NEEDLE_lighting_settings.ts +185 -185
  801. package/src/engine/extensions/NEEDLE_lightmaps.ts +119 -119
  802. package/src/engine/extensions/NEEDLE_persistent_assets.ts +76 -76
  803. package/src/engine/extensions/NEEDLE_render_objects.ts +209 -209
  804. package/src/engine/extensions/NEEDLE_techniques_webgl.ts +640 -640
  805. package/src/engine/extensions/extension_resolver.ts +4 -4
  806. package/src/engine/extensions/extension_utils.ts +166 -166
  807. package/src/engine/extensions/extensions.ts +135 -135
  808. package/src/engine/extensions/index.ts +5 -5
  809. package/src/engine/extensions/usage_tracker.ts +100 -100
  810. package/src/engine/js-extensions/Camera.ts +37 -37
  811. package/src/engine/js-extensions/ExtensionUtils.ts +85 -85
  812. package/src/engine/js-extensions/Layers.ts +23 -23
  813. package/src/engine/js-extensions/Object3D.ts +296 -296
  814. package/src/engine/js-extensions/RGBAColor.ts +75 -75
  815. package/src/engine/js-extensions/Vector.ts +18 -18
  816. package/src/engine/js-extensions/index.ts +4 -4
  817. package/src/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +122 -122
  818. package/src/engine/shaders/shaderData.ts +67 -67
  819. package/src/engine/tests/test_utils.ts +63 -63
  820. package/src/engine/webcomponents/WebXRButtons.ts +260 -260
  821. package/src/engine/webcomponents/api.ts +6 -6
  822. package/src/engine/webcomponents/buttons.ts +262 -262
  823. package/src/engine/webcomponents/fonts.ts +41 -41
  824. package/src/engine/webcomponents/icons.ts +57 -57
  825. package/src/engine/webcomponents/index.ts +1 -1
  826. package/src/engine/webcomponents/logo-element.ts +78 -78
  827. package/src/engine/webcomponents/needle menu/needle-menu-spatial.ts +573 -573
  828. package/src/engine/webcomponents/needle menu/needle-menu.ts +1107 -1107
  829. package/src/engine/webcomponents/needle-button.ts +181 -181
  830. package/src/engine/xr/NeedleXRController.ts +1126 -1126
  831. package/src/engine/xr/NeedleXRSession.ts +1585 -1585
  832. package/src/engine/xr/NeedleXRSync.ts +220 -220
  833. package/src/engine/xr/SceneTransition.ts +78 -78
  834. package/src/engine/xr/TempXRContext.ts +216 -216
  835. package/src/engine/xr/XRRig.ts +9 -9
  836. package/src/engine/xr/api.ts +5 -5
  837. package/src/engine/xr/events.ts +102 -102
  838. package/src/engine/xr/internal.ts +34 -34
  839. package/src/engine/xr/usdz.ts +30 -30
  840. package/src/engine/xr/utils.ts +39 -39
  841. package/src/engine-components/AlignmentConstraint.ts +36 -36
  842. package/src/engine-components/Animation.ts +557 -557
  843. package/src/engine-components/AnimationCurve.ts +150 -150
  844. package/src/engine-components/AnimationUtils.ts +28 -28
  845. package/src/engine-components/AnimationUtilsAutoplay.ts +43 -43
  846. package/src/engine-components/Animator.ts +397 -397
  847. package/src/engine-components/AnimatorController.ts +1293 -1293
  848. package/src/engine-components/AudioListener.ts +92 -92
  849. package/src/engine-components/AudioSource.ts +639 -639
  850. package/src/engine-components/AvatarLoader.ts +263 -263
  851. package/src/engine-components/AxesHelper.ts +59 -59
  852. package/src/engine-components/BasicIKConstraint.ts +54 -54
  853. package/src/engine-components/BoxCollider.ts +1 -1
  854. package/src/engine-components/BoxHelperComponent.ts +114 -114
  855. package/src/engine-components/Camera.ts +707 -707
  856. package/src/engine-components/CameraUtils.ts +144 -144
  857. package/src/engine-components/CharacterController.ts +253 -253
  858. package/src/engine-components/Collider.ts +374 -374
  859. package/src/engine-components/Component.ts +1294 -1294
  860. package/src/engine-components/ContactShadows.ts +482 -482
  861. package/src/engine-components/DeleteBox.ts +62 -62
  862. package/src/engine-components/DeviceFlag.ts +46 -46
  863. package/src/engine-components/DragControls.ts +1623 -1623
  864. package/src/engine-components/DropListener.ts +698 -698
  865. package/src/engine-components/Duplicatable.ts +198 -198
  866. package/src/engine-components/EventList.ts +266 -266
  867. package/src/engine-components/EventTrigger.ts +74 -74
  868. package/src/engine-components/EventType.ts +22 -22
  869. package/src/engine-components/Fog.ts +60 -60
  870. package/src/engine-components/Gizmos.ts +56 -56
  871. package/src/engine-components/GridHelper.ts +48 -48
  872. package/src/engine-components/GroundProjection.ts +356 -356
  873. package/src/engine-components/Interactable.ts +14 -14
  874. package/src/engine-components/Joints.ts +52 -52
  875. package/src/engine-components/LODGroup.ts +153 -153
  876. package/src/engine-components/Light.ts +558 -558
  877. package/src/engine-components/LookAtConstraint.ts +25 -25
  878. package/src/engine-components/NeedleMenu.ts +84 -84
  879. package/src/engine-components/NestedGltf.ts +86 -86
  880. package/src/engine-components/Networking.ts +114 -114
  881. package/src/engine-components/OffsetConstraint.ts +60 -60
  882. package/src/engine-components/OrbitControls.ts +1068 -1068
  883. package/src/engine-components/PlayerColor.ts +103 -103
  884. package/src/engine-components/ReflectionProbe.ts +209 -209
  885. package/src/engine-components/Renderer.ts +900 -900
  886. package/src/engine-components/RendererInstancing.ts +855 -855
  887. package/src/engine-components/RendererLightmap.ts +198 -198
  888. package/src/engine-components/RigidBody.ts +526 -526
  889. package/src/engine-components/SceneSwitcher.ts +1013 -1013
  890. package/src/engine-components/ScreenCapture.ts +592 -592
  891. package/src/engine-components/ShadowCatcher.ts +172 -172
  892. package/src/engine-components/Skybox.ts +455 -455
  893. package/src/engine-components/SmoothFollow.ts +76 -76
  894. package/src/engine-components/SpatialTrigger.ts +229 -229
  895. package/src/engine-components/SpectatorCamera.ts +787 -787
  896. package/src/engine-components/SphereCollider.ts +1 -1
  897. package/src/engine-components/SpriteRenderer.ts +468 -468
  898. package/src/engine-components/SyncedCamera.ts +220 -220
  899. package/src/engine-components/SyncedRoom.ts +380 -380
  900. package/src/engine-components/SyncedTransform.ts +378 -378
  901. package/src/engine-components/TestRunner.ts +118 -118
  902. package/src/engine-components/TransformGizmo.ts +219 -219
  903. package/src/engine-components/VideoPlayer.ts +1025 -1025
  904. package/src/engine-components/Voip.ts +363 -363
  905. package/src/engine-components/api.ts +60 -60
  906. package/src/engine-components/avatar/AvatarBlink_Simple.ts +69 -69
  907. package/src/engine-components/avatar/AvatarEyeLook_Rotation.ts +63 -63
  908. package/src/engine-components/avatar/Avatar_Brain_LookAt.ts +139 -139
  909. package/src/engine-components/avatar/Avatar_MouthShapes.ts +83 -83
  910. package/src/engine-components/avatar/Avatar_MustacheShake.ts +31 -31
  911. package/src/engine-components/codegen/components.ts +216 -216
  912. package/src/engine-components/debug/LogStats.ts +21 -21
  913. package/src/engine-components/export/gltf/GltfExport.ts +265 -265
  914. package/src/engine-components/export/usdz/Extension.ts +24 -24
  915. package/src/engine-components/export/usdz/ThreeUSDZExporter.ts +2413 -2413
  916. package/src/engine-components/export/usdz/USDZExporter.ts +705 -705
  917. package/src/engine-components/export/usdz/extensions/Animation.ts +1204 -1204
  918. package/src/engine-components/export/usdz/extensions/DocumentExtension.ts +9 -9
  919. package/src/engine-components/export/usdz/extensions/USDZText.ts +240 -240
  920. package/src/engine-components/export/usdz/extensions/USDZUI.ts +189 -189
  921. package/src/engine-components/export/usdz/extensions/behavior/Actions.ts +99 -99
  922. package/src/engine-components/export/usdz/extensions/behavior/AudioExtension.ts +102 -102
  923. package/src/engine-components/export/usdz/extensions/behavior/Behaviour.ts +320 -320
  924. package/src/engine-components/export/usdz/extensions/behavior/BehaviourComponents.ts +1225 -1225
  925. package/src/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.ts +646 -646
  926. package/src/engine-components/export/usdz/extensions/behavior/PhysicsExtension.ts +132 -132
  927. package/src/engine-components/export/usdz/index.ts +2 -2
  928. package/src/engine-components/export/usdz/utils/animationutils.ts +191 -191
  929. package/src/engine-components/export/usdz/utils/quicklook.ts +50 -50
  930. package/src/engine-components/particlesystem/ParticleSystem.ts +1287 -1287
  931. package/src/engine-components/particlesystem/ParticleSystemModules.ts +1765 -1765
  932. package/src/engine-components/particlesystem/ParticleSystemSubEmitter.ts +111 -111
  933. package/src/engine-components/particlesystem/api.ts +1 -1
  934. package/src/engine-components/postprocessing/Effects/Antialiasing.ts +55 -55
  935. package/src/engine-components/postprocessing/Effects/BloomEffect.ts +116 -116
  936. package/src/engine-components/postprocessing/Effects/ChromaticAberration.ts +37 -37
  937. package/src/engine-components/postprocessing/Effects/ColorAdjustments.ts +95 -95
  938. package/src/engine-components/postprocessing/Effects/DepthOfField.ts +103 -103
  939. package/src/engine-components/postprocessing/Effects/EffectWrapper.ts +25 -25
  940. package/src/engine-components/postprocessing/Effects/Pixelation.ts +32 -32
  941. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.ts +90 -90
  942. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.ts +191 -191
  943. package/src/engine-components/postprocessing/Effects/Sharpening.ts +138 -138
  944. package/src/engine-components/postprocessing/Effects/TiltShiftEffect.ts +61 -61
  945. package/src/engine-components/postprocessing/Effects/Tonemapping.ts +155 -155
  946. package/src/engine-components/postprocessing/Effects/Vignette.ts +59 -59
  947. package/src/engine-components/postprocessing/PostProcessingEffect.ts +172 -172
  948. package/src/engine-components/postprocessing/PostProcessingHandler.ts +398 -398
  949. package/src/engine-components/postprocessing/Volume.ts +410 -410
  950. package/src/engine-components/postprocessing/VolumeParameter.ts +158 -158
  951. package/src/engine-components/postprocessing/VolumeProfile.ts +61 -61
  952. package/src/engine-components/postprocessing/index.ts +5 -5
  953. package/src/engine-components/postprocessing/utils.ts +52 -52
  954. package/src/engine-components/timeline/PlayableDirector.ts +722 -722
  955. package/src/engine-components/timeline/SignalAsset.ts +144 -144
  956. package/src/engine-components/timeline/TimelineModels.ts +92 -92
  957. package/src/engine-components/timeline/TimelineTracks.ts +967 -967
  958. package/src/engine-components/timeline/index.ts +3 -3
  959. package/src/engine-components/ui/BaseUIComponent.ts +203 -203
  960. package/src/engine-components/ui/Button.ts +307 -307
  961. package/src/engine-components/ui/Canvas.ts +419 -419
  962. package/src/engine-components/ui/CanvasGroup.ts +54 -54
  963. package/src/engine-components/ui/EventSystem.ts +853 -853
  964. package/src/engine-components/ui/Graphic.ts +275 -275
  965. package/src/engine-components/ui/Image.ts +112 -112
  966. package/src/engine-components/ui/InputField.ts +321 -321
  967. package/src/engine-components/ui/Interfaces.ts +57 -57
  968. package/src/engine-components/ui/Layout.ts +334 -334
  969. package/src/engine-components/ui/Outline.ts +13 -13
  970. package/src/engine-components/ui/PointerEvents.ts +206 -206
  971. package/src/engine-components/ui/RaycastUtils.ts +69 -69
  972. package/src/engine-components/ui/Raycaster.ts +102 -102
  973. package/src/engine-components/ui/RectTransform.ts +372 -372
  974. package/src/engine-components/ui/SpatialHtml.ts +79 -79
  975. package/src/engine-components/ui/Text.ts +578 -578
  976. package/src/engine-components/ui/Utils.ts +112 -112
  977. package/src/engine-components/utils/EnvironmentScene.ts +245 -245
  978. package/src/engine-components/utils/LookAt.ts +88 -88
  979. package/src/engine-components/utils/OpenURL.ts +114 -114
  980. package/src/engine-components/webxr/Avatar.ts +265 -265
  981. package/src/engine-components/webxr/TeleportTarget.ts +9 -9
  982. package/src/engine-components/webxr/WebARCameraBackground.ts +175 -175
  983. package/src/engine-components/webxr/WebARSessionRoot.ts +880 -880
  984. package/src/engine-components/webxr/WebXR.ts +585 -585
  985. package/src/engine-components/webxr/WebXRAvatar.ts +66 -66
  986. package/src/engine-components/webxr/WebXRImageTracking.ts +518 -518
  987. package/src/engine-components/webxr/WebXRPlaneTracking.ts +570 -570
  988. package/src/engine-components/webxr/WebXRRig.ts +77 -77
  989. package/src/engine-components/webxr/XRFlag.ts +147 -147
  990. package/src/engine-components/webxr/controllers/XRControllerFollow.ts +118 -118
  991. package/src/engine-components/webxr/controllers/XRControllerModel.ts +374 -374
  992. package/src/engine-components/webxr/controllers/XRControllerMovement.ts +550 -550
  993. package/src/engine-components/webxr/index.ts +2 -2
  994. package/src/engine-components/webxr/types.ts +3 -3
  995. package/src/engine-components-experimental/Presentation.ts +12 -12
  996. package/src/engine-components-experimental/api.ts +4 -4
  997. package/src/engine-components-experimental/networking/PlayerSync.ts +401 -401
  998. package/src/engine-schemes/COMPILE_SCHEMES.bat +3 -3
  999. package/src/engine-schemes/COMPILE_TS.bat +11 -11
  1000. package/src/engine-schemes/README.md +1 -1
  1001. package/src/engine-schemes/api.ts +12 -12
  1002. package/src/engine-schemes/schemes.ts +28 -28
  1003. package/src/engine-schemes/synced-camera-model.ts +92 -92
  1004. package/src/engine-schemes/synced-transform-model.ts +90 -90
  1005. package/src/engine-schemes/syncedCamera.fbs +10 -10
  1006. package/src/engine-schemes/transform.ts +50 -50
  1007. package/src/engine-schemes/transforms.fbs +25 -25
  1008. package/src/engine-schemes/vec.fbs +19 -19
  1009. package/src/engine-schemes/vec2.ts +33 -33
  1010. package/src/engine-schemes/vec3.ts +38 -38
  1011. package/src/engine-schemes/vec4.ts +43 -43
  1012. package/src/engine-schemes/vr-user-state-buffer.ts +145 -145
  1013. package/src/engine-schemes/vrUserStateBuffer.fbs +17 -17
  1014. package/src/include/draco/draco_decoder.js +34 -34
  1015. package/src/include/ktx2/basis_transcoder.js +21 -21
  1016. package/src/include/needle/arial-msdf.json +1471 -1471
  1017. package/src/include/three/DragControls.js +231 -231
  1018. package/src/include/three/EXT_mesh_gpu_instancing_exporter.js +66 -66
  1019. package/src/needle-engine.ts +70 -70
  1020. package/lib/engine/engine.d.ts +0 -4
  1021. package/lib/engine/engine.js +0 -12
  1022. package/lib/engine/engine.js.map +0 -1
  1023. package/lib/engine/engine_web_api.d.ts +0 -12
  1024. package/lib/engine/engine_web_api.js +0 -113
  1025. package/lib/engine/engine_web_api.js.map +0 -1
  1026. package/lib/engine-components/FlyControls.d.ts +0 -10
  1027. package/lib/engine-components/FlyControls.js +0 -29
  1028. package/lib/engine-components/FlyControls.js.map +0 -1
  1029. package/src/engine-schemes/dist/api.js +0 -17
  1030. package/src/engine-schemes/dist/api.js.meta +0 -7
  1031. package/src/engine-schemes/dist/schemes.js +0 -25
  1032. package/src/engine-schemes/dist/schemes.js.meta +0 -7
  1033. package/src/engine-schemes/dist/synced-camera-model.js +0 -74
  1034. package/src/engine-schemes/dist/synced-camera-model.js.meta +0 -7
  1035. package/src/engine-schemes/dist/synced-transform-model.js +0 -73
  1036. package/src/engine-schemes/dist/synced-transform-model.js.meta +0 -7
  1037. package/src/engine-schemes/dist/transform.js +0 -46
  1038. package/src/engine-schemes/dist/transform.js.meta +0 -7
  1039. package/src/engine-schemes/dist/vec2.js +0 -32
  1040. package/src/engine-schemes/dist/vec2.js.meta +0 -7
  1041. package/src/engine-schemes/dist/vec3.js +0 -36
  1042. package/src/engine-schemes/dist/vec3.js.meta +0 -7
  1043. package/src/engine-schemes/dist/vec4.js +0 -40
  1044. package/src/engine-schemes/dist/vec4.js.meta +0 -7
  1045. package/src/engine-schemes/dist/vr-user-state-buffer.js +0 -110
  1046. package/src/engine-schemes/dist/vr-user-state-buffer.js.meta +0 -7
@@ -1,1204 +1,1204 @@
1
- import { AnimationClip, Bone,Interpolant, KeyframeTrack, Matrix4, Object3D, PropertyBinding, Quaternion, Vector3 } from "three";
2
-
3
- import { isDevEnvironment, showBalloonWarning } from "../../../../engine/debug/debug.js";
4
- import { getParam } from "../../../../engine/engine_utils.js";
5
- import { Animator } from "../../../Animator.js";
6
- import { GameObject } from "../../../Component.js";
7
- import type { IUSDExporterExtension } from "../Extension.js";
8
- import { buildMatrix, findStructuralNodesInBoneHierarchy, getPathToSkeleton,usdNumberFormatting as fn, USDObject, USDWriter, USDZExporterContext } from "../ThreeUSDZExporter.js";
9
-
10
- const debug = getParam("debugusdzanimation");
11
- const debugSerialization = getParam("debugusdzanimationserialization");
12
-
13
- export interface UsdzAnimation {
14
- createAnimation(ext: AnimationExtension, model: USDObject, context);
15
- }
16
-
17
- export type AnimationClipCollection = Array<{ root: Object3D, clips: Array<AnimationClip> }>;
18
-
19
- export class RegisteredAnimationInfo {
20
-
21
- private _start?: number;
22
- get start(): number {
23
- if (this._start === undefined) {
24
- this._start = this.ext.getStartTimeByClip(this.clip);
25
- }
26
- return this._start;
27
- }
28
- get duration(): number { return this.clip?.duration ?? TransformData.restPoseClipDuration; }
29
- get nearestAnimatedRoot(): Object3D | undefined { return this._nearestAnimatedRoot; }
30
- get clipName(): string { return this.clip?.name ?? "rest"; }
31
-
32
- private ext: AnimationExtension;
33
- private root: Object3D;
34
- private _nearestAnimatedRoot?: Object3D = undefined;
35
- private clip: AnimationClip | null;
36
-
37
- // Playback speed. Does not affect how the animation is written, just how fast actions play it back.
38
- speed?: number;
39
-
40
- constructor(ext: AnimationExtension, root: Object3D, clip: AnimationClip | null) {
41
- this.ext = ext;
42
- this.root = root;
43
- this.clip = clip;
44
-
45
- this._nearestAnimatedRoot = this.getNearestAnimatedRoot();
46
- }
47
-
48
- private static isDescendantOf(parent: Object3D, child: Object3D) {
49
- let current: Object3D | null = child;
50
- if (!current || !parent) return false;
51
- while (current) {
52
- if (!current) return false;
53
- if (current === parent) return true;
54
- current = current.parent;
55
- }
56
- return false;
57
- }
58
-
59
- /** Finds the nearest actually animated object under root based on the tracks in the AnimationClip. */
60
- getNearestAnimatedRoot() {
61
- let highestRoot: Object3D | undefined = undefined;
62
- try {
63
- for (const track of this.clip?.tracks ?? []) {
64
- const parsedPath = PropertyBinding.parseTrackName(track.name);
65
- let animationTarget = PropertyBinding.findNode(this.root, parsedPath.nodeName);
66
- if (animationTarget) {
67
- if (!highestRoot) highestRoot = animationTarget;
68
- else {
69
- if (animationTarget === highestRoot) continue;
70
- if (RegisteredAnimationInfo.isDescendantOf(highestRoot, animationTarget)) continue;
71
- if (!RegisteredAnimationInfo.isDescendantOf(animationTarget, highestRoot)) {
72
- // TODO test this, should find the nearest common ancestor
73
- while (!RegisteredAnimationInfo.isDescendantOf(animationTarget, highestRoot) && animationTarget.parent) {
74
- animationTarget = animationTarget.parent;
75
- }
76
- if (!RegisteredAnimationInfo.isDescendantOf(animationTarget, highestRoot)) {
77
- console.error("USDZExporter: Animation clip targets multiple roots that are not parent/child. Please report a bug", this.root, this.clip, highestRoot, animationTarget);
78
- }
79
- }
80
- highestRoot = animationTarget;
81
- }
82
- }
83
- }
84
- } catch (e) {
85
- console.error("USDZExporter: Exception when trying to find nearest animated root. Please report a bug", e);
86
- highestRoot = undefined;
87
- }
88
- return highestRoot;
89
- }
90
- }
91
-
92
- export class TransformData {
93
- clip: AnimationClip | null;
94
- pos?: KeyframeTrack;
95
- rot?: KeyframeTrack;
96
- scale?: KeyframeTrack;
97
-
98
- private root: Object3D | null;
99
- private target: Object3D;
100
- private duration = 0;
101
- private useRootMotion = false;
102
-
103
- /** This value can theoretically be anything – a value of 1 is good to clearly see animation gaps.
104
- * For production, a value of 1/60 is enough, since the files can then still properly play back at 60fps.
105
- */
106
- static frameRate = 60;
107
- static animationDurationPadding = 6 / 60;
108
- static restPoseClipDuration = 6 / 60;
109
-
110
- constructor(root: Object3D | null, target: Object3D, clip: AnimationClip | null) {
111
- this.root = root;
112
- this.target = target;
113
- this.clip = clip;
114
-
115
- // this is a rest pose clip.
116
- // we assume duration 1/60 and no tracks, and when queried for times we just return [0, duration]
117
- if (!clip) {
118
- this.duration = TransformData.restPoseClipDuration;
119
- }
120
- else {
121
- this.duration = clip.duration;
122
- }
123
-
124
- // warn if the duration does not equal the maximum time value in the tracks
125
- if (clip && clip.tracks) {
126
- const maxTime = Math.max(...clip.tracks.map((t) => t.times[t.times.length - 1]));
127
- if (maxTime !== this.duration) {
128
- console.warn("USDZExporter: Animation clip duration does not match the maximum time value in the tracks.", clip, maxTime, this.duration);
129
- // We need to override the duration, otherwise we end up with gaps in the exported animation
130
- // where there are actually no written animation values
131
- this.duration = maxTime;
132
- }
133
- }
134
-
135
- const animator = GameObject.getComponent(root, Animator);
136
- if (animator) this.useRootMotion = animator.applyRootMotion;
137
- }
138
-
139
- addTrack(track: KeyframeTrack) {
140
- if (!this.clip) {
141
- console.error("This is a rest clip but you're trying to add tracks to it – this is likely a bug");
142
- return;
143
- }
144
-
145
- if (track.name.endsWith("position")) this.pos = track;
146
- else if (track.name.endsWith("quaternion")) this.rot = track;
147
- else if (track.name.endsWith("scale")) this.scale = track;
148
- else {
149
- if (track.name.endsWith("activeSelf")) {
150
- /*
151
- // Construct a scale track, then apply to the existing scale track.
152
- // Not supported right now, because it would also require properly tracking that these objects need to be enabled
153
- // at animation start because they're animating the enabled state... otherwise they just stay disabled from scene start
154
- const newValues = [...track.values].map((v) => v ? [1,1,1] : [0,0,0]).flat();
155
- const scaleTrack = new KeyframeTrack(track.name.replace(".activeSelf", ".scale"), track.times, newValues, InterpolateDiscrete);
156
- if (!this.scale)
157
- {
158
- this.scale = scaleTrack;
159
- console.log("Mock scale track", this.scale);
160
- }
161
- */
162
- console.warn("[USDZ] Animation of enabled/disabled state is not supported for USDZ export and will NOT be exported: " + track.name + " on " + (this.root?.name ?? this.target.name) + ". Animate scale 0/1 instead.");
163
- }
164
- else {
165
- console.warn("[USDZ] Animation track type not supported for USDZ export and will NOT be exported: " + track.name + " on " + (this.root?.name ?? this.target.name) + ". Only .position, .rotation, .scale are supported.");
166
- }
167
-
168
- if (isDevEnvironment()) showBalloonWarning("[USDZ] Some animations can't be exported. See console for details.");
169
- }
170
- }
171
-
172
- getFrames(): number {
173
- if (!this.clip) return 2;
174
- return Math.max(this.pos?.times?.length ?? 0, this.rot?.times?.length ?? 0, this.scale?.times?.length ?? 0);
175
- }
176
-
177
- getDuration(): number {
178
- return this.duration;
179
- }
180
-
181
- getSortedTimesArray(generatePos: boolean = true, generateRot: boolean = true, generateScale: boolean = true) {
182
- if (!this.clip) return [0, this.duration];
183
-
184
- const posTimesArray = this.pos?.times;
185
- const rotTimesArray = this.rot?.times;
186
- const scaleTimesArray = this.scale?.times;
187
-
188
- // timesArray is the sorted union of all time values
189
- const timesArray: number[] = [];
190
- if (generatePos && posTimesArray) for (const t of posTimesArray) timesArray.push(t);
191
- if (generateRot && rotTimesArray) for (const t of rotTimesArray) timesArray.push(t);
192
- if (generateScale && scaleTimesArray) for (const t of scaleTimesArray) timesArray.push(t);
193
-
194
- // We also need to make sure we have start and end times for these tracks
195
- // We already ensure this is the case for duration – it's always the maximum time value in the tracks
196
- // (see constructor)
197
- if (!timesArray.includes(0)) timesArray.push(0);
198
-
199
- // sort times so it's increasing
200
- timesArray.sort((a, b) => a - b);
201
- // make sure time values are unique
202
- return [...new Set(timesArray)];
203
- }
204
-
205
- /**
206
- * Returns an iterator that yields the values for each time sample.
207
- * Values are reused objects - if you want to append them to some array
208
- * instead of processing them right away, clone() them.
209
- * @param timesArray
210
- * @param generatePos
211
- * @param generateRot
212
- * @param generateScale
213
- */
214
- *getValues(timesArray: number[], generatePos: boolean = true, generateRot: boolean = true, generateScale: boolean = true) {
215
-
216
- const translation = new Vector3();
217
- const rotation = new Quaternion();
218
- const scale = new Vector3(1, 1, 1);
219
- const object = this.target;
220
-
221
- const positionInterpolant: Interpolant | undefined = generatePos ? this.pos?.createInterpolant() : undefined;
222
- const rotationInterpolant: Interpolant | undefined = generateRot ? this.rot?.createInterpolant() : undefined;
223
- const scaleInterpolant: Interpolant | undefined = generateScale ? this.scale?.createInterpolant() : undefined;
224
-
225
- if (!positionInterpolant) translation.set(object.position.x, object.position.y, object.position.z);
226
- if (!rotationInterpolant) rotation.set(object.quaternion.x, object.quaternion.y, object.quaternion.z, object.quaternion.w);
227
- if (!scaleInterpolant) scale.set(object.scale.x, object.scale.y, object.scale.z);
228
-
229
- // WORKAROUND because it seems that sometimes we get a quaternion interpolant with a valueSize
230
- // of its own length... which then goes into an endless loop
231
- if (positionInterpolant && positionInterpolant.valueSize !== 3)
232
- positionInterpolant.valueSize = 3;
233
- if (rotationInterpolant && rotationInterpolant.valueSize !== 4)
234
- rotationInterpolant.valueSize = 4;
235
- if (scaleInterpolant && scaleInterpolant.valueSize !== 3)
236
- scaleInterpolant.valueSize = 3;
237
-
238
- // We're optionally padding with one extra time step at the beginning and the end
239
- // So that we don't get unwanted interpolations between clips (during the padding time)
240
- const extraFrame = 0; // TransformData.animationDurationPadding > 1 / 60 ? 1 : 0;
241
- for (let index = 0 - extraFrame; index < timesArray.length + extraFrame; index++) {
242
- let time = 0;
243
- let returnTime = 0;
244
- if (index < 0) {
245
- time = timesArray[0];
246
- returnTime = time - (TransformData.animationDurationPadding / 2) + 1 / 60;
247
- }
248
- else if (index >= timesArray.length) {
249
- time = timesArray[timesArray.length - 1];
250
- returnTime = time + (TransformData.animationDurationPadding / 2) - 1 / 60;
251
- }
252
- else {
253
- time = timesArray[index];
254
- returnTime = time;
255
- }
256
-
257
- if (positionInterpolant) {
258
- const pos = positionInterpolant.evaluate(time);
259
- translation.set(pos[0], pos[1], pos[2]);
260
- }
261
- if (rotationInterpolant) {
262
- const quat = rotationInterpolant.evaluate(time);
263
- rotation.set(quat[0], quat[1], quat[2], quat[3]);
264
- }
265
- if (scaleInterpolant) {
266
- const scaleVal = scaleInterpolant.evaluate(time);
267
- scale.set(scaleVal[0], scaleVal[1], scaleVal[2]);
268
- }
269
-
270
- // Apply basic root motion offset – non-animated transformation data is applied to the node again.
271
- // We're doing this because clips that animate their own root are (typically) not in world space,
272
- // but in local space and moved to a specific spot in the world.
273
- if (this.useRootMotion && object === this.root) {
274
- const rootMatrix = new Matrix4();
275
- rootMatrix.compose(translation, rotation, scale);
276
- rootMatrix.multiply(object.matrix);
277
- rootMatrix.decompose(translation, rotation, scale);
278
- }
279
-
280
- yield { time: returnTime, translation, rotation, scale, index };
281
- }
282
- }
283
- }
284
-
285
- export class AnimationExtension implements IUSDExporterExtension {
286
-
287
- get extensionName(): string { return "animation" }
288
- get animationData() { return this.dict; }
289
- get registeredClips() { return this.clipToStartTime.keys(); }
290
- get animatedRoots() { return this.rootTargetMap.keys(); }
291
- get holdClipMap() { return this.clipToHoldClip; }
292
-
293
- /** For each animated object, contains time/pos/rot/scale samples in the format that USD needs,
294
- * ready to be written to the .usda file.
295
- */
296
- private dict: Map<Object3D, Array<TransformData>> = new Map();
297
- /** Map of all roots (Animation/Animator or scene) and all targets that they animate.
298
- * We need that info so that we can ensure that each target has the same number of TransformData entries
299
- * so that switching between animations doesn't result in data "leaking" to another clip.
300
- */
301
- private rootTargetMap = new Map<Object3D, Array<Object3D>>();
302
- private rootAndClipToRegisteredAnimationMap = new Map<string, RegisteredAnimationInfo>();
303
- /** Clips registered for each root */
304
- private rootToRegisteredClip = new Map<Object3D, Array<AnimationClip>>();
305
- private lastClipEndTime = 0;
306
- private clipToStartTime: Map<AnimationClip, number> = new Map();
307
- private clipToHoldClip: Map<AnimationClip, AnimationClip> = new Map();
308
-
309
- private serializers: SerializeAnimation[] = [];
310
-
311
- /** Determines if we inject a rest pose clip for each root - only makes sense for QuickLook */
312
- injectRestPoses = false;
313
- /** Determines if we inject a PlayAnimationOnClick component with "scenestart" trigger - only makes sense for QuickLook */
314
- injectImplicitBehaviours = false;
315
-
316
- constructor(quickLookCompatible: boolean) {
317
- this.injectRestPoses = quickLookCompatible;
318
- this.injectImplicitBehaviours = quickLookCompatible;
319
- }
320
-
321
- getStartTimeCode() {
322
- // return the end time + padding of the rest clip, if any exists
323
- if (!this.injectRestPoses) return 0;
324
- if (this.rootAndClipToRegisteredAnimationMap.size === 0) return 0;
325
- // return 0;
326
- return (TransformData.restPoseClipDuration + TransformData.animationDurationPadding) * 60;
327
- }
328
-
329
- /** Returns the end time code, based on 60 frames per second, for all registered animations.
330
- * This matches the highest time value in the USDZ file. */
331
- getEndTimeCode() {
332
- let max = 0;
333
- for (const [_, info] of this.rootAndClipToRegisteredAnimationMap) {
334
- const end = info.start + info.duration;
335
- if (end > max) max = end;
336
- }
337
- return max * 60;
338
- }
339
-
340
- getClipCount(root: Object3D): number {
341
- const currentCount = this.rootToRegisteredClip.get(root)?.length ?? 0;
342
- // The rest pose is not part of rootToRegisteredClip
343
- // if (this.injectRestPoses) currentCount = currentCount ? currentCount - 1 : 0;
344
- return currentCount ?? 0;
345
- }
346
-
347
- /*
348
- // TODO why do we have this here and on TransformData? Can RegisteredAnimationInfo not cache this value?
349
- // TODO we probably want to assert here that this is the same value on all nodes
350
- getStartTime01(root: Object3D, clip: AnimationClip | null) {
351
- // This is a rest pose clip, it always starts at 0
352
- if (!clip) return 0;
353
-
354
- const targets = this.rootTargetMap.get(root);
355
- if (!targets) return 0;
356
- const transformDatas = this.dict.get(targets[0]);
357
- if (!transformDatas) {
358
- console.error("Trying to get start time for root that has no animation data", root, clip, ...this.dict);
359
- return 0;
360
- }
361
-
362
- let currentStartTime = 0;
363
- for (let i = 0; i < transformDatas.length; i++) {
364
- if (transformDatas[i].clip === clip) break;
365
- currentStartTime += transformDatas[i].getDuration() + TransformData.animationDurationPadding;
366
- }
367
-
368
- return currentStartTime;
369
- }
370
- */
371
-
372
- getStartTimeByClip(clip: AnimationClip | null) {
373
- if (!clip) return 0;
374
- if (!this.clipToStartTime.has(clip)) {
375
- console.error("USDZExporter: Missing start time for clip – please report a bug.", clip);
376
- return 0;
377
- }
378
- const time = this.clipToStartTime.get(clip)!;
379
- return time;
380
- }
381
-
382
- // The same clip could be registered for different roots. All of them need written animation data then.
383
- // The same root could have multiple clips registered to it. If it does, the clips need to write
384
- // independent time data, so that playing back an animation on that root doesn't result in data "leaking"/"overlapping".
385
- // The structure we need is:
386
- // - MyRoot
387
- // Animator
388
- // - Clip1: CubeScale (only animates MyCube), duration: 3s
389
- // - Clip2: SphereRotation (only animates MySphere), duration: 2s
390
- // - MyCube
391
- // - MySphere
392
- // Results in:
393
- // - MyRoot
394
- // - MyCube
395
- // - # rest clip (0..0.1)
396
- // - # CubeScale (0.2..3.2)
397
- // - # rest clip for SphereRotation (3.3..5.3)
398
- // - MySphere
399
- // - # rest clip (0..0.1)
400
- // - # rest clip for CubeScale (0.2..3.2)
401
- // - # SphereRotation (3.3..5.3)
402
-
403
- /** Register an AnimationClip for a specific root object.
404
- * @param root The root object that the animation clip is targeting.
405
- * @param clip The animation clip to register. If null, a rest pose is registered.
406
- * @returns The registered animation info, which contains the start time and duration of the clip.
407
- */
408
- registerAnimation(root: Object3D, clip: AnimationClip | null): RegisteredAnimationInfo | null {
409
- if(!root) return null;
410
- if (!this.rootTargetMap.has(root)) this.rootTargetMap.set(root, []);
411
-
412
- // if we registered that exact pair already, just return the info
413
- // no proper tuples in JavaScript, but we can use the uuids for a unique key here
414
- const hash = root.uuid + (clip?.uuid ?? "-rest");
415
- if (this.rootAndClipToRegisteredAnimationMap.has(hash)) {
416
- return this.rootAndClipToRegisteredAnimationMap.get(hash)!;
417
- }
418
-
419
- if (debug) console.log("registerAnimation", root, clip);
420
-
421
- // When injecting a rest clip, the rest clip has ALL animated nodes as targets.
422
- // So all other nodes will already have at least one animated clip registered, and their own
423
- // animations need to start at index 1. Otherwise we're getting overlap where everything is
424
- // in animation 0 and some data overrides each other incorrectly.
425
- // When we don't inject a rest clip, we start at 0.
426
- const startIndex = this.injectRestPoses ? 1 : 0;
427
- const currentCount = (this.rootToRegisteredClip.get(root)?.length ?? 0) + startIndex;
428
-
429
- const targets = this.rootTargetMap.get(root);
430
- const unregisteredNodesForThisClip = new Set(targets);
431
- if (clip && clip.tracks) {
432
- // We could sort so that supported tracks come first, this allows us to support some additional tracks by
433
- // modifying what has already been written for the supported ones (e.g. enabled -> modify scale).
434
- // Only needed if we're actually emulating some unsupported track types in addTrack(...).
435
- // const sortedTracks = clip.tracks.filter(x => !!x).sort((a, _b) => a.name.endsWith("position") || a.name.endsWith("quaternion") || a.name.endsWith("scale") ? -1 : 1);
436
- for (const track of clip.tracks) {
437
- const parsedPath = PropertyBinding.parseTrackName(track.name);
438
- const animationTarget = PropertyBinding.findNode(root, parsedPath.nodeName);
439
-
440
- if (!animationTarget) {
441
- console.warn("no object found for track", track.name, "using " + root.name + " instead");
442
- continue;
443
- // // if no object was found it might be that we have a component that references an animation clip but wants to target another object
444
- // // in that case UnityGLTF writes the name of the component as track targets because it doesnt know of the intented target
445
- // animationTarget = root;
446
- }
447
- if (!this.dict.has(animationTarget)) {
448
- this.dict.set(animationTarget, []);
449
- }
450
- const transformDataForTarget = this.dict.get(animationTarget);
451
- if (!transformDataForTarget) {
452
- console.warn("no transform data found for target ", animationTarget, "at slot " + currentCount + ", this is likely a bug");
453
- continue;
454
- }
455
-
456
- // this node has animation data for this clip – no need for additional padding
457
- unregisteredNodesForThisClip.delete(animationTarget);
458
-
459
- // Since we're interleaving animations, we need to ensure that for the same root,
460
- // all clips that "touch" it are written in the same order for all animated nodes.
461
- // this means we need to pad the TransformData array with empty entries when a particular
462
- // node inside that root is not animated by a particular clip.
463
- // It also means that when we encounter a clip that contains animation data for a new node,
464
- // We need to pad that one's array as well so it starts at the same point.
465
- // TODO most likely doesn't work for overlapping clips (clips where a root is a child of another root)
466
- // TODO in that case we may need to pad globally, not per root
467
-
468
- // Inject a rest pose if we don't have it already
469
- if (this.injectRestPoses && !transformDataForTarget[0]) {
470
- console.log("Injecting rest pose", animationTarget, clip, "at slot", currentCount);
471
- transformDataForTarget[0] = new TransformData(null, animationTarget, null);
472
- }
473
- // These all need to be at the same index, otherwise our padding went wrong
474
- let model = transformDataForTarget[currentCount];
475
-
476
- if (!model) {
477
- model = new TransformData(root, animationTarget, clip);
478
- transformDataForTarget[currentCount] = model;
479
- }
480
- model.addTrack(track);
481
-
482
- // We're keeping track of all animated nodes per root, needed for proper padding
483
- if (!targets?.includes(animationTarget)) targets?.push(animationTarget);
484
- }
485
- }
486
-
487
- if (debug) console.log("Unregistered nodes for this clip", unregisteredNodesForThisClip, "clip", clip, "at slot", currentCount, "for root", root, "targets", targets)
488
-
489
- // add padding for nodes that are not animated by this clip
490
- for (const target of unregisteredNodesForThisClip) {
491
- const transformDataForTarget = this.dict.get(target);
492
- if (!transformDataForTarget) continue;
493
-
494
- // Inject rest pose if these nodes don't have it yet for some reason – this is likely a bug
495
- if (this.injectRestPoses && !transformDataForTarget[0]) {
496
- console.warn("Adding rest pose for ", target, clip, "at slot", currentCount, "This is likely a bug, should have been added earlier.");
497
- const model = new TransformData(null, target, null);
498
- transformDataForTarget[0] = model;
499
- }
500
-
501
- let model = transformDataForTarget[currentCount];
502
- if (!model) {
503
- if (debug) console.log("Adding padding clip for ", target, clip, "at slot", currentCount);
504
- model = new TransformData(root, target, clip);
505
- transformDataForTarget[currentCount] = model;
506
- }
507
- }
508
-
509
- // get the entry for this object.
510
- // This doesnt work if we have clips animating multiple objects
511
- const info = new RegisteredAnimationInfo(this, root, clip);
512
- this.rootAndClipToRegisteredAnimationMap.set(hash, info);
513
-
514
- if (debug) console.log({root, clip, info});
515
- if (clip) {
516
- const registered = this.rootToRegisteredClip.get(root);
517
- if (!registered) this.rootToRegisteredClip.set(root, [clip]);
518
- else registered.push(clip);
519
-
520
- const lastClip = this.clipToStartTime.get(clip);
521
- if (!lastClip) {
522
- if (this.lastClipEndTime == null) this.lastClipEndTime = TransformData.restPoseClipDuration;
523
-
524
- let newStartTime = this.lastClipEndTime + TransformData.animationDurationPadding;
525
- let newEndTime = newStartTime + clip.duration;
526
-
527
- // Round these times, makes it easier to understand what happens in the file
528
- const roundedStartTime = Math.round(newStartTime * 60) / 60;
529
- const roundedEndTime = Math.round(newEndTime * 60) / 60;
530
- if (Math.abs(roundedStartTime - newStartTime) < 0.01) newStartTime = roundedStartTime;
531
- if (Math.abs(roundedEndTime - newEndTime) < 0.01) newEndTime = roundedEndTime;
532
- // Round newStartTime up to the next frame
533
- newStartTime = Math.ceil(newStartTime);
534
- newEndTime = newStartTime + clip.duration;
535
-
536
- this.clipToStartTime.set(clip, newStartTime);
537
- this.lastClipEndTime = newEndTime;
538
- }
539
- }
540
- return info;
541
- }
542
-
543
- onAfterHierarchy(_context) {
544
- if (debug) console.log("Animation clips per animation target node", this.dict);
545
- }
546
-
547
- onAfterBuildDocument(_context: any) {
548
-
549
- // Validation: go through all roots, check if their data and lengths are consistent.
550
- // There are some cases that we can patch up here, especially if non-overlapping animations have resulted in "holes"
551
- // in TransformData where only now we know what the matching animation clip actually is.
552
- if (debug) console.log("Animation data", { dict: this.dict, rootTargetMap: this.rootTargetMap, rootToRegisteredClip: this.rootToRegisteredClip});
553
-
554
- for (const root of this.rootTargetMap.keys()) {
555
- const targets = this.rootTargetMap.get(root);
556
-
557
- if (!targets) continue;
558
-
559
- // The TransformData[] arrays here should have the same length, and the same durations
560
- let arrayLength: number | undefined = undefined;
561
- const durations: Array<number | undefined> = [];
562
- for (const target of targets) {
563
- const datas = this.dict.get(target);
564
- if (!datas) {
565
- console.error("No data found for target on USDZ export – please report a bug!", target);
566
- continue;
567
- }
568
-
569
- if (arrayLength === undefined) arrayLength = datas?.length;
570
- if (arrayLength !== datas?.length) console.error("Different array lengths for targets – please report a bug!", datas);
571
-
572
- for (let i = 0; i < datas.length; i++) {
573
- let data = datas[i];
574
- if (!data) {
575
- // If we don't have TransformData for this object yet, we're emitting a rest pose with the duration
576
- // of the matching clip that was registered for this root.
577
- const index = i - (this.injectRestPoses ? 1 : 0);
578
- datas[i] = new TransformData(null, target, this.rootToRegisteredClip.get(root)![index]);
579
- data = datas[i];
580
- }
581
-
582
- const duration = data.getDuration();
583
- if (durations[i] === undefined) durations[i] = duration;
584
- else if (durations[i] !== duration) {
585
- console.error("Error during UDSZ export: Encountered different animation durations for animated targets. Please report a bug!", {datas, target});
586
- durations[i] = duration;
587
- continue;
588
- }
589
- }
590
- }
591
- }
592
-
593
- for (const ser of this.serializers) {
594
- const parent = ser.model?.parent;
595
- const isEmptyParent = parent?.isDynamic === true;
596
- if (debugSerialization) console.log(isEmptyParent, ser.model?.parent);
597
- if (isEmptyParent) {
598
- ser.registerCallback(parent);
599
- }
600
- }
601
- }
602
-
603
- onExportObject(object, model: USDObject, _context) {
604
-
605
- GameObject.foreachComponent(object, (comp) => {
606
- const c = comp as unknown as UsdzAnimation;
607
- if (typeof c.createAnimation === "function") {
608
- c.createAnimation(this, model, _context);
609
- }
610
- }, false);
611
-
612
- // we need to be able to retarget serialization to empty parents before actually serializing (we do that in another callback)
613
- const ser = new SerializeAnimation(object, this);
614
- this.serializers.push(ser);
615
- ser.registerCallback(model);
616
- }
617
-
618
- }
619
-
620
- declare type TransformDataByObject = Map<Object3D, TransformData[]>;
621
- declare type AnimationClipFrameTimes = { pos: number[], rot: number[], scale: number[], timeOffset: number };
622
-
623
- class SerializeAnimation {
624
-
625
- model: USDObject | undefined = undefined;
626
-
627
- private object: Object3D;
628
- private animationData: Map<Object3D, Array<TransformData>>;
629
- private ext: AnimationExtension;
630
-
631
- private callback?: (writer: USDWriter, context: USDZExporterContext) => void;
632
-
633
- constructor(object: Object3D, ext: AnimationExtension) {
634
- this.object = object;
635
- this.animationData = ext.animationData;
636
- this.ext = ext;
637
- }
638
-
639
- registerCallback(model: USDObject) {
640
- if (this.model && this.callback) {
641
- this.model.removeEventListener("serialize", this.callback);
642
- }
643
- if (!this.callback)
644
- this.callback = this.onSerialize.bind(this);
645
- if (debugSerialization) console.log("REPARENT", model);
646
- this.model = model;
647
-
648
- if (this.callback)
649
- this.model.addEventListener("serialize", this.callback);
650
- }
651
-
652
- skinnedMeshExport(writer: USDWriter, _context: USDZExporterContext, ext: AnimationExtension) {
653
- const model = this.model;
654
- const dict = this.animationData;
655
- if (!model) return;
656
-
657
- if ( model.skinnedMesh ) {
658
-
659
- const skeleton = model.skinnedMesh.skeleton;
660
-
661
- const boneAndInverse = new Array<{bone: Object3D, inverse: Matrix4}>();
662
-
663
- const sortedBones:Bone[] = [];
664
- const uuidsFound:string[] = [];
665
- for(const bone of skeleton.bones ) {
666
- // if (bone.parent!.type !== 'Bone')
667
- {
668
- sortedBones.push(bone);
669
- uuidsFound.push(bone.uuid);
670
- const inverse = skeleton.boneInverses[skeleton.bones.indexOf(bone)];
671
- boneAndInverse.push({bone, inverse});
672
- }
673
- }
674
-
675
- let maxSteps = 10_000;
676
- while (uuidsFound.length < skeleton.bones.length && maxSteps-- > 0) {
677
- for (const sortedBone of sortedBones){
678
- const children = sortedBone.children as Bone[];
679
- for (const childBone of children){
680
- if (uuidsFound.indexOf(childBone.uuid) === -1 && skeleton.bones.indexOf(childBone) !== -1){
681
- sortedBones.push(childBone);
682
- uuidsFound.push(childBone.uuid);
683
- const childInverse = skeleton.boneInverses[skeleton.bones.indexOf(childBone)];
684
- boneAndInverse.push({bone: childBone, inverse: childInverse});
685
- }
686
- }
687
- }
688
- }
689
-
690
- if (maxSteps <= 0) console.error("Failed to sort bones in skinned mesh", model.skinnedMesh, skeleton.bones, uuidsFound);
691
-
692
- for (const structuralNode of findStructuralNodesInBoneHierarchy(skeleton.bones)) {
693
- boneAndInverse.push({bone: structuralNode, inverse: structuralNode.matrixWorld.clone().invert()});
694
- }
695
-
696
- // sort bones by path – need to be sorted in the same order as during mesh export
697
- const assumedRoot = boneAndInverse[0].bone.parent!;
698
- if (!assumedRoot) console.error("No bone parent found for skinned mesh during USDZ export", model.skinnedMesh);
699
- boneAndInverse.sort((a, b) => getPathToSkeleton(a.bone, assumedRoot) > getPathToSkeleton(b.bone, assumedRoot) ? 1 : -1);
700
-
701
- function createVector3TimeSampleLines_( values: Map<number, Vector3[]> ) {
702
-
703
- const lines:string[] = []
704
- for (const [frame, frameValues] of values) {
705
- let line = `${frame} : [`;
706
- const boneRotations: Array<string> = [];
707
- for ( const v of frameValues ) {
708
- boneRotations.push( `(${fn( v.x )}, ${fn( v.y )}, ${fn( v.z )})` );
709
- }
710
- line = line.concat( boneRotations.join( ', ' ) );
711
- line = line.concat( '],' );
712
- lines.push( line );
713
- }
714
-
715
- return lines;
716
-
717
- }
718
-
719
- function createVector4TimeSampleLines_( rotations: Map<number, Quaternion[]> ) {
720
-
721
- const lines:string[] = []
722
-
723
- for (const [frame, frameRotations] of rotations) {
724
- let line = `${frame} : [`;
725
- const boneRotations: Array<string> = [];
726
- for ( const v of frameRotations ) {
727
- boneRotations.push( `(${fn( v.w )}, ${fn( v.x )}, ${fn( v.y )}, ${fn( v.z )})` );
728
- }
729
- line = line.concat( boneRotations.join( ', ' ) );
730
- line = line.concat( '],' );
731
- lines.push( line );
732
- }
733
-
734
- return lines;
735
-
736
- }
737
-
738
- function getSortedFrameTimes( boneToTransformData: TransformDataByObject ): AnimationClipFrameTimes[] {
739
-
740
- // We should have a proper rectangular array,
741
- // Where for each bone we have the same number of TransformData entries.
742
- let numberOfEntries: number | undefined = undefined;
743
- let allBonesHaveSameNumberOfTransformDataEntries = true;
744
- const undefinedBoneEntries = new Map<Object3D, Array<number>>();
745
- for (const [bone, transformDatas] of boneToTransformData) {
746
- if (numberOfEntries === undefined) numberOfEntries = transformDatas.length;
747
- if (numberOfEntries !== transformDatas.length) {
748
- allBonesHaveSameNumberOfTransformDataEntries = false;
749
- }
750
- let index = 0;
751
- for (const transformData of transformDatas) {
752
- index++;
753
- if (!transformData) {
754
- if (!undefinedBoneEntries.has(bone)) undefinedBoneEntries.set(bone, []);
755
- undefinedBoneEntries.get(bone)!.push(index);
756
- }
757
- }
758
- }
759
-
760
- // TODO not working yet for multiple skinned characters at the same time
761
- if (debug) {
762
- console.log("Bone count: ", boneToTransformData.size, "TransformData entries per bone: ", numberOfEntries, "Undefined bone entries: ", undefinedBoneEntries);
763
- }
764
- console.assert(allBonesHaveSameNumberOfTransformDataEntries, "All bones should have the same number of TransformData entries", boneToTransformData);
765
- console.assert(undefinedBoneEntries.size === 0, "All TransformData entries should be set", undefinedBoneEntries);
766
- const times: AnimationClipFrameTimes[] = [];
767
-
768
- for (const [bone, transformDatas] of boneToTransformData) {
769
-
770
- /*
771
- // calculate start times from the transformDatas
772
- const startTimes = new Array<number>();
773
- let currentStartTime = 0;
774
- for (let i = 0; i < transformDatas.length; i++) {
775
- startTimes.push(currentStartTime);
776
- currentStartTime += transformDatas[i].getDuration() + TransformData.animationDurationPadding;
777
- }
778
- */
779
-
780
- for (let i = 0; i < transformDatas.length; i++) {
781
- const transformData = transformDatas[i];
782
- // const timeOffset = transformData.getStartTime(dict);
783
- const timeOffset = ext.getStartTimeByClip(transformData.clip);
784
- if (times.length <= i) {
785
- times.push({pos: [], rot: [], scale: [], timeOffset});
786
- }
787
-
788
- const perTransfromDataTimes = times[i];
789
-
790
- perTransfromDataTimes.pos.push( ...transformData.getSortedTimesArray(true, false, false));
791
- perTransfromDataTimes.rot.push( ...transformData.getSortedTimesArray(false, true, false));
792
- perTransfromDataTimes.scale.push( ...transformData.getSortedTimesArray(false, false, true));
793
- }
794
- }
795
-
796
- for (const perTransfromDataTimes of times) {
797
-
798
- /*
799
- // TODO we're doing that in animation export as well
800
- if (!times.pos.includes(0)) times.pos.push(0);
801
- if (!times.rot.includes(0)) times.rot.push(0);
802
- if (!times.scale.includes(0)) times.scale.push(0);
803
- */
804
-
805
- // sort times so it's increasing
806
- perTransfromDataTimes.pos.sort((a, b) => a - b);
807
- perTransfromDataTimes.rot.sort((a, b) => a - b);
808
- perTransfromDataTimes.scale.sort((a, b) => a - b);
809
-
810
- // make sure time values are unique
811
- perTransfromDataTimes.pos = [...new Set(perTransfromDataTimes.pos)];
812
- perTransfromDataTimes.rot = [...new Set(perTransfromDataTimes.rot)];
813
- perTransfromDataTimes.scale = [...new Set(perTransfromDataTimes.scale)];
814
- }
815
-
816
- return times;
817
- }
818
-
819
- function createTimeSamplesObject_( data: TransformDataByObject, sortedComponentFrameNumbers: AnimationClipFrameTimes[], bones: Array<Object3D> ) {
820
- const positionTimeSamples = new Map<number, Array<Vector3>>();
821
- const quaternionTimeSamples = new Map<number, Array<Quaternion>>();
822
- const scaleTimeSamples = new Map<number, Array<Vector3>>();
823
-
824
- const count = sortedComponentFrameNumbers.length;
825
-
826
- // return sampled data for each bone
827
- for ( const bone of bones ) {
828
- const boneEntryInData = data.get( bone );
829
-
830
- let emptyTransformData: TransformData | undefined = undefined;
831
- // if we have animation data for this bone, check that it's the right amount.
832
- if (boneEntryInData)
833
- console.assert(boneEntryInData.length === count, "We should have the same number of TransformData entries for each bone", boneEntryInData, sortedComponentFrameNumbers);
834
- // if we don't have animation data, create an empty one – 
835
- // it will automatically map to the rest pose, albeit inefficiently
836
- else
837
- emptyTransformData = new TransformData(null, bone, null);
838
-
839
- for (let i = 0; i < count; i++) {
840
- const transformData = boneEntryInData ? boneEntryInData[i] : emptyTransformData!;
841
- const timeData = sortedComponentFrameNumbers[i];
842
-
843
- for (const { time, translation } of transformData.getValues(timeData.pos, true, false, false)) {
844
- const shiftedTime = time + timeData.timeOffset;
845
- const t = shiftedTime * 60;
846
-
847
- if (!positionTimeSamples.has(t)) positionTimeSamples.set(t, new Array<Vector3>());
848
- positionTimeSamples.get(t)!.push( translation.clone() );
849
- }
850
- for (const { time, rotation } of transformData.getValues(timeData.rot, false, true, false)) {
851
- const shiftedTime = time + timeData.timeOffset;
852
- const t = shiftedTime * 60;
853
-
854
- if (!quaternionTimeSamples.has(t)) quaternionTimeSamples.set(t, new Array<Quaternion>());
855
- quaternionTimeSamples.get(t)!.push( rotation.clone() );
856
- }
857
- for (const { time, scale } of transformData.getValues(timeData.scale, false, false, true)) {
858
- const shiftedTime = time + timeData.timeOffset;
859
- const t = shiftedTime * 60;
860
-
861
- if (!scaleTimeSamples.has(t)) scaleTimeSamples.set(t, new Array<Vector3>());
862
- scaleTimeSamples.get(t)!.push( scale.clone() );
863
- }
864
- }
865
- }
866
-
867
- return {
868
- position: positionTimeSamples.size == 0 ? undefined : positionTimeSamples,
869
- quaternion: quaternionTimeSamples.size == 0 ? undefined: quaternionTimeSamples,
870
- scale: scaleTimeSamples.size == 0 ? undefined : scaleTimeSamples,
871
- };
872
- }
873
-
874
- function buildVector3Array_( array: Array<Vector3> ) {
875
- const lines: Array<string> = [];
876
- for ( const v of array ) {
877
- lines.push( `(${fn( v.x )}, ${fn( v.y )}, ${fn( v.z )})` );
878
- }
879
- return lines.join( ', ' );
880
- }
881
-
882
- function buildVector4Array_( array: Array<Quaternion> ) {
883
- const lines: Array<string> = [];
884
- for ( const v of array ) {
885
- lines.push( `(${fn( v.w )}, ${fn( v.x )}, ${fn( v.y )}, ${fn( v.z )})` );
886
- }
887
- return lines.join( ', ' );
888
- }
889
-
890
- function getPerBoneTransformData( bones: Array<Object3D> ): TransformDataByObject {
891
-
892
- const boneToTransformData = new Map<Object3D, TransformData[]>();
893
- if (debug) {
894
- const logData = new Array<string>();
895
- for (const [key, val] of dict) {
896
- logData.push(key.uuid + ": " + val.length + " " + val.map(x => x.clip?.uuid.substring(0, 6)).join(" "));
897
- }
898
- console.log("getPerBoneTransformData\n" + logData.join("\n"));
899
- }
900
-
901
- for (const bone of bones) {
902
- const data = dict.get(bone);
903
- if (!data) continue;
904
- boneToTransformData.set(bone, data);
905
- }
906
-
907
- return boneToTransformData;
908
- }
909
-
910
- function createAllTimeSampleObjects( bones: Array<Object3D> ) {
911
- const perBoneTransformData = getPerBoneTransformData( bones );
912
- const sortedFrameNumbers = getSortedFrameTimes( perBoneTransformData );
913
- return createTimeSamplesObject_( perBoneTransformData, sortedFrameNumbers, bones );
914
- }
915
-
916
- const sanitizeRestPose = _context.quickLookCompatible;
917
-
918
- const rest: Array<Matrix4> = [];
919
- const translations: Array<Vector3> = [];
920
- const rotations: Array<Quaternion> = [];
921
- const scales: Array<Vector3> = [];
922
- for ( const { bone } of boneAndInverse ){
923
-
924
- // Workaround for FB13808839: Rest poses must be decomposable in QuickLook
925
- if (sanitizeRestPose) {
926
- const scale = bone.scale;
927
- if (scale.x == 0) scale.x = 0.00001;
928
- if (scale.y == 0) scale.y = 0.00001;
929
- if (scale.z == 0) scale.z = 0.00001;
930
- rest.push( new Matrix4().compose( bone.position, bone.quaternion, bone.scale )) ;
931
- } else {
932
- rest.push( bone.matrix.clone() );
933
- }
934
- translations.push( bone.position ) ;
935
- rotations.push( bone.quaternion );
936
- scales.push( bone.scale );
937
- }
938
-
939
- const bonesArray = boneAndInverse.map( x => "\"" + getPathToSkeleton(x.bone, assumedRoot) + "\"" ).join( ', ' );
940
- const bindTransforms = boneAndInverse.map( x => buildMatrix( x.inverse.clone().invert() ) ).join( ', ' );
941
-
942
- writer.beginBlock( `def Skeleton "Rig"`);
943
-
944
- writer.appendLine( `uniform matrix4d[] bindTransforms = [${bindTransforms}]` );
945
- writer.appendLine( `uniform token[] joints = [${bonesArray}]` );
946
- writer.appendLine( `uniform token purpose = "guide"` );
947
- writer.appendLine( `uniform matrix4d[] restTransforms = [${rest.map( m => buildMatrix( m ) ).join( ', ' )}]` );
948
-
949
- // In glTF, transformations on the Skeleton are ignored (NODE_SKINNED_MESH_LOCAL_TRANSFORMS validator warning)
950
- // So here we don't write anything to get an identity transform.
951
- // writer.appendLine( `matrix4d xformOp:transform = ${buildMatrix( new Matrix4() )}` );
952
- // writer.appendLine( `uniform token[] xformOpOrder = ["xformOp:transform"]` );
953
-
954
- const timeSampleObjects = createAllTimeSampleObjects ( boneAndInverse.map( x => x.bone ) );
955
-
956
- if (debug) {
957
- // find the first..last value in the time samples
958
- let min = 10000000;
959
- let max = 0;
960
- for (const key of timeSampleObjects.position?.keys() ?? []) {
961
- min = Math.min(min, key);
962
- max = Math.max(max, key);
963
- }
964
- console.log("Time samples", min, max, timeSampleObjects);
965
- }
966
-
967
- writer.beginBlock( `def SkelAnimation "_anim"` );
968
-
969
- // TODO if we include blendshapes we likely need subdivision?
970
- // writer.appendLine( `uniform token[] blendShapes` )
971
- // writer.appendLine( `float[] blendShapeWeights` )
972
-
973
- writer.appendLine( `uniform token[] joints = [${bonesArray}]` );
974
-
975
- writer.appendLine( `quatf[] rotations = [${buildVector4Array_( rotations )}]` );
976
-
977
- if ( timeSampleObjects && timeSampleObjects.quaternion ) {
978
- writer.beginBlock( `quatf[] rotations.timeSamples = {`, '');
979
- const rotationTimeSampleLines = createVector4TimeSampleLines_( timeSampleObjects['quaternion'] );
980
- for ( const line of rotationTimeSampleLines ) {
981
- writer.appendLine( line );
982
- }
983
- writer.closeBlock();
984
-
985
- }
986
-
987
- writer.appendLine( `half3[] scales = [${buildVector3Array_( scales )}]` );
988
-
989
- if ( timeSampleObjects && timeSampleObjects.scale ) {
990
- writer.beginBlock( `half3[] scales.timeSamples = {`, '' );
991
- const scaleTimeSampleLines = createVector3TimeSampleLines_( timeSampleObjects['scale'] );
992
-
993
- for ( const line of scaleTimeSampleLines ) {
994
- writer.appendLine( line );
995
- }
996
- writer.closeBlock();
997
-
998
- }
999
-
1000
- writer.appendLine( `float3[] translations = [${buildVector3Array_( translations )}]` );
1001
-
1002
- if ( timeSampleObjects && timeSampleObjects.position) {
1003
- writer.beginBlock( `float3[] translations.timeSamples = {`, '' );
1004
- const positionTimeSampleLines = createVector3TimeSampleLines_( timeSampleObjects['position'] );
1005
-
1006
- for ( const line of positionTimeSampleLines ) {
1007
- writer.appendLine( line );
1008
- }
1009
- writer.closeBlock();
1010
-
1011
- }
1012
-
1013
- writer.closeBlock();
1014
- writer.closeBlock();
1015
-
1016
- }
1017
- }
1018
-
1019
- onSerialize(writer: USDWriter, _context: USDZExporterContext) {
1020
- if (!this.model) return;
1021
-
1022
- // Workaround: Sanitize TransformData for this object.
1023
- // This works around an issue with wrongly detected animation roots, where some of the indices
1024
- // in the TransformData array are not property set. Reproduces with golem_yokai.glb
1025
- const arr0 = this.animationData.get(this.object);
1026
- if (arr0) {
1027
- for (let i = 0; i < arr0.length; i++) {
1028
- if (arr0[i] !== undefined) continue;
1029
- arr0[i] = new TransformData(null, this.object, null);
1030
- }
1031
- }
1032
-
1033
- const ext = this.ext;
1034
-
1035
- this.skinnedMeshExport(writer, _context, ext);
1036
-
1037
- const object = this.object;
1038
- const model = this.model;
1039
-
1040
- // do we have animation data for this node? if not, return
1041
- const animationData = this.animationData.get(object);
1042
- if (!animationData) return;
1043
-
1044
- // Skinned meshes are handled separately by the method above.
1045
- // They need to be handled first (before checking for animation data) because animation needs to be exported
1046
- // as part of the skinned mesh and that may not be animated at all – if any bone is animated we need to export.
1047
- //@ts-ignore
1048
- if (object.isSkinnedMesh) return;
1049
-
1050
- // Excluding the concrete bone xform hierarchy animation his is mostly useful for debugging,
1051
- // as otherwise we're getting a ton of extra animation data per-bone xform
1052
- // TODO if this turns out to be slow/large (lots of duplicated animation data)
1053
- // we can look into optimizing it, and only including both the xform hierarchy and the animation
1054
- // only when we need it – when anywhere below it in the hierarchy are animated visible meshes.
1055
- //@ts-ignore
1056
- // if (object.isBone) return;
1057
-
1058
- if (debugSerialization) console.log("SERIALIZE", this.model.name, this.object.type, animationData);
1059
-
1060
- // const composedTransform = new Matrix4();
1061
- // writer.appendLine("matrix4d xformOp:transform.timeSamples = {");
1062
- // writer.indent++;
1063
-
1064
- // TransformData is a collection of clips (position, rotation and scale) for a particular node
1065
- // We need to make sure that the same underlying animation clip ends up
1066
- // at the same start time in the USD file, and that we're not getting overlaps to other clips.
1067
- // That means that the same clip (transformData.clip) should end up at the same start time for all nodes.
1068
-
1069
- // calculate start times
1070
- // calculate start times from the transformDatas
1071
- /*
1072
- const startTimes = new Array<number>();
1073
- let currentStartTime = 0;
1074
- for (let i = 0; i < animationData.length; i++) {
1075
- startTimes.push(currentStartTime);
1076
- if (animationData[i] === undefined) {
1077
- console.error("Got an undefined transform data, this is likely a bug.", object, animationData);
1078
- continue;
1079
- }
1080
- currentStartTime += animationData[i].getDuration() + TransformData.animationDurationPadding;
1081
- }
1082
- */
1083
-
1084
- const formatter = Intl.NumberFormat("en-US", {
1085
- maximumFractionDigits: 3,
1086
- minimumFractionDigits: 0,
1087
- useGrouping: false,
1088
- });
1089
-
1090
- function writeAnimationTimesamples(arr: TransformData[], type: "position" | "rotation" | "scale") {
1091
-
1092
- const hasAnimationData = arr.some(x => x && {
1093
- position: x.pos,
1094
- rotation: x.rot,
1095
- scale: x.scale
1096
- }[type]);
1097
- if (!hasAnimationData) {
1098
- return;
1099
- }
1100
-
1101
- switch (type) {
1102
- case "position":
1103
- model.needsTranslate = true;
1104
- writer.beginBlock(`double3 xformOp:translate.timeSamples = {`, '');
1105
- break;
1106
- case "rotation":
1107
- model.needsOrient = true;
1108
- writer.beginBlock(`quatf xformOp:orient.timeSamples = {`, '');
1109
- break;
1110
- case "scale":
1111
- model.needsScale = true;
1112
- writer.beginBlock(`double3 xformOp:scale.timeSamples = {`, '');
1113
- break;
1114
- }
1115
-
1116
- for (let i = 0; i < arr.length; i++) {
1117
- const transformData = arr[i];
1118
- if (!transformData) continue;
1119
- const startTime = ext.getStartTimeByClip(transformData.clip);
1120
- const timesArray = transformData.getSortedTimesArray(type === "position", type === "rotation", type === "scale");
1121
-
1122
- if (!timesArray || timesArray.length === 0) {
1123
- console.error("got an animated object but no time values?", object, transformData);
1124
- continue;
1125
- }
1126
-
1127
- const isRestPose = !transformData.clip;
1128
- const hasPos = type === "position" && (transformData.pos || isRestPose);
1129
- const hasRot = type === "rotation" && (transformData.rot || isRestPose);
1130
- const hasScale = type === "scale" && (transformData.scale || isRestPose);
1131
-
1132
- // Writing out the clip name and duration.
1133
- // If this is a rest pose clip, we still want to write it out, as it's a valid clip.
1134
- if (hasPos || hasRot || hasScale)
1135
- {
1136
- const clipName = transformData.clip?.name ?? "rest";
1137
- const duration = transformData.getDuration();
1138
- if (debug) console.log("Write .timeSamples:", clipName, startTime, duration, arr);
1139
- writer.appendLine("# " + clipName + ": start=" + formatter.format(startTime * TransformData.frameRate) + ", length=" + formatter.format(duration * TransformData.frameRate) + ", frames=" + transformData.getFrames());
1140
- }
1141
-
1142
- if (hasPos) {
1143
- for (const { time, translation } of transformData.getValues(timesArray, true, false, false)) {
1144
- const timeStr = formatter.format((startTime + time) * TransformData.frameRate);
1145
- const line = `${timeStr}: (${fn(translation.x)}, ${fn(translation.y)}, ${fn(translation.z)}),`;
1146
- writer.appendLine(line);
1147
- }
1148
- }
1149
- if (hasRot) {
1150
- for (const { time, rotation } of transformData.getValues(timesArray, false, true, false)) {
1151
- const timeStr = formatter.format((startTime + time) * TransformData.frameRate);
1152
- const line = `${timeStr}: (${fn(rotation.w)}, ${fn(rotation.x)}, ${fn(rotation.y)}, ${fn(rotation.z)}),`;
1153
- writer.appendLine(line);
1154
- }
1155
- }
1156
- if (hasScale) {
1157
- for (const { time, scale } of transformData.getValues(timesArray, false, false, true)) {
1158
- const timeStr = formatter.format((startTime + time) * TransformData.frameRate);
1159
- const line = `${timeStr}: (${fn(scale.x)}, ${fn(scale.y)}, ${fn(scale.z)}),`;
1160
- writer.appendLine(line);
1161
- }
1162
- }
1163
- }
1164
- writer.closeBlock();
1165
- }
1166
- writeAnimationTimesamples(animationData, "position");
1167
- writeAnimationTimesamples(animationData, "rotation");
1168
- writeAnimationTimesamples(animationData, "scale");
1169
-
1170
- // We must be careful here that we don't overwrite the xformOpOrder that the object already had.
1171
- // it _might_ not even have any (if the position/quaternion/scale are all indentity values)
1172
- // so in some cases we end up writing the same xformOpOrder multiple times here...
1173
- // So right now, we just always write the xformOpOrder when traversing the hierarchy, in case something is animated.
1174
-
1175
- // if (xFormOrder.length > 0) {
1176
- // const xformUnique = [...new Set(xFormOrder)];
1177
- // writer.appendLine(`uniform token[] xformOpOrder = [${xformUnique.map(x => `"${x}"`).join(', ')}]`);
1178
- // writer.appendLine('uniform token[] xformOpOrder = ["xformOp:translate", "xformOp:orient", "xformOp:scale"]');
1179
- // }
1180
-
1181
- // for (let i = 0; i < arr.length; i++) {
1182
- // const transformData = arr[i];
1183
- // if (!transformData) continue;
1184
- // const startTime = startTimes[i];
1185
- // const timesArray = transformData.getSortedTimesArray();
1186
-
1187
- // if (!timesArray || timesArray.length === 0) {
1188
- // console.error("got an animated object but no time values?", object, transformData);
1189
- // continue;
1190
- // }
1191
- // for (const { time, translation, rotation, scale } of transformData.getValues(timesArray)) {
1192
- // composedTransform.compose(translation, rotation, scale);
1193
-
1194
-
1195
- // const timeStr = formatter.format((startTime + time) * transformData.frameRate);
1196
- // const line = `${timeStr}: ${buildMatrix(composedTransform)},`;
1197
- // writer.appendLine(line);
1198
- // }
1199
- // }
1200
-
1201
- // writer.indent--;
1202
- // writer.appendLine("}");
1203
- }
1204
- }
1
+ import { AnimationClip, Bone,Interpolant, KeyframeTrack, Matrix4, Object3D, PropertyBinding, Quaternion, Vector3 } from "three";
2
+
3
+ import { isDevEnvironment, showBalloonWarning } from "../../../../engine/debug/debug.js";
4
+ import { getParam } from "../../../../engine/engine_utils.js";
5
+ import { Animator } from "../../../Animator.js";
6
+ import { GameObject } from "../../../Component.js";
7
+ import type { IUSDExporterExtension } from "../Extension.js";
8
+ import { buildMatrix, findStructuralNodesInBoneHierarchy, getPathToSkeleton,usdNumberFormatting as fn, USDObject, USDWriter, USDZExporterContext } from "../ThreeUSDZExporter.js";
9
+
10
+ const debug = getParam("debugusdzanimation");
11
+ const debugSerialization = getParam("debugusdzanimationserialization");
12
+
13
+ export interface UsdzAnimation {
14
+ createAnimation(ext: AnimationExtension, model: USDObject, context);
15
+ }
16
+
17
+ export type AnimationClipCollection = Array<{ root: Object3D, clips: Array<AnimationClip> }>;
18
+
19
+ export class RegisteredAnimationInfo {
20
+
21
+ private _start?: number;
22
+ get start(): number {
23
+ if (this._start === undefined) {
24
+ this._start = this.ext.getStartTimeByClip(this.clip);
25
+ }
26
+ return this._start;
27
+ }
28
+ get duration(): number { return this.clip?.duration ?? TransformData.restPoseClipDuration; }
29
+ get nearestAnimatedRoot(): Object3D | undefined { return this._nearestAnimatedRoot; }
30
+ get clipName(): string { return this.clip?.name ?? "rest"; }
31
+
32
+ private ext: AnimationExtension;
33
+ private root: Object3D;
34
+ private _nearestAnimatedRoot?: Object3D = undefined;
35
+ private clip: AnimationClip | null;
36
+
37
+ // Playback speed. Does not affect how the animation is written, just how fast actions play it back.
38
+ speed?: number;
39
+
40
+ constructor(ext: AnimationExtension, root: Object3D, clip: AnimationClip | null) {
41
+ this.ext = ext;
42
+ this.root = root;
43
+ this.clip = clip;
44
+
45
+ this._nearestAnimatedRoot = this.getNearestAnimatedRoot();
46
+ }
47
+
48
+ private static isDescendantOf(parent: Object3D, child: Object3D) {
49
+ let current: Object3D | null = child;
50
+ if (!current || !parent) return false;
51
+ while (current) {
52
+ if (!current) return false;
53
+ if (current === parent) return true;
54
+ current = current.parent;
55
+ }
56
+ return false;
57
+ }
58
+
59
+ /** Finds the nearest actually animated object under root based on the tracks in the AnimationClip. */
60
+ getNearestAnimatedRoot() {
61
+ let highestRoot: Object3D | undefined = undefined;
62
+ try {
63
+ for (const track of this.clip?.tracks ?? []) {
64
+ const parsedPath = PropertyBinding.parseTrackName(track.name);
65
+ let animationTarget = PropertyBinding.findNode(this.root, parsedPath.nodeName);
66
+ if (animationTarget) {
67
+ if (!highestRoot) highestRoot = animationTarget;
68
+ else {
69
+ if (animationTarget === highestRoot) continue;
70
+ if (RegisteredAnimationInfo.isDescendantOf(highestRoot, animationTarget)) continue;
71
+ if (!RegisteredAnimationInfo.isDescendantOf(animationTarget, highestRoot)) {
72
+ // TODO test this, should find the nearest common ancestor
73
+ while (!RegisteredAnimationInfo.isDescendantOf(animationTarget, highestRoot) && animationTarget.parent) {
74
+ animationTarget = animationTarget.parent;
75
+ }
76
+ if (!RegisteredAnimationInfo.isDescendantOf(animationTarget, highestRoot)) {
77
+ console.error("USDZExporter: Animation clip targets multiple roots that are not parent/child. Please report a bug", this.root, this.clip, highestRoot, animationTarget);
78
+ }
79
+ }
80
+ highestRoot = animationTarget;
81
+ }
82
+ }
83
+ }
84
+ } catch (e) {
85
+ console.error("USDZExporter: Exception when trying to find nearest animated root. Please report a bug", e);
86
+ highestRoot = undefined;
87
+ }
88
+ return highestRoot;
89
+ }
90
+ }
91
+
92
+ export class TransformData {
93
+ clip: AnimationClip | null;
94
+ pos?: KeyframeTrack;
95
+ rot?: KeyframeTrack;
96
+ scale?: KeyframeTrack;
97
+
98
+ private root: Object3D | null;
99
+ private target: Object3D;
100
+ private duration = 0;
101
+ private useRootMotion = false;
102
+
103
+ /** This value can theoretically be anything – a value of 1 is good to clearly see animation gaps.
104
+ * For production, a value of 1/60 is enough, since the files can then still properly play back at 60fps.
105
+ */
106
+ static frameRate = 60;
107
+ static animationDurationPadding = 6 / 60;
108
+ static restPoseClipDuration = 6 / 60;
109
+
110
+ constructor(root: Object3D | null, target: Object3D, clip: AnimationClip | null) {
111
+ this.root = root;
112
+ this.target = target;
113
+ this.clip = clip;
114
+
115
+ // this is a rest pose clip.
116
+ // we assume duration 1/60 and no tracks, and when queried for times we just return [0, duration]
117
+ if (!clip) {
118
+ this.duration = TransformData.restPoseClipDuration;
119
+ }
120
+ else {
121
+ this.duration = clip.duration;
122
+ }
123
+
124
+ // warn if the duration does not equal the maximum time value in the tracks
125
+ if (clip && clip.tracks) {
126
+ const maxTime = Math.max(...clip.tracks.map((t) => t.times[t.times.length - 1]));
127
+ if (maxTime !== this.duration) {
128
+ console.warn("USDZExporter: Animation clip duration does not match the maximum time value in the tracks.", clip, maxTime, this.duration);
129
+ // We need to override the duration, otherwise we end up with gaps in the exported animation
130
+ // where there are actually no written animation values
131
+ this.duration = maxTime;
132
+ }
133
+ }
134
+
135
+ const animator = GameObject.getComponent(root, Animator);
136
+ if (animator) this.useRootMotion = animator.applyRootMotion;
137
+ }
138
+
139
+ addTrack(track: KeyframeTrack) {
140
+ if (!this.clip) {
141
+ console.error("This is a rest clip but you're trying to add tracks to it – this is likely a bug");
142
+ return;
143
+ }
144
+
145
+ if (track.name.endsWith("position")) this.pos = track;
146
+ else if (track.name.endsWith("quaternion")) this.rot = track;
147
+ else if (track.name.endsWith("scale")) this.scale = track;
148
+ else {
149
+ if (track.name.endsWith("activeSelf")) {
150
+ /*
151
+ // Construct a scale track, then apply to the existing scale track.
152
+ // Not supported right now, because it would also require properly tracking that these objects need to be enabled
153
+ // at animation start because they're animating the enabled state... otherwise they just stay disabled from scene start
154
+ const newValues = [...track.values].map((v) => v ? [1,1,1] : [0,0,0]).flat();
155
+ const scaleTrack = new KeyframeTrack(track.name.replace(".activeSelf", ".scale"), track.times, newValues, InterpolateDiscrete);
156
+ if (!this.scale)
157
+ {
158
+ this.scale = scaleTrack;
159
+ console.log("Mock scale track", this.scale);
160
+ }
161
+ */
162
+ console.warn("[USDZ] Animation of enabled/disabled state is not supported for USDZ export and will NOT be exported: " + track.name + " on " + (this.root?.name ?? this.target.name) + ". Animate scale 0/1 instead.");
163
+ }
164
+ else {
165
+ console.warn("[USDZ] Animation track type not supported for USDZ export and will NOT be exported: " + track.name + " on " + (this.root?.name ?? this.target.name) + ". Only .position, .rotation, .scale are supported.");
166
+ }
167
+
168
+ if (isDevEnvironment()) showBalloonWarning("[USDZ] Some animations can't be exported. See console for details.");
169
+ }
170
+ }
171
+
172
+ getFrames(): number {
173
+ if (!this.clip) return 2;
174
+ return Math.max(this.pos?.times?.length ?? 0, this.rot?.times?.length ?? 0, this.scale?.times?.length ?? 0);
175
+ }
176
+
177
+ getDuration(): number {
178
+ return this.duration;
179
+ }
180
+
181
+ getSortedTimesArray(generatePos: boolean = true, generateRot: boolean = true, generateScale: boolean = true) {
182
+ if (!this.clip) return [0, this.duration];
183
+
184
+ const posTimesArray = this.pos?.times;
185
+ const rotTimesArray = this.rot?.times;
186
+ const scaleTimesArray = this.scale?.times;
187
+
188
+ // timesArray is the sorted union of all time values
189
+ const timesArray: number[] = [];
190
+ if (generatePos && posTimesArray) for (const t of posTimesArray) timesArray.push(t);
191
+ if (generateRot && rotTimesArray) for (const t of rotTimesArray) timesArray.push(t);
192
+ if (generateScale && scaleTimesArray) for (const t of scaleTimesArray) timesArray.push(t);
193
+
194
+ // We also need to make sure we have start and end times for these tracks
195
+ // We already ensure this is the case for duration – it's always the maximum time value in the tracks
196
+ // (see constructor)
197
+ if (!timesArray.includes(0)) timesArray.push(0);
198
+
199
+ // sort times so it's increasing
200
+ timesArray.sort((a, b) => a - b);
201
+ // make sure time values are unique
202
+ return [...new Set(timesArray)];
203
+ }
204
+
205
+ /**
206
+ * Returns an iterator that yields the values for each time sample.
207
+ * Values are reused objects - if you want to append them to some array
208
+ * instead of processing them right away, clone() them.
209
+ * @param timesArray
210
+ * @param generatePos
211
+ * @param generateRot
212
+ * @param generateScale
213
+ */
214
+ *getValues(timesArray: number[], generatePos: boolean = true, generateRot: boolean = true, generateScale: boolean = true) {
215
+
216
+ const translation = new Vector3();
217
+ const rotation = new Quaternion();
218
+ const scale = new Vector3(1, 1, 1);
219
+ const object = this.target;
220
+
221
+ const positionInterpolant: Interpolant | undefined = generatePos ? this.pos?.createInterpolant() : undefined;
222
+ const rotationInterpolant: Interpolant | undefined = generateRot ? this.rot?.createInterpolant() : undefined;
223
+ const scaleInterpolant: Interpolant | undefined = generateScale ? this.scale?.createInterpolant() : undefined;
224
+
225
+ if (!positionInterpolant) translation.set(object.position.x, object.position.y, object.position.z);
226
+ if (!rotationInterpolant) rotation.set(object.quaternion.x, object.quaternion.y, object.quaternion.z, object.quaternion.w);
227
+ if (!scaleInterpolant) scale.set(object.scale.x, object.scale.y, object.scale.z);
228
+
229
+ // WORKAROUND because it seems that sometimes we get a quaternion interpolant with a valueSize
230
+ // of its own length... which then goes into an endless loop
231
+ if (positionInterpolant && positionInterpolant.valueSize !== 3)
232
+ positionInterpolant.valueSize = 3;
233
+ if (rotationInterpolant && rotationInterpolant.valueSize !== 4)
234
+ rotationInterpolant.valueSize = 4;
235
+ if (scaleInterpolant && scaleInterpolant.valueSize !== 3)
236
+ scaleInterpolant.valueSize = 3;
237
+
238
+ // We're optionally padding with one extra time step at the beginning and the end
239
+ // So that we don't get unwanted interpolations between clips (during the padding time)
240
+ const extraFrame = 0; // TransformData.animationDurationPadding > 1 / 60 ? 1 : 0;
241
+ for (let index = 0 - extraFrame; index < timesArray.length + extraFrame; index++) {
242
+ let time = 0;
243
+ let returnTime = 0;
244
+ if (index < 0) {
245
+ time = timesArray[0];
246
+ returnTime = time - (TransformData.animationDurationPadding / 2) + 1 / 60;
247
+ }
248
+ else if (index >= timesArray.length) {
249
+ time = timesArray[timesArray.length - 1];
250
+ returnTime = time + (TransformData.animationDurationPadding / 2) - 1 / 60;
251
+ }
252
+ else {
253
+ time = timesArray[index];
254
+ returnTime = time;
255
+ }
256
+
257
+ if (positionInterpolant) {
258
+ const pos = positionInterpolant.evaluate(time);
259
+ translation.set(pos[0], pos[1], pos[2]);
260
+ }
261
+ if (rotationInterpolant) {
262
+ const quat = rotationInterpolant.evaluate(time);
263
+ rotation.set(quat[0], quat[1], quat[2], quat[3]);
264
+ }
265
+ if (scaleInterpolant) {
266
+ const scaleVal = scaleInterpolant.evaluate(time);
267
+ scale.set(scaleVal[0], scaleVal[1], scaleVal[2]);
268
+ }
269
+
270
+ // Apply basic root motion offset – non-animated transformation data is applied to the node again.
271
+ // We're doing this because clips that animate their own root are (typically) not in world space,
272
+ // but in local space and moved to a specific spot in the world.
273
+ if (this.useRootMotion && object === this.root) {
274
+ const rootMatrix = new Matrix4();
275
+ rootMatrix.compose(translation, rotation, scale);
276
+ rootMatrix.multiply(object.matrix);
277
+ rootMatrix.decompose(translation, rotation, scale);
278
+ }
279
+
280
+ yield { time: returnTime, translation, rotation, scale, index };
281
+ }
282
+ }
283
+ }
284
+
285
+ export class AnimationExtension implements IUSDExporterExtension {
286
+
287
+ get extensionName(): string { return "animation" }
288
+ get animationData() { return this.dict; }
289
+ get registeredClips() { return this.clipToStartTime.keys(); }
290
+ get animatedRoots() { return this.rootTargetMap.keys(); }
291
+ get holdClipMap() { return this.clipToHoldClip; }
292
+
293
+ /** For each animated object, contains time/pos/rot/scale samples in the format that USD needs,
294
+ * ready to be written to the .usda file.
295
+ */
296
+ private dict: Map<Object3D, Array<TransformData>> = new Map();
297
+ /** Map of all roots (Animation/Animator or scene) and all targets that they animate.
298
+ * We need that info so that we can ensure that each target has the same number of TransformData entries
299
+ * so that switching between animations doesn't result in data "leaking" to another clip.
300
+ */
301
+ private rootTargetMap = new Map<Object3D, Array<Object3D>>();
302
+ private rootAndClipToRegisteredAnimationMap = new Map<string, RegisteredAnimationInfo>();
303
+ /** Clips registered for each root */
304
+ private rootToRegisteredClip = new Map<Object3D, Array<AnimationClip>>();
305
+ private lastClipEndTime = 0;
306
+ private clipToStartTime: Map<AnimationClip, number> = new Map();
307
+ private clipToHoldClip: Map<AnimationClip, AnimationClip> = new Map();
308
+
309
+ private serializers: SerializeAnimation[] = [];
310
+
311
+ /** Determines if we inject a rest pose clip for each root - only makes sense for QuickLook */
312
+ injectRestPoses = false;
313
+ /** Determines if we inject a PlayAnimationOnClick component with "scenestart" trigger - only makes sense for QuickLook */
314
+ injectImplicitBehaviours = false;
315
+
316
+ constructor(quickLookCompatible: boolean) {
317
+ this.injectRestPoses = quickLookCompatible;
318
+ this.injectImplicitBehaviours = quickLookCompatible;
319
+ }
320
+
321
+ getStartTimeCode() {
322
+ // return the end time + padding of the rest clip, if any exists
323
+ if (!this.injectRestPoses) return 0;
324
+ if (this.rootAndClipToRegisteredAnimationMap.size === 0) return 0;
325
+ // return 0;
326
+ return (TransformData.restPoseClipDuration + TransformData.animationDurationPadding) * 60;
327
+ }
328
+
329
+ /** Returns the end time code, based on 60 frames per second, for all registered animations.
330
+ * This matches the highest time value in the USDZ file. */
331
+ getEndTimeCode() {
332
+ let max = 0;
333
+ for (const [_, info] of this.rootAndClipToRegisteredAnimationMap) {
334
+ const end = info.start + info.duration;
335
+ if (end > max) max = end;
336
+ }
337
+ return max * 60;
338
+ }
339
+
340
+ getClipCount(root: Object3D): number {
341
+ const currentCount = this.rootToRegisteredClip.get(root)?.length ?? 0;
342
+ // The rest pose is not part of rootToRegisteredClip
343
+ // if (this.injectRestPoses) currentCount = currentCount ? currentCount - 1 : 0;
344
+ return currentCount ?? 0;
345
+ }
346
+
347
+ /*
348
+ // TODO why do we have this here and on TransformData? Can RegisteredAnimationInfo not cache this value?
349
+ // TODO we probably want to assert here that this is the same value on all nodes
350
+ getStartTime01(root: Object3D, clip: AnimationClip | null) {
351
+ // This is a rest pose clip, it always starts at 0
352
+ if (!clip) return 0;
353
+
354
+ const targets = this.rootTargetMap.get(root);
355
+ if (!targets) return 0;
356
+ const transformDatas = this.dict.get(targets[0]);
357
+ if (!transformDatas) {
358
+ console.error("Trying to get start time for root that has no animation data", root, clip, ...this.dict);
359
+ return 0;
360
+ }
361
+
362
+ let currentStartTime = 0;
363
+ for (let i = 0; i < transformDatas.length; i++) {
364
+ if (transformDatas[i].clip === clip) break;
365
+ currentStartTime += transformDatas[i].getDuration() + TransformData.animationDurationPadding;
366
+ }
367
+
368
+ return currentStartTime;
369
+ }
370
+ */
371
+
372
+ getStartTimeByClip(clip: AnimationClip | null) {
373
+ if (!clip) return 0;
374
+ if (!this.clipToStartTime.has(clip)) {
375
+ console.error("USDZExporter: Missing start time for clip – please report a bug.", clip);
376
+ return 0;
377
+ }
378
+ const time = this.clipToStartTime.get(clip)!;
379
+ return time;
380
+ }
381
+
382
+ // The same clip could be registered for different roots. All of them need written animation data then.
383
+ // The same root could have multiple clips registered to it. If it does, the clips need to write
384
+ // independent time data, so that playing back an animation on that root doesn't result in data "leaking"/"overlapping".
385
+ // The structure we need is:
386
+ // - MyRoot
387
+ // Animator
388
+ // - Clip1: CubeScale (only animates MyCube), duration: 3s
389
+ // - Clip2: SphereRotation (only animates MySphere), duration: 2s
390
+ // - MyCube
391
+ // - MySphere
392
+ // Results in:
393
+ // - MyRoot
394
+ // - MyCube
395
+ // - # rest clip (0..0.1)
396
+ // - # CubeScale (0.2..3.2)
397
+ // - # rest clip for SphereRotation (3.3..5.3)
398
+ // - MySphere
399
+ // - # rest clip (0..0.1)
400
+ // - # rest clip for CubeScale (0.2..3.2)
401
+ // - # SphereRotation (3.3..5.3)
402
+
403
+ /** Register an AnimationClip for a specific root object.
404
+ * @param root The root object that the animation clip is targeting.
405
+ * @param clip The animation clip to register. If null, a rest pose is registered.
406
+ * @returns The registered animation info, which contains the start time and duration of the clip.
407
+ */
408
+ registerAnimation(root: Object3D, clip: AnimationClip | null): RegisteredAnimationInfo | null {
409
+ if(!root) return null;
410
+ if (!this.rootTargetMap.has(root)) this.rootTargetMap.set(root, []);
411
+
412
+ // if we registered that exact pair already, just return the info
413
+ // no proper tuples in JavaScript, but we can use the uuids for a unique key here
414
+ const hash = root.uuid + (clip?.uuid ?? "-rest");
415
+ if (this.rootAndClipToRegisteredAnimationMap.has(hash)) {
416
+ return this.rootAndClipToRegisteredAnimationMap.get(hash)!;
417
+ }
418
+
419
+ if (debug) console.log("registerAnimation", root, clip);
420
+
421
+ // When injecting a rest clip, the rest clip has ALL animated nodes as targets.
422
+ // So all other nodes will already have at least one animated clip registered, and their own
423
+ // animations need to start at index 1. Otherwise we're getting overlap where everything is
424
+ // in animation 0 and some data overrides each other incorrectly.
425
+ // When we don't inject a rest clip, we start at 0.
426
+ const startIndex = this.injectRestPoses ? 1 : 0;
427
+ const currentCount = (this.rootToRegisteredClip.get(root)?.length ?? 0) + startIndex;
428
+
429
+ const targets = this.rootTargetMap.get(root);
430
+ const unregisteredNodesForThisClip = new Set(targets);
431
+ if (clip && clip.tracks) {
432
+ // We could sort so that supported tracks come first, this allows us to support some additional tracks by
433
+ // modifying what has already been written for the supported ones (e.g. enabled -> modify scale).
434
+ // Only needed if we're actually emulating some unsupported track types in addTrack(...).
435
+ // const sortedTracks = clip.tracks.filter(x => !!x).sort((a, _b) => a.name.endsWith("position") || a.name.endsWith("quaternion") || a.name.endsWith("scale") ? -1 : 1);
436
+ for (const track of clip.tracks) {
437
+ const parsedPath = PropertyBinding.parseTrackName(track.name);
438
+ const animationTarget = PropertyBinding.findNode(root, parsedPath.nodeName);
439
+
440
+ if (!animationTarget) {
441
+ console.warn("no object found for track", track.name, "using " + root.name + " instead");
442
+ continue;
443
+ // // if no object was found it might be that we have a component that references an animation clip but wants to target another object
444
+ // // in that case UnityGLTF writes the name of the component as track targets because it doesnt know of the intented target
445
+ // animationTarget = root;
446
+ }
447
+ if (!this.dict.has(animationTarget)) {
448
+ this.dict.set(animationTarget, []);
449
+ }
450
+ const transformDataForTarget = this.dict.get(animationTarget);
451
+ if (!transformDataForTarget) {
452
+ console.warn("no transform data found for target ", animationTarget, "at slot " + currentCount + ", this is likely a bug");
453
+ continue;
454
+ }
455
+
456
+ // this node has animation data for this clip – no need for additional padding
457
+ unregisteredNodesForThisClip.delete(animationTarget);
458
+
459
+ // Since we're interleaving animations, we need to ensure that for the same root,
460
+ // all clips that "touch" it are written in the same order for all animated nodes.
461
+ // this means we need to pad the TransformData array with empty entries when a particular
462
+ // node inside that root is not animated by a particular clip.
463
+ // It also means that when we encounter a clip that contains animation data for a new node,
464
+ // We need to pad that one's array as well so it starts at the same point.
465
+ // TODO most likely doesn't work for overlapping clips (clips where a root is a child of another root)
466
+ // TODO in that case we may need to pad globally, not per root
467
+
468
+ // Inject a rest pose if we don't have it already
469
+ if (this.injectRestPoses && !transformDataForTarget[0]) {
470
+ console.log("Injecting rest pose", animationTarget, clip, "at slot", currentCount);
471
+ transformDataForTarget[0] = new TransformData(null, animationTarget, null);
472
+ }
473
+ // These all need to be at the same index, otherwise our padding went wrong
474
+ let model = transformDataForTarget[currentCount];
475
+
476
+ if (!model) {
477
+ model = new TransformData(root, animationTarget, clip);
478
+ transformDataForTarget[currentCount] = model;
479
+ }
480
+ model.addTrack(track);
481
+
482
+ // We're keeping track of all animated nodes per root, needed for proper padding
483
+ if (!targets?.includes(animationTarget)) targets?.push(animationTarget);
484
+ }
485
+ }
486
+
487
+ if (debug) console.log("Unregistered nodes for this clip", unregisteredNodesForThisClip, "clip", clip, "at slot", currentCount, "for root", root, "targets", targets)
488
+
489
+ // add padding for nodes that are not animated by this clip
490
+ for (const target of unregisteredNodesForThisClip) {
491
+ const transformDataForTarget = this.dict.get(target);
492
+ if (!transformDataForTarget) continue;
493
+
494
+ // Inject rest pose if these nodes don't have it yet for some reason – this is likely a bug
495
+ if (this.injectRestPoses && !transformDataForTarget[0]) {
496
+ console.warn("Adding rest pose for ", target, clip, "at slot", currentCount, "This is likely a bug, should have been added earlier.");
497
+ const model = new TransformData(null, target, null);
498
+ transformDataForTarget[0] = model;
499
+ }
500
+
501
+ let model = transformDataForTarget[currentCount];
502
+ if (!model) {
503
+ if (debug) console.log("Adding padding clip for ", target, clip, "at slot", currentCount);
504
+ model = new TransformData(root, target, clip);
505
+ transformDataForTarget[currentCount] = model;
506
+ }
507
+ }
508
+
509
+ // get the entry for this object.
510
+ // This doesnt work if we have clips animating multiple objects
511
+ const info = new RegisteredAnimationInfo(this, root, clip);
512
+ this.rootAndClipToRegisteredAnimationMap.set(hash, info);
513
+
514
+ if (debug) console.log({root, clip, info});
515
+ if (clip) {
516
+ const registered = this.rootToRegisteredClip.get(root);
517
+ if (!registered) this.rootToRegisteredClip.set(root, [clip]);
518
+ else registered.push(clip);
519
+
520
+ const lastClip = this.clipToStartTime.get(clip);
521
+ if (!lastClip) {
522
+ if (this.lastClipEndTime == null) this.lastClipEndTime = TransformData.restPoseClipDuration;
523
+
524
+ let newStartTime = this.lastClipEndTime + TransformData.animationDurationPadding;
525
+ let newEndTime = newStartTime + clip.duration;
526
+
527
+ // Round these times, makes it easier to understand what happens in the file
528
+ const roundedStartTime = Math.round(newStartTime * 60) / 60;
529
+ const roundedEndTime = Math.round(newEndTime * 60) / 60;
530
+ if (Math.abs(roundedStartTime - newStartTime) < 0.01) newStartTime = roundedStartTime;
531
+ if (Math.abs(roundedEndTime - newEndTime) < 0.01) newEndTime = roundedEndTime;
532
+ // Round newStartTime up to the next frame
533
+ newStartTime = Math.ceil(newStartTime);
534
+ newEndTime = newStartTime + clip.duration;
535
+
536
+ this.clipToStartTime.set(clip, newStartTime);
537
+ this.lastClipEndTime = newEndTime;
538
+ }
539
+ }
540
+ return info;
541
+ }
542
+
543
+ onAfterHierarchy(_context) {
544
+ if (debug) console.log("Animation clips per animation target node", this.dict);
545
+ }
546
+
547
+ onAfterBuildDocument(_context: any) {
548
+
549
+ // Validation: go through all roots, check if their data and lengths are consistent.
550
+ // There are some cases that we can patch up here, especially if non-overlapping animations have resulted in "holes"
551
+ // in TransformData where only now we know what the matching animation clip actually is.
552
+ if (debug) console.log("Animation data", { dict: this.dict, rootTargetMap: this.rootTargetMap, rootToRegisteredClip: this.rootToRegisteredClip});
553
+
554
+ for (const root of this.rootTargetMap.keys()) {
555
+ const targets = this.rootTargetMap.get(root);
556
+
557
+ if (!targets) continue;
558
+
559
+ // The TransformData[] arrays here should have the same length, and the same durations
560
+ let arrayLength: number | undefined = undefined;
561
+ const durations: Array<number | undefined> = [];
562
+ for (const target of targets) {
563
+ const datas = this.dict.get(target);
564
+ if (!datas) {
565
+ console.error("No data found for target on USDZ export – please report a bug!", target);
566
+ continue;
567
+ }
568
+
569
+ if (arrayLength === undefined) arrayLength = datas?.length;
570
+ if (arrayLength !== datas?.length) console.error("Different array lengths for targets – please report a bug!", datas);
571
+
572
+ for (let i = 0; i < datas.length; i++) {
573
+ let data = datas[i];
574
+ if (!data) {
575
+ // If we don't have TransformData for this object yet, we're emitting a rest pose with the duration
576
+ // of the matching clip that was registered for this root.
577
+ const index = i - (this.injectRestPoses ? 1 : 0);
578
+ datas[i] = new TransformData(null, target, this.rootToRegisteredClip.get(root)![index]);
579
+ data = datas[i];
580
+ }
581
+
582
+ const duration = data.getDuration();
583
+ if (durations[i] === undefined) durations[i] = duration;
584
+ else if (durations[i] !== duration) {
585
+ console.error("Error during UDSZ export: Encountered different animation durations for animated targets. Please report a bug!", {datas, target});
586
+ durations[i] = duration;
587
+ continue;
588
+ }
589
+ }
590
+ }
591
+ }
592
+
593
+ for (const ser of this.serializers) {
594
+ const parent = ser.model?.parent;
595
+ const isEmptyParent = parent?.isDynamic === true;
596
+ if (debugSerialization) console.log(isEmptyParent, ser.model?.parent);
597
+ if (isEmptyParent) {
598
+ ser.registerCallback(parent);
599
+ }
600
+ }
601
+ }
602
+
603
+ onExportObject(object, model: USDObject, _context) {
604
+
605
+ GameObject.foreachComponent(object, (comp) => {
606
+ const c = comp as unknown as UsdzAnimation;
607
+ if (typeof c.createAnimation === "function") {
608
+ c.createAnimation(this, model, _context);
609
+ }
610
+ }, false);
611
+
612
+ // we need to be able to retarget serialization to empty parents before actually serializing (we do that in another callback)
613
+ const ser = new SerializeAnimation(object, this);
614
+ this.serializers.push(ser);
615
+ ser.registerCallback(model);
616
+ }
617
+
618
+ }
619
+
620
+ declare type TransformDataByObject = Map<Object3D, TransformData[]>;
621
+ declare type AnimationClipFrameTimes = { pos: number[], rot: number[], scale: number[], timeOffset: number };
622
+
623
+ class SerializeAnimation {
624
+
625
+ model: USDObject | undefined = undefined;
626
+
627
+ private object: Object3D;
628
+ private animationData: Map<Object3D, Array<TransformData>>;
629
+ private ext: AnimationExtension;
630
+
631
+ private callback?: (writer: USDWriter, context: USDZExporterContext) => void;
632
+
633
+ constructor(object: Object3D, ext: AnimationExtension) {
634
+ this.object = object;
635
+ this.animationData = ext.animationData;
636
+ this.ext = ext;
637
+ }
638
+
639
+ registerCallback(model: USDObject) {
640
+ if (this.model && this.callback) {
641
+ this.model.removeEventListener("serialize", this.callback);
642
+ }
643
+ if (!this.callback)
644
+ this.callback = this.onSerialize.bind(this);
645
+ if (debugSerialization) console.log("REPARENT", model);
646
+ this.model = model;
647
+
648
+ if (this.callback)
649
+ this.model.addEventListener("serialize", this.callback);
650
+ }
651
+
652
+ skinnedMeshExport(writer: USDWriter, _context: USDZExporterContext, ext: AnimationExtension) {
653
+ const model = this.model;
654
+ const dict = this.animationData;
655
+ if (!model) return;
656
+
657
+ if ( model.skinnedMesh ) {
658
+
659
+ const skeleton = model.skinnedMesh.skeleton;
660
+
661
+ const boneAndInverse = new Array<{bone: Object3D, inverse: Matrix4}>();
662
+
663
+ const sortedBones:Bone[] = [];
664
+ const uuidsFound:string[] = [];
665
+ for(const bone of skeleton.bones ) {
666
+ // if (bone.parent!.type !== 'Bone')
667
+ {
668
+ sortedBones.push(bone);
669
+ uuidsFound.push(bone.uuid);
670
+ const inverse = skeleton.boneInverses[skeleton.bones.indexOf(bone)];
671
+ boneAndInverse.push({bone, inverse});
672
+ }
673
+ }
674
+
675
+ let maxSteps = 10_000;
676
+ while (uuidsFound.length < skeleton.bones.length && maxSteps-- > 0) {
677
+ for (const sortedBone of sortedBones){
678
+ const children = sortedBone.children as Bone[];
679
+ for (const childBone of children){
680
+ if (uuidsFound.indexOf(childBone.uuid) === -1 && skeleton.bones.indexOf(childBone) !== -1){
681
+ sortedBones.push(childBone);
682
+ uuidsFound.push(childBone.uuid);
683
+ const childInverse = skeleton.boneInverses[skeleton.bones.indexOf(childBone)];
684
+ boneAndInverse.push({bone: childBone, inverse: childInverse});
685
+ }
686
+ }
687
+ }
688
+ }
689
+
690
+ if (maxSteps <= 0) console.error("Failed to sort bones in skinned mesh", model.skinnedMesh, skeleton.bones, uuidsFound);
691
+
692
+ for (const structuralNode of findStructuralNodesInBoneHierarchy(skeleton.bones)) {
693
+ boneAndInverse.push({bone: structuralNode, inverse: structuralNode.matrixWorld.clone().invert()});
694
+ }
695
+
696
+ // sort bones by path – need to be sorted in the same order as during mesh export
697
+ const assumedRoot = boneAndInverse[0].bone.parent!;
698
+ if (!assumedRoot) console.error("No bone parent found for skinned mesh during USDZ export", model.skinnedMesh);
699
+ boneAndInverse.sort((a, b) => getPathToSkeleton(a.bone, assumedRoot) > getPathToSkeleton(b.bone, assumedRoot) ? 1 : -1);
700
+
701
+ function createVector3TimeSampleLines_( values: Map<number, Vector3[]> ) {
702
+
703
+ const lines:string[] = []
704
+ for (const [frame, frameValues] of values) {
705
+ let line = `${frame} : [`;
706
+ const boneRotations: Array<string> = [];
707
+ for ( const v of frameValues ) {
708
+ boneRotations.push( `(${fn( v.x )}, ${fn( v.y )}, ${fn( v.z )})` );
709
+ }
710
+ line = line.concat( boneRotations.join( ', ' ) );
711
+ line = line.concat( '],' );
712
+ lines.push( line );
713
+ }
714
+
715
+ return lines;
716
+
717
+ }
718
+
719
+ function createVector4TimeSampleLines_( rotations: Map<number, Quaternion[]> ) {
720
+
721
+ const lines:string[] = []
722
+
723
+ for (const [frame, frameRotations] of rotations) {
724
+ let line = `${frame} : [`;
725
+ const boneRotations: Array<string> = [];
726
+ for ( const v of frameRotations ) {
727
+ boneRotations.push( `(${fn( v.w )}, ${fn( v.x )}, ${fn( v.y )}, ${fn( v.z )})` );
728
+ }
729
+ line = line.concat( boneRotations.join( ', ' ) );
730
+ line = line.concat( '],' );
731
+ lines.push( line );
732
+ }
733
+
734
+ return lines;
735
+
736
+ }
737
+
738
+ function getSortedFrameTimes( boneToTransformData: TransformDataByObject ): AnimationClipFrameTimes[] {
739
+
740
+ // We should have a proper rectangular array,
741
+ // Where for each bone we have the same number of TransformData entries.
742
+ let numberOfEntries: number | undefined = undefined;
743
+ let allBonesHaveSameNumberOfTransformDataEntries = true;
744
+ const undefinedBoneEntries = new Map<Object3D, Array<number>>();
745
+ for (const [bone, transformDatas] of boneToTransformData) {
746
+ if (numberOfEntries === undefined) numberOfEntries = transformDatas.length;
747
+ if (numberOfEntries !== transformDatas.length) {
748
+ allBonesHaveSameNumberOfTransformDataEntries = false;
749
+ }
750
+ let index = 0;
751
+ for (const transformData of transformDatas) {
752
+ index++;
753
+ if (!transformData) {
754
+ if (!undefinedBoneEntries.has(bone)) undefinedBoneEntries.set(bone, []);
755
+ undefinedBoneEntries.get(bone)!.push(index);
756
+ }
757
+ }
758
+ }
759
+
760
+ // TODO not working yet for multiple skinned characters at the same time
761
+ if (debug) {
762
+ console.log("Bone count: ", boneToTransformData.size, "TransformData entries per bone: ", numberOfEntries, "Undefined bone entries: ", undefinedBoneEntries);
763
+ }
764
+ console.assert(allBonesHaveSameNumberOfTransformDataEntries, "All bones should have the same number of TransformData entries", boneToTransformData);
765
+ console.assert(undefinedBoneEntries.size === 0, "All TransformData entries should be set", undefinedBoneEntries);
766
+ const times: AnimationClipFrameTimes[] = [];
767
+
768
+ for (const [bone, transformDatas] of boneToTransformData) {
769
+
770
+ /*
771
+ // calculate start times from the transformDatas
772
+ const startTimes = new Array<number>();
773
+ let currentStartTime = 0;
774
+ for (let i = 0; i < transformDatas.length; i++) {
775
+ startTimes.push(currentStartTime);
776
+ currentStartTime += transformDatas[i].getDuration() + TransformData.animationDurationPadding;
777
+ }
778
+ */
779
+
780
+ for (let i = 0; i < transformDatas.length; i++) {
781
+ const transformData = transformDatas[i];
782
+ // const timeOffset = transformData.getStartTime(dict);
783
+ const timeOffset = ext.getStartTimeByClip(transformData.clip);
784
+ if (times.length <= i) {
785
+ times.push({pos: [], rot: [], scale: [], timeOffset});
786
+ }
787
+
788
+ const perTransfromDataTimes = times[i];
789
+
790
+ perTransfromDataTimes.pos.push( ...transformData.getSortedTimesArray(true, false, false));
791
+ perTransfromDataTimes.rot.push( ...transformData.getSortedTimesArray(false, true, false));
792
+ perTransfromDataTimes.scale.push( ...transformData.getSortedTimesArray(false, false, true));
793
+ }
794
+ }
795
+
796
+ for (const perTransfromDataTimes of times) {
797
+
798
+ /*
799
+ // TODO we're doing that in animation export as well
800
+ if (!times.pos.includes(0)) times.pos.push(0);
801
+ if (!times.rot.includes(0)) times.rot.push(0);
802
+ if (!times.scale.includes(0)) times.scale.push(0);
803
+ */
804
+
805
+ // sort times so it's increasing
806
+ perTransfromDataTimes.pos.sort((a, b) => a - b);
807
+ perTransfromDataTimes.rot.sort((a, b) => a - b);
808
+ perTransfromDataTimes.scale.sort((a, b) => a - b);
809
+
810
+ // make sure time values are unique
811
+ perTransfromDataTimes.pos = [...new Set(perTransfromDataTimes.pos)];
812
+ perTransfromDataTimes.rot = [...new Set(perTransfromDataTimes.rot)];
813
+ perTransfromDataTimes.scale = [...new Set(perTransfromDataTimes.scale)];
814
+ }
815
+
816
+ return times;
817
+ }
818
+
819
+ function createTimeSamplesObject_( data: TransformDataByObject, sortedComponentFrameNumbers: AnimationClipFrameTimes[], bones: Array<Object3D> ) {
820
+ const positionTimeSamples = new Map<number, Array<Vector3>>();
821
+ const quaternionTimeSamples = new Map<number, Array<Quaternion>>();
822
+ const scaleTimeSamples = new Map<number, Array<Vector3>>();
823
+
824
+ const count = sortedComponentFrameNumbers.length;
825
+
826
+ // return sampled data for each bone
827
+ for ( const bone of bones ) {
828
+ const boneEntryInData = data.get( bone );
829
+
830
+ let emptyTransformData: TransformData | undefined = undefined;
831
+ // if we have animation data for this bone, check that it's the right amount.
832
+ if (boneEntryInData)
833
+ console.assert(boneEntryInData.length === count, "We should have the same number of TransformData entries for each bone", boneEntryInData, sortedComponentFrameNumbers);
834
+ // if we don't have animation data, create an empty one – 
835
+ // it will automatically map to the rest pose, albeit inefficiently
836
+ else
837
+ emptyTransformData = new TransformData(null, bone, null);
838
+
839
+ for (let i = 0; i < count; i++) {
840
+ const transformData = boneEntryInData ? boneEntryInData[i] : emptyTransformData!;
841
+ const timeData = sortedComponentFrameNumbers[i];
842
+
843
+ for (const { time, translation } of transformData.getValues(timeData.pos, true, false, false)) {
844
+ const shiftedTime = time + timeData.timeOffset;
845
+ const t = shiftedTime * 60;
846
+
847
+ if (!positionTimeSamples.has(t)) positionTimeSamples.set(t, new Array<Vector3>());
848
+ positionTimeSamples.get(t)!.push( translation.clone() );
849
+ }
850
+ for (const { time, rotation } of transformData.getValues(timeData.rot, false, true, false)) {
851
+ const shiftedTime = time + timeData.timeOffset;
852
+ const t = shiftedTime * 60;
853
+
854
+ if (!quaternionTimeSamples.has(t)) quaternionTimeSamples.set(t, new Array<Quaternion>());
855
+ quaternionTimeSamples.get(t)!.push( rotation.clone() );
856
+ }
857
+ for (const { time, scale } of transformData.getValues(timeData.scale, false, false, true)) {
858
+ const shiftedTime = time + timeData.timeOffset;
859
+ const t = shiftedTime * 60;
860
+
861
+ if (!scaleTimeSamples.has(t)) scaleTimeSamples.set(t, new Array<Vector3>());
862
+ scaleTimeSamples.get(t)!.push( scale.clone() );
863
+ }
864
+ }
865
+ }
866
+
867
+ return {
868
+ position: positionTimeSamples.size == 0 ? undefined : positionTimeSamples,
869
+ quaternion: quaternionTimeSamples.size == 0 ? undefined: quaternionTimeSamples,
870
+ scale: scaleTimeSamples.size == 0 ? undefined : scaleTimeSamples,
871
+ };
872
+ }
873
+
874
+ function buildVector3Array_( array: Array<Vector3> ) {
875
+ const lines: Array<string> = [];
876
+ for ( const v of array ) {
877
+ lines.push( `(${fn( v.x )}, ${fn( v.y )}, ${fn( v.z )})` );
878
+ }
879
+ return lines.join( ', ' );
880
+ }
881
+
882
+ function buildVector4Array_( array: Array<Quaternion> ) {
883
+ const lines: Array<string> = [];
884
+ for ( const v of array ) {
885
+ lines.push( `(${fn( v.w )}, ${fn( v.x )}, ${fn( v.y )}, ${fn( v.z )})` );
886
+ }
887
+ return lines.join( ', ' );
888
+ }
889
+
890
+ function getPerBoneTransformData( bones: Array<Object3D> ): TransformDataByObject {
891
+
892
+ const boneToTransformData = new Map<Object3D, TransformData[]>();
893
+ if (debug) {
894
+ const logData = new Array<string>();
895
+ for (const [key, val] of dict) {
896
+ logData.push(key.uuid + ": " + val.length + " " + val.map(x => x.clip?.uuid.substring(0, 6)).join(" "));
897
+ }
898
+ console.log("getPerBoneTransformData\n" + logData.join("\n"));
899
+ }
900
+
901
+ for (const bone of bones) {
902
+ const data = dict.get(bone);
903
+ if (!data) continue;
904
+ boneToTransformData.set(bone, data);
905
+ }
906
+
907
+ return boneToTransformData;
908
+ }
909
+
910
+ function createAllTimeSampleObjects( bones: Array<Object3D> ) {
911
+ const perBoneTransformData = getPerBoneTransformData( bones );
912
+ const sortedFrameNumbers = getSortedFrameTimes( perBoneTransformData );
913
+ return createTimeSamplesObject_( perBoneTransformData, sortedFrameNumbers, bones );
914
+ }
915
+
916
+ const sanitizeRestPose = _context.quickLookCompatible;
917
+
918
+ const rest: Array<Matrix4> = [];
919
+ const translations: Array<Vector3> = [];
920
+ const rotations: Array<Quaternion> = [];
921
+ const scales: Array<Vector3> = [];
922
+ for ( const { bone } of boneAndInverse ){
923
+
924
+ // Workaround for FB13808839: Rest poses must be decomposable in QuickLook
925
+ if (sanitizeRestPose) {
926
+ const scale = bone.scale;
927
+ if (scale.x == 0) scale.x = 0.00001;
928
+ if (scale.y == 0) scale.y = 0.00001;
929
+ if (scale.z == 0) scale.z = 0.00001;
930
+ rest.push( new Matrix4().compose( bone.position, bone.quaternion, bone.scale )) ;
931
+ } else {
932
+ rest.push( bone.matrix.clone() );
933
+ }
934
+ translations.push( bone.position ) ;
935
+ rotations.push( bone.quaternion );
936
+ scales.push( bone.scale );
937
+ }
938
+
939
+ const bonesArray = boneAndInverse.map( x => "\"" + getPathToSkeleton(x.bone, assumedRoot) + "\"" ).join( ', ' );
940
+ const bindTransforms = boneAndInverse.map( x => buildMatrix( x.inverse.clone().invert() ) ).join( ', ' );
941
+
942
+ writer.beginBlock( `def Skeleton "Rig"`);
943
+
944
+ writer.appendLine( `uniform matrix4d[] bindTransforms = [${bindTransforms}]` );
945
+ writer.appendLine( `uniform token[] joints = [${bonesArray}]` );
946
+ writer.appendLine( `uniform token purpose = "guide"` );
947
+ writer.appendLine( `uniform matrix4d[] restTransforms = [${rest.map( m => buildMatrix( m ) ).join( ', ' )}]` );
948
+
949
+ // In glTF, transformations on the Skeleton are ignored (NODE_SKINNED_MESH_LOCAL_TRANSFORMS validator warning)
950
+ // So here we don't write anything to get an identity transform.
951
+ // writer.appendLine( `matrix4d xformOp:transform = ${buildMatrix( new Matrix4() )}` );
952
+ // writer.appendLine( `uniform token[] xformOpOrder = ["xformOp:transform"]` );
953
+
954
+ const timeSampleObjects = createAllTimeSampleObjects ( boneAndInverse.map( x => x.bone ) );
955
+
956
+ if (debug) {
957
+ // find the first..last value in the time samples
958
+ let min = 10000000;
959
+ let max = 0;
960
+ for (const key of timeSampleObjects.position?.keys() ?? []) {
961
+ min = Math.min(min, key);
962
+ max = Math.max(max, key);
963
+ }
964
+ console.log("Time samples", min, max, timeSampleObjects);
965
+ }
966
+
967
+ writer.beginBlock( `def SkelAnimation "_anim"` );
968
+
969
+ // TODO if we include blendshapes we likely need subdivision?
970
+ // writer.appendLine( `uniform token[] blendShapes` )
971
+ // writer.appendLine( `float[] blendShapeWeights` )
972
+
973
+ writer.appendLine( `uniform token[] joints = [${bonesArray}]` );
974
+
975
+ writer.appendLine( `quatf[] rotations = [${buildVector4Array_( rotations )}]` );
976
+
977
+ if ( timeSampleObjects && timeSampleObjects.quaternion ) {
978
+ writer.beginBlock( `quatf[] rotations.timeSamples = {`, '');
979
+ const rotationTimeSampleLines = createVector4TimeSampleLines_( timeSampleObjects['quaternion'] );
980
+ for ( const line of rotationTimeSampleLines ) {
981
+ writer.appendLine( line );
982
+ }
983
+ writer.closeBlock();
984
+
985
+ }
986
+
987
+ writer.appendLine( `half3[] scales = [${buildVector3Array_( scales )}]` );
988
+
989
+ if ( timeSampleObjects && timeSampleObjects.scale ) {
990
+ writer.beginBlock( `half3[] scales.timeSamples = {`, '' );
991
+ const scaleTimeSampleLines = createVector3TimeSampleLines_( timeSampleObjects['scale'] );
992
+
993
+ for ( const line of scaleTimeSampleLines ) {
994
+ writer.appendLine( line );
995
+ }
996
+ writer.closeBlock();
997
+
998
+ }
999
+
1000
+ writer.appendLine( `float3[] translations = [${buildVector3Array_( translations )}]` );
1001
+
1002
+ if ( timeSampleObjects && timeSampleObjects.position) {
1003
+ writer.beginBlock( `float3[] translations.timeSamples = {`, '' );
1004
+ const positionTimeSampleLines = createVector3TimeSampleLines_( timeSampleObjects['position'] );
1005
+
1006
+ for ( const line of positionTimeSampleLines ) {
1007
+ writer.appendLine( line );
1008
+ }
1009
+ writer.closeBlock();
1010
+
1011
+ }
1012
+
1013
+ writer.closeBlock();
1014
+ writer.closeBlock();
1015
+
1016
+ }
1017
+ }
1018
+
1019
+ onSerialize(writer: USDWriter, _context: USDZExporterContext) {
1020
+ if (!this.model) return;
1021
+
1022
+ // Workaround: Sanitize TransformData for this object.
1023
+ // This works around an issue with wrongly detected animation roots, where some of the indices
1024
+ // in the TransformData array are not property set. Reproduces with golem_yokai.glb
1025
+ const arr0 = this.animationData.get(this.object);
1026
+ if (arr0) {
1027
+ for (let i = 0; i < arr0.length; i++) {
1028
+ if (arr0[i] !== undefined) continue;
1029
+ arr0[i] = new TransformData(null, this.object, null);
1030
+ }
1031
+ }
1032
+
1033
+ const ext = this.ext;
1034
+
1035
+ this.skinnedMeshExport(writer, _context, ext);
1036
+
1037
+ const object = this.object;
1038
+ const model = this.model;
1039
+
1040
+ // do we have animation data for this node? if not, return
1041
+ const animationData = this.animationData.get(object);
1042
+ if (!animationData) return;
1043
+
1044
+ // Skinned meshes are handled separately by the method above.
1045
+ // They need to be handled first (before checking for animation data) because animation needs to be exported
1046
+ // as part of the skinned mesh and that may not be animated at all – if any bone is animated we need to export.
1047
+ //@ts-ignore
1048
+ if (object.isSkinnedMesh) return;
1049
+
1050
+ // Excluding the concrete bone xform hierarchy animation his is mostly useful for debugging,
1051
+ // as otherwise we're getting a ton of extra animation data per-bone xform
1052
+ // TODO if this turns out to be slow/large (lots of duplicated animation data)
1053
+ // we can look into optimizing it, and only including both the xform hierarchy and the animation
1054
+ // only when we need it – when anywhere below it in the hierarchy are animated visible meshes.
1055
+ //@ts-ignore
1056
+ // if (object.isBone) return;
1057
+
1058
+ if (debugSerialization) console.log("SERIALIZE", this.model.name, this.object.type, animationData);
1059
+
1060
+ // const composedTransform = new Matrix4();
1061
+ // writer.appendLine("matrix4d xformOp:transform.timeSamples = {");
1062
+ // writer.indent++;
1063
+
1064
+ // TransformData is a collection of clips (position, rotation and scale) for a particular node
1065
+ // We need to make sure that the same underlying animation clip ends up
1066
+ // at the same start time in the USD file, and that we're not getting overlaps to other clips.
1067
+ // That means that the same clip (transformData.clip) should end up at the same start time for all nodes.
1068
+
1069
+ // calculate start times
1070
+ // calculate start times from the transformDatas
1071
+ /*
1072
+ const startTimes = new Array<number>();
1073
+ let currentStartTime = 0;
1074
+ for (let i = 0; i < animationData.length; i++) {
1075
+ startTimes.push(currentStartTime);
1076
+ if (animationData[i] === undefined) {
1077
+ console.error("Got an undefined transform data, this is likely a bug.", object, animationData);
1078
+ continue;
1079
+ }
1080
+ currentStartTime += animationData[i].getDuration() + TransformData.animationDurationPadding;
1081
+ }
1082
+ */
1083
+
1084
+ const formatter = Intl.NumberFormat("en-US", {
1085
+ maximumFractionDigits: 3,
1086
+ minimumFractionDigits: 0,
1087
+ useGrouping: false,
1088
+ });
1089
+
1090
+ function writeAnimationTimesamples(arr: TransformData[], type: "position" | "rotation" | "scale") {
1091
+
1092
+ const hasAnimationData = arr.some(x => x && {
1093
+ position: x.pos,
1094
+ rotation: x.rot,
1095
+ scale: x.scale
1096
+ }[type]);
1097
+ if (!hasAnimationData) {
1098
+ return;
1099
+ }
1100
+
1101
+ switch (type) {
1102
+ case "position":
1103
+ model.needsTranslate = true;
1104
+ writer.beginBlock(`double3 xformOp:translate.timeSamples = {`, '');
1105
+ break;
1106
+ case "rotation":
1107
+ model.needsOrient = true;
1108
+ writer.beginBlock(`quatf xformOp:orient.timeSamples = {`, '');
1109
+ break;
1110
+ case "scale":
1111
+ model.needsScale = true;
1112
+ writer.beginBlock(`double3 xformOp:scale.timeSamples = {`, '');
1113
+ break;
1114
+ }
1115
+
1116
+ for (let i = 0; i < arr.length; i++) {
1117
+ const transformData = arr[i];
1118
+ if (!transformData) continue;
1119
+ const startTime = ext.getStartTimeByClip(transformData.clip);
1120
+ const timesArray = transformData.getSortedTimesArray(type === "position", type === "rotation", type === "scale");
1121
+
1122
+ if (!timesArray || timesArray.length === 0) {
1123
+ console.error("got an animated object but no time values?", object, transformData);
1124
+ continue;
1125
+ }
1126
+
1127
+ const isRestPose = !transformData.clip;
1128
+ const hasPos = type === "position" && (transformData.pos || isRestPose);
1129
+ const hasRot = type === "rotation" && (transformData.rot || isRestPose);
1130
+ const hasScale = type === "scale" && (transformData.scale || isRestPose);
1131
+
1132
+ // Writing out the clip name and duration.
1133
+ // If this is a rest pose clip, we still want to write it out, as it's a valid clip.
1134
+ if (hasPos || hasRot || hasScale)
1135
+ {
1136
+ const clipName = transformData.clip?.name ?? "rest";
1137
+ const duration = transformData.getDuration();
1138
+ if (debug) console.log("Write .timeSamples:", clipName, startTime, duration, arr);
1139
+ writer.appendLine("# " + clipName + ": start=" + formatter.format(startTime * TransformData.frameRate) + ", length=" + formatter.format(duration * TransformData.frameRate) + ", frames=" + transformData.getFrames());
1140
+ }
1141
+
1142
+ if (hasPos) {
1143
+ for (const { time, translation } of transformData.getValues(timesArray, true, false, false)) {
1144
+ const timeStr = formatter.format((startTime + time) * TransformData.frameRate);
1145
+ const line = `${timeStr}: (${fn(translation.x)}, ${fn(translation.y)}, ${fn(translation.z)}),`;
1146
+ writer.appendLine(line);
1147
+ }
1148
+ }
1149
+ if (hasRot) {
1150
+ for (const { time, rotation } of transformData.getValues(timesArray, false, true, false)) {
1151
+ const timeStr = formatter.format((startTime + time) * TransformData.frameRate);
1152
+ const line = `${timeStr}: (${fn(rotation.w)}, ${fn(rotation.x)}, ${fn(rotation.y)}, ${fn(rotation.z)}),`;
1153
+ writer.appendLine(line);
1154
+ }
1155
+ }
1156
+ if (hasScale) {
1157
+ for (const { time, scale } of transformData.getValues(timesArray, false, false, true)) {
1158
+ const timeStr = formatter.format((startTime + time) * TransformData.frameRate);
1159
+ const line = `${timeStr}: (${fn(scale.x)}, ${fn(scale.y)}, ${fn(scale.z)}),`;
1160
+ writer.appendLine(line);
1161
+ }
1162
+ }
1163
+ }
1164
+ writer.closeBlock();
1165
+ }
1166
+ writeAnimationTimesamples(animationData, "position");
1167
+ writeAnimationTimesamples(animationData, "rotation");
1168
+ writeAnimationTimesamples(animationData, "scale");
1169
+
1170
+ // We must be careful here that we don't overwrite the xformOpOrder that the object already had.
1171
+ // it _might_ not even have any (if the position/quaternion/scale are all indentity values)
1172
+ // so in some cases we end up writing the same xformOpOrder multiple times here...
1173
+ // So right now, we just always write the xformOpOrder when traversing the hierarchy, in case something is animated.
1174
+
1175
+ // if (xFormOrder.length > 0) {
1176
+ // const xformUnique = [...new Set(xFormOrder)];
1177
+ // writer.appendLine(`uniform token[] xformOpOrder = [${xformUnique.map(x => `"${x}"`).join(', ')}]`);
1178
+ // writer.appendLine('uniform token[] xformOpOrder = ["xformOp:translate", "xformOp:orient", "xformOp:scale"]');
1179
+ // }
1180
+
1181
+ // for (let i = 0; i < arr.length; i++) {
1182
+ // const transformData = arr[i];
1183
+ // if (!transformData) continue;
1184
+ // const startTime = startTimes[i];
1185
+ // const timesArray = transformData.getSortedTimesArray();
1186
+
1187
+ // if (!timesArray || timesArray.length === 0) {
1188
+ // console.error("got an animated object but no time values?", object, transformData);
1189
+ // continue;
1190
+ // }
1191
+ // for (const { time, translation, rotation, scale } of transformData.getValues(timesArray)) {
1192
+ // composedTransform.compose(translation, rotation, scale);
1193
+
1194
+
1195
+ // const timeStr = formatter.format((startTime + time) * transformData.frameRate);
1196
+ // const line = `${timeStr}: ${buildMatrix(composedTransform)},`;
1197
+ // writer.appendLine(line);
1198
+ // }
1199
+ // }
1200
+
1201
+ // writer.indent--;
1202
+ // writer.appendLine("}");
1203
+ }
1204
+ }