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

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 (1054) hide show
  1. package/CHANGELOG.md +3614 -3608
  2. package/LICENSE.md +10 -10
  3. package/README.md +64 -64
  4. package/components.needle.json +1 -1
  5. package/dist/needle-engine.bundle.js +2399 -2347
  6. package/dist/needle-engine.bundle.light.js +2395 -2343
  7. package/dist/needle-engine.bundle.light.min.js +89 -89
  8. package/dist/needle-engine.bundle.light.umd.cjs +84 -84
  9. package/dist/needle-engine.bundle.min.js +89 -89
  10. package/dist/needle-engine.bundle.umd.cjs +79 -79
  11. package/dist/needle-engine.d.ts +138 -130
  12. package/dist/needle-engine.light.d.ts +138 -130
  13. package/dist/postprocessing.js +1513 -1659
  14. package/dist/postprocessing.light.js +1513 -1659
  15. package/dist/postprocessing.light.min.js +66 -80
  16. package/dist/postprocessing.light.umd.cjs +69 -83
  17. package/dist/postprocessing.min.js +66 -80
  18. package/dist/postprocessing.umd.cjs +69 -83
  19. package/dist/vendor.js +1 -1
  20. package/dist/vendor.light.js +1 -1
  21. package/lib/asap/needle-asap.d.ts +1 -1
  22. package/lib/asap/needle-asap.js +95 -95
  23. package/lib/asap/sessiongranted.d.ts +3 -3
  24. package/lib/asap/sessiongranted.js +65 -65
  25. package/lib/asap/utils.d.ts +1 -1
  26. package/lib/asap/utils.js +3 -3
  27. package/lib/engine/analytics/index.d.ts +6 -6
  28. package/lib/engine/analytics/index.js +12 -12
  29. package/lib/engine/analytics/lcp.d.ts +3 -3
  30. package/lib/engine/analytics/lcp.js +34 -34
  31. package/lib/engine/api.d.ts +81 -81
  32. package/lib/engine/api.js +80 -80
  33. package/lib/engine/assets/index.d.ts +11 -11
  34. package/lib/engine/assets/index.js +47 -47
  35. package/lib/engine/assets/static.d.ts +1 -1
  36. package/lib/engine/assets/static.js +4 -4
  37. package/lib/engine/codegen/register_types.d.ts +1 -1
  38. package/lib/engine/codegen/register_types.js +300 -300
  39. package/lib/engine/debug/debug.d.ts +15 -15
  40. package/lib/engine/debug/debug.js +44 -44
  41. package/lib/engine/debug/debug_console.d.ts +2 -2
  42. package/lib/engine/debug/debug_console.js +307 -307
  43. package/lib/engine/debug/debug_overlay.d.ts +22 -22
  44. package/lib/engine/debug/debug_overlay.js +316 -316
  45. package/lib/engine/debug/debug_spatial_console.d.ts +2 -2
  46. package/lib/engine/debug/debug_spatial_console.js +390 -390
  47. package/lib/engine/debug/index.d.ts +2 -2
  48. package/lib/engine/debug/index.js +2 -2
  49. package/lib/engine/engine.d.ts +4 -0
  50. package/lib/engine/engine.js +12 -0
  51. package/lib/engine/engine.js.map +1 -0
  52. package/lib/engine/engine_addressables.d.ts +166 -166
  53. package/lib/engine/engine_addressables.js +608 -608
  54. package/lib/engine/engine_animation.d.ts +43 -43
  55. package/lib/engine/engine_animation.js +133 -133
  56. package/lib/engine/engine_application.d.ts +40 -40
  57. package/lib/engine/engine_application.js +104 -104
  58. package/lib/engine/engine_assetdatabase.d.ts +25 -25
  59. package/lib/engine/engine_assetdatabase.js +344 -344
  60. package/lib/engine/engine_audio.d.ts +4 -4
  61. package/lib/engine/engine_audio.js +23 -23
  62. package/lib/engine/engine_camera.d.ts +13 -13
  63. package/lib/engine/engine_camera.js +30 -30
  64. package/lib/engine/engine_components.d.ts +110 -110
  65. package/lib/engine/engine_components.js +382 -380
  66. package/lib/engine/engine_components.js.map +1 -1
  67. package/lib/engine/engine_components_internal.d.ts +9 -9
  68. package/lib/engine/engine_components_internal.js +36 -36
  69. package/lib/engine/engine_constants.d.ts +10 -10
  70. package/lib/engine/engine_constants.js +41 -41
  71. package/lib/engine/engine_context.d.ts +345 -345
  72. package/lib/engine/engine_context.js +1515 -1515
  73. package/lib/engine/engine_context_registry.d.ts +71 -71
  74. package/lib/engine/engine_context_registry.js +117 -117
  75. package/lib/engine/engine_coroutine.d.ts +35 -35
  76. package/lib/engine/engine_coroutine.js +52 -52
  77. package/lib/engine/engine_create_objects.d.ts +118 -118
  78. package/lib/engine/engine_create_objects.js +308 -308
  79. package/lib/engine/engine_default_parameters.d.ts +2 -2
  80. package/lib/engine/engine_default_parameters.js +3 -3
  81. package/lib/engine/engine_editor-sync.d.ts +21 -21
  82. package/lib/engine/engine_editor-sync.js +4 -4
  83. package/lib/engine/engine_element.d.ts +113 -113
  84. package/lib/engine/engine_element.js +829 -830
  85. package/lib/engine/engine_element.js.map +1 -1
  86. package/lib/engine/engine_element_attributes.d.ts +72 -72
  87. package/lib/engine/engine_element_attributes.js +1 -1
  88. package/lib/engine/engine_element_extras.d.ts +6 -6
  89. package/lib/engine/engine_element_extras.js +13 -13
  90. package/lib/engine/engine_element_loading.d.ts +44 -44
  91. package/lib/engine/engine_element_loading.js +349 -349
  92. package/lib/engine/engine_element_overlay.d.ts +21 -21
  93. package/lib/engine/engine_element_overlay.js +166 -166
  94. package/lib/engine/engine_fileloader.d.ts +2 -2
  95. package/lib/engine/engine_fileloader.js +8 -8
  96. package/lib/engine/engine_gameobject.d.ts +68 -68
  97. package/lib/engine/engine_gameobject.js +591 -591
  98. package/lib/engine/engine_generic_utils.d.ts +1 -1
  99. package/lib/engine/engine_generic_utils.js +13 -13
  100. package/lib/engine/engine_gizmos.d.ts +149 -149
  101. package/lib/engine/engine_gizmos.js +530 -530
  102. package/lib/engine/engine_gltf.d.ts +12 -12
  103. package/lib/engine/engine_gltf.js +15 -15
  104. package/lib/engine/engine_gltf_builtin_components.d.ts +7 -7
  105. package/lib/engine/engine_gltf_builtin_components.js +341 -341
  106. package/lib/engine/engine_hot_reload.d.ts +7 -7
  107. package/lib/engine/engine_hot_reload.js +184 -184
  108. package/lib/engine/engine_input.d.ts +352 -352
  109. package/lib/engine/engine_input.js +1265 -1265
  110. package/lib/engine/engine_input_utils.d.ts +2 -2
  111. package/lib/engine/engine_input_utils.js +22 -22
  112. package/lib/engine/engine_instancing.d.ts +19 -19
  113. package/lib/engine/engine_instancing.js +39 -39
  114. package/lib/engine/engine_license.d.ts +9 -9
  115. package/lib/engine/engine_license.js +320 -320
  116. package/lib/engine/engine_lifecycle_api.d.ts +76 -76
  117. package/lib/engine/engine_lifecycle_api.js +99 -99
  118. package/lib/engine/engine_lifecycle_functions_internal.d.ts +32 -32
  119. package/lib/engine/engine_lifecycle_functions_internal.js +146 -146
  120. package/lib/engine/engine_lightdata.d.ts +23 -23
  121. package/lib/engine/engine_lightdata.js +91 -91
  122. package/lib/engine/engine_loaders.d.ts +13 -13
  123. package/lib/engine/engine_loaders.js +62 -62
  124. package/lib/engine/engine_lods.d.ts +31 -31
  125. package/lib/engine/engine_lods.js +146 -146
  126. package/lib/engine/engine_mainloop_utils.d.ts +32 -32
  127. package/lib/engine/engine_mainloop_utils.js +466 -466
  128. package/lib/engine/engine_math.d.ts +114 -114
  129. package/lib/engine/engine_math.js +247 -247
  130. package/lib/engine/engine_modules.d.ts +36 -36
  131. package/lib/engine/engine_modules.js +85 -85
  132. package/lib/engine/engine_networking.d.ts +252 -252
  133. package/lib/engine/engine_networking.js +743 -743
  134. package/lib/engine/engine_networking_auto.d.ts +24 -24
  135. package/lib/engine/engine_networking_auto.js +310 -310
  136. package/lib/engine/engine_networking_blob.d.ts +48 -48
  137. package/lib/engine/engine_networking_blob.js +212 -212
  138. package/lib/engine/engine_networking_files.d.ts +35 -35
  139. package/lib/engine/engine_networking_files.js +172 -172
  140. package/lib/engine/engine_networking_files_default_components.d.ts +6 -6
  141. package/lib/engine/engine_networking_files_default_components.js +42 -42
  142. package/lib/engine/engine_networking_instantiate.d.ts +100 -100
  143. package/lib/engine/engine_networking_instantiate.js +345 -345
  144. package/lib/engine/engine_networking_peer.d.ts +15 -15
  145. package/lib/engine/engine_networking_peer.js +132 -132
  146. package/lib/engine/engine_networking_streams.d.ts +123 -123
  147. package/lib/engine/engine_networking_streams.js +645 -645
  148. package/lib/engine/engine_networking_types.d.ts +22 -22
  149. package/lib/engine/engine_networking_types.js +7 -7
  150. package/lib/engine/engine_networking_utils.d.ts +2 -2
  151. package/lib/engine/engine_networking_utils.js +20 -20
  152. package/lib/engine/engine_networking_websocket.d.ts +1 -1
  153. package/lib/engine/engine_networking_websocket.js +2 -2
  154. package/lib/engine/engine_patcher.d.ts +10 -10
  155. package/lib/engine/engine_patcher.js +142 -142
  156. package/lib/engine/engine_physics.d.ts +152 -152
  157. package/lib/engine/engine_physics.js +645 -645
  158. package/lib/engine/engine_physics.types.d.ts +40 -40
  159. package/lib/engine/engine_physics.types.js +33 -33
  160. package/lib/engine/engine_physics_rapier.d.ts +147 -147
  161. package/lib/engine/engine_physics_rapier.js +1432 -1432
  162. package/lib/engine/engine_playerview.d.ts +26 -26
  163. package/lib/engine/engine_playerview.js +64 -64
  164. package/lib/engine/engine_scenelighting.d.ts +71 -71
  165. package/lib/engine/engine_scenelighting.js +226 -226
  166. package/lib/engine/engine_scenetools.d.ts +50 -50
  167. package/lib/engine/engine_scenetools.js +321 -321
  168. package/lib/engine/engine_serialization.d.ts +3 -3
  169. package/lib/engine/engine_serialization.js +3 -3
  170. package/lib/engine/engine_serialization_builtin_serializer.d.ts +72 -72
  171. package/lib/engine/engine_serialization_builtin_serializer.js +403 -403
  172. package/lib/engine/engine_serialization_core.d.ts +85 -85
  173. package/lib/engine/engine_serialization_core.js +602 -602
  174. package/lib/engine/engine_serialization_decorator.d.ts +23 -23
  175. package/lib/engine/engine_serialization_decorator.js +66 -66
  176. package/lib/engine/engine_setup.d.ts +1 -1
  177. package/lib/engine/engine_setup.js +2 -2
  178. package/lib/engine/engine_shaders.d.ts +53 -53
  179. package/lib/engine/engine_shaders.js +252 -252
  180. package/lib/engine/engine_shims.d.ts +4 -4
  181. package/lib/engine/engine_shims.js +24 -24
  182. package/lib/engine/engine_test_utils.d.ts +39 -39
  183. package/lib/engine/engine_test_utils.js +83 -83
  184. package/lib/engine/engine_texture.d.ts +28 -28
  185. package/lib/engine/engine_texture.js +64 -64
  186. package/lib/engine/engine_three_utils.d.ts +201 -201
  187. package/lib/engine/engine_three_utils.js +731 -731
  188. package/lib/engine/engine_time.d.ts +51 -51
  189. package/lib/engine/engine_time.js +82 -82
  190. package/lib/engine/engine_time_utils.d.ts +88 -88
  191. package/lib/engine/engine_time_utils.js +215 -215
  192. package/lib/engine/engine_tonemapping.d.ts +2 -2
  193. package/lib/engine/engine_tonemapping.js +194 -194
  194. package/lib/engine/engine_types.d.ts +572 -572
  195. package/lib/engine/engine_types.js +88 -88
  196. package/lib/engine/engine_typestore.d.ts +28 -28
  197. package/lib/engine/engine_typestore.js +55 -55
  198. package/lib/engine/engine_util_decorator.d.ts +13 -13
  199. package/lib/engine/engine_util_decorator.js +116 -116
  200. package/lib/engine/engine_utils.d.ts +266 -266
  201. package/lib/engine/engine_utils.js +878 -878
  202. package/lib/engine/engine_utils_format.d.ts +21 -21
  203. package/lib/engine/engine_utils_format.js +193 -193
  204. package/lib/engine/engine_utils_screenshot.d.ts +159 -159
  205. package/lib/engine/engine_utils_screenshot.js +513 -513
  206. package/lib/engine/engine_utils_screenshot.js.map +1 -1
  207. package/lib/engine/engine_utils_screenshot.xr.d.ts +5 -5
  208. package/lib/engine/engine_utils_screenshot.xr.js +90 -90
  209. package/lib/engine/engine_web_api.d.ts +12 -0
  210. package/lib/engine/engine_web_api.js +113 -0
  211. package/lib/engine/engine_web_api.js.map +1 -0
  212. package/lib/engine/engine_xr.d.ts +1 -1
  213. package/lib/engine/engine_xr.js +1 -1
  214. package/lib/engine/export/gltf/Writers.d.ts +19 -19
  215. package/lib/engine/export/gltf/Writers.js +24 -24
  216. package/lib/engine/export/gltf/index.d.ts +11 -11
  217. package/lib/engine/export/gltf/index.js +123 -123
  218. package/lib/engine/export/index.d.ts +2 -2
  219. package/lib/engine/export/index.js +2 -2
  220. package/lib/engine/export/state.d.ts +7 -7
  221. package/lib/engine/export/state.js +17 -17
  222. package/lib/engine/export/utils.d.ts +2 -2
  223. package/lib/engine/export/utils.js +7 -7
  224. package/lib/engine/extensions/EXT_texture_exr.d.ts +8 -8
  225. package/lib/engine/extensions/EXT_texture_exr.js +32 -32
  226. package/lib/engine/extensions/NEEDLE_animator_controller_model.d.ts +122 -122
  227. package/lib/engine/extensions/NEEDLE_animator_controller_model.js +95 -95
  228. package/lib/engine/extensions/NEEDLE_components.d.ts +35 -35
  229. package/lib/engine/extensions/NEEDLE_components.js +220 -220
  230. package/lib/engine/extensions/NEEDLE_gameobject_data.d.ts +10 -10
  231. package/lib/engine/extensions/NEEDLE_gameobject_data.js +57 -57
  232. package/lib/engine/extensions/NEEDLE_lighting_settings.d.ts +37 -37
  233. package/lib/engine/extensions/NEEDLE_lighting_settings.js +157 -157
  234. package/lib/engine/extensions/NEEDLE_lightmaps.d.ts +18 -18
  235. package/lib/engine/extensions/NEEDLE_lightmaps.js +99 -99
  236. package/lib/engine/extensions/NEEDLE_persistent_assets.d.ts +11 -11
  237. package/lib/engine/extensions/NEEDLE_persistent_assets.js +63 -63
  238. package/lib/engine/extensions/NEEDLE_progressive.d.ts +1 -1
  239. package/lib/engine/extensions/NEEDLE_progressive.js +1 -1
  240. package/lib/engine/extensions/NEEDLE_render_objects.d.ts +13 -13
  241. package/lib/engine/extensions/NEEDLE_render_objects.js +159 -159
  242. package/lib/engine/extensions/NEEDLE_techniques_webgl.d.ts +38 -38
  243. package/lib/engine/extensions/NEEDLE_techniques_webgl.js +564 -564
  244. package/lib/engine/extensions/extension_resolver.d.ts +4 -4
  245. package/lib/engine/extensions/extension_resolver.js +1 -1
  246. package/lib/engine/extensions/extension_utils.d.ts +12 -12
  247. package/lib/engine/extensions/extension_utils.js +152 -152
  248. package/lib/engine/extensions/extensions.d.ts +31 -31
  249. package/lib/engine/extensions/extensions.js +103 -103
  250. package/lib/engine/extensions/index.d.ts +6 -6
  251. package/lib/engine/extensions/index.js +6 -6
  252. package/lib/engine/extensions/usage_tracker.d.ts +13 -13
  253. package/lib/engine/extensions/usage_tracker.js +65 -65
  254. package/lib/engine/js-extensions/Camera.d.ts +1 -1
  255. package/lib/engine/js-extensions/Camera.js +39 -39
  256. package/lib/engine/js-extensions/ExtensionUtils.d.ts +9 -9
  257. package/lib/engine/js-extensions/ExtensionUtils.js +67 -67
  258. package/lib/engine/js-extensions/Layers.d.ts +6 -6
  259. package/lib/engine/js-extensions/Layers.js +22 -22
  260. package/lib/engine/js-extensions/Object3D.d.ts +120 -120
  261. package/lib/engine/js-extensions/Object3D.js +136 -136
  262. package/lib/engine/js-extensions/RGBAColor.d.ts +23 -22
  263. package/lib/engine/js-extensions/RGBAColor.js +110 -62
  264. package/lib/engine/js-extensions/RGBAColor.js.map +1 -1
  265. package/lib/engine/js-extensions/Vector.d.ts +3 -3
  266. package/lib/engine/js-extensions/Vector.js +13 -13
  267. package/lib/engine/js-extensions/index.d.ts +5 -5
  268. package/lib/engine/js-extensions/index.js +5 -5
  269. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.d.ts +4 -4
  270. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +75 -75
  271. package/lib/engine/shaders/shaderData.d.ts +55 -55
  272. package/lib/engine/shaders/shaderData.js +58 -58
  273. package/lib/engine/tests/test_utils.d.ts +2 -2
  274. package/lib/engine/tests/test_utils.js +53 -53
  275. package/lib/engine/webcomponents/WebXRButtons.d.ts +56 -56
  276. package/lib/engine/webcomponents/WebXRButtons.js +230 -230
  277. package/lib/engine/webcomponents/api.d.ts +5 -5
  278. package/lib/engine/webcomponents/api.js +4 -4
  279. package/lib/engine/webcomponents/buttons.d.ts +39 -39
  280. package/lib/engine/webcomponents/buttons.js +237 -237
  281. package/lib/engine/webcomponents/fonts.d.ts +9 -9
  282. package/lib/engine/webcomponents/fonts.js +32 -32
  283. package/lib/engine/webcomponents/icons.d.ts +9 -9
  284. package/lib/engine/webcomponents/icons.js +52 -52
  285. package/lib/engine/webcomponents/index.d.ts +1 -1
  286. package/lib/engine/webcomponents/index.js +1 -1
  287. package/lib/engine/webcomponents/logo-element.d.ts +10 -10
  288. package/lib/engine/webcomponents/logo-element.js +67 -67
  289. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.d.ts +37 -37
  290. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.js +513 -513
  291. package/lib/engine/webcomponents/needle menu/needle-menu.d.ts +151 -151
  292. package/lib/engine/webcomponents/needle menu/needle-menu.js +1018 -1018
  293. package/lib/engine/webcomponents/needle-button.d.ts +34 -34
  294. package/lib/engine/webcomponents/needle-button.js +161 -161
  295. package/lib/engine/xr/NeedleXRController.d.ts +313 -313
  296. package/lib/engine/xr/NeedleXRController.js +1008 -1008
  297. package/lib/engine/xr/NeedleXRSession.d.ts +339 -339
  298. package/lib/engine/xr/NeedleXRSession.js +1427 -1427
  299. package/lib/engine/xr/NeedleXRSync.d.ts +22 -22
  300. package/lib/engine/xr/NeedleXRSync.js +188 -188
  301. package/lib/engine/xr/SceneTransition.d.ts +18 -18
  302. package/lib/engine/xr/SceneTransition.js +69 -69
  303. package/lib/engine/xr/TempXRContext.d.ts +34 -34
  304. package/lib/engine/xr/TempXRContext.js +187 -187
  305. package/lib/engine/xr/XRRig.d.ts +7 -7
  306. package/lib/engine/xr/XRRig.js +1 -1
  307. package/lib/engine/xr/api.d.ts +6 -6
  308. package/lib/engine/xr/api.js +6 -6
  309. package/lib/engine/xr/events.d.ts +66 -66
  310. package/lib/engine/xr/events.js +93 -93
  311. package/lib/engine/xr/internal.d.ts +12 -12
  312. package/lib/engine/xr/internal.js +25 -25
  313. package/lib/engine/xr/usdz.d.ts +12 -12
  314. package/lib/engine/xr/usdz.js +29 -29
  315. package/lib/engine/xr/utils.d.ts +11 -11
  316. package/lib/engine/xr/utils.js +34 -34
  317. package/lib/engine-components/AlignmentConstraint.d.ts +10 -10
  318. package/lib/engine-components/AlignmentConstraint.js +39 -39
  319. package/lib/engine-components/Animation.d.ts +156 -156
  320. package/lib/engine-components/Animation.js +508 -508
  321. package/lib/engine-components/AnimationCurve.d.ts +40 -40
  322. package/lib/engine-components/AnimationCurve.js +159 -159
  323. package/lib/engine-components/AnimationUtils.d.ts +8 -8
  324. package/lib/engine-components/AnimationUtils.js +27 -27
  325. package/lib/engine-components/AnimationUtilsAutoplay.d.ts +1 -1
  326. package/lib/engine-components/AnimationUtilsAutoplay.js +39 -39
  327. package/lib/engine-components/Animator.d.ts +217 -217
  328. package/lib/engine-components/Animator.js +354 -354
  329. package/lib/engine-components/AnimatorController.d.ts +227 -227
  330. package/lib/engine-components/AnimatorController.js +1152 -1152
  331. package/lib/engine-components/AudioListener.d.ts +33 -33
  332. package/lib/engine-components/AudioListener.js +86 -86
  333. package/lib/engine-components/AudioSource.d.ts +217 -217
  334. package/lib/engine-components/AudioSource.js +627 -627
  335. package/lib/engine-components/AvatarLoader.d.ts +80 -80
  336. package/lib/engine-components/AvatarLoader.js +231 -231
  337. package/lib/engine-components/AxesHelper.d.ts +32 -32
  338. package/lib/engine-components/AxesHelper.js +67 -67
  339. package/lib/engine-components/BasicIKConstraint.d.ts +9 -9
  340. package/lib/engine-components/BasicIKConstraint.js +43 -43
  341. package/lib/engine-components/BoxCollider.d.ts +2 -2
  342. package/lib/engine-components/BoxCollider.js +2 -2
  343. package/lib/engine-components/BoxHelperComponent.d.ts +47 -47
  344. package/lib/engine-components/BoxHelperComponent.js +102 -102
  345. package/lib/engine-components/Camera.d.ts +231 -231
  346. package/lib/engine-components/Camera.js +700 -694
  347. package/lib/engine-components/Camera.js.map +1 -1
  348. package/lib/engine-components/CameraUtils.d.ts +1 -1
  349. package/lib/engine-components/CameraUtils.js +118 -127
  350. package/lib/engine-components/CameraUtils.js.map +1 -1
  351. package/lib/engine-components/CharacterController.d.ts +55 -55
  352. package/lib/engine-components/CharacterController.js +236 -236
  353. package/lib/engine-components/Collider.d.ts +188 -188
  354. package/lib/engine-components/Collider.js +369 -369
  355. package/lib/engine-components/Component.d.ts +792 -792
  356. package/lib/engine-components/Component.js +915 -915
  357. package/lib/engine-components/ContactShadows.d.ts +82 -82
  358. package/lib/engine-components/ContactShadows.js +430 -430
  359. package/lib/engine-components/DeleteBox.d.ts +19 -19
  360. package/lib/engine-components/DeleteBox.js +58 -58
  361. package/lib/engine-components/DeviceFlag.d.ts +16 -16
  362. package/lib/engine-components/DeviceFlag.js +47 -47
  363. package/lib/engine-components/DragControls.d.ts +170 -170
  364. package/lib/engine-components/DragControls.js +1421 -1421
  365. package/lib/engine-components/DropListener.d.ts +215 -215
  366. package/lib/engine-components/DropListener.js +630 -630
  367. package/lib/engine-components/Duplicatable.d.ts +35 -35
  368. package/lib/engine-components/Duplicatable.js +202 -202
  369. package/lib/engine-components/EventList.d.ts +54 -54
  370. package/lib/engine-components/EventList.js +232 -232
  371. package/lib/engine-components/EventTrigger.d.ts +33 -33
  372. package/lib/engine-components/EventTrigger.js +75 -75
  373. package/lib/engine-components/EventType.d.ts +22 -22
  374. package/lib/engine-components/EventType.js +23 -23
  375. package/lib/engine-components/FlyControls.d.ts +10 -0
  376. package/lib/engine-components/FlyControls.js +29 -0
  377. package/lib/engine-components/FlyControls.js.map +1 -0
  378. package/lib/engine-components/Fog.d.ts +22 -22
  379. package/lib/engine-components/Fog.js +61 -61
  380. package/lib/engine-components/Gizmos.d.ts +17 -17
  381. package/lib/engine-components/Gizmos.js +64 -64
  382. package/lib/engine-components/GridHelper.d.ts +20 -20
  383. package/lib/engine-components/GridHelper.js +54 -54
  384. package/lib/engine-components/GroundProjection.d.ts +67 -67
  385. package/lib/engine-components/GroundProjection.js +343 -343
  386. package/lib/engine-components/Interactable.d.ts +12 -12
  387. package/lib/engine-components/Interactable.js +12 -12
  388. package/lib/engine-components/Joints.d.ts +19 -19
  389. package/lib/engine-components/Joints.js +51 -51
  390. package/lib/engine-components/LODGroup.d.ts +35 -35
  391. package/lib/engine-components/LODGroup.js +152 -152
  392. package/lib/engine-components/Light.d.ts +180 -180
  393. package/lib/engine-components/Light.js +535 -535
  394. package/lib/engine-components/LookAtConstraint.d.ts +19 -19
  395. package/lib/engine-components/LookAtConstraint.js +35 -35
  396. package/lib/engine-components/NeedleMenu.d.ts +50 -50
  397. package/lib/engine-components/NeedleMenu.js +92 -92
  398. package/lib/engine-components/NestedGltf.d.ts +25 -25
  399. package/lib/engine-components/NestedGltf.js +88 -88
  400. package/lib/engine-components/Networking.d.ts +54 -54
  401. package/lib/engine-components/Networking.js +112 -112
  402. package/lib/engine-components/OffsetConstraint.d.ts +14 -14
  403. package/lib/engine-components/OffsetConstraint.js +65 -65
  404. package/lib/engine-components/OrbitControls.d.ts +266 -266
  405. package/lib/engine-components/OrbitControls.js +1009 -1009
  406. package/lib/engine-components/PlayerColor.d.ts +19 -19
  407. package/lib/engine-components/PlayerColor.js +94 -94
  408. package/lib/engine-components/ReflectionProbe.d.ts +27 -26
  409. package/lib/engine-components/ReflectionProbe.js +201 -194
  410. package/lib/engine-components/ReflectionProbe.js.map +1 -1
  411. package/lib/engine-components/Renderer.d.ts +153 -153
  412. package/lib/engine-components/Renderer.js +830 -830
  413. package/lib/engine-components/RendererInstancing.d.ts +140 -140
  414. package/lib/engine-components/RendererInstancing.js +744 -744
  415. package/lib/engine-components/RendererLightmap.d.ts +24 -24
  416. package/lib/engine-components/RendererLightmap.js +182 -182
  417. package/lib/engine-components/RigidBody.d.ts +155 -155
  418. package/lib/engine-components/RigidBody.js +517 -517
  419. package/lib/engine-components/SceneSwitcher.d.ts +263 -263
  420. package/lib/engine-components/SceneSwitcher.js +951 -951
  421. package/lib/engine-components/ScreenCapture.d.ts +144 -144
  422. package/lib/engine-components/ScreenCapture.js +547 -547
  423. package/lib/engine-components/ShadowCatcher.d.ts +33 -33
  424. package/lib/engine-components/ShadowCatcher.js +166 -166
  425. package/lib/engine-components/Skybox.d.ts +82 -82
  426. package/lib/engine-components/Skybox.js +448 -448
  427. package/lib/engine-components/SmoothFollow.d.ts +34 -34
  428. package/lib/engine-components/SmoothFollow.js +82 -82
  429. package/lib/engine-components/SpatialTrigger.d.ts +102 -102
  430. package/lib/engine-components/SpatialTrigger.js +225 -225
  431. package/lib/engine-components/SpectatorCamera.d.ts +111 -111
  432. package/lib/engine-components/SpectatorCamera.js +715 -715
  433. package/lib/engine-components/SphereCollider.d.ts +2 -2
  434. package/lib/engine-components/SphereCollider.js +2 -2
  435. package/lib/engine-components/SpriteRenderer.d.ts +132 -132
  436. package/lib/engine-components/SpriteRenderer.js +472 -472
  437. package/lib/engine-components/SyncedCamera.d.ts +41 -41
  438. package/lib/engine-components/SyncedCamera.js +199 -199
  439. package/lib/engine-components/SyncedRoom.d.ts +106 -106
  440. package/lib/engine-components/SyncedRoom.js +371 -371
  441. package/lib/engine-components/SyncedTransform.d.ts +94 -88
  442. package/lib/engine-components/SyncedTransform.js +331 -326
  443. package/lib/engine-components/SyncedTransform.js.map +1 -1
  444. package/lib/engine-components/TestRunner.d.ts +16 -16
  445. package/lib/engine-components/TestRunner.js +102 -102
  446. package/lib/engine-components/TransformGizmo.d.ts +75 -75
  447. package/lib/engine-components/TransformGizmo.js +209 -209
  448. package/lib/engine-components/VideoPlayer.d.ts +184 -184
  449. package/lib/engine-components/VideoPlayer.js +978 -978
  450. package/lib/engine-components/Voip.d.ts +67 -67
  451. package/lib/engine-components/Voip.js +360 -360
  452. package/lib/engine-components/api.d.ts +51 -51
  453. package/lib/engine-components/api.js +50 -50
  454. package/lib/engine-components/avatar/AvatarBlink_Simple.d.ts +11 -11
  455. package/lib/engine-components/avatar/AvatarBlink_Simple.js +76 -76
  456. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.d.ts +14 -14
  457. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.js +68 -68
  458. package/lib/engine-components/avatar/Avatar_Brain_LookAt.d.ts +29 -29
  459. package/lib/engine-components/avatar/Avatar_Brain_LookAt.js +121 -121
  460. package/lib/engine-components/avatar/Avatar_MouthShapes.d.ts +15 -15
  461. package/lib/engine-components/avatar/Avatar_MouthShapes.js +79 -79
  462. package/lib/engine-components/avatar/Avatar_MustacheShake.d.ts +9 -9
  463. package/lib/engine-components/avatar/Avatar_MustacheShake.js +29 -29
  464. package/lib/engine-components/codegen/components.d.ts +216 -216
  465. package/lib/engine-components/codegen/components.js +218 -218
  466. package/lib/engine-components/debug/LogStats.d.ts +5 -5
  467. package/lib/engine-components/debug/LogStats.js +18 -18
  468. package/lib/engine-components/export/gltf/GltfExport.d.ts +30 -30
  469. package/lib/engine-components/export/gltf/GltfExport.js +246 -246
  470. package/lib/engine-components/export/gltf/index.d.ts +1 -1
  471. package/lib/engine-components/export/gltf/index.js +1 -1
  472. package/lib/engine-components/export/index.d.ts +1 -1
  473. package/lib/engine-components/export/index.js +1 -1
  474. package/lib/engine-components/export/usdz/Extension.d.ts +22 -22
  475. package/lib/engine-components/export/usdz/Extension.js +1 -1
  476. package/lib/engine-components/export/usdz/ThreeUSDZExporter.d.ts +160 -160
  477. package/lib/engine-components/export/usdz/ThreeUSDZExporter.js +1782 -1782
  478. package/lib/engine-components/export/usdz/USDZExporter.d.ts +130 -130
  479. package/lib/engine-components/export/usdz/USDZExporter.js +663 -663
  480. package/lib/engine-components/export/usdz/extensions/Animation.d.ts +106 -106
  481. package/lib/engine-components/export/usdz/extensions/Animation.js +1071 -1071
  482. package/lib/engine-components/export/usdz/extensions/DocumentExtension.d.ts +5 -5
  483. package/lib/engine-components/export/usdz/extensions/DocumentExtension.js +6 -6
  484. package/lib/engine-components/export/usdz/extensions/USDZText.d.ts +54 -54
  485. package/lib/engine-components/export/usdz/extensions/USDZText.js +203 -203
  486. package/lib/engine-components/export/usdz/extensions/USDZUI.d.ts +8 -8
  487. package/lib/engine-components/export/usdz/extensions/USDZUI.js +157 -157
  488. package/lib/engine-components/export/usdz/extensions/behavior/Actions.d.ts +30 -30
  489. package/lib/engine-components/export/usdz/extensions/behavior/Actions.js +88 -88
  490. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.d.ts +10 -10
  491. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.js +86 -86
  492. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.d.ts +28 -28
  493. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.js +290 -290
  494. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.d.ts +190 -190
  495. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.js +1060 -1060
  496. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.d.ts +135 -135
  497. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.js +548 -548
  498. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.d.ts +7 -7
  499. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.js +115 -115
  500. package/lib/engine-components/export/usdz/index.d.ts +3 -3
  501. package/lib/engine-components/export/usdz/index.js +2 -2
  502. package/lib/engine-components/export/usdz/utils/animationutils.d.ts +7 -7
  503. package/lib/engine-components/export/usdz/utils/animationutils.js +163 -163
  504. package/lib/engine-components/export/usdz/utils/quicklook.d.ts +2 -2
  505. package/lib/engine-components/export/usdz/utils/quicklook.js +43 -43
  506. package/lib/engine-components/particlesystem/ParticleSystem.d.ts +177 -177
  507. package/lib/engine-components/particlesystem/ParticleSystem.js +1176 -1176
  508. package/lib/engine-components/particlesystem/ParticleSystemModules.d.ts +526 -526
  509. package/lib/engine-components/particlesystem/ParticleSystemModules.js +1930 -1930
  510. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.d.ts +25 -25
  511. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.js +87 -87
  512. package/lib/engine-components/particlesystem/api.d.ts +2 -2
  513. package/lib/engine-components/particlesystem/api.js +2 -2
  514. package/lib/engine-components/postprocessing/Effects/Antialiasing.d.ts +17 -17
  515. package/lib/engine-components/postprocessing/Effects/Antialiasing.js +50 -50
  516. package/lib/engine-components/postprocessing/Effects/BloomEffect.d.ts +46 -46
  517. package/lib/engine-components/postprocessing/Effects/BloomEffect.js +113 -113
  518. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.d.ts +11 -11
  519. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.js +39 -39
  520. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.d.ts +15 -15
  521. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.js +92 -92
  522. package/lib/engine-components/postprocessing/Effects/DepthOfField.d.ts +25 -25
  523. package/lib/engine-components/postprocessing/Effects/DepthOfField.js +104 -104
  524. package/lib/engine-components/postprocessing/Effects/EffectWrapper.d.ts +12 -12
  525. package/lib/engine-components/postprocessing/Effects/EffectWrapper.js +18 -18
  526. package/lib/engine-components/postprocessing/Effects/Pixelation.d.ts +11 -11
  527. package/lib/engine-components/postprocessing/Effects/Pixelation.js +32 -32
  528. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.d.ts +18 -18
  529. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.js +91 -91
  530. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.d.ts +70 -70
  531. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.js +175 -175
  532. package/lib/engine-components/postprocessing/Effects/Sharpening.d.ts +17 -17
  533. package/lib/engine-components/postprocessing/Effects/Sharpening.js +123 -123
  534. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.d.ts +17 -17
  535. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.js +70 -70
  536. package/lib/engine-components/postprocessing/Effects/Tonemapping.d.ts +26 -26
  537. package/lib/engine-components/postprocessing/Effects/Tonemapping.js +138 -138
  538. package/lib/engine-components/postprocessing/Effects/Vignette.d.ts +15 -15
  539. package/lib/engine-components/postprocessing/Effects/Vignette.js +60 -60
  540. package/lib/engine-components/postprocessing/PostProcessingEffect.d.ts +72 -72
  541. package/lib/engine-components/postprocessing/PostProcessingEffect.js +149 -149
  542. package/lib/engine-components/postprocessing/PostProcessingHandler.d.ts +25 -25
  543. package/lib/engine-components/postprocessing/PostProcessingHandler.js +350 -350
  544. package/lib/engine-components/postprocessing/Volume.d.ts +89 -89
  545. package/lib/engine-components/postprocessing/Volume.js +367 -367
  546. package/lib/engine-components/postprocessing/VolumeParameter.d.ts +26 -26
  547. package/lib/engine-components/postprocessing/VolumeParameter.js +136 -136
  548. package/lib/engine-components/postprocessing/VolumeProfile.d.ts +15 -15
  549. package/lib/engine-components/postprocessing/VolumeProfile.js +60 -60
  550. package/lib/engine-components/postprocessing/index.d.ts +5 -5
  551. package/lib/engine-components/postprocessing/index.js +5 -5
  552. package/lib/engine-components/postprocessing/utils.d.ts +11 -11
  553. package/lib/engine-components/postprocessing/utils.js +37 -37
  554. package/lib/engine-components/timeline/PlayableDirector.d.ts +163 -163
  555. package/lib/engine-components/timeline/PlayableDirector.js +686 -686
  556. package/lib/engine-components/timeline/SignalAsset.d.ts +24 -24
  557. package/lib/engine-components/timeline/SignalAsset.js +130 -130
  558. package/lib/engine-components/timeline/TimelineModels.d.ts +89 -89
  559. package/lib/engine-components/timeline/TimelineModels.js +22 -22
  560. package/lib/engine-components/timeline/TimelineTracks.d.ts +110 -110
  561. package/lib/engine-components/timeline/TimelineTracks.js +879 -879
  562. package/lib/engine-components/timeline/index.d.ts +4 -4
  563. package/lib/engine-components/timeline/index.js +3 -3
  564. package/lib/engine-components/ui/BaseUIComponent.d.ts +49 -49
  565. package/lib/engine-components/ui/BaseUIComponent.js +170 -170
  566. package/lib/engine-components/ui/Button.d.ts +64 -64
  567. package/lib/engine-components/ui/Button.js +315 -315
  568. package/lib/engine-components/ui/Canvas.d.ts +74 -74
  569. package/lib/engine-components/ui/Canvas.js +407 -407
  570. package/lib/engine-components/ui/CanvasGroup.d.ts +19 -19
  571. package/lib/engine-components/ui/CanvasGroup.js +58 -58
  572. package/lib/engine-components/ui/EventSystem.d.ts +125 -125
  573. package/lib/engine-components/ui/EventSystem.js +764 -764
  574. package/lib/engine-components/ui/Graphic.d.ts +55 -55
  575. package/lib/engine-components/ui/Graphic.js +254 -254
  576. package/lib/engine-components/ui/Image.d.ts +35 -35
  577. package/lib/engine-components/ui/Image.js +116 -116
  578. package/lib/engine-components/ui/InputField.d.ts +42 -42
  579. package/lib/engine-components/ui/InputField.js +268 -268
  580. package/lib/engine-components/ui/Interfaces.d.ts +38 -38
  581. package/lib/engine-components/ui/Interfaces.js +12 -12
  582. package/lib/engine-components/ui/Layout.d.ts +84 -84
  583. package/lib/engine-components/ui/Layout.js +330 -330
  584. package/lib/engine-components/ui/Outline.d.ts +7 -7
  585. package/lib/engine-components/ui/Outline.js +20 -20
  586. package/lib/engine-components/ui/PointerEvents.d.ts +115 -115
  587. package/lib/engine-components/ui/PointerEvents.js +145 -145
  588. package/lib/engine-components/ui/RaycastUtils.d.ts +11 -11
  589. package/lib/engine-components/ui/RaycastUtils.js +67 -67
  590. package/lib/engine-components/ui/Raycaster.d.ts +30 -30
  591. package/lib/engine-components/ui/Raycaster.js +95 -95
  592. package/lib/engine-components/ui/RectTransform.d.ts +61 -61
  593. package/lib/engine-components/ui/RectTransform.js +353 -353
  594. package/lib/engine-components/ui/SpatialHtml.d.ts +8 -8
  595. package/lib/engine-components/ui/SpatialHtml.js +79 -79
  596. package/lib/engine-components/ui/Text.d.ts +78 -78
  597. package/lib/engine-components/ui/Text.js +539 -539
  598. package/lib/engine-components/ui/Utils.d.ts +24 -24
  599. package/lib/engine-components/ui/Utils.js +90 -90
  600. package/lib/engine-components/ui/index.d.ts +1 -1
  601. package/lib/engine-components/ui/index.js +1 -1
  602. package/lib/engine-components/utils/EnvironmentScene.d.ts +5 -5
  603. package/lib/engine-components/utils/EnvironmentScene.js +205 -205
  604. package/lib/engine-components/utils/LookAt.d.ts +31 -31
  605. package/lib/engine-components/utils/LookAt.js +82 -82
  606. package/lib/engine-components/utils/OpenURL.d.ts +42 -42
  607. package/lib/engine-components/utils/OpenURL.js +119 -119
  608. package/lib/engine-components/webxr/Avatar.d.ts +25 -25
  609. package/lib/engine-components/webxr/Avatar.js +255 -255
  610. package/lib/engine-components/webxr/TeleportTarget.d.ts +7 -7
  611. package/lib/engine-components/webxr/TeleportTarget.js +7 -7
  612. package/lib/engine-components/webxr/WebARCameraBackground.d.ts +30 -30
  613. package/lib/engine-components/webxr/WebARCameraBackground.js +155 -155
  614. package/lib/engine-components/webxr/WebARSessionRoot.d.ts +98 -98
  615. package/lib/engine-components/webxr/WebARSessionRoot.js +770 -770
  616. package/lib/engine-components/webxr/WebXR.d.ts +232 -232
  617. package/lib/engine-components/webxr/WebXR.js +561 -561
  618. package/lib/engine-components/webxr/WebXRAvatar.d.ts +27 -27
  619. package/lib/engine-components/webxr/WebXRAvatar.js +44 -44
  620. package/lib/engine-components/webxr/WebXRImageTracking.d.ts +86 -86
  621. package/lib/engine-components/webxr/WebXRImageTracking.js +470 -470
  622. package/lib/engine-components/webxr/WebXRPlaneTracking.d.ts +92 -92
  623. package/lib/engine-components/webxr/WebXRPlaneTracking.js +500 -500
  624. package/lib/engine-components/webxr/WebXRRig.d.ts +32 -32
  625. package/lib/engine-components/webxr/WebXRRig.js +72 -72
  626. package/lib/engine-components/webxr/XRFlag.d.ts +38 -38
  627. package/lib/engine-components/webxr/XRFlag.js +139 -139
  628. package/lib/engine-components/webxr/controllers/XRControllerFollow.d.ts +47 -47
  629. package/lib/engine-components/webxr/controllers/XRControllerFollow.js +120 -120
  630. package/lib/engine-components/webxr/controllers/XRControllerModel.d.ts +43 -43
  631. package/lib/engine-components/webxr/controllers/XRControllerModel.js +351 -351
  632. package/lib/engine-components/webxr/controllers/XRControllerMovement.d.ts +78 -78
  633. package/lib/engine-components/webxr/controllers/XRControllerMovement.js +506 -506
  634. package/lib/engine-components/webxr/index.d.ts +3 -3
  635. package/lib/engine-components/webxr/index.js +3 -3
  636. package/lib/engine-components/webxr/types.d.ts +3 -3
  637. package/lib/engine-components/webxr/types.js +1 -1
  638. package/lib/engine-components-experimental/Presentation.d.ts +6 -6
  639. package/lib/engine-components-experimental/Presentation.js +9 -9
  640. package/lib/engine-components-experimental/api.d.ts +4 -4
  641. package/lib/engine-components-experimental/api.js +4 -4
  642. package/lib/engine-components-experimental/networking/PlayerSync.d.ts +156 -156
  643. package/lib/engine-components-experimental/networking/PlayerSync.js +377 -377
  644. package/lib/engine-schemes/api.d.ts +12 -12
  645. package/lib/engine-schemes/api.js +12 -12
  646. package/lib/engine-schemes/schemes.d.ts +7 -7
  647. package/lib/engine-schemes/schemes.js +19 -19
  648. package/lib/engine-schemes/synced-camera-model.d.ts +25 -25
  649. package/lib/engine-schemes/synced-camera-model.js +67 -67
  650. package/lib/engine-schemes/synced-transform-model.d.ts +31 -31
  651. package/lib/engine-schemes/synced-transform-model.js +66 -66
  652. package/lib/engine-schemes/transform.d.ts +12 -12
  653. package/lib/engine-schemes/transform.js +39 -39
  654. package/lib/engine-schemes/vec2.d.ts +10 -10
  655. package/lib/engine-schemes/vec2.js +25 -25
  656. package/lib/engine-schemes/vec3.d.ts +11 -11
  657. package/lib/engine-schemes/vec3.js +29 -29
  658. package/lib/engine-schemes/vec4.d.ts +12 -12
  659. package/lib/engine-schemes/vec4.js +33 -33
  660. package/lib/engine-schemes/vr-user-state-buffer.d.ts +37 -37
  661. package/lib/engine-schemes/vr-user-state-buffer.js +110 -110
  662. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.d.ts +6 -6
  663. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.js +45 -45
  664. package/lib/needle-engine.d.ts +7 -7
  665. package/lib/needle-engine.js +64 -64
  666. package/package.json +1 -1
  667. package/plugins/common/buildinfo.js +64 -64
  668. package/plugins/common/cloud.js +1 -1
  669. package/plugins/common/config.cjs +31 -31
  670. package/plugins/common/config.js +35 -35
  671. package/plugins/common/files.js +31 -31
  672. package/plugins/common/generator.js +10 -10
  673. package/plugins/common/license.js +341 -330
  674. package/plugins/common/npm.js +15 -15
  675. package/plugins/common/timers.js +7 -7
  676. package/plugins/common/version.js +37 -37
  677. package/plugins/gltf-packer.mjs +1 -1
  678. package/plugins/next/alias.cjs +39 -39
  679. package/plugins/next/license.cjs +18 -18
  680. package/plugins/next/meshbvhworker.cjs +18 -18
  681. package/plugins/next/next.js +128 -128
  682. package/plugins/types/index.d.ts +2 -2
  683. package/plugins/types/license.d.ts +24 -24
  684. package/plugins/types/needleConfig.d.ts +27 -27
  685. package/plugins/types/userconfig.d.ts +105 -105
  686. package/plugins/types/webmanifest.d.ts +32 -32
  687. package/plugins/vite/alias.js +174 -174
  688. package/plugins/vite/asap.js +245 -245
  689. package/plugins/vite/build-pipeline.js +355 -355
  690. package/plugins/vite/build.js +19 -19
  691. package/plugins/vite/buildinfo.js +41 -41
  692. package/plugins/vite/config.js +106 -106
  693. package/plugins/vite/copyfiles.js +138 -138
  694. package/plugins/vite/defines.js +66 -66
  695. package/plugins/vite/dependencies.js +216 -216
  696. package/plugins/vite/dependency-watcher.js +231 -231
  697. package/plugins/vite/drop-client.js +76 -76
  698. package/plugins/vite/drop.js +87 -87
  699. package/plugins/vite/editor-connection.js +124 -124
  700. package/plugins/vite/facebook-instant-games.js +99 -99
  701. package/plugins/vite/gzip.js +5 -5
  702. package/plugins/vite/imports-logger.js +143 -143
  703. package/plugins/vite/index.js +139 -139
  704. package/plugins/vite/license.js +55 -55
  705. package/plugins/vite/meta.js +163 -163
  706. package/plugins/vite/npm.js +7 -7
  707. package/plugins/vite/peer.js +29 -29
  708. package/plugins/vite/poster-client.js +73 -73
  709. package/plugins/vite/poster.js +79 -79
  710. package/plugins/vite/pwa.js +604 -604
  711. package/plugins/vite/reload-client.js +15 -15
  712. package/plugins/vite/reload.js +363 -363
  713. package/plugins/vite/server.js +66 -66
  714. package/plugins/vite/transform-codegen.js +55 -55
  715. package/plugins/vite/transform.js +31 -31
  716. package/plugins/vite/vite-4.4-hack.js +31 -31
  717. package/src/asap/needle-asap.ts +111 -111
  718. package/src/asap/sessiongranted.ts +75 -75
  719. package/src/asap/utils.ts +4 -4
  720. package/src/engine/analytics/index.ts +10 -10
  721. package/src/engine/analytics/lcp.ts +35 -35
  722. package/src/engine/api.ts +81 -81
  723. package/src/engine/assets/index.ts +59 -59
  724. package/src/engine/assets/static.js +5 -5
  725. package/src/engine/codegen/register_types.ts +300 -300
  726. package/src/engine/debug/debug.ts +51 -51
  727. package/src/engine/debug/debug_console.ts +333 -333
  728. package/src/engine/debug/debug_overlay.ts +332 -332
  729. package/src/engine/debug/debug_spatial_console.ts +429 -429
  730. package/src/engine/debug/index.ts +1 -1
  731. package/src/engine/engine_addressables.ts +679 -679
  732. package/src/engine/engine_animation.ts +145 -145
  733. package/src/engine/engine_application.ts +113 -113
  734. package/src/engine/engine_assetdatabase.ts +387 -387
  735. package/src/engine/engine_audio.ts +24 -24
  736. package/src/engine/engine_camera.ts +39 -39
  737. package/src/engine/engine_components.ts +374 -373
  738. package/src/engine/engine_components_internal.ts +40 -40
  739. package/src/engine/engine_constants.ts +52 -52
  740. package/src/engine/engine_context.ts +1662 -1662
  741. package/src/engine/engine_context_registry.ts +129 -129
  742. package/src/engine/engine_coroutine.ts +54 -54
  743. package/src/engine/engine_create_objects.ts +398 -398
  744. package/src/engine/engine_default_parameters.ts +3 -3
  745. package/src/engine/engine_editor-sync.ts +28 -28
  746. package/src/engine/engine_element.ts +869 -871
  747. package/src/engine/engine_element_attributes.ts +85 -85
  748. package/src/engine/engine_element_extras.ts +16 -16
  749. package/src/engine/engine_element_loading.ts +381 -381
  750. package/src/engine/engine_element_overlay.ts +186 -186
  751. package/src/engine/engine_fileloader.js +9 -9
  752. package/src/engine/engine_gameobject.ts +684 -684
  753. package/src/engine/engine_generic_utils.js +13 -13
  754. package/src/engine/engine_gizmos.ts +577 -577
  755. package/src/engine/engine_gltf.ts +29 -29
  756. package/src/engine/engine_gltf_builtin_components.ts +403 -403
  757. package/src/engine/engine_hot_reload.ts +198 -198
  758. package/src/engine/engine_input.ts +1460 -1460
  759. package/src/engine/engine_input_utils.ts +23 -23
  760. package/src/engine/engine_instancing.ts +45 -45
  761. package/src/engine/engine_license.ts +329 -329
  762. package/src/engine/engine_lifecycle_api.ts +106 -106
  763. package/src/engine/engine_lifecycle_functions_internal.ts +193 -193
  764. package/src/engine/engine_lightdata.ts +117 -117
  765. package/src/engine/engine_loaders.ts +82 -82
  766. package/src/engine/engine_lods.ts +168 -168
  767. package/src/engine/engine_mainloop_utils.ts +472 -472
  768. package/src/engine/engine_math.ts +282 -282
  769. package/src/engine/engine_modules.ts +83 -83
  770. package/src/engine/engine_networking.ts +841 -841
  771. package/src/engine/engine_networking_auto.ts +352 -352
  772. package/src/engine/engine_networking_blob.ts +254 -254
  773. package/src/engine/engine_networking_files.ts +217 -217
  774. package/src/engine/engine_networking_files_default_components.ts +58 -58
  775. package/src/engine/engine_networking_instantiate.ts +419 -419
  776. package/src/engine/engine_networking_peer.ts +159 -159
  777. package/src/engine/engine_networking_streams.ts +713 -713
  778. package/src/engine/engine_networking_types.ts +24 -24
  779. package/src/engine/engine_networking_utils.ts +23 -23
  780. package/src/engine/engine_networking_websocket.ts +2 -2
  781. package/src/engine/engine_patcher.ts +199 -199
  782. package/src/engine/engine_physics.ts +783 -783
  783. package/src/engine/engine_physics.types.ts +46 -46
  784. package/src/engine/engine_physics_rapier.ts +1579 -1579
  785. package/src/engine/engine_playerview.ts +80 -80
  786. package/src/engine/engine_scenelighting.ts +294 -294
  787. package/src/engine/engine_scenetools.ts +365 -365
  788. package/src/engine/engine_serialization.ts +2 -2
  789. package/src/engine/engine_serialization_builtin_serializer.ts +473 -473
  790. package/src/engine/engine_serialization_core.ts +705 -705
  791. package/src/engine/engine_serialization_decorator.ts +80 -80
  792. package/src/engine/engine_setup.ts +1 -1
  793. package/src/engine/engine_shaders.ts +267 -267
  794. package/src/engine/engine_shims.ts +32 -32
  795. package/src/engine/engine_test_utils.ts +109 -109
  796. package/src/engine/engine_texture.ts +82 -82
  797. package/src/engine/engine_three_utils.ts +849 -849
  798. package/src/engine/engine_time.ts +94 -94
  799. package/src/engine/engine_time_utils.ts +237 -237
  800. package/src/engine/engine_tonemapping.ts +210 -210
  801. package/src/engine/engine_types.ts +714 -714
  802. package/src/engine/engine_typestore.ts +63 -63
  803. package/src/engine/engine_util_decorator.ts +136 -136
  804. package/src/engine/engine_utils.ts +972 -972
  805. package/src/engine/engine_utils_format.ts +212 -212
  806. package/src/engine/engine_utils_screenshot.ts +698 -698
  807. package/src/engine/engine_utils_screenshot.xr.ts +103 -103
  808. package/src/engine/export/gltf/Writers.ts +34 -34
  809. package/src/engine/export/gltf/index.ts +158 -158
  810. package/src/engine/export/index.ts +2 -2
  811. package/src/engine/export/state.ts +19 -19
  812. package/src/engine/export/utils.ts +9 -9
  813. package/src/engine/extensions/EXT_texture_exr.ts +50 -50
  814. package/src/engine/extensions/NEEDLE_animator_controller_model.ts +195 -195
  815. package/src/engine/extensions/NEEDLE_components.ts +268 -268
  816. package/src/engine/extensions/NEEDLE_gameobject_data.ts +81 -81
  817. package/src/engine/extensions/NEEDLE_lighting_settings.ts +185 -185
  818. package/src/engine/extensions/NEEDLE_lightmaps.ts +119 -119
  819. package/src/engine/extensions/NEEDLE_persistent_assets.ts +76 -76
  820. package/src/engine/extensions/NEEDLE_render_objects.ts +209 -209
  821. package/src/engine/extensions/NEEDLE_techniques_webgl.ts +640 -640
  822. package/src/engine/extensions/extension_resolver.ts +4 -4
  823. package/src/engine/extensions/extension_utils.ts +166 -166
  824. package/src/engine/extensions/extensions.ts +135 -135
  825. package/src/engine/extensions/index.ts +5 -5
  826. package/src/engine/extensions/usage_tracker.ts +100 -100
  827. package/src/engine/js-extensions/Camera.ts +37 -37
  828. package/src/engine/js-extensions/ExtensionUtils.ts +85 -85
  829. package/src/engine/js-extensions/Layers.ts +23 -23
  830. package/src/engine/js-extensions/Object3D.ts +296 -296
  831. package/src/engine/js-extensions/RGBAColor.ts +125 -75
  832. package/src/engine/js-extensions/Vector.ts +18 -18
  833. package/src/engine/js-extensions/index.ts +4 -4
  834. package/src/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +122 -122
  835. package/src/engine/shaders/shaderData.ts +67 -67
  836. package/src/engine/tests/test_utils.ts +63 -63
  837. package/src/engine/webcomponents/WebXRButtons.ts +260 -260
  838. package/src/engine/webcomponents/api.ts +6 -6
  839. package/src/engine/webcomponents/buttons.ts +262 -262
  840. package/src/engine/webcomponents/fonts.ts +41 -41
  841. package/src/engine/webcomponents/icons.ts +57 -57
  842. package/src/engine/webcomponents/index.ts +1 -1
  843. package/src/engine/webcomponents/logo-element.ts +78 -78
  844. package/src/engine/webcomponents/needle menu/needle-menu-spatial.ts +573 -573
  845. package/src/engine/webcomponents/needle menu/needle-menu.ts +1107 -1107
  846. package/src/engine/webcomponents/needle-button.ts +181 -181
  847. package/src/engine/xr/NeedleXRController.ts +1126 -1126
  848. package/src/engine/xr/NeedleXRSession.ts +1585 -1585
  849. package/src/engine/xr/NeedleXRSync.ts +220 -220
  850. package/src/engine/xr/SceneTransition.ts +78 -78
  851. package/src/engine/xr/TempXRContext.ts +216 -216
  852. package/src/engine/xr/XRRig.ts +9 -9
  853. package/src/engine/xr/api.ts +5 -5
  854. package/src/engine/xr/events.ts +102 -102
  855. package/src/engine/xr/internal.ts +34 -34
  856. package/src/engine/xr/usdz.ts +30 -30
  857. package/src/engine/xr/utils.ts +39 -39
  858. package/src/engine-components/AlignmentConstraint.ts +36 -36
  859. package/src/engine-components/Animation.ts +557 -557
  860. package/src/engine-components/AnimationCurve.ts +150 -150
  861. package/src/engine-components/AnimationUtils.ts +28 -28
  862. package/src/engine-components/AnimationUtilsAutoplay.ts +43 -43
  863. package/src/engine-components/Animator.ts +397 -397
  864. package/src/engine-components/AnimatorController.ts +1293 -1293
  865. package/src/engine-components/AudioListener.ts +92 -92
  866. package/src/engine-components/AudioSource.ts +639 -639
  867. package/src/engine-components/AvatarLoader.ts +263 -263
  868. package/src/engine-components/AxesHelper.ts +59 -59
  869. package/src/engine-components/BasicIKConstraint.ts +54 -54
  870. package/src/engine-components/BoxCollider.ts +1 -1
  871. package/src/engine-components/BoxHelperComponent.ts +114 -114
  872. package/src/engine-components/Camera.ts +719 -707
  873. package/src/engine-components/CameraUtils.ts +133 -142
  874. package/src/engine-components/CharacterController.ts +253 -253
  875. package/src/engine-components/Collider.ts +374 -374
  876. package/src/engine-components/Component.ts +1294 -1294
  877. package/src/engine-components/ContactShadows.ts +482 -482
  878. package/src/engine-components/DeleteBox.ts +62 -62
  879. package/src/engine-components/DeviceFlag.ts +46 -46
  880. package/src/engine-components/DragControls.ts +1623 -1623
  881. package/src/engine-components/DropListener.ts +698 -698
  882. package/src/engine-components/Duplicatable.ts +198 -198
  883. package/src/engine-components/EventList.ts +266 -266
  884. package/src/engine-components/EventTrigger.ts +74 -74
  885. package/src/engine-components/EventType.ts +22 -22
  886. package/src/engine-components/Fog.ts +60 -60
  887. package/src/engine-components/Gizmos.ts +56 -56
  888. package/src/engine-components/GridHelper.ts +48 -48
  889. package/src/engine-components/GroundProjection.ts +356 -356
  890. package/src/engine-components/Interactable.ts +14 -14
  891. package/src/engine-components/Joints.ts +52 -52
  892. package/src/engine-components/LODGroup.ts +153 -153
  893. package/src/engine-components/Light.ts +558 -558
  894. package/src/engine-components/LookAtConstraint.ts +25 -25
  895. package/src/engine-components/NeedleMenu.ts +84 -84
  896. package/src/engine-components/NestedGltf.ts +86 -86
  897. package/src/engine-components/Networking.ts +114 -114
  898. package/src/engine-components/OffsetConstraint.ts +60 -60
  899. package/src/engine-components/OrbitControls.ts +1068 -1068
  900. package/src/engine-components/PlayerColor.ts +103 -103
  901. package/src/engine-components/ReflectionProbe.ts +216 -209
  902. package/src/engine-components/Renderer.ts +900 -900
  903. package/src/engine-components/RendererInstancing.ts +855 -855
  904. package/src/engine-components/RendererLightmap.ts +198 -198
  905. package/src/engine-components/RigidBody.ts +526 -526
  906. package/src/engine-components/SceneSwitcher.ts +1013 -1013
  907. package/src/engine-components/ScreenCapture.ts +592 -592
  908. package/src/engine-components/ShadowCatcher.ts +172 -172
  909. package/src/engine-components/Skybox.ts +455 -455
  910. package/src/engine-components/SmoothFollow.ts +76 -76
  911. package/src/engine-components/SpatialTrigger.ts +229 -229
  912. package/src/engine-components/SpectatorCamera.ts +787 -787
  913. package/src/engine-components/SphereCollider.ts +1 -1
  914. package/src/engine-components/SpriteRenderer.ts +468 -468
  915. package/src/engine-components/SyncedCamera.ts +220 -220
  916. package/src/engine-components/SyncedRoom.ts +380 -380
  917. package/src/engine-components/SyncedTransform.ts +383 -378
  918. package/src/engine-components/TestRunner.ts +118 -118
  919. package/src/engine-components/TransformGizmo.ts +219 -219
  920. package/src/engine-components/VideoPlayer.ts +1025 -1025
  921. package/src/engine-components/Voip.ts +363 -363
  922. package/src/engine-components/api.ts +60 -60
  923. package/src/engine-components/avatar/AvatarBlink_Simple.ts +69 -69
  924. package/src/engine-components/avatar/AvatarEyeLook_Rotation.ts +63 -63
  925. package/src/engine-components/avatar/Avatar_Brain_LookAt.ts +139 -139
  926. package/src/engine-components/avatar/Avatar_MouthShapes.ts +83 -83
  927. package/src/engine-components/avatar/Avatar_MustacheShake.ts +31 -31
  928. package/src/engine-components/codegen/components.ts +217 -217
  929. package/src/engine-components/debug/LogStats.ts +21 -21
  930. package/src/engine-components/export/gltf/GltfExport.ts +265 -265
  931. package/src/engine-components/export/usdz/Extension.ts +24 -24
  932. package/src/engine-components/export/usdz/ThreeUSDZExporter.ts +2413 -2413
  933. package/src/engine-components/export/usdz/USDZExporter.ts +705 -705
  934. package/src/engine-components/export/usdz/extensions/Animation.ts +1204 -1204
  935. package/src/engine-components/export/usdz/extensions/DocumentExtension.ts +9 -9
  936. package/src/engine-components/export/usdz/extensions/USDZText.ts +240 -240
  937. package/src/engine-components/export/usdz/extensions/USDZUI.ts +189 -189
  938. package/src/engine-components/export/usdz/extensions/behavior/Actions.ts +99 -99
  939. package/src/engine-components/export/usdz/extensions/behavior/AudioExtension.ts +102 -102
  940. package/src/engine-components/export/usdz/extensions/behavior/Behaviour.ts +320 -320
  941. package/src/engine-components/export/usdz/extensions/behavior/BehaviourComponents.ts +1225 -1225
  942. package/src/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.ts +646 -646
  943. package/src/engine-components/export/usdz/extensions/behavior/PhysicsExtension.ts +132 -132
  944. package/src/engine-components/export/usdz/index.ts +2 -2
  945. package/src/engine-components/export/usdz/utils/animationutils.ts +191 -191
  946. package/src/engine-components/export/usdz/utils/quicklook.ts +50 -50
  947. package/src/engine-components/particlesystem/ParticleSystem.ts +1287 -1287
  948. package/src/engine-components/particlesystem/ParticleSystemModules.ts +1765 -1765
  949. package/src/engine-components/particlesystem/ParticleSystemSubEmitter.ts +111 -111
  950. package/src/engine-components/particlesystem/api.ts +1 -1
  951. package/src/engine-components/postprocessing/Effects/Antialiasing.ts +55 -55
  952. package/src/engine-components/postprocessing/Effects/BloomEffect.ts +116 -116
  953. package/src/engine-components/postprocessing/Effects/ChromaticAberration.ts +37 -37
  954. package/src/engine-components/postprocessing/Effects/ColorAdjustments.ts +95 -95
  955. package/src/engine-components/postprocessing/Effects/DepthOfField.ts +103 -103
  956. package/src/engine-components/postprocessing/Effects/EffectWrapper.ts +25 -25
  957. package/src/engine-components/postprocessing/Effects/Pixelation.ts +32 -32
  958. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.ts +90 -90
  959. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.ts +191 -191
  960. package/src/engine-components/postprocessing/Effects/Sharpening.ts +138 -138
  961. package/src/engine-components/postprocessing/Effects/TiltShiftEffect.ts +61 -61
  962. package/src/engine-components/postprocessing/Effects/Tonemapping.ts +155 -155
  963. package/src/engine-components/postprocessing/Effects/Vignette.ts +59 -59
  964. package/src/engine-components/postprocessing/PostProcessingEffect.ts +172 -172
  965. package/src/engine-components/postprocessing/PostProcessingHandler.ts +398 -398
  966. package/src/engine-components/postprocessing/Volume.ts +410 -410
  967. package/src/engine-components/postprocessing/VolumeParameter.ts +158 -158
  968. package/src/engine-components/postprocessing/VolumeProfile.ts +61 -61
  969. package/src/engine-components/postprocessing/index.ts +5 -5
  970. package/src/engine-components/postprocessing/utils.ts +52 -52
  971. package/src/engine-components/timeline/PlayableDirector.ts +722 -722
  972. package/src/engine-components/timeline/SignalAsset.ts +144 -144
  973. package/src/engine-components/timeline/TimelineModels.ts +92 -92
  974. package/src/engine-components/timeline/TimelineTracks.ts +967 -967
  975. package/src/engine-components/timeline/index.ts +3 -3
  976. package/src/engine-components/ui/BaseUIComponent.ts +203 -203
  977. package/src/engine-components/ui/Button.ts +307 -307
  978. package/src/engine-components/ui/Canvas.ts +419 -419
  979. package/src/engine-components/ui/CanvasGroup.ts +54 -54
  980. package/src/engine-components/ui/EventSystem.ts +853 -853
  981. package/src/engine-components/ui/Graphic.ts +275 -275
  982. package/src/engine-components/ui/Image.ts +112 -112
  983. package/src/engine-components/ui/InputField.ts +321 -321
  984. package/src/engine-components/ui/Interfaces.ts +57 -57
  985. package/src/engine-components/ui/Layout.ts +334 -334
  986. package/src/engine-components/ui/Outline.ts +13 -13
  987. package/src/engine-components/ui/PointerEvents.ts +206 -206
  988. package/src/engine-components/ui/RaycastUtils.ts +69 -69
  989. package/src/engine-components/ui/Raycaster.ts +102 -102
  990. package/src/engine-components/ui/RectTransform.ts +372 -372
  991. package/src/engine-components/ui/SpatialHtml.ts +79 -79
  992. package/src/engine-components/ui/Text.ts +578 -578
  993. package/src/engine-components/ui/Utils.ts +112 -112
  994. package/src/engine-components/utils/EnvironmentScene.ts +245 -245
  995. package/src/engine-components/utils/LookAt.ts +88 -88
  996. package/src/engine-components/utils/OpenURL.ts +114 -114
  997. package/src/engine-components/webxr/Avatar.ts +265 -265
  998. package/src/engine-components/webxr/TeleportTarget.ts +9 -9
  999. package/src/engine-components/webxr/WebARCameraBackground.ts +175 -175
  1000. package/src/engine-components/webxr/WebARSessionRoot.ts +880 -880
  1001. package/src/engine-components/webxr/WebXR.ts +585 -585
  1002. package/src/engine-components/webxr/WebXRAvatar.ts +66 -66
  1003. package/src/engine-components/webxr/WebXRImageTracking.ts +518 -518
  1004. package/src/engine-components/webxr/WebXRPlaneTracking.ts +570 -570
  1005. package/src/engine-components/webxr/WebXRRig.ts +77 -77
  1006. package/src/engine-components/webxr/XRFlag.ts +147 -147
  1007. package/src/engine-components/webxr/controllers/XRControllerFollow.ts +118 -118
  1008. package/src/engine-components/webxr/controllers/XRControllerModel.ts +374 -374
  1009. package/src/engine-components/webxr/controllers/XRControllerMovement.ts +550 -550
  1010. package/src/engine-components/webxr/index.ts +2 -2
  1011. package/src/engine-components/webxr/types.ts +3 -3
  1012. package/src/engine-components-experimental/Presentation.ts +12 -12
  1013. package/src/engine-components-experimental/api.ts +4 -4
  1014. package/src/engine-components-experimental/networking/PlayerSync.ts +401 -401
  1015. package/src/engine-schemes/COMPILE_SCHEMES.bat +3 -3
  1016. package/src/engine-schemes/COMPILE_TS.bat +11 -11
  1017. package/src/engine-schemes/README.md +1 -1
  1018. package/src/engine-schemes/api.ts +12 -12
  1019. package/src/engine-schemes/dist/api.js +17 -0
  1020. package/src/engine-schemes/dist/api.js.meta +7 -0
  1021. package/src/engine-schemes/dist/schemes.js +25 -0
  1022. package/src/engine-schemes/dist/schemes.js.meta +7 -0
  1023. package/src/engine-schemes/dist/synced-camera-model.js +74 -0
  1024. package/src/engine-schemes/dist/synced-camera-model.js.meta +7 -0
  1025. package/src/engine-schemes/dist/synced-transform-model.js +73 -0
  1026. package/src/engine-schemes/dist/synced-transform-model.js.meta +7 -0
  1027. package/src/engine-schemes/dist/transform.js +46 -0
  1028. package/src/engine-schemes/dist/transform.js.meta +7 -0
  1029. package/src/engine-schemes/dist/vec2.js +32 -0
  1030. package/src/engine-schemes/dist/vec2.js.meta +7 -0
  1031. package/src/engine-schemes/dist/vec3.js +36 -0
  1032. package/src/engine-schemes/dist/vec3.js.meta +7 -0
  1033. package/src/engine-schemes/dist/vec4.js +40 -0
  1034. package/src/engine-schemes/dist/vec4.js.meta +7 -0
  1035. package/src/engine-schemes/dist/vr-user-state-buffer.js +110 -0
  1036. package/src/engine-schemes/dist/vr-user-state-buffer.js.meta +7 -0
  1037. package/src/engine-schemes/schemes.ts +28 -28
  1038. package/src/engine-schemes/synced-camera-model.ts +92 -92
  1039. package/src/engine-schemes/synced-transform-model.ts +90 -90
  1040. package/src/engine-schemes/syncedCamera.fbs +10 -10
  1041. package/src/engine-schemes/transform.ts +50 -50
  1042. package/src/engine-schemes/transforms.fbs +25 -25
  1043. package/src/engine-schemes/vec.fbs +19 -19
  1044. package/src/engine-schemes/vec2.ts +33 -33
  1045. package/src/engine-schemes/vec3.ts +38 -38
  1046. package/src/engine-schemes/vec4.ts +43 -43
  1047. package/src/engine-schemes/vr-user-state-buffer.ts +145 -145
  1048. package/src/engine-schemes/vrUserStateBuffer.fbs +17 -17
  1049. package/src/include/draco/draco_decoder.js +34 -34
  1050. package/src/include/ktx2/basis_transcoder.js +21 -21
  1051. package/src/include/needle/arial-msdf.json +1471 -1471
  1052. package/src/include/three/DragControls.js +231 -231
  1053. package/src/include/three/EXT_mesh_gpu_instancing_exporter.js +66 -66
  1054. package/src/needle-engine.ts +70 -70
