Inheritance #

Object
- AudioServer
- CameraServer
- ClassDB
- DisplayServer
- EditorFileSystemDirectory
- EditorInterface
- EditorPaths
- EditorSelection
- EditorUndoRedoManager
- EditorVCSInterface
- Engine
- EngineDebugger
- FramebufferCacheRD
- GDExtensionManager
- Geometry2D
- Geometry3D
- IP
- Input
- InputMap
- JNISingleton
- JSONRPC
- JavaClassWrapper
- JavaScriptBridge
- MainLoop (1)
- Marshalls
- MovieWriter
- NativeMenu
- NavigationMeshGenerator
- NavigationServer2D
- NavigationServer3D
- Node (21)
- OS
- OpenXRExtensionWrapperExtension
- OpenXRInteractionProfileMetadata
- Performance
- PhysicsDirectBodyState2D (1)
- PhysicsDirectBodyState3D (1)
- PhysicsDirectSpaceState2D (1)
- PhysicsDirectSpaceState3D (1)
- PhysicsServer2D (1)
- PhysicsServer2DManager
- PhysicsServer3D (1)
- PhysicsServer3DManager
- PhysicsServer3DRendering
ServerHandler
- ProjectSettings
- RefCounted (121)
- RenderData (2)
- RenderSceneData (2)
- RenderingDevice
- RenderingServer
- ResourceLoader
- ResourceSaver
- ResourceUID
- ScriptLanguage (1)
- ShaderIncludeDB
- TextServerManager
- ThemeDB
- TileData
- Time
- TranslationServer
- TreeItem
- UndoRedo
- UniformSetCacheRD
- WorkerThreadPool
- XRServer
- XRVRS
RefCounted
- AESContext
- AStar2D
- AStar3D
- AStarGrid2D
- AudioEffectInstance (1)
- AudioSample
- AudioSamplePlayback
- AudioStreamPlayback (5)
- CameraFeed
- CharFXTransform
- ConfigFile
- Crypto
- DTLSServer
- DirAccess
- ENetConnection
- EditorContextMenuPlugin
- EditorDebuggerPlugin
- EditorDebuggerSession
- EditorExportPlatform (6)
- EditorExportPlugin
- EditorExportPreset
- EditorFeatureProfile
- EditorFileSystemImportFormatSupportQuery
- EditorInspectorPlugin
- EditorResourceConversionPlugin
- EditorResourcePreviewGenerator
- EditorResourceTooltipPlugin
- EditorSceneFormatImporter (4)
- EditorScenePostImport
- EditorScenePostImportPlugin
- EditorScript
- EditorTranslationParserPlugin
- EncodedObjectAsID
- EngineProfiler
- Expression
- FileAccess
- GLTFObjectModelProperty
- HMACContext
- HTTPClient
- HashingContext
- ImageFormatLoader (1)
- JavaClass
- JavaObject
- JavaScriptObject
- KinematicCollision2D
- KinematicCollision3D
- Lightmapper (1)
- MeshConvexDecompositionSettings
- MeshDataTool
- MultiplayerAPI (2)
- Mutex
- NavigationPathQueryParameters2D
- NavigationPathQueryParameters3D
- NavigationPathQueryResult2D
- NavigationPathQueryResult3D
- Node3DGizmo (1)
- OggPacketSequencePlayback
- OpenXRAPIExtension
- PCKPacker
- PackedDataContainerRef
- PacketPeer (8)
- PhysicsPointQueryParameters2D
- PhysicsPointQueryParameters3D
- PhysicsRayQueryParameters2D
- PhysicsRayQueryParameters3D
- PhysicsShapeQueryParameters2D
- PhysicsShapeQueryParameters3D
- PhysicsTestMotionParameters2D
- PhysicsTestMotionParameters3D
- PhysicsTestMotionResult2D
- PhysicsTestMotionResult3D
- RDAttachmentFormat
- RDFramebufferPass
- RDPipelineColorBlendState
- RDPipelineColorBlendStateAttachment
- RDPipelineDepthStencilState
- RDPipelineMultisampleState
- RDPipelineRasterizationState
- RDPipelineSpecializationConstant
- RDSamplerState
- RDShaderSource
- RDTextureFormat
- RDTextureView
- RDUniform
- RDVertexAttribute
- RandomNumberGenerator
- RegEx
- RegExMatch
- RenderSceneBuffers (2)
- RenderSceneBuffersConfiguration
- Resource (103)
- ResourceFormatLoader
- ResourceFormatSaver
- ResourceImporter (16)
- SceneState
- SceneTreeTimer
- Semaphore
- SkinReference
- StreamPeer (5)
- SurfaceTool
- TCPServer
- TLSOptions
- TextLine
- TextParagraph
- TextServer (1)
- Thread
- TranslationDomain
- TriangleMesh
- Tween
- Tweener (5)
- UDPServer
- UPNP
- UPNPDevice
- WeakRef
- WebRTCPeerConnection (1)
- XMLParser
- XRInterface (4)
- XRPose
- XRTracker (2)
- ZIPPacker
- ZIPReader
XRTracker
- XRFaceTracker
- XRPositionalTracker (3)
XRPositionalTracker
- XRBodyTracker
- XRControllerTracker
- XRHandTracker
XRBodyTracker
Table of contents

