webxr_interface_js.cpp 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843
  1. /**************************************************************************/
  2. /* webxr_interface_js.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "webxr_interface_js.h"
  31. #ifdef WEB_ENABLED
  32. #include "godot_webxr.h"
  33. #include "core/input/input.h"
  34. #include "core/os/os.h"
  35. #include "drivers/gles3/storage/texture_storage.h"
  36. #include "scene/main/scene_tree.h"
  37. #include "scene/main/window.h"
  38. #include "scene/scene_string_names.h"
  39. #include "servers/rendering/renderer_compositor.h"
  40. #include "servers/rendering/rendering_server_globals.h"
  41. #include "servers/xr/xr_hand_tracker.h"
  42. #include <emscripten.h>
  43. #include <stdlib.h>
  44. void _emwebxr_on_session_supported(char *p_session_mode, int p_supported) {
  45. XRServer *xr_server = XRServer::get_singleton();
  46. ERR_FAIL_NULL(xr_server);
  47. Ref<WebXRInterfaceJS> interface = xr_server->find_interface("WebXR");
  48. ERR_FAIL_COND(interface.is_null());
  49. String session_mode = String(p_session_mode);
  50. interface->emit_signal(SNAME("session_supported"), session_mode, p_supported ? true : false);
  51. }
  52. void _emwebxr_on_session_started(char *p_reference_space_type, char *p_enabled_features) {
  53. XRServer *xr_server = XRServer::get_singleton();
  54. ERR_FAIL_NULL(xr_server);
  55. Ref<WebXRInterfaceJS> interface = xr_server->find_interface("WebXR");
  56. ERR_FAIL_COND(interface.is_null());
  57. String reference_space_type = String(p_reference_space_type);
  58. interface->_set_reference_space_type(reference_space_type);
  59. interface->_set_enabled_features(p_enabled_features);
  60. interface->emit_signal(SNAME("session_started"));
  61. }
  62. void _emwebxr_on_session_ended() {
  63. XRServer *xr_server = XRServer::get_singleton();
  64. ERR_FAIL_NULL(xr_server);
  65. Ref<WebXRInterfaceJS> interface = xr_server->find_interface("WebXR");
  66. ERR_FAIL_COND(interface.is_null());
  67. interface->uninitialize();
  68. interface->emit_signal(SNAME("session_ended"));
  69. }
  70. void _emwebxr_on_session_failed(char *p_message) {
  71. XRServer *xr_server = XRServer::get_singleton();
  72. ERR_FAIL_NULL(xr_server);
  73. Ref<WebXRInterfaceJS> interface = xr_server->find_interface("WebXR");
  74. ERR_FAIL_COND(interface.is_null());
  75. interface->uninitialize();
  76. String message = String(p_message);
  77. interface->emit_signal(SNAME("session_failed"), message);
  78. }
  79. extern "C" EMSCRIPTEN_KEEPALIVE void _emwebxr_on_input_event(int p_event_type, int p_input_source_id) {
  80. XRServer *xr_server = XRServer::get_singleton();
  81. ERR_FAIL_NULL(xr_server);
  82. Ref<WebXRInterfaceJS> interface = xr_server->find_interface("WebXR");
  83. ERR_FAIL_COND(interface.is_null());
  84. interface->_on_input_event(p_event_type, p_input_source_id);
  85. }
  86. extern "C" EMSCRIPTEN_KEEPALIVE void _emwebxr_on_simple_event(char *p_signal_name) {
  87. XRServer *xr_server = XRServer::get_singleton();
  88. ERR_FAIL_NULL(xr_server);
  89. Ref<WebXRInterfaceJS> interface = xr_server->find_interface("WebXR");
  90. ERR_FAIL_COND(interface.is_null());
  91. StringName signal_name = StringName(p_signal_name);
  92. interface->emit_signal(signal_name);
  93. }
  94. void WebXRInterfaceJS::is_session_supported(const String &p_session_mode) {
  95. godot_webxr_is_session_supported(p_session_mode.utf8().get_data(), &_emwebxr_on_session_supported);
  96. }
  97. void WebXRInterfaceJS::set_session_mode(String p_session_mode) {
  98. session_mode = p_session_mode;
  99. }
  100. String WebXRInterfaceJS::get_session_mode() const {
  101. return session_mode;
  102. }
  103. void WebXRInterfaceJS::set_required_features(String p_required_features) {
  104. required_features = p_required_features;
  105. }
  106. String WebXRInterfaceJS::get_required_features() const {
  107. return required_features;
  108. }
  109. void WebXRInterfaceJS::set_optional_features(String p_optional_features) {
  110. optional_features = p_optional_features;
  111. }
  112. String WebXRInterfaceJS::get_optional_features() const {
  113. return optional_features;
  114. }
  115. void WebXRInterfaceJS::set_requested_reference_space_types(String p_requested_reference_space_types) {
  116. requested_reference_space_types = p_requested_reference_space_types;
  117. }
  118. String WebXRInterfaceJS::get_requested_reference_space_types() const {
  119. return requested_reference_space_types;
  120. }
  121. String WebXRInterfaceJS::get_reference_space_type() const {
  122. return reference_space_type;
  123. }
  124. String WebXRInterfaceJS::get_enabled_features() const {
  125. return enabled_features;
  126. }
  127. bool WebXRInterfaceJS::is_input_source_active(int p_input_source_id) const {
  128. ERR_FAIL_INDEX_V(p_input_source_id, input_source_count, false);
  129. return input_sources[p_input_source_id].active;
  130. }
  131. Ref<XRControllerTracker> WebXRInterfaceJS::get_input_source_tracker(int p_input_source_id) const {
  132. ERR_FAIL_INDEX_V(p_input_source_id, input_source_count, Ref<XRControllerTracker>());
  133. return input_sources[p_input_source_id].tracker;
  134. }
  135. WebXRInterface::TargetRayMode WebXRInterfaceJS::get_input_source_target_ray_mode(int p_input_source_id) const {
  136. ERR_FAIL_INDEX_V(p_input_source_id, input_source_count, WebXRInterface::TARGET_RAY_MODE_UNKNOWN);
  137. if (!input_sources[p_input_source_id].active) {
  138. return WebXRInterface::TARGET_RAY_MODE_UNKNOWN;
  139. }
  140. return input_sources[p_input_source_id].target_ray_mode;
  141. }
  142. String WebXRInterfaceJS::get_visibility_state() const {
  143. char *c_str = godot_webxr_get_visibility_state();
  144. if (c_str) {
  145. String visibility_state = String(c_str);
  146. free(c_str);
  147. return visibility_state;
  148. }
  149. return String();
  150. }
  151. PackedVector3Array WebXRInterfaceJS::get_play_area() const {
  152. PackedVector3Array ret;
  153. float *points;
  154. int point_count = godot_webxr_get_bounds_geometry(&points);
  155. if (point_count > 0) {
  156. ret.resize(point_count);
  157. for (int i = 0; i < point_count; i++) {
  158. float *js_vector3 = points + (i * 3);
  159. ret.set(i, Vector3(js_vector3[0], js_vector3[1], js_vector3[2]));
  160. }
  161. free(points);
  162. }
  163. return ret;
  164. }
  165. float WebXRInterfaceJS::get_display_refresh_rate() const {
  166. return godot_webxr_get_frame_rate();
  167. }
  168. void WebXRInterfaceJS::set_display_refresh_rate(float p_refresh_rate) {
  169. godot_webxr_update_target_frame_rate(p_refresh_rate);
  170. }
  171. Array WebXRInterfaceJS::get_available_display_refresh_rates() const {
  172. Array ret;
  173. float *rates;
  174. int rate_count = godot_webxr_get_supported_frame_rates(&rates);
  175. if (rate_count > 0) {
  176. ret.resize(rate_count);
  177. for (int i = 0; i < rate_count; i++) {
  178. ret[i] = rates[i];
  179. }
  180. free(rates);
  181. }
  182. return ret;
  183. }
  184. StringName WebXRInterfaceJS::get_name() const {
  185. return "WebXR";
  186. };
  187. uint32_t WebXRInterfaceJS::get_capabilities() const {
  188. return XRInterface::XR_STEREO | XRInterface::XR_MONO | XRInterface::XR_VR | XRInterface::XR_AR;
  189. };
  190. uint32_t WebXRInterfaceJS::get_view_count() {
  191. return godot_webxr_get_view_count();
  192. };
  193. bool WebXRInterfaceJS::is_initialized() const {
  194. return (initialized);
  195. };
  196. bool WebXRInterfaceJS::initialize() {
  197. XRServer *xr_server = XRServer::get_singleton();
  198. ERR_FAIL_NULL_V(xr_server, false);
  199. if (!initialized) {
  200. if (!godot_webxr_is_supported()) {
  201. return false;
  202. }
  203. if (requested_reference_space_types.size() == 0) {
  204. return false;
  205. }
  206. enabled_features.clear();
  207. // We must create a tracker for our head.
  208. head_transform.basis = Basis();
  209. head_transform.origin = Vector3();
  210. head_tracker.instantiate();
  211. head_tracker->set_tracker_type(XRServer::TRACKER_HEAD);
  212. head_tracker->set_tracker_name("head");
  213. head_tracker->set_tracker_desc("Players head");
  214. xr_server->add_tracker(head_tracker);
  215. // Make this our primary interface.
  216. xr_server->set_primary_interface(this);
  217. // Clear render_targetsize to make sure it gets reset to the new size.
  218. // Clearing in uninitialize() doesn't work because a frame can still be
  219. // rendered after it's called, which will fill render_targetsize again.
  220. render_targetsize.width = 0;
  221. render_targetsize.height = 0;
  222. initialized = true;
  223. godot_webxr_initialize(
  224. session_mode.utf8().get_data(),
  225. required_features.utf8().get_data(),
  226. optional_features.utf8().get_data(),
  227. requested_reference_space_types.utf8().get_data(),
  228. &_emwebxr_on_session_started,
  229. &_emwebxr_on_session_ended,
  230. &_emwebxr_on_session_failed,
  231. &_emwebxr_on_input_event,
  232. &_emwebxr_on_simple_event);
  233. };
  234. return true;
  235. };
  236. void WebXRInterfaceJS::uninitialize() {
  237. if (initialized) {
  238. XRServer *xr_server = XRServer::get_singleton();
  239. if (xr_server != nullptr) {
  240. if (head_tracker.is_valid()) {
  241. xr_server->remove_tracker(head_tracker);
  242. head_tracker.unref();
  243. }
  244. for (int i = 0; i < HAND_MAX; i++) {
  245. if (hand_trackers[i].is_valid()) {
  246. xr_server->remove_tracker(hand_trackers[i]);
  247. hand_trackers[i].unref();
  248. }
  249. }
  250. if (xr_server->get_primary_interface() == this) {
  251. // no longer our primary interface
  252. xr_server->set_primary_interface(nullptr);
  253. }
  254. }
  255. godot_webxr_uninitialize();
  256. GLES3::TextureStorage *texture_storage = GLES3::TextureStorage::get_singleton();
  257. if (texture_storage != nullptr) {
  258. for (KeyValue<unsigned int, RID> &E : texture_cache) {
  259. // Forcibly mark as not part of a render target so we can free it.
  260. GLES3::Texture *texture = texture_storage->get_texture(E.value);
  261. texture->is_render_target = false;
  262. texture_storage->texture_free(E.value);
  263. }
  264. }
  265. texture_cache.clear();
  266. reference_space_type.clear();
  267. enabled_features.clear();
  268. initialized = false;
  269. };
  270. };
  271. Dictionary WebXRInterfaceJS::get_system_info() {
  272. Dictionary dict;
  273. // TODO get actual information from WebXR to return here
  274. dict[SNAME("XRRuntimeName")] = String("WebXR");
  275. dict[SNAME("XRRuntimeVersion")] = String("");
  276. return dict;
  277. }
  278. Transform3D WebXRInterfaceJS::_js_matrix_to_transform(float *p_js_matrix) {
  279. Transform3D transform;
  280. transform.basis.rows[0].x = p_js_matrix[0];
  281. transform.basis.rows[1].x = p_js_matrix[1];
  282. transform.basis.rows[2].x = p_js_matrix[2];
  283. transform.basis.rows[0].y = p_js_matrix[4];
  284. transform.basis.rows[1].y = p_js_matrix[5];
  285. transform.basis.rows[2].y = p_js_matrix[6];
  286. transform.basis.rows[0].z = p_js_matrix[8];
  287. transform.basis.rows[1].z = p_js_matrix[9];
  288. transform.basis.rows[2].z = p_js_matrix[10];
  289. transform.origin.x = p_js_matrix[12];
  290. transform.origin.y = p_js_matrix[13];
  291. transform.origin.z = p_js_matrix[14];
  292. return transform;
  293. }
  294. Size2 WebXRInterfaceJS::get_render_target_size() {
  295. if (render_targetsize.width != 0 && render_targetsize.height != 0) {
  296. return render_targetsize;
  297. }
  298. int js_size[2];
  299. bool has_size = godot_webxr_get_render_target_size(js_size);
  300. if (!initialized || !has_size) {
  301. // As a temporary default (until WebXR is fully initialized), use the
  302. // window size.
  303. return DisplayServer::get_singleton()->window_get_size();
  304. }
  305. render_targetsize.width = (float)js_size[0];
  306. render_targetsize.height = (float)js_size[1];
  307. return render_targetsize;
  308. };
  309. Transform3D WebXRInterfaceJS::get_camera_transform() {
  310. Transform3D camera_transform;
  311. XRServer *xr_server = XRServer::get_singleton();
  312. ERR_FAIL_NULL_V(xr_server, camera_transform);
  313. if (initialized) {
  314. double world_scale = xr_server->get_world_scale();
  315. Transform3D _head_transform = head_transform;
  316. _head_transform.origin *= world_scale;
  317. camera_transform = (xr_server->get_reference_frame()) * _head_transform;
  318. }
  319. return camera_transform;
  320. };
  321. Transform3D WebXRInterfaceJS::get_transform_for_view(uint32_t p_view, const Transform3D &p_cam_transform) {
  322. XRServer *xr_server = XRServer::get_singleton();
  323. ERR_FAIL_NULL_V(xr_server, p_cam_transform);
  324. ERR_FAIL_COND_V(!initialized, p_cam_transform);
  325. float js_matrix[16];
  326. bool has_transform = godot_webxr_get_transform_for_view(p_view, js_matrix);
  327. if (!has_transform) {
  328. return p_cam_transform;
  329. }
  330. Transform3D transform_for_view = _js_matrix_to_transform(js_matrix);
  331. double world_scale = xr_server->get_world_scale();
  332. transform_for_view.origin *= world_scale;
  333. return p_cam_transform * xr_server->get_reference_frame() * transform_for_view;
  334. };
  335. Projection WebXRInterfaceJS::get_projection_for_view(uint32_t p_view, double p_aspect, double p_z_near, double p_z_far) {
  336. Projection view;
  337. ERR_FAIL_COND_V(!initialized, view);
  338. float js_matrix[16];
  339. bool has_projection = godot_webxr_get_projection_for_view(p_view, js_matrix);
  340. if (!has_projection) {
  341. return view;
  342. }
  343. int k = 0;
  344. for (int i = 0; i < 4; i++) {
  345. for (int j = 0; j < 4; j++) {
  346. view.columns[i][j] = js_matrix[k++];
  347. }
  348. }
  349. // Copied from godot_oculus_mobile's ovr_mobile_session.cpp
  350. view.columns[2][2] = -(p_z_far + p_z_near) / (p_z_far - p_z_near);
  351. view.columns[3][2] = -(2.0f * p_z_far * p_z_near) / (p_z_far - p_z_near);
  352. return view;
  353. }
  354. bool WebXRInterfaceJS::pre_draw_viewport(RID p_render_target) {
  355. GLES3::TextureStorage *texture_storage = GLES3::TextureStorage::get_singleton();
  356. if (texture_storage == nullptr) {
  357. return false;
  358. }
  359. // Cache the resources so we don't have to get them from JS twice.
  360. color_texture = _get_color_texture();
  361. depth_texture = _get_depth_texture();
  362. // Per the WebXR spec, it returns "opaque textures" to us, which may be the
  363. // same WebGLTexture object (which would be the same GLuint in C++) but
  364. // represent a different underlying resource (probably the next texture in
  365. // the XR device's swap chain). In order to render to this texture, we need
  366. // to re-attach it to the FBO, otherwise we get an "incomplete FBO" error.
  367. //
  368. // See: https://immersive-web.github.io/layers/#xropaquetextures
  369. //
  370. // So, even if the color and depth textures have the same GLuint as the last
  371. // frame, we need to re-attach them again.
  372. texture_storage->render_target_set_reattach_textures(p_render_target, true);
  373. return true;
  374. }
  375. Vector<BlitToScreen> WebXRInterfaceJS::post_draw_viewport(RID p_render_target, const Rect2 &p_screen_rect) {
  376. Vector<BlitToScreen> blit_to_screen;
  377. GLES3::TextureStorage *texture_storage = GLES3::TextureStorage::get_singleton();
  378. if (texture_storage == nullptr) {
  379. return blit_to_screen;
  380. }
  381. texture_storage->render_target_set_reattach_textures(p_render_target, false);
  382. return blit_to_screen;
  383. };
  384. RID WebXRInterfaceJS::_get_color_texture() {
  385. unsigned int texture_id = godot_webxr_get_color_texture();
  386. if (texture_id == 0) {
  387. return RID();
  388. }
  389. return _get_texture(texture_id);
  390. }
  391. RID WebXRInterfaceJS::_get_depth_texture() {
  392. unsigned int texture_id = godot_webxr_get_depth_texture();
  393. if (texture_id == 0) {
  394. return RID();
  395. }
  396. return _get_texture(texture_id);
  397. }
  398. RID WebXRInterfaceJS::_get_texture(unsigned int p_texture_id) {
  399. RBMap<unsigned int, RID>::Element *cache = texture_cache.find(p_texture_id);
  400. if (cache != nullptr) {
  401. return cache->get();
  402. }
  403. GLES3::TextureStorage *texture_storage = GLES3::TextureStorage::get_singleton();
  404. if (texture_storage == nullptr) {
  405. return RID();
  406. }
  407. uint32_t view_count = godot_webxr_get_view_count();
  408. Size2 texture_size = get_render_target_size();
  409. RID texture = texture_storage->texture_create_external(
  410. view_count == 1 ? GLES3::Texture::TYPE_2D : GLES3::Texture::TYPE_LAYERED,
  411. Image::FORMAT_RGBA8,
  412. p_texture_id,
  413. (int)texture_size.width,
  414. (int)texture_size.height,
  415. 1,
  416. view_count);
  417. texture_cache.insert(p_texture_id, texture);
  418. return texture;
  419. }
  420. RID WebXRInterfaceJS::get_color_texture() {
  421. return color_texture;
  422. }
  423. RID WebXRInterfaceJS::get_depth_texture() {
  424. return depth_texture;
  425. }
  426. RID WebXRInterfaceJS::get_velocity_texture() {
  427. unsigned int texture_id = godot_webxr_get_velocity_texture();
  428. if (texture_id == 0) {
  429. return RID();
  430. }
  431. return _get_texture(texture_id);
  432. }
  433. void WebXRInterfaceJS::process() {
  434. if (initialized) {
  435. // Get the "head" position.
  436. float js_matrix[16];
  437. if (godot_webxr_get_transform_for_view(-1, js_matrix)) {
  438. head_transform = _js_matrix_to_transform(js_matrix);
  439. }
  440. if (head_tracker.is_valid()) {
  441. head_tracker->set_pose("default", head_transform, Vector3(), Vector3());
  442. }
  443. // Update all input sources.
  444. for (int i = 0; i < input_source_count; i++) {
  445. _update_input_source(i);
  446. }
  447. };
  448. };
  449. void WebXRInterfaceJS::_update_input_source(int p_input_source_id) {
  450. XRServer *xr_server = XRServer::get_singleton();
  451. ERR_FAIL_NULL(xr_server);
  452. InputSource &input_source = input_sources[p_input_source_id];
  453. float target_pose[16];
  454. int tmp_target_ray_mode;
  455. int touch_index;
  456. int has_grip_pose;
  457. float grip_pose[16];
  458. int has_standard_mapping;
  459. int button_count;
  460. float buttons[10];
  461. int axes_count;
  462. float axes[10];
  463. int has_hand_data;
  464. float hand_joints[WEBXR_HAND_JOINT_MAX * 16];
  465. float hand_radii[WEBXR_HAND_JOINT_MAX];
  466. input_source.active = godot_webxr_update_input_source(
  467. p_input_source_id,
  468. target_pose,
  469. &tmp_target_ray_mode,
  470. &touch_index,
  471. &has_grip_pose,
  472. grip_pose,
  473. &has_standard_mapping,
  474. &button_count,
  475. buttons,
  476. &axes_count,
  477. axes,
  478. &has_hand_data,
  479. hand_joints,
  480. hand_radii);
  481. if (!input_source.active) {
  482. if (input_source.tracker.is_valid()) {
  483. xr_server->remove_tracker(input_source.tracker);
  484. input_source.tracker.unref();
  485. }
  486. return;
  487. }
  488. input_source.target_ray_mode = (WebXRInterface::TargetRayMode)tmp_target_ray_mode;
  489. input_source.touch_index = touch_index;
  490. Ref<XRControllerTracker> &tracker = input_source.tracker;
  491. if (tracker.is_null()) {
  492. tracker.instantiate();
  493. StringName tracker_name;
  494. if (input_source.target_ray_mode == WebXRInterface::TargetRayMode::TARGET_RAY_MODE_SCREEN) {
  495. tracker_name = touch_names[touch_index];
  496. } else {
  497. tracker_name = tracker_names[p_input_source_id];
  498. }
  499. // Input source id's 0 and 1 are always the left and right hands.
  500. if (p_input_source_id < 2) {
  501. tracker->set_tracker_name(tracker_name);
  502. tracker->set_tracker_desc(p_input_source_id == 0 ? "Left hand controller" : "Right hand controller");
  503. tracker->set_tracker_hand(p_input_source_id == 0 ? XRPositionalTracker::TRACKER_HAND_LEFT : XRPositionalTracker::TRACKER_HAND_RIGHT);
  504. } else {
  505. tracker->set_tracker_name(tracker_name);
  506. tracker->set_tracker_desc(tracker_name);
  507. }
  508. xr_server->add_tracker(tracker);
  509. }
  510. Transform3D aim_transform = _js_matrix_to_transform(target_pose);
  511. tracker->set_pose(SceneStringName(default_), aim_transform, Vector3(), Vector3());
  512. tracker->set_pose(SNAME("aim"), aim_transform, Vector3(), Vector3());
  513. if (has_grip_pose) {
  514. tracker->set_pose(SNAME("grip"), _js_matrix_to_transform(grip_pose), Vector3(), Vector3());
  515. }
  516. for (int i = 0; i < button_count; i++) {
  517. StringName button_name = has_standard_mapping ? standard_button_names[i] : unknown_button_names[i];
  518. StringName button_pressure_name = has_standard_mapping ? standard_button_pressure_names[i] : unknown_button_pressure_names[i];
  519. float value = buttons[i];
  520. bool state = value > 0.0;
  521. tracker->set_input(button_name, state);
  522. tracker->set_input(button_pressure_name, value);
  523. }
  524. for (int i = 0; i < axes_count; i++) {
  525. StringName axis_name = has_standard_mapping ? standard_axis_names[i] : unknown_axis_names[i];
  526. float value = axes[i];
  527. if (has_standard_mapping && (i == 1 || i == 3)) {
  528. // Invert the Y-axis on thumbsticks and trackpads, in order to
  529. // match OpenXR and other XR platform SDKs.
  530. value = -value;
  531. }
  532. tracker->set_input(axis_name, value);
  533. }
  534. // Also create Vector2's for the thumbstick and trackpad when we have the
  535. // standard mapping.
  536. if (has_standard_mapping) {
  537. if (axes_count >= 2) {
  538. tracker->set_input(standard_vector_names[0], Vector2(axes[0], -axes[1]));
  539. }
  540. if (axes_count >= 4) {
  541. tracker->set_input(standard_vector_names[1], Vector2(axes[2], -axes[3]));
  542. }
  543. }
  544. if (input_source.target_ray_mode == WebXRInterface::TARGET_RAY_MODE_SCREEN) {
  545. if (touch_index < 5 && axes_count >= 2) {
  546. Vector2 joy_vector = Vector2(axes[0], axes[1]);
  547. Vector2 position = _get_screen_position_from_joy_vector(joy_vector);
  548. if (touches[touch_index].is_touching) {
  549. Vector2 delta = position - touches[touch_index].position;
  550. // If position has changed by at least 1 pixel, generate a drag event.
  551. if (abs(delta.x) >= 1.0 || abs(delta.y) >= 1.0) {
  552. Ref<InputEventScreenDrag> event;
  553. event.instantiate();
  554. event->set_index(touch_index);
  555. event->set_position(position);
  556. event->set_relative(delta);
  557. event->set_relative_screen_position(delta);
  558. Input::get_singleton()->parse_input_event(event);
  559. }
  560. }
  561. touches[touch_index].position = position;
  562. }
  563. }
  564. if (p_input_source_id < 2) {
  565. Ref<XRHandTracker> hand_tracker = hand_trackers[p_input_source_id];
  566. if (has_hand_data) {
  567. // Transform orientations to match Godot Humanoid skeleton.
  568. const Basis bone_adjustment(
  569. Vector3(-1.0, 0.0, 0.0),
  570. Vector3(0.0, 0.0, -1.0),
  571. Vector3(0.0, -1.0, 0.0));
  572. if (unlikely(hand_tracker.is_null())) {
  573. hand_tracker.instantiate();
  574. hand_tracker->set_tracker_hand(p_input_source_id == 0 ? XRPositionalTracker::TRACKER_HAND_LEFT : XRPositionalTracker::TRACKER_HAND_RIGHT);
  575. hand_tracker->set_tracker_name(p_input_source_id == 0 ? "/user/hand_tracker/left" : "/user/hand_tracker/right");
  576. // These flags always apply, since WebXR doesn't give us enough insight to be more fine grained.
  577. BitField<XRHandTracker::HandJointFlags> joint_flags(XRHandTracker::HAND_JOINT_FLAG_POSITION_VALID | XRHandTracker::HAND_JOINT_FLAG_ORIENTATION_VALID | XRHandTracker::HAND_JOINT_FLAG_POSITION_TRACKED | XRHandTracker::HAND_JOINT_FLAG_ORIENTATION_TRACKED);
  578. for (int godot_joint = 0; godot_joint < XRHandTracker::HAND_JOINT_MAX; godot_joint++) {
  579. hand_tracker->set_hand_joint_flags((XRHandTracker::HandJoint)godot_joint, joint_flags);
  580. }
  581. hand_trackers[p_input_source_id] = hand_tracker;
  582. xr_server->add_tracker(hand_tracker);
  583. }
  584. hand_tracker->set_has_tracking_data(true);
  585. for (int webxr_joint = 0; webxr_joint < WEBXR_HAND_JOINT_MAX; webxr_joint++) {
  586. XRHandTracker::HandJoint godot_joint = (XRHandTracker::HandJoint)(webxr_joint + 1);
  587. Transform3D joint_transform = _js_matrix_to_transform(hand_joints + (16 * webxr_joint));
  588. joint_transform.basis *= bone_adjustment;
  589. hand_tracker->set_hand_joint_transform(godot_joint, joint_transform);
  590. hand_tracker->set_hand_joint_radius(godot_joint, hand_radii[webxr_joint]);
  591. }
  592. // WebXR doesn't have a palm joint, so we calculate it by finding the middle of the middle finger metacarpal bone.
  593. {
  594. // Start by getting the middle finger metacarpal joint.
  595. // Note: 10 is the WebXR middle finger metacarpal joint.
  596. Transform3D palm_transform = _js_matrix_to_transform(hand_joints + (10 * 16));
  597. palm_transform.basis *= bone_adjustment;
  598. // Get the middle finger phalanx position.
  599. // Note: 11 is the WebXR middle finger phalanx proximal joint and 12 is the origin offset.
  600. const float *phalanx_pos = hand_joints + (11 * 16) + 12;
  601. Vector3 phalanx(phalanx_pos[0], phalanx_pos[1], phalanx_pos[2]);
  602. // Offset the palm half-way towards the phalanx joint.
  603. palm_transform.origin = (palm_transform.origin + phalanx) / 2.0;
  604. // Set the palm joint and the pose.
  605. hand_tracker->set_hand_joint_transform(XRHandTracker::HAND_JOINT_PALM, palm_transform);
  606. hand_tracker->set_pose("default", palm_transform, Vector3(), Vector3());
  607. }
  608. } else if (hand_tracker.is_valid()) {
  609. hand_tracker->set_has_tracking_data(false);
  610. hand_tracker->invalidate_pose("default");
  611. }
  612. }
  613. }
  614. void WebXRInterfaceJS::_on_input_event(int p_event_type, int p_input_source_id) {
  615. // Get the latest data for this input source. For transient input sources,
  616. // we may not have any data at all yet!
  617. _update_input_source(p_input_source_id);
  618. if (p_event_type == WEBXR_INPUT_EVENT_SELECTSTART || p_event_type == WEBXR_INPUT_EVENT_SELECTEND) {
  619. const InputSource &input_source = input_sources[p_input_source_id];
  620. if (input_source.target_ray_mode == WebXRInterface::TARGET_RAY_MODE_SCREEN) {
  621. int touch_index = input_source.touch_index;
  622. if (touch_index >= 0 && touch_index < 5) {
  623. touches[touch_index].is_touching = (p_event_type == WEBXR_INPUT_EVENT_SELECTSTART);
  624. Ref<InputEventScreenTouch> event;
  625. event.instantiate();
  626. event->set_index(touch_index);
  627. event->set_position(touches[touch_index].position);
  628. event->set_pressed(p_event_type == WEBXR_INPUT_EVENT_SELECTSTART);
  629. Input::get_singleton()->parse_input_event(event);
  630. }
  631. }
  632. }
  633. switch (p_event_type) {
  634. case WEBXR_INPUT_EVENT_SELECTSTART:
  635. emit_signal("selectstart", p_input_source_id);
  636. break;
  637. case WEBXR_INPUT_EVENT_SELECTEND:
  638. emit_signal("selectend", p_input_source_id);
  639. // Emit the 'select' event on our own (rather than intercepting the
  640. // one from JavaScript) so that we don't have to needlessly call
  641. // _update_input_source() a second time.
  642. emit_signal("select", p_input_source_id);
  643. break;
  644. case WEBXR_INPUT_EVENT_SQUEEZESTART:
  645. emit_signal("squeezestart", p_input_source_id);
  646. break;
  647. case WEBXR_INPUT_EVENT_SQUEEZEEND:
  648. emit_signal("squeezeend", p_input_source_id);
  649. // Again, we emit the 'squeeze' event on our own to avoid extra work.
  650. emit_signal("squeeze", p_input_source_id);
  651. break;
  652. }
  653. }
  654. Vector2 WebXRInterfaceJS::_get_screen_position_from_joy_vector(const Vector2 &p_joy_vector) {
  655. SceneTree *scene_tree = Object::cast_to<SceneTree>(OS::get_singleton()->get_main_loop());
  656. if (!scene_tree) {
  657. return Vector2();
  658. }
  659. Window *viewport = scene_tree->get_root();
  660. Vector2 position_percentage((p_joy_vector.x + 1.0f) / 2.0f, ((p_joy_vector.y) + 1.0f) / 2.0f);
  661. Vector2 position = (Size2)viewport->get_size() * position_percentage;
  662. return position;
  663. }
  664. WebXRInterfaceJS::WebXRInterfaceJS() {
  665. initialized = false;
  666. session_mode = "inline";
  667. requested_reference_space_types = "local";
  668. };
  669. WebXRInterfaceJS::~WebXRInterfaceJS() {
  670. // and make sure we cleanup if we haven't already
  671. if (initialized) {
  672. uninitialize();
  673. };
  674. };
  675. #endif // WEB_ENABLED