Attention: Here be dragons (unstable version)
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Redot.
Checking the stable version of the documentation...
XRBodyTracker
Experimental: This class may be changed or removed in future versions.
Inherits: XRPositionalTracker < XRTracker < RefCounted < Object
A tracked body in XR.
Description
A body 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 Redot Humanoid skeleton and store this data on the XRBodyTracker object.
Use XRBodyModifier3D to animate a body mesh using body tracking data.
Tutorials
Properties
BitField[BodyFlags] |
|
|
|
||
type |
|
Methods
BitField[JointFlags] |
get_joint_flags(joint: Joint) const |
get_joint_transform(joint: Joint) const |
|
void |
set_joint_flags(joint: Joint, flags: BitField[JointFlags]) |
void |
set_joint_transform(joint: Joint, transform: Transform3D) |
Enumerations
flags BodyFlags: 🔗
BodyFlags BODY_FLAG_UPPER_BODY_SUPPORTED = 1
Upper body tracking supported.
BodyFlags BODY_FLAG_LOWER_BODY_SUPPORTED = 2
Lower body tracking supported.
BodyFlags BODY_FLAG_HANDS_SUPPORTED = 4
Hand tracking supported.
enum Joint: 🔗
Joint JOINT_ROOT = 0
Root joint.
Joint JOINT_HIPS = 1
Hips joint.
Joint JOINT_SPINE = 2
Spine joint.
Joint JOINT_CHEST = 3
Chest joint.
Joint JOINT_UPPER_CHEST = 4
Upper chest joint.
Joint JOINT_NECK = 5
Neck joint.
Joint JOINT_HEAD = 6
Head joint.
Joint JOINT_HEAD_TIP = 7
Head tip joint.
Joint JOINT_LEFT_SHOULDER = 8
Left shoulder joint.
Joint JOINT_LEFT_UPPER_ARM = 9
Left upper arm joint.
Joint JOINT_LEFT_LOWER_ARM = 10
Left lower arm joint.
Joint JOINT_RIGHT_SHOULDER = 11
Right shoulder joint.
Joint JOINT_RIGHT_UPPER_ARM = 12
Right upper arm joint.
Joint JOINT_RIGHT_LOWER_ARM = 13
Right lower arm joint.
Joint JOINT_LEFT_UPPER_LEG = 14
Left upper leg joint.
Joint JOINT_LEFT_LOWER_LEG = 15
Left lower leg joint.
Joint JOINT_LEFT_FOOT = 16
Left foot joint.
Joint JOINT_LEFT_TOES = 17
Left toes joint.
Joint JOINT_RIGHT_UPPER_LEG = 18
Right upper leg joint.
Joint JOINT_RIGHT_LOWER_LEG = 19
Right lower leg joint.
Joint JOINT_RIGHT_FOOT = 20
Right foot joint.
Joint JOINT_RIGHT_TOES = 21
Right toes joint.
Joint JOINT_LEFT_HAND = 22
Left hand joint.
Joint JOINT_LEFT_PALM = 23
Left palm joint.
Joint JOINT_LEFT_WRIST = 24
Left wrist joint.
Joint JOINT_LEFT_THUMB_METACARPAL = 25
Left thumb metacarpal joint.
Joint JOINT_LEFT_THUMB_PHALANX_PROXIMAL = 26
Left thumb phalanx proximal joint.
Joint JOINT_LEFT_THUMB_PHALANX_DISTAL = 27
Left thumb phalanx distal joint.
Joint JOINT_LEFT_THUMB_TIP = 28
Left thumb tip joint.
Joint JOINT_LEFT_INDEX_FINGER_METACARPAL = 29
Left index finger metacarpal joint.
Joint JOINT_LEFT_INDEX_FINGER_PHALANX_PROXIMAL = 30
Left index finger phalanx proximal joint.
Joint JOINT_LEFT_INDEX_FINGER_PHALANX_INTERMEDIATE = 31
Left index finger phalanx intermediate joint.
Joint JOINT_LEFT_INDEX_FINGER_PHALANX_DISTAL = 32
Left index finger phalanx distal joint.
Joint JOINT_LEFT_INDEX_FINGER_TIP = 33
Left index finger tip joint.
Joint JOINT_LEFT_MIDDLE_FINGER_METACARPAL = 34
Left middle finger metacarpal joint.
Joint JOINT_LEFT_MIDDLE_FINGER_PHALANX_PROXIMAL = 35
Left middle finger phalanx proximal joint.
Joint JOINT_LEFT_MIDDLE_FINGER_PHALANX_INTERMEDIATE = 36
Left middle finger phalanx intermediate joint.
Joint JOINT_LEFT_MIDDLE_FINGER_PHALANX_DISTAL = 37
Left middle finger phalanx distal joint.
Joint JOINT_LEFT_MIDDLE_FINGER_TIP = 38
Left middle finger tip joint.
Joint JOINT_LEFT_RING_FINGER_METACARPAL = 39
Left ring finger metacarpal joint.
Joint JOINT_LEFT_RING_FINGER_PHALANX_PROXIMAL = 40
Left ring finger phalanx proximal joint.
Joint JOINT_LEFT_RING_FINGER_PHALANX_INTERMEDIATE = 41
Left ring finger phalanx intermediate joint.
Joint JOINT_LEFT_RING_FINGER_PHALANX_DISTAL = 42
Left ring finger phalanx distal joint.
Joint JOINT_LEFT_RING_FINGER_TIP = 43
Left ring finger tip joint.
Joint JOINT_LEFT_PINKY_FINGER_METACARPAL = 44
Left pinky finger metacarpal joint.
Joint JOINT_LEFT_PINKY_FINGER_PHALANX_PROXIMAL = 45
Left pinky finger phalanx proximal joint.
Joint JOINT_LEFT_PINKY_FINGER_PHALANX_INTERMEDIATE = 46
Left pinky finger phalanx intermediate joint.
Joint JOINT_LEFT_PINKY_FINGER_PHALANX_DISTAL = 47
Left pinky finger phalanx distal joint.
Joint JOINT_LEFT_PINKY_FINGER_TIP = 48
Left pinky finger tip joint.
Joint JOINT_RIGHT_HAND = 49
Right hand joint.
Joint JOINT_RIGHT_PALM = 50
Right palm joint.
Joint JOINT_RIGHT_WRIST = 51
Right wrist joint.
Joint JOINT_RIGHT_THUMB_METACARPAL = 52
Right thumb metacarpal joint.
Joint JOINT_RIGHT_THUMB_PHALANX_PROXIMAL = 53
Right thumb phalanx proximal joint.
Joint JOINT_RIGHT_THUMB_PHALANX_DISTAL = 54
Right thumb phalanx distal joint.
Joint JOINT_RIGHT_THUMB_TIP = 55
Right thumb tip joint.
Joint JOINT_RIGHT_INDEX_FINGER_METACARPAL = 56
Right index finger metacarpal joint.
Joint JOINT_RIGHT_INDEX_FINGER_PHALANX_PROXIMAL = 57
Right index finger phalanx proximal joint.
Joint JOINT_RIGHT_INDEX_FINGER_PHALANX_INTERMEDIATE = 58
Right index finger phalanx intermediate joint.
Joint JOINT_RIGHT_INDEX_FINGER_PHALANX_DISTAL = 59
Right index finger phalanx distal joint.
Joint JOINT_RIGHT_INDEX_FINGER_TIP = 60
Right index finger tip joint.
Joint JOINT_RIGHT_MIDDLE_FINGER_METACARPAL = 61
Right middle finger metacarpal joint.
Joint JOINT_RIGHT_MIDDLE_FINGER_PHALANX_PROXIMAL = 62
Right middle finger phalanx proximal joint.
Joint JOINT_RIGHT_MIDDLE_FINGER_PHALANX_INTERMEDIATE = 63
Right middle finger phalanx intermediate joint.
Joint JOINT_RIGHT_MIDDLE_FINGER_PHALANX_DISTAL = 64
Right middle finger phalanx distal joint.
Joint JOINT_RIGHT_MIDDLE_FINGER_TIP = 65
Right middle finger tip joint.
Joint JOINT_RIGHT_RING_FINGER_METACARPAL = 66
Right ring finger metacarpal joint.
Joint JOINT_RIGHT_RING_FINGER_PHALANX_PROXIMAL = 67
Right ring finger phalanx proximal joint.
Joint JOINT_RIGHT_RING_FINGER_PHALANX_INTERMEDIATE = 68
Right ring finger phalanx intermediate joint.
Joint JOINT_RIGHT_RING_FINGER_PHALANX_DISTAL = 69
Right ring finger phalanx distal joint.
Joint JOINT_RIGHT_RING_FINGER_TIP = 70
Right ring finger tip joint.
Joint JOINT_RIGHT_PINKY_FINGER_METACARPAL = 71
Right pinky finger metacarpal joint.
Joint JOINT_RIGHT_PINKY_FINGER_PHALANX_PROXIMAL = 72
Right pinky finger phalanx proximal joint.
Joint JOINT_RIGHT_PINKY_FINGER_PHALANX_INTERMEDIATE = 73
Right pinky finger phalanx intermediate joint.
Joint JOINT_RIGHT_PINKY_FINGER_PHALANX_DISTAL = 74
Right pinky finger phalanx distal joint.
Joint JOINT_RIGHT_PINKY_FINGER_TIP = 75
Right pinky finger tip joint.
Joint JOINT_MAX = 76
Represents the size of the Joint enum.
flags JointFlags: 🔗
JointFlags JOINT_FLAG_ORIENTATION_VALID = 1
The joint's orientation data is valid.
JointFlags JOINT_FLAG_ORIENTATION_TRACKED = 2
The joint's orientation is actively tracked. May not be set if tracking has been temporarily lost.
JointFlags JOINT_FLAG_POSITION_VALID = 4
The joint's position data is valid.
JointFlags JOINT_FLAG_POSITION_TRACKED = 8
The joint's position is actively tracked. May not be set if tracking has been temporarily lost.
Property Descriptions
BitField[BodyFlags] body_flags = 0 🔗
The type of body tracking data captured.
bool has_tracking_data = false 🔗
If true, the body tracking data is valid.
Method Descriptions
BitField[JointFlags] get_joint_flags(joint: Joint) const 🔗
Returns flags about the validity of the tracking data for the given body joint (see JointFlags).
Transform3D get_joint_transform(joint: Joint) const 🔗
Returns the transform for the given body joint.
void set_joint_flags(joint: Joint, flags: BitField[JointFlags]) 🔗
Sets flags about the validity of the tracking data for the given body joint.
void set_joint_transform(joint: Joint, transform: Transform3D) 🔗
Sets the transform for the given body joint.