XRBodyTracker #

is_refcounted, is_instantiable, core, not_builtin_classes

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.

Members #

var body_flags: int = 0#

The type of body tracking data captured.

var has_tracking_data: bool = false#

If true, the body tracking data is valid.

var type = TRACKER_BODY#

Methods #

const func get_joint_flags(joint: int enumXRBodyTracker.Joint) -> intXRBodyTracker.JointFlags#

Returns flags about the validity of the tracking data for the given body joint (see XRBodyTracker.JointFlags).

const func get_joint_transform(joint: int enumXRBodyTracker.Joint) -> Transform3D#

Returns the transform for the given body joint.

func set_joint_flags(flags: int enumXRBodyTracker.JointFlags) -> void#

Sets flags about the validity of the tracking data for the given body joint.

func set_joint_transform(transform: Transform3D) -> void#

Sets the transform for the given body joint.

Annotations #

Constants #

const BODY_FLAG_UPPER_BODY_SUPPORTED = 1 enum BodyFlags
Bitfield
#

Upper body tracking supported.

const BODY_FLAG_LOWER_BODY_SUPPORTED = 2 enum BodyFlags
Bitfield
#

Lower body tracking supported.

const BODY_FLAG_HANDS_SUPPORTED = 4 enum BodyFlags
Bitfield
#

Hand tracking supported.

const JOINT_ROOT = 0 enum Joint#

Root joint.

const JOINT_HIPS = 1 enum Joint#

Hips joint.

const JOINT_SPINE = 2 enum Joint#

Spine joint.

const JOINT_CHEST = 3 enum Joint#

Chest joint.

const JOINT_UPPER_CHEST = 4 enum Joint#

Upper chest joint.

const JOINT_NECK = 5 enum Joint#

Neck joint.

const JOINT_HEAD = 6 enum Joint#

Head joint.

const JOINT_HEAD_TIP = 7 enum Joint#

Head tip joint.

const JOINT_LEFT_SHOULDER = 8 enum Joint#

Left shoulder joint.

const JOINT_LEFT_UPPER_ARM = 9 enum Joint#

Left upper arm joint.

const JOINT_LEFT_LOWER_ARM = 10 enum Joint#

Left lower arm joint.

const JOINT_RIGHT_SHOULDER = 11 enum Joint#

Right shoulder joint.

const JOINT_RIGHT_UPPER_ARM = 12 enum Joint#

Right upper arm joint.

const JOINT_RIGHT_LOWER_ARM = 13 enum Joint#

Right lower arm joint.

const JOINT_LEFT_UPPER_LEG = 14 enum Joint#

Left upper leg joint.

const JOINT_LEFT_LOWER_LEG = 15 enum Joint#

Left lower leg joint.

const JOINT_LEFT_FOOT = 16 enum Joint#

Left foot joint.

const JOINT_LEFT_TOES = 17 enum Joint#

Left toes joint.

const JOINT_RIGHT_UPPER_LEG = 18 enum Joint#

Right upper leg joint.

const JOINT_RIGHT_LOWER_LEG = 19 enum Joint#

Right lower leg joint.

const JOINT_RIGHT_FOOT = 20 enum Joint#

Right foot joint.

const JOINT_RIGHT_TOES = 21 enum Joint#

Right toes joint.

const JOINT_LEFT_HAND = 22 enum Joint#

Left hand joint.

const JOINT_LEFT_PALM = 23 enum Joint#

Left palm joint.

const JOINT_LEFT_WRIST = 24 enum Joint#

Left wrist joint.

const JOINT_LEFT_THUMB_METACARPAL = 25 enum Joint#

Left thumb metacarpal joint.

const JOINT_LEFT_THUMB_PHALANX_PROXIMAL = 26 enum Joint#

