summaryrefslogtreecommitdiff
path: root/servers/xr_server.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'servers/xr_server.cpp')
-rw-r--r--servers/xr_server.cpp304
1 files changed, 171 insertions, 133 deletions
diff --git a/servers/xr_server.cpp b/servers/xr_server.cpp
index c18a9f8b4e..990281d96d 100644
--- a/servers/xr_server.cpp
+++ b/servers/xr_server.cpp
@@ -5,8 +5,8 @@
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
-/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
-/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
+/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
+/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
@@ -33,6 +33,16 @@
#include "xr/xr_interface.h"
#include "xr/xr_positional_tracker.h"
+XRServer::XRMode XRServer::xr_mode = XRMODE_DEFAULT;
+
+XRServer::XRMode XRServer::get_xr_mode() {
+ return xr_mode;
+}
+
+void XRServer::set_xr_mode(XRServer::XRMode p_mode) {
+ xr_mode = p_mode;
+}
+
XRServer *XRServer::singleton = nullptr;
XRServer *XRServer::get_singleton() {
@@ -41,7 +51,7 @@ XRServer *XRServer::get_singleton() {
void XRServer::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_world_scale"), &XRServer::get_world_scale);
- ClassDB::bind_method(D_METHOD("set_world_scale"), &XRServer::set_world_scale);
+ ClassDB::bind_method(D_METHOD("set_world_scale", "scale"), &XRServer::set_world_scale);
ClassDB::bind_method(D_METHOD("get_reference_frame"), &XRServer::get_reference_frame);
ClassDB::bind_method(D_METHOD("center_on_hmd", "rotation_mode", "keep_height"), &XRServer::center_on_hmd);
ClassDB::bind_method(D_METHOD("get_hmd_transform"), &XRServer::get_hmd_transform);
@@ -54,20 +64,18 @@ void XRServer::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_interface", "idx"), &XRServer::get_interface);
ClassDB::bind_method(D_METHOD("get_interfaces"), &XRServer::get_interfaces);
ClassDB::bind_method(D_METHOD("find_interface", "name"), &XRServer::find_interface);
- ClassDB::bind_method(D_METHOD("get_tracker_count"), &XRServer::get_tracker_count);
- ClassDB::bind_method(D_METHOD("get_tracker", "idx"), &XRServer::get_tracker);
+
ClassDB::bind_method(D_METHOD("add_tracker", "tracker"), &XRServer::add_tracker);
ClassDB::bind_method(D_METHOD("remove_tracker", "tracker"), &XRServer::remove_tracker);
+ ClassDB::bind_method(D_METHOD("get_trackers", "tracker_types"), &XRServer::get_trackers);
+ ClassDB::bind_method(D_METHOD("get_tracker", "tracker_name"), &XRServer::get_tracker);
ClassDB::bind_method(D_METHOD("get_primary_interface"), &XRServer::get_primary_interface);
ClassDB::bind_method(D_METHOD("set_primary_interface", "interface"), &XRServer::set_primary_interface);
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "primary_interface"), "set_primary_interface", "get_primary_interface");
- ClassDB::bind_method(D_METHOD("get_last_process_usec"), &XRServer::get_last_process_usec);
- ClassDB::bind_method(D_METHOD("get_last_commit_usec"), &XRServer::get_last_commit_usec);
- ClassDB::bind_method(D_METHOD("get_last_frame_usec"), &XRServer::get_last_frame_usec);
-
+ BIND_ENUM_CONSTANT(TRACKER_HEAD);
BIND_ENUM_CONSTANT(TRACKER_CONTROLLER);
BIND_ENUM_CONSTANT(TRACKER_BASESTATION);
BIND_ENUM_CONSTANT(TRACKER_ANCHOR);
@@ -82,15 +90,16 @@ void XRServer::_bind_methods() {
ADD_SIGNAL(MethodInfo("interface_added", PropertyInfo(Variant::STRING_NAME, "interface_name")));
ADD_SIGNAL(MethodInfo("interface_removed", PropertyInfo(Variant::STRING_NAME, "interface_name")));
- ADD_SIGNAL(MethodInfo("tracker_added", PropertyInfo(Variant::STRING_NAME, "tracker_name"), PropertyInfo(Variant::INT, "type"), PropertyInfo(Variant::INT, "id")));
- ADD_SIGNAL(MethodInfo("tracker_removed", PropertyInfo(Variant::STRING_NAME, "tracker_name"), PropertyInfo(Variant::INT, "type"), PropertyInfo(Variant::INT, "id")));
+ ADD_SIGNAL(MethodInfo("tracker_added", PropertyInfo(Variant::STRING_NAME, "tracker_name"), PropertyInfo(Variant::INT, "type")));
+ ADD_SIGNAL(MethodInfo("tracker_updated", PropertyInfo(Variant::STRING_NAME, "tracker_name"), PropertyInfo(Variant::INT, "type")));
+ ADD_SIGNAL(MethodInfo("tracker_removed", PropertyInfo(Variant::STRING_NAME, "tracker_name"), PropertyInfo(Variant::INT, "type")));
};
-real_t XRServer::get_world_scale() const {
+double XRServer::get_world_scale() const {
return world_scale;
};
-void XRServer::set_world_scale(real_t p_world_scale) {
+void XRServer::set_world_scale(double p_world_scale) {
if (p_world_scale < 0.01) {
p_world_scale = 0.01;
} else if (p_world_scale > 1000.0) {
@@ -113,35 +122,43 @@ Transform3D XRServer::get_reference_frame() const {
};
void XRServer::center_on_hmd(RotationMode p_rotation_mode, bool p_keep_height) {
- if (primary_interface != nullptr) {
- // clear our current reference frame or we'll end up double adjusting it
+ if (primary_interface == nullptr) {
+ return;
+ }
+
+ if (primary_interface->get_play_area_mode() == XRInterface::XR_PLAY_AREA_STAGE) {
+ // center_on_hmd is not available in this mode
reference_frame = Transform3D();
+ return;
+ }
- // requesting our EYE_MONO transform should return our current HMD position
- Transform3D new_reference_frame = primary_interface->get_camera_transform();
+ // clear our current reference frame or we'll end up double adjusting it
+ reference_frame = Transform3D();
- // remove our tilt
- if (p_rotation_mode == 1) {
- // take the Y out of our Z
- new_reference_frame.basis.set_axis(2, Vector3(new_reference_frame.basis.elements[0][2], 0.0, new_reference_frame.basis.elements[2][2]).normalized());
+ // requesting our EYE_MONO transform should return our current HMD position
+ Transform3D new_reference_frame = primary_interface->get_camera_transform();
- // Y is straight up
- new_reference_frame.basis.set_axis(1, Vector3(0.0, 1.0, 0.0));
+ // remove our tilt
+ if (p_rotation_mode == 1) {
+ // take the Y out of our Z
+ new_reference_frame.basis.set_column(2, Vector3(new_reference_frame.basis.rows[0][2], 0.0, new_reference_frame.basis.rows[2][2]).normalized());
- // and X is our cross reference
- new_reference_frame.basis.set_axis(0, new_reference_frame.basis.get_axis(1).cross(new_reference_frame.basis.get_axis(2)).normalized());
- } else if (p_rotation_mode == 2) {
- // remove our rotation, we're only interesting in centering on position
- new_reference_frame.basis = Basis();
- };
+ // Y is straight up
+ new_reference_frame.basis.set_column(1, Vector3(0.0, 1.0, 0.0));
- // don't negate our height
- if (p_keep_height) {
- new_reference_frame.origin.y = 0.0;
- };
+ // and X is our cross reference
+ new_reference_frame.basis.set_column(0, new_reference_frame.basis.get_column(1).cross(new_reference_frame.basis.get_column(2)).normalized());
+ } else if (p_rotation_mode == 2) {
+ // remove our rotation, we're only interesting in centering on position
+ new_reference_frame.basis = Basis();
+ };
- reference_frame = new_reference_frame.inverse();
+ // don't negate our height
+ if (p_keep_height) {
+ new_reference_frame.origin.y = 0.0;
};
+
+ reference_frame = new_reference_frame.inverse();
};
Transform3D XRServer::get_hmd_transform() {
@@ -177,12 +194,12 @@ void XRServer::remove_interface(const Ref<XRInterface> &p_interface) {
};
};
- ERR_FAIL_COND(idx == -1);
+ ERR_FAIL_COND_MSG(idx == -1, "Interface not found.");
print_verbose("XR: Removed interface" + p_interface->get_name());
emit_signal(SNAME("interface_removed"), p_interface->get_name());
- interfaces.remove(idx);
+ interfaces.remove_at(idx);
};
int XRServer::get_interface_count() const {
@@ -204,7 +221,7 @@ Ref<XRInterface> XRServer::find_interface(const String &p_name) const {
};
};
- ERR_FAIL_COND_V(idx == -1, nullptr);
+ ERR_FAIL_COND_V_MSG(idx == -1, nullptr, "Interface not found.");
return interfaces[idx];
};
@@ -224,126 +241,127 @@ Array XRServer::get_interfaces() const {
return ret;
};
-/*
- A little extra info on the tracker ids, these are unique per tracker type so we get some consistency in recognising our trackers, specifically controllers.
-
- The first controller that is turned of will get ID 1, the second will get ID 2, etc.
- The magic happens when one of the controllers is turned off, say controller 1 turns off, controller 2 will remain controller 2, controller 3 will remain controller 3.
- If controller number 1 is turned on again it again gets ID 1 unless another new controller was turned on since.
-
- The most likely scenario however is a controller that runs out of battery and another controller being used to replace it.
- Because the controllers are often linked to physical objects, say you're holding a shield in controller 1, your left hand, and a gun in controller 2, your right hand, and controller 1 dies:
- - using our tracker index would suddenly make the gun disappear and the shield jump into your right hand because controller 2 becomes controller 1.
- - using this approach the shield disappears or is no longer tracked, but the gun stays firmly in your right hand because that is still controller 2, further more, if controller 1 is replaced the shield will return.
-*/
-
-bool XRServer::is_tracker_id_in_use_for_type(TrackerType p_tracker_type, int p_tracker_id) const {
- for (int i = 0; i < trackers.size(); i++) {
- if (trackers[i]->get_tracker_type() == p_tracker_type && trackers[i]->get_tracker_id() == p_tracker_id) {
- return true;
- };
- };
-
- // all good
- return false;
+Ref<XRInterface> XRServer::get_primary_interface() const {
+ return primary_interface;
};
-int XRServer::get_free_tracker_id_for_type(TrackerType p_tracker_type) {
- // We start checking at 1, 0 means that it's not a controller..
- // Note that for controller we reserve:
- // - 1 for the left hand controller and
- // - 2 for the right hand controller
- // so we start at 3 :)
- int tracker_id = p_tracker_type == XRServer::TRACKER_CONTROLLER ? 3 : 1;
-
- while (is_tracker_id_in_use_for_type(p_tracker_type, tracker_id)) {
- // try the next one
- tracker_id++;
- };
+void XRServer::set_primary_interface(const Ref<XRInterface> &p_primary_interface) {
+ if (p_primary_interface.is_null()) {
+ print_verbose("XR: Clearing primary interface");
+ primary_interface.unref();
+ } else {
+ primary_interface = p_primary_interface;
- return tracker_id;
+ print_verbose("XR: Primary interface set to: " + primary_interface->get_name());
+ }
};
void XRServer::add_tracker(Ref<XRPositionalTracker> p_tracker) {
ERR_FAIL_COND(p_tracker.is_null());
- trackers.push_back(p_tracker);
- emit_signal(SNAME("tracker_added"), p_tracker->get_tracker_name(), p_tracker->get_tracker_type(), p_tracker->get_tracker_id());
+ StringName tracker_name = p_tracker->get_tracker_name();
+ if (trackers.has(tracker_name)) {
+ if (trackers[tracker_name] != p_tracker) {
+ // We already have a tracker with this name, we're going to replace it
+ trackers[tracker_name] = p_tracker;
+ emit_signal(SNAME("tracker_updated"), tracker_name, p_tracker->get_tracker_type());
+ }
+ } else {
+ trackers[tracker_name] = p_tracker;
+ emit_signal(SNAME("tracker_added"), tracker_name, p_tracker->get_tracker_type());
+ }
};
void XRServer::remove_tracker(Ref<XRPositionalTracker> p_tracker) {
ERR_FAIL_COND(p_tracker.is_null());
- int idx = -1;
- for (int i = 0; i < trackers.size(); i++) {
- if (trackers[i] == p_tracker) {
- idx = i;
- break;
- };
- };
-
- ERR_FAIL_COND(idx == -1);
+ StringName tracker_name = p_tracker->get_tracker_name();
+ if (trackers.has(tracker_name)) {
+ // we send the signal right before removing it
+ emit_signal(SNAME("tracker_removed"), p_tracker->get_tracker_name(), p_tracker->get_tracker_type());
- emit_signal(SNAME("tracker_removed"), p_tracker->get_tracker_name(), p_tracker->get_tracker_type(), p_tracker->get_tracker_id());
- trackers.remove(idx);
+ // and remove it
+ trackers.erase(tracker_name);
+ }
};
-int XRServer::get_tracker_count() const {
- return trackers.size();
-};
+Dictionary XRServer::get_trackers(int p_tracker_types) {
+ Dictionary res;
+
+ for (int i = 0; i < trackers.size(); i++) {
+ Ref<XRPositionalTracker> tracker = trackers.get_value_at_index(i);
+ if (tracker.is_valid() && (tracker->get_tracker_type() & p_tracker_types) != 0) {
+ res[tracker->get_tracker_name()] = tracker;
+ }
+ }
-Ref<XRPositionalTracker> XRServer::get_tracker(int p_index) const {
- ERR_FAIL_INDEX_V(p_index, trackers.size(), Ref<XRPositionalTracker>());
+ return res;
+}
- return trackers[p_index];
+Ref<XRPositionalTracker> XRServer::get_tracker(const StringName &p_name) const {
+ if (trackers.has(p_name)) {
+ return trackers[p_name];
+ } else {
+ // tracker hasn't been registered yet, which is fine, no need to spam the error log...
+ return Ref<XRPositionalTracker>();
+ }
};
-Ref<XRPositionalTracker> XRServer::find_by_type_and_id(TrackerType p_tracker_type, int p_tracker_id) const {
- ERR_FAIL_COND_V(p_tracker_id == 0, Ref<XRPositionalTracker>());
+PackedStringArray XRServer::get_suggested_tracker_names() const {
+ PackedStringArray arr;
- for (int i = 0; i < trackers.size(); i++) {
- if (trackers[i]->get_tracker_type() == p_tracker_type && trackers[i]->get_tracker_id() == p_tracker_id) {
- return trackers[i];
- };
- };
+ for (int i = 0; i < interfaces.size(); i++) {
+ Ref<XRInterface> interface = interfaces[i];
+ PackedStringArray interface_arr = interface->get_suggested_tracker_names();
+ for (int a = 0; a < interface_arr.size(); a++) {
+ if (!arr.has(interface_arr[a])) {
+ arr.push_back(interface_arr[a]);
+ }
+ }
+ }
- return Ref<XRPositionalTracker>();
-};
+ if (arr.size() == 0) {
+ // no suggestions from our tracker? include our defaults
+ arr.push_back(String("head"));
+ arr.push_back(String("left_hand"));
+ arr.push_back(String("right_hand"));
+ }
-Ref<XRInterface> XRServer::get_primary_interface() const {
- return primary_interface;
-};
+ return arr;
+}
-void XRServer::set_primary_interface(const Ref<XRInterface> &p_primary_interface) {
- if (p_primary_interface.is_null()) {
- print_verbose("XR: Clearing primary interface");
- primary_interface.unref();
- } else {
- primary_interface = p_primary_interface;
+PackedStringArray XRServer::get_suggested_pose_names(const StringName &p_tracker_name) const {
+ PackedStringArray arr;
- print_verbose("XR: Primary interface set to: " + primary_interface->get_name());
+ for (int i = 0; i < interfaces.size(); i++) {
+ Ref<XRInterface> interface = interfaces[i];
+ PackedStringArray interface_arr = interface->get_suggested_pose_names(p_tracker_name);
+ for (int a = 0; a < interface_arr.size(); a++) {
+ if (!arr.has(interface_arr[a])) {
+ arr.push_back(interface_arr[a]);
+ }
+ }
}
-};
-uint64_t XRServer::get_last_process_usec() {
- return last_process_usec;
-};
+ if (arr.size() == 0) {
+ // no suggestions from our tracker? include our defaults
+ arr.push_back(String("default"));
-uint64_t XRServer::get_last_commit_usec() {
- return last_commit_usec;
-};
+ if ((p_tracker_name == "left_hand") || (p_tracker_name == "right_hand")) {
+ arr.push_back(String("aim"));
+ arr.push_back(String("grip"));
+ arr.push_back(String("skeleton"));
+ }
+ }
-uint64_t XRServer::get_last_frame_usec() {
- return last_frame_usec;
-};
+ return arr;
+}
void XRServer::_process() {
- /* called from renderer_viewport.draw_viewports right before we start drawing our viewports */
-
- /* mark for our frame timing */
- last_process_usec = OS::get_singleton()->get_ticks_usec();
+ // called from our main game loop before we handle physics and game logic
+ // note that we can have multiple interfaces active if we have interfaces that purely handle tracking
- /* process all active interfaces */
+ // process all active interfaces
for (int i = 0; i < interfaces.size(); i++) {
if (!interfaces[i].is_valid()) {
// ignore, not a valid reference
@@ -353,13 +371,32 @@ void XRServer::_process() {
};
};
-void XRServer::_mark_commit() {
- /* time this */
- last_commit_usec = OS::get_singleton()->get_ticks_usec();
+void XRServer::pre_render() {
+ // called from RendererViewport.draw_viewports right before we start drawing our viewports
+ // note that we can have multiple interfaces active if we have interfaces that purely handle tracking
- /* now store our difference as we may overwrite last_process_usec before this is accessed */
- last_frame_usec = last_commit_usec - last_process_usec;
-};
+ // process all active interfaces
+ for (int i = 0; i < interfaces.size(); i++) {
+ if (!interfaces[i].is_valid()) {
+ // ignore, not a valid reference
+ } else if (interfaces[i]->is_initialized()) {
+ interfaces.write[i]->pre_render();
+ };
+ };
+}
+
+void XRServer::end_frame() {
+ // called from RenderingServerDefault after Vulkan queues have been submitted
+
+ // process all active interfaces
+ for (int i = 0; i < interfaces.size(); i++) {
+ if (!interfaces[i].is_valid()) {
+ // ignore, not a valid reference
+ } else if (interfaces[i]->is_initialized()) {
+ interfaces.write[i]->end_frame();
+ };
+ };
+}
XRServer::XRServer() {
singleton = this;
@@ -370,11 +407,12 @@ XRServer::~XRServer() {
primary_interface.unref();
while (interfaces.size() > 0) {
- interfaces.remove(0);
+ interfaces.remove_at(0);
}
+ // TODO pretty sure there is a clear function or something...
while (trackers.size() > 0) {
- trackers.remove(0);
+ trackers.erase(trackers.get_key_at_index(0));
}
singleton = nullptr;
generated by cgit v1.2.3 (git 2.25.1) at 2025-03-21 03:08:48 +0000