2024-01-09 11:29:56 +11:00
/**************************************************************************/
/* openxr_meta_controller_extension.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_meta_controller_extension.h"
# include "../action_map/openxr_interaction_profile_metadata.h"
HashMap < String , bool * > OpenXRMetaControllerExtension : : get_requested_extensions ( ) {
HashMap < String , bool * > request_extensions ;
request_extensions [ XR_FB_TOUCH_CONTROLLER_PROXIMITY_EXTENSION_NAME ] = & available [ META_TOUCH_PROXIMITY ] ;
request_extensions [ XR_FB_TOUCH_CONTROLLER_PRO_EXTENSION_NAME ] = & available [ META_TOUCH_PRO ] ;
request_extensions [ XR_META_TOUCH_CONTROLLER_PLUS_EXTENSION_NAME ] = & available [ META_TOUCH_PLUS ] ;
return request_extensions ;
}
bool OpenXRMetaControllerExtension : : is_available ( MetaControllers p_type ) {
return available [ p_type ] ;
}
void OpenXRMetaControllerExtension : : on_register_metadata ( ) {
2025-01-23 17:50:07 +11:00
OpenXRInteractionProfileMetadata * openxr_metadata = OpenXRInteractionProfileMetadata : : get_singleton ( ) ;
ERR_FAIL_NULL ( openxr_metadata ) ;
2024-01-09 11:29:56 +11:00
// Note, we register controllers regardless if they are supported on the current hardware.
2024-09-18 10:14:21 +10:00
{ // Normal touch controller is part of the core spec, but we do have some extensions.
const String profile_path = " /interaction_profiles/oculus/touch_controller " ;
for ( const String user_path : { " /user/hand/left " , " /user/hand/right " } ) {
2025-01-23 17:50:07 +11:00
openxr_metadata - > register_io_path ( profile_path , " Trigger proximity " , user_path , user_path + " /input/trigger/proximity_fb " , " XR_FB_touch_controller_proximity " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumb proximity " , user_path , user_path + " /input/thumb_fb/proximity_fb " , " XR_FB_touch_controller_proximity " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
2024-09-18 10:14:21 +10:00
}
}
{ // Touch controller pro (Quest Pro)
const String profile_path = " /interaction_profiles/facebook/touch_controller_pro " ;
2025-01-23 17:50:07 +11:00
openxr_metadata - > register_interaction_profile ( " Touch controller pro " , profile_path , " XR_FB_touch_controller_pro " ) ;
2024-09-18 10:14:21 +10:00
for ( const String user_path : { " /user/hand/left " , " /user/hand/right " } ) {
2025-01-23 17:50:07 +11:00
openxr_metadata - > register_io_path ( profile_path , " Grip pose " , user_path , user_path + " /input/grip/pose " , " " , OpenXRAction : : OPENXR_ACTION_POSE ) ;
openxr_metadata - > register_io_path ( profile_path , " Aim pose " , user_path , user_path + " /input/aim/pose " , " " , OpenXRAction : : OPENXR_ACTION_POSE ) ;
openxr_metadata - > register_io_path ( profile_path , " Palm pose " , user_path , user_path + " /palm_ext/pose " , XR_EXT_PALM_POSE_EXTENSION_NAME , OpenXRAction : : OPENXR_ACTION_POSE ) ;
openxr_metadata - > register_io_path ( profile_path , " Trigger " , user_path , user_path + " /input/trigger/value " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
openxr_metadata - > register_io_path ( profile_path , " Trigger touch " , user_path , user_path + " /input/trigger/touch " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Trigger proximity " , user_path , user_path + " /input/trigger/proximity_fb " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Trigger curl " , user_path , user_path + " /input/trigger/curl_fb " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
openxr_metadata - > register_io_path ( profile_path , " Trigger slide " , user_path , user_path + " /input/trigger/slide_fb " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
openxr_metadata - > register_io_path ( profile_path , " Trigger force " , user_path , user_path + " /input/trigger/force " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
openxr_metadata - > register_io_path ( profile_path , " Squeeze " , user_path , user_path + " /input/squeeze/value " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumb proximity " , user_path , user_path + " /input/thumb_fb/proximity_fb " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick " , user_path , user_path + " /input/thumbstick " , " " , OpenXRAction : : OPENXR_ACTION_VECTOR2 ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick X " , user_path , user_path + " /input/thumbstick/x " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick Y " , user_path , user_path + " /input/thumbstick/y " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick click " , user_path , user_path + " /input/thumbstick/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick touch " , user_path , user_path + " /input/thumbstick/touch " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick Dpad Up " , user_path , user_path + " /input/thumbstick/dpad_up " , " XR_EXT_dpad_binding " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick Dpad Down " , user_path , user_path + " /input/thumbstick/dpad_down " , " XR_EXT_dpad_binding " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick Dpad Left " , user_path , user_path + " /input/thumbstick/dpad_left " , " XR_EXT_dpad_binding " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick Dpad Right " , user_path , user_path + " /input/thumbstick/dpad_right " , " XR_EXT_dpad_binding " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbrest touch " , user_path , user_path + " /input/thumbrest/touch " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbrest force " , user_path , user_path + " /input/thumbrest/force " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
openxr_metadata - > register_io_path ( profile_path , " Stylus force " , user_path , user_path + " /input/stylus_fb/force " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
openxr_metadata - > register_io_path ( profile_path , " Haptic output " , user_path , user_path + " /output/haptic " , " " , OpenXRAction : : OPENXR_ACTION_HAPTIC ) ;
openxr_metadata - > register_io_path ( profile_path , " Haptic trigger output " , user_path , user_path + " /output/haptic_trigger_fb " , " " , OpenXRAction : : OPENXR_ACTION_HAPTIC ) ;
openxr_metadata - > register_io_path ( profile_path , " Haptic thumb output " , user_path , user_path + " /output/haptic_thumb_fb " , " " , OpenXRAction : : OPENXR_ACTION_HAPTIC ) ;
2024-09-18 10:14:21 +10:00
}
2025-01-23 17:50:07 +11:00
openxr_metadata - > register_io_path ( profile_path , " Menu click " , " /user/hand/left " , " /user/hand/left/input/menu/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " System click " , " /user/hand/right " , " /user/hand/right/input/system/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " X click " , " /user/hand/left " , " /user/hand/left/input/x/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " X touch " , " /user/hand/left " , " /user/hand/left/input/x/touch " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Y click " , " /user/hand/left " , " /user/hand/left/input/y/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Y touch " , " /user/hand/left " , " /user/hand/left/input/y/touch " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " A click " , " /user/hand/right " , " /user/hand/right/input/a/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " A touch " , " /user/hand/right " , " /user/hand/right/input/a/touch " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " B click " , " /user/hand/right " , " /user/hand/right/input/b/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " B touch " , " /user/hand/right " , " /user/hand/right/input/b/touch " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
2024-09-18 10:14:21 +10:00
}
{ // Touch controller plus (Quest 3)
const String profile_path = " /interaction_profiles/meta/touch_controller_plus " ;
2025-01-23 17:50:07 +11:00
openxr_metadata - > register_interaction_profile ( " Touch controller plus " , profile_path , " XR_META_touch_controller_plus " ) ;
2024-09-18 10:14:21 +10:00
for ( const String user_path : { " /user/hand/left " , " /user/hand/right " } ) {
2025-01-23 17:50:07 +11:00
openxr_metadata - > register_io_path ( profile_path , " Grip pose " , user_path , user_path + " /input/grip/pose " , " " , OpenXRAction : : OPENXR_ACTION_POSE ) ;
openxr_metadata - > register_io_path ( profile_path , " Aim pose " , user_path , user_path + " /input/aim/pose " , " " , OpenXRAction : : OPENXR_ACTION_POSE ) ;
openxr_metadata - > register_io_path ( profile_path , " Palm pose " , user_path , user_path + " /input/palm_ext/pose " , XR_EXT_PALM_POSE_EXTENSION_NAME , OpenXRAction : : OPENXR_ACTION_POSE ) ;
openxr_metadata - > register_io_path ( profile_path , " Trigger " , user_path , user_path + " /input/trigger/value " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
openxr_metadata - > register_io_path ( profile_path , " Trigger touch " , user_path , user_path + " /input/trigger/touch " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Trigger proximity " , user_path , user_path + " /input/trigger/proximity_meta " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Trigger curl " , user_path , user_path + " /input/trigger/curl_meta " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
openxr_metadata - > register_io_path ( profile_path , " Trigger slide " , user_path , user_path + " /input/trigger/slide_meta " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
openxr_metadata - > register_io_path ( profile_path , " Trigger force " , user_path , user_path + " /input/trigger/force " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
openxr_metadata - > register_io_path ( profile_path , " Squeeze " , user_path , user_path + " /input/squeeze/value " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumb proximity " , user_path , user_path + " /input/thumb_meta/proximity_meta " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick " , user_path , user_path + " /input/thumbstick " , " " , OpenXRAction : : OPENXR_ACTION_VECTOR2 ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick X " , user_path , user_path + " /input/thumbstick/x " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick Y " , user_path , user_path + " /input/thumbstick/y " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick click " , user_path , user_path + " /input/thumbstick/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick touch " , user_path , user_path + " /input/thumbstick/touch " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick Dpad Up " , user_path , user_path + " /input/thumbstick/dpad_up " , " XR_EXT_dpad_binding " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick Dpad Down " , user_path , user_path + " /input/thumbstick/dpad_down " , " XR_EXT_dpad_binding " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick Dpad Left " , user_path , user_path + " /input/thumbstick/dpad_left " , " XR_EXT_dpad_binding " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbstick Dpad Right " , user_path , user_path + " /input/thumbstick/dpad_right " , " XR_EXT_dpad_binding " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Thumbrest touch " , user_path , user_path + " /input/thumbrest/touch " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Haptic output " , user_path , user_path + " /output/haptic " , " " , OpenXRAction : : OPENXR_ACTION_HAPTIC ) ;
2024-09-18 10:14:21 +10:00
}
2025-01-23 17:50:07 +11:00
openxr_metadata - > register_io_path ( profile_path , " Menu click " , " /user/hand/left " , " /user/hand/left/input/menu/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " System click " , " /user/hand/right " , " /user/hand/right/input/system/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " X click " , " /user/hand/left " , " /user/hand/left/input/x/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " X touch " , " /user/hand/left " , " /user/hand/left/input/x/touch " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Y click " , " /user/hand/left " , " /user/hand/left/input/y/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " Y touch " , " /user/hand/left " , " /user/hand/left/input/y/touch " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " A click " , " /user/hand/right " , " /user/hand/right/input/a/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " A touch " , " /user/hand/right " , " /user/hand/right/input/a/touch " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " B click " , " /user/hand/right " , " /user/hand/right/input/b/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
openxr_metadata - > register_io_path ( profile_path , " B touch " , " /user/hand/right " , " /user/hand/right/input/b/touch " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
2024-09-18 10:14:21 +10:00
}
2024-01-09 11:29:56 +11:00
}