Left thumb phalanx proximal joint.

const JOINT_LEFT_THUMB_PHALANX_DISTAL = 27 enum Joint#

Left thumb phalanx distal joint.

const JOINT_LEFT_THUMB_TIP = 28 enum Joint#

Left thumb tip joint.

const JOINT_LEFT_INDEX_FINGER_METACARPAL = 29 enum Joint#

Left index finger metacarpal joint.

const JOINT_LEFT_INDEX_FINGER_PHALANX_PROXIMAL = 30 enum Joint#

Left index finger phalanx proximal joint.

const JOINT_LEFT_INDEX_FINGER_PHALANX_INTERMEDIATE = 31 enum Joint#

Left index finger phalanx intermediate joint.

const JOINT_LEFT_INDEX_FINGER_PHALANX_DISTAL = 32 enum Joint#

Left index finger phalanx distal joint.

const JOINT_LEFT_INDEX_FINGER_TIP = 33 enum Joint#

Left index finger tip joint.

const JOINT_LEFT_MIDDLE_FINGER_METACARPAL = 34 enum Joint#

Left middle finger metacarpal joint.

const JOINT_LEFT_MIDDLE_FINGER_PHALANX_PROXIMAL = 35 enum Joint#

Left middle finger phalanx proximal joint.

const JOINT_LEFT_MIDDLE_FINGER_PHALANX_INTERMEDIATE = 36 enum Joint#

Left middle finger phalanx intermediate joint.

const JOINT_LEFT_MIDDLE_FINGER_PHALANX_DISTAL = 37 enum Joint#

Left middle finger phalanx distal joint.

const JOINT_LEFT_MIDDLE_FINGER_TIP = 38 enum Joint#

Left middle finger tip joint.

const JOINT_LEFT_RING_FINGER_METACARPAL = 39 enum Joint#

Left ring finger metacarpal joint.

const JOINT_LEFT_RING_FINGER_PHALANX_PROXIMAL = 40 enum Joint#

Left ring finger phalanx proximal joint.

const JOINT_LEFT_RING_FINGER_PHALANX_INTERMEDIATE = 41 enum Joint#

Left ring finger phalanx intermediate joint.

const JOINT_LEFT_RING_FINGER_PHALANX_DISTAL = 42 enum Joint#

Left ring finger phalanx distal joint.

const JOINT_LEFT_RING_FINGER_TIP = 43 enum Joint#

Left ring finger tip joint.

const JOINT_LEFT_PINKY_FINGER_METACARPAL = 44 enum Joint#

Left pinky finger metacarpal joint.

const JOINT_LEFT_PINKY_FINGER_PHALANX_PROXIMAL = 45 enum Joint#

Left pinky finger phalanx proximal joint.

const JOINT_LEFT_PINKY_FINGER_PHALANX_INTERMEDIATE = 46 enum Joint#

Left pinky finger phalanx intermediate joint.

const JOINT_LEFT_PINKY_FINGER_PHALANX_DISTAL = 47 enum Joint#

Left pinky finger phalanx distal joint.

const JOINT_LEFT_PINKY_FINGER_TIP = 48 enum Joint#

Left pinky finger tip joint.

const JOINT_RIGHT_HAND = 49 enum Joint#

Right hand joint.

const JOINT_RIGHT_PALM = 50 enum Joint#

Right palm joint.

const JOINT_RIGHT_WRIST = 51 enum Joint#

Right wrist joint.

const JOINT_RIGHT_THUMB_METACARPAL = 52 enum Joint#

Right thumb metacarpal joint.

const JOINT_RIGHT_THUMB_PHALANX_PROXIMAL = 53 enum Joint#

Right thumb phalanx proximal joint.

const JOINT_RIGHT_THUMB_PHALANX_DISTAL = 54 enum Joint#

Right thumb phalanx distal joint.

const JOINT_RIGHT_THUMB_TIP = 55 enum Joint#

Right thumb tip joint.

const JOINT_RIGHT_INDEX_FINGER_METACARPAL = 56 enum Joint#

Right index finger metacarpal joint.

const JOINT_RIGHT_INDEX_FINGER_PHALANX_PROXIMAL = 57 enum Joint#

Right index finger phalanx proximal joint.

const JOINT_RIGHT_INDEX_FINGER_PHALANX_INTERMEDIATE = 58 enum Joint#

Right index finger phalanx intermediate joint.

const JOINT_RIGHT_INDEX_FINGER_PHALANX_DISTAL = 59 enum Joint#

Right index finger phalanx distal joint.

