From 57aa7345627075fa4cf3f1de33bcddf67baafe80 Mon Sep 17 00:00:00 2001 From: Malcolm Nixon Date: Sat, 24 Feb 2024 19:20:11 -0500 Subject: Add body tracking support. --- doc/classes/XRBodyTracker.xml | 307 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 307 insertions(+) create mode 100644 doc/classes/XRBodyTracker.xml (limited to 'doc/classes/XRBodyTracker.xml') diff --git a/doc/classes/XRBodyTracker.xml b/doc/classes/XRBodyTracker.xml new file mode 100644 index 0000000000..5d45ad11bd --- /dev/null +++ b/doc/classes/XRBodyTracker.xml @@ -0,0 +1,307 @@ + + + + A tracked body in XR. + + + 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 Godot Humanoid skeleton and store this data on the [XRBodyTracker] object. + Use [XRBodyModifier3D] to animate a body mesh using body tracking data. + + + $DOCS_URL/tutorials/xr/index.html + + + + + + + Returns flags about the validity of the tracking data for the given body joint (see [enum XRBodyTracker.JointFlags]). + + + + + + + Returns the transform for the given body joint. + + + + + + + + Sets flags about the validity of the tracking data for the given body joint. + + + + + + + + Sets the transform for the given body joint. + + + + + + The type of body tracking data captured. + + + If [code]true[/code], the body tracking data is valid. + + + + + Upper body tracking supported. + + + Lower body tracking supported. + + + Hand tracking supported. + + + Root joint. + + + Hips joint. + + + Spine joint. + + + Chest joint. + + + Upper chest joint. + + + Neck joint. + + + Head joint. + + + Head tip joint. + + + Left shoulder joint. + + + Left upper arm joint. + + + Left lower arm joint. + + + Right shoulder joint. + + + Right upper arm joint. + + + Right lower arm joint. + + + Left upper leg joint. + + + Left lower leg joint. + + + Left foot joint. + + + Left toes joint. + + + Right upper leg joint. + + + Right lower leg joint. + + + Right foot joint. + + + Right toes joint. + + + Left hand joint. + + + Left palm joint. + + + Left wrist joint. + + + Left thumb metacarpal joint. + + + Left thumb phalanx proximal joint. + + + Left thumb phalanx distal joint. + + + Left thumb tip joint. + + + Left index finger metacarpal joint. + + + Left index finger phalanx proximal joint. + + + Left index finger phalanx intermediate joint. + + + Left index finger phalanx distal joint. + + + Left index finger tip joint. + + + Left middle finger metacarpal joint. + + + Left middle finger phalanx proximal joint. + + + Left middle finger phalanx intermediate joint. + + + Left middle finger phalanx distal joint. + + + Left middle finger tip joint. + + + Left ring finger metacarpal joint. + + + Left ring finger phalanx proximal joint. + + + Left ring finger phalanx intermediate joint. + + + Left ring finger phalanx distal joint. + + + Left ring finger tip joint. + + + Left pinky finger metacarpal joint. + + + Left pinky finger phalanx proximal joint. + + + Left pinky finger phalanx intermediate joint. + + + Left pinky finger phalanx distal joint. + + + Left pinky finger tip joint. + + + Right hand joint. + + + Right palm joint. + + + Right wrist joint. + + + Right thumb metacarpal joint. + + + Right thumb phalanx proximal joint. + + + Right thumb phalanx distal joint. + + + Right thumb tip joint. + + + Right index finger metacarpal joint. + + + Right index finger phalanx proximal joint. + + + Right index finger phalanx intermediate joint. + + + Right index finger phalanx distal joint. + + + Right index finger tip joint. + + + Right middle finger metacarpal joint. + + + Right middle finger phalanx proximal joint. + + + Right middle finger phalanx intermediate joint. + + + Right middle finger phalanx distal joint. + + + Right middle finger tip joint. + + + Right ring finger metacarpal joint. + + + Right ring finger phalanx proximal joint. + + + Right ring finger phalanx intermediate joint. + + + Right ring finger phalanx distal joint. + + + Right ring finger tip joint. + + + Right pinky finger metacarpal joint. + + + Right pinky finger phalanx proximal joint. + + + Right pinky finger phalanx intermediate joint. + + + Right pinky finger phalanx distal joint. + + + Right pinky finger tip joint. + + + Represents the size of the [enum Joint] enum. + + + The joint's orientation data is valid. + + + The joint's orientation is actively tracked. May not be set if tracking has been temporarily lost. + + + The joint's position data is valid. + + + The joint's position is actively tracked. May not be set if tracking has been temporarily lost. + + + -- cgit v1.2.3