@@ -1,1226 +1,1226 @@
1
- import { AnimationClip, Material, Matrix4, Mesh, Object3D, Quaternion, Vector3 } from "three";
2
-
3
- import { isDevEnvironment, showBalloonWarning } from "../../../../../engine/debug/index.js";
4
- import { serializable } from "../../../../../engine/engine_serialization_decorator.js";
5
- import { getWorldPosition, getWorldQuaternion, getWorldScale, setWorldPosition, setWorldQuaternion, setWorldScale } from "../../../../../engine/engine_three_utils.js";
6
- import { getParam } from "../../../../../engine/engine_utils.js";
7
- import { compareAssociation } from "../../../../../engine/extensions/extension_utils.js";
8
- import type { State } from "../../../../../engine/extensions/NEEDLE_animator_controller_model.js";
9
- import { NEEDLE_progressive } from "../../../../../engine/extensions/NEEDLE_progressive.js";
10
- import { Animation } from "../../../../Animation.js";
11
- import { Animator } from "../../../../Animator.js";
12
- import { AudioSource } from "../../../../AudioSource.js";
13
- import { Behaviour, GameObject } from "../../../../Component.js";
14
- import type { IPointerClickHandler, PointerEventData } from "../../../../ui/PointerEvents.js";
15
- import { ObjectRaycaster,Raycaster } from "../../../../ui/Raycaster.js";
16
- import { makeNameSafeForUSD,USDDocument, USDObject, USDZExporterContext } from "../../ThreeUSDZExporter.js";
17
- import { AnimationExtension, RegisteredAnimationInfo, type UsdzAnimation } from "../Animation.js";
18
- import { AudioExtension } from "./AudioExtension.js";
19
- import type { BehaviorExtension, UsdzBehaviour } from "./Behaviour.js";
20
- import { ActionBuilder, ActionModel, BehaviorModel, EmphasizeActionMotionType,GroupActionModel,type IBehaviorElement, Target, TriggerBuilder } from "./BehavioursBuilder.js";
21
-
22
- const debug = getParam("debugusdzbehaviours");
23
-
24
- function ensureRaycaster(obj: GameObject) {
25
- if (!obj) return;
26
- if (!obj.getComponentInParent(Raycaster)) {
27
- if (isDevEnvironment())
28
- console.debug("Raycaster on \"" + obj.name + "\" was automatically added, because no raycaster was found in the parent hierarchy.")
29
- obj.addComponent(ObjectRaycaster);
30
- }
31
- }
32
-
33
- /**
34
- * @category Everywhere Actions
35
- * @group Components
36
- */
37
- export class ChangeTransformOnClick extends Behaviour implements IPointerClickHandler, UsdzBehaviour {
38
-
39
- @serializable(Object3D)
40
- object?: Object3D;
41
-
42
- @serializable(Object3D)
43
- target?: Object3D;
44
-
45
- @serializable()
46
- duration: number = 1;
47
-
48
- @serializable()
49
- relativeMotion: boolean = false;
50
-
51
- private coroutine: Generator | null = null;
52
-
53
- private targetPos = new Vector3();
54
- private targetRot = new Quaternion();
55
- private targetScale = new Vector3();
56
-
57
- start(): void {
58
- ensureRaycaster(this.gameObject);
59
- }
60
-
61
- onPointerClick(args: PointerEventData) {
62
- args.use();
63
- if (this.coroutine) this.stopCoroutine(this.coroutine);
64
- if (!this.relativeMotion)
65
- this.coroutine = this.startCoroutine(this.moveToTarget());
66
- else
67
- this.coroutine = this.startCoroutine(this.moveRelative());
68
- }
69
-
70
- private *moveToTarget() {
71
-
72
- if (!this.target || !this.object) return;
73
-
74
- const thisPos = getWorldPosition(this.object).clone();
75
- const targetPos = getWorldPosition(this.target).clone();
76
-
77
- const thisRot = getWorldQuaternion(this.object).clone();
78
- const targetRot = getWorldQuaternion(this.target).clone();
79
-
80
- const thisScale = getWorldScale(this.object).clone();
81
- const targetScale = getWorldScale(this.target).clone();
82
-
83
- const dist = thisPos.distanceTo(targetPos);
84
- const rotDist = thisRot.angleTo(targetRot);
85
- const scaleDist = thisScale.distanceTo(targetScale);
86
-
87
- if (dist < 0.01 && rotDist < 0.01 && scaleDist < 0.01) {
88
- setWorldPosition(this.object, targetPos);
89
- setWorldQuaternion(this.object, targetRot);
90
- setWorldScale(this.object, targetScale);
91
- this.coroutine = null;
92
- return;
93
- }
94
-
95
- let t01 = 0;
96
- let eased = 0;
97
- while (t01 < 1) {
98
-
99
- t01 += this.context.time.deltaTime / this.duration;
100
- if (t01 > 1) t01 = 1;
101
-
102
- // apply ease-in-out
103
- // https://easings.net/
104
- eased = t01 < 0.5 ? 4 * t01 * t01 * t01 : 1 - Math.pow(-2 * t01 + 2, 3) / 2;
105
-
106
- this.targetPos.lerpVectors(thisPos, targetPos, eased);
107
- this.targetRot.slerpQuaternions(thisRot, targetRot, eased);
108
- this.targetScale.lerpVectors(thisScale, targetScale, eased);
109
-
110
- setWorldPosition(this.object, this.targetPos);
111
- setWorldQuaternion(this.object, this.targetRot);
112
- setWorldScale(this.object, this.targetScale);
113
-
114
- yield;
115
- }
116
-
117
- this.coroutine = null;
118
- }
119
-
120
- private *moveRelative() {
121
-
122
- if (!this.target || !this.object) return;
123
-
124
- const thisPos = this.object.position.clone();
125
- const thisRot = this.object.quaternion.clone();
126
- const thisScale = this.object.scale.clone();
127
-
128
- const posOffset = this.target.position.clone();
129
- const rotOffset = this.target.quaternion.clone();
130
- const scaleOffset = this.target.scale.clone();
131
-
132
- // convert into right space
133
- posOffset.applyQuaternion(this.object.quaternion);
134
-
135
- this.targetPos.copy(this.object.position).add(posOffset);
136
- this.targetRot.copy(this.object.quaternion).multiply(rotOffset);
137
- this.targetScale.copy(this.object.scale).multiply(scaleOffset);
138
-
139
- let t01 = 0;
140
- let eased = 0;
141
- while (t01 < 1) {
142
-
143
- t01 += this.context.time.deltaTime / this.duration;
144
- if (t01 > 1) t01 = 1;
145
-
146
- // apply ease-in-out
147
- // https://easings.net/
148
- eased = t01 < 0.5 ? 4 * t01 * t01 * t01 : 1 - Math.pow(-2 * t01 + 2, 3) / 2;
149
-
150
- this.object.position.lerpVectors(thisPos, this.targetPos, eased);
151
- this.object.quaternion.slerpQuaternions(thisRot, this.targetRot, eased);
152
- this.object.scale.lerpVectors(thisScale, this.targetScale, eased);
153
-
154
- yield;
155
- }
156
-
157
- this.coroutine = null;
158
- }
159
-
160
- beforeCreateDocument(ext) {
161
- if (this.target && this.object && this.gameObject) {
162
- const moveForward = new BehaviorModel("Move to " + this.target?.name,
163
- TriggerBuilder.tapTrigger(this.gameObject),
164
- ActionBuilder.transformAction(this.object, this.target, this.duration, this.relativeMotion ? "relative" : "absolute"),
165
- );
166
- ext.addBehavior(moveForward);
167
- }
168
- }
169
- }
170
-
171
- /**
172
- * @category Everywhere Actions
173
- * @group Components
174
- */
175
- export class ChangeMaterialOnClick extends Behaviour implements IPointerClickHandler, UsdzBehaviour {
176
-
177
- /**
178
- * The material that will be switched to the variant material
179
- */
180
- @serializable(Material)
181
- materialToSwitch?: Material;
182
-
183
- /**
184
- * The material that will be switched to
185
- */
186
- @serializable(Material)
187
- variantMaterial?: Material;
188
-
189
- /**
190
- * The duration of the fade effect in seconds (USDZ/Quicklook only)
191
- * @default 0
192
- */
193
- @serializable()
194
- fadeDuration: number = 0;
195
-
196
- start(): void {
197
- // initialize the object list
198
- this._objectsWithThisMaterial = this.objectsWithThisMaterial;
199
- ensureRaycaster(this.gameObject);
200
- if (isDevEnvironment() && this._objectsWithThisMaterial.length <= 0) {
201
- console.warn("ChangeMaterialOnClick: No objects found with material \"" + this.materialToSwitch?.name + "\"");
202
- }
203
- }
204
-
205
- onPointerEnter(_args: PointerEventData) {
206
- this.context.input.setCursor("pointer");
207
- }
208
- onPointerExit(_: PointerEventData) {
209
- this.context.input.unsetCursor("pointer");
210
- }
211
- onPointerClick(args: PointerEventData) {
212
- args.use();
213
- if (!this.variantMaterial) return;
214
- for (let i = 0; i < this.objectsWithThisMaterial.length; i++) {
215
- const obj = this.objectsWithThisMaterial[i];
216
- obj.material = this.variantMaterial;
217
- }
218
- }
219
-
220
- private _objectsWithThisMaterial: Mesh[] | null = null;
221
- /** Get all objects in the scene that have the assigned materialToSwitch */
222
- private get objectsWithThisMaterial(): Mesh[] {
223
- if (this._objectsWithThisMaterial != null) return this._objectsWithThisMaterial;
224
- this._objectsWithThisMaterial = [];
225
- if (this.variantMaterial && this.materialToSwitch) {
226
- this.context.scene.traverse(obj => {
227
- if (obj instanceof Mesh) {
228
- if (Array.isArray(obj.material)) {
229
- for (const mat of obj.material) {
230
- if (mat === this.materialToSwitch) {
231
- this.objectsWithThisMaterial.push(obj);
232
- break;
233
- }
234
- }
235
- }
236
- else {
237
- if (obj.material === this.materialToSwitch) {
238
- this.objectsWithThisMaterial.push(obj);
239
- }
240
- else if (compareAssociation(obj.material, this.materialToSwitch)) {
241
- this.objectsWithThisMaterial.push(obj);
242
- }
243
- }
244
- }
245
- });
246
- }
247
- return this._objectsWithThisMaterial;
248
- }
249
-
250
- private selfModel!: USDObject;
251
- private targetModels!: USDObject[];
252
-
253
- private static _materialTriggersPerId: { [key: string]: ChangeMaterialOnClick[] } = {}
254
- private static _startHiddenBehaviour: BehaviorModel | null = null;
255
- private static _parallelStartHiddenActions: USDObject[] = [];
256
-
257
- async beforeCreateDocument(_ext: BehaviorExtension, _context) {
258
- this.targetModels = [];
259
- ChangeMaterialOnClick._materialTriggersPerId = {}
260
- ChangeMaterialOnClick.variantSwitchIndex = 0;
261
-
262
- // Ensure that the progressive textures have been loaded for all variants and materials
263
- if (this.materialToSwitch) {
264
- await NEEDLE_progressive.assignTextureLOD(this.materialToSwitch, 0);
265
- }
266
- if (this.variantMaterial) {
267
- await NEEDLE_progressive.assignTextureLOD(this.variantMaterial, 0);
268
- }
269
- }
270
-
271
-
272
- createBehaviours(_ext: BehaviorExtension, model: USDObject, _context) {
273
-
274
- const shouldExport = this.objectsWithThisMaterial.find(o => o.uuid === model.uuid);
275
- if (shouldExport) {
276
- this.targetModels.push(model);
277
- }
278
- if (this.gameObject.uuid === model.uuid) {
279
- this.selfModel = model;
280
- if (this.materialToSwitch) {
281
- if (!ChangeMaterialOnClick._materialTriggersPerId[this.materialToSwitch.uuid])
282
- ChangeMaterialOnClick._materialTriggersPerId[this.materialToSwitch.uuid] = [];
283
- ChangeMaterialOnClick._materialTriggersPerId[this.materialToSwitch.uuid].push(this);
284
- }
285
- }
286
- }
287
-
288
- afterCreateDocument(ext: BehaviorExtension, _context) {
289
-
290
- if (!this.materialToSwitch) return;
291
- const handlers = ChangeMaterialOnClick._materialTriggersPerId[this.materialToSwitch.uuid];
292
- if (handlers) {
293
- const variants: { [key: string]: Array<USDObject> } = {}
294
- for (const handler of handlers) {
295
- const createdVariants = handler.createVariants();
296
- if (createdVariants && createdVariants.length > 0)
297
- variants[handler.selfModel.uuid] = createdVariants;
298
- }
299
- for (const handler of handlers) {
300
- const otherVariants: Array<USDObject> = [];
301
- for (const key in variants) {
302
- if (key !== handler.selfModel.uuid) {
303
- otherVariants.push(...variants[key]);
304
- }
305
- }
306
- handler.createAndAttachBehaviors(ext, variants[handler.selfModel.uuid], otherVariants);
307
- }
308
- }
309
- delete ChangeMaterialOnClick._materialTriggersPerId[this.materialToSwitch.uuid];
310
- }
311
-
312
- private createAndAttachBehaviors(ext: BehaviorExtension, myVariants: Array<USDObject>, otherVariants: Array<USDObject>) {
313
- const select: ActionModel[] = [];
314
-
315
- const fadeDuration = Math.max(0, this.fadeDuration);
316
-
317
- select.push(ActionBuilder.fadeAction([...this.targetModels, ...otherVariants], fadeDuration, false));
318
- select.push(ActionBuilder.fadeAction(myVariants, fadeDuration, true));
319
-
320
- ext.addBehavior(new BehaviorModel("Select_" + this.selfModel.name,
321
- TriggerBuilder.tapTrigger(this.selfModel),
322
- ActionBuilder.parallel(...select))
323
- );
324
- ChangeMaterialOnClick._parallelStartHiddenActions.push(...myVariants);
325
- if (!ChangeMaterialOnClick._startHiddenBehaviour) {
326
- ChangeMaterialOnClick._startHiddenBehaviour =
327
- new BehaviorModel("StartHidden_" + this.selfModel.name,
328
- TriggerBuilder.sceneStartTrigger(),
329
- ActionBuilder.fadeAction(ChangeMaterialOnClick._parallelStartHiddenActions, fadeDuration, false));
330
- ext.addBehavior(ChangeMaterialOnClick._startHiddenBehaviour);
331
- }
332
- }
333
-
334
- private static getMaterialName(material: Material) {
335
- return makeNameSafeForUSD(material.name || 'Material') + "_" + material.id;
336
- }
337
-
338
- static variantSwitchIndex: number = 0;
339
- private createVariants() {
340
- if (!this.variantMaterial) return null;
341
-
342
- const variantModels: USDObject[] = [];
343
- for (const target of this.targetModels) {
344
- const variant = target.clone();
345
- variant.name += "_Variant_" + ChangeMaterialOnClick.variantSwitchIndex++ + "_" + ChangeMaterialOnClick.getMaterialName(this.variantMaterial);
346
- variant.displayName = variant.displayName + ": Variant with material " + this.variantMaterial.name;
347
- variant.material = this.variantMaterial;
348
- variant.geometry = target.geometry;
349
- variant.transform = target.transform;
350
-
351
- if (!target.parent || !target.parent.isEmpty()) {
352
- USDObject.createEmptyParent(target);
353
- }
354
- if (target.parent) target.parent.add(variant);
355
- variantModels.push(variant);
356
- }
357
- return variantModels;
358
- }
359
- }
360
-
361
- /**
362
- * @category Everywhere Actions
363
- * @group Components
364
- */
365
- export class SetActiveOnClick extends Behaviour implements IPointerClickHandler, UsdzBehaviour {
366
-
367
- @serializable(Object3D)
368
- target?: Object3D;
369
-
370
- @serializable()
371
- toggleOnClick: boolean = false;
372
-
373
- @serializable()
374
- targetState: boolean = true;
375
-
376
- @serializable()
377
- hideSelf: boolean = true;
378
-
379
- start(): void {
380
- ensureRaycaster(this.gameObject);
381
- }
382
-
383
- onPointerClick(args: PointerEventData) {
384
- args.use();
385
-
386
- if (!this.toggleOnClick && this.hideSelf)
387
- this.gameObject.visible = false;
388
-
389
- if (this.target)
390
- this.target.visible = this.toggleOnClick ? !this.target.visible : this.targetState;
391
- }
392
-
393
- private selfModel!: USDObject;
394
- private selfModelClone!: USDObject;
395
- private targetModel?: USDObject;
396
- private toggleModel?: USDObject;
397
-
398
- createBehaviours(_, model: USDObject, _context: USDZExporterContext) {
399
- if (model.uuid === this.gameObject.uuid) {
400
- this.selfModel = model;
401
- this.selfModelClone = model.clone();
402
- }
403
- }
404
-
405
- private stateBeforeCreatingDocument: boolean = false;
406
- private targetStateBeforeCreatingDocument: boolean = false;
407
- private static clonedToggleIndex = 0;
408
- private static wasVisible = Symbol("usdz_SetActiveOnClick_wasVisible");
409
- private static toggleClone = Symbol("clone for toggling");
410
- private static reverseToggleClone = Symbol("clone for reverse toggling");
411
-
412
- beforeCreateDocument() {
413
- if (!this.target) return;
414
-
415
- // need to cache on the object itself, because otherwise different actions would override each other's visibility state
416
- // TODO would probably be better to have this somewhere on the exporter, not on this component
417
- if (this.gameObject[SetActiveOnClick.wasVisible] === undefined)
418
- this.gameObject[SetActiveOnClick.wasVisible] = this.gameObject.activeSelf;
419
- if (this.target[SetActiveOnClick.wasVisible] === undefined)
420
- this.target[SetActiveOnClick.wasVisible] = (this.target as GameObject).activeSelf;
421
-
422
- this.stateBeforeCreatingDocument = this.gameObject[SetActiveOnClick.wasVisible];
423
- this.targetStateBeforeCreatingDocument = this.target[SetActiveOnClick.wasVisible];
424
-
425
- // Objects need to be on so they are exported, as we're skipping invisible objects
426
- this.gameObject.visible = true;
427
- this.target.visible = true;
428
- }
429
-
430
- afterCreateDocument(ext: BehaviorExtension, context: USDZExporterContext) {
431
- if (!this.target) return;
432
-
433
- // Parameters:
434
- // - hideSelf: the trigger is hidden after clicking. Can basically only be used once.
435
- // - toggleOnClick: the target is toggled on/off when the trigger is clicked.
436
- // - targetState: the target is set to this state when the trigger is clicked.
437
-
438
- // Combinations:
439
- // - when toggleOnClick is on, hideSelf is ignored
440
- // - we need to make a copy of our object
441
- // - when the trigger is clicked
442
- // - hide the original trigger
443
- // - show the copied trigger
444
- // - set the target to targetState
445
- // - when the copied trigger is clicked
446
- // - hide the copied trigger
447
- // - show the original trigger again
448
- // - set the target to !targetState
449
- // - when toggleOnClick is off, hideSelf is used
450
- // - no copy is needed
451
- // - when the trigger is clicked
452
- // - hide the trigger
453
- // - set the target to the targetState
454
-
455
- this.targetModel = context.document.findById(this.target.uuid);
456
- const originalModel = this.selfModel;
457
-
458
- if (this.selfModel && this.targetModel) {
459
- let selfModel = this.selfModel;
460
- let targetState = this.targetState;
461
-
462
- // if we toggle, we need to create a copy of our object
463
- if (this.toggleOnClick) {
464
- // When toggling we want to respect the current state of the target,
465
- // so effectively this.targetState and this.hideSelf are ignored.
466
- targetState = !this.targetStateBeforeCreatingDocument;
467
-
468
-
469
- // Potentially it's easier/better to just "clone" and put the object as a sibling next
470
- // to the rest of the hierarchy. This way we would lose nested clicks (clicking on a child would not trigger events)
471
- // but we're not potentially duplicating tons of objects.
472
- // It's much easier to reason about nested actions when we're not duplicating tons of hierarchy...
473
- // We can probably only do a shallow clone when the tapped object has geometry of its own, otherwise
474
- // we end up with nothing to tap on.
475
-
476
- // Option A: we deep clone ourselves. This makes hierarchical cases and nested behaviours really complex.
477
- // We do this currently when the object doesn't have any geometry.
478
- if (!this.selfModelClone.geometry) {
479
- if (!this.selfModel.parent || this.selfModel.parent.isEmpty())
480
- USDDocument.createEmptyParent(this.selfModel);
481
- this.toggleModel = this.selfModel.deepClone();
482
- this.toggleModel.name += "_toggle";
483
- this.selfModel.parent!.add(this.toggleModel);
484
- }
485
- else {
486
- // Option B: we shallow clone ourselves and put the clone next to us. This means childs are not clickable anymore.
487
- // We create clones exactly once for this gameObject, so that all SetActiveOnClick on the same object use the same trigger.
488
- if (!this.gameObject[SetActiveOnClick.toggleClone]) {
489
- const clone = this.selfModelClone.clone();
490
- clone.setMatrix(new Matrix4());
491
- clone.name += "_toggle" + (SetActiveOnClick.clonedToggleIndex++);
492
- originalModel.add(clone);
493
- this.gameObject[SetActiveOnClick.toggleClone] = clone;
494
-
495
- console.warn("USDZExport: Toggle " + this.gameObject.name + " doesn't have geometry. It will be deep cloned and nested behaviours will likely not work.");
496
- }
497
- const clonedSelfModel = this.gameObject[SetActiveOnClick.toggleClone];
498
-
499
- if (!this.gameObject[SetActiveOnClick.reverseToggleClone]) {
500
- const clone = this.selfModelClone.clone();
501
- clone.setMatrix(new Matrix4());
502
- clone.name += "_toggleReverse" + (SetActiveOnClick.clonedToggleIndex++);
503
- originalModel.add(clone);
504
- this.gameObject[SetActiveOnClick.reverseToggleClone] = clone;
505
- }
506
- this.toggleModel = this.gameObject[SetActiveOnClick.reverseToggleClone];
507
-
508
- if (!this.toggleModel!.geometry || !clonedSelfModel.geometry) {
509
- console.error("triggers without childs and without geometry won't work!", this, originalModel.geometry)
510
- }
511
-
512
- // We're targeting the clone in the actions below, not the original object
513
- selfModel = clonedSelfModel;
514
-
515
- // Remove the geometry, we've duplicated it into the toggle/reverseToggle already
516
- originalModel.geometry = null;
517
- originalModel.material = null;
518
-
519
- // Known issues: clone() does not clone skinned mesh geometry, lights, cameras;
520
- // we still have them on the original object and the clones won't have it.
521
- }
522
- }
523
-
524
- // this.toggleOnClick is false, so we don't have a toggleModel – no need for clones,
525
- // just set the target object to targetState and optionally hide ourselves
526
- if (!this.toggleModel) {
527
- const sequence: ActionModel[] = [];
528
- if (this.hideSelf)
529
- sequence.push(ActionBuilder.fadeAction(selfModel, 0, false));
530
- sequence.push(ActionBuilder.fadeAction(this.targetModel, 0, targetState));
531
-
532
- ext.addBehavior(new BehaviorModel("Toggle_" + selfModel.name + "_ToggleTo" + (targetState ? "On" : "Off"),
533
- TriggerBuilder.tapTrigger(selfModel),
534
- sequence.length > 1 ? ActionBuilder.parallel(...sequence) : sequence[0],
535
- ));
536
- }
537
- // We have a toggleModel, so we need to set up two sequences:
538
- // - one that hides the original object, shows the toggle and sets the target to targetState
539
- // - one that hides the toggle, shows the original object and sets the target to !targetState
540
- else if (this.toggleOnClick) {
541
- const toggleSequence: ActionModel[] = [];
542
- toggleSequence.push(ActionBuilder.fadeAction(selfModel, 0, false));
543
- toggleSequence.push(ActionBuilder.fadeAction(this.toggleModel, 0, true));
544
- toggleSequence.push(ActionBuilder.fadeAction(this.targetModel, 0, targetState));
545
-
546
- ext.addBehavior(new BehaviorModel("Toggle_" + selfModel.name + "_ToggleTo" + (targetState ? "On" : "Off"),
547
- TriggerBuilder.tapTrigger(selfModel),
548
- ActionBuilder.parallel(...toggleSequence)
549
- ));
550
-
551
- const reverseSequence: ActionModel[] = [];
552
- reverseSequence.push(ActionBuilder.fadeAction(this.toggleModel, 0, false));
553
- reverseSequence.push(ActionBuilder.fadeAction(selfModel, 0, true));
554
- reverseSequence.push(ActionBuilder.fadeAction(this.targetModel, 0, !targetState));
555
-
556
- ext.addBehavior(new BehaviorModel("Toggle_" + selfModel.name + "_ToggleTo" + (!targetState ? "On" : "Off"),
557
- TriggerBuilder.tapTrigger(this.toggleModel),
558
- ActionBuilder.parallel(...reverseSequence)
559
- ));
560
- }
561
-
562
- // Ensure initial states are set correctly so that we get the same result as was currently active in the runtime
563
- const objectsToHide = new Array<USDObject>();
564
- if (!this.targetStateBeforeCreatingDocument)
565
- objectsToHide.push(this.targetModel);
566
- if (!this.stateBeforeCreatingDocument)
567
- objectsToHide.push(originalModel);
568
- if (this.toggleModel)
569
- objectsToHide.push(this.toggleModel);
570
-
571
- HideOnStart.add(objectsToHide, ext);
572
- }
573
- }
574
-
575
- afterSerialize(_ext: BehaviorExtension, _context: USDZExporterContext): void {
576
- // cleanup visibility cache
577
- if (this.gameObject[SetActiveOnClick.wasVisible] !== undefined) {
578
- this.gameObject.visible = this.gameObject[SetActiveOnClick.wasVisible];
579
- delete this.gameObject[SetActiveOnClick.wasVisible];
580
- }
581
- if (this.target && this.target[SetActiveOnClick.wasVisible] !== undefined) {
582
- this.target.visible = this.target[SetActiveOnClick.wasVisible];
583
- delete this.target[SetActiveOnClick.wasVisible];
584
- }
585
-
586
- // cleanup trigger clones
587
- delete this.gameObject[SetActiveOnClick.toggleClone];
588
- delete this.gameObject[SetActiveOnClick.reverseToggleClone];
589
- }
590
- }
591
-
592
- /**
593
- * @category Everywhere Actions
594
- * @group Components
595
- */
596
- export class HideOnStart extends Behaviour implements UsdzBehaviour {
597
-
598
- private static _fadeBehaviour?: BehaviorModel;
599
- private static _fadeObjects: Array<USDObject | Object3D> = [];
600
-
601
- static add(target: Target, ext: BehaviorExtension) {
602
- const arr = Array.isArray(target) ? target : [target];
603
- for (const entry of arr) {
604
- if (!HideOnStart._fadeObjects.includes(entry)) {
605
- console.log("adding hide on start", entry);
606
- HideOnStart._fadeObjects.push(entry);
607
- }
608
- }
609
- if (HideOnStart._fadeBehaviour === undefined) {
610
- HideOnStart._fadeBehaviour = new BehaviorModel("HideOnStart",
611
- TriggerBuilder.sceneStartTrigger(),
612
- //@ts-ignore
613
- ActionBuilder.fadeAction(HideOnStart._fadeObjects, 0, false)
614
- );
615
- ext.addBehavior(HideOnStart._fadeBehaviour);
616
- }
617
- }
618
-
619
- start() {
620
- GameObject.setActive(this.gameObject, false);
621
- }
622
-
623
- createBehaviours(ext, model, _context) {
624
- if (model.uuid === this.gameObject.uuid) {
625
- // we only want to mark the object as HideOnStart if it's still hidden
626
- if (!this.wasVisible) {
627
- HideOnStart.add(model, ext);
628
- }
629
- }
630
- }
631
-
632
- private wasVisible: boolean = false;
633
-
634
- beforeCreateDocument() {
635
- this.wasVisible = GameObject.isActiveSelf(this.gameObject);
636
- }
637
- }
638
-
639
- /**
640
- * @category Everywhere Actions
641
- * @group Components
642
- */
643
- export class EmphasizeOnClick extends Behaviour implements UsdzBehaviour {
644
-
645
- @serializable()
646
- target?: Object3D;
647
-
648
- @serializable()
649
- duration: number = 0.5;
650
-
651
- @serializable()
652
- motionType: EmphasizeActionMotionType = "bounce";
653
-
654
- beforeCreateDocument() { }
655
-
656
- createBehaviours(ext, model, _context) {
657
- if (!this.target) return;
658
-
659
- if (model.uuid === this.gameObject.uuid) {
660
- const emphasize = new BehaviorModel("emphasize " + this.name,
661
- TriggerBuilder.tapTrigger(this.gameObject),
662
- ActionBuilder.emphasize(this.target, this.duration, this.motionType, undefined, "basic"),
663
- );
664
- ext.addBehavior(emphasize);
665
- }
666
- }
667
-
668
- afterCreateDocument(_ext, _context) { }
669
- }
670
-
671
- /**
672
- * @category Everywhere Actions
673
- * @group Components
674
- */
675
- export class PlayAudioOnClick extends Behaviour implements IPointerClickHandler, UsdzBehaviour {
676
-
677
- @serializable(AudioSource)
678
- target?: AudioSource;
679
-
680
- @serializable(URL)
681
- clip: string = "";
682
-
683
- @serializable()
684
- toggleOnClick: boolean = false;
685
-
686
- // Not exposed, but used for implicit playback of PlayOnAwake audio sources
687
- trigger: "tap" | "start" = "tap";
688
-
689
- start(): void {
690
- ensureRaycaster(this.gameObject);
691
- }
692
-
693
- ensureAudioSource() {
694
- if (!this.target) {
695
- const newAudioSource = this.gameObject.addComponent(AudioSource);
696
- if (newAudioSource) {
697
- this.target = newAudioSource;
698
- newAudioSource.spatialBlend = 1;
699
- newAudioSource.volume = 1;
700
- newAudioSource.loop = false;
701
- newAudioSource.preload = true;
702
- }
703
- }
704
- }
705
-
706
- onPointerClick(args: PointerEventData) {
707
- args.use();
708
-
709
- if (!this.target?.clip && !this.clip) return;
710
-
711
- this.ensureAudioSource();
712
-
713
- if (this.target) {
714
-
715
- if (this.target.isPlaying && this.toggleOnClick) {
716
- this.target.stop();
717
- }
718
- else {
719
- if (!this.toggleOnClick && this.target.isPlaying) {
720
- this.target.stop();
721
- }
722
- if (this.clip) this.target.play(this.clip);
723
- else this.target.play();
724
- }
725
- }
726
- }
727
-
728
- createBehaviours(ext: BehaviorExtension, model: USDObject, _context: USDZExporterContext) {
729
- if (!this.target && !this.clip) return;
730
- if (model.uuid === this.gameObject.uuid) {
731
-
732
- const clipUrl = this.clip ? this.clip : this.target ? this.target.clip : undefined;
733
- if (!clipUrl) return;
734
- if (typeof clipUrl !== "string") return;
735
-
736
- const playbackTarget = this.target ? this.target.gameObject : this.gameObject;
737
- const clipName = AudioExtension.getName(clipUrl);
738
- const volume = this.target ? this.target.volume : 1;
739
- const auralMode = this.target && this.target.spatialBlend == 0 ? "nonSpatial" : "spatial";
740
-
741
- // This checks if any child is clickable – if yes, the tap trigger is added; if not, we omit it.
742
- let anyChildHasGeometry = false;
743
- this.gameObject.traverse(c => {
744
- if (c instanceof Mesh && c.visible) anyChildHasGeometry = true;
745
- });
746
- // Workaround: seems iOS often simply doesn't play audio on scene start when this is NOT present.
747
- // unclear why, but having a useless tap action (nothing to tap on) "fixes" it.
748
- anyChildHasGeometry = true;
749
-
750
- const audioClip = ext.addAudioClip(clipUrl);
751
- // const stopAction: IBehaviorElement = ActionBuilder.playAudioAction(playbackTarget, audioClip, "stop", volume, auralMode);
752
- let playAction: IBehaviorElement = ActionBuilder.playAudioAction(playbackTarget, audioClip, "play", volume, auralMode);
753
- if (this.target && this.target.loop)
754
- playAction = ActionBuilder.sequence(playAction).makeLooping();
755
-
756
- const behaviorName = (this.name ? "_" + this.name : "");
757
-
758
- if (anyChildHasGeometry && this.trigger === "tap")
759
- {
760
- // does not seem to work in iOS / QuickLook...
761
- // TODO use play "type" which can be start/stop/pause
762
- if (this.toggleOnClick) (playAction as ActionModel).multiplePerformOperation = "stop";
763
- const playClipOnTap = new BehaviorModel("playAudio" + behaviorName,
764
- TriggerBuilder.tapTrigger(model),
765
- playAction,
766
- );
767
- ext.addBehavior(playClipOnTap);
768
- }
769
-
770
- // automatically play audio on start too if the referenced AudioSource has playOnAwake enabled
771
- if (this.target && this.target.playOnAwake && this.target.enabled) {
772
- if (anyChildHasGeometry && this.trigger === "tap") {
773
- // WORKAROUND Currently (20240509) we MUST not emit this behaviour if we're also expecting the tap trigger to work.
774
- // Seems to be a regression in QuickLook... audio clips can't be stopped anymore as soon as they start playing.
775
- console.warn("USDZExport: Audio sources that are played on tap can't also auto-play at scene start due to a QuickLook bug.");
776
- }
777
- else {
778
- const playClipOnStart = new BehaviorModel("playAudioOnStart" + behaviorName,
779
- TriggerBuilder.sceneStartTrigger(),
780
- playAction,
781
- );
782
- ext.addBehavior(playClipOnStart);
783
- }
784
- }
785
- }
786
- }
787
- }
788
-
789
- /**
790
- * @category Everywhere Actions
791
- * @group Components
792
- */
793
- export class PlayAnimationOnClick extends Behaviour implements IPointerClickHandler, UsdzBehaviour, UsdzAnimation {
794
-
795
- @serializable(Animator)
796
- animator?: Animator;
797
-
798
- @serializable()
799
- stateName?: string;
800
-
801
- // Not editable from the outside yet, but from code
802
- // we want to expose this once we have a nice drawer for "Triggers" (e.g. shows proximity distance)
803
- // and once we rename the component to "PlayAnimation" or "PlayAnimationOnTrigger"
804
- trigger: "tap" | "start" = "tap"; // "proximity"
805
- animation?: Animation;
806
-
807
- private get target() { return this.animator?.gameObject || this.animation?.gameObject }
808
-
809
- start(): void {
810
- ensureRaycaster(this.gameObject);
811
- }
812
-
813
- onPointerClick(args: PointerEventData) {
814
- args.use();
815
- if (!this.target) return;
816
- if (this.stateName) {
817
- // TODO this is currently quite annoying to use,
818
- // as for the web we use the Animator component and its states directly,
819
- // while in QuickLook we use explicit animations / states.
820
- this.animator?.play(this.stateName, 0, 0, .1);
821
- }
822
- }
823
-
824
- private selfModel: any;
825
-
826
- private stateAnimationModel: any;
827
-
828
- private animationSequence? = new Array<RegisteredAnimationInfo>();
829
- private animationLoopAfterSequence? = new Array<RegisteredAnimationInfo>();
830
- private randomOffsetNormalized: number = 0;
831
-
832
- createBehaviours(_ext: BehaviorExtension, model: USDObject, _context: USDZExporterContext) {
833
-
834
- if (model.uuid === this.gameObject.uuid)
835
- this.selfModel = model;
836
- }
837
-
838
- private static animationActions: ActionModel[] = [];
839
- private static rootsWithExclusivePlayback: Set<Object3D> = new Set();
840
-
841
- // Cleanup. TODO This is not the best way as it's called multiple times (once for each component).
842
- afterSerialize() {
843
- if (PlayAnimationOnClick.rootsWithExclusivePlayback.size > 1) {
844
- const message = "Multiple root objects targeted by more than one animation. To work around QuickLook bug FB13410767, animations will be set as \"exclusive\" and activating them will stop other animations being marked as exclusive.";
845
- if (isDevEnvironment()) showBalloonWarning(message);
846
- console.warn(message, ...PlayAnimationOnClick.rootsWithExclusivePlayback);
847
- }
848
- PlayAnimationOnClick.animationActions = [];
849
- PlayAnimationOnClick.rootsWithExclusivePlayback = new Set();
850
- }
851
-
852
- afterCreateDocument(ext: BehaviorExtension, context: USDZExporterContext) {
853
- if ((this.animationSequence === undefined && this.animationLoopAfterSequence === undefined) || !this.stateAnimationModel) return;
854
- if (!this.target) return;
855
-
856
- const document = context.document;
857
-
858
- // check if the AnimationExtension has been attached and what data it has for the current object
859
- const animationExt = context.extensions.find(ext => ext instanceof AnimationExtension) as AnimationExtension;
860
- if (!animationExt) return;
861
-
862
- // This is a workaround for FB13410767 - StartAnimationAction in USDZ preliminary behaviours does not stop when another StartAnimationAction is called on the same prim
863
- // When we play multiple animations on the same root, QuickLook just overlaps them and glitches around instead of stopping an earlier one.
864
- // Once this is fixed, we can relax this check and just always make it non-exclusive again.
865
- // Setting exclusive playback has the side effect of unfortunately canceling all other playing actions that are exclusive too -
866
- // seems there is no finer-grained control over which actions should stop which other actions...
867
- const requiresExclusivePlayback = animationExt.getClipCount(this.target) > 1;
868
- if (requiresExclusivePlayback) {
869
- if (isDevEnvironment())
870
- console.warn("Setting exclusive playback for " + this.target.name + "@" + this.stateName + " because it has " + animationExt.getClipCount(this.target) + " animations. This works around QuickLook bug FB13410767.");
871
-
872
- PlayAnimationOnClick.rootsWithExclusivePlayback.add(this.target);
873
- }
874
-
875
- const behaviorName = (this.name ? this.name : "");
876
-
877
- document.traverse(model => {
878
- if (model.uuid === this.target?.uuid) {
879
- const sequence = PlayAnimationOnClick.getActionForSequences(
880
- document,
881
- model,
882
- this.animationSequence,
883
- this.animationLoopAfterSequence,
884
- this.randomOffsetNormalized,
885
- );
886
-
887
- const playAnimationOnTap = new BehaviorModel(this.trigger + "_" + behaviorName + "_toPlayAnimation_" + this.stateName + "_on_" + this.target?.name,
888
- this.trigger == "tap" ? TriggerBuilder.tapTrigger(this.selfModel) : TriggerBuilder.sceneStartTrigger(),
889
- sequence
890
- );
891
-
892
- // See comment above for why exclusive playback is currently required when playing multiple animations on the same root.
893
- if (requiresExclusivePlayback)
894
- playAnimationOnTap.makeExclusive(true);
895
- ext.addBehavior(playAnimationOnTap);
896
- }
897
- });
898
- }
899
-
900
- static getActionForSequences(_document: USDDocument, model: Target, animationSequence?: Array<RegisteredAnimationInfo>, animationLoopAfterSequence?: Array<RegisteredAnimationInfo>, randomOffsetNormalized?: number) {
901
-
902
- const getOrCacheAction = (model: Target, anim: RegisteredAnimationInfo) => {
903
- let action = PlayAnimationOnClick.animationActions.find(a => a.affectedObjects == model && a.start == anim.start && a.duration == anim.duration && a.animationSpeed == anim.speed);
904
- if (!action) {
905
- action = ActionBuilder.startAnimationAction(model, anim) as ActionModel;
906
- PlayAnimationOnClick.animationActions.push(action);
907
- }
908
- return action;
909
- }
910
-
911
- const sequence = ActionBuilder.sequence();
912
-
913
- if (animationSequence && animationSequence.length > 0)
914
- {
915
- for (const anim of animationSequence) {
916
- sequence.addAction(getOrCacheAction(model, anim));
917
- }
918
- }
919
-
920
- if (animationLoopAfterSequence && animationLoopAfterSequence.length > 0) {
921
- // only make a new action group if there's already stuff in the existing one
922
- const loopSequence = sequence.actions.length == 0 ? sequence : ActionBuilder.sequence();
923
- for (const anim of animationLoopAfterSequence) {
924
- loopSequence.addAction(getOrCacheAction(model, anim));
925
- }
926
- loopSequence.makeLooping();
927
- if (sequence !== loopSequence)
928
- sequence.addAction(loopSequence);
929
- }
930
-
931
- if (randomOffsetNormalized && randomOffsetNormalized > 0) {
932
- sequence.actions.unshift(ActionBuilder.waitAction(randomOffsetNormalized));
933
- }
934
-
935
- return sequence;
936
- }
937
-
938
- static getAndRegisterAnimationSequences(ext: AnimationExtension, target: GameObject, stateName?: string):
939
- {
940
- animationSequence: Array<RegisteredAnimationInfo>,
941
- animationLoopAfterSequence: Array<RegisteredAnimationInfo>,
942
- randomTimeOffset: number,
943
- } | undefined {
944
-
945
- if (!target) return undefined;
946
-
947
- const animator = target.getComponent(Animator);
948
- const animation = target.getComponent(Animation);
949
-
950
- if (!animator && !animation) return undefined;
951
-
952
- if (animator && !stateName) {
953
- throw new Error("PlayAnimationOnClick: No stateName specified for animator " + animator.name + " on " + target.name);
954
- }
955
-
956
- let animationSequence: Array<RegisteredAnimationInfo> = [];
957
- let animationLoopAfterSequence: Array<RegisteredAnimationInfo> = [];
958
-
959
- if (animation) {
960
- const anim = ext.registerAnimation(target, animation.clip);
961
- if (anim) {
962
- if (animation.loop)
963
- animationLoopAfterSequence.push(anim);
964
- else
965
- animationSequence.push(anim);
966
- }
967
-
968
- let randomTimeOffset = 0;
969
- if (animation.minMaxOffsetNormalized) {
970
- const from = animation.minMaxOffsetNormalized.x;
971
- const to = animation.minMaxOffsetNormalized.y;
972
- randomTimeOffset = (animation.clip?.duration || 1) * (from + Math.random() * (to - from));
973
- }
974
-
975
- return {
976
- animationSequence,
977
- animationLoopAfterSequence,
978
- randomTimeOffset,
979
- }
980
- }
981
-
982
- // If there's a separate state specified to play after this one, we
983
- // play it automatically. Theoretically an animator state machine flow could be encoded here.
984
-
985
- // We're parsing the Animator states here and follow the transition chain until we find a loop.
986
- // There are some edge cases:
987
- // - (0 > 1.looping) should keep looping (1).
988
- // - (0 > 1 > 1) should keep looping (1).
989
- // - (0 > 1 > 2 > 3 > 2) should keep looping (2,3).
990
- // - (0 > 1 > 2 > 3 > 0) should keep looping (0,1,2,3).
991
- const runtimeController = animator?.runtimeAnimatorController;
992
- let currentState = runtimeController?.findState(stateName);
993
- let statesUntilLoop: State[] = [];
994
- let statesLooping: State[] = [];
995
-
996
- if (runtimeController && currentState) {
997
- // starting point – we have set this above already as startAction
998
- const visitedStates = new Array<State>;
999
- visitedStates.push(currentState);
1000
- let foundLoop = false;
1001
-
1002
- while (true && visitedStates.length < 100) {
1003
- if (!currentState || currentState === null || !currentState.transitions || currentState.transitions.length === 0) {
1004
- if (currentState.motion?.isLooping)
1005
- foundLoop = true;
1006
- break;
1007
- }
1008
-
1009
- // find the first transition without parameters
1010
- // TODO we could also find the first _valid_ transition here instead based on the current parameters.
1011
- const transition = currentState.transitions.find(t => t.conditions.length === 0);
1012
- const nextState: State | null = transition ? runtimeController["getState"](transition.destinationState, 0) : null;
1013
- // abort: we found a state loop
1014
- if (nextState && visitedStates.includes(nextState)) {
1015
- currentState = nextState;
1016
- foundLoop = true;
1017
- break;
1018
- }
1019
- // keep looking: transition to another state
1020
- else if (transition) {
1021
- currentState = nextState;
1022
- if (!currentState)
1023
- break;
1024
- visitedStates.push(currentState);
1025
- }
1026
- // abort: no transition found. check if last state is looping
1027
- else {
1028
- foundLoop = currentState.motion?.isLooping ?? false;
1029
- break;
1030
- }
1031
- }
1032
-
1033
- if (foundLoop && currentState) {
1034
- // check what the first state in the loop is – it must be matching the last one we added
1035
- const firstStateInLoop = visitedStates.indexOf(currentState);
1036
- statesUntilLoop = visitedStates.slice(0, firstStateInLoop); // can be empty, which means we're looping all
1037
- statesLooping = visitedStates.slice(firstStateInLoop); // can be empty, which means nothing is looping
1038
-
1039
- // Potentially we need to prevent self-transitions into a non-looping state, these do not result in a loop in the runtime
1040
- /*
1041
- if (statesLooping.length === 1 && !statesLooping[0].motion?.isLooping) {
1042
- statesUntilLoop.push(statesLooping[0]);
1043
- statesLooping = [];
1044
- }
1045
- */
1046
- if (debug) console.log("found loop from " + stateName, "states until loop", statesUntilLoop, "states looping", statesLooping);
1047
- }
1048
- else {
1049
- statesUntilLoop = visitedStates;
1050
- statesLooping = [];
1051
- if (debug) console.log("found no loop from " + stateName, "states", statesUntilLoop);
1052
- }
1053
- // If we do NOT loop, we need to explicitly add a single-keyframe clip with a "hold" pose
1054
- // to prevent the animation from resetting to the start.
1055
- if (!statesLooping.length) {
1056
- const lastState = statesUntilLoop[statesUntilLoop.length - 1];
1057
- const lastClip = lastState.motion?.clip;
1058
- if (lastClip) {
1059
- let clipCopy: AnimationClip | undefined;
1060
- if (ext.holdClipMap.has(lastClip)) {
1061
- clipCopy = ext.holdClipMap.get(lastClip);
1062
- }
1063
- else {
1064
- // We're creating a "hold" clip here; exactly 1 second long, and inteprolates exactly on the duration of the clip
1065
- const holdStateName = lastState.name + "_hold";
1066
- clipCopy = lastClip.clone();
1067
- clipCopy.duration = 1;
1068
- clipCopy.name = holdStateName;
1069
- const lastFrame = lastClip.duration;
1070
- clipCopy.tracks = lastClip.tracks.map(t => {
1071
- const trackCopy = t.clone();
1072
- trackCopy.times = new Float32Array([0, lastFrame]);
1073
- const len = t.values.length;
1074
- const size = t.getValueSize();;
1075
- const lastValue = t.values.slice(len - size, len);
1076
- // we need this twice
1077
- trackCopy.values = new Float32Array(2 * size);
1078
- trackCopy.values.set(lastValue, 0);
1079
- trackCopy.values.set(lastValue, size);
1080
- return trackCopy;
1081
- });
1082
- clipCopy.name = holdStateName;
1083
- ext.holdClipMap.set(lastClip, clipCopy);
1084
- }
1085
-
1086
- if (clipCopy) {
1087
- const holdState = {
1088
- name: clipCopy.name,
1089
- motion: { clip: clipCopy, isLooping: false, name: clipCopy.name },
1090
- speed: 1,
1091
- transitions: [],
1092
- behaviours: [],
1093
- hash: lastState.hash + 1,
1094
- }
1095
- statesLooping.push(holdState);
1096
- }
1097
- }
1098
- }
1099
- }
1100
-
1101
- // Special case: someone's trying to play an empty clip without any motion data, no loops or anything.
1102
- // In that case, we simply go to the rest clip – this is a common case for "idle" states.
1103
- if (statesUntilLoop.length === 1 && (!statesUntilLoop[0].motion?.clip || statesUntilLoop[0].motion?.clip.tracks?.length === 0)) {
1104
- animationSequence = new Array<RegisteredAnimationInfo>();
1105
- const anim = ext.registerAnimation(target, null);
1106
- if (anim) animationSequence.push(anim);
1107
- return undefined;
1108
- }
1109
-
1110
- // filter out any states that don't have motion data
1111
- statesUntilLoop = statesUntilLoop.filter(s => s.motion?.clip && s.motion?.clip.tracks?.length > 0);
1112
- statesLooping = statesLooping.filter(s => s.motion?.clip && s.motion?.clip.tracks?.length > 0);
1113
-
1114
- // If none of the found states have motion, we need to warn
1115
- if (statesUntilLoop.length === 0 && statesLooping.length === 0) {
1116
- console.warn("No clips found for state " + stateName + " on " + animator?.name + ", can't export animation data");
1117
- return undefined;
1118
- }
1119
-
1120
- const addStateToSequence = (state: State, sequence: Array<RegisteredAnimationInfo>) => {
1121
- if (!target) return;
1122
- const anim = ext.registerAnimation(target, state.motion.clip ?? null);
1123
- if (anim) {
1124
- anim.speed = state.speed;
1125
- sequence.push(anim);
1126
- }
1127
- else console.warn("Couldn't register animation for state " + state.name + " on " + animator?.name);
1128
- };
1129
-
1130
- // Register all the animation states we found.
1131
- if (statesUntilLoop.length > 0) {
1132
- animationSequence = new Array<RegisteredAnimationInfo>();
1133
- for (const state of statesUntilLoop) {
1134
- addStateToSequence(state, animationSequence);
1135
- }
1136
- }
1137
- if (statesLooping.length > 0) {
1138
- animationLoopAfterSequence = new Array<RegisteredAnimationInfo>();
1139
- for (const state of statesLooping) {
1140
- addStateToSequence(state, animationLoopAfterSequence);
1141
- }
1142
- }
1143
-
1144
- let randomTimeOffset = 0;
1145
- if (animator && runtimeController && animator.minMaxOffsetNormalized) {
1146
- const from = animator.minMaxOffsetNormalized.x;
1147
- const to = animator.minMaxOffsetNormalized.y;
1148
- // first state in the sequence
1149
- const firstState = statesUntilLoop.length ? statesUntilLoop[0] : statesLooping.length ? statesLooping[0] : null;
1150
- randomTimeOffset = (firstState?.motion.clip?.duration || 1) * (from + Math.random() * (to - from));
1151
- }
1152
- return {
1153
- animationSequence,
1154
- animationLoopAfterSequence,
1155
- randomTimeOffset,
1156
- }
1157
- }
1158
-
1159
- createAnimation(ext: AnimationExtension, model: USDObject, _context: USDZExporterContext) {
1160
-
1161
- if (!this.target || (!this.animator && !this.animation)) return;
1162
-
1163
- const result = PlayAnimationOnClick.getAndRegisterAnimationSequences(ext, this.target, this.stateName);
1164
- if (!result) return;
1165
-
1166
- this.animationSequence = result.animationSequence;
1167
- this.animationLoopAfterSequence = result.animationLoopAfterSequence;
1168
- this.randomOffsetNormalized = result.randomTimeOffset;
1169
-
1170
- this.stateAnimationModel = model;
1171
- }
1172
-
1173
- }
1174
-
1175
- export class PreliminaryAction extends Behaviour {
1176
- getType(): string | void { }
1177
- @serializable(Object3D)
1178
- target?: Object3D;
1179
-
1180
-
1181
- getDuration(): number | void { };
1182
- }
1183
-
1184
- export class PreliminaryTrigger extends Behaviour {
1185
-
1186
- @serializable(PreliminaryAction)
1187
- target?: PreliminaryAction;
1188
- }
1189
-
1190
- /**
1191
- * @category Everywhere Actions
1192
- * @group Components
1193
- */
1194
- export class VisibilityAction extends PreliminaryAction {
1195
-
1196
- //@type int
1197
- @serializable()
1198
- type: VisibilityActionType = VisibilityActionType.Hide;
1199
-
1200
- @serializable()
1201
- duration: number = 1;
1202
-
1203
- getType() {
1204
- switch (this.type) {
1205
- case VisibilityActionType.Hide: return "hide";
1206
- case VisibilityActionType.Show: return "show";
1207
- }
1208
- }
1209
-
1210
- getDuration() {
1211
- return this.duration;
1212
- }
1213
- }
1214
-
1215
- /**
1216
- * @category Everywhere Actions
1217
- * @group Components
1218
- */
1219
- export class TapGestureTrigger extends PreliminaryTrigger {
1220
-
1221
- }
1222
-
1223
- export enum VisibilityActionType {
1224
- Show = 0,
1225
- Hide = 1,
1
+ import { AnimationClip, Material, Matrix4, Mesh, Object3D, Quaternion, Vector3 } from "three";
2
+
3
+ import { isDevEnvironment, showBalloonWarning } from "../../../../../engine/debug/index.js";
4
+ import { serializable } from "../../../../../engine/engine_serialization_decorator.js";
5
+ import { getWorldPosition, getWorldQuaternion, getWorldScale, setWorldPosition, setWorldQuaternion, setWorldScale } from "../../../../../engine/engine_three_utils.js";
6
+ import { getParam } from "../../../../../engine/engine_utils.js";
7
+ import { compareAssociation } from "../../../../../engine/extensions/extension_utils.js";
8
+ import type { State } from "../../../../../engine/extensions/NEEDLE_animator_controller_model.js";
9
+ import { NEEDLE_progressive } from "../../../../../engine/extensions/NEEDLE_progressive.js";
10
+ import { Animation } from "../../../../Animation.js";
11
+ import { Animator } from "../../../../Animator.js";
12
+ import { AudioSource } from "../../../../AudioSource.js";
13
+ import { Behaviour, GameObject } from "../../../../Component.js";
14
+ import type { IPointerClickHandler, PointerEventData } from "../../../../ui/PointerEvents.js";
15
+ import { ObjectRaycaster,Raycaster } from "../../../../ui/Raycaster.js";
16
+ import { makeNameSafeForUSD,USDDocument, USDObject, USDZExporterContext } from "../../ThreeUSDZExporter.js";
17
+ import { AnimationExtension, RegisteredAnimationInfo, type UsdzAnimation } from "../Animation.js";
18
+ import { AudioExtension } from "./AudioExtension.js";
19
+ import type { BehaviorExtension, UsdzBehaviour } from "./Behaviour.js";
20
+ import { ActionBuilder, ActionModel, BehaviorModel, EmphasizeActionMotionType,GroupActionModel,type IBehaviorElement, Target, TriggerBuilder } from "./BehavioursBuilder.js";
21
+
22
+ const debug = getParam("debugusdzbehaviours");
23
+
24
+ function ensureRaycaster(obj: GameObject) {
25
+ if (!obj) return;
26
+ if (!obj.getComponentInParent(Raycaster)) {
27
+ if (isDevEnvironment())
28
+ console.debug("Raycaster on \"" + obj.name + "\" was automatically added, because no raycaster was found in the parent hierarchy.")
29
+ obj.addComponent(ObjectRaycaster);
30
+ }
31
+ }
32
+
33
+ /**
34
+ * @category Everywhere Actions
35
+ * @group Components
36
+ */
37
+ export class ChangeTransformOnClick extends Behaviour implements IPointerClickHandler, UsdzBehaviour {
38
+
39
+ @serializable(Object3D)
40
+ object?: Object3D;
41
+
42
+ @serializable(Object3D)
43
+ target?: Object3D;
44
+
45
+ @serializable()
46
+ duration: number = 1;
47
+
48
+ @serializable()
49
+ relativeMotion: boolean = false;
50
+
51
+ private coroutine: Generator | null = null;
52
+
53
+ private targetPos = new Vector3();
54
+ private targetRot = new Quaternion();
55
+ private targetScale = new Vector3();
56
+
57
+ start(): void {
58
+ ensureRaycaster(this.gameObject);
59
+ }
60
+
61
+ onPointerClick(args: PointerEventData) {
62
+ args.use();
63
+ if (this.coroutine) this.stopCoroutine(this.coroutine);
64
+ if (!this.relativeMotion)
65
+ this.coroutine = this.startCoroutine(this.moveToTarget());
66
+ else
67
+ this.coroutine = this.startCoroutine(this.moveRelative());
68
+ }
69
+
70
+ private *moveToTarget() {
71
+
72
+ if (!this.target || !this.object) return;
73
+
74
+ const thisPos = getWorldPosition(this.object).clone();
75
+ const targetPos = getWorldPosition(this.target).clone();
76
+
77
+ const thisRot = getWorldQuaternion(this.object).clone();
78
+ const targetRot = getWorldQuaternion(this.target).clone();
79
+
80
+ const thisScale = getWorldScale(this.object).clone();
81
+ const targetScale = getWorldScale(this.target).clone();
82
+
83
+ const dist = thisPos.distanceTo(targetPos);
84
+ const rotDist = thisRot.angleTo(targetRot);
85
+ const scaleDist = thisScale.distanceTo(targetScale);
86
+
87
+ if (dist < 0.01 && rotDist < 0.01 && scaleDist < 0.01) {
88
+ setWorldPosition(this.object, targetPos);
89
+ setWorldQuaternion(this.object, targetRot);
90
+ setWorldScale(this.object, targetScale);
91
+ this.coroutine = null;
92
+ return;
93
+ }
94
+
95
+ let t01 = 0;
96
+ let eased = 0;
97
+ while (t01 < 1) {
98
+
99
+ t01 += this.context.time.deltaTime / this.duration;
100
+ if (t01 > 1) t01 = 1;
101
+
102
+ // apply ease-in-out
103
+ // https://easings.net/
104
+ eased = t01 < 0.5 ? 4 * t01 * t01 * t01 : 1 - Math.pow(-2 * t01 + 2, 3) / 2;
105
+
106
+ this.targetPos.lerpVectors(thisPos, targetPos, eased);
107
+ this.targetRot.slerpQuaternions(thisRot, targetRot, eased);
108
+ this.targetScale.lerpVectors(thisScale, targetScale, eased);
109
+
110
+ setWorldPosition(this.object, this.targetPos);
111
+ setWorldQuaternion(this.object, this.targetRot);
112
+ setWorldScale(this.object, this.targetScale);
113
+
114
+ yield;
115
+ }
116
+
117
+ this.coroutine = null;
118
+ }
119
+
120
+ private *moveRelative() {
121
+
122
+ if (!this.target || !this.object) return;
123
+
124
+ const thisPos = this.object.position.clone();
125
+ const thisRot = this.object.quaternion.clone();
126
+ const thisScale = this.object.scale.clone();
127
+
128
+ const posOffset = this.target.position.clone();
129
+ const rotOffset = this.target.quaternion.clone();
130
+ const scaleOffset = this.target.scale.clone();
131
+
132
+ // convert into right space
133
+ posOffset.applyQuaternion(this.object.quaternion);
134
+
135
+ this.targetPos.copy(this.object.position).add(posOffset);
136
+ this.targetRot.copy(this.object.quaternion).multiply(rotOffset);
137
+ this.targetScale.copy(this.object.scale).multiply(scaleOffset);
138
+
139
+ let t01 = 0;
140
+ let eased = 0;
141
+ while (t01 < 1) {
142
+
143
+ t01 += this.context.time.deltaTime / this.duration;
144
+ if (t01 > 1) t01 = 1;
145
+
146
+ // apply ease-in-out
147
+ // https://easings.net/
148
+ eased = t01 < 0.5 ? 4 * t01 * t01 * t01 : 1 - Math.pow(-2 * t01 + 2, 3) / 2;
149
+
150
+ this.object.position.lerpVectors(thisPos, this.targetPos, eased);
151
+ this.object.quaternion.slerpQuaternions(thisRot, this.targetRot, eased);
152
+ this.object.scale.lerpVectors(thisScale, this.targetScale, eased);
153
+
154
+ yield;
155
+ }
156
+
157
+ this.coroutine = null;
158
+ }
159
+
160
+ beforeCreateDocument(ext) {
161
+ if (this.target && this.object && this.gameObject) {
162
+ const moveForward = new BehaviorModel("Move to " + this.target?.name,
163
+ TriggerBuilder.tapTrigger(this.gameObject),
164
+ ActionBuilder.transformAction(this.object, this.target, this.duration, this.relativeMotion ? "relative" : "absolute"),
165
+ );
166
+ ext.addBehavior(moveForward);
167
+ }
168
+ }
169
+ }
170
+
171
+ /**
172
+ * @category Everywhere Actions
173
+ * @group Components
174
+ */
175
+ export class ChangeMaterialOnClick extends Behaviour implements IPointerClickHandler, UsdzBehaviour {
176
+
177
+ /**
178
+ * The material that will be switched to the variant material
179
+ */
180
+ @serializable(Material)
181
+ materialToSwitch?: Material;
182
+
183
+ /**
184
+ * The material that will be switched to
185
+ */
186
+ @serializable(Material)
187
+ variantMaterial?: Material;
188
+
189
+ /**
190
+ * The duration of the fade effect in seconds (USDZ/Quicklook only)
191
+ * @default 0
192
+ */
193
+ @serializable()
194
+ fadeDuration: number = 0;
195
+
196
+ start(): void {
197
+ // initialize the object list
198
+ this._objectsWithThisMaterial = this.objectsWithThisMaterial;
199
+ ensureRaycaster(this.gameObject);
200
+ if (isDevEnvironment() && this._objectsWithThisMaterial.length <= 0) {
201
+ console.warn("ChangeMaterialOnClick: No objects found with material \"" + this.materialToSwitch?.name + "\"");
202
+ }
203
+ }
204
+
205
+ onPointerEnter(_args: PointerEventData) {
206
+ this.context.input.setCursor("pointer");
207
+ }
208
+ onPointerExit(_: PointerEventData) {
209
+ this.context.input.unsetCursor("pointer");
210
+ }
211
+ onPointerClick(args: PointerEventData) {
212
+ args.use();
213
+ if (!this.variantMaterial) return;
214
+ for (let i = 0; i < this.objectsWithThisMaterial.length; i++) {
215
+ const obj = this.objectsWithThisMaterial[i];
216
+ obj.material = this.variantMaterial;
217
+ }
218
+ }
219
+
220
+ private _objectsWithThisMaterial: Mesh[] | null = null;
221
+ /** Get all objects in the scene that have the assigned materialToSwitch */
222
+ private get objectsWithThisMaterial(): Mesh[] {
223
+ if (this._objectsWithThisMaterial != null) return this._objectsWithThisMaterial;
224
+ this._objectsWithThisMaterial = [];
225
+ if (this.variantMaterial && this.materialToSwitch) {
226
+ this.context.scene.traverse(obj => {
227
+ if (obj instanceof Mesh) {
228
+ if (Array.isArray(obj.material)) {
229
+ for (const mat of obj.material) {
230
+ if (mat === this.materialToSwitch) {
231
+ this.objectsWithThisMaterial.push(obj);
232
+ break;
233
+ }
234
+ }
235
+ }
236
+ else {
237
+ if (obj.material === this.materialToSwitch) {
238
+ this.objectsWithThisMaterial.push(obj);
239
+ }
240
+ else if (compareAssociation(obj.material, this.materialToSwitch)) {
241
+ this.objectsWithThisMaterial.push(obj);
242
+ }
243
+ }
244
+ }
245
+ });
246
+ }
247
+ return this._objectsWithThisMaterial;
248
+ }
249
+
250
+ private selfModel!: USDObject;
251
+ private targetModels!: USDObject[];
252
+
253
+ private static _materialTriggersPerId: { [key: string]: ChangeMaterialOnClick[] } = {}
254
+ private static _startHiddenBehaviour: BehaviorModel | null = null;
255
+ private static _parallelStartHiddenActions: USDObject[] = [];
256
+
257
+ async beforeCreateDocument(_ext: BehaviorExtension, _context) {
258
+ this.targetModels = [];
259
+ ChangeMaterialOnClick._materialTriggersPerId = {}
260
+ ChangeMaterialOnClick.variantSwitchIndex = 0;
261
+
262
+ // Ensure that the progressive textures have been loaded for all variants and materials
263
+ if (this.materialToSwitch) {
264
+ await NEEDLE_progressive.assignTextureLOD(this.materialToSwitch, 0);
265
+ }
266
+ if (this.variantMaterial) {
267
+ await NEEDLE_progressive.assignTextureLOD(this.variantMaterial, 0);
268
+ }
269
+ }
270
+
271
+
272
+ createBehaviours(_ext: BehaviorExtension, model: USDObject, _context) {
273
+
274
+ const shouldExport = this.objectsWithThisMaterial.find(o => o.uuid === model.uuid);
275
+ if (shouldExport) {
276
+ this.targetModels.push(model);
277
+ }
278
+ if (this.gameObject.uuid === model.uuid) {
279
+ this.selfModel = model;
280
+ if (this.materialToSwitch) {
281
+ if (!ChangeMaterialOnClick._materialTriggersPerId[this.materialToSwitch.uuid])
282
+ ChangeMaterialOnClick._materialTriggersPerId[this.materialToSwitch.uuid] = [];
283
+ ChangeMaterialOnClick._materialTriggersPerId[this.materialToSwitch.uuid].push(this);
284
+ }
285
+ }
286
+ }
287
+
288
+ afterCreateDocument(ext: BehaviorExtension, _context) {
289
+
290
+ if (!this.materialToSwitch) return;
291
+ const handlers = ChangeMaterialOnClick._materialTriggersPerId[this.materialToSwitch.uuid];
292
+ if (handlers) {
293
+ const variants: { [key: string]: Array<USDObject> } = {}
294
+ for (const handler of handlers) {
295
+ const createdVariants = handler.createVariants();
296
+ if (createdVariants && createdVariants.length > 0)
297
+ variants[handler.selfModel.uuid] = createdVariants;
298
+ }
299
+ for (const handler of handlers) {
300
+ const otherVariants: Array<USDObject> = [];
301
+ for (const key in variants) {
302
+ if (key !== handler.selfModel.uuid) {
303
+ otherVariants.push(...variants[key]);
304
+ }
305
+ }
306
+ handler.createAndAttachBehaviors(ext, variants[handler.selfModel.uuid], otherVariants);
307
+ }
308
+ }
309
+ delete ChangeMaterialOnClick._materialTriggersPerId[this.materialToSwitch.uuid];
310
+ }
311
+
312
+ private createAndAttachBehaviors(ext: BehaviorExtension, myVariants: Array<USDObject>, otherVariants: Array<USDObject>) {
313
+ const select: ActionModel[] = [];
314
+
315
+ const fadeDuration = Math.max(0, this.fadeDuration);
316
+
317
+ select.push(ActionBuilder.fadeAction([...this.targetModels, ...otherVariants], fadeDuration, false));
318
+ select.push(ActionBuilder.fadeAction(myVariants, fadeDuration, true));
319
+
320
+ ext.addBehavior(new BehaviorModel("Select_" + this.selfModel.name,
321
+ TriggerBuilder.tapTrigger(this.selfModel),
322
+ ActionBuilder.parallel(...select))
323
+ );
324
+ ChangeMaterialOnClick._parallelStartHiddenActions.push(...myVariants);
325
+ if (!ChangeMaterialOnClick._startHiddenBehaviour) {
326
+ ChangeMaterialOnClick._startHiddenBehaviour =
327
+ new BehaviorModel("StartHidden_" + this.selfModel.name,
328
+ TriggerBuilder.sceneStartTrigger(),
329
+ ActionBuilder.fadeAction(ChangeMaterialOnClick._parallelStartHiddenActions, fadeDuration, false));
330
+ ext.addBehavior(ChangeMaterialOnClick._startHiddenBehaviour);
331
+ }
332
+ }
333
+
334
+ private static getMaterialName(material: Material) {
335
+ return makeNameSafeForUSD(material.name || 'Material') + "_" + material.id;
336
+ }
337
+
338
+ static variantSwitchIndex: number = 0;
339
+ private createVariants() {
340
+ if (!this.variantMaterial) return null;
341
+
342
+ const variantModels: USDObject[] = [];
343
+ for (const target of this.targetModels) {
344
+ const variant = target.clone();
345
+ variant.name += "_Variant_" + ChangeMaterialOnClick.variantSwitchIndex++ + "_" + ChangeMaterialOnClick.getMaterialName(this.variantMaterial);
346
+ variant.displayName = variant.displayName + ": Variant with material " + this.variantMaterial.name;
347
+ variant.material = this.variantMaterial;
348
+ variant.geometry = target.geometry;
349
+ variant.transform = target.transform;
350
+
351
+ if (!target.parent || !target.parent.isEmpty()) {
352
+ USDObject.createEmptyParent(target);
353
+ }
354
+ if (target.parent) target.parent.add(variant);
355
+ variantModels.push(variant);
356
+ }
357
+ return variantModels;
358
+ }
359
+ }
360
+
361
+ /**
362
+ * @category Everywhere Actions
363
+ * @group Components
364
+ */
365
+ export class SetActiveOnClick extends Behaviour implements IPointerClickHandler, UsdzBehaviour {
366
+
367
+ @serializable(Object3D)
368
+ target?: Object3D;
369
+
370
+ @serializable()
371
+ toggleOnClick: boolean = false;
372
+
373
+ @serializable()
374
+ targetState: boolean = true;
375
+
376
+ @serializable()
377
+ hideSelf: boolean = true;
378
+
379
+ start(): void {
380
+ ensureRaycaster(this.gameObject);
381
+ }
382
+
383
+ onPointerClick(args: PointerEventData) {
384
+ args.use();
385
+
386
+ if (!this.toggleOnClick && this.hideSelf)
387
+ this.gameObject.visible = false;
388
+
389
+ if (this.target)
390
+ this.target.visible = this.toggleOnClick ? !this.target.visible : this.targetState;
391
+ }
392
+
393
+ private selfModel!: USDObject;
394
+ private selfModelClone!: USDObject;
395
+ private targetModel?: USDObject;
396
+ private toggleModel?: USDObject;
397
+
398
+ createBehaviours(_, model: USDObject, _context: USDZExporterContext) {
399
+ if (model.uuid === this.gameObject.uuid) {
400
+ this.selfModel = model;
401
+ this.selfModelClone = model.clone();
402
+ }
403
+ }
404
+
405
+ private stateBeforeCreatingDocument: boolean = false;
406
+ private targetStateBeforeCreatingDocument: boolean = false;
407
+ private static clonedToggleIndex = 0;
408
+ private static wasVisible = Symbol("usdz_SetActiveOnClick_wasVisible");
409
+ private static toggleClone = Symbol("clone for toggling");
410
+ private static reverseToggleClone = Symbol("clone for reverse toggling");
411
+
412
+ beforeCreateDocument() {
413
+ if (!this.target) return;
414
+
415
+ // need to cache on the object itself, because otherwise different actions would override each other's visibility state
416
+ // TODO would probably be better to have this somewhere on the exporter, not on this component
417
+ if (this.gameObject[SetActiveOnClick.wasVisible] === undefined)
418
+ this.gameObject[SetActiveOnClick.wasVisible] = this.gameObject.activeSelf;
419
+ if (this.target[SetActiveOnClick.wasVisible] === undefined)
420
+ this.target[SetActiveOnClick.wasVisible] = (this.target as GameObject).activeSelf;
421
+
422
+ this.stateBeforeCreatingDocument = this.gameObject[SetActiveOnClick.wasVisible];
423
+ this.targetStateBeforeCreatingDocument = this.target[SetActiveOnClick.wasVisible];
424
+
425
+ // Objects need to be on so they are exported, as we're skipping invisible objects
426
+ this.gameObject.visible = true;
427
+ this.target.visible = true;
428
+ }
429
+
430
+ afterCreateDocument(ext: BehaviorExtension, context: USDZExporterContext) {
431
+ if (!this.target) return;
432
+
433
+ // Parameters:
434
+ // - hideSelf: the trigger is hidden after clicking. Can basically only be used once.
435
+ // - toggleOnClick: the target is toggled on/off when the trigger is clicked.
436
+ // - targetState: the target is set to this state when the trigger is clicked.
437
+
438
+ // Combinations:
439
+ // - when toggleOnClick is on, hideSelf is ignored
440
+ // - we need to make a copy of our object
441
+ // - when the trigger is clicked
442
+ // - hide the original trigger
443
+ // - show the copied trigger
444
+ // - set the target to targetState
445
+ // - when the copied trigger is clicked
446
+ // - hide the copied trigger
447
+ // - show the original trigger again
448
+ // - set the target to !targetState
449
+ // - when toggleOnClick is off, hideSelf is used
450
+ // - no copy is needed
451
+ // - when the trigger is clicked
452
+ // - hide the trigger
453
+ // - set the target to the targetState
454
+
455
+ this.targetModel = context.document.findById(this.target.uuid);
456
+ const originalModel = this.selfModel;
457
+
458
+ if (this.selfModel && this.targetModel) {
459
+ let selfModel = this.selfModel;
460
+ let targetState = this.targetState;
461
+
462
+ // if we toggle, we need to create a copy of our object
463
+ if (this.toggleOnClick) {
464
+ // When toggling we want to respect the current state of the target,
465
+ // so effectively this.targetState and this.hideSelf are ignored.
466
+ targetState = !this.targetStateBeforeCreatingDocument;
467
+
468
+
469
+ // Potentially it's easier/better to just "clone" and put the object as a sibling next
470
+ // to the rest of the hierarchy. This way we would lose nested clicks (clicking on a child would not trigger events)
471
+ // but we're not potentially duplicating tons of objects.
472
+ // It's much easier to reason about nested actions when we're not duplicating tons of hierarchy...
473
+ // We can probably only do a shallow clone when the tapped object has geometry of its own, otherwise
474
+ // we end up with nothing to tap on.
475
+
476
+ // Option A: we deep clone ourselves. This makes hierarchical cases and nested behaviours really complex.
477
+ // We do this currently when the object doesn't have any geometry.
478
+ if (!this.selfModelClone.geometry) {
479
+ if (!this.selfModel.parent || this.selfModel.parent.isEmpty())
480
+ USDDocument.createEmptyParent(this.selfModel);
481
+ this.toggleModel = this.selfModel.deepClone();
482
+ this.toggleModel.name += "_toggle";
483
+ this.selfModel.parent!.add(this.toggleModel);
484
+ }
485
+ else {
486
+ // Option B: we shallow clone ourselves and put the clone next to us. This means childs are not clickable anymore.
487
+ // We create clones exactly once for this gameObject, so that all SetActiveOnClick on the same object use the same trigger.
488
+ if (!this.gameObject[SetActiveOnClick.toggleClone]) {
489
+ const clone = this.selfModelClone.clone();
490
+ clone.setMatrix(new Matrix4());
491
+ clone.name += "_toggle" + (SetActiveOnClick.clonedToggleIndex++);
492
+ originalModel.add(clone);
493
+ this.gameObject[SetActiveOnClick.toggleClone] = clone;
494
+
495
+ console.warn("USDZExport: Toggle " + this.gameObject.name + " doesn't have geometry. It will be deep cloned and nested behaviours will likely not work.");
496
+ }
497
+ const clonedSelfModel = this.gameObject[SetActiveOnClick.toggleClone];
498
+
499
+ if (!this.gameObject[SetActiveOnClick.reverseToggleClone]) {
500
+ const clone = this.selfModelClone.clone();
501
+ clone.setMatrix(new Matrix4());
502
+ clone.name += "_toggleReverse" + (SetActiveOnClick.clonedToggleIndex++);
503
+ originalModel.add(clone);
504
+ this.gameObject[SetActiveOnClick.reverseToggleClone] = clone;
505
+ }
506
+ this.toggleModel = this.gameObject[SetActiveOnClick.reverseToggleClone];
507
+
508
+ if (!this.toggleModel!.geometry || !clonedSelfModel.geometry) {
509
+ console.error("triggers without childs and without geometry won't work!", this, originalModel.geometry)
510
+ }
511
+
512
+ // We're targeting the clone in the actions below, not the original object
513
+ selfModel = clonedSelfModel;
514
+
515
+ // Remove the geometry, we've duplicated it into the toggle/reverseToggle already
516
+ originalModel.geometry = null;
517
+ originalModel.material = null;
518
+
519
+ // Known issues: clone() does not clone skinned mesh geometry, lights, cameras;
520
+ // we still have them on the original object and the clones won't have it.
521
+ }
522
+ }
523
+
524
+ // this.toggleOnClick is false, so we don't have a toggleModel – no need for clones,
525
+ // just set the target object to targetState and optionally hide ourselves
526
+ if (!this.toggleModel) {
527
+ const sequence: ActionModel[] = [];
528
+ if (this.hideSelf)
529
+ sequence.push(ActionBuilder.fadeAction(selfModel, 0, false));
530
+ sequence.push(ActionBuilder.fadeAction(this.targetModel, 0, targetState));
531
+
532
+ ext.addBehavior(new BehaviorModel("Toggle_" + selfModel.name + "_ToggleTo" + (targetState ? "On" : "Off"),
533
+ TriggerBuilder.tapTrigger(selfModel),
534
+ sequence.length > 1 ? ActionBuilder.parallel(...sequence) : sequence[0],
535
+ ));
536
+ }
537
+ // We have a toggleModel, so we need to set up two sequences:
538
+ // - one that hides the original object, shows the toggle and sets the target to targetState
539
+ // - one that hides the toggle, shows the original object and sets the target to !targetState
540
+ else if (this.toggleOnClick) {
541
+ const toggleSequence: ActionModel[] = [];
542
+ toggleSequence.push(ActionBuilder.fadeAction(selfModel, 0, false));
543
+ toggleSequence.push(ActionBuilder.fadeAction(this.toggleModel, 0, true));
544
+ toggleSequence.push(ActionBuilder.fadeAction(this.targetModel, 0, targetState));
545
+
546
+ ext.addBehavior(new BehaviorModel("Toggle_" + selfModel.name + "_ToggleTo" + (targetState ? "On" : "Off"),
547
+ TriggerBuilder.tapTrigger(selfModel),
548
+ ActionBuilder.parallel(...toggleSequence)
549
+ ));
550
+
551
+ const reverseSequence: ActionModel[] = [];
552
+ reverseSequence.push(ActionBuilder.fadeAction(this.toggleModel, 0, false));
553
+ reverseSequence.push(ActionBuilder.fadeAction(selfModel, 0, true));
554
+ reverseSequence.push(ActionBuilder.fadeAction(this.targetModel, 0, !targetState));
555
+
556
+ ext.addBehavior(new BehaviorModel("Toggle_" + selfModel.name + "_ToggleTo" + (!targetState ? "On" : "Off"),
557
+ TriggerBuilder.tapTrigger(this.toggleModel),
558
+ ActionBuilder.parallel(...reverseSequence)
559
+ ));
560
+ }
561
+
562
+ // Ensure initial states are set correctly so that we get the same result as was currently active in the runtime
563
+ const objectsToHide = new Array<USDObject>();
564
+ if (!this.targetStateBeforeCreatingDocument)
565
+ objectsToHide.push(this.targetModel);
566
+ if (!this.stateBeforeCreatingDocument)
567
+ objectsToHide.push(originalModel);
568
+ if (this.toggleModel)
569
+ objectsToHide.push(this.toggleModel);
570
+
571
+ HideOnStart.add(objectsToHide, ext);
572
+ }
573
+ }
574
+
575
+ afterSerialize(_ext: BehaviorExtension, _context: USDZExporterContext): void {
576
+ // cleanup visibility cache
577
+ if (this.gameObject[SetActiveOnClick.wasVisible] !== undefined) {
578
+ this.gameObject.visible = this.gameObject[SetActiveOnClick.wasVisible];
579
+ delete this.gameObject[SetActiveOnClick.wasVisible];
580
+ }
581
+ if (this.target && this.target[SetActiveOnClick.wasVisible] !== undefined) {
582
+ this.target.visible = this.target[SetActiveOnClick.wasVisible];
583
+ delete this.target[SetActiveOnClick.wasVisible];
584
+ }
585
+
586
+ // cleanup trigger clones
587
+ delete this.gameObject[SetActiveOnClick.toggleClone];
588
+ delete this.gameObject[SetActiveOnClick.reverseToggleClone];
589
+ }
590
+ }
591
+
592
+ /**
593
+ * @category Everywhere Actions
594
+ * @group Components
595
+ */
596
+ export class HideOnStart extends Behaviour implements UsdzBehaviour {
597
+
598
+ private static _fadeBehaviour?: BehaviorModel;
599
+ private static _fadeObjects: Array<USDObject | Object3D> = [];
600
+
601
+ static add(target: Target, ext: BehaviorExtension) {
602
+ const arr = Array.isArray(target) ? target : [target];
603
+ for (const entry of arr) {
604
+ if (!HideOnStart._fadeObjects.includes(entry)) {
605
+ console.log("adding hide on start", entry);
606
+ HideOnStart._fadeObjects.push(entry);
607
+ }
608
+ }
609
+ if (HideOnStart._fadeBehaviour === undefined) {
610
+ HideOnStart._fadeBehaviour = new BehaviorModel("HideOnStart",
611
+ TriggerBuilder.sceneStartTrigger(),
612
+ //@ts-ignore
613
+ ActionBuilder.fadeAction(HideOnStart._fadeObjects, 0, false)
614
+ );
615
+ ext.addBehavior(HideOnStart._fadeBehaviour);
616
+ }
617
+ }
618
+
619
+ start() {
620
+ GameObject.setActive(this.gameObject, false);
621
+ }
622
+
623
+ createBehaviours(ext, model, _context) {
624
+ if (model.uuid === this.gameObject.uuid) {
625
+ // we only want to mark the object as HideOnStart if it's still hidden
626
+ if (!this.wasVisible) {
627
+ HideOnStart.add(model, ext);
628
+ }
629
+ }
630
+ }
631
+
632
+ private wasVisible: boolean = false;
633
+
634
+ beforeCreateDocument() {
635
+ this.wasVisible = GameObject.isActiveSelf(this.gameObject);
636
+ }
637
+ }
638
+
639
+ /**
640
+ * @category Everywhere Actions
641
+ * @group Components
642
+ */
643
+ export class EmphasizeOnClick extends Behaviour implements UsdzBehaviour {
644
+
645
+ @serializable()
646
+ target?: Object3D;
647
+
648
+ @serializable()
649
+ duration: number = 0.5;
650
+
651
+ @serializable()
652
+ motionType: EmphasizeActionMotionType = "bounce";
653
+
654
+ beforeCreateDocument() { }
655
+
656
+ createBehaviours(ext, model, _context) {
657
+ if (!this.target) return;
658
+
659
+ if (model.uuid === this.gameObject.uuid) {
660
+ const emphasize = new BehaviorModel("emphasize " + this.name,
661
+ TriggerBuilder.tapTrigger(this.gameObject),
662
+ ActionBuilder.emphasize(this.target, this.duration, this.motionType, undefined, "basic"),
663
+ );
664
+ ext.addBehavior(emphasize);
665
+ }
666
+ }
667
+
668
+ afterCreateDocument(_ext, _context) { }
669
+ }
670
+
671
+ /**
672
+ * @category Everywhere Actions
673
+ * @group Components
674
+ */
675
+ export class PlayAudioOnClick extends Behaviour implements IPointerClickHandler, UsdzBehaviour {
676
+
677
+ @serializable(AudioSource)
678
+ target?: AudioSource;
679
+
680
+ @serializable(URL)
681
+ clip: string = "";
682
+
683
+ @serializable()
684
+ toggleOnClick: boolean = false;
685
+
686
+ // Not exposed, but used for implicit playback of PlayOnAwake audio sources
687
+ trigger: "tap" | "start" = "tap";
688
+
689
+ start(): void {
690
+ ensureRaycaster(this.gameObject);
691
+ }
692
+
693
+ ensureAudioSource() {
694
+ if (!this.target) {
695
+ const newAudioSource = this.gameObject.addComponent(AudioSource);
696
+ if (newAudioSource) {
697
+ this.target = newAudioSource;
698
+ newAudioSource.spatialBlend = 1;
699
+ newAudioSource.volume = 1;
700
+ newAudioSource.loop = false;
701
+ newAudioSource.preload = true;
702
+ }
703
+ }
704
+ }
705
+
706
+ onPointerClick(args: PointerEventData) {
707
+ args.use();
708
+
709
+ if (!this.target?.clip && !this.clip) return;
710
+
711
+ this.ensureAudioSource();
712
+
713
+ if (this.target) {
714
+
715
+ if (this.target.isPlaying && this.toggleOnClick) {
716
+ this.target.stop();
717
+ }
718
+ else {
719
+ if (!this.toggleOnClick && this.target.isPlaying) {
720
+ this.target.stop();
721
+ }
722
+ if (this.clip) this.target.play(this.clip);
723
+ else this.target.play();
724
+ }
725
+ }
726
+ }
727
+
728
+ createBehaviours(ext: BehaviorExtension, model: USDObject, _context: USDZExporterContext) {
729
+ if (!this.target && !this.clip) return;
730
+ if (model.uuid === this.gameObject.uuid) {
731
+
732
+ const clipUrl = this.clip ? this.clip : this.target ? this.target.clip : undefined;
733
+ if (!clipUrl) return;
734
+ if (typeof clipUrl !== "string") return;
735
+
736
+ const playbackTarget = this.target ? this.target.gameObject : this.gameObject;
737
+ const clipName = AudioExtension.getName(clipUrl);
738
+ const volume = this.target ? this.target.volume : 1;
739
+ const auralMode = this.target && this.target.spatialBlend == 0 ? "nonSpatial" : "spatial";
740
+
741
+ // This checks if any child is clickable – if yes, the tap trigger is added; if not, we omit it.
742
+ let anyChildHasGeometry = false;
743
+ this.gameObject.traverse(c => {
744
+ if (c instanceof Mesh && c.visible) anyChildHasGeometry = true;
745
+ });
746
+ // Workaround: seems iOS often simply doesn't play audio on scene start when this is NOT present.
747
+ // unclear why, but having a useless tap action (nothing to tap on) "fixes" it.
748
+ anyChildHasGeometry = true;
749
+
750
+ const audioClip = ext.addAudioClip(clipUrl);
751
+ // const stopAction: IBehaviorElement = ActionBuilder.playAudioAction(playbackTarget, audioClip, "stop", volume, auralMode);
752
+ let playAction: IBehaviorElement = ActionBuilder.playAudioAction(playbackTarget, audioClip, "play", volume, auralMode);
753
+ if (this.target && this.target.loop)
754
+ playAction = ActionBuilder.sequence(playAction).makeLooping();
755
+
756
+ const behaviorName = (this.name ? "_" + this.name : "");
757
+
758
+ if (anyChildHasGeometry && this.trigger === "tap")
759
+ {
760
+ // does not seem to work in iOS / QuickLook...
761
+ // TODO use play "type" which can be start/stop/pause
762
+ if (this.toggleOnClick) (playAction as ActionModel).multiplePerformOperation = "stop";
763
+ const playClipOnTap = new BehaviorModel("playAudio" + behaviorName,
764
+ TriggerBuilder.tapTrigger(model),
765
+ playAction,
766
+ );
767
+ ext.addBehavior(playClipOnTap);
768
+ }
769
+
770
+ // automatically play audio on start too if the referenced AudioSource has playOnAwake enabled
771
+ if (this.target && this.target.playOnAwake && this.target.enabled) {
772
+ if (anyChildHasGeometry && this.trigger === "tap") {
773
+ // WORKAROUND Currently (20240509) we MUST not emit this behaviour if we're also expecting the tap trigger to work.
774
+ // Seems to be a regression in QuickLook... audio clips can't be stopped anymore as soon as they start playing.
775
+ console.warn("USDZExport: Audio sources that are played on tap can't also auto-play at scene start due to a QuickLook bug.");
776
+ }
777
+ else {
778
+ const playClipOnStart = new BehaviorModel("playAudioOnStart" + behaviorName,
779
+ TriggerBuilder.sceneStartTrigger(),
780
+ playAction,
781
+ );
782
+ ext.addBehavior(playClipOnStart);
783
+ }
784
+ }
785
+ }
786
+ }
787
+ }
788
+
789
+ /**
790
+ * @category Everywhere Actions
791
+ * @group Components
792
+ */
793
+ export class PlayAnimationOnClick extends Behaviour implements IPointerClickHandler, UsdzBehaviour, UsdzAnimation {
794
+
795
+ @serializable(Animator)
796
+ animator?: Animator;
797
+
798
+ @serializable()
799
+ stateName?: string;
800
+
801
+ // Not editable from the outside yet, but from code
802
+ // we want to expose this once we have a nice drawer for "Triggers" (e.g. shows proximity distance)
803
+ // and once we rename the component to "PlayAnimation" or "PlayAnimationOnTrigger"
804
+ trigger: "tap" | "start" = "tap"; // "proximity"
805
+ animation?: Animation;
806
+
807
+ private get target() { return this.animator?.gameObject || this.animation?.gameObject }
808
+
809
+ start(): void {
810
+ ensureRaycaster(this.gameObject);
811
+ }
812
+
813
+ onPointerClick(args: PointerEventData) {
814
+ args.use();
815
+ if (!this.target) return;
816
+ if (this.stateName) {
817
+ // TODO this is currently quite annoying to use,
818
+ // as for the web we use the Animator component and its states directly,
819
+ // while in QuickLook we use explicit animations / states.
820
+ this.animator?.play(this.stateName, 0, 0, .1);
821
+ }
822
+ }
823
+
824
+ private selfModel: any;
825
+
826
+ private stateAnimationModel: any;
827
+
828
+ private animationSequence? = new Array<RegisteredAnimationInfo>();
829
+ private animationLoopAfterSequence? = new Array<RegisteredAnimationInfo>();
830
+ private randomOffsetNormalized: number = 0;
831
+
832
+ createBehaviours(_ext: BehaviorExtension, model: USDObject, _context: USDZExporterContext) {
833
+
834
+ if (model.uuid === this.gameObject.uuid)
835
+ this.selfModel = model;
836
+ }
837
+
838
+ private static animationActions: ActionModel[] = [];
839
+ private static rootsWithExclusivePlayback: Set<Object3D> = new Set();
840
+
841
+ // Cleanup. TODO This is not the best way as it's called multiple times (once for each component).
842
+ afterSerialize() {
843
+ if (PlayAnimationOnClick.rootsWithExclusivePlayback.size > 1) {
844
+ const message = "Multiple root objects targeted by more than one animation. To work around QuickLook bug FB13410767, animations will be set as \"exclusive\" and activating them will stop other animations being marked as exclusive.";
845
+ if (isDevEnvironment()) showBalloonWarning(message);
846
+ console.warn(message, ...PlayAnimationOnClick.rootsWithExclusivePlayback);
847
+ }
848
+ PlayAnimationOnClick.animationActions = [];
849
+ PlayAnimationOnClick.rootsWithExclusivePlayback = new Set();
850
+ }
851
+
852
+ afterCreateDocument(ext: BehaviorExtension, context: USDZExporterContext) {
853
+ if ((this.animationSequence === undefined && this.animationLoopAfterSequence === undefined) || !this.stateAnimationModel) return;
854
+ if (!this.target) return;
855
+
856
+ const document = context.document;
857
+
858
+ // check if the AnimationExtension has been attached and what data it has for the current object
859
+ const animationExt = context.extensions.find(ext => ext instanceof AnimationExtension) as AnimationExtension;
860
+ if (!animationExt) return;
861
+
862
+ // This is a workaround for FB13410767 - StartAnimationAction in USDZ preliminary behaviours does not stop when another StartAnimationAction is called on the same prim
863
+ // When we play multiple animations on the same root, QuickLook just overlaps them and glitches around instead of stopping an earlier one.
864
+ // Once this is fixed, we can relax this check and just always make it non-exclusive again.
865
+ // Setting exclusive playback has the side effect of unfortunately canceling all other playing actions that are exclusive too -
866
+ // seems there is no finer-grained control over which actions should stop which other actions...
867
+ const requiresExclusivePlayback = animationExt.getClipCount(this.target) > 1;
868
+ if (requiresExclusivePlayback) {
869
+ if (isDevEnvironment())
870
+ console.warn("Setting exclusive playback for " + this.target.name + "@" + this.stateName + " because it has " + animationExt.getClipCount(this.target) + " animations. This works around QuickLook bug FB13410767.");
871
+
872
+ PlayAnimationOnClick.rootsWithExclusivePlayback.add(this.target);
873
+ }
874
+
875
+ const behaviorName = (this.name ? this.name : "");
876
+
877
+ document.traverse(model => {
878
+ if (model.uuid === this.target?.uuid) {
879
+ const sequence = PlayAnimationOnClick.getActionForSequences(
880
+ document,
881
+ model,
882
+ this.animationSequence,
883
+ this.animationLoopAfterSequence,
884
+ this.randomOffsetNormalized,
885
+ );
886
+
887
+ const playAnimationOnTap = new BehaviorModel(this.trigger + "_" + behaviorName + "_toPlayAnimation_" + this.stateName + "_on_" + this.target?.name,
888
+ this.trigger == "tap" ? TriggerBuilder.tapTrigger(this.selfModel) : TriggerBuilder.sceneStartTrigger(),
889
+ sequence
890
+ );
891
+
892
+ // See comment above for why exclusive playback is currently required when playing multiple animations on the same root.
893
+ if (requiresExclusivePlayback)
894
+ playAnimationOnTap.makeExclusive(true);
895
+ ext.addBehavior(playAnimationOnTap);
896
+ }
897
+ });
898
+ }
899
+
900
+ static getActionForSequences(_document: USDDocument, model: Target, animationSequence?: Array<RegisteredAnimationInfo>, animationLoopAfterSequence?: Array<RegisteredAnimationInfo>, randomOffsetNormalized?: number) {
901
+
902
+ const getOrCacheAction = (model: Target, anim: RegisteredAnimationInfo) => {
903
+ let action = PlayAnimationOnClick.animationActions.find(a => a.affectedObjects == model && a.start == anim.start && a.duration == anim.duration && a.animationSpeed == anim.speed);
904
+ if (!action) {
905
+ action = ActionBuilder.startAnimationAction(model, anim) as ActionModel;
906
+ PlayAnimationOnClick.animationActions.push(action);
907
+ }
908
+ return action;
909
+ }
910
+
911
+ const sequence = ActionBuilder.sequence();
912
+
913
+ if (animationSequence && animationSequence.length > 0)
914
+ {
915
+ for (const anim of animationSequence) {
916
+ sequence.addAction(getOrCacheAction(model, anim));
917
+ }
918
+ }
919
+
920
+ if (animationLoopAfterSequence && animationLoopAfterSequence.length > 0) {
921
+ // only make a new action group if there's already stuff in the existing one
922
+ const loopSequence = sequence.actions.length == 0 ? sequence : ActionBuilder.sequence();
923
+ for (const anim of animationLoopAfterSequence) {
924
+ loopSequence.addAction(getOrCacheAction(model, anim));
925
+ }
926
+ loopSequence.makeLooping();
927
+ if (sequence !== loopSequence)
928
+ sequence.addAction(loopSequence);
929
+ }
930
+
931
+ if (randomOffsetNormalized && randomOffsetNormalized > 0) {
932
+ sequence.actions.unshift(ActionBuilder.waitAction(randomOffsetNormalized));
933
+ }
934
+
935
+ return sequence;
936
+ }
937
+
938
+ static getAndRegisterAnimationSequences(ext: AnimationExtension, target: GameObject, stateName?: string):
939
+ {
940
+ animationSequence: Array<RegisteredAnimationInfo>,
941
+ animationLoopAfterSequence: Array<RegisteredAnimationInfo>,
942
+ randomTimeOffset: number,
943
+ } | undefined {
944
+
945
+ if (!target) return undefined;
946
+
947
+ const animator = target.getComponent(Animator);
948
+ const animation = target.getComponent(Animation);
949
+
950
+ if (!animator && !animation) return undefined;
951
+
952
+ if (animator && !stateName) {
953
+ throw new Error("PlayAnimationOnClick: No stateName specified for animator " + animator.name + " on " + target.name);
954
+ }
955
+
956
+ let animationSequence: Array<RegisteredAnimationInfo> = [];
957
+ let animationLoopAfterSequence: Array<RegisteredAnimationInfo> = [];
958
+
959
+ if (animation) {
960
+ const anim = ext.registerAnimation(target, animation.clip);
961
+ if (anim) {
962
+ if (animation.loop)
963
+ animationLoopAfterSequence.push(anim);
964
+ else
965
+ animationSequence.push(anim);
966
+ }
967
+
968
+ let randomTimeOffset = 0;
969
+ if (animation.minMaxOffsetNormalized) {
970
+ const from = animation.minMaxOffsetNormalized.x;
971
+ const to = animation.minMaxOffsetNormalized.y;
972
+ randomTimeOffset = (animation.clip?.duration || 1) * (from + Math.random() * (to - from));
973
+ }
974
+
975
+ return {
976
+ animationSequence,
977
+ animationLoopAfterSequence,
978
+ randomTimeOffset,
979
+ }
980
+ }
981
+
982
+ // If there's a separate state specified to play after this one, we
983
+ // play it automatically. Theoretically an animator state machine flow could be encoded here.
984
+
985
+ // We're parsing the Animator states here and follow the transition chain until we find a loop.
986
+ // There are some edge cases:
987
+ // - (0 > 1.looping) should keep looping (1).
988
+ // - (0 > 1 > 1) should keep looping (1).
989
+ // - (0 > 1 > 2 > 3 > 2) should keep looping (2,3).
990
+ // - (0 > 1 > 2 > 3 > 0) should keep looping (0,1,2,3).
991
+ const runtimeController = animator?.runtimeAnimatorController;
992
+ let currentState = runtimeController?.findState(stateName);
993
+ let statesUntilLoop: State[] = [];
994
+ let statesLooping: State[] = [];
995
+
996
+ if (runtimeController && currentState) {
997
+ // starting point – we have set this above already as startAction
998
+ const visitedStates = new Array<State>;
999
+ visitedStates.push(currentState);
1000
+ let foundLoop = false;
1001
+
1002
+ while (true && visitedStates.length < 100) {
1003
+ if (!currentState || currentState === null || !currentState.transitions || currentState.transitions.length === 0) {
1004
+ if (currentState.motion?.isLooping)
1005
+ foundLoop = true;
1006
+ break;
1007
+ }
1008
+
1009
+ // find the first transition without parameters
1010
+ // TODO we could also find the first _valid_ transition here instead based on the current parameters.
1011
+ const transition = currentState.transitions.find(t => t.conditions.length === 0);
1012
+ const nextState: State | null = transition ? runtimeController["getState"](transition.destinationState, 0) : null;
1013
+ // abort: we found a state loop
1014
+ if (nextState && visitedStates.includes(nextState)) {
1015
+ currentState = nextState;
1016
+ foundLoop = true;
1017
+ break;
1018
+ }
1019
+ // keep looking: transition to another state
1020
+ else if (transition) {
1021
+ currentState = nextState;
1022
+ if (!currentState)
1023
+ break;
1024
+ visitedStates.push(currentState);
1025
+ }
1026
+ // abort: no transition found. check if last state is looping
1027
+ else {
1028
+ foundLoop = currentState.motion?.isLooping ?? false;
1029
+ break;
1030
+ }
1031
+ }
1032
+
1033
+ if (foundLoop && currentState) {
1034
+ // check what the first state in the loop is – it must be matching the last one we added
1035
+ const firstStateInLoop = visitedStates.indexOf(currentState);
1036
+ statesUntilLoop = visitedStates.slice(0, firstStateInLoop); // can be empty, which means we're looping all
1037
+ statesLooping = visitedStates.slice(firstStateInLoop); // can be empty, which means nothing is looping
1038
+
1039
+ // Potentially we need to prevent self-transitions into a non-looping state, these do not result in a loop in the runtime
1040
+ /*
1041
+ if (statesLooping.length === 1 && !statesLooping[0].motion?.isLooping) {
1042
+ statesUntilLoop.push(statesLooping[0]);
1043
+ statesLooping = [];
1044
+ }
1045
+ */
1046
+ if (debug) console.log("found loop from " + stateName, "states until loop", statesUntilLoop, "states looping", statesLooping);
1047
+ }
1048
+ else {
1049
+ statesUntilLoop = visitedStates;
1050
+ statesLooping = [];
1051
+ if (debug) console.log("found no loop from " + stateName, "states", statesUntilLoop);
1052
+ }
1053
+ // If we do NOT loop, we need to explicitly add a single-keyframe clip with a "hold" pose
1054
+ // to prevent the animation from resetting to the start.
1055
+ if (!statesLooping.length) {
1056
+ const lastState = statesUntilLoop[statesUntilLoop.length - 1];
1057
+ const lastClip = lastState.motion?.clip;
1058
+ if (lastClip) {
1059
+ let clipCopy: AnimationClip | undefined;
1060
+ if (ext.holdClipMap.has(lastClip)) {
1061
+ clipCopy = ext.holdClipMap.get(lastClip);
1062
+ }
1063
+ else {
1064
+ // We're creating a "hold" clip here; exactly 1 second long, and inteprolates exactly on the duration of the clip
1065
+ const holdStateName = lastState.name + "_hold";
1066
+ clipCopy = lastClip.clone();
1067
+ clipCopy.duration = 1;
1068
+ clipCopy.name = holdStateName;
1069
+ const lastFrame = lastClip.duration;
1070
+ clipCopy.tracks = lastClip.tracks.map(t => {
1071
+ const trackCopy = t.clone();
1072
+ trackCopy.times = new Float32Array([0, lastFrame]);
1073
+ const len = t.values.length;
1074
+ const size = t.getValueSize();;
1075
+ const lastValue = t.values.slice(len - size, len);
1076
+ // we need this twice
1077
+ trackCopy.values = new Float32Array(2 * size);
1078
+ trackCopy.values.set(lastValue, 0);
1079
+ trackCopy.values.set(lastValue, size);
1080
+ return trackCopy;
1081
+ });
1082
+ clipCopy.name = holdStateName;
1083
+ ext.holdClipMap.set(lastClip, clipCopy);
1084
+ }
1085
+
1086
+ if (clipCopy) {
1087
+ const holdState = {
1088
+ name: clipCopy.name,
1089
+ motion: { clip: clipCopy, isLooping: false, name: clipCopy.name },
1090
+ speed: 1,
1091
+ transitions: [],
1092
+ behaviours: [],
1093
+ hash: lastState.hash + 1,
1094
+ }
1095
+ statesLooping.push(holdState);
1096
+ }
1097
+ }
1098
+ }
1099
+ }
1100
+
1101
+ // Special case: someone's trying to play an empty clip without any motion data, no loops or anything.
1102
+ // In that case, we simply go to the rest clip – this is a common case for "idle" states.
1103
+ if (statesUntilLoop.length === 1 && (!statesUntilLoop[0].motion?.clip || statesUntilLoop[0].motion?.clip.tracks?.length === 0)) {
1104
+ animationSequence = new Array<RegisteredAnimationInfo>();
1105
+ const anim = ext.registerAnimation(target, null);
1106
+ if (anim) animationSequence.push(anim);
1107
+ return undefined;
1108
+ }
1109
+
1110
+ // filter out any states that don't have motion data
1111
+ statesUntilLoop = statesUntilLoop.filter(s => s.motion?.clip && s.motion?.clip.tracks?.length > 0);
1112
+ statesLooping = statesLooping.filter(s => s.motion?.clip && s.motion?.clip.tracks?.length > 0);
1113
+
1114
+ // If none of the found states have motion, we need to warn
1115
+ if (statesUntilLoop.length === 0 && statesLooping.length === 0) {
1116
+ console.warn("No clips found for state " + stateName + " on " + animator?.name + ", can't export animation data");
1117
+ return undefined;
1118
+ }
1119
+
1120
+ const addStateToSequence = (state: State, sequence: Array<RegisteredAnimationInfo>) => {
1121
+ if (!target) return;
1122
+ const anim = ext.registerAnimation(target, state.motion.clip ?? null);
1123
+ if (anim) {
1124
+ anim.speed = state.speed;
1125
+ sequence.push(anim);
1126
+ }
1127
+ else console.warn("Couldn't register animation for state " + state.name + " on " + animator?.name);
1128
+ };
1129
+
1130
+ // Register all the animation states we found.
1131
+ if (statesUntilLoop.length > 0) {
1132
+ animationSequence = new Array<RegisteredAnimationInfo>();
1133
+ for (const state of statesUntilLoop) {
1134
+ addStateToSequence(state, animationSequence);
1135
+ }
1136
+ }
1137
+ if (statesLooping.length > 0) {
1138
+ animationLoopAfterSequence = new Array<RegisteredAnimationInfo>();
1139
+ for (const state of statesLooping) {
1140
+ addStateToSequence(state, animationLoopAfterSequence);
1141
+ }
1142
+ }
1143
+
1144
+ let randomTimeOffset = 0;
1145
+ if (animator && runtimeController && animator.minMaxOffsetNormalized) {
1146
+ const from = animator.minMaxOffsetNormalized.x;
1147
+ const to = animator.minMaxOffsetNormalized.y;
1148
+ // first state in the sequence
1149
+ const firstState = statesUntilLoop.length ? statesUntilLoop[0] : statesLooping.length ? statesLooping[0] : null;
1150
+ randomTimeOffset = (firstState?.motion.clip?.duration || 1) * (from + Math.random() * (to - from));
1151
+ }
1152
+ return {
1153
+ animationSequence,
1154
+ animationLoopAfterSequence,
1155
+ randomTimeOffset,
1156
+ }
1157
+ }
1158
+
1159
+ createAnimation(ext: AnimationExtension, model: USDObject, _context: USDZExporterContext) {
1160
+
1161
+ if (!this.target || (!this.animator && !this.animation)) return;
1162
+
1163
+ const result = PlayAnimationOnClick.getAndRegisterAnimationSequences(ext, this.target, this.stateName);
1164
+ if (!result) return;
1165
+
1166
+ this.animationSequence = result.animationSequence;
1167
+ this.animationLoopAfterSequence = result.animationLoopAfterSequence;
1168
+ this.randomOffsetNormalized = result.randomTimeOffset;
1169
+
1170
+ this.stateAnimationModel = model;
1171
+ }
1172
+
1173
+ }
1174
+
1175
+ export class PreliminaryAction extends Behaviour {
1176
+ getType(): string | void { }
1177
+ @serializable(Object3D)
1178
+ target?: Object3D;
1179
+
1180
+
1181
+ getDuration(): number | void { };
1182
+ }
1183
+
1184
+ export class PreliminaryTrigger extends Behaviour {
1185
+
1186
+ @serializable(PreliminaryAction)
1187
+ target?: PreliminaryAction;
1188
+ }
1189
+
1190
+ /**
1191
+ * @category Everywhere Actions
1192
+ * @group Components
1193
+ */
1194
+ export class VisibilityAction extends PreliminaryAction {
1195
+
1196
+ //@type int
1197
+ @serializable()
1198
+ type: VisibilityActionType = VisibilityActionType.Hide;
1199
+
1200
+ @serializable()
1201
+ duration: number = 1;
1202
+
1203
+ getType() {
1204
+ switch (this.type) {
1205
+ case VisibilityActionType.Hide: return "hide";
1206
+ case VisibilityActionType.Show: return "show";
1207
+ }
1208
+ }
1209
+
1210
+ getDuration() {
1211
+ return this.duration;
1212
+ }
1213
+ }
1214
+
1215
+ /**
1216
+ * @category Everywhere Actions
1217
+ * @group Components
1218
+ */
1219
+ export class TapGestureTrigger extends PreliminaryTrigger {
1220
+
1221
+ }
1222
+
1223
+ export enum VisibilityActionType {
1224
+ Show = 0,
1225
+ Hide = 1,
1226
1226
  }