const JOINT_RIGHT_INDEX_FINGER_TIP = 60 enum Joint#

Right index finger tip joint.

const JOINT_RIGHT_MIDDLE_FINGER_METACARPAL = 61 enum Joint#

Right middle finger metacarpal joint.

const JOINT_RIGHT_MIDDLE_FINGER_PHALANX_PROXIMAL = 62 enum Joint#

Right middle finger phalanx proximal joint.

const JOINT_RIGHT_MIDDLE_FINGER_PHALANX_INTERMEDIATE = 63 enum Joint#

Right middle finger phalanx intermediate joint.

const JOINT_RIGHT_MIDDLE_FINGER_PHALANX_DISTAL = 64 enum Joint#

Right middle finger phalanx distal joint.

const JOINT_RIGHT_MIDDLE_FINGER_TIP = 65 enum Joint#

Right middle finger tip joint.

const JOINT_RIGHT_RING_FINGER_METACARPAL = 66 enum Joint#

Right ring finger metacarpal joint.

const JOINT_RIGHT_RING_FINGER_PHALANX_PROXIMAL = 67 enum Joint#

Right ring finger phalanx proximal joint.

const JOINT_RIGHT_RING_FINGER_PHALANX_INTERMEDIATE = 68 enum Joint#

Right ring finger phalanx intermediate joint.

const JOINT_RIGHT_RING_FINGER_PHALANX_DISTAL = 69 enum Joint#

Right ring finger phalanx distal joint.

const JOINT_RIGHT_RING_FINGER_TIP = 70 enum Joint#

Right ring finger tip joint.

const JOINT_RIGHT_PINKY_FINGER_METACARPAL = 71 enum Joint#

Right pinky finger metacarpal joint.

const JOINT_RIGHT_PINKY_FINGER_PHALANX_PROXIMAL = 72 enum Joint#

Right pinky finger phalanx proximal joint.

const JOINT_RIGHT_PINKY_FINGER_PHALANX_INTERMEDIATE = 73 enum Joint#

Right pinky finger phalanx intermediate joint.

const JOINT_RIGHT_PINKY_FINGER_PHALANX_DISTAL = 74 enum Joint#

Right pinky finger phalanx distal joint.

const JOINT_RIGHT_PINKY_FINGER_TIP = 75 enum Joint#

Right pinky finger tip joint.

const JOINT_MAX = 76 enum Joint#

Represents the size of the Joint enum.

const JOINT_FLAG_ORIENTATION_VALID = 1 enum JointFlags
Bitfield
#

The joint's orientation data is valid.

const JOINT_FLAG_ORIENTATION_TRACKED = 2 enum JointFlags
Bitfield
#

The joint's orientation is actively tracked. May not be set if tracking has been temporarily lost.

const JOINT_FLAG_POSITION_VALID = 4 enum JointFlags
Bitfield
#

The joint's position data is valid.

const JOINT_FLAG_POSITION_TRACKED = 8 enum JointFlags
Bitfield
#

The joint's position is actively tracked. May not be set if tracking has been temporarily lost.

Constructors #

Enums #

BodyFlags#

enum BodyFlags { BODY_FLAG_UPPER_BODY_SUPPORTED = 1, BODY_FLAG_LOWER_BODY_SUPPORTED = 2, BODY_FLAG_HANDS_SUPPORTED = 4, }

Joint#

