Table of Contents

Class XRHandTracker

A tracked hand in XR.

Inheritance
XRHandTracker

Remarks

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.

See Also

XR documentation index

Properties

hand_tracking_source

The source of the hand tracking data.

var hand_tracking_source : int = 0

Property Value

int

Remarks

  • void set_hand_tracking_source(int value)
  • int get_hand_tracking_source

has_tracking_data

If true, the hand tracking data is valid.

var has_tracking_data : bool = false

Property Value

bool

Remarks

  • void set_has_tracking_data(bool value)
  • bool get_has_tracking_data

Methods

get_hand_joint_angular_velocity(int)

Qualifiers: const

Returns the angular velocity for the given hand joint.

Vector3 get_hand_joint_angular_velocity(int joint)

Parameters

joint int

get_hand_joint_flags(int)

Qualifiers: const

Returns flags about the validity of the tracking data for the given hand joint (see HandJointFlags).

int get_hand_joint_flags(int joint)

Parameters

joint int

get_hand_joint_linear_velocity(int)

Qualifiers: const

Returns the linear velocity for the given hand joint.

Vector3 get_hand_joint_linear_velocity(int joint)

Parameters

joint int

get_hand_joint_radius(int)

Qualifiers: const

Returns the radius of the given hand joint.

float get_hand_joint_radius(int joint)

Parameters

joint int

get_hand_joint_transform(int)

Qualifiers: const

Returns the transform for the given hand joint.

Transform3D get_hand_joint_transform(int joint)

Parameters

joint int

set_hand_joint_angular_velocity(int, Vector3)

Sets the angular velocity for the given hand joint.

void set_hand_joint_angular_velocity(int joint, Vector3 angular_velocity)

Parameters

joint int
angular_velocity Vector3

set_hand_joint_flags(int, int)

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

void set_hand_joint_flags(int joint, int flags)

Parameters

joint int
flags int

set_hand_joint_linear_velocity(int, Vector3)

Sets the linear velocity for the given hand joint.

void set_hand_joint_linear_velocity(int joint, Vector3 linear_velocity)

Parameters

joint int
linear_velocity Vector3

set_hand_joint_radius(int, float)

Sets the radius of the given hand joint.

void set_hand_joint_radius(int joint, float radius)

Parameters

joint int
radius float

set_hand_joint_transform(int, Transform3D)

Sets the transform for the given hand joint.

void set_hand_joint_transform(int joint, Transform3D transform)

Parameters

joint int
transform Transform3D