1/**************************************************************************/
2/* openxr_hand.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef OPENXR_HAND_H
32#define OPENXR_HAND_H
33
34#include "scene/3d/node_3d.h"
35#include "scene/3d/skeleton_3d.h"
36
37#include <openxr/openxr.h>
38
39class OpenXRAPI;
40class OpenXRHandTrackingExtension;
41
42class OpenXRHand : public Node3D {
43 GDCLASS(OpenXRHand, Node3D);
44
45public:
46 enum Hands { // Deprecated, need to change this to OpenXRInterface::Hands.
47 HAND_LEFT,
48 HAND_RIGHT,
49 HAND_MAX
50 };
51
52 enum MotionRange { // Deprecated, need to change this to OpenXRInterface::HandMotionRange.
53 MOTION_RANGE_UNOBSTRUCTED,
54 MOTION_RANGE_CONFORM_TO_CONTROLLER,
55 MOTION_RANGE_MAX
56 };
57
58private:
59 OpenXRAPI *openxr_api = nullptr;
60 OpenXRHandTrackingExtension *hand_tracking_ext = nullptr;
61
62 Hands hand = HAND_LEFT;
63 MotionRange motion_range = MOTION_RANGE_UNOBSTRUCTED;
64 NodePath hand_skeleton;
65
66 int64_t bones[XR_HAND_JOINT_COUNT_EXT];
67
68 void _set_motion_range();
69
70 Skeleton3D *get_skeleton();
71 void _get_bones();
72 void _update_skeleton();
73
74protected:
75 static void _bind_methods();
76
77public:
78 OpenXRHand();
79
80 void set_hand(const Hands p_hand);
81 Hands get_hand() const;
82
83 void set_motion_range(const MotionRange p_motion_range);
84 MotionRange get_motion_range() const;
85
86 void set_hand_skeleton(const NodePath &p_hand_skeleton);
87 NodePath get_hand_skeleton() const;
88
89 void _notification(int p_what);
90};
91
92VARIANT_ENUM_CAST(OpenXRHand::Hands)
93VARIANT_ENUM_CAST(OpenXRHand::MotionRange)
94
95#endif // OPENXR_HAND_H
96