138 lines
5.5 KiB
C++
138 lines
5.5 KiB
C++
/**************************************************************************/
|
|
/* xr_hand_tracker.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 XR_HAND_TRACKER_H
|
|
#define XR_HAND_TRACKER_H
|
|
|
|
#include "core/object/ref_counted.h"
|
|
|
|
class XRHandTracker : public RefCounted {
|
|
GDCLASS(XRHandTracker, RefCounted);
|
|
_THREAD_SAFE_CLASS_
|
|
|
|
public:
|
|
enum Hand {
|
|
HAND_LEFT,
|
|
HAND_RIGHT,
|
|
HAND_MAX,
|
|
};
|
|
|
|
enum HandTrackingSource {
|
|
HAND_TRACKING_SOURCE_UNKNOWN,
|
|
HAND_TRACKING_SOURCE_UNOBSTRUCTED,
|
|
HAND_TRACKING_SOURCE_CONTROLLER,
|
|
HAND_TRACKING_SOURCE_MAX
|
|
};
|
|
|
|
enum HandJoint {
|
|
HAND_JOINT_PALM,
|
|
HAND_JOINT_WRIST,
|
|
HAND_JOINT_THUMB_METACARPAL,
|
|
HAND_JOINT_THUMB_PHALANX_PROXIMAL,
|
|
HAND_JOINT_THUMB_PHALANX_DISTAL,
|
|
HAND_JOINT_THUMB_TIP,
|
|
HAND_JOINT_INDEX_FINGER_METACARPAL,
|
|
HAND_JOINT_INDEX_FINGER_PHALANX_PROXIMAL,
|
|
HAND_JOINT_INDEX_FINGER_PHALANX_INTERMEDIATE,
|
|
HAND_JOINT_INDEX_FINGER_PHALANX_DISTAL,
|
|
HAND_JOINT_INDEX_FINGER_TIP,
|
|
HAND_JOINT_MIDDLE_FINGER_METACARPAL,
|
|
HAND_JOINT_MIDDLE_FINGER_PHALANX_PROXIMAL,
|
|
HAND_JOINT_MIDDLE_FINGER_PHALANX_INTERMEDIATE,
|
|
HAND_JOINT_MIDDLE_FINGER_PHALANX_DISTAL,
|
|
HAND_JOINT_MIDDLE_FINGER_TIP,
|
|
HAND_JOINT_RING_FINGER_METACARPAL,
|
|
HAND_JOINT_RING_FINGER_PHALANX_PROXIMAL,
|
|
HAND_JOINT_RING_FINGER_PHALANX_INTERMEDIATE,
|
|
HAND_JOINT_RING_FINGER_PHALANX_DISTAL,
|
|
HAND_JOINT_RING_FINGER_TIP,
|
|
HAND_JOINT_PINKY_FINGER_METACARPAL,
|
|
HAND_JOINT_PINKY_FINGER_PHALANX_PROXIMAL,
|
|
HAND_JOINT_PINKY_FINGER_PHALANX_INTERMEDIATE,
|
|
HAND_JOINT_PINKY_FINGER_PHALANX_DISTAL,
|
|
HAND_JOINT_PINKY_FINGER_TIP,
|
|
HAND_JOINT_MAX,
|
|
};
|
|
|
|
enum HandJointFlags {
|
|
HAND_JOINT_FLAG_ORIENTATION_VALID = 1,
|
|
HAND_JOINT_FLAG_ORIENTATION_TRACKED = 2,
|
|
HAND_JOINT_FLAG_POSITION_VALID = 4,
|
|
HAND_JOINT_FLAG_POSITION_TRACKED = 8,
|
|
HAND_JOINT_FLAG_LINEAR_VELOCITY_VALID = 16,
|
|
HAND_JOINT_FLAG_ANGULAR_VELOCITY_VALID = 32,
|
|
};
|
|
|
|
void set_hand(Hand p_hand);
|
|
Hand get_hand() const;
|
|
|
|
void set_has_tracking_data(bool p_has_tracking_data);
|
|
bool get_has_tracking_data() const;
|
|
|
|
void set_hand_tracking_source(HandTrackingSource p_source);
|
|
HandTrackingSource get_hand_tracking_source() const;
|
|
|
|
void set_hand_joint_flags(HandJoint p_joint, BitField<HandJointFlags> p_flags);
|
|
BitField<HandJointFlags> get_hand_joint_flags(HandJoint p_joint) const;
|
|
|
|
void set_hand_joint_transform(HandJoint p_joint, const Transform3D &p_transform);
|
|
Transform3D get_hand_joint_transform(HandJoint p_joint) const;
|
|
|
|
void set_hand_joint_radius(HandJoint p_joint, float p_radius);
|
|
float get_hand_joint_radius(HandJoint p_joint) const;
|
|
|
|
void set_hand_joint_linear_velocity(HandJoint p_joint, const Vector3 &p_velocity);
|
|
Vector3 get_hand_joint_linear_velocity(HandJoint p_joint) const;
|
|
|
|
void set_hand_joint_angular_velocity(HandJoint p_joint, const Vector3 &p_velocity);
|
|
Vector3 get_hand_joint_angular_velocity(HandJoint p_joint) const;
|
|
|
|
protected:
|
|
static void _bind_methods();
|
|
|
|
private:
|
|
Hand hand = HAND_LEFT;
|
|
bool has_tracking_data = false;
|
|
HandTrackingSource hand_tracking_source = HAND_TRACKING_SOURCE_UNKNOWN;
|
|
|
|
BitField<HandJointFlags> hand_joint_flags[HAND_JOINT_MAX];
|
|
Transform3D hand_joint_transforms[HAND_JOINT_MAX];
|
|
float hand_joint_radii[HAND_JOINT_MAX] = {};
|
|
Vector3 hand_joint_linear_velocities[HAND_JOINT_MAX];
|
|
Vector3 hand_joint_angular_velocities[HAND_JOINT_MAX];
|
|
};
|
|
|
|
VARIANT_ENUM_CAST(XRHandTracker::Hand)
|
|
VARIANT_ENUM_CAST(XRHandTracker::HandTrackingSource)
|
|
VARIANT_ENUM_CAST(XRHandTracker::HandJoint)
|
|
VARIANT_BITFIELD_CAST(XRHandTracker::HandJointFlags)
|
|
|
|
#endif // XR_HAND_TRACKER_H
|