@needle-tools/engine 4.7.0-alpha → 4.7.0-next.22483b4

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 (1067) hide show
  1. package/CHANGELOG.md +3768 -3768
  2. package/LICENSE.md +10 -10
  3. package/README.md +64 -64
  4. package/components.needle.json +1 -1
  5. package/dist/generateMeshBVH.worker-BaNp_Xtp.js +25 -0
  6. package/dist/{gltf-progressive-Bm9eEfgu.min.js → gltf-progressive-Bl4okF1b.min.js} +1 -1
  7. package/dist/{gltf-progressive-GjIqwSG3.js → gltf-progressive-DSpdn0QT.js} +2 -2
  8. package/dist/{gltf-progressive-Dn6o99rH.umd.cjs → gltf-progressive-P8b8a0qY.umd.cjs} +1 -1
  9. package/dist/{needle-engine.bundle-BEUFTdl6.min.js → needle-engine.bundle-BnGp0ASs.min.js} +75 -74
  10. package/dist/{needle-engine.bundle-CK8cQ3FX.umd.cjs → needle-engine.bundle-CP5AJL1A.umd.cjs} +66 -65
  11. package/dist/{needle-engine.bundle-CXtflnL6.js → needle-engine.bundle-RgZNbAgp.js} +1185 -1176
  12. package/dist/needle-engine.d.ts +130 -129
  13. package/dist/needle-engine.js +4 -4
  14. package/dist/needle-engine.min.js +1 -1
  15. package/dist/needle-engine.umd.cjs +1 -1
  16. package/dist/{postprocessing-8AQTeZsr.umd.cjs → postprocessing-CjW23fio.umd.cjs} +2 -2
  17. package/dist/{postprocessing-BkxN_08g.js → postprocessing-DYLNOL3W.js} +3 -3
  18. package/dist/{postprocessing-BDScN9yu.min.js → postprocessing-xYQWCHFu.min.js} +2 -2
  19. package/dist/{three-DMrv-4ar.umd.cjs → three-B_hneGZr.umd.cjs} +4 -4
  20. package/dist/{three-Bz6X1mrw.js → three-DrqIzZTH.js} +4198 -4198
  21. package/dist/{three-Boa-jOq-.min.js → three-DuDKwKB8.min.js} +33 -33
  22. package/dist/{three-examples-GggCDHv0.js → three-examples-B50TT3Iu.js} +5 -5
  23. package/dist/{three-examples-DuVhxqft.min.js → three-examples-DaDLBuy6.min.js} +14 -14
  24. package/dist/{three-examples-C7ryg8vN.umd.cjs → three-examples-X3OadjXB.umd.cjs} +3 -3
  25. package/dist/{three-mesh-ui-CY6Izc7C.min.js → three-mesh-ui-B3p3gyUz.min.js} +1 -1
  26. package/dist/{three-mesh-ui-CwlN0FUC.umd.cjs → three-mesh-ui-CQiIQIlA.umd.cjs} +1 -1
  27. package/dist/{three-mesh-ui-CLNOfsWn.js → three-mesh-ui-CxuWt7m-.js} +1 -1
  28. package/dist/{vendor-zxXa3Dmr.min.js → vendor-BlSxe9JJ.min.js} +3 -3
  29. package/dist/{vendor-BSD1RQIh.js → vendor-BmYIgaS1.js} +3 -3
  30. package/dist/{vendor-DHr4aqIZ.umd.cjs → vendor-Cavtu3CP.umd.cjs} +3 -3
  31. package/lib/asap/needle-asap.d.ts +1 -1
  32. package/lib/asap/needle-asap.js +95 -95
  33. package/lib/asap/sessiongranted.d.ts +3 -3
  34. package/lib/asap/sessiongranted.js +65 -65
  35. package/lib/asap/utils.d.ts +1 -1
  36. package/lib/asap/utils.js +3 -3
  37. package/lib/engine/analytics/index.d.ts +6 -6
  38. package/lib/engine/analytics/index.js +12 -12
  39. package/lib/engine/analytics/lcp.d.ts +3 -3
  40. package/lib/engine/analytics/lcp.js +34 -34
  41. package/lib/engine/api.d.ts +82 -82
  42. package/lib/engine/api.js +81 -81
  43. package/lib/engine/assets/index.d.ts +11 -11
  44. package/lib/engine/assets/index.js +47 -47
  45. package/lib/engine/assets/static.d.ts +1 -1
  46. package/lib/engine/assets/static.js +4 -4
  47. package/lib/engine/codegen/register_types.d.ts +1 -1
  48. package/lib/engine/codegen/register_types.js +300 -300
  49. package/lib/engine/debug/debug.d.ts +15 -15
  50. package/lib/engine/debug/debug.js +44 -44
  51. package/lib/engine/debug/debug_console.d.ts +2 -2
  52. package/lib/engine/debug/debug_console.js +307 -307
  53. package/lib/engine/debug/debug_overlay.d.ts +22 -22
  54. package/lib/engine/debug/debug_overlay.js +316 -316
  55. package/lib/engine/debug/debug_spatial_console.d.ts +2 -2
  56. package/lib/engine/debug/debug_spatial_console.js +390 -390
  57. package/lib/engine/debug/index.d.ts +2 -2
  58. package/lib/engine/debug/index.js +2 -2
  59. package/lib/engine/engine_addressables.d.ts +166 -166
  60. package/lib/engine/engine_addressables.js +608 -608
  61. package/lib/engine/engine_animation.d.ts +43 -43
  62. package/lib/engine/engine_animation.js +133 -133
  63. package/lib/engine/engine_application.d.ts +45 -45
  64. package/lib/engine/engine_application.js +104 -104
  65. package/lib/engine/engine_assetdatabase.d.ts +25 -25
  66. package/lib/engine/engine_assetdatabase.js +346 -346
  67. package/lib/engine/engine_audio.d.ts +4 -4
  68. package/lib/engine/engine_audio.js +23 -23
  69. package/lib/engine/engine_camera.d.ts +13 -13
  70. package/lib/engine/engine_camera.js +30 -30
  71. package/lib/engine/engine_components.d.ts +110 -110
  72. package/lib/engine/engine_components.js +374 -374
  73. package/lib/engine/engine_components_internal.d.ts +9 -9
  74. package/lib/engine/engine_components_internal.js +36 -36
  75. package/lib/engine/engine_constants.d.ts +10 -10
  76. package/lib/engine/engine_constants.js +41 -41
  77. package/lib/engine/engine_context.d.ts +475 -475
  78. package/lib/engine/engine_context.js +1673 -1672
  79. package/lib/engine/engine_context.js.map +1 -1
  80. package/lib/engine/engine_context_registry.d.ts +71 -71
  81. package/lib/engine/engine_context_registry.js +117 -117
  82. package/lib/engine/engine_coroutine.d.ts +35 -35
  83. package/lib/engine/engine_coroutine.js +52 -52
  84. package/lib/engine/engine_create_objects.d.ts +119 -119
  85. package/lib/engine/engine_create_objects.js +320 -320
  86. package/lib/engine/engine_default_parameters.d.ts +2 -2
  87. package/lib/engine/engine_default_parameters.js +3 -3
  88. package/lib/engine/engine_editor-sync.d.ts +21 -21
  89. package/lib/engine/engine_editor-sync.js +4 -4
  90. package/lib/engine/engine_fileloader.d.ts +2 -2
  91. package/lib/engine/engine_fileloader.js +8 -8
  92. package/lib/engine/engine_gameobject.d.ts +68 -68
  93. package/lib/engine/engine_gameobject.js +619 -619
  94. package/lib/engine/engine_generic_utils.d.ts +1 -1
  95. package/lib/engine/engine_generic_utils.js +13 -13
  96. package/lib/engine/engine_gizmos.d.ts +149 -149
  97. package/lib/engine/engine_gizmos.js +530 -530
  98. package/lib/engine/engine_gltf.d.ts +12 -12
  99. package/lib/engine/engine_gltf.js +15 -15
  100. package/lib/engine/engine_gltf_builtin_components.d.ts +11 -11
  101. package/lib/engine/engine_gltf_builtin_components.js +341 -341
  102. package/lib/engine/engine_hot_reload.d.ts +8 -8
  103. package/lib/engine/engine_hot_reload.js +197 -197
  104. package/lib/engine/engine_input.d.ts +362 -362
  105. package/lib/engine/engine_input.js +1294 -1294
  106. package/lib/engine/engine_input_utils.d.ts +2 -2
  107. package/lib/engine/engine_input_utils.js +22 -22
  108. package/lib/engine/engine_instancing.d.ts +19 -19
  109. package/lib/engine/engine_instancing.js +39 -39
  110. package/lib/engine/engine_license.d.ts +11 -11
  111. package/lib/engine/engine_license.js +369 -369
  112. package/lib/engine/engine_lifecycle_api.d.ts +83 -83
  113. package/lib/engine/engine_lifecycle_api.js +106 -106
  114. package/lib/engine/engine_lifecycle_functions_internal.d.ts +32 -32
  115. package/lib/engine/engine_lifecycle_functions_internal.js +146 -146
  116. package/lib/engine/engine_lightdata.d.ts +23 -23
  117. package/lib/engine/engine_lightdata.js +91 -91
  118. package/lib/engine/engine_loaders.callbacks.d.ts +97 -97
  119. package/lib/engine/engine_loaders.callbacks.js +86 -86
  120. package/lib/engine/engine_loaders.d.ts +48 -48
  121. package/lib/engine/engine_loaders.gltf.d.ts +13 -13
  122. package/lib/engine/engine_loaders.gltf.js +62 -62
  123. package/lib/engine/engine_loaders.js +337 -337
  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 +260 -260
  133. package/lib/engine/engine_networking.js +764 -764
  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 +228 -228
  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 +1433 -1433
  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_serialization.d.ts +3 -3
  167. package/lib/engine/engine_serialization.js +3 -3
  168. package/lib/engine/engine_serialization_builtin_serializer.d.ts +72 -72
  169. package/lib/engine/engine_serialization_builtin_serializer.js +403 -403
  170. package/lib/engine/engine_serialization_core.d.ts +94 -94
  171. package/lib/engine/engine_serialization_core.js +607 -607
  172. package/lib/engine/engine_serialization_decorator.d.ts +23 -23
  173. package/lib/engine/engine_serialization_decorator.js +66 -66
  174. package/lib/engine/engine_setup.d.ts +1 -1
  175. package/lib/engine/engine_setup.js +2 -2
  176. package/lib/engine/engine_shaders.d.ts +53 -53
  177. package/lib/engine/engine_shaders.js +252 -252
  178. package/lib/engine/engine_shims.d.ts +4 -4
  179. package/lib/engine/engine_shims.js +24 -24
  180. package/lib/engine/engine_test_utils.d.ts +39 -39
  181. package/lib/engine/engine_test_utils.js +83 -83
  182. package/lib/engine/engine_texture.d.ts +28 -28
  183. package/lib/engine/engine_texture.js +64 -64
  184. package/lib/engine/engine_three_utils.d.ts +204 -204
  185. package/lib/engine/engine_three_utils.js +784 -784
  186. package/lib/engine/engine_time.d.ts +51 -51
  187. package/lib/engine/engine_time.js +82 -82
  188. package/lib/engine/engine_time_utils.d.ts +88 -88
  189. package/lib/engine/engine_time_utils.js +215 -215
  190. package/lib/engine/engine_tonemapping.d.ts +6 -6
  191. package/lib/engine/engine_tonemapping.js +197 -197
  192. package/lib/engine/engine_types.d.ts +578 -578
  193. package/lib/engine/engine_types.js +95 -95
  194. package/lib/engine/engine_typestore.d.ts +28 -28
  195. package/lib/engine/engine_typestore.js +55 -55
  196. package/lib/engine/engine_util_decorator.d.ts +13 -13
  197. package/lib/engine/engine_util_decorator.js +116 -116
  198. package/lib/engine/engine_utils.d.ts +248 -248
  199. package/lib/engine/engine_utils.js +1012 -1012
  200. package/lib/engine/engine_utils_format.d.ts +24 -24
  201. package/lib/engine/engine_utils_format.js +239 -239
  202. package/lib/engine/engine_utils_screenshot.d.ts +159 -159
  203. package/lib/engine/engine_utils_screenshot.js +522 -522
  204. package/lib/engine/engine_utils_screenshot.xr.d.ts +5 -5
  205. package/lib/engine/engine_utils_screenshot.xr.js +90 -90
  206. package/lib/engine/engine_xr.d.ts +1 -1
  207. package/lib/engine/engine_xr.js +1 -1
  208. package/lib/engine/export/gltf/Writers.d.ts +19 -19
  209. package/lib/engine/export/gltf/Writers.js +24 -24
  210. package/lib/engine/export/gltf/index.d.ts +11 -11
  211. package/lib/engine/export/gltf/index.js +123 -123
  212. package/lib/engine/export/index.d.ts +2 -2
  213. package/lib/engine/export/index.js +2 -2
  214. package/lib/engine/export/state.d.ts +7 -7
  215. package/lib/engine/export/state.js +17 -17
  216. package/lib/engine/export/utils.d.ts +2 -2
  217. package/lib/engine/export/utils.js +7 -7
  218. package/lib/engine/extensions/EXT_texture_exr.d.ts +8 -8
  219. package/lib/engine/extensions/EXT_texture_exr.js +32 -32
  220. package/lib/engine/extensions/NEEDLE_animator_controller_model.d.ts +122 -122
  221. package/lib/engine/extensions/NEEDLE_animator_controller_model.js +95 -95
  222. package/lib/engine/extensions/NEEDLE_components.d.ts +35 -35
  223. package/lib/engine/extensions/NEEDLE_components.js +220 -220
  224. package/lib/engine/extensions/NEEDLE_gameobject_data.d.ts +10 -10
  225. package/lib/engine/extensions/NEEDLE_gameobject_data.js +57 -57
  226. package/lib/engine/extensions/NEEDLE_lighting_settings.d.ts +37 -37
  227. package/lib/engine/extensions/NEEDLE_lighting_settings.js +157 -157
  228. package/lib/engine/extensions/NEEDLE_lightmaps.d.ts +18 -18
  229. package/lib/engine/extensions/NEEDLE_lightmaps.js +99 -99
  230. package/lib/engine/extensions/NEEDLE_persistent_assets.d.ts +11 -11
  231. package/lib/engine/extensions/NEEDLE_persistent_assets.js +63 -63
  232. package/lib/engine/extensions/NEEDLE_progressive.d.ts +1 -1
  233. package/lib/engine/extensions/NEEDLE_progressive.js +1 -1
  234. package/lib/engine/extensions/NEEDLE_render_objects.d.ts +13 -13
  235. package/lib/engine/extensions/NEEDLE_render_objects.js +159 -159
  236. package/lib/engine/extensions/NEEDLE_techniques_webgl.d.ts +38 -38
  237. package/lib/engine/extensions/NEEDLE_techniques_webgl.js +564 -564
  238. package/lib/engine/extensions/extension_resolver.d.ts +4 -4
  239. package/lib/engine/extensions/extension_resolver.js +1 -1
  240. package/lib/engine/extensions/extension_utils.d.ts +12 -12
  241. package/lib/engine/extensions/extension_utils.js +152 -152
  242. package/lib/engine/extensions/extensions.d.ts +32 -32
  243. package/lib/engine/extensions/extensions.js +107 -107
  244. package/lib/engine/extensions/index.d.ts +6 -6
  245. package/lib/engine/extensions/index.js +6 -6
  246. package/lib/engine/extensions/usage_tracker.d.ts +13 -13
  247. package/lib/engine/extensions/usage_tracker.js +65 -65
  248. package/lib/engine/js-extensions/Camera.d.ts +1 -1
  249. package/lib/engine/js-extensions/Camera.js +39 -39
  250. package/lib/engine/js-extensions/ExtensionUtils.d.ts +9 -9
  251. package/lib/engine/js-extensions/ExtensionUtils.js +67 -67
  252. package/lib/engine/js-extensions/Layers.d.ts +6 -6
  253. package/lib/engine/js-extensions/Layers.js +22 -22
  254. package/lib/engine/js-extensions/Object3D.d.ts +120 -120
  255. package/lib/engine/js-extensions/Object3D.js +136 -136
  256. package/lib/engine/js-extensions/RGBAColor.d.ts +23 -23
  257. package/lib/engine/js-extensions/RGBAColor.js +111 -111
  258. package/lib/engine/js-extensions/Vector.d.ts +3 -3
  259. package/lib/engine/js-extensions/Vector.js +13 -13
  260. package/lib/engine/js-extensions/index.d.ts +5 -5
  261. package/lib/engine/js-extensions/index.js +5 -5
  262. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.d.ts +4 -4
  263. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +79 -79
  264. package/lib/engine/shaders/shaderData.d.ts +55 -55
  265. package/lib/engine/shaders/shaderData.js +58 -58
  266. package/lib/engine/tests/test_utils.d.ts +2 -2
  267. package/lib/engine/tests/test_utils.js +53 -53
  268. package/lib/engine/webcomponents/WebXRButtons.d.ts +56 -56
  269. package/lib/engine/webcomponents/WebXRButtons.js +230 -230
  270. package/lib/engine/webcomponents/api.d.ts +5 -5
  271. package/lib/engine/webcomponents/api.js +4 -4
  272. package/lib/engine/webcomponents/buttons.d.ts +51 -51
  273. package/lib/engine/webcomponents/buttons.js +264 -264
  274. package/lib/engine/webcomponents/fonts.d.ts +9 -9
  275. package/lib/engine/webcomponents/fonts.js +32 -32
  276. package/lib/engine/webcomponents/icons.d.ts +9 -9
  277. package/lib/engine/webcomponents/icons.js +52 -52
  278. package/lib/engine/webcomponents/index.d.ts +1 -1
  279. package/lib/engine/webcomponents/index.js +1 -1
  280. package/lib/engine/webcomponents/logo-element.d.ts +10 -10
  281. package/lib/engine/webcomponents/logo-element.js +67 -67
  282. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.d.ts +37 -37
  283. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.js +513 -513
  284. package/lib/engine/webcomponents/needle menu/needle-menu.d.ts +155 -155
  285. package/lib/engine/webcomponents/needle menu/needle-menu.js +1029 -1029
  286. package/lib/engine/webcomponents/needle-button.d.ts +34 -34
  287. package/lib/engine/webcomponents/needle-button.js +161 -161
  288. package/lib/engine/webcomponents/needle-engine.ar-overlay.d.ts +21 -21
  289. package/lib/engine/webcomponents/needle-engine.ar-overlay.js +166 -166
  290. package/lib/engine/webcomponents/needle-engine.attributes.d.ts +69 -69
  291. package/lib/engine/webcomponents/needle-engine.attributes.js +1 -1
  292. package/lib/engine/webcomponents/needle-engine.d.ts +116 -116
  293. package/lib/engine/webcomponents/needle-engine.extras.d.ts +6 -6
  294. package/lib/engine/webcomponents/needle-engine.extras.js +13 -13
  295. package/lib/engine/webcomponents/needle-engine.js +821 -821
  296. package/lib/engine/webcomponents/needle-engine.loading.d.ts +44 -44
  297. package/lib/engine/webcomponents/needle-engine.loading.js +341 -341
  298. package/lib/engine/xr/NeedleXRController.d.ts +313 -313
  299. package/lib/engine/xr/NeedleXRController.js +1007 -1007
  300. package/lib/engine/xr/NeedleXRSession.d.ts +340 -340
  301. package/lib/engine/xr/NeedleXRSession.js +1463 -1463
  302. package/lib/engine/xr/NeedleXRSync.d.ts +22 -22
  303. package/lib/engine/xr/NeedleXRSync.js +188 -188
  304. package/lib/engine/xr/SceneTransition.d.ts +18 -18
  305. package/lib/engine/xr/SceneTransition.js +69 -69
  306. package/lib/engine/xr/TempXRContext.d.ts +34 -34
  307. package/lib/engine/xr/TempXRContext.js +187 -187
  308. package/lib/engine/xr/XRRig.d.ts +7 -7
  309. package/lib/engine/xr/XRRig.js +1 -1
  310. package/lib/engine/xr/api.d.ts +6 -6
  311. package/lib/engine/xr/api.js +6 -6
  312. package/lib/engine/xr/events.d.ts +66 -66
  313. package/lib/engine/xr/events.js +93 -93
  314. package/lib/engine/xr/internal.d.ts +12 -12
  315. package/lib/engine/xr/internal.js +25 -25
  316. package/lib/engine/xr/usdz.d.ts +12 -12
  317. package/lib/engine/xr/usdz.js +29 -29
  318. package/lib/engine/xr/utils.d.ts +11 -11
  319. package/lib/engine/xr/utils.js +34 -34
  320. package/lib/engine-components/AlignmentConstraint.d.ts +10 -10
  321. package/lib/engine-components/AlignmentConstraint.js +39 -39
  322. package/lib/engine-components/Animation.d.ts +156 -156
  323. package/lib/engine-components/Animation.js +508 -508
  324. package/lib/engine-components/AnimationCurve.d.ts +40 -40
  325. package/lib/engine-components/AnimationCurve.js +159 -159
  326. package/lib/engine-components/AnimationUtils.d.ts +8 -8
  327. package/lib/engine-components/AnimationUtils.js +27 -27
  328. package/lib/engine-components/AnimationUtilsAutoplay.d.ts +1 -1
  329. package/lib/engine-components/AnimationUtilsAutoplay.js +39 -39
  330. package/lib/engine-components/Animator.d.ts +217 -217
  331. package/lib/engine-components/Animator.js +354 -354
  332. package/lib/engine-components/AnimatorController.d.ts +227 -227
  333. package/lib/engine-components/AnimatorController.js +1152 -1152
  334. package/lib/engine-components/AudioListener.d.ts +33 -33
  335. package/lib/engine-components/AudioListener.js +86 -86
  336. package/lib/engine-components/AudioSource.d.ts +217 -217
  337. package/lib/engine-components/AudioSource.js +635 -635
  338. package/lib/engine-components/AvatarLoader.d.ts +80 -80
  339. package/lib/engine-components/AvatarLoader.js +231 -231
  340. package/lib/engine-components/AxesHelper.d.ts +32 -32
  341. package/lib/engine-components/AxesHelper.js +67 -67
  342. package/lib/engine-components/BasicIKConstraint.d.ts +9 -9
  343. package/lib/engine-components/BasicIKConstraint.js +43 -43
  344. package/lib/engine-components/BoxCollider.d.ts +2 -2
  345. package/lib/engine-components/BoxCollider.js +2 -2
  346. package/lib/engine-components/BoxHelperComponent.d.ts +47 -47
  347. package/lib/engine-components/BoxHelperComponent.js +102 -102
  348. package/lib/engine-components/Camera.d.ts +231 -231
  349. package/lib/engine-components/Camera.js +700 -700
  350. package/lib/engine-components/CameraUtils.d.ts +1 -1
  351. package/lib/engine-components/CameraUtils.js +121 -121
  352. package/lib/engine-components/CharacterController.d.ts +55 -55
  353. package/lib/engine-components/CharacterController.js +236 -236
  354. package/lib/engine-components/Collider.d.ts +188 -188
  355. package/lib/engine-components/Collider.js +369 -369
  356. package/lib/engine-components/Component.d.ts +792 -792
  357. package/lib/engine-components/Component.js +920 -920
  358. package/lib/engine-components/ContactShadows.d.ts +94 -94
  359. package/lib/engine-components/ContactShadows.js +453 -453
  360. package/lib/engine-components/DeleteBox.d.ts +19 -19
  361. package/lib/engine-components/DeleteBox.js +58 -58
  362. package/lib/engine-components/DeviceFlag.d.ts +16 -16
  363. package/lib/engine-components/DeviceFlag.js +47 -47
  364. package/lib/engine-components/DragControls.d.ts +170 -170
  365. package/lib/engine-components/DragControls.js +1421 -1421
  366. package/lib/engine-components/DropListener.d.ts +215 -215
  367. package/lib/engine-components/DropListener.js +642 -642
  368. package/lib/engine-components/Duplicatable.d.ts +35 -35
  369. package/lib/engine-components/Duplicatable.js +202 -202
  370. package/lib/engine-components/EventList.d.ts +54 -54
  371. package/lib/engine-components/EventList.js +232 -232
  372. package/lib/engine-components/EventTrigger.d.ts +33 -33
  373. package/lib/engine-components/EventTrigger.js +75 -75
  374. package/lib/engine-components/EventType.d.ts +22 -22
  375. package/lib/engine-components/EventType.js +23 -23
  376. package/lib/engine-components/Fog.d.ts +22 -22
  377. package/lib/engine-components/Fog.js +61 -61
  378. package/lib/engine-components/Gizmos.d.ts +17 -17
  379. package/lib/engine-components/Gizmos.js +64 -64
  380. package/lib/engine-components/GridHelper.d.ts +20 -20
  381. package/lib/engine-components/GridHelper.js +54 -54
  382. package/lib/engine-components/GroundProjection.d.ts +67 -67
  383. package/lib/engine-components/GroundProjection.js +343 -343
  384. package/lib/engine-components/Interactable.d.ts +12 -12
  385. package/lib/engine-components/Interactable.js +12 -12
  386. package/lib/engine-components/Joints.d.ts +19 -19
  387. package/lib/engine-components/Joints.js +51 -51
  388. package/lib/engine-components/LODGroup.d.ts +35 -35
  389. package/lib/engine-components/LODGroup.js +152 -152
  390. package/lib/engine-components/Light.d.ts +180 -180
  391. package/lib/engine-components/Light.js +535 -535
  392. package/lib/engine-components/LookAtConstraint.d.ts +19 -19
  393. package/lib/engine-components/LookAtConstraint.js +35 -35
  394. package/lib/engine-components/NeedleMenu.d.ts +50 -50
  395. package/lib/engine-components/NeedleMenu.js +92 -92
  396. package/lib/engine-components/NestedGltf.d.ts +25 -25
  397. package/lib/engine-components/NestedGltf.js +88 -88
  398. package/lib/engine-components/Networking.d.ts +54 -54
  399. package/lib/engine-components/Networking.js +112 -112
  400. package/lib/engine-components/OffsetConstraint.d.ts +14 -14
  401. package/lib/engine-components/OffsetConstraint.js +65 -65
  402. package/lib/engine-components/OrbitControls.d.ts +268 -268
  403. package/lib/engine-components/OrbitControls.js +1015 -1015
  404. package/lib/engine-components/PlayerColor.d.ts +19 -19
  405. package/lib/engine-components/PlayerColor.js +94 -94
  406. package/lib/engine-components/ReflectionProbe.d.ts +28 -28
  407. package/lib/engine-components/ReflectionProbe.js +204 -204
  408. package/lib/engine-components/Renderer.d.ts +153 -153
  409. package/lib/engine-components/Renderer.js +834 -834
  410. package/lib/engine-components/RendererInstancing.d.ts +140 -140
  411. package/lib/engine-components/RendererInstancing.js +744 -744
  412. package/lib/engine-components/RendererLightmap.d.ts +24 -24
  413. package/lib/engine-components/RendererLightmap.js +182 -182
  414. package/lib/engine-components/RigidBody.d.ts +155 -155
  415. package/lib/engine-components/RigidBody.js +517 -517
  416. package/lib/engine-components/SceneSwitcher.d.ts +263 -263
  417. package/lib/engine-components/SceneSwitcher.js +971 -971
  418. package/lib/engine-components/ScreenCapture.d.ts +144 -144
  419. package/lib/engine-components/ScreenCapture.js +547 -547
  420. package/lib/engine-components/ShadowCatcher.d.ts +33 -33
  421. package/lib/engine-components/ShadowCatcher.js +166 -166
  422. package/lib/engine-components/Skybox.d.ts +88 -88
  423. package/lib/engine-components/Skybox.js +469 -469
  424. package/lib/engine-components/SmoothFollow.d.ts +34 -34
  425. package/lib/engine-components/SmoothFollow.js +82 -82
  426. package/lib/engine-components/SpatialTrigger.d.ts +102 -102
  427. package/lib/engine-components/SpatialTrigger.js +225 -225
  428. package/lib/engine-components/SpectatorCamera.d.ts +111 -111
  429. package/lib/engine-components/SpectatorCamera.js +715 -715
  430. package/lib/engine-components/SphereCollider.d.ts +2 -2
  431. package/lib/engine-components/SphereCollider.js +2 -2
  432. package/lib/engine-components/SpriteRenderer.d.ts +132 -132
  433. package/lib/engine-components/SpriteRenderer.js +472 -472
  434. package/lib/engine-components/SyncedCamera.d.ts +41 -41
  435. package/lib/engine-components/SyncedCamera.js +199 -199
  436. package/lib/engine-components/SyncedRoom.d.ts +106 -106
  437. package/lib/engine-components/SyncedRoom.js +371 -371
  438. package/lib/engine-components/SyncedTransform.d.ts +94 -94
  439. package/lib/engine-components/SyncedTransform.js +331 -331
  440. package/lib/engine-components/TestRunner.d.ts +16 -16
  441. package/lib/engine-components/TestRunner.js +102 -102
  442. package/lib/engine-components/TransformGizmo.d.ts +75 -75
  443. package/lib/engine-components/TransformGizmo.js +209 -209
  444. package/lib/engine-components/VideoPlayer.d.ts +184 -184
  445. package/lib/engine-components/VideoPlayer.js +978 -978
  446. package/lib/engine-components/Voip.d.ts +67 -67
  447. package/lib/engine-components/Voip.js +360 -360
  448. package/lib/engine-components/api.d.ts +51 -51
  449. package/lib/engine-components/api.js +50 -50
  450. package/lib/engine-components/avatar/AvatarBlink_Simple.d.ts +11 -11
  451. package/lib/engine-components/avatar/AvatarBlink_Simple.js +76 -76
  452. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.d.ts +14 -14
  453. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.js +68 -68
  454. package/lib/engine-components/avatar/Avatar_Brain_LookAt.d.ts +29 -29
  455. package/lib/engine-components/avatar/Avatar_Brain_LookAt.js +121 -121
  456. package/lib/engine-components/avatar/Avatar_MouthShapes.d.ts +15 -15
  457. package/lib/engine-components/avatar/Avatar_MouthShapes.js +79 -79
  458. package/lib/engine-components/avatar/Avatar_MustacheShake.d.ts +9 -9
  459. package/lib/engine-components/avatar/Avatar_MustacheShake.js +29 -29
  460. package/lib/engine-components/codegen/components.d.ts +216 -216
  461. package/lib/engine-components/codegen/components.js +218 -218
  462. package/lib/engine-components/debug/LogStats.d.ts +5 -5
  463. package/lib/engine-components/debug/LogStats.js +18 -18
  464. package/lib/engine-components/export/gltf/GltfExport.d.ts +30 -30
  465. package/lib/engine-components/export/gltf/GltfExport.js +246 -246
  466. package/lib/engine-components/export/gltf/index.d.ts +1 -1
  467. package/lib/engine-components/export/gltf/index.js +1 -1
  468. package/lib/engine-components/export/index.d.ts +1 -1
  469. package/lib/engine-components/export/index.js +1 -1
  470. package/lib/engine-components/export/usdz/Extension.d.ts +22 -22
  471. package/lib/engine-components/export/usdz/Extension.js +1 -1
  472. package/lib/engine-components/export/usdz/ThreeUSDZExporter.d.ts +162 -162
  473. package/lib/engine-components/export/usdz/ThreeUSDZExporter.js +1789 -1789
  474. package/lib/engine-components/export/usdz/USDZExporter.d.ts +130 -130
  475. package/lib/engine-components/export/usdz/USDZExporter.js +663 -663
  476. package/lib/engine-components/export/usdz/extensions/Animation.d.ts +106 -106
  477. package/lib/engine-components/export/usdz/extensions/Animation.js +1071 -1071
  478. package/lib/engine-components/export/usdz/extensions/DocumentExtension.d.ts +5 -5
  479. package/lib/engine-components/export/usdz/extensions/DocumentExtension.js +6 -6
  480. package/lib/engine-components/export/usdz/extensions/NodeMaterialConverter.d.ts +10 -10
  481. package/lib/engine-components/export/usdz/extensions/NodeMaterialConverter.js +451 -451
  482. package/lib/engine-components/export/usdz/extensions/USDZText.d.ts +54 -54
  483. package/lib/engine-components/export/usdz/extensions/USDZText.js +203 -203
  484. package/lib/engine-components/export/usdz/extensions/USDZUI.d.ts +8 -8
  485. package/lib/engine-components/export/usdz/extensions/USDZUI.js +158 -158
  486. package/lib/engine-components/export/usdz/extensions/behavior/Actions.d.ts +30 -30
  487. package/lib/engine-components/export/usdz/extensions/behavior/Actions.js +88 -88
  488. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.d.ts +10 -10
  489. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.js +86 -86
  490. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.d.ts +28 -28
  491. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.js +290 -290
  492. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.d.ts +190 -190
  493. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.js +1060 -1060
  494. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.d.ts +135 -135
  495. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.js +548 -548
  496. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.d.ts +7 -7
  497. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.js +115 -115
  498. package/lib/engine-components/export/usdz/index.d.ts +3 -3
  499. package/lib/engine-components/export/usdz/index.js +2 -2
  500. package/lib/engine-components/export/usdz/utils/animationutils.d.ts +7 -7
  501. package/lib/engine-components/export/usdz/utils/animationutils.js +163 -163
  502. package/lib/engine-components/export/usdz/utils/quicklook.d.ts +2 -2
  503. package/lib/engine-components/export/usdz/utils/quicklook.js +43 -43
  504. package/lib/engine-components/particlesystem/ParticleSystem.d.ts +177 -177
  505. package/lib/engine-components/particlesystem/ParticleSystem.js +1176 -1176
  506. package/lib/engine-components/particlesystem/ParticleSystemModules.d.ts +526 -526
  507. package/lib/engine-components/particlesystem/ParticleSystemModules.js +1930 -1930
  508. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.d.ts +25 -25
  509. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.js +87 -87
  510. package/lib/engine-components/particlesystem/api.d.ts +2 -2
  511. package/lib/engine-components/particlesystem/api.js +2 -2
  512. package/lib/engine-components/postprocessing/Effects/Antialiasing.d.ts +17 -17
  513. package/lib/engine-components/postprocessing/Effects/Antialiasing.js +59 -52
  514. package/lib/engine-components/postprocessing/Effects/Antialiasing.js.map +1 -1
  515. package/lib/engine-components/postprocessing/Effects/BloomEffect.d.ts +46 -46
  516. package/lib/engine-components/postprocessing/Effects/BloomEffect.js +113 -113
  517. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.d.ts +11 -11
  518. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.js +39 -39
  519. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.d.ts +23 -23
  520. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.js +111 -111
  521. package/lib/engine-components/postprocessing/Effects/DepthOfField.d.ts +25 -25
  522. package/lib/engine-components/postprocessing/Effects/DepthOfField.js +104 -104
  523. package/lib/engine-components/postprocessing/Effects/EffectWrapper.d.ts +12 -12
  524. package/lib/engine-components/postprocessing/Effects/EffectWrapper.js +18 -18
  525. package/lib/engine-components/postprocessing/Effects/Pixelation.d.ts +11 -11
  526. package/lib/engine-components/postprocessing/Effects/Pixelation.js +32 -32
  527. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.d.ts +18 -18
  528. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.js +91 -91
  529. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.d.ts +70 -70
  530. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.js +176 -176
  531. package/lib/engine-components/postprocessing/Effects/Sharpening.d.ts +18 -18
  532. package/lib/engine-components/postprocessing/Effects/Sharpening.js +127 -127
  533. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.d.ts +17 -17
  534. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.js +70 -70
  535. package/lib/engine-components/postprocessing/Effects/Tonemapping.d.ts +19 -19
  536. package/lib/engine-components/postprocessing/Effects/Tonemapping.js +94 -94
  537. package/lib/engine-components/postprocessing/Effects/Tonemapping.utils.d.ts +13 -13
  538. package/lib/engine-components/postprocessing/Effects/Tonemapping.utils.js +51 -51
  539. package/lib/engine-components/postprocessing/Effects/Vignette.d.ts +15 -15
  540. package/lib/engine-components/postprocessing/Effects/Vignette.js +60 -60
  541. package/lib/engine-components/postprocessing/PostProcessingEffect.d.ts +90 -90
  542. package/lib/engine-components/postprocessing/PostProcessingEffect.js +168 -168
  543. package/lib/engine-components/postprocessing/PostProcessingHandler.d.ts +42 -42
  544. package/lib/engine-components/postprocessing/PostProcessingHandler.js +494 -480
  545. package/lib/engine-components/postprocessing/PostProcessingHandler.js.map +1 -1
  546. package/lib/engine-components/postprocessing/Volume.d.ts +90 -90
  547. package/lib/engine-components/postprocessing/Volume.js +385 -385
  548. package/lib/engine-components/postprocessing/VolumeParameter.d.ts +26 -26
  549. package/lib/engine-components/postprocessing/VolumeParameter.js +136 -136
  550. package/lib/engine-components/postprocessing/VolumeProfile.d.ts +15 -15
  551. package/lib/engine-components/postprocessing/VolumeProfile.js +60 -60
  552. package/lib/engine-components/postprocessing/index.d.ts +6 -6
  553. package/lib/engine-components/postprocessing/index.js +6 -6
  554. package/lib/engine-components/postprocessing/utils.d.ts +55 -55
  555. package/lib/engine-components/postprocessing/utils.js +119 -119
  556. package/lib/engine-components/timeline/PlayableDirector.d.ts +163 -163
  557. package/lib/engine-components/timeline/PlayableDirector.js +686 -686
  558. package/lib/engine-components/timeline/SignalAsset.d.ts +24 -24
  559. package/lib/engine-components/timeline/SignalAsset.js +130 -130
  560. package/lib/engine-components/timeline/TimelineModels.d.ts +89 -89
  561. package/lib/engine-components/timeline/TimelineModels.js +22 -22
  562. package/lib/engine-components/timeline/TimelineTracks.d.ts +110 -110
  563. package/lib/engine-components/timeline/TimelineTracks.js +879 -879
  564. package/lib/engine-components/timeline/index.d.ts +4 -4
  565. package/lib/engine-components/timeline/index.js +3 -3
  566. package/lib/engine-components/ui/BaseUIComponent.d.ts +48 -48
  567. package/lib/engine-components/ui/BaseUIComponent.js +170 -170
  568. package/lib/engine-components/ui/Button.d.ts +64 -64
  569. package/lib/engine-components/ui/Button.js +315 -315
  570. package/lib/engine-components/ui/Canvas.d.ts +74 -74
  571. package/lib/engine-components/ui/Canvas.js +407 -407
  572. package/lib/engine-components/ui/CanvasGroup.d.ts +19 -19
  573. package/lib/engine-components/ui/CanvasGroup.js +58 -58
  574. package/lib/engine-components/ui/EventSystem.d.ts +125 -125
  575. package/lib/engine-components/ui/EventSystem.js +765 -765
  576. package/lib/engine-components/ui/Graphic.d.ts +55 -55
  577. package/lib/engine-components/ui/Graphic.js +255 -255
  578. package/lib/engine-components/ui/Image.d.ts +35 -35
  579. package/lib/engine-components/ui/Image.js +116 -116
  580. package/lib/engine-components/ui/InputField.d.ts +42 -42
  581. package/lib/engine-components/ui/InputField.js +268 -268
  582. package/lib/engine-components/ui/Interfaces.d.ts +38 -38
  583. package/lib/engine-components/ui/Interfaces.js +12 -12
  584. package/lib/engine-components/ui/Layout.d.ts +84 -84
  585. package/lib/engine-components/ui/Layout.js +330 -330
  586. package/lib/engine-components/ui/Outline.d.ts +7 -7
  587. package/lib/engine-components/ui/Outline.js +20 -20
  588. package/lib/engine-components/ui/PointerEvents.d.ts +115 -115
  589. package/lib/engine-components/ui/PointerEvents.js +145 -145
  590. package/lib/engine-components/ui/RaycastUtils.d.ts +11 -11
  591. package/lib/engine-components/ui/RaycastUtils.js +67 -67
  592. package/lib/engine-components/ui/Raycaster.d.ts +30 -30
  593. package/lib/engine-components/ui/Raycaster.js +95 -95
  594. package/lib/engine-components/ui/RectTransform.d.ts +61 -61
  595. package/lib/engine-components/ui/RectTransform.js +356 -356
  596. package/lib/engine-components/ui/SpatialHtml.d.ts +8 -8
  597. package/lib/engine-components/ui/SpatialHtml.js +79 -79
  598. package/lib/engine-components/ui/Symbols.d.ts +1 -1
  599. package/lib/engine-components/ui/Symbols.js +1 -1
  600. package/lib/engine-components/ui/Text.d.ts +78 -78
  601. package/lib/engine-components/ui/Text.js +539 -539
  602. package/lib/engine-components/ui/Utils.d.ts +24 -24
  603. package/lib/engine-components/ui/Utils.js +90 -90
  604. package/lib/engine-components/ui/index.d.ts +1 -1
  605. package/lib/engine-components/ui/index.js +1 -1
  606. package/lib/engine-components/utils/EnvironmentScene.d.ts +5 -5
  607. package/lib/engine-components/utils/EnvironmentScene.js +205 -205
  608. package/lib/engine-components/utils/LookAt.d.ts +31 -31
  609. package/lib/engine-components/utils/LookAt.js +82 -82
  610. package/lib/engine-components/utils/OpenURL.d.ts +42 -42
  611. package/lib/engine-components/utils/OpenURL.js +119 -119
  612. package/lib/engine-components/webxr/Avatar.d.ts +25 -25
  613. package/lib/engine-components/webxr/Avatar.js +255 -255
  614. package/lib/engine-components/webxr/TeleportTarget.d.ts +7 -7
  615. package/lib/engine-components/webxr/TeleportTarget.js +7 -7
  616. package/lib/engine-components/webxr/WebARCameraBackground.d.ts +30 -30
  617. package/lib/engine-components/webxr/WebARCameraBackground.js +155 -155
  618. package/lib/engine-components/webxr/WebARSessionRoot.d.ts +98 -98
  619. package/lib/engine-components/webxr/WebARSessionRoot.js +770 -770
  620. package/lib/engine-components/webxr/WebXR.d.ts +232 -232
  621. package/lib/engine-components/webxr/WebXR.js +561 -561
  622. package/lib/engine-components/webxr/WebXRAvatar.d.ts +27 -27
  623. package/lib/engine-components/webxr/WebXRAvatar.js +44 -44
  624. package/lib/engine-components/webxr/WebXRImageTracking.d.ts +86 -86
  625. package/lib/engine-components/webxr/WebXRImageTracking.js +471 -471
  626. package/lib/engine-components/webxr/WebXRPlaneTracking.d.ts +92 -92
  627. package/lib/engine-components/webxr/WebXRPlaneTracking.js +500 -500
  628. package/lib/engine-components/webxr/WebXRRig.d.ts +32 -32
  629. package/lib/engine-components/webxr/WebXRRig.js +72 -72
  630. package/lib/engine-components/webxr/XRFlag.d.ts +38 -38
  631. package/lib/engine-components/webxr/XRFlag.js +139 -139
  632. package/lib/engine-components/webxr/controllers/XRControllerFollow.d.ts +47 -47
  633. package/lib/engine-components/webxr/controllers/XRControllerFollow.js +120 -120
  634. package/lib/engine-components/webxr/controllers/XRControllerModel.d.ts +43 -43
  635. package/lib/engine-components/webxr/controllers/XRControllerModel.js +352 -352
  636. package/lib/engine-components/webxr/controllers/XRControllerMovement.d.ts +78 -78
  637. package/lib/engine-components/webxr/controllers/XRControllerMovement.js +506 -506
  638. package/lib/engine-components/webxr/index.d.ts +3 -3
  639. package/lib/engine-components/webxr/index.js +3 -3
  640. package/lib/engine-components/webxr/types.d.ts +3 -3
  641. package/lib/engine-components/webxr/types.js +1 -1
  642. package/lib/engine-components-experimental/Presentation.d.ts +6 -6
  643. package/lib/engine-components-experimental/Presentation.js +9 -9
  644. package/lib/engine-components-experimental/api.d.ts +4 -4
  645. package/lib/engine-components-experimental/api.js +4 -4
  646. package/lib/engine-components-experimental/networking/PlayerSync.d.ts +156 -156
  647. package/lib/engine-components-experimental/networking/PlayerSync.js +377 -377
  648. package/lib/engine-schemes/api.d.ts +12 -12
  649. package/lib/engine-schemes/api.js +12 -12
  650. package/lib/engine-schemes/schemes.d.ts +7 -7
  651. package/lib/engine-schemes/schemes.js +19 -19
  652. package/lib/engine-schemes/synced-camera-model.d.ts +25 -25
  653. package/lib/engine-schemes/synced-camera-model.js +67 -67
  654. package/lib/engine-schemes/synced-transform-model.d.ts +31 -31
  655. package/lib/engine-schemes/synced-transform-model.js +66 -66
  656. package/lib/engine-schemes/transform.d.ts +12 -12
  657. package/lib/engine-schemes/transform.js +39 -39
  658. package/lib/engine-schemes/vec2.d.ts +10 -10
  659. package/lib/engine-schemes/vec2.js +25 -25
  660. package/lib/engine-schemes/vec3.d.ts +11 -11
  661. package/lib/engine-schemes/vec3.js +29 -29
  662. package/lib/engine-schemes/vec4.d.ts +12 -12
  663. package/lib/engine-schemes/vec4.js +33 -33
  664. package/lib/engine-schemes/vr-user-state-buffer.d.ts +37 -37
  665. package/lib/engine-schemes/vr-user-state-buffer.js +110 -110
  666. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.d.ts +6 -6
  667. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.js +45 -45
  668. package/lib/needle-engine.d.ts +7 -7
  669. package/lib/needle-engine.js +64 -64
  670. package/package.json +2 -2
  671. package/plugins/common/buildinfo.js +64 -64
  672. package/plugins/common/cloud.js +1 -1
  673. package/plugins/common/config.cjs +31 -31
  674. package/plugins/common/config.js +35 -35
  675. package/plugins/common/files.js +31 -31
  676. package/plugins/common/generator.js +10 -10
  677. package/plugins/common/license.js +452 -452
  678. package/plugins/common/npm.js +15 -15
  679. package/plugins/common/timers.js +7 -7
  680. package/plugins/common/version.js +37 -37
  681. package/plugins/gltf-packer.mjs +1 -1
  682. package/plugins/next/alias.cjs +39 -39
  683. package/plugins/next/license.cjs +24 -24
  684. package/plugins/next/meshbvhworker.cjs +18 -18
  685. package/plugins/next/next.js +141 -141
  686. package/plugins/types/index.d.ts +2 -2
  687. package/plugins/types/license.d.ts +24 -24
  688. package/plugins/types/needleConfig.d.ts +27 -27
  689. package/plugins/types/next.d.ts +2 -2
  690. package/plugins/types/userconfig.d.ts +122 -120
  691. package/plugins/types/vite.d.ts +13 -13
  692. package/plugins/types/webmanifest.d.ts +32 -32
  693. package/plugins/vite/alias.js +184 -174
  694. package/plugins/vite/asap.js +251 -251
  695. package/plugins/vite/build-pipeline.js +371 -371
  696. package/plugins/vite/build.js +19 -19
  697. package/plugins/vite/buildinfo.js +41 -41
  698. package/plugins/vite/config.js +106 -106
  699. package/plugins/vite/copyfiles.js +138 -138
  700. package/plugins/vite/defines.js +70 -70
  701. package/plugins/vite/dependencies.js +232 -232
  702. package/plugins/vite/dependency-watcher.js +237 -237
  703. package/plugins/vite/drop-client.js +76 -76
  704. package/plugins/vite/drop.js +87 -87
  705. package/plugins/vite/editor-connection.js +124 -124
  706. package/plugins/vite/facebook-instant-games.js +102 -102
  707. package/plugins/vite/gzip.js +5 -5
  708. package/plugins/vite/imports-logger.js +143 -143
  709. package/plugins/vite/index.js +145 -143
  710. package/plugins/vite/license.js +56 -56
  711. package/plugins/vite/local-files.js +440 -440
  712. package/plugins/vite/materialx.js +30 -0
  713. package/plugins/vite/meta.js +163 -163
  714. package/plugins/vite/npm.js +7 -7
  715. package/plugins/vite/peer.js +29 -29
  716. package/plugins/vite/poster-client.js +73 -73
  717. package/plugins/vite/poster.js +79 -79
  718. package/plugins/vite/pwa.js +604 -604
  719. package/plugins/vite/reload-client.js +15 -15
  720. package/plugins/vite/reload.js +351 -351
  721. package/plugins/vite/server.js +66 -66
  722. package/plugins/vite/transform-codegen.js +55 -55
  723. package/plugins/vite/transform.js +32 -31
  724. package/plugins/vite/vite-4.4-hack.js +31 -31
  725. package/src/asap/needle-asap.ts +111 -111
  726. package/src/asap/sessiongranted.ts +75 -75
  727. package/src/asap/utils.ts +4 -4
  728. package/src/engine/analytics/index.ts +10 -10
  729. package/src/engine/analytics/lcp.ts +35 -35
  730. package/src/engine/api.ts +82 -82
  731. package/src/engine/assets/index.ts +59 -59
  732. package/src/engine/assets/static.js +5 -5
  733. package/src/engine/codegen/register_types.ts +300 -300
  734. package/src/engine/debug/debug.ts +51 -51
  735. package/src/engine/debug/debug_console.ts +333 -333
  736. package/src/engine/debug/debug_overlay.ts +332 -332
  737. package/src/engine/debug/debug_spatial_console.ts +429 -429
  738. package/src/engine/debug/index.ts +1 -1
  739. package/src/engine/engine_addressables.ts +680 -680
  740. package/src/engine/engine_animation.ts +145 -145
  741. package/src/engine/engine_application.ts +113 -113
  742. package/src/engine/engine_assetdatabase.ts +389 -389
  743. package/src/engine/engine_audio.ts +24 -24
  744. package/src/engine/engine_camera.ts +39 -39
  745. package/src/engine/engine_components.ts +366 -366
  746. package/src/engine/engine_components_internal.ts +40 -40
  747. package/src/engine/engine_constants.ts +52 -52
  748. package/src/engine/engine_context.ts +1824 -1823
  749. package/src/engine/engine_context_registry.ts +129 -129
  750. package/src/engine/engine_coroutine.ts +54 -54
  751. package/src/engine/engine_create_objects.ts +411 -411
  752. package/src/engine/engine_default_parameters.ts +3 -3
  753. package/src/engine/engine_editor-sync.ts +28 -28
  754. package/src/engine/engine_fileloader.js +9 -9
  755. package/src/engine/engine_gameobject.ts +712 -712
  756. package/src/engine/engine_generic_utils.js +13 -13
  757. package/src/engine/engine_gizmos.ts +577 -577
  758. package/src/engine/engine_gltf.ts +29 -29
  759. package/src/engine/engine_gltf_builtin_components.ts +403 -403
  760. package/src/engine/engine_hot_reload.ts +210 -210
  761. package/src/engine/engine_input.ts +1500 -1500
  762. package/src/engine/engine_input_utils.ts +23 -23
  763. package/src/engine/engine_instancing.ts +45 -45
  764. package/src/engine/engine_license.ts +386 -386
  765. package/src/engine/engine_lifecycle_api.ts +113 -113
  766. package/src/engine/engine_lifecycle_functions_internal.ts +193 -193
  767. package/src/engine/engine_lightdata.ts +117 -117
  768. package/src/engine/engine_loaders.callbacks.ts +136 -136
  769. package/src/engine/engine_loaders.gltf.ts +82 -82
  770. package/src/engine/engine_loaders.ts +378 -378
  771. package/src/engine/engine_lods.ts +168 -168
  772. package/src/engine/engine_mainloop_utils.ts +472 -472
  773. package/src/engine/engine_math.ts +282 -282
  774. package/src/engine/engine_modules.ts +83 -83
  775. package/src/engine/engine_networking.ts +862 -862
  776. package/src/engine/engine_networking_auto.ts +352 -352
  777. package/src/engine/engine_networking_blob.ts +275 -275
  778. package/src/engine/engine_networking_files.ts +217 -217
  779. package/src/engine/engine_networking_files_default_components.ts +58 -58
  780. package/src/engine/engine_networking_instantiate.ts +419 -419
  781. package/src/engine/engine_networking_peer.ts +159 -159
  782. package/src/engine/engine_networking_streams.ts +713 -713
  783. package/src/engine/engine_networking_types.ts +24 -24
  784. package/src/engine/engine_networking_utils.ts +23 -23
  785. package/src/engine/engine_networking_websocket.ts +2 -2
  786. package/src/engine/engine_patcher.ts +199 -199
  787. package/src/engine/engine_physics.ts +783 -783
  788. package/src/engine/engine_physics.types.ts +46 -46
  789. package/src/engine/engine_physics_rapier.ts +1577 -1577
  790. package/src/engine/engine_playerview.ts +80 -80
  791. package/src/engine/engine_scenelighting.ts +294 -294
  792. package/src/engine/engine_serialization.ts +2 -2
  793. package/src/engine/engine_serialization_builtin_serializer.ts +473 -473
  794. package/src/engine/engine_serialization_core.ts +720 -720
  795. package/src/engine/engine_serialization_decorator.ts +80 -80
  796. package/src/engine/engine_setup.ts +1 -1
  797. package/src/engine/engine_shaders.ts +267 -267
  798. package/src/engine/engine_shims.ts +32 -32
  799. package/src/engine/engine_test_utils.ts +109 -109
  800. package/src/engine/engine_texture.ts +82 -82
  801. package/src/engine/engine_three_utils.ts +925 -925
  802. package/src/engine/engine_time.ts +94 -94
  803. package/src/engine/engine_time_utils.ts +237 -237
  804. package/src/engine/engine_tonemapping.ts +208 -208
  805. package/src/engine/engine_types.ts +730 -730
  806. package/src/engine/engine_typestore.ts +63 -63
  807. package/src/engine/engine_util_decorator.ts +136 -136
  808. package/src/engine/engine_utils.ts +1115 -1115
  809. package/src/engine/engine_utils_format.ts +273 -273
  810. package/src/engine/engine_utils_screenshot.ts +708 -708
  811. package/src/engine/engine_utils_screenshot.xr.ts +103 -103
  812. package/src/engine/export/gltf/Writers.ts +34 -34
  813. package/src/engine/export/gltf/index.ts +158 -158
  814. package/src/engine/export/index.ts +2 -2
  815. package/src/engine/export/state.ts +19 -19
  816. package/src/engine/export/utils.ts +9 -9
  817. package/src/engine/extensions/EXT_texture_exr.ts +50 -50
  818. package/src/engine/extensions/NEEDLE_animator_controller_model.ts +195 -195
  819. package/src/engine/extensions/NEEDLE_components.ts +268 -268
  820. package/src/engine/extensions/NEEDLE_gameobject_data.ts +81 -81
  821. package/src/engine/extensions/NEEDLE_lighting_settings.ts +185 -185
  822. package/src/engine/extensions/NEEDLE_lightmaps.ts +119 -119
  823. package/src/engine/extensions/NEEDLE_persistent_assets.ts +76 -76
  824. package/src/engine/extensions/NEEDLE_render_objects.ts +209 -209
  825. package/src/engine/extensions/NEEDLE_techniques_webgl.ts +640 -640
  826. package/src/engine/extensions/extension_resolver.ts +4 -4
  827. package/src/engine/extensions/extension_utils.ts +166 -166
  828. package/src/engine/extensions/extensions.ts +140 -140
  829. package/src/engine/extensions/index.ts +5 -5
  830. package/src/engine/extensions/usage_tracker.ts +100 -100
  831. package/src/engine/js-extensions/Camera.ts +37 -37
  832. package/src/engine/js-extensions/ExtensionUtils.ts +85 -85
  833. package/src/engine/js-extensions/Layers.ts +23 -23
  834. package/src/engine/js-extensions/Object3D.ts +296 -296
  835. package/src/engine/js-extensions/RGBAColor.ts +126 -126
  836. package/src/engine/js-extensions/Vector.ts +18 -18
  837. package/src/engine/js-extensions/index.ts +4 -4
  838. package/src/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +125 -125
  839. package/src/engine/shaders/shaderData.ts +67 -67
  840. package/src/engine/tests/test_utils.ts +63 -63
  841. package/src/engine/webcomponents/WebXRButtons.ts +260 -260
  842. package/src/engine/webcomponents/api.ts +6 -6
  843. package/src/engine/webcomponents/buttons.ts +292 -292
  844. package/src/engine/webcomponents/fonts.ts +41 -41
  845. package/src/engine/webcomponents/icons.ts +57 -57
  846. package/src/engine/webcomponents/index.ts +1 -1
  847. package/src/engine/webcomponents/logo-element.ts +78 -78
  848. package/src/engine/webcomponents/needle menu/needle-menu-spatial.ts +573 -573
  849. package/src/engine/webcomponents/needle menu/needle-menu.ts +1118 -1118
  850. package/src/engine/webcomponents/needle-button.ts +181 -181
  851. package/src/engine/webcomponents/needle-engine.ar-overlay.ts +186 -186
  852. package/src/engine/webcomponents/needle-engine.attributes.ts +82 -82
  853. package/src/engine/webcomponents/needle-engine.extras.ts +16 -16
  854. package/src/engine/webcomponents/needle-engine.loading.ts +373 -373
  855. package/src/engine/webcomponents/needle-engine.ts +860 -860
  856. package/src/engine/xr/NeedleXRController.ts +1125 -1125
  857. package/src/engine/xr/NeedleXRSession.ts +1624 -1624
  858. package/src/engine/xr/NeedleXRSync.ts +220 -220
  859. package/src/engine/xr/SceneTransition.ts +78 -78
  860. package/src/engine/xr/TempXRContext.ts +216 -216
  861. package/src/engine/xr/XRRig.ts +9 -9
  862. package/src/engine/xr/api.ts +5 -5
  863. package/src/engine/xr/events.ts +102 -102
  864. package/src/engine/xr/internal.ts +34 -34
  865. package/src/engine/xr/usdz.ts +30 -30
  866. package/src/engine/xr/utils.ts +39 -39
  867. package/src/engine-components/AlignmentConstraint.ts +36 -36
  868. package/src/engine-components/Animation.ts +557 -557
  869. package/src/engine-components/AnimationCurve.ts +150 -150
  870. package/src/engine-components/AnimationUtils.ts +28 -28
  871. package/src/engine-components/AnimationUtilsAutoplay.ts +43 -43
  872. package/src/engine-components/Animator.ts +397 -397
  873. package/src/engine-components/AnimatorController.ts +1293 -1293
  874. package/src/engine-components/AudioListener.ts +92 -92
  875. package/src/engine-components/AudioSource.ts +644 -644
  876. package/src/engine-components/AvatarLoader.ts +263 -263
  877. package/src/engine-components/AxesHelper.ts +59 -59
  878. package/src/engine-components/BasicIKConstraint.ts +54 -54
  879. package/src/engine-components/BoxCollider.ts +1 -1
  880. package/src/engine-components/BoxHelperComponent.ts +114 -114
  881. package/src/engine-components/Camera.ts +719 -719
  882. package/src/engine-components/CameraUtils.ts +136 -136
  883. package/src/engine-components/CharacterController.ts +253 -253
  884. package/src/engine-components/Collider.ts +374 -374
  885. package/src/engine-components/Component.ts +1297 -1297
  886. package/src/engine-components/ContactShadows.ts +506 -506
  887. package/src/engine-components/DeleteBox.ts +62 -62
  888. package/src/engine-components/DeviceFlag.ts +46 -46
  889. package/src/engine-components/DragControls.ts +1623 -1623
  890. package/src/engine-components/DropListener.ts +713 -713
  891. package/src/engine-components/Duplicatable.ts +198 -198
  892. package/src/engine-components/EventList.ts +266 -266
  893. package/src/engine-components/EventTrigger.ts +74 -74
  894. package/src/engine-components/EventType.ts +22 -22
  895. package/src/engine-components/Fog.ts +60 -60
  896. package/src/engine-components/Gizmos.ts +56 -56
  897. package/src/engine-components/GridHelper.ts +48 -48
  898. package/src/engine-components/GroundProjection.ts +356 -356
  899. package/src/engine-components/Interactable.ts +14 -14
  900. package/src/engine-components/Joints.ts +52 -52
  901. package/src/engine-components/LODGroup.ts +153 -153
  902. package/src/engine-components/Light.ts +558 -558
  903. package/src/engine-components/LookAtConstraint.ts +25 -25
  904. package/src/engine-components/NeedleMenu.ts +84 -84
  905. package/src/engine-components/NestedGltf.ts +86 -86
  906. package/src/engine-components/Networking.ts +114 -114
  907. package/src/engine-components/OffsetConstraint.ts +60 -60
  908. package/src/engine-components/OrbitControls.ts +1074 -1074
  909. package/src/engine-components/PlayerColor.ts +103 -103
  910. package/src/engine-components/ReflectionProbe.ts +220 -220
  911. package/src/engine-components/Renderer.ts +903 -903
  912. package/src/engine-components/RendererInstancing.ts +855 -855
  913. package/src/engine-components/RendererLightmap.ts +198 -198
  914. package/src/engine-components/RigidBody.ts +526 -526
  915. package/src/engine-components/SceneSwitcher.ts +1030 -1030
  916. package/src/engine-components/ScreenCapture.ts +592 -592
  917. package/src/engine-components/ShadowCatcher.ts +172 -172
  918. package/src/engine-components/Skybox.ts +475 -475
  919. package/src/engine-components/SmoothFollow.ts +76 -76
  920. package/src/engine-components/SpatialTrigger.ts +229 -229
  921. package/src/engine-components/SpectatorCamera.ts +787 -787
  922. package/src/engine-components/SphereCollider.ts +1 -1
  923. package/src/engine-components/SpriteRenderer.ts +468 -468
  924. package/src/engine-components/SyncedCamera.ts +220 -220
  925. package/src/engine-components/SyncedRoom.ts +380 -380
  926. package/src/engine-components/SyncedTransform.ts +383 -383
  927. package/src/engine-components/TestRunner.ts +118 -118
  928. package/src/engine-components/TransformGizmo.ts +219 -219
  929. package/src/engine-components/VideoPlayer.ts +1025 -1025
  930. package/src/engine-components/Voip.ts +363 -363
  931. package/src/engine-components/api.ts +60 -60
  932. package/src/engine-components/avatar/AvatarBlink_Simple.ts +69 -69
  933. package/src/engine-components/avatar/AvatarEyeLook_Rotation.ts +63 -63
  934. package/src/engine-components/avatar/Avatar_Brain_LookAt.ts +139 -139
  935. package/src/engine-components/avatar/Avatar_MouthShapes.ts +83 -83
  936. package/src/engine-components/avatar/Avatar_MustacheShake.ts +31 -31
  937. package/src/engine-components/codegen/components.ts +217 -217
  938. package/src/engine-components/debug/LogStats.ts +21 -21
  939. package/src/engine-components/export/gltf/GltfExport.ts +265 -265
  940. package/src/engine-components/export/usdz/Extension.ts +24 -24
  941. package/src/engine-components/export/usdz/ThreeUSDZExporter.ts +2426 -2426
  942. package/src/engine-components/export/usdz/USDZExporter.ts +705 -705
  943. package/src/engine-components/export/usdz/extensions/Animation.ts +1204 -1204
  944. package/src/engine-components/export/usdz/extensions/DocumentExtension.ts +9 -9
  945. package/src/engine-components/export/usdz/extensions/NodeMaterialConverter.ts +532 -532
  946. package/src/engine-components/export/usdz/extensions/USDZText.ts +240 -240
  947. package/src/engine-components/export/usdz/extensions/USDZUI.ts +189 -189
  948. package/src/engine-components/export/usdz/extensions/behavior/Actions.ts +99 -99
  949. package/src/engine-components/export/usdz/extensions/behavior/AudioExtension.ts +102 -102
  950. package/src/engine-components/export/usdz/extensions/behavior/Behaviour.ts +320 -320
  951. package/src/engine-components/export/usdz/extensions/behavior/BehaviourComponents.ts +1225 -1225
  952. package/src/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.ts +646 -646
  953. package/src/engine-components/export/usdz/extensions/behavior/PhysicsExtension.ts +132 -132
  954. package/src/engine-components/export/usdz/index.ts +2 -2
  955. package/src/engine-components/export/usdz/utils/animationutils.ts +191 -191
  956. package/src/engine-components/export/usdz/utils/quicklook.ts +50 -50
  957. package/src/engine-components/particlesystem/ParticleSystem.ts +1287 -1287
  958. package/src/engine-components/particlesystem/ParticleSystemModules.ts +1765 -1765
  959. package/src/engine-components/particlesystem/ParticleSystemSubEmitter.ts +111 -111
  960. package/src/engine-components/particlesystem/api.ts +1 -1
  961. package/src/engine-components/postprocessing/Effects/Antialiasing.ts +64 -57
  962. package/src/engine-components/postprocessing/Effects/BloomEffect.ts +116 -116
  963. package/src/engine-components/postprocessing/Effects/ChromaticAberration.ts +37 -37
  964. package/src/engine-components/postprocessing/Effects/ColorAdjustments.ts +106 -106
  965. package/src/engine-components/postprocessing/Effects/DepthOfField.ts +103 -103
  966. package/src/engine-components/postprocessing/Effects/EffectWrapper.ts +25 -25
  967. package/src/engine-components/postprocessing/Effects/Pixelation.ts +32 -32
  968. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.ts +90 -90
  969. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.ts +192 -192
  970. package/src/engine-components/postprocessing/Effects/Sharpening.ts +143 -143
  971. package/src/engine-components/postprocessing/Effects/TiltShiftEffect.ts +61 -61
  972. package/src/engine-components/postprocessing/Effects/Tonemapping.ts +103 -103
  973. package/src/engine-components/postprocessing/Effects/Tonemapping.utils.ts +60 -60
  974. package/src/engine-components/postprocessing/Effects/Vignette.ts +59 -59
  975. package/src/engine-components/postprocessing/PostProcessingEffect.ts +192 -192
  976. package/src/engine-components/postprocessing/PostProcessingHandler.ts +573 -560
  977. package/src/engine-components/postprocessing/Volume.ts +426 -426
  978. package/src/engine-components/postprocessing/VolumeParameter.ts +158 -158
  979. package/src/engine-components/postprocessing/VolumeProfile.ts +61 -61
  980. package/src/engine-components/postprocessing/index.ts +5 -5
  981. package/src/engine-components/postprocessing/utils.ts +154 -154
  982. package/src/engine-components/timeline/PlayableDirector.ts +722 -722
  983. package/src/engine-components/timeline/SignalAsset.ts +144 -144
  984. package/src/engine-components/timeline/TimelineModels.ts +92 -92
  985. package/src/engine-components/timeline/TimelineTracks.ts +967 -967
  986. package/src/engine-components/timeline/index.ts +3 -3
  987. package/src/engine-components/ui/BaseUIComponent.ts +203 -203
  988. package/src/engine-components/ui/Button.ts +307 -307
  989. package/src/engine-components/ui/Canvas.ts +419 -419
  990. package/src/engine-components/ui/CanvasGroup.ts +54 -54
  991. package/src/engine-components/ui/EventSystem.ts +854 -854
  992. package/src/engine-components/ui/Graphic.ts +275 -275
  993. package/src/engine-components/ui/Image.ts +112 -112
  994. package/src/engine-components/ui/InputField.ts +321 -321
  995. package/src/engine-components/ui/Interfaces.ts +57 -57
  996. package/src/engine-components/ui/Layout.ts +334 -334
  997. package/src/engine-components/ui/Outline.ts +13 -13
  998. package/src/engine-components/ui/PointerEvents.ts +206 -206
  999. package/src/engine-components/ui/RaycastUtils.ts +69 -69
  1000. package/src/engine-components/ui/Raycaster.ts +102 -102
  1001. package/src/engine-components/ui/RectTransform.ts +375 -375
  1002. package/src/engine-components/ui/SpatialHtml.ts +79 -79
  1003. package/src/engine-components/ui/Symbols.ts +1 -1
  1004. package/src/engine-components/ui/Text.ts +578 -578
  1005. package/src/engine-components/ui/Utils.ts +113 -113
  1006. package/src/engine-components/utils/EnvironmentScene.ts +245 -245
  1007. package/src/engine-components/utils/LookAt.ts +88 -88
  1008. package/src/engine-components/utils/OpenURL.ts +114 -114
  1009. package/src/engine-components/webxr/Avatar.ts +265 -265
  1010. package/src/engine-components/webxr/TeleportTarget.ts +9 -9
  1011. package/src/engine-components/webxr/WebARCameraBackground.ts +175 -175
  1012. package/src/engine-components/webxr/WebARSessionRoot.ts +880 -880
  1013. package/src/engine-components/webxr/WebXR.ts +585 -585
  1014. package/src/engine-components/webxr/WebXRAvatar.ts +66 -66
  1015. package/src/engine-components/webxr/WebXRImageTracking.ts +519 -519
  1016. package/src/engine-components/webxr/WebXRPlaneTracking.ts +570 -570
  1017. package/src/engine-components/webxr/WebXRRig.ts +77 -77
  1018. package/src/engine-components/webxr/XRFlag.ts +147 -147
  1019. package/src/engine-components/webxr/controllers/XRControllerFollow.ts +118 -118
  1020. package/src/engine-components/webxr/controllers/XRControllerModel.ts +373 -373
  1021. package/src/engine-components/webxr/controllers/XRControllerMovement.ts +550 -550
  1022. package/src/engine-components/webxr/index.ts +2 -2
  1023. package/src/engine-components/webxr/types.ts +3 -3
  1024. package/src/engine-components-experimental/Presentation.ts +12 -12
  1025. package/src/engine-components-experimental/api.ts +4 -4
  1026. package/src/engine-components-experimental/networking/PlayerSync.ts +401 -401
  1027. package/src/engine-schemes/COMPILE_SCHEMES.bat +3 -3
  1028. package/src/engine-schemes/COMPILE_TS.bat +11 -11
  1029. package/src/engine-schemes/README.md +1 -1
  1030. package/src/engine-schemes/api.ts +12 -12
  1031. package/src/engine-schemes/schemes.ts +28 -28
  1032. package/src/engine-schemes/synced-camera-model.ts +92 -92
  1033. package/src/engine-schemes/synced-transform-model.ts +90 -90
  1034. package/src/engine-schemes/syncedCamera.fbs +10 -10
  1035. package/src/engine-schemes/transform.ts +50 -50
  1036. package/src/engine-schemes/transforms.fbs +25 -25
  1037. package/src/engine-schemes/vec.fbs +19 -19
  1038. package/src/engine-schemes/vec2.ts +33 -33
  1039. package/src/engine-schemes/vec3.ts +38 -38
  1040. package/src/engine-schemes/vec4.ts +43 -43
  1041. package/src/engine-schemes/vr-user-state-buffer.ts +145 -145
  1042. package/src/engine-schemes/vrUserStateBuffer.fbs +17 -17
  1043. package/src/include/draco/draco_decoder.js +34 -34
  1044. package/src/include/ktx2/basis_transcoder.js +21 -21
  1045. package/src/include/needle/arial-msdf.json +1471 -1471
  1046. package/src/include/three/DragControls.js +231 -231
  1047. package/src/include/three/EXT_mesh_gpu_instancing_exporter.js +66 -66
  1048. package/src/needle-engine.ts +70 -70
  1049. package/dist/generateMeshBVH.worker-Cdfpaq5W.js +0 -25
  1050. package/src/engine-schemes/dist/api.js +0 -17
  1051. package/src/engine-schemes/dist/api.js.meta +0 -7
  1052. package/src/engine-schemes/dist/schemes.js +0 -25
  1053. package/src/engine-schemes/dist/schemes.js.meta +0 -7
  1054. package/src/engine-schemes/dist/synced-camera-model.js +0 -74
  1055. package/src/engine-schemes/dist/synced-camera-model.js.meta +0 -7
  1056. package/src/engine-schemes/dist/synced-transform-model.js +0 -73
  1057. package/src/engine-schemes/dist/synced-transform-model.js.meta +0 -7
  1058. package/src/engine-schemes/dist/transform.js +0 -46
  1059. package/src/engine-schemes/dist/transform.js.meta +0 -7
  1060. package/src/engine-schemes/dist/vec2.js +0 -32
  1061. package/src/engine-schemes/dist/vec2.js.meta +0 -7
  1062. package/src/engine-schemes/dist/vec3.js +0 -36
  1063. package/src/engine-schemes/dist/vec3.js.meta +0 -7
  1064. package/src/engine-schemes/dist/vec4.js +0 -40
  1065. package/src/engine-schemes/dist/vec4.js.meta +0 -7
  1066. package/src/engine-schemes/dist/vr-user-state-buffer.js +0 -110
  1067. package/src/engine-schemes/dist/vr-user-state-buffer.js.meta +0 -7
@@ -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
  }