2023-01-05 13:25:55 +01:00
/**************************************************************************/
/* openxr_wmr_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. */
/**************************************************************************/
2022-12-29 06:34:25 +01:00
# include "openxr_wmr_controller_extension.h"
2023-06-13 16:56:21 +02:00
2023-08-26 17:39:43 +02:00
# include "../action_map/openxr_interaction_profile_metadata.h"
2022-12-29 06:34:25 +01:00
HashMap < String , bool * > OpenXRWMRControllerExtension : : get_requested_extensions ( ) {
HashMap < String , bool * > request_extensions ;
// Note HP G2 is available on WMR and SteamVR, but Odessey is only available on WMR
request_extensions [ XR_EXT_HP_MIXED_REALITY_CONTROLLER_EXTENSION_NAME ] = & available [ WMR_HPMR ] ;
request_extensions [ XR_EXT_SAMSUNG_ODYSSEY_CONTROLLER_EXTENSION_NAME ] = & available [ WMR_SAMSUNG_ODESSY ] ;
2024-06-12 11:16:43 +02:00
request_extensions [ XR_MSFT_HAND_INTERACTION_EXTENSION_NAME ] = & available [ WMR_HAND_INTERACTION ] ;
2022-12-29 06:34:25 +01:00
return request_extensions ;
}
bool OpenXRWMRControllerExtension : : is_available ( WMRControllers p_type ) {
return available [ p_type ] ;
}
void OpenXRWMRControllerExtension : : on_register_metadata ( ) {
2023-08-26 17:39:43 +02:00
OpenXRInteractionProfileMetadata * metadata = OpenXRInteractionProfileMetadata : : get_singleton ( ) ;
2022-12-29 06:34:25 +01:00
ERR_FAIL_NULL ( metadata ) ;
// HP MR controller (newer G2 controllers)
metadata - > register_interaction_profile ( " HPMR controller " , " /interaction_profiles/hp/mixed_reality_controller " , XR_EXT_HP_MIXED_REALITY_CONTROLLER_EXTENSION_NAME ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Grip pose " , " /user/hand/left " , " /user/hand/left/input/grip/pose " , " " , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Grip pose " , " /user/hand/right " , " /user/hand/right/input/grip/pose " , " " , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Aim pose " , " /user/hand/left " , " /user/hand/left/input/aim/pose " , " " , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Aim pose " , " /user/hand/right " , " /user/hand/right/input/aim/pose " , " " , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Palm pose " , " /user/hand/left " , " /user/hand/left/input/palm_ext/pose " , XR_EXT_PALM_POSE_EXTENSION_NAME , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Palm pose " , " /user/hand/right " , " /user/hand/right/input/palm_ext/pose " , XR_EXT_PALM_POSE_EXTENSION_NAME , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Menu click " , " /user/hand/left " , " /user/hand/left/input/menu/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Menu click " , " /user/hand/right " , " /user/hand/right/input/menu/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " X click " , " /user/hand/left " , " /user/hand/left/input/x/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Y click " , " /user/hand/left " , " /user/hand/left/input/y/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " A click " , " /user/hand/right " , " /user/hand/right/input/a/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " B click " , " /user/hand/right " , " /user/hand/right/input/b/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Trigger " , " /user/hand/left " , " /user/hand/left/input/trigger/value " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Trigger click " , " /user/hand/left " , " /user/hand/left/input/trigger/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Trigger " , " /user/hand/right " , " /user/hand/right/input/trigger/value " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Trigger click " , " /user/hand/right " , " /user/hand/right/input/trigger/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Squeeze " , " /user/hand/left " , " /user/hand/left/input/squeeze/value " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Squeeze " , " /user/hand/right " , " /user/hand/right/input/squeeze/value " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Thumbstick " , " /user/hand/left " , " /user/hand/left/input/thumbstick " , " " , OpenXRAction : : OPENXR_ACTION_VECTOR2 ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Thumbstick click " , " /user/hand/left " , " /user/hand/left/input/thumbstick/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Thumbstick " , " /user/hand/right " , " /user/hand/right/input/thumbstick " , " " , OpenXRAction : : OPENXR_ACTION_VECTOR2 ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Thumbstick click " , " /user/hand/right " , " /user/hand/right/input/thumbstick/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Haptic output " , " /user/hand/left " , " /user/hand/left/output/haptic " , " " , OpenXRAction : : OPENXR_ACTION_HAPTIC ) ;
metadata - > register_io_path ( " /interaction_profiles/hp/mixed_reality_controller " , " Haptic output " , " /user/hand/right " , " /user/hand/right/output/haptic " , " " , OpenXRAction : : OPENXR_ACTION_HAPTIC ) ;
// Samsung Odyssey controller
metadata - > register_interaction_profile ( " Samsung Odyssey controller " , " /interaction_profiles/samsung/odyssey_controller " , XR_EXT_SAMSUNG_ODYSSEY_CONTROLLER_EXTENSION_NAME ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Grip pose " , " /user/hand/left " , " /user/hand/left/input/grip/pose " , " " , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Grip pose " , " /user/hand/right " , " /user/hand/right/input/grip/pose " , " " , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Aim pose " , " /user/hand/left " , " /user/hand/left/input/aim/pose " , " " , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Aim pose " , " /user/hand/right " , " /user/hand/right/input/aim/pose " , " " , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Palm pose " , " /user/hand/left " , " /user/hand/left/input/palm_ext/pose " , XR_EXT_PALM_POSE_EXTENSION_NAME , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Palm pose " , " /user/hand/right " , " /user/hand/right/input/palm_ext/pose " , XR_EXT_PALM_POSE_EXTENSION_NAME , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Menu click " , " /user/hand/left " , " /user/hand/left/input/menu/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Menu click " , " /user/hand/right " , " /user/hand/right/input/menu/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Trigger " , " /user/hand/left " , " /user/hand/left/input/trigger/value " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Trigger click " , " /user/hand/left " , " /user/hand/left/input/trigger/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Trigger " , " /user/hand/right " , " /user/hand/right/input/trigger/value " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Trigger click " , " /user/hand/right " , " /user/hand/right/input/trigger/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Squeeze click " , " /user/hand/left " , " /user/hand/left/input/squeeze/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Squeeze click " , " /user/hand/right " , " /user/hand/right/input/squeeze/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Thumbstick " , " /user/hand/left " , " /user/hand/left/input/thumbstick " , " " , OpenXRAction : : OPENXR_ACTION_VECTOR2 ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Thumbstick click " , " /user/hand/left " , " /user/hand/left/input/thumbstick/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Thumbstick " , " /user/hand/right " , " /user/hand/right/input/thumbstick " , " " , OpenXRAction : : OPENXR_ACTION_VECTOR2 ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Thumbstick click " , " /user/hand/right " , " /user/hand/right/input/thumbstick/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Trackpad " , " /user/hand/left " , " /user/hand/left/input/trackpad " , " " , OpenXRAction : : OPENXR_ACTION_VECTOR2 ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Trackpad click " , " /user/hand/left " , " /user/hand/left/input/trackpad/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Trackpad touch " , " /user/hand/left " , " /user/hand/left/input/trackpad/touch " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Trackpad " , " /user/hand/right " , " /user/hand/right/input/trackpad " , " " , OpenXRAction : : OPENXR_ACTION_VECTOR2 ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Trackpad click " , " /user/hand/right " , " /user/hand/right/input/trackpad/click " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Trackpad touch " , " /user/hand/right " , " /user/hand/right/input/trackpad/touch " , " " , OpenXRAction : : OPENXR_ACTION_BOOL ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Haptic output " , " /user/hand/left " , " /user/hand/left/output/haptic " , " " , OpenXRAction : : OPENXR_ACTION_HAPTIC ) ;
metadata - > register_io_path ( " /interaction_profiles/samsung/odyssey_controller " , " Haptic output " , " /user/hand/right " , " /user/hand/right/output/haptic " , " " , OpenXRAction : : OPENXR_ACTION_HAPTIC ) ;
2024-06-12 11:16:43 +02:00
// MSFT Hand interaction profile, also supported by other headsets
metadata - > register_interaction_profile ( " MSFT Hand interaction " , " /interaction_profiles/microsoft/hand_interaction " , XR_MSFT_HAND_INTERACTION_EXTENSION_NAME ) ;
metadata - > register_io_path ( " /interaction_profiles/microsoft/hand_interaction " , " Grip pose " , " /user/hand/left " , " /user/hand/left/input/grip/pose " , " " , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/microsoft/hand_interaction " , " Grip pose " , " /user/hand/right " , " /user/hand/right/input/grip/pose " , " " , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/microsoft/hand_interaction " , " Aim pose " , " /user/hand/left " , " /user/hand/left/input/aim/pose " , " " , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/microsoft/hand_interaction " , " Aim pose " , " /user/hand/right " , " /user/hand/right/input/aim/pose " , " " , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/microsoft/hand_interaction " , " Pinch pose " , " /user/hand/left " , " /user/hand/left/input/pinch_ext/pose " , XR_EXT_HAND_INTERACTION_EXTENSION_NAME , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/microsoft/hand_interaction " , " Pinch pose " , " /user/hand/right " , " /user/hand/right/input/pinch_ext/pose " , XR_EXT_HAND_INTERACTION_EXTENSION_NAME , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/microsoft/hand_interaction " , " Poke pose " , " /user/hand/left " , " /user/hand/left/input/poke_ext/pose " , XR_EXT_HAND_INTERACTION_EXTENSION_NAME , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/microsoft/hand_interaction " , " Poke pose " , " /user/hand/right " , " /user/hand/right/input/poke_ext/pose " , XR_EXT_HAND_INTERACTION_EXTENSION_NAME , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/microsoft/hand_interaction " , " Palm pose " , " /user/hand/left " , " /user/hand/left/input/palm_ext/pose " , XR_EXT_PALM_POSE_EXTENSION_NAME , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/microsoft/hand_interaction " , " Palm pose " , " /user/hand/right " , " /user/hand/right/input/palm_ext/pose " , XR_EXT_PALM_POSE_EXTENSION_NAME , OpenXRAction : : OPENXR_ACTION_POSE ) ;
metadata - > register_io_path ( " /interaction_profiles/microsoft/hand_interaction " , " Select (pinch) " , " /user/hand/left " , " /user/hand/left/input/select/value " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
metadata - > register_io_path ( " /interaction_profiles/microsoft/hand_interaction " , " Select (pinch) " , " /user/hand/right " , " /user/hand/right/input/select/value " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
metadata - > register_io_path ( " /interaction_profiles/microsoft/hand_interaction " , " Squeeze (grab) " , " /user/hand/left " , " /user/hand/left/input/squeeze/value " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
metadata - > register_io_path ( " /interaction_profiles/microsoft/hand_interaction " , " Squeeze (grab) " , " /user/hand/right " , " /user/hand/right/input/squeeze/value " , " " , OpenXRAction : : OPENXR_ACTION_FLOAT ) ;
2022-12-29 06:34:25 +01:00
}