blob: 79ea237480ad1e62277a6d9d2fb98ddf60e8eac6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="XRHandTracker" inherits="XRPositionalTracker" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
A tracked hand in XR.
</brief_description>
<description>
A hand tracking system will create an instance of this object and add it to the [XRServer]. This tracking system will then obtain skeleton data, convert it to the Godot Humanoid hand skeleton and store this data on the [XRHandTracker] object.
Use [XRHandModifier3D] to animate a hand mesh using hand tracking data.
</description>
<tutorials>
<link title="XR documentation index">$DOCS_URL/tutorials/xr/index.html</link>
</tutorials>
<methods>
<method name="get_hand_joint_angular_velocity" qualifiers="const">
<return type="Vector3" />
<param index="0" name="joint" type="int" enum="XRHandTracker.HandJoint" />
<description>
Returns the angular velocity for the given hand joint.
</description>
</method>
<method name="get_hand_joint_flags" qualifiers="const">
<return type="int" enum="XRHandTracker.HandJointFlags" is_bitfield="true" />
<param index="0" name="joint" type="int" enum="XRHandTracker.HandJoint" />
<description>
Returns flags about the validity of the tracking data for the given hand joint (see [enum XRHandTracker.HandJointFlags]).
</description>
</method>
<method name="get_hand_joint_linear_velocity" qualifiers="const">
<return type="Vector3" />
<param index="0" name="joint" type="int" enum="XRHandTracker.HandJoint" />
<description>
Returns the linear velocity for the given hand joint.
</description>
</method>
<method name="get_hand_joint_radius" qualifiers="const">
<return type="float" />
<param index="0" name="joint" type="int" enum="XRHandTracker.HandJoint" />
<description>
Returns the radius of the given hand joint.
</description>
</method>
<method name="get_hand_joint_transform" qualifiers="const">
<return type="Transform3D" />
<param index="0" name="joint" type="int" enum="XRHandTracker.HandJoint" />
<description>
Returns the transform for the given hand joint.
</description>
</method>
<method name="set_hand_joint_angular_velocity">
<return type="void" />
<param index="0" name="joint" type="int" enum="XRHandTracker.HandJoint" />
<param index="1" name="angular_velocity" type="Vector3" />
<description>
Sets the angular velocity for the given hand joint.
</description>
</method>
<method name="set_hand_joint_flags">
<return type="void" />
<param index="0" name="joint" type="int" enum="XRHandTracker.HandJoint" />
<param index="1" name="flags" type="int" enum="XRHandTracker.HandJointFlags" is_bitfield="true" />
<description>
Sets flags about the validity of the tracking data for the given hand joint.
</description>
</method>
<method name="set_hand_joint_linear_velocity">
<return type="void" />
<param index="0" name="joint" type="int" enum="XRHandTracker.HandJoint" />
<param index="1" name="linear_velocity" type="Vector3" />
<description>
Sets the linear velocity for the given hand joint.
</description>
</method>
<method name="set_hand_joint_radius">
<return type="void" />
<param index="0" name="joint" type="int" enum="XRHandTracker.HandJoint" />
<param index="1" name="radius" type="float" />
<description>
Sets the radius of the given hand joint.
</description>
</method>
<method name="set_hand_joint_transform">
<return type="void" />
<param index="0" name="joint" type="int" enum="XRHandTracker.HandJoint" />
<param index="1" name="transform" type="Transform3D" />
<description>
Sets the transform for the given hand joint.
</description>
</method>
</methods>
<members>
<member name="hand" type="int" setter="set_tracker_hand" getter="get_tracker_hand" overrides="XRPositionalTracker" enum="XRPositionalTracker.TrackerHand" default="1" />
<member name="hand_tracking_source" type="int" setter="set_hand_tracking_source" getter="get_hand_tracking_source" enum="XRHandTracker.HandTrackingSource" default="0">
The source of the hand tracking data.
</member>
<member name="has_tracking_data" type="bool" setter="set_has_tracking_data" getter="get_has_tracking_data" default="false">
If [code]true[/code], the hand tracking data is valid.
</member>
<member name="type" type="int" setter="set_tracker_type" getter="get_tracker_type" overrides="XRTracker" enum="XRServer.TrackerType" default="16" />
</members>
<constants>
<constant name="HAND_TRACKING_SOURCE_UNKNOWN" value="0" enum="HandTrackingSource">
The source of hand tracking data is unknown.
</constant>
<constant name="HAND_TRACKING_SOURCE_UNOBSTRUCTED" value="1" enum="HandTrackingSource">
The source of hand tracking data is unobstructed, meaning that an accurate method of hand tracking is used. These include optical hand tracking, data gloves, etc.
</constant>
<constant name="HAND_TRACKING_SOURCE_CONTROLLER" value="2" enum="HandTrackingSource">
The source of hand tracking data is a controller, meaning that joint positions are inferred from controller inputs.
</constant>
<constant name="HAND_TRACKING_SOURCE_NOT_TRACKED" value="3" enum="HandTrackingSource">
No hand tracking data is tracked, this either means the hand is obscured, the controller is turned off, or tracking is not supported for the current input type.
</constant>
<constant name="HAND_TRACKING_SOURCE_MAX" value="4" enum="HandTrackingSource">
Represents the size of the [enum HandTrackingSource] enum.
</constant>
<constant name="HAND_JOINT_PALM" value="0" enum="HandJoint">
Palm joint.
</constant>
<constant name="HAND_JOINT_WRIST" value="1" enum="HandJoint">
Wrist joint.
</constant>
<constant name="HAND_JOINT_THUMB_METACARPAL" value="2" enum="HandJoint">
Thumb metacarpal joint.
</constant>
<constant name="HAND_JOINT_THUMB_PHALANX_PROXIMAL" value="3" enum="HandJoint">
Thumb phalanx proximal joint.
</constant>
<constant name="HAND_JOINT_THUMB_PHALANX_DISTAL" value="4" enum="HandJoint">
Thumb phalanx distal joint.
</constant>
<constant name="HAND_JOINT_THUMB_TIP" value="5" enum="HandJoint">
Thumb tip joint.
</constant>
<constant name="HAND_JOINT_INDEX_FINGER_METACARPAL" value="6" enum="HandJoint">
Index finger metacarpal joint.
</constant>
<constant name="HAND_JOINT_INDEX_FINGER_PHALANX_PROXIMAL" value="7" enum="HandJoint">
Index finger phalanx proximal joint.
</constant>
<constant name="HAND_JOINT_INDEX_FINGER_PHALANX_INTERMEDIATE" value="8" enum="HandJoint">
Index finger phalanx intermediate joint.
</constant>
<constant name="HAND_JOINT_INDEX_FINGER_PHALANX_DISTAL" value="9" enum="HandJoint">
Index finger phalanx distal joint.
</constant>
<constant name="HAND_JOINT_INDEX_FINGER_TIP" value="10" enum="HandJoint">
Index finger tip joint.
</constant>
<constant name="HAND_JOINT_MIDDLE_FINGER_METACARPAL" value="11" enum="HandJoint">
Middle finger metacarpal joint.
</constant>
<constant name="HAND_JOINT_MIDDLE_FINGER_PHALANX_PROXIMAL" value="12" enum="HandJoint">
Middle finger phalanx proximal joint.
</constant>
<constant name="HAND_JOINT_MIDDLE_FINGER_PHALANX_INTERMEDIATE" value="13" enum="HandJoint">
Middle finger phalanx intermediate joint.
</constant>
<constant name="HAND_JOINT_MIDDLE_FINGER_PHALANX_DISTAL" value="14" enum="HandJoint">
Middle finger phalanx distal joint.
</constant>
<constant name="HAND_JOINT_MIDDLE_FINGER_TIP" value="15" enum="HandJoint">
Middle finger tip joint.
</constant>
<constant name="HAND_JOINT_RING_FINGER_METACARPAL" value="16" enum="HandJoint">
Ring finger metacarpal joint.
</constant>
<constant name="HAND_JOINT_RING_FINGER_PHALANX_PROXIMAL" value="17" enum="HandJoint">
Ring finger phalanx proximal joint.
</constant>
<constant name="HAND_JOINT_RING_FINGER_PHALANX_INTERMEDIATE" value="18" enum="HandJoint">
Ring finger phalanx intermediate joint.
</constant>
<constant name="HAND_JOINT_RING_FINGER_PHALANX_DISTAL" value="19" enum="HandJoint">
Ring finger phalanx distal joint.
</constant>
<constant name="HAND_JOINT_RING_FINGER_TIP" value="20" enum="HandJoint">
Ring finger tip joint.
</constant>
<constant name="HAND_JOINT_PINKY_FINGER_METACARPAL" value="21" enum="HandJoint">
Pinky finger metacarpal joint.
</constant>
<constant name="HAND_JOINT_PINKY_FINGER_PHALANX_PROXIMAL" value="22" enum="HandJoint">
Pinky finger phalanx proximal joint.
</constant>
<constant name="HAND_JOINT_PINKY_FINGER_PHALANX_INTERMEDIATE" value="23" enum="HandJoint">
Pinky finger phalanx intermediate joint.
</constant>
<constant name="HAND_JOINT_PINKY_FINGER_PHALANX_DISTAL" value="24" enum="HandJoint">
Pinky finger phalanx distal joint.
</constant>
<constant name="HAND_JOINT_PINKY_FINGER_TIP" value="25" enum="HandJoint">
Pinky finger tip joint.
</constant>
<constant name="HAND_JOINT_MAX" value="26" enum="HandJoint">
Represents the size of the [enum HandJoint] enum.
</constant>
<constant name="HAND_JOINT_FLAG_ORIENTATION_VALID" value="1" enum="HandJointFlags" is_bitfield="true">
The hand joint's orientation data is valid.
</constant>
<constant name="HAND_JOINT_FLAG_ORIENTATION_TRACKED" value="2" enum="HandJointFlags" is_bitfield="true">
The hand joint's orientation is actively tracked. May not be set if tracking has been temporarily lost.
</constant>
<constant name="HAND_JOINT_FLAG_POSITION_VALID" value="4" enum="HandJointFlags" is_bitfield="true">
The hand joint's position data is valid.
</constant>
<constant name="HAND_JOINT_FLAG_POSITION_TRACKED" value="8" enum="HandJointFlags" is_bitfield="true">
The hand joint's position is actively tracked. May not be set if tracking has been temporarily lost.
</constant>
<constant name="HAND_JOINT_FLAG_LINEAR_VELOCITY_VALID" value="16" enum="HandJointFlags" is_bitfield="true">
The hand joint's linear velocity data is valid.
</constant>
<constant name="HAND_JOINT_FLAG_ANGULAR_VELOCITY_VALID" value="32" enum="HandJointFlags" is_bitfield="true">
The hand joint's angular velocity data is valid.
</constant>
</constants>
</class>
|
