Class reference
XRBodyTracker
Inherits XRPositionalTracker
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.
Properties
Methods
int get_joint_flags(int joint) const
int get_joint_flags(int joint) constReturns flags about the validity of the tracking data for the given body joint.
Transform3D get_joint_transform(int joint) const
Transform3D get_joint_transform(int joint) constReturns the transform for the given body joint.
void set_joint_flags(int joint, int flags)
int joint, int flags)Sets flags about the validity of the tracking data for the given body joint.
void set_joint_transform(int joint, Transform3D transform)
int joint, Transform3D transform)Sets the transform for the given body joint.
Constants
BODY_FLAG_UPPER_BODY_SUPPORTED = 1
Upper body tracking supported.
BODY_FLAG_LOWER_BODY_SUPPORTED = 2
Lower body tracking supported.
BODY_FLAG_HANDS_SUPPORTED = 4
Hand tracking supported.
JOINT_ROOT = 0
Root joint.
JOINT_HIPS = 1
Hips joint.
JOINT_SPINE = 2
Spine joint.
JOINT_CHEST = 3
Chest joint.
JOINT_UPPER_CHEST = 4
Upper chest joint.
JOINT_NECK = 5
Neck joint.
JOINT_HEAD = 6
Head joint.
JOINT_HEAD_TIP = 7
Head tip joint.
JOINT_LEFT_SHOULDER = 8
Left shoulder joint.
JOINT_LEFT_UPPER_ARM = 9
Left upper arm joint.
JOINT_LEFT_LOWER_ARM = 10
Left lower arm joint.
JOINT_RIGHT_SHOULDER = 11
Right shoulder joint.
JOINT_RIGHT_UPPER_ARM = 12
Right upper arm joint.
JOINT_RIGHT_LOWER_ARM = 13
Right lower arm joint.
JOINT_LEFT_UPPER_LEG = 14
Left upper leg joint.
JOINT_LEFT_LOWER_LEG = 15
Left lower leg joint.
JOINT_LEFT_FOOT = 16
Left foot joint.
JOINT_LEFT_TOES = 17
Left toes joint.
JOINT_RIGHT_UPPER_LEG = 18
Right upper leg joint.
JOINT_RIGHT_LOWER_LEG = 19
Right lower leg joint.
JOINT_RIGHT_FOOT = 20
Right foot joint.
JOINT_RIGHT_TOES = 21
Right toes joint.
JOINT_LEFT_HAND = 22
Left hand joint.
JOINT_LEFT_PALM = 23
Left palm joint.
JOINT_LEFT_WRIST = 24
Left wrist joint.
JOINT_LEFT_THUMB_METACARPAL = 25
Left thumb metacarpal joint.
JOINT_LEFT_THUMB_PHALANX_PROXIMAL = 26
Left thumb phalanx proximal joint.
JOINT_LEFT_THUMB_PHALANX_DISTAL = 27
Left thumb phalanx distal joint.
JOINT_LEFT_THUMB_TIP = 28
Left thumb tip joint.
JOINT_LEFT_INDEX_FINGER_METACARPAL = 29
Left index finger metacarpal joint.
JOINT_LEFT_INDEX_FINGER_PHALANX_PROXIMAL = 30
Left index finger phalanx proximal joint.
JOINT_LEFT_INDEX_FINGER_PHALANX_INTERMEDIATE = 31
Left index finger phalanx intermediate joint.
JOINT_LEFT_INDEX_FINGER_PHALANX_DISTAL = 32
Left index finger phalanx distal joint.
JOINT_LEFT_INDEX_FINGER_TIP = 33
Left index finger tip joint.
JOINT_LEFT_MIDDLE_FINGER_METACARPAL = 34
Left middle finger metacarpal joint.
JOINT_LEFT_MIDDLE_FINGER_PHALANX_PROXIMAL = 35
Left middle finger phalanx proximal joint.
JOINT_LEFT_MIDDLE_FINGER_PHALANX_INTERMEDIATE = 36
Left middle finger phalanx intermediate joint.
JOINT_LEFT_MIDDLE_FINGER_PHALANX_DISTAL = 37
Left middle finger phalanx distal joint.
JOINT_LEFT_MIDDLE_FINGER_TIP = 38
Left middle finger tip joint.
JOINT_LEFT_RING_FINGER_METACARPAL = 39
Left ring finger metacarpal joint.
JOINT_LEFT_RING_FINGER_PHALANX_PROXIMAL = 40
Left ring finger phalanx proximal joint.
JOINT_LEFT_RING_FINGER_PHALANX_INTERMEDIATE = 41
Left ring finger phalanx intermediate joint.
JOINT_LEFT_RING_FINGER_PHALANX_DISTAL = 42
Left ring finger phalanx distal joint.
JOINT_LEFT_RING_FINGER_TIP = 43
Left ring finger tip joint.
JOINT_LEFT_PINKY_FINGER_METACARPAL = 44
Left pinky finger metacarpal joint.
JOINT_LEFT_PINKY_FINGER_PHALANX_PROXIMAL = 45
Left pinky finger phalanx proximal joint.
JOINT_LEFT_PINKY_FINGER_PHALANX_INTERMEDIATE = 46
Left pinky finger phalanx intermediate joint.
JOINT_LEFT_PINKY_FINGER_PHALANX_DISTAL = 47
Left pinky finger phalanx distal joint.
JOINT_LEFT_PINKY_FINGER_TIP = 48
Left pinky finger tip joint.
JOINT_RIGHT_HAND = 49
Right hand joint.
JOINT_RIGHT_PALM = 50
Right palm joint.
JOINT_RIGHT_WRIST = 51
Right wrist joint.
JOINT_RIGHT_THUMB_METACARPAL = 52
Right thumb metacarpal joint.
JOINT_RIGHT_THUMB_PHALANX_PROXIMAL = 53
Right thumb phalanx proximal joint.
JOINT_RIGHT_THUMB_PHALANX_DISTAL = 54
Right thumb phalanx distal joint.
JOINT_RIGHT_THUMB_TIP = 55
Right thumb tip joint.
JOINT_RIGHT_INDEX_FINGER_METACARPAL = 56
Right index finger metacarpal joint.
JOINT_RIGHT_INDEX_FINGER_PHALANX_PROXIMAL = 57
Right index finger phalanx proximal joint.
JOINT_RIGHT_INDEX_FINGER_PHALANX_INTERMEDIATE = 58
Right index finger phalanx intermediate joint.
JOINT_RIGHT_INDEX_FINGER_PHALANX_DISTAL = 59
Right index finger phalanx distal joint.
JOINT_RIGHT_INDEX_FINGER_TIP = 60
Right index finger tip joint.
JOINT_RIGHT_MIDDLE_FINGER_METACARPAL = 61
Right middle finger metacarpal joint.
JOINT_RIGHT_MIDDLE_FINGER_PHALANX_PROXIMAL = 62
Right middle finger phalanx proximal joint.
JOINT_RIGHT_MIDDLE_FINGER_PHALANX_INTERMEDIATE = 63
Right middle finger phalanx intermediate joint.
JOINT_RIGHT_MIDDLE_FINGER_PHALANX_DISTAL = 64
Right middle finger phalanx distal joint.
JOINT_RIGHT_MIDDLE_FINGER_TIP = 65
Right middle finger tip joint.
JOINT_RIGHT_RING_FINGER_METACARPAL = 66
Right ring finger metacarpal joint.
JOINT_RIGHT_RING_FINGER_PHALANX_PROXIMAL = 67
Right ring finger phalanx proximal joint.
JOINT_RIGHT_RING_FINGER_PHALANX_INTERMEDIATE = 68
Right ring finger phalanx intermediate joint.
JOINT_RIGHT_RING_FINGER_PHALANX_DISTAL = 69
Right ring finger phalanx distal joint.
JOINT_RIGHT_RING_FINGER_TIP = 70
Right ring finger tip joint.
JOINT_RIGHT_PINKY_FINGER_METACARPAL = 71
Right pinky finger metacarpal joint.
JOINT_RIGHT_PINKY_FINGER_PHALANX_PROXIMAL = 72
Right pinky finger phalanx proximal joint.
JOINT_RIGHT_PINKY_FINGER_PHALANX_INTERMEDIATE = 73
Right pinky finger phalanx intermediate joint.
JOINT_RIGHT_PINKY_FINGER_PHALANX_DISTAL = 74
Right pinky finger phalanx distal joint.
JOINT_RIGHT_PINKY_FINGER_TIP = 75
Right pinky finger tip joint.
JOINT_LOWER_CHEST = 76
Lower chest joint.
JOINT_LEFT_SCAPULA = 77
Left scapula joint.
JOINT_LEFT_WRIST_TWIST = 78
Left wrist twist joint.
JOINT_RIGHT_SCAPULA = 79
Right scapula joint.
JOINT_RIGHT_WRIST_TWIST = 80
Right wrist twist joint.
JOINT_LEFT_FOOT_TWIST = 81
Left foot twist joint.
JOINT_LEFT_HEEL = 82
Left heel joint.
JOINT_LEFT_MIDDLE_FOOT = 83
Left middle foot joint.
JOINT_RIGHT_FOOT_TWIST = 84
Right foot twist joint.
JOINT_RIGHT_HEEL = 85
Right heel joint.
JOINT_RIGHT_MIDDLE_FOOT = 86
Right middle foot joint.
JOINT_MAX = 87
Represents the size of the Joint enum.
JOINT_FLAG_ORIENTATION_VALID = 1
The joint's orientation data is valid.
JOINT_FLAG_ORIENTATION_TRACKED = 2
The joint's orientation is actively tracked. May not be set if tracking has been temporarily lost.
JOINT_FLAG_POSITION_VALID = 4
The joint's position data is valid.
JOINT_FLAG_POSITION_TRACKED = 8
The joint's position is actively tracked. May not be set if tracking has been temporarily lost.