diff options
Diffstat (limited to 'modules/openxr')
| -rw-r--r-- | modules/openxr/SCsub | 1 | ||||
| -rw-r--r-- | modules/openxr/action_map/openxr_action_map.cpp | 8 | ||||
| -rw-r--r-- | modules/openxr/doc_classes/OpenXRInterface.xml | 7 | ||||
| -rw-r--r-- | modules/openxr/extensions/openxr_eye_gaze_interaction.cpp | 98 | ||||
| -rw-r--r-- | modules/openxr/extensions/openxr_eye_gaze_interaction.h | 58 | ||||
| -rw-r--r-- | modules/openxr/openxr_interface.cpp | 23 | ||||
| -rw-r--r-- | modules/openxr/openxr_interface.h | 2 | ||||
| -rw-r--r-- | modules/openxr/register_types.cpp | 4 |
8 files changed, 199 insertions, 2 deletions
diff --git a/modules/openxr/SCsub b/modules/openxr/SCsub index c3a5d82fc4..73a3723ea4 100644 --- a/modules/openxr/SCsub +++ b/modules/openxr/SCsub @@ -106,6 +106,7 @@ if env["opengl3"] and env["platform"] != "macos": env_openxr.add_source_files(module_obj, "extensions/openxr_palm_pose_extension.cpp") env_openxr.add_source_files(module_obj, "extensions/openxr_composition_layer_depth_extension.cpp") +env_openxr.add_source_files(module_obj, "extensions/openxr_eye_gaze_interaction.cpp") env_openxr.add_source_files(module_obj, "extensions/openxr_htc_controller_extension.cpp") env_openxr.add_source_files(module_obj, "extensions/openxr_htc_vive_tracker_extension.cpp") env_openxr.add_source_files(module_obj, "extensions/openxr_huawei_controller_extension.cpp") diff --git a/modules/openxr/action_map/openxr_action_map.cpp b/modules/openxr/action_map/openxr_action_map.cpp index 6d79e33de8..72866f1cf7 100644 --- a/modules/openxr/action_map/openxr_action_map.cpp +++ b/modules/openxr/action_map/openxr_action_map.cpp @@ -206,7 +206,8 @@ void OpenXRActionMap::create_default_action_sets() { "/user/vive_tracker_htcx/role/waist," "/user/vive_tracker_htcx/role/chest," "/user/vive_tracker_htcx/role/camera," - "/user/vive_tracker_htcx/role/keyboard"); + "/user/vive_tracker_htcx/role/keyboard," + "/user/eyes_ext"); Ref<OpenXRAction> aim_pose = action_set->add_new_action("aim_pose", "Aim pose", OpenXRAction::OPENXR_ACTION_POSE, "/user/hand/left,/user/hand/right"); Ref<OpenXRAction> grip_pose = action_set->add_new_action("grip_pose", "Grip pose", OpenXRAction::OPENXR_ACTION_POSE, "/user/hand/left,/user/hand/right"); Ref<OpenXRAction> palm_pose = action_set->add_new_action("palm_pose", "Palm pose", OpenXRAction::OPENXR_ACTION_POSE, "/user/hand/left,/user/hand/right"); @@ -503,6 +504,11 @@ void OpenXRActionMap::create_default_action_sets() { "/user/vive_tracker_htcx/role/camera/output/haptic," "/user/vive_tracker_htcx/role/keyboard/output/haptic"); add_interaction_profile(profile); + + // Create our eye gaze interaction profile + profile = OpenXRInteractionProfile::new_profile("/interaction_profiles/ext/eye_gaze_interaction"); + profile->add_new_binding(default_pose, "/user/eyes_ext/input/gaze_ext/pose"); + add_interaction_profile(profile); } void OpenXRActionMap::create_editor_action_sets() { diff --git a/modules/openxr/doc_classes/OpenXRInterface.xml b/modules/openxr/doc_classes/OpenXRInterface.xml index d0630626e6..c7c666dc2f 100644 --- a/modules/openxr/doc_classes/OpenXRInterface.xml +++ b/modules/openxr/doc_classes/OpenXRInterface.xml @@ -77,6 +77,13 @@ Returns [code]true[/code] if the given action set is active. </description> </method> + <method name="is_eye_gaze_interaction_supported"> + <return type="bool" /> + <description> + Returns the capabilities of the eye gaze interaction extension. + [b]Note:[/b] This only returns a valid value after OpenXR has been initialized. + </description> + </method> <method name="is_foveation_supported" qualifiers="const"> <return type="bool" /> <description> diff --git a/modules/openxr/extensions/openxr_eye_gaze_interaction.cpp b/modules/openxr/extensions/openxr_eye_gaze_interaction.cpp new file mode 100644 index 0000000000..59bdec5c8e --- /dev/null +++ b/modules/openxr/extensions/openxr_eye_gaze_interaction.cpp @@ -0,0 +1,98 @@ +/**************************************************************************/ +/* openxr_eye_gaze_interaction.cpp */ +/**************************************************************************/ +/* This file is part of: */ +/* GODOT ENGINE */ +/* https://godotengine.org */ +/**************************************************************************/ +/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ +/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ +/* */ +/* Permission is hereby granted, free of charge, to any person obtaining */ +/* a copy of this software and associated documentation files (the */ +/* "Software"), to deal in the Software without restriction, including */ +/* without limitation the rights to use, copy, modify, merge, publish, */ +/* distribute, sublicense, and/or sell copies of the Software, and to */ +/* permit persons to whom the Software is furnished to do so, subject to */ +/* the following conditions: */ +/* */ +/* The above copyright notice and this permission notice shall be */ +/* included in all copies or substantial portions of the Software. */ +/* */ +/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ +/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ +/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */ +/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ +/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ +/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ +/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ +/**************************************************************************/ + +#include "openxr_eye_gaze_interaction.h" + +#include "core/os/os.h" + +#include "../action_map/openxr_interaction_profile_metadata.h" + +OpenXREyeGazeInteractionExtension *OpenXREyeGazeInteractionExtension::singleton = nullptr; + +OpenXREyeGazeInteractionExtension *OpenXREyeGazeInteractionExtension::get_singleton() { + ERR_FAIL_NULL_V(singleton, nullptr); + return singleton; +} + +OpenXREyeGazeInteractionExtension::OpenXREyeGazeInteractionExtension() { + singleton = this; +} + +OpenXREyeGazeInteractionExtension::~OpenXREyeGazeInteractionExtension() { + singleton = nullptr; +} + +HashMap<String, bool *> OpenXREyeGazeInteractionExtension::get_requested_extensions() { + HashMap<String, bool *> request_extensions; + + request_extensions[XR_EXT_EYE_GAZE_INTERACTION_EXTENSION_NAME] = &available; + + return request_extensions; +} + +void *OpenXREyeGazeInteractionExtension::set_system_properties_and_get_next_pointer(void *p_next_pointer) { + if (!available) { + return p_next_pointer; + } + + properties.type = XR_TYPE_SYSTEM_EYE_GAZE_INTERACTION_PROPERTIES_EXT; + properties.next = p_next_pointer; + properties.supportsEyeGazeInteraction = false; + + return &properties; +} + +bool OpenXREyeGazeInteractionExtension::is_available() { + return available; +} + +bool OpenXREyeGazeInteractionExtension::supports_eye_gaze_interaction() { + // The extension being available only means that the OpenXR Runtime supports the extension. + // The `supportsEyeGazeInteraction` is set to true if the device also supports this. + // Thus both need to be true. + // In addition, on mobile runtimes, the proper permission needs to be granted. + if (available && properties.supportsEyeGazeInteraction) { + return !OS::get_singleton()->has_feature("mobile") || OS::get_singleton()->has_feature("PERMISSION_XR_EXT_eye_gaze_interaction"); + } + + return false; +} + +void OpenXREyeGazeInteractionExtension::on_register_metadata() { + OpenXRInteractionProfileMetadata *metadata = OpenXRInteractionProfileMetadata::get_singleton(); + ERR_FAIL_NULL(metadata); + + // Eyes top path + metadata->register_top_level_path("Eye gaze tracker", "/user/eyes_ext", XR_EXT_EYE_GAZE_INTERACTION_EXTENSION_NAME); + + // Eye gaze interaction + metadata->register_interaction_profile("Eye gaze", "/interaction_profiles/ext/eye_gaze_interaction", XR_EXT_EYE_GAZE_INTERACTION_EXTENSION_NAME); + metadata->register_io_path("/interaction_profiles/ext/eye_gaze_interaction", "Gaze pose", "/user/eyes_ext", "/user/eyes_ext/input/gaze_ext/pose", "", OpenXRAction::OPENXR_ACTION_POSE); +} diff --git a/modules/openxr/extensions/openxr_eye_gaze_interaction.h b/modules/openxr/extensions/openxr_eye_gaze_interaction.h new file mode 100644 index 0000000000..704940ad26 --- /dev/null +++ b/modules/openxr/extensions/openxr_eye_gaze_interaction.h @@ -0,0 +1,58 @@ +/**************************************************************************/ +/* openxr_eye_gaze_interaction.h */ +/**************************************************************************/ +/* This file is part of: */ +/* GODOT ENGINE */ +/* https://godotengine.org */ +/**************************************************************************/ +/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ +/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ +/* */ +/* Permission is hereby granted, free of charge, to any person obtaining */ +/* a copy of this software and associated documentation files (the */ +/* "Software"), to deal in the Software without restriction, including */ +/* without limitation the rights to use, copy, modify, merge, publish, */ +/* distribute, sublicense, and/or sell copies of the Software, and to */ +/* permit persons to whom the Software is furnished to do so, subject to */ +/* the following conditions: */ +/* */ +/* The above copyright notice and this permission notice shall be */ +/* included in all copies or substantial portions of the Software. */ +/* */ +/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ +/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ +/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */ +/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ +/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ +/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ +/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ +/**************************************************************************/ + +#ifndef OPENXR_EYE_GAZE_INTERACTION_H +#define OPENXR_EYE_GAZE_INTERACTION_H + +#include "openxr_extension_wrapper.h" + +class OpenXREyeGazeInteractionExtension : public OpenXRExtensionWrapper { +public: + static OpenXREyeGazeInteractionExtension *get_singleton(); + + OpenXREyeGazeInteractionExtension(); + ~OpenXREyeGazeInteractionExtension(); + + virtual HashMap<String, bool *> get_requested_extensions() override; + virtual void *set_system_properties_and_get_next_pointer(void *p_next_pointer) override; + + bool is_available(); + bool supports_eye_gaze_interaction(); + + virtual void on_register_metadata() override; + +private: + static OpenXREyeGazeInteractionExtension *singleton; + + bool available = false; + XrSystemEyeGazeInteractionPropertiesEXT properties; +}; + +#endif // OPENXR_EYE_GAZE_INTERACTION_H diff --git a/modules/openxr/openxr_interface.cpp b/modules/openxr/openxr_interface.cpp index 7b1530677f..67a459adb8 100644 --- a/modules/openxr/openxr_interface.cpp +++ b/modules/openxr/openxr_interface.cpp @@ -36,6 +36,8 @@ #include "extensions/openxr_hand_tracking_extension.h" +#include "extensions/openxr_eye_gaze_interaction.h" + void OpenXRInterface::_bind_methods() { // lifecycle signals ADD_SIGNAL(MethodInfo("session_begun")); @@ -119,6 +121,8 @@ void OpenXRInterface::_bind_methods() { BIND_ENUM_CONSTANT(HAND_JOINT_LITTLE_DISTAL); BIND_ENUM_CONSTANT(HAND_JOINT_LITTLE_TIP); BIND_ENUM_CONSTANT(HAND_JOINT_MAX); + + ClassDB::bind_method(D_METHOD("is_eye_gaze_interaction_supported"), &OpenXRInterface::is_eye_gaze_interaction_supported); } StringName OpenXRInterface::get_name() const { @@ -152,7 +156,9 @@ PackedStringArray OpenXRInterface::get_suggested_tracker_names() const { "/user/vive_tracker_htcx/role/waist", "/user/vive_tracker_htcx/role/chest", "/user/vive_tracker_htcx/role/camera", - "/user/vive_tracker_htcx/role/keyboard" + "/user/vive_tracker_htcx/role/keyboard", + + "/user/eyes_ext", }; return arr; @@ -705,6 +711,21 @@ Array OpenXRInterface::get_available_display_refresh_rates() const { } } +bool OpenXRInterface::is_eye_gaze_interaction_supported() { + if (openxr_api == nullptr) { + return false; + } else if (!openxr_api->is_initialized()) { + return false; + } else { + OpenXREyeGazeInteractionExtension *eye_gaze_ext = OpenXREyeGazeInteractionExtension::get_singleton(); + if (eye_gaze_ext == nullptr) { + return false; + } else { + return eye_gaze_ext->supports_eye_gaze_interaction(); + } + } +} + bool OpenXRInterface::is_action_set_active(const String &p_action_set) const { for (ActionSet *action_set : action_sets) { if (action_set->action_set_name == p_action_set) { diff --git a/modules/openxr/openxr_interface.h b/modules/openxr/openxr_interface.h index 38cf4bdbe8..a2cc2b27ff 100644 --- a/modules/openxr/openxr_interface.h +++ b/modules/openxr/openxr_interface.h @@ -107,6 +107,8 @@ public: virtual PackedStringArray get_suggested_tracker_names() const override; virtual TrackingStatus get_tracking_status() const override; + bool is_eye_gaze_interaction_supported(); + bool initialize_on_startup() const; virtual bool is_initialized() const override; virtual bool initialize() override; diff --git a/modules/openxr/register_types.cpp b/modules/openxr/register_types.cpp index d69c803502..09a064b9a9 100644 --- a/modules/openxr/register_types.cpp +++ b/modules/openxr/register_types.cpp @@ -42,6 +42,7 @@ #include "scene/openxr_hand.h" #include "extensions/openxr_composition_layer_depth_extension.h" +#include "extensions/openxr_eye_gaze_interaction.h" #include "extensions/openxr_fb_display_refresh_rate_extension.h" #include "extensions/openxr_fb_passthrough_extension_wrapper.h" #include "extensions/openxr_hand_tracking_extension.h" @@ -104,6 +105,9 @@ void initialize_openxr_module(ModuleInitializationLevel p_level) { #endif // register our other extensions + if (GLOBAL_GET("xr/openxr/extensions/eye_gaze_interaction") && (!OS::get_singleton()->has_feature("mobile") || OS::get_singleton()->has_feature(XR_EXT_EYE_GAZE_INTERACTION_EXTENSION_NAME))) { + OpenXRAPI::register_extension_wrapper(memnew(OpenXREyeGazeInteractionExtension)); + } OpenXRAPI::register_extension_wrapper(memnew(OpenXRPalmPoseExtension)); OpenXRAPI::register_extension_wrapper(memnew(OpenXRPicoControllerExtension)); OpenXRAPI::register_extension_wrapper(memnew(OpenXRCompositionLayerDepthExtension)); |