initial commit, 4.5 stable

modules/openxr/extensions/openxr_hand_tracking_extension.h

@@ -0,0 +1,128 @@
+/**************************************************************************/
+/*  openxr_hand_tracking_extension.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.                 */
+/**************************************************************************/
+
+#pragma once
+
+#include "../util.h"
+#include "core/math/quaternion.h"
+#include "openxr_extension_wrapper.h"
+#include "servers/xr/xr_hand_tracker.h"
+
+class OpenXRHandTrackingExtension : public OpenXRExtensionWrapper {
+	GDCLASS(OpenXRHandTrackingExtension, OpenXRExtensionWrapper);
+
+protected:
+	static void _bind_methods() {}
+
+public:
+	enum HandTrackedHands {
+		OPENXR_TRACKED_LEFT_HAND,
+		OPENXR_TRACKED_RIGHT_HAND,
+		OPENXR_MAX_TRACKED_HANDS
+	};
+
+	enum HandTrackedSource {
+		OPENXR_SOURCE_UNKNOWN,
+		OPENXR_SOURCE_UNOBSTRUCTED,
+		OPENXR_SOURCE_CONTROLLER,
+		OPENXR_SOURCE_NOT_TRACKED,
+		OPENXR_SOURCE_MAX
+	};
+
+	struct HandTracker {
+		bool is_initialized = false;
+		Ref<XRHandTracker> godot_tracker;
+		XrHandJointsMotionRangeEXT motion_range = XR_HAND_JOINTS_MOTION_RANGE_UNOBSTRUCTED_EXT;
+		HandTrackedSource source = OPENXR_SOURCE_UNKNOWN;
+
+		XrHandTrackerEXT hand_tracker = XR_NULL_HANDLE;
+		XrHandJointLocationEXT joint_locations[XR_HAND_JOINT_COUNT_EXT];
+		XrHandJointVelocityEXT joint_velocities[XR_HAND_JOINT_COUNT_EXT];
+
+		XrHandJointVelocitiesEXT velocities;
+		XrHandJointLocationsEXT locations;
+		XrHandTrackingDataSourceStateEXT data_source;
+	};
+
+	static OpenXRHandTrackingExtension *get_singleton();
+
+	OpenXRHandTrackingExtension();
+	virtual ~OpenXRHandTrackingExtension() override;
+
+	virtual HashMap<String, bool *> get_requested_extensions() override;
+
+	virtual void on_instance_created(const XrInstance p_instance) override;
+	virtual void on_instance_destroyed() override;
+	virtual void on_session_destroyed() override;
+
+	virtual void *set_system_properties_and_get_next_pointer(void *p_next_pointer) override;
+	virtual void on_state_ready() override;
+	virtual void on_process() override;
+	virtual void on_state_stopping() override;
+
+	bool get_active();
+	const HandTracker *get_hand_tracker(HandTrackedHands p_hand) const;
+
+	XrHandJointsMotionRangeEXT get_motion_range(HandTrackedHands p_hand) const;
+	void set_motion_range(HandTrackedHands p_hand, XrHandJointsMotionRangeEXT p_motion_range);
+
+	HandTrackedSource get_hand_tracking_source(HandTrackedHands p_hand) const;
+
+	XrSpaceLocationFlags get_hand_joint_location_flags(HandTrackedHands p_hand, XrHandJointEXT p_joint) const;
+	Quaternion get_hand_joint_rotation(HandTrackedHands p_hand, XrHandJointEXT p_joint) const;
+	Vector3 get_hand_joint_position(HandTrackedHands p_hand, XrHandJointEXT p_joint) const;
+	float get_hand_joint_radius(HandTrackedHands p_hand, XrHandJointEXT p_joint) const;
+
+	XrSpaceVelocityFlags get_hand_joint_velocity_flags(HandTrackedHands p_hand, XrHandJointEXT p_joint) const;
+	Vector3 get_hand_joint_linear_velocity(HandTrackedHands p_hand, XrHandJointEXT p_joint) const;
+	Vector3 get_hand_joint_angular_velocity(HandTrackedHands p_hand, XrHandJointEXT p_joint) const;
+
+private:
+	static OpenXRHandTrackingExtension *singleton;
+
+	// state
+	XrSystemHandTrackingPropertiesEXT handTrackingSystemProperties;
+	HandTracker hand_trackers[OPENXR_MAX_TRACKED_HANDS]; // Fixed for left and right hand
+
+	// related extensions
+	bool hand_tracking_ext = false;
+	bool hand_motion_range_ext = false;
+	bool hand_tracking_source_ext = false;
+	bool unobstructed_data_source = false;
+	bool controller_data_source = false;
+
+	// functions
+	void cleanup_hand_tracking();
+
+	// OpenXR API call wrappers
+	EXT_PROTO_XRRESULT_FUNC3(xrCreateHandTrackerEXT, (XrSession), p_session, (const XrHandTrackerCreateInfoEXT *), p_createInfo, (XrHandTrackerEXT *), p_handTracker)
+	EXT_PROTO_XRRESULT_FUNC1(xrDestroyHandTrackerEXT, (XrHandTrackerEXT), p_handTracker)
+	EXT_PROTO_XRRESULT_FUNC3(xrLocateHandJointsEXT, (XrHandTrackerEXT), p_handTracker, (const XrHandJointsLocateInfoEXT *), p_locateInfo, (XrHandJointLocationsEXT *), p_locations)
+};