xr_nodes.cpp 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743
  1. /**************************************************************************/
  2. /* xr_nodes.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 "xr_nodes.h"
  31. #include "core/config/project_settings.h"
  32. #include "scene/main/viewport.h"
  33. #include "servers/xr/xr_interface.h"
  34. ////////////////////////////////////////////////////////////////////////////////////////////////////
  35. void XRCamera3D::_bind_tracker() {
  36. XRServer *xr_server = XRServer::get_singleton();
  37. ERR_FAIL_NULL(xr_server);
  38. tracker = xr_server->get_tracker(tracker_name);
  39. if (tracker.is_valid()) {
  40. tracker->connect("pose_changed", callable_mp(this, &XRCamera3D::_pose_changed));
  41. Ref<XRPose> pose = tracker->get_pose(pose_name);
  42. if (pose.is_valid()) {
  43. set_transform(pose->get_adjusted_transform());
  44. }
  45. }
  46. }
  47. void XRCamera3D::_unbind_tracker() {
  48. if (tracker.is_valid()) {
  49. tracker->disconnect("pose_changed", callable_mp(this, &XRCamera3D::_pose_changed));
  50. }
  51. tracker.unref();
  52. }
  53. void XRCamera3D::_changed_tracker(const StringName p_tracker_name, int p_tracker_type) {
  54. if (p_tracker_name == tracker_name) {
  55. _bind_tracker();
  56. }
  57. }
  58. void XRCamera3D::_removed_tracker(const StringName p_tracker_name, int p_tracker_type) {
  59. if (p_tracker_name == tracker_name) {
  60. _unbind_tracker();
  61. }
  62. }
  63. void XRCamera3D::_pose_changed(const Ref<XRPose> &p_pose) {
  64. if (p_pose->get_name() == pose_name) {
  65. set_transform(p_pose->get_adjusted_transform());
  66. }
  67. }
  68. PackedStringArray XRCamera3D::get_configuration_warnings() const {
  69. PackedStringArray warnings = Node::get_configuration_warnings();
  70. if (is_visible() && is_inside_tree()) {
  71. // must be child node of XROrigin3D!
  72. XROrigin3D *origin = Object::cast_to<XROrigin3D>(get_parent());
  73. if (origin == nullptr) {
  74. warnings.push_back(RTR("XRCamera3D must have an XROrigin3D node as its parent."));
  75. };
  76. }
  77. return warnings;
  78. };
  79. Vector3 XRCamera3D::project_local_ray_normal(const Point2 &p_pos) const {
  80. // get our XRServer
  81. XRServer *xr_server = XRServer::get_singleton();
  82. ERR_FAIL_NULL_V(xr_server, Vector3());
  83. Ref<XRInterface> xr_interface = xr_server->get_primary_interface();
  84. if (xr_interface.is_null()) {
  85. // we might be in the editor or have VR turned off, just call superclass
  86. return Camera3D::project_local_ray_normal(p_pos);
  87. }
  88. ERR_FAIL_COND_V_MSG(!is_inside_tree(), Vector3(), "Camera is not inside scene.");
  89. Size2 viewport_size = get_viewport()->get_camera_rect_size();
  90. Vector2 cpos = get_viewport()->get_camera_coords(p_pos);
  91. Vector3 ray;
  92. // Just use the first view, if multiple views are supported this function has no good result
  93. Projection cm = xr_interface->get_projection_for_view(0, viewport_size.aspect(), get_near(), get_far());
  94. Vector2 screen_he = cm.get_viewport_half_extents();
  95. ray = Vector3(((cpos.x / viewport_size.width) * 2.0 - 1.0) * screen_he.x, ((1.0 - (cpos.y / viewport_size.height)) * 2.0 - 1.0) * screen_he.y, -get_near()).normalized();
  96. return ray;
  97. };
  98. Point2 XRCamera3D::unproject_position(const Vector3 &p_pos) const {
  99. // get our XRServer
  100. XRServer *xr_server = XRServer::get_singleton();
  101. ERR_FAIL_NULL_V(xr_server, Vector2());
  102. Ref<XRInterface> xr_interface = xr_server->get_primary_interface();
  103. if (xr_interface.is_null()) {
  104. // we might be in the editor or have VR turned off, just call superclass
  105. return Camera3D::unproject_position(p_pos);
  106. }
  107. ERR_FAIL_COND_V_MSG(!is_inside_tree(), Vector2(), "Camera is not inside scene.");
  108. Size2 viewport_size = get_viewport()->get_visible_rect().size;
  109. // Just use the first view, if multiple views are supported this function has no good result
  110. Projection cm = xr_interface->get_projection_for_view(0, viewport_size.aspect(), get_near(), get_far());
  111. Plane p(get_camera_transform().xform_inv(p_pos), 1.0);
  112. p = cm.xform4(p);
  113. p.normal /= p.d;
  114. Point2 res;
  115. res.x = (p.normal.x * 0.5 + 0.5) * viewport_size.x;
  116. res.y = (-p.normal.y * 0.5 + 0.5) * viewport_size.y;
  117. return res;
  118. };
  119. Vector3 XRCamera3D::project_position(const Point2 &p_point, real_t p_z_depth) const {
  120. // get our XRServer
  121. XRServer *xr_server = XRServer::get_singleton();
  122. ERR_FAIL_NULL_V(xr_server, Vector3());
  123. Ref<XRInterface> xr_interface = xr_server->get_primary_interface();
  124. if (xr_interface.is_null()) {
  125. // we might be in the editor or have VR turned off, just call superclass
  126. return Camera3D::project_position(p_point, p_z_depth);
  127. }
  128. ERR_FAIL_COND_V_MSG(!is_inside_tree(), Vector3(), "Camera is not inside scene.");
  129. Size2 viewport_size = get_viewport()->get_visible_rect().size;
  130. // Just use the first view, if multiple views are supported this function has no good result
  131. Projection cm = xr_interface->get_projection_for_view(0, viewport_size.aspect(), get_near(), get_far());
  132. Vector2 vp_he = cm.get_viewport_half_extents();
  133. Vector2 point;
  134. point.x = (p_point.x / viewport_size.x) * 2.0 - 1.0;
  135. point.y = (1.0 - (p_point.y / viewport_size.y)) * 2.0 - 1.0;
  136. point *= vp_he;
  137. Vector3 p(point.x, point.y, -p_z_depth);
  138. return get_camera_transform().xform(p);
  139. };
  140. Vector<Plane> XRCamera3D::get_frustum() const {
  141. // get our XRServer
  142. XRServer *xr_server = XRServer::get_singleton();
  143. ERR_FAIL_NULL_V(xr_server, Vector<Plane>());
  144. Ref<XRInterface> xr_interface = xr_server->get_primary_interface();
  145. if (xr_interface.is_null()) {
  146. // we might be in the editor or have VR turned off, just call superclass
  147. return Camera3D::get_frustum();
  148. }
  149. ERR_FAIL_COND_V(!is_inside_world(), Vector<Plane>());
  150. Size2 viewport_size = get_viewport()->get_visible_rect().size;
  151. // TODO Just use the first view for now, this is mostly for debugging so we may look into using our combined projection here.
  152. Projection cm = xr_interface->get_projection_for_view(0, viewport_size.aspect(), get_near(), get_far());
  153. return cm.get_projection_planes(get_camera_transform());
  154. };
  155. XRCamera3D::XRCamera3D() {
  156. XRServer *xr_server = XRServer::get_singleton();
  157. ERR_FAIL_NULL(xr_server);
  158. xr_server->connect("tracker_added", callable_mp(this, &XRCamera3D::_changed_tracker));
  159. xr_server->connect("tracker_updated", callable_mp(this, &XRCamera3D::_changed_tracker));
  160. xr_server->connect("tracker_removed", callable_mp(this, &XRCamera3D::_removed_tracker));
  161. // check if our tracker already exists and if so, bind it...
  162. _bind_tracker();
  163. }
  164. XRCamera3D::~XRCamera3D() {
  165. XRServer *xr_server = XRServer::get_singleton();
  166. ERR_FAIL_NULL(xr_server);
  167. xr_server->disconnect("tracker_added", callable_mp(this, &XRCamera3D::_changed_tracker));
  168. xr_server->disconnect("tracker_updated", callable_mp(this, &XRCamera3D::_changed_tracker));
  169. xr_server->disconnect("tracker_removed", callable_mp(this, &XRCamera3D::_removed_tracker));
  170. }
  171. ////////////////////////////////////////////////////////////////////////////////////////////////////
  172. // XRNode3D is a node that has it's transform updated by an XRPositionalTracker.
  173. // Note that trackers are only available in runtime and only after an XRInterface registers one.
  174. // So we bind by name and as long as a tracker isn't available, our node remains inactive.
  175. void XRNode3D::_bind_methods() {
  176. ClassDB::bind_method(D_METHOD("set_tracker", "tracker_name"), &XRNode3D::set_tracker);
  177. ClassDB::bind_method(D_METHOD("get_tracker"), &XRNode3D::get_tracker);
  178. ADD_PROPERTY(PropertyInfo(Variant::STRING, "tracker", PROPERTY_HINT_ENUM_SUGGESTION), "set_tracker", "get_tracker");
  179. ClassDB::bind_method(D_METHOD("set_pose_name", "pose"), &XRNode3D::set_pose_name);
  180. ClassDB::bind_method(D_METHOD("get_pose_name"), &XRNode3D::get_pose_name);
  181. ADD_PROPERTY(PropertyInfo(Variant::STRING, "pose", PROPERTY_HINT_ENUM_SUGGESTION), "set_pose_name", "get_pose_name");
  182. ClassDB::bind_method(D_METHOD("get_is_active"), &XRNode3D::get_is_active);
  183. ClassDB::bind_method(D_METHOD("get_has_tracking_data"), &XRNode3D::get_has_tracking_data);
  184. ClassDB::bind_method(D_METHOD("get_pose"), &XRNode3D::get_pose);
  185. ClassDB::bind_method(D_METHOD("trigger_haptic_pulse", "action_name", "frequency", "amplitude", "duration_sec", "delay_sec"), &XRNode3D::trigger_haptic_pulse);
  186. };
  187. void XRNode3D::_validate_property(PropertyInfo &p_property) const {
  188. XRServer *xr_server = XRServer::get_singleton();
  189. ERR_FAIL_NULL(xr_server);
  190. if (p_property.name == "tracker") {
  191. PackedStringArray names = xr_server->get_suggested_tracker_names();
  192. String hint_string;
  193. for (const String &name : names) {
  194. hint_string += name + ",";
  195. }
  196. p_property.hint_string = hint_string;
  197. } else if (p_property.name == "pose") {
  198. PackedStringArray names = xr_server->get_suggested_pose_names(tracker_name);
  199. String hint_string;
  200. for (const String &name : names) {
  201. hint_string += name + ",";
  202. }
  203. p_property.hint_string = hint_string;
  204. }
  205. }
  206. void XRNode3D::set_tracker(const StringName p_tracker_name) {
  207. if (tracker.is_valid() && tracker->get_tracker_name() == p_tracker_name) {
  208. // didn't change
  209. return;
  210. }
  211. // just in case
  212. _unbind_tracker();
  213. // copy the name
  214. tracker_name = p_tracker_name;
  215. pose_name = "default";
  216. // see if it's already available
  217. _bind_tracker();
  218. update_configuration_warnings();
  219. notify_property_list_changed();
  220. }
  221. StringName XRNode3D::get_tracker() const {
  222. return tracker_name;
  223. }
  224. void XRNode3D::set_pose_name(const StringName p_pose_name) {
  225. pose_name = p_pose_name;
  226. // Update pose if we are bound to a tracker with a valid pose
  227. Ref<XRPose> pose = get_pose();
  228. if (pose.is_valid()) {
  229. set_transform(pose->get_adjusted_transform());
  230. }
  231. }
  232. StringName XRNode3D::get_pose_name() const {
  233. return pose_name;
  234. }
  235. bool XRNode3D::get_is_active() const {
  236. if (tracker.is_null()) {
  237. return false;
  238. } else if (!tracker->has_pose(pose_name)) {
  239. return false;
  240. } else {
  241. return true;
  242. }
  243. }
  244. bool XRNode3D::get_has_tracking_data() const {
  245. if (tracker.is_null()) {
  246. return false;
  247. } else if (!tracker->has_pose(pose_name)) {
  248. return false;
  249. } else {
  250. return tracker->get_pose(pose_name)->get_has_tracking_data();
  251. }
  252. }
  253. void XRNode3D::trigger_haptic_pulse(const String &p_action_name, double p_frequency, double p_amplitude, double p_duration_sec, double p_delay_sec) {
  254. // TODO need to link trackers to the interface that registered them so we can call this on the correct interface.
  255. // For now this works fine as in 99% of the cases we only have our primary interface active
  256. XRServer *xr_server = XRServer::get_singleton();
  257. if (xr_server != nullptr) {
  258. Ref<XRInterface> xr_interface = xr_server->get_primary_interface();
  259. if (xr_interface.is_valid()) {
  260. xr_interface->trigger_haptic_pulse(p_action_name, tracker_name, p_frequency, p_amplitude, p_duration_sec, p_delay_sec);
  261. }
  262. }
  263. }
  264. Ref<XRPose> XRNode3D::get_pose() {
  265. if (tracker.is_valid()) {
  266. return tracker->get_pose(pose_name);
  267. } else {
  268. return Ref<XRPose>();
  269. }
  270. }
  271. void XRNode3D::_bind_tracker() {
  272. ERR_FAIL_COND_MSG(tracker.is_valid(), "Unbind the current tracker first");
  273. XRServer *xr_server = XRServer::get_singleton();
  274. if (xr_server != nullptr) {
  275. tracker = xr_server->get_tracker(tracker_name);
  276. if (tracker.is_null()) {
  277. // It is possible and valid if the tracker isn't available (yet), in this case we just exit
  278. return;
  279. }
  280. tracker->connect("pose_changed", callable_mp(this, &XRNode3D::_pose_changed));
  281. Ref<XRPose> pose = get_pose();
  282. if (pose.is_valid()) {
  283. set_transform(pose->get_adjusted_transform());
  284. }
  285. }
  286. }
  287. void XRNode3D::_unbind_tracker() {
  288. if (tracker.is_valid()) {
  289. tracker->disconnect("pose_changed", callable_mp(this, &XRNode3D::_pose_changed));
  290. tracker.unref();
  291. }
  292. }
  293. void XRNode3D::_changed_tracker(const StringName p_tracker_name, int p_tracker_type) {
  294. if (tracker_name == p_tracker_name) {
  295. // just in case unref our current tracker
  296. _unbind_tracker();
  297. // get our new tracker
  298. _bind_tracker();
  299. }
  300. }
  301. void XRNode3D::_removed_tracker(const StringName p_tracker_name, int p_tracker_type) {
  302. if (tracker_name == p_tracker_name) {
  303. // unref our tracker, it's no longer available
  304. _unbind_tracker();
  305. }
  306. }
  307. void XRNode3D::_pose_changed(const Ref<XRPose> &p_pose) {
  308. if (p_pose.is_valid() && p_pose->get_name() == pose_name) {
  309. set_transform(p_pose->get_adjusted_transform());
  310. }
  311. }
  312. XRNode3D::XRNode3D() {
  313. XRServer *xr_server = XRServer::get_singleton();
  314. ERR_FAIL_NULL(xr_server);
  315. xr_server->connect("tracker_added", callable_mp(this, &XRNode3D::_changed_tracker));
  316. xr_server->connect("tracker_updated", callable_mp(this, &XRNode3D::_changed_tracker));
  317. xr_server->connect("tracker_removed", callable_mp(this, &XRNode3D::_removed_tracker));
  318. }
  319. XRNode3D::~XRNode3D() {
  320. _unbind_tracker();
  321. XRServer *xr_server = XRServer::get_singleton();
  322. ERR_FAIL_NULL(xr_server);
  323. xr_server->disconnect("tracker_added", callable_mp(this, &XRNode3D::_changed_tracker));
  324. xr_server->disconnect("tracker_updated", callable_mp(this, &XRNode3D::_changed_tracker));
  325. xr_server->disconnect("tracker_removed", callable_mp(this, &XRNode3D::_removed_tracker));
  326. }
  327. PackedStringArray XRNode3D::get_configuration_warnings() const {
  328. PackedStringArray warnings = Node::get_configuration_warnings();
  329. if (is_visible() && is_inside_tree()) {
  330. // must be child node of XROrigin!
  331. XROrigin3D *origin = Object::cast_to<XROrigin3D>(get_parent());
  332. if (origin == nullptr) {
  333. warnings.push_back(RTR("XRController3D must have an XROrigin3D node as its parent."));
  334. }
  335. if (tracker_name == "") {
  336. warnings.push_back(RTR("No tracker name is set."));
  337. }
  338. if (pose_name == "") {
  339. warnings.push_back(RTR("No pose is set."));
  340. }
  341. }
  342. return warnings;
  343. }
  344. ////////////////////////////////////////////////////////////////////////////////////////////////////
  345. void XRController3D::_bind_methods() {
  346. // passthroughs to information about our related joystick
  347. ClassDB::bind_method(D_METHOD("is_button_pressed", "name"), &XRController3D::is_button_pressed);
  348. ClassDB::bind_method(D_METHOD("get_input", "name"), &XRController3D::get_input);
  349. ClassDB::bind_method(D_METHOD("get_float", "name"), &XRController3D::get_float);
  350. ClassDB::bind_method(D_METHOD("get_vector2", "name"), &XRController3D::get_vector2);
  351. ClassDB::bind_method(D_METHOD("get_tracker_hand"), &XRController3D::get_tracker_hand);
  352. ADD_SIGNAL(MethodInfo("button_pressed", PropertyInfo(Variant::STRING, "name")));
  353. ADD_SIGNAL(MethodInfo("button_released", PropertyInfo(Variant::STRING, "name")));
  354. ADD_SIGNAL(MethodInfo("input_float_changed", PropertyInfo(Variant::STRING, "name"), PropertyInfo(Variant::FLOAT, "value")));
  355. ADD_SIGNAL(MethodInfo("input_vector2_changed", PropertyInfo(Variant::STRING, "name"), PropertyInfo(Variant::VECTOR2, "value")));
  356. };
  357. void XRController3D::_bind_tracker() {
  358. XRNode3D::_bind_tracker();
  359. if (tracker.is_valid()) {
  360. // bind to input signals
  361. tracker->connect("button_pressed", callable_mp(this, &XRController3D::_button_pressed));
  362. tracker->connect("button_released", callable_mp(this, &XRController3D::_button_released));
  363. tracker->connect("input_float_changed", callable_mp(this, &XRController3D::_input_float_changed));
  364. tracker->connect("input_vector2_changed", callable_mp(this, &XRController3D::_input_vector2_changed));
  365. }
  366. }
  367. void XRController3D::_unbind_tracker() {
  368. if (tracker.is_valid()) {
  369. // unbind input signals
  370. tracker->disconnect("button_pressed", callable_mp(this, &XRController3D::_button_pressed));
  371. tracker->disconnect("button_released", callable_mp(this, &XRController3D::_button_released));
  372. tracker->disconnect("input_float_changed", callable_mp(this, &XRController3D::_input_float_changed));
  373. tracker->disconnect("input_vector2_changed", callable_mp(this, &XRController3D::_input_vector2_changed));
  374. }
  375. XRNode3D::_unbind_tracker();
  376. }
  377. void XRController3D::_button_pressed(const String &p_name) {
  378. // just pass it on...
  379. emit_signal(SNAME("button_pressed"), p_name);
  380. }
  381. void XRController3D::_button_released(const String &p_name) {
  382. // just pass it on...
  383. emit_signal(SNAME("button_released"), p_name);
  384. }
  385. void XRController3D::_input_float_changed(const String &p_name, float p_value) {
  386. // just pass it on...
  387. emit_signal(SNAME("input_float_changed"), p_name, p_value);
  388. }
  389. void XRController3D::_input_vector2_changed(const String &p_name, Vector2 p_value) {
  390. // just pass it on...
  391. emit_signal(SNAME("input_vector2_changed"), p_name, p_value);
  392. }
  393. bool XRController3D::is_button_pressed(const StringName &p_name) const {
  394. if (tracker.is_valid()) {
  395. // Inputs should already be of the correct type, our XR runtime handles conversions between raw input and the desired type
  396. bool pressed = tracker->get_input(p_name);
  397. return pressed;
  398. } else {
  399. return false;
  400. }
  401. }
  402. Variant XRController3D::get_input(const StringName &p_name) const {
  403. if (tracker.is_valid()) {
  404. return tracker->get_input(p_name);
  405. } else {
  406. return Variant();
  407. }
  408. }
  409. float XRController3D::get_float(const StringName &p_name) const {
  410. if (tracker.is_valid()) {
  411. // Inputs should already be of the correct type, our XR runtime handles conversions between raw input and the desired type, but just in case we convert
  412. Variant input = tracker->get_input(p_name);
  413. switch (input.get_type()) {
  414. case Variant::BOOL: {
  415. bool value = input;
  416. return value ? 1.0 : 0.0;
  417. } break;
  418. case Variant::FLOAT: {
  419. float value = input;
  420. return value;
  421. } break;
  422. default:
  423. return 0.0;
  424. };
  425. } else {
  426. return 0.0;
  427. }
  428. }
  429. Vector2 XRController3D::get_vector2(const StringName &p_name) const {
  430. if (tracker.is_valid()) {
  431. // Inputs should already be of the correct type, our XR runtime handles conversions between raw input and the desired type, but just in case we convert
  432. Variant input = tracker->get_input(p_name);
  433. switch (input.get_type()) {
  434. case Variant::BOOL: {
  435. bool value = input;
  436. return Vector2(value ? 1.0 : 0.0, 0.0);
  437. } break;
  438. case Variant::FLOAT: {
  439. float value = input;
  440. return Vector2(value, 0.0);
  441. } break;
  442. case Variant::VECTOR2: {
  443. Vector2 axis = input;
  444. return axis;
  445. }
  446. default:
  447. return Vector2();
  448. }
  449. } else {
  450. return Vector2();
  451. }
  452. }
  453. XRPositionalTracker::TrackerHand XRController3D::get_tracker_hand() const {
  454. // get our XRServer
  455. if (!tracker.is_valid()) {
  456. return XRPositionalTracker::TRACKER_HAND_UNKNOWN;
  457. }
  458. return tracker->get_tracker_hand();
  459. }
  460. ////////////////////////////////////////////////////////////////////////////////////////////////////
  461. void XRAnchor3D::_bind_methods() {
  462. ClassDB::bind_method(D_METHOD("get_size"), &XRAnchor3D::get_size);
  463. ClassDB::bind_method(D_METHOD("get_plane"), &XRAnchor3D::get_plane);
  464. }
  465. Vector3 XRAnchor3D::get_size() const {
  466. return size;
  467. }
  468. Plane XRAnchor3D::get_plane() const {
  469. Vector3 location = get_position();
  470. Basis orientation = get_transform().basis;
  471. Plane plane(orientation.get_column(1).normalized(), location);
  472. return plane;
  473. }
  474. ////////////////////////////////////////////////////////////////////////////////////////////////////
  475. Vector<XROrigin3D *> XROrigin3D::origin_nodes;
  476. PackedStringArray XROrigin3D::get_configuration_warnings() const {
  477. PackedStringArray warnings = Node::get_configuration_warnings();
  478. if (is_visible() && is_inside_tree()) {
  479. bool has_camera = false;
  480. for (int i = 0; !has_camera && i < get_child_count(); i++) {
  481. XRCamera3D *camera = Object::cast_to<XRCamera3D>(get_child(i));
  482. if (camera) {
  483. // found it!
  484. has_camera = true;
  485. }
  486. }
  487. if (!has_camera) {
  488. warnings.push_back(RTR("XROrigin3D requires an XRCamera3D child node."));
  489. }
  490. }
  491. bool xr_enabled = GLOBAL_GET("xr/shaders/enabled");
  492. if (!xr_enabled) {
  493. warnings.push_back(RTR("XR is not enabled in rendering project settings. Stereoscopic output is not supported unless this is enabled."));
  494. }
  495. return warnings;
  496. }
  497. void XROrigin3D::_bind_methods() {
  498. ClassDB::bind_method(D_METHOD("set_world_scale", "world_scale"), &XROrigin3D::set_world_scale);
  499. ClassDB::bind_method(D_METHOD("get_world_scale"), &XROrigin3D::get_world_scale);
  500. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "world_scale"), "set_world_scale", "get_world_scale");
  501. ClassDB::bind_method(D_METHOD("set_current", "enabled"), &XROrigin3D::set_current);
  502. ClassDB::bind_method(D_METHOD("is_current"), &XROrigin3D::is_current);
  503. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "current"), "set_current", "is_current");
  504. }
  505. real_t XROrigin3D::get_world_scale() const {
  506. // get our XRServer
  507. XRServer *xr_server = XRServer::get_singleton();
  508. ERR_FAIL_NULL_V(xr_server, 1.0);
  509. return xr_server->get_world_scale();
  510. }
  511. void XROrigin3D::set_world_scale(real_t p_world_scale) {
  512. // get our XRServer
  513. XRServer *xr_server = XRServer::get_singleton();
  514. ERR_FAIL_NULL(xr_server);
  515. xr_server->set_world_scale(p_world_scale);
  516. }
  517. void XROrigin3D::_set_current(bool p_enabled, bool p_update_others) {
  518. // We run this logic even if current already equals p_enabled as we may have set this previously before we entered our tree.
  519. // This is then called a second time on NOTIFICATION_ENTER_TREE where we actually process activating this origin node.
  520. current = p_enabled;
  521. if (!is_inside_tree() || Engine::get_singleton()->is_editor_hint()) {
  522. return;
  523. }
  524. // Notify us of any transform changes
  525. set_notify_local_transform(current);
  526. set_notify_transform(current);
  527. // update XRServer with our current position
  528. if (current) {
  529. XRServer *xr_server = XRServer::get_singleton();
  530. ERR_FAIL_NULL(xr_server);
  531. xr_server->set_world_origin(get_global_transform());
  532. }
  533. // Check if we need to update our other origin nodes accordingly
  534. if (p_update_others) {
  535. if (current) {
  536. for (int i = 0; i < origin_nodes.size(); i++) {
  537. if (origin_nodes[i] != this && origin_nodes[i]->current) {
  538. origin_nodes[i]->_set_current(false, false);
  539. }
  540. }
  541. } else {
  542. // We no longer have a current origin so find the first one we can make current
  543. for (int i = 0; i < origin_nodes.size(); i++) {
  544. if (origin_nodes[i] != this) {
  545. origin_nodes[i]->_set_current(true, false);
  546. return; // we are done.
  547. }
  548. }
  549. }
  550. }
  551. }
  552. void XROrigin3D::set_current(bool p_enabled) {
  553. _set_current(p_enabled, true);
  554. }
  555. bool XROrigin3D::is_current() const {
  556. if (Engine::get_singleton()->is_editor_hint()) {
  557. // return as is
  558. return current;
  559. } else {
  560. return current && is_inside_tree();
  561. }
  562. }
  563. void XROrigin3D::_notification(int p_what) {
  564. // get our XRServer
  565. XRServer *xr_server = XRServer::get_singleton();
  566. ERR_FAIL_NULL(xr_server);
  567. switch (p_what) {
  568. case NOTIFICATION_ENTER_TREE: {
  569. if (!Engine::get_singleton()->is_editor_hint()) {
  570. if (origin_nodes.is_empty()) {
  571. // first entry always becomes current
  572. current = true;
  573. }
  574. origin_nodes.push_back(this);
  575. if (current) {
  576. // set this again so we do whatever setup is needed.
  577. set_current(true);
  578. }
  579. }
  580. } break;
  581. case NOTIFICATION_EXIT_TREE: {
  582. if (!Engine::get_singleton()->is_editor_hint()) {
  583. origin_nodes.erase(this);
  584. if (current) {
  585. // We are no longer current
  586. set_current(false);
  587. }
  588. }
  589. } break;
  590. case NOTIFICATION_LOCAL_TRANSFORM_CHANGED:
  591. case NOTIFICATION_TRANSFORM_CHANGED: {
  592. if (current && !Engine::get_singleton()->is_editor_hint()) {
  593. xr_server->set_world_origin(get_global_transform());
  594. }
  595. } break;
  596. }
  597. if (current) {
  598. // send our notification to all active XE interfaces, they may need to react to it also
  599. for (int i = 0; i < xr_server->get_interface_count(); i++) {
  600. Ref<XRInterface> interface = xr_server->get_interface(i);
  601. if (interface.is_valid() && interface->is_initialized()) {
  602. interface->notification(p_what);
  603. }
  604. }
  605. }
  606. }