enum Joint { JOINT_ROOT = 0, JOINT_HIPS = 1, JOINT_SPINE = 2, JOINT_CHEST = 3, JOINT_UPPER_CHEST = 4, JOINT_NECK = 5, JOINT_HEAD = 6, JOINT_HEAD_TIP = 7, JOINT_LEFT_SHOULDER = 8, JOINT_LEFT_UPPER_ARM = 9, JOINT_LEFT_LOWER_ARM = 10, JOINT_RIGHT_SHOULDER = 11, JOINT_RIGHT_UPPER_ARM = 12, JOINT_RIGHT_LOWER_ARM = 13, JOINT_LEFT_UPPER_LEG = 14, JOINT_LEFT_LOWER_LEG = 15, JOINT_LEFT_FOOT = 16, JOINT_LEFT_TOES = 17, JOINT_RIGHT_UPPER_LEG = 18, JOINT_RIGHT_LOWER_LEG = 19, JOINT_RIGHT_FOOT = 20, JOINT_RIGHT_TOES = 21, JOINT_LEFT_HAND = 22, JOINT_LEFT_PALM = 23, JOINT_LEFT_WRIST = 24, JOINT_LEFT_THUMB_METACARPAL = 25, JOINT_LEFT_THUMB_PHALANX_PROXIMAL = 26, JOINT_LEFT_THUMB_PHALANX_DISTAL = 27, JOINT_LEFT_THUMB_TIP = 28, JOINT_LEFT_INDEX_FINGER_METACARPAL = 29, JOINT_LEFT_INDEX_FINGER_PHALANX_PROXIMAL = 30, JOINT_LEFT_INDEX_FINGER_PHALANX_INTERMEDIATE = 31, JOINT_LEFT_INDEX_FINGER_PHALANX_DISTAL = 32, JOINT_LEFT_INDEX_FINGER_TIP = 33, JOINT_LEFT_MIDDLE_FINGER_METACARPAL = 34, JOINT_LEFT_MIDDLE_FINGER_PHALANX_PROXIMAL = 35, JOINT_LEFT_MIDDLE_FINGER_PHALANX_INTERMEDIATE = 36, JOINT_LEFT_MIDDLE_FINGER_PHALANX_DISTAL = 37, JOINT_LEFT_MIDDLE_FINGER_TIP = 38, JOINT_LEFT_RING_FINGER_METACARPAL = 39, JOINT_LEFT_RING_FINGER_PHALANX_PROXIMAL = 40, JOINT_LEFT_RING_FINGER_PHALANX_INTERMEDIATE = 41, JOINT_LEFT_RING_FINGER_PHALANX_DISTAL = 42, JOINT_LEFT_RING_FINGER_TIP = 43, JOINT_LEFT_PINKY_FINGER_METACARPAL = 44, JOINT_LEFT_PINKY_FINGER_PHALANX_PROXIMAL = 45, JOINT_LEFT_PINKY_FINGER_PHALANX_INTERMEDIATE = 46, JOINT_LEFT_PINKY_FINGER_PHALANX_DISTAL = 47, JOINT_LEFT_PINKY_FINGER_TIP = 48, JOINT_RIGHT_HAND = 49, JOINT_RIGHT_PALM = 50, JOINT_RIGHT_WRIST = 51, JOINT_RIGHT_THUMB_METACARPAL = 52, JOINT_RIGHT_THUMB_PHALANX_PROXIMAL = 53, JOINT_RIGHT_THUMB_PHALANX_DISTAL = 54, JOINT_RIGHT_THUMB_TIP = 55, JOINT_RIGHT_INDEX_FINGER_METACARPAL = 56, JOINT_RIGHT_INDEX_FINGER_PHALANX_PROXIMAL = 57, JOINT_RIGHT_INDEX_FINGER_PHALANX_INTERMEDIATE = 58, JOINT_RIGHT_INDEX_FINGER_PHALANX_DISTAL = 59, JOINT_RIGHT_INDEX_FINGER_TIP = 60, JOINT_RIGHT_MIDDLE_FINGER_METACARPAL = 61, JOINT_RIGHT_MIDDLE_FINGER_PHALANX_PROXIMAL = 62, JOINT_RIGHT_MIDDLE_FINGER_PHALANX_INTERMEDIATE = 63, JOINT_RIGHT_MIDDLE_FINGER_PHALANX_DISTAL = 64, JOINT_RIGHT_MIDDLE_FINGER_TIP = 65, JOINT_RIGHT_RING_FINGER_METACARPAL = 66, JOINT_RIGHT_RING_FINGER_PHALANX_PROXIMAL = 67, JOINT_RIGHT_RING_FINGER_PHALANX_INTERMEDIATE = 68, JOINT_RIGHT_RING_FINGER_PHALANX_DISTAL = 69, JOINT_RIGHT_RING_FINGER_TIP = 70, JOINT_RIGHT_PINKY_FINGER_METACARPAL = 71, JOINT_RIGHT_PINKY_FINGER_PHALANX_PROXIMAL = 72, JOINT_RIGHT_PINKY_FINGER_PHALANX_INTERMEDIATE = 73, JOINT_RIGHT_PINKY_FINGER_PHALANX_DISTAL = 74, JOINT_RIGHT_PINKY_FINGER_TIP = 75, JOINT_MAX = 76, }

JointFlags#

enum JointFlags { JOINT_FLAG_ORIENTATION_VALID = 1, JOINT_FLAG_ORIENTATION_TRACKED = 2, JOINT_FLAG_POSITION_VALID = 4, JOINT_FLAG_POSITION_TRACKED = 8, }

Operators #

Signals #

Theme Items #

Tutorials #