openxr_interface.cpp 46 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336
  1. /**************************************************************************/
  2. /* openxr_interface.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 "openxr_interface.h"
  31. #include "core/io/resource_loader.h"
  32. #include "core/io/resource_saver.h"
  33. #include "servers/rendering/rendering_server_globals.h"
  34. #include "extensions/openxr_eye_gaze_interaction.h"
  35. void OpenXRInterface::_bind_methods() {
  36. // lifecycle signals
  37. ADD_SIGNAL(MethodInfo("session_begun"));
  38. ADD_SIGNAL(MethodInfo("session_stopping"));
  39. ADD_SIGNAL(MethodInfo("session_focussed"));
  40. ADD_SIGNAL(MethodInfo("session_visible"));
  41. ADD_SIGNAL(MethodInfo("pose_recentered"));
  42. // Display refresh rate
  43. ClassDB::bind_method(D_METHOD("get_display_refresh_rate"), &OpenXRInterface::get_display_refresh_rate);
  44. ClassDB::bind_method(D_METHOD("set_display_refresh_rate", "refresh_rate"), &OpenXRInterface::set_display_refresh_rate);
  45. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "display_refresh_rate"), "set_display_refresh_rate", "get_display_refresh_rate");
  46. // Render Target size multiplier
  47. ClassDB::bind_method(D_METHOD("get_render_target_size_multiplier"), &OpenXRInterface::get_render_target_size_multiplier);
  48. ClassDB::bind_method(D_METHOD("set_render_target_size_multiplier", "multiplier"), &OpenXRInterface::set_render_target_size_multiplier);
  49. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "render_target_size_multiplier"), "set_render_target_size_multiplier", "get_render_target_size_multiplier");
  50. // Foveation level
  51. ClassDB::bind_method(D_METHOD("is_foveation_supported"), &OpenXRInterface::is_foveation_supported);
  52. ClassDB::bind_method(D_METHOD("get_foveation_level"), &OpenXRInterface::get_foveation_level);
  53. ClassDB::bind_method(D_METHOD("set_foveation_level", "foveation_level"), &OpenXRInterface::set_foveation_level);
  54. ADD_PROPERTY(PropertyInfo(Variant::INT, "foveation_level"), "set_foveation_level", "get_foveation_level");
  55. ClassDB::bind_method(D_METHOD("get_foveation_dynamic"), &OpenXRInterface::get_foveation_dynamic);
  56. ClassDB::bind_method(D_METHOD("set_foveation_dynamic", "foveation_dynamic"), &OpenXRInterface::set_foveation_dynamic);
  57. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "foveation_dynamic"), "set_foveation_dynamic", "get_foveation_dynamic");
  58. // Action sets
  59. ClassDB::bind_method(D_METHOD("is_action_set_active", "name"), &OpenXRInterface::is_action_set_active);
  60. ClassDB::bind_method(D_METHOD("set_action_set_active", "name", "active"), &OpenXRInterface::set_action_set_active);
  61. ClassDB::bind_method(D_METHOD("get_action_sets"), &OpenXRInterface::get_action_sets);
  62. // Refresh rates
  63. ClassDB::bind_method(D_METHOD("get_available_display_refresh_rates"), &OpenXRInterface::get_available_display_refresh_rates);
  64. // Hand tracking.
  65. ClassDB::bind_method(D_METHOD("set_motion_range", "hand", "motion_range"), &OpenXRInterface::set_motion_range);
  66. ClassDB::bind_method(D_METHOD("get_motion_range", "hand"), &OpenXRInterface::get_motion_range);
  67. ClassDB::bind_method(D_METHOD("get_hand_joint_flags", "hand", "joint"), &OpenXRInterface::get_hand_joint_flags);
  68. ClassDB::bind_method(D_METHOD("get_hand_joint_rotation", "hand", "joint"), &OpenXRInterface::get_hand_joint_rotation);
  69. ClassDB::bind_method(D_METHOD("get_hand_joint_position", "hand", "joint"), &OpenXRInterface::get_hand_joint_position);
  70. ClassDB::bind_method(D_METHOD("get_hand_joint_radius", "hand", "joint"), &OpenXRInterface::get_hand_joint_radius);
  71. ClassDB::bind_method(D_METHOD("get_hand_joint_linear_velocity", "hand", "joint"), &OpenXRInterface::get_hand_joint_linear_velocity);
  72. ClassDB::bind_method(D_METHOD("get_hand_joint_angular_velocity", "hand", "joint"), &OpenXRInterface::get_hand_joint_angular_velocity);
  73. ClassDB::bind_method(D_METHOD("is_hand_tracking_supported"), &OpenXRInterface::is_hand_tracking_supported);
  74. ClassDB::bind_method(D_METHOD("is_eye_gaze_interaction_supported"), &OpenXRInterface::is_eye_gaze_interaction_supported);
  75. BIND_ENUM_CONSTANT(HAND_LEFT);
  76. BIND_ENUM_CONSTANT(HAND_RIGHT);
  77. BIND_ENUM_CONSTANT(HAND_MAX);
  78. BIND_ENUM_CONSTANT(HAND_MOTION_RANGE_UNOBSTRUCTED);
  79. BIND_ENUM_CONSTANT(HAND_MOTION_RANGE_CONFORM_TO_CONTROLLER);
  80. BIND_ENUM_CONSTANT(HAND_MOTION_RANGE_MAX);
  81. BIND_ENUM_CONSTANT(HAND_JOINT_PALM);
  82. BIND_ENUM_CONSTANT(HAND_JOINT_WRIST);
  83. BIND_ENUM_CONSTANT(HAND_JOINT_THUMB_METACARPAL);
  84. BIND_ENUM_CONSTANT(HAND_JOINT_THUMB_PROXIMAL);
  85. BIND_ENUM_CONSTANT(HAND_JOINT_THUMB_DISTAL);
  86. BIND_ENUM_CONSTANT(HAND_JOINT_THUMB_TIP);
  87. BIND_ENUM_CONSTANT(HAND_JOINT_INDEX_METACARPAL);
  88. BIND_ENUM_CONSTANT(HAND_JOINT_INDEX_PROXIMAL);
  89. BIND_ENUM_CONSTANT(HAND_JOINT_INDEX_INTERMEDIATE);
  90. BIND_ENUM_CONSTANT(HAND_JOINT_INDEX_DISTAL);
  91. BIND_ENUM_CONSTANT(HAND_JOINT_INDEX_TIP);
  92. BIND_ENUM_CONSTANT(HAND_JOINT_MIDDLE_METACARPAL);
  93. BIND_ENUM_CONSTANT(HAND_JOINT_MIDDLE_PROXIMAL);
  94. BIND_ENUM_CONSTANT(HAND_JOINT_MIDDLE_INTERMEDIATE);
  95. BIND_ENUM_CONSTANT(HAND_JOINT_MIDDLE_DISTAL);
  96. BIND_ENUM_CONSTANT(HAND_JOINT_MIDDLE_TIP);
  97. BIND_ENUM_CONSTANT(HAND_JOINT_RING_METACARPAL);
  98. BIND_ENUM_CONSTANT(HAND_JOINT_RING_PROXIMAL);
  99. BIND_ENUM_CONSTANT(HAND_JOINT_RING_INTERMEDIATE);
  100. BIND_ENUM_CONSTANT(HAND_JOINT_RING_DISTAL);
  101. BIND_ENUM_CONSTANT(HAND_JOINT_RING_TIP);
  102. BIND_ENUM_CONSTANT(HAND_JOINT_LITTLE_METACARPAL);
  103. BIND_ENUM_CONSTANT(HAND_JOINT_LITTLE_PROXIMAL);
  104. BIND_ENUM_CONSTANT(HAND_JOINT_LITTLE_INTERMEDIATE);
  105. BIND_ENUM_CONSTANT(HAND_JOINT_LITTLE_DISTAL);
  106. BIND_ENUM_CONSTANT(HAND_JOINT_LITTLE_TIP);
  107. BIND_ENUM_CONSTANT(HAND_JOINT_MAX);
  108. BIND_BITFIELD_FLAG(HAND_JOINT_NONE);
  109. BIND_BITFIELD_FLAG(HAND_JOINT_ORIENTATION_VALID);
  110. BIND_BITFIELD_FLAG(HAND_JOINT_ORIENTATION_TRACKED);
  111. BIND_BITFIELD_FLAG(HAND_JOINT_POSITION_VALID);
  112. BIND_BITFIELD_FLAG(HAND_JOINT_POSITION_TRACKED);
  113. BIND_BITFIELD_FLAG(HAND_JOINT_LINEAR_VELOCITY_VALID);
  114. BIND_BITFIELD_FLAG(HAND_JOINT_ANGULAR_VELOCITY_VALID);
  115. }
  116. StringName OpenXRInterface::get_name() const {
  117. return StringName("OpenXR");
  118. };
  119. uint32_t OpenXRInterface::get_capabilities() const {
  120. return XRInterface::XR_VR + XRInterface::XR_STEREO;
  121. };
  122. PackedStringArray OpenXRInterface::get_suggested_tracker_names() const {
  123. // These are hardcoded in OpenXR, note that they will only be available if added to our action map
  124. PackedStringArray arr = {
  125. "left_hand", // /user/hand/left is mapped to our defaults
  126. "right_hand", // /user/hand/right is mapped to our defaults
  127. "/user/treadmill",
  128. // Even though these are only available if you have the tracker extension,
  129. // we add these as we may be deploying on a different platform than our
  130. // editor is running on.
  131. "/user/vive_tracker_htcx/role/handheld_object",
  132. "/user/vive_tracker_htcx/role/left_foot",
  133. "/user/vive_tracker_htcx/role/right_foot",
  134. "/user/vive_tracker_htcx/role/left_shoulder",
  135. "/user/vive_tracker_htcx/role/right_shoulder",
  136. "/user/vive_tracker_htcx/role/left_elbow",
  137. "/user/vive_tracker_htcx/role/right_elbow",
  138. "/user/vive_tracker_htcx/role/left_knee",
  139. "/user/vive_tracker_htcx/role/right_knee",
  140. "/user/vive_tracker_htcx/role/waist",
  141. "/user/vive_tracker_htcx/role/chest",
  142. "/user/vive_tracker_htcx/role/camera",
  143. "/user/vive_tracker_htcx/role/keyboard",
  144. "/user/eyes_ext",
  145. };
  146. return arr;
  147. }
  148. XRInterface::TrackingStatus OpenXRInterface::get_tracking_status() const {
  149. return tracking_state;
  150. }
  151. void OpenXRInterface::_load_action_map() {
  152. ERR_FAIL_NULL(openxr_api);
  153. // This may seem a bit duplicitous to a little bit of background info here.
  154. // OpenXRActionMap (with all its sub resource classes) is a class that allows us to configure and store an action map in.
  155. // This gives the user the ability to edit the action map in a UI and customize the actions.
  156. // OpenXR however requires us to submit an action map and it takes over from that point and we can no longer change it.
  157. // This system does that push and we store the info needed to then work with this action map going forward.
  158. // Within our openxr device we maintain a number of classes that wrap the relevant OpenXR objects for this.
  159. // Within OpenXRInterface we have a few internal classes that keep track of what we've created.
  160. // This allow us to process the relevant actions each frame.
  161. // just in case clean up
  162. free_trackers();
  163. free_interaction_profiles();
  164. free_action_sets();
  165. Ref<OpenXRActionMap> action_map;
  166. if (Engine::get_singleton()->is_editor_hint()) {
  167. #ifdef TOOLS_ENABLED
  168. action_map.instantiate();
  169. action_map->create_editor_action_sets();
  170. #endif
  171. } else {
  172. String default_tres_name = openxr_api->get_default_action_map_resource_name();
  173. // Check if we can load our default
  174. if (ResourceLoader::exists(default_tres_name)) {
  175. action_map = ResourceLoader::load(default_tres_name);
  176. }
  177. // Check if we need to create default action set
  178. if (action_map.is_null()) {
  179. action_map.instantiate();
  180. action_map->create_default_action_sets();
  181. #ifdef TOOLS_ENABLED
  182. // Save our action sets so our user can
  183. action_map->set_path(default_tres_name, true);
  184. ResourceSaver::save(action_map, default_tres_name);
  185. #endif
  186. }
  187. }
  188. // process our action map
  189. if (action_map.is_valid()) {
  190. HashMap<Ref<OpenXRAction>, Action *> xr_actions;
  191. Array action_set_array = action_map->get_action_sets();
  192. for (int i = 0; i < action_set_array.size(); i++) {
  193. // Create our action set
  194. Ref<OpenXRActionSet> xr_action_set = action_set_array[i];
  195. ActionSet *action_set = create_action_set(xr_action_set->get_name(), xr_action_set->get_localized_name(), xr_action_set->get_priority());
  196. if (!action_set) {
  197. continue;
  198. }
  199. // Now create our actions for these
  200. Array actions = xr_action_set->get_actions();
  201. for (int j = 0; j < actions.size(); j++) {
  202. Ref<OpenXRAction> xr_action = actions[j];
  203. PackedStringArray toplevel_paths = xr_action->get_toplevel_paths();
  204. Vector<Tracker *> trackers_for_action;
  205. for (int k = 0; k < toplevel_paths.size(); k++) {
  206. // Only check for our tracker if our path is supported.
  207. if (openxr_api->is_top_level_path_supported(toplevel_paths[k])) {
  208. Tracker *tracker = find_tracker(toplevel_paths[k], true);
  209. if (tracker) {
  210. trackers_for_action.push_back(tracker);
  211. }
  212. }
  213. }
  214. // Only add our action if we have at least one valid toplevel path
  215. if (trackers_for_action.size() > 0) {
  216. Action *action = create_action(action_set, xr_action->get_name(), xr_action->get_localized_name(), xr_action->get_action_type(), trackers_for_action);
  217. if (action) {
  218. // add this to our map for creating our interaction profiles
  219. xr_actions[xr_action] = action;
  220. }
  221. }
  222. }
  223. }
  224. // now do our suggestions
  225. Array interaction_profile_array = action_map->get_interaction_profiles();
  226. for (int i = 0; i < interaction_profile_array.size(); i++) {
  227. Ref<OpenXRInteractionProfile> xr_interaction_profile = interaction_profile_array[i];
  228. // Note, we can only have one entry per interaction profile so if it already exists we clear it out
  229. RID ip = openxr_api->interaction_profile_create(xr_interaction_profile->get_interaction_profile_path());
  230. if (ip.is_valid()) {
  231. openxr_api->interaction_profile_clear_bindings(ip);
  232. Array xr_bindings = xr_interaction_profile->get_bindings();
  233. for (int j = 0; j < xr_bindings.size(); j++) {
  234. Ref<OpenXRIPBinding> xr_binding = xr_bindings[j];
  235. Ref<OpenXRAction> xr_action = xr_binding->get_action();
  236. Action *action = nullptr;
  237. if (xr_actions.has(xr_action)) {
  238. action = xr_actions[xr_action];
  239. } else {
  240. print_line("Action ", xr_action->get_name(), " isn't part of an action set!");
  241. continue;
  242. }
  243. PackedStringArray paths = xr_binding->get_paths();
  244. for (int k = 0; k < paths.size(); k++) {
  245. openxr_api->interaction_profile_add_binding(ip, action->action_rid, paths[k]);
  246. }
  247. }
  248. // Now submit our suggestions
  249. openxr_api->interaction_profile_suggest_bindings(ip);
  250. // And record it in our array so we can clean it up later on
  251. if (interaction_profile_array.has(ip)) {
  252. interaction_profile_array.push_back(ip);
  253. }
  254. }
  255. }
  256. }
  257. }
  258. OpenXRInterface::ActionSet *OpenXRInterface::create_action_set(const String &p_action_set_name, const String &p_localized_name, const int p_priority) {
  259. ERR_FAIL_NULL_V(openxr_api, nullptr);
  260. // find if it already exists
  261. for (int i = 0; i < action_sets.size(); i++) {
  262. if (action_sets[i]->action_set_name == p_action_set_name) {
  263. // already exists in this set
  264. return nullptr;
  265. }
  266. }
  267. ActionSet *action_set = memnew(ActionSet);
  268. action_set->action_set_name = p_action_set_name;
  269. action_set->is_active = true;
  270. action_set->action_set_rid = openxr_api->action_set_create(p_action_set_name, p_localized_name, p_priority);
  271. action_sets.push_back(action_set);
  272. return action_set;
  273. }
  274. void OpenXRInterface::free_action_sets() {
  275. ERR_FAIL_NULL(openxr_api);
  276. for (int i = 0; i < action_sets.size(); i++) {
  277. ActionSet *action_set = action_sets[i];
  278. free_actions(action_set);
  279. openxr_api->action_set_free(action_set->action_set_rid);
  280. memfree(action_set);
  281. }
  282. action_sets.clear();
  283. }
  284. OpenXRInterface::Action *OpenXRInterface::create_action(ActionSet *p_action_set, const String &p_action_name, const String &p_localized_name, OpenXRAction::ActionType p_action_type, const Vector<Tracker *> p_trackers) {
  285. ERR_FAIL_NULL_V(openxr_api, nullptr);
  286. for (int i = 0; i < p_action_set->actions.size(); i++) {
  287. if (p_action_set->actions[i]->action_name == p_action_name) {
  288. // already exists in this set
  289. return nullptr;
  290. }
  291. }
  292. Vector<RID> tracker_rids;
  293. for (int i = 0; i < p_trackers.size(); i++) {
  294. tracker_rids.push_back(p_trackers[i]->tracker_rid);
  295. }
  296. Action *action = memnew(Action);
  297. if (p_action_type == OpenXRAction::OPENXR_ACTION_POSE) {
  298. // We can't have dual action names in OpenXR hence we added _pose,
  299. // but default, aim and grip and default pose action names in Godot so rename them on the tracker.
  300. // NOTE need to decide on whether we should keep the naming convention or rename it on Godots side
  301. if (p_action_name == "default_pose") {
  302. action->action_name = "default";
  303. } else if (p_action_name == "aim_pose") {
  304. action->action_name = "aim";
  305. } else if (p_action_name == "grip_pose") {
  306. action->action_name = "grip";
  307. } else {
  308. action->action_name = p_action_name;
  309. }
  310. } else {
  311. action->action_name = p_action_name;
  312. }
  313. action->action_type = p_action_type;
  314. action->action_rid = openxr_api->action_create(p_action_set->action_set_rid, p_action_name, p_localized_name, p_action_type, tracker_rids);
  315. p_action_set->actions.push_back(action);
  316. // we link our actions back to our trackers so we know which actions to check when we're processing our trackers
  317. for (int i = 0; i < p_trackers.size(); i++) {
  318. if (p_trackers[i]->actions.find(action) == -1) {
  319. p_trackers[i]->actions.push_back(action);
  320. }
  321. }
  322. return action;
  323. }
  324. OpenXRInterface::Action *OpenXRInterface::find_action(const String &p_action_name) {
  325. // We just find the first action by this name
  326. for (int i = 0; i < action_sets.size(); i++) {
  327. for (int j = 0; j < action_sets[i]->actions.size(); j++) {
  328. if (action_sets[i]->actions[j]->action_name == p_action_name) {
  329. return action_sets[i]->actions[j];
  330. }
  331. }
  332. }
  333. // not found
  334. return nullptr;
  335. }
  336. void OpenXRInterface::free_actions(ActionSet *p_action_set) {
  337. ERR_FAIL_NULL(openxr_api);
  338. for (int i = 0; i < p_action_set->actions.size(); i++) {
  339. Action *action = p_action_set->actions[i];
  340. openxr_api->action_free(action->action_rid);
  341. memdelete(action);
  342. }
  343. p_action_set->actions.clear();
  344. }
  345. OpenXRInterface::Tracker *OpenXRInterface::find_tracker(const String &p_tracker_name, bool p_create) {
  346. XRServer *xr_server = XRServer::get_singleton();
  347. ERR_FAIL_NULL_V(xr_server, nullptr);
  348. ERR_FAIL_NULL_V(openxr_api, nullptr);
  349. Tracker *tracker = nullptr;
  350. for (int i = 0; i < trackers.size(); i++) {
  351. tracker = trackers[i];
  352. if (tracker->tracker_name == p_tracker_name) {
  353. return tracker;
  354. }
  355. }
  356. if (!p_create) {
  357. return nullptr;
  358. }
  359. ERR_FAIL_COND_V(!openxr_api->is_top_level_path_supported(p_tracker_name), nullptr);
  360. // Create our RID
  361. RID tracker_rid = openxr_api->tracker_create(p_tracker_name);
  362. ERR_FAIL_COND_V(tracker_rid.is_null(), nullptr);
  363. // create our positional tracker
  364. Ref<XRPositionalTracker> positional_tracker;
  365. positional_tracker.instantiate();
  366. // We have standardized some names to make things nicer to the user so lets recognize the toplevel paths related to these.
  367. if (p_tracker_name == "/user/hand/left") {
  368. positional_tracker->set_tracker_type(XRServer::TRACKER_CONTROLLER);
  369. positional_tracker->set_tracker_name("left_hand");
  370. positional_tracker->set_tracker_desc("Left hand controller");
  371. positional_tracker->set_tracker_hand(XRPositionalTracker::TRACKER_HAND_LEFT);
  372. } else if (p_tracker_name == "/user/hand/right") {
  373. positional_tracker->set_tracker_type(XRServer::TRACKER_CONTROLLER);
  374. positional_tracker->set_tracker_name("right_hand");
  375. positional_tracker->set_tracker_desc("Right hand controller");
  376. positional_tracker->set_tracker_hand(XRPositionalTracker::TRACKER_HAND_RIGHT);
  377. } else {
  378. positional_tracker->set_tracker_type(XRServer::TRACKER_CONTROLLER);
  379. positional_tracker->set_tracker_name(p_tracker_name);
  380. positional_tracker->set_tracker_desc(p_tracker_name);
  381. }
  382. positional_tracker->set_tracker_profile(INTERACTION_PROFILE_NONE);
  383. xr_server->add_tracker(positional_tracker);
  384. // create a new entry
  385. tracker = memnew(Tracker);
  386. tracker->tracker_name = p_tracker_name;
  387. tracker->tracker_rid = tracker_rid;
  388. tracker->positional_tracker = positional_tracker;
  389. tracker->interaction_profile = RID();
  390. trackers.push_back(tracker);
  391. return tracker;
  392. }
  393. void OpenXRInterface::tracker_profile_changed(RID p_tracker, RID p_interaction_profile) {
  394. Tracker *tracker = nullptr;
  395. for (int i = 0; i < trackers.size() && tracker == nullptr; i++) {
  396. if (trackers[i]->tracker_rid == p_tracker) {
  397. tracker = trackers[i];
  398. }
  399. }
  400. ERR_FAIL_NULL(tracker);
  401. tracker->interaction_profile = p_interaction_profile;
  402. if (p_interaction_profile.is_null()) {
  403. print_verbose("OpenXR: Interaction profile for " + tracker->tracker_name + " changed to " + INTERACTION_PROFILE_NONE);
  404. tracker->positional_tracker->set_tracker_profile(INTERACTION_PROFILE_NONE);
  405. } else {
  406. String name = openxr_api->interaction_profile_get_name(p_interaction_profile);
  407. print_verbose("OpenXR: Interaction profile for " + tracker->tracker_name + " changed to " + name);
  408. tracker->positional_tracker->set_tracker_profile(name);
  409. }
  410. }
  411. void OpenXRInterface::handle_tracker(Tracker *p_tracker) {
  412. ERR_FAIL_NULL(openxr_api);
  413. ERR_FAIL_COND(p_tracker->positional_tracker.is_null());
  414. // Note, which actions are actually bound to inputs are handled by our interaction profiles however interaction
  415. // profiles are suggested bindings for controller types we know about. OpenXR runtimes can stray away from these
  416. // and rebind them or even offer bindings to controllers that are not known to us.
  417. // We don't really have a consistent way to detect whether a controller is active however as long as it is
  418. // unbound it seems to be unavailable, so far unknown controller seem to mimic one of the profiles we've
  419. // supplied.
  420. if (p_tracker->interaction_profile.is_null()) {
  421. return;
  422. }
  423. // We check all actions that are related to our tracker.
  424. for (int i = 0; i < p_tracker->actions.size(); i++) {
  425. Action *action = p_tracker->actions[i];
  426. switch (action->action_type) {
  427. case OpenXRAction::OPENXR_ACTION_BOOL: {
  428. bool pressed = openxr_api->get_action_bool(action->action_rid, p_tracker->tracker_rid);
  429. p_tracker->positional_tracker->set_input(action->action_name, Variant(pressed));
  430. } break;
  431. case OpenXRAction::OPENXR_ACTION_FLOAT: {
  432. real_t value = openxr_api->get_action_float(action->action_rid, p_tracker->tracker_rid);
  433. p_tracker->positional_tracker->set_input(action->action_name, Variant(value));
  434. } break;
  435. case OpenXRAction::OPENXR_ACTION_VECTOR2: {
  436. Vector2 value = openxr_api->get_action_vector2(action->action_rid, p_tracker->tracker_rid);
  437. p_tracker->positional_tracker->set_input(action->action_name, Variant(value));
  438. } break;
  439. case OpenXRAction::OPENXR_ACTION_POSE: {
  440. Transform3D transform;
  441. Vector3 linear, angular;
  442. XRPose::TrackingConfidence confidence = openxr_api->get_action_pose(action->action_rid, p_tracker->tracker_rid, transform, linear, angular);
  443. if (confidence != XRPose::XR_TRACKING_CONFIDENCE_NONE) {
  444. p_tracker->positional_tracker->set_pose(action->action_name, transform, linear, angular, confidence);
  445. } else {
  446. p_tracker->positional_tracker->invalidate_pose(action->action_name);
  447. }
  448. } break;
  449. default: {
  450. // not yet supported
  451. } break;
  452. }
  453. }
  454. }
  455. void OpenXRInterface::trigger_haptic_pulse(const String &p_action_name, const StringName &p_tracker_name, double p_frequency, double p_amplitude, double p_duration_sec, double p_delay_sec) {
  456. ERR_FAIL_NULL(openxr_api);
  457. Action *action = find_action(p_action_name);
  458. ERR_FAIL_NULL(action);
  459. // We need to map our tracker name to our OpenXR name for our inbuild names.
  460. String tracker_name = p_tracker_name;
  461. if (tracker_name == "left_hand") {
  462. tracker_name = "/user/hand/left";
  463. } else if (tracker_name == "right_hand") {
  464. tracker_name = "/user/hand/right";
  465. }
  466. Tracker *tracker = find_tracker(tracker_name);
  467. ERR_FAIL_NULL(tracker);
  468. // TODO OpenXR does not support delay, so we may need to add support for that somehow...
  469. XrDuration duration = XrDuration(p_duration_sec * 1000000000.0); // seconds -> nanoseconds
  470. openxr_api->trigger_haptic_pulse(action->action_rid, tracker->tracker_rid, p_frequency, p_amplitude, duration);
  471. }
  472. void OpenXRInterface::free_trackers() {
  473. XRServer *xr_server = XRServer::get_singleton();
  474. ERR_FAIL_NULL(xr_server);
  475. ERR_FAIL_NULL(openxr_api);
  476. for (int i = 0; i < trackers.size(); i++) {
  477. Tracker *tracker = trackers[i];
  478. openxr_api->tracker_free(tracker->tracker_rid);
  479. xr_server->remove_tracker(tracker->positional_tracker);
  480. tracker->positional_tracker.unref();
  481. memdelete(tracker);
  482. }
  483. trackers.clear();
  484. }
  485. void OpenXRInterface::free_interaction_profiles() {
  486. ERR_FAIL_NULL(openxr_api);
  487. for (int i = 0; i < interaction_profiles.size(); i++) {
  488. openxr_api->interaction_profile_free(interaction_profiles[i]);
  489. }
  490. interaction_profiles.clear();
  491. }
  492. bool OpenXRInterface::initialize_on_startup() const {
  493. if (openxr_api == nullptr) {
  494. return false;
  495. } else if (!openxr_api->is_initialized()) {
  496. return false;
  497. } else {
  498. return true;
  499. }
  500. }
  501. bool OpenXRInterface::is_initialized() const {
  502. return initialized;
  503. };
  504. bool OpenXRInterface::initialize() {
  505. XRServer *xr_server = XRServer::get_singleton();
  506. ERR_FAIL_NULL_V(xr_server, false);
  507. if (openxr_api == nullptr) {
  508. return false;
  509. } else if (!openxr_api->is_initialized()) {
  510. return false;
  511. } else if (initialized) {
  512. return true;
  513. }
  514. // load up our action sets before setting up our session, note that our profiles are suggestions, OpenXR takes ownership of (re)binding
  515. _load_action_map();
  516. if (!openxr_api->initialize_session()) {
  517. return false;
  518. }
  519. // we must create a tracker for our head
  520. head.instantiate();
  521. head->set_tracker_type(XRServer::TRACKER_HEAD);
  522. head->set_tracker_name("head");
  523. head->set_tracker_desc("Players head");
  524. xr_server->add_tracker(head);
  525. // attach action sets
  526. Vector<RID> loaded_action_sets;
  527. for (int i = 0; i < action_sets.size(); i++) {
  528. loaded_action_sets.append(action_sets[i]->action_set_rid);
  529. }
  530. openxr_api->attach_action_sets(loaded_action_sets);
  531. // make this our primary interface
  532. xr_server->set_primary_interface(this);
  533. initialized = true;
  534. return initialized;
  535. }
  536. void OpenXRInterface::uninitialize() {
  537. // Our OpenXR driver will clean itself up properly when Godot exits, so we just do some basic stuff here
  538. // end the session if we need to?
  539. // cleanup stuff
  540. free_trackers();
  541. free_interaction_profiles();
  542. free_action_sets();
  543. XRServer *xr_server = XRServer::get_singleton();
  544. if (xr_server) {
  545. if (head.is_valid()) {
  546. xr_server->remove_tracker(head);
  547. head.unref();
  548. }
  549. }
  550. initialized = false;
  551. }
  552. Dictionary OpenXRInterface::get_system_info() {
  553. Dictionary dict;
  554. if (openxr_api) {
  555. dict[SNAME("XRRuntimeName")] = openxr_api->get_runtime_name();
  556. dict[SNAME("XRRuntimeVersion")] = openxr_api->get_runtime_version();
  557. }
  558. return dict;
  559. }
  560. bool OpenXRInterface::supports_play_area_mode(XRInterface::PlayAreaMode p_mode) {
  561. return false;
  562. }
  563. XRInterface::PlayAreaMode OpenXRInterface::get_play_area_mode() const {
  564. return XRInterface::XR_PLAY_AREA_UNKNOWN;
  565. }
  566. bool OpenXRInterface::set_play_area_mode(XRInterface::PlayAreaMode p_mode) {
  567. return false;
  568. }
  569. float OpenXRInterface::get_display_refresh_rate() const {
  570. if (openxr_api == nullptr) {
  571. return 0.0;
  572. } else if (!openxr_api->is_initialized()) {
  573. return 0.0;
  574. } else {
  575. return openxr_api->get_display_refresh_rate();
  576. }
  577. }
  578. void OpenXRInterface::set_display_refresh_rate(float p_refresh_rate) {
  579. if (openxr_api == nullptr) {
  580. return;
  581. } else if (!openxr_api->is_initialized()) {
  582. return;
  583. } else {
  584. openxr_api->set_display_refresh_rate(p_refresh_rate);
  585. }
  586. }
  587. Array OpenXRInterface::get_available_display_refresh_rates() const {
  588. if (openxr_api == nullptr) {
  589. return Array();
  590. } else if (!openxr_api->is_initialized()) {
  591. return Array();
  592. } else {
  593. return openxr_api->get_available_display_refresh_rates();
  594. }
  595. }
  596. bool OpenXRInterface::is_hand_tracking_supported() {
  597. if (openxr_api == nullptr) {
  598. return false;
  599. } else if (!openxr_api->is_initialized()) {
  600. return false;
  601. } else {
  602. OpenXRHandTrackingExtension *hand_tracking_ext = OpenXRHandTrackingExtension::get_singleton();
  603. if (hand_tracking_ext == nullptr) {
  604. return false;
  605. } else {
  606. return hand_tracking_ext->get_active();
  607. }
  608. }
  609. }
  610. bool OpenXRInterface::is_eye_gaze_interaction_supported() {
  611. if (openxr_api == nullptr) {
  612. return false;
  613. } else if (!openxr_api->is_initialized()) {
  614. return false;
  615. } else {
  616. OpenXREyeGazeInteractionExtension *eye_gaze_ext = OpenXREyeGazeInteractionExtension::get_singleton();
  617. if (eye_gaze_ext == nullptr) {
  618. return false;
  619. } else {
  620. return eye_gaze_ext->supports_eye_gaze_interaction();
  621. }
  622. }
  623. }
  624. bool OpenXRInterface::is_action_set_active(const String &p_action_set) const {
  625. for (ActionSet *action_set : action_sets) {
  626. if (action_set->action_set_name == p_action_set) {
  627. return action_set->is_active;
  628. }
  629. }
  630. WARN_PRINT("OpenXR: Unknown action set " + p_action_set);
  631. return false;
  632. }
  633. void OpenXRInterface::set_action_set_active(const String &p_action_set, bool p_active) {
  634. for (ActionSet *action_set : action_sets) {
  635. if (action_set->action_set_name == p_action_set) {
  636. action_set->is_active = p_active;
  637. return;
  638. }
  639. }
  640. WARN_PRINT("OpenXR: Unknown action set " + p_action_set);
  641. }
  642. Array OpenXRInterface::get_action_sets() const {
  643. Array arr;
  644. for (ActionSet *action_set : action_sets) {
  645. arr.push_back(action_set->action_set_name);
  646. }
  647. return arr;
  648. }
  649. double OpenXRInterface::get_render_target_size_multiplier() const {
  650. if (openxr_api == nullptr) {
  651. return 1.0;
  652. } else {
  653. return openxr_api->get_render_target_size_multiplier();
  654. }
  655. }
  656. void OpenXRInterface::set_render_target_size_multiplier(double multiplier) {
  657. if (openxr_api == nullptr) {
  658. return;
  659. } else {
  660. openxr_api->set_render_target_size_multiplier(multiplier);
  661. }
  662. }
  663. bool OpenXRInterface::is_foveation_supported() const {
  664. if (openxr_api == nullptr) {
  665. return false;
  666. } else {
  667. return openxr_api->is_foveation_supported();
  668. }
  669. }
  670. int OpenXRInterface::get_foveation_level() const {
  671. if (openxr_api == nullptr) {
  672. return 0;
  673. } else {
  674. return openxr_api->get_foveation_level();
  675. }
  676. }
  677. void OpenXRInterface::set_foveation_level(int p_foveation_level) {
  678. if (openxr_api == nullptr) {
  679. return;
  680. } else {
  681. openxr_api->set_foveation_level(p_foveation_level);
  682. }
  683. }
  684. bool OpenXRInterface::get_foveation_dynamic() const {
  685. if (openxr_api == nullptr) {
  686. return false;
  687. } else {
  688. return openxr_api->get_foveation_dynamic();
  689. }
  690. }
  691. void OpenXRInterface::set_foveation_dynamic(bool p_foveation_dynamic) {
  692. if (openxr_api == nullptr) {
  693. return;
  694. } else {
  695. openxr_api->set_foveation_dynamic(p_foveation_dynamic);
  696. }
  697. }
  698. Size2 OpenXRInterface::get_render_target_size() {
  699. if (openxr_api == nullptr) {
  700. return Size2();
  701. } else {
  702. return openxr_api->get_recommended_target_size();
  703. }
  704. }
  705. uint32_t OpenXRInterface::get_view_count() {
  706. // TODO set this based on our configuration
  707. return 2;
  708. }
  709. void OpenXRInterface::_set_default_pos(Transform3D &p_transform, double p_world_scale, uint64_t p_eye) {
  710. p_transform = Transform3D();
  711. // if we're not tracking, don't put our head on the floor...
  712. p_transform.origin.y = 1.5 * p_world_scale;
  713. // overkill but..
  714. if (p_eye == 1) {
  715. p_transform.origin.x = 0.03 * p_world_scale;
  716. } else if (p_eye == 2) {
  717. p_transform.origin.x = -0.03 * p_world_scale;
  718. }
  719. }
  720. Transform3D OpenXRInterface::get_camera_transform() {
  721. XRServer *xr_server = XRServer::get_singleton();
  722. ERR_FAIL_NULL_V(xr_server, Transform3D());
  723. Transform3D hmd_transform;
  724. double world_scale = xr_server->get_world_scale();
  725. // head_transform should be updated in process
  726. hmd_transform.basis = head_transform.basis;
  727. hmd_transform.origin = head_transform.origin * world_scale;
  728. return hmd_transform;
  729. }
  730. Transform3D OpenXRInterface::get_transform_for_view(uint32_t p_view, const Transform3D &p_cam_transform) {
  731. XRServer *xr_server = XRServer::get_singleton();
  732. ERR_FAIL_NULL_V(xr_server, Transform3D());
  733. ERR_FAIL_UNSIGNED_INDEX_V_MSG(p_view, get_view_count(), Transform3D(), "View index outside bounds.");
  734. Transform3D t;
  735. if (openxr_api && openxr_api->get_view_transform(p_view, t)) {
  736. // update our cached value if we have a valid transform
  737. transform_for_view[p_view] = t;
  738. } else {
  739. // reuse cached value
  740. t = transform_for_view[p_view];
  741. }
  742. // Apply our world scale
  743. double world_scale = xr_server->get_world_scale();
  744. t.origin *= world_scale;
  745. return p_cam_transform * xr_server->get_reference_frame() * t;
  746. }
  747. Projection OpenXRInterface::get_projection_for_view(uint32_t p_view, double p_aspect, double p_z_near, double p_z_far) {
  748. Projection cm;
  749. ERR_FAIL_UNSIGNED_INDEX_V_MSG(p_view, get_view_count(), cm, "View index outside bounds.");
  750. if (openxr_api) {
  751. if (openxr_api->get_view_projection(p_view, p_z_near, p_z_far, cm)) {
  752. return cm;
  753. }
  754. }
  755. // Failed to get from our OpenXR device? Default to some sort of sensible camera matrix..
  756. cm.set_for_hmd(p_view + 1, 1.0, 6.0, 14.5, 4.0, 1.5, p_z_near, p_z_far);
  757. return cm;
  758. }
  759. RID OpenXRInterface::get_color_texture() {
  760. if (openxr_api) {
  761. return openxr_api->get_color_texture();
  762. } else {
  763. return RID();
  764. }
  765. }
  766. RID OpenXRInterface::get_depth_texture() {
  767. if (openxr_api) {
  768. return openxr_api->get_depth_texture();
  769. } else {
  770. return RID();
  771. }
  772. }
  773. void OpenXRInterface::handle_hand_tracking(const String &p_path, OpenXRHandTrackingExtension::HandTrackedHands p_hand) {
  774. OpenXRHandTrackingExtension *hand_tracking_ext = OpenXRHandTrackingExtension::get_singleton();
  775. if (hand_tracking_ext && hand_tracking_ext->get_active()) {
  776. OpenXRInterface::Tracker *tracker = find_tracker(p_path);
  777. if (tracker && tracker->positional_tracker.is_valid()) {
  778. XrSpaceLocationFlags location_flags = hand_tracking_ext->get_hand_joint_location_flags(p_hand, XR_HAND_JOINT_PALM_EXT);
  779. if (location_flags & (XR_SPACE_LOCATION_ORIENTATION_VALID_BIT + XR_SPACE_LOCATION_POSITION_VALID_BIT)) {
  780. static const XrSpaceLocationFlags all_location_flags = XR_SPACE_LOCATION_ORIENTATION_VALID_BIT + XR_SPACE_LOCATION_POSITION_VALID_BIT + XR_SPACE_LOCATION_ORIENTATION_TRACKED_BIT + XR_SPACE_LOCATION_POSITION_TRACKED_BIT;
  781. XRPose::TrackingConfidence confidence = XRPose::XR_TRACKING_CONFIDENCE_LOW;
  782. Transform3D transform;
  783. Vector3 linear_velocity;
  784. Vector3 angular_velocity;
  785. if ((location_flags & all_location_flags) == all_location_flags) {
  786. // All flags set? confidence is high!
  787. confidence = XRPose::XR_TRACKING_CONFIDENCE_HIGH;
  788. }
  789. if (location_flags & XR_SPACE_LOCATION_ORIENTATION_VALID_BIT) {
  790. transform.basis = Basis(hand_tracking_ext->get_hand_joint_rotation(p_hand, XR_HAND_JOINT_PALM_EXT));
  791. }
  792. if (location_flags & XR_SPACE_LOCATION_POSITION_VALID_BIT) {
  793. transform.origin = hand_tracking_ext->get_hand_joint_position(p_hand, XR_HAND_JOINT_PALM_EXT);
  794. }
  795. XrSpaceVelocityFlags velocity_flags = hand_tracking_ext->get_hand_joint_location_flags(p_hand, XR_HAND_JOINT_PALM_EXT);
  796. if (velocity_flags & XR_SPACE_VELOCITY_LINEAR_VALID_BIT) {
  797. linear_velocity = hand_tracking_ext->get_hand_joint_linear_velocity(p_hand, XR_HAND_JOINT_PALM_EXT);
  798. }
  799. if (velocity_flags & XR_SPACE_VELOCITY_ANGULAR_VALID_BIT) {
  800. angular_velocity = hand_tracking_ext->get_hand_joint_angular_velocity(p_hand, XR_HAND_JOINT_PALM_EXT);
  801. }
  802. tracker->positional_tracker->set_pose("skeleton", transform, linear_velocity, angular_velocity, confidence);
  803. } else {
  804. tracker->positional_tracker->invalidate_pose("skeleton");
  805. }
  806. }
  807. }
  808. }
  809. void OpenXRInterface::process() {
  810. if (openxr_api) {
  811. // do our normal process
  812. if (openxr_api->process()) {
  813. Transform3D t;
  814. Vector3 linear_velocity;
  815. Vector3 angular_velocity;
  816. head_confidence = openxr_api->get_head_center(t, linear_velocity, angular_velocity);
  817. if (head_confidence != XRPose::XR_TRACKING_CONFIDENCE_NONE) {
  818. // Only update our transform if we have one to update it with
  819. // note that poses are stored without world scale and reference frame applied!
  820. head_transform = t;
  821. head_linear_velocity = linear_velocity;
  822. head_angular_velocity = angular_velocity;
  823. }
  824. }
  825. // handle our action sets....
  826. Vector<RID> active_sets;
  827. for (int i = 0; i < action_sets.size(); i++) {
  828. if (action_sets[i]->is_active) {
  829. active_sets.push_back(action_sets[i]->action_set_rid);
  830. }
  831. }
  832. if (openxr_api->sync_action_sets(active_sets)) {
  833. for (int i = 0; i < trackers.size(); i++) {
  834. handle_tracker(trackers[i]);
  835. }
  836. }
  837. // Handle hand tracking
  838. handle_hand_tracking("/user/hand/left", OpenXRHandTrackingExtension::OPENXR_TRACKED_LEFT_HAND);
  839. handle_hand_tracking("/user/hand/right", OpenXRHandTrackingExtension::OPENXR_TRACKED_RIGHT_HAND);
  840. }
  841. if (head.is_valid()) {
  842. head->set_pose("default", head_transform, head_linear_velocity, head_angular_velocity, head_confidence);
  843. }
  844. }
  845. void OpenXRInterface::pre_render() {
  846. if (openxr_api) {
  847. openxr_api->pre_render();
  848. }
  849. }
  850. bool OpenXRInterface::pre_draw_viewport(RID p_render_target) {
  851. if (openxr_api) {
  852. return openxr_api->pre_draw_viewport(p_render_target);
  853. } else {
  854. // don't render
  855. return false;
  856. }
  857. }
  858. Vector<BlitToScreen> OpenXRInterface::post_draw_viewport(RID p_render_target, const Rect2 &p_screen_rect) {
  859. Vector<BlitToScreen> blit_to_screen;
  860. #ifndef ANDROID_ENABLED
  861. // If separate HMD we should output one eye to screen
  862. if (p_screen_rect != Rect2()) {
  863. BlitToScreen blit;
  864. blit.render_target = p_render_target;
  865. blit.multi_view.use_layer = true;
  866. blit.multi_view.layer = 0;
  867. blit.lens_distortion.apply = false;
  868. Size2 render_size = get_render_target_size();
  869. Rect2 dst_rect = p_screen_rect;
  870. float new_height = dst_rect.size.x * (render_size.y / render_size.x);
  871. if (new_height > dst_rect.size.y) {
  872. dst_rect.position.y = (0.5 * dst_rect.size.y) - (0.5 * new_height);
  873. dst_rect.size.y = new_height;
  874. } else {
  875. float new_width = dst_rect.size.y * (render_size.x / render_size.y);
  876. dst_rect.position.x = (0.5 * dst_rect.size.x) - (0.5 * new_width);
  877. dst_rect.size.x = new_width;
  878. }
  879. blit.dst_rect = dst_rect;
  880. blit_to_screen.push_back(blit);
  881. }
  882. #endif
  883. if (openxr_api) {
  884. openxr_api->post_draw_viewport(p_render_target);
  885. }
  886. return blit_to_screen;
  887. }
  888. void OpenXRInterface::end_frame() {
  889. if (openxr_api) {
  890. openxr_api->end_frame();
  891. }
  892. }
  893. bool OpenXRInterface::is_passthrough_supported() {
  894. return passthrough_wrapper != nullptr && passthrough_wrapper->is_passthrough_supported();
  895. }
  896. bool OpenXRInterface::is_passthrough_enabled() {
  897. return passthrough_wrapper != nullptr && passthrough_wrapper->is_passthrough_enabled();
  898. }
  899. bool OpenXRInterface::start_passthrough() {
  900. return passthrough_wrapper != nullptr && passthrough_wrapper->start_passthrough();
  901. }
  902. void OpenXRInterface::stop_passthrough() {
  903. if (passthrough_wrapper) {
  904. passthrough_wrapper->stop_passthrough();
  905. }
  906. }
  907. Array OpenXRInterface::get_supported_environment_blend_modes() {
  908. Array modes;
  909. if (!openxr_api) {
  910. return modes;
  911. }
  912. uint32_t count = 0;
  913. const XrEnvironmentBlendMode *env_blend_modes = openxr_api->get_supported_environment_blend_modes(count);
  914. if (!env_blend_modes) {
  915. return modes;
  916. }
  917. for (uint32_t i = 0; i < count; i++) {
  918. switch (env_blend_modes[i]) {
  919. case XR_ENVIRONMENT_BLEND_MODE_OPAQUE:
  920. modes.push_back(XR_ENV_BLEND_MODE_OPAQUE);
  921. break;
  922. case XR_ENVIRONMENT_BLEND_MODE_ADDITIVE:
  923. modes.push_back(XR_ENV_BLEND_MODE_ADDITIVE);
  924. break;
  925. case XR_ENVIRONMENT_BLEND_MODE_ALPHA_BLEND:
  926. modes.push_back(XR_ENV_BLEND_MODE_ALPHA_BLEND);
  927. break;
  928. default:
  929. WARN_PRINT("Unsupported blend mode found: " + String::num_int64(int64_t(env_blend_modes[i])));
  930. }
  931. }
  932. return modes;
  933. }
  934. XRInterface::EnvironmentBlendMode OpenXRInterface::get_environment_blend_mode() const {
  935. if (openxr_api) {
  936. XrEnvironmentBlendMode oxr_blend_mode = openxr_api->get_environment_blend_mode();
  937. switch (oxr_blend_mode) {
  938. case XR_ENVIRONMENT_BLEND_MODE_OPAQUE: {
  939. return XR_ENV_BLEND_MODE_OPAQUE;
  940. } break;
  941. case XR_ENVIRONMENT_BLEND_MODE_ADDITIVE: {
  942. return XR_ENV_BLEND_MODE_ADDITIVE;
  943. } break;
  944. case XR_ENVIRONMENT_BLEND_MODE_ALPHA_BLEND: {
  945. return XR_ENV_BLEND_MODE_ALPHA_BLEND;
  946. } break;
  947. default:
  948. break;
  949. }
  950. }
  951. return XR_ENV_BLEND_MODE_OPAQUE;
  952. }
  953. bool OpenXRInterface::set_environment_blend_mode(XRInterface::EnvironmentBlendMode mode) {
  954. if (openxr_api) {
  955. XrEnvironmentBlendMode oxr_blend_mode;
  956. switch (mode) {
  957. case XR_ENV_BLEND_MODE_OPAQUE:
  958. oxr_blend_mode = XR_ENVIRONMENT_BLEND_MODE_OPAQUE;
  959. break;
  960. case XR_ENV_BLEND_MODE_ADDITIVE:
  961. oxr_blend_mode = XR_ENVIRONMENT_BLEND_MODE_ADDITIVE;
  962. break;
  963. case XR_ENV_BLEND_MODE_ALPHA_BLEND:
  964. oxr_blend_mode = XR_ENVIRONMENT_BLEND_MODE_ALPHA_BLEND;
  965. break;
  966. default:
  967. WARN_PRINT("Unknown blend mode requested: " + String::num_int64(int64_t(mode)));
  968. oxr_blend_mode = XR_ENVIRONMENT_BLEND_MODE_OPAQUE;
  969. }
  970. return openxr_api->set_environment_blend_mode(oxr_blend_mode);
  971. }
  972. return false;
  973. }
  974. void OpenXRInterface::on_state_ready() {
  975. emit_signal(SNAME("session_begun"));
  976. }
  977. void OpenXRInterface::on_state_visible() {
  978. emit_signal(SNAME("session_visible"));
  979. }
  980. void OpenXRInterface::on_state_focused() {
  981. emit_signal(SNAME("session_focussed"));
  982. }
  983. void OpenXRInterface::on_state_stopping() {
  984. emit_signal(SNAME("session_stopping"));
  985. }
  986. void OpenXRInterface::on_pose_recentered() {
  987. emit_signal(SNAME("pose_recentered"));
  988. }
  989. /** Hand tracking. */
  990. void OpenXRInterface::set_motion_range(const Hand p_hand, const HandMotionRange p_motion_range) {
  991. ERR_FAIL_INDEX(p_hand, HAND_MAX);
  992. ERR_FAIL_INDEX(p_motion_range, HAND_MOTION_RANGE_MAX);
  993. OpenXRHandTrackingExtension *hand_tracking_ext = OpenXRHandTrackingExtension::get_singleton();
  994. if (hand_tracking_ext && hand_tracking_ext->get_active()) {
  995. XrHandJointsMotionRangeEXT xr_motion_range;
  996. switch (p_motion_range) {
  997. case HAND_MOTION_RANGE_UNOBSTRUCTED:
  998. xr_motion_range = XR_HAND_JOINTS_MOTION_RANGE_UNOBSTRUCTED_EXT;
  999. break;
  1000. case HAND_MOTION_RANGE_CONFORM_TO_CONTROLLER:
  1001. xr_motion_range = XR_HAND_JOINTS_MOTION_RANGE_CONFORMING_TO_CONTROLLER_EXT;
  1002. break;
  1003. default:
  1004. // Shouldn't get here, ERR_FAIL_INDEX should have caught this...
  1005. xr_motion_range = XR_HAND_JOINTS_MOTION_RANGE_CONFORMING_TO_CONTROLLER_EXT;
  1006. break;
  1007. }
  1008. hand_tracking_ext->set_motion_range(OpenXRHandTrackingExtension::HandTrackedHands(p_hand), xr_motion_range);
  1009. }
  1010. }
  1011. OpenXRInterface::HandMotionRange OpenXRInterface::get_motion_range(const Hand p_hand) const {
  1012. ERR_FAIL_INDEX_V(p_hand, HAND_MAX, HAND_MOTION_RANGE_MAX);
  1013. OpenXRHandTrackingExtension *hand_tracking_ext = OpenXRHandTrackingExtension::get_singleton();
  1014. if (hand_tracking_ext && hand_tracking_ext->get_active()) {
  1015. XrHandJointsMotionRangeEXT xr_motion_range = hand_tracking_ext->get_motion_range(OpenXRHandTrackingExtension::HandTrackedHands(p_hand));
  1016. switch (xr_motion_range) {
  1017. case XR_HAND_JOINTS_MOTION_RANGE_UNOBSTRUCTED_EXT:
  1018. return HAND_MOTION_RANGE_UNOBSTRUCTED;
  1019. case XR_HAND_JOINTS_MOTION_RANGE_CONFORMING_TO_CONTROLLER_EXT:
  1020. return HAND_MOTION_RANGE_CONFORM_TO_CONTROLLER;
  1021. default:
  1022. ERR_FAIL_V_MSG(HAND_MOTION_RANGE_MAX, "Unknown motion range returned by OpenXR");
  1023. }
  1024. }
  1025. return HAND_MOTION_RANGE_MAX;
  1026. }
  1027. BitField<OpenXRInterface::HandJointFlags> OpenXRInterface::get_hand_joint_flags(Hand p_hand, HandJoints p_joint) const {
  1028. BitField<OpenXRInterface::HandJointFlags> bits;
  1029. OpenXRHandTrackingExtension *hand_tracking_ext = OpenXRHandTrackingExtension::get_singleton();
  1030. if (hand_tracking_ext && hand_tracking_ext->get_active()) {
  1031. XrSpaceLocationFlags location_flags = hand_tracking_ext->get_hand_joint_location_flags(OpenXRHandTrackingExtension::HandTrackedHands(p_hand), XrHandJointEXT(p_joint));
  1032. if (location_flags & XR_SPACE_LOCATION_ORIENTATION_VALID_BIT) {
  1033. bits.set_flag(HAND_JOINT_ORIENTATION_VALID);
  1034. }
  1035. if (location_flags & XR_SPACE_LOCATION_ORIENTATION_TRACKED_BIT) {
  1036. bits.set_flag(HAND_JOINT_ORIENTATION_TRACKED);
  1037. }
  1038. if (location_flags & XR_SPACE_LOCATION_POSITION_VALID_BIT) {
  1039. bits.set_flag(HAND_JOINT_POSITION_VALID);
  1040. }
  1041. if (location_flags & XR_SPACE_LOCATION_POSITION_TRACKED_BIT) {
  1042. bits.set_flag(HAND_JOINT_POSITION_TRACKED);
  1043. }
  1044. XrSpaceVelocityFlags velocity_flags = hand_tracking_ext->get_hand_joint_velocity_flags(OpenXRHandTrackingExtension::HandTrackedHands(p_hand), XrHandJointEXT(p_joint));
  1045. if (velocity_flags & XR_SPACE_VELOCITY_LINEAR_VALID_BIT) {
  1046. bits.set_flag(HAND_JOINT_LINEAR_VELOCITY_VALID);
  1047. }
  1048. if (velocity_flags & XR_SPACE_VELOCITY_ANGULAR_VALID_BIT) {
  1049. bits.set_flag(HAND_JOINT_ANGULAR_VELOCITY_VALID);
  1050. }
  1051. }
  1052. return bits;
  1053. }
  1054. Quaternion OpenXRInterface::get_hand_joint_rotation(Hand p_hand, HandJoints p_joint) const {
  1055. OpenXRHandTrackingExtension *hand_tracking_ext = OpenXRHandTrackingExtension::get_singleton();
  1056. if (hand_tracking_ext && hand_tracking_ext->get_active()) {
  1057. return hand_tracking_ext->get_hand_joint_rotation(OpenXRHandTrackingExtension::HandTrackedHands(p_hand), XrHandJointEXT(p_joint));
  1058. }
  1059. return Quaternion();
  1060. }
  1061. Vector3 OpenXRInterface::get_hand_joint_position(Hand p_hand, HandJoints p_joint) const {
  1062. OpenXRHandTrackingExtension *hand_tracking_ext = OpenXRHandTrackingExtension::get_singleton();
  1063. if (hand_tracking_ext && hand_tracking_ext->get_active()) {
  1064. return hand_tracking_ext->get_hand_joint_position(OpenXRHandTrackingExtension::HandTrackedHands(p_hand), XrHandJointEXT(p_joint));
  1065. }
  1066. return Vector3();
  1067. }
  1068. float OpenXRInterface::get_hand_joint_radius(Hand p_hand, HandJoints p_joint) const {
  1069. OpenXRHandTrackingExtension *hand_tracking_ext = OpenXRHandTrackingExtension::get_singleton();
  1070. if (hand_tracking_ext && hand_tracking_ext->get_active()) {
  1071. return hand_tracking_ext->get_hand_joint_radius(OpenXRHandTrackingExtension::HandTrackedHands(p_hand), XrHandJointEXT(p_joint));
  1072. }
  1073. return 0.0;
  1074. }
  1075. Vector3 OpenXRInterface::get_hand_joint_linear_velocity(Hand p_hand, HandJoints p_joint) const {
  1076. OpenXRHandTrackingExtension *hand_tracking_ext = OpenXRHandTrackingExtension::get_singleton();
  1077. if (hand_tracking_ext && hand_tracking_ext->get_active()) {
  1078. return hand_tracking_ext->get_hand_joint_linear_velocity(OpenXRHandTrackingExtension::HandTrackedHands(p_hand), XrHandJointEXT(p_joint));
  1079. }
  1080. return Vector3();
  1081. }
  1082. Vector3 OpenXRInterface::get_hand_joint_angular_velocity(Hand p_hand, HandJoints p_joint) const {
  1083. OpenXRHandTrackingExtension *hand_tracking_ext = OpenXRHandTrackingExtension::get_singleton();
  1084. if (hand_tracking_ext && hand_tracking_ext->get_active()) {
  1085. return hand_tracking_ext->get_hand_joint_angular_velocity(OpenXRHandTrackingExtension::HandTrackedHands(p_hand), XrHandJointEXT(p_joint));
  1086. }
  1087. return Vector3();
  1088. }
  1089. OpenXRInterface::OpenXRInterface() {
  1090. openxr_api = OpenXRAPI::get_singleton();
  1091. if (openxr_api) {
  1092. openxr_api->set_xr_interface(this);
  1093. }
  1094. // while we don't have head tracking, don't put the headset on the floor...
  1095. _set_default_pos(head_transform, 1.0, 0);
  1096. _set_default_pos(transform_for_view[0], 1.0, 1);
  1097. _set_default_pos(transform_for_view[1], 1.0, 2);
  1098. passthrough_wrapper = OpenXRFbPassthroughExtensionWrapper::get_singleton();
  1099. }
  1100. OpenXRInterface::~OpenXRInterface() {
  1101. if (is_initialized()) {
  1102. uninitialize();
  1103. }
  1104. if (openxr_api) {
  1105. openxr_api->set_xr_interface(nullptr);
  1106. openxr_api = nullptr;
  1107. }
  1108. }