Index · Object → RefCounted → XRTracker → XRPositionalTracker → XRHandTracker

XRHandTracker

A tracked hand in XR.

Class Description

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.

Properties

var hand: XRPositionalTracker.TrackerHand = 1
var hand_tracking_source: XRHandTracker.HandTrackingSource = 0

The source of the hand tracking data.

var has_tracking_data: bool = false

If true, the hand tracking data is valid.

var type: XRServer.TrackerType = 16
Inherited from XRPositionalTracker (2)
var profile: String = ""
Inherited from XRTracker (3)
var name: StringName = &"Unknown"

Methods

func get_hand_joint_angular_velocity(joint: XRHandTracker.HandJoint) -> Vector3

Returns the angular velocity for the given hand joint.

func get_hand_joint_flags(joint: XRHandTracker.HandJoint) -> XRHandTracker.HandJointFlags

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

func get_hand_joint_linear_velocity(joint: XRHandTracker.HandJoint) -> Vector3

Returns the linear velocity for the given hand joint.

func get_hand_joint_radius(joint: XRHandTracker.HandJoint) -> float

Returns the radius of the given hand joint.

func get_hand_joint_transform(joint: XRHandTracker.HandJoint) -> Transform3D

Returns the transform for the given hand joint.

func set_hand_joint_angular_velocity(joint: XRHandTracker.HandJoint, angular_velocity: Vector3) -> void

Sets the angular velocity for the given hand joint.

func set_hand_joint_flags(joint: XRHandTracker.HandJoint, flags: XRHandTracker.HandJointFlags) -> void

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

func set_hand_joint_linear_velocity(joint: XRHandTracker.HandJoint, linear_velocity: Vector3) -> void

Sets the linear velocity for the given hand joint.

func set_hand_joint_radius(joint: XRHandTracker.HandJoint, radius: float) -> void

Sets the radius of the given hand joint.

func set_hand_joint_transform(joint: XRHandTracker.HandJoint, transform: Transform3D) -> void

Sets the transform for the given hand joint.

Inherited from XRPositionalTracker (6)
func get_pose(name: StringName) -> XRPose
func has_pose(name: StringName) -> bool
func invalidate_pose(name: StringName) -> void
func set_input(name: StringName, value: Variant) -> void
func set_pose(name: StringName, transform: Transform3D, linear_velocity: Vector3, angular_velocity: Vector3, tracking_confidence: XRPose.TrackingConfidence) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from XRPositionalTracker (7)
signal button_pressed(action_name: String)
signal button_released(action_name: String)
signal input_float_changed(action_name: String, value: float)
signal input_vector2_changed(action_name: String, vector: Vector2)
signal pose_changed(pose: XRPose)
signal profile_changed(role: String)
Inherited from Object (2)

Enums & Constants

enum HandTrackingSource
HAND_TRACKING_SOURCE_UNKNOWN = 0

The source of hand tracking data is unknown.

HAND_TRACKING_SOURCE_UNOBSTRUCTED = 1

The source of hand tracking data is unobstructed, meaning that an accurate method of hand tracking is used. These include optical hand tracking, data gloves, etc.

HAND_TRACKING_SOURCE_CONTROLLER = 2

The source of hand tracking data is a controller, meaning that joint positions are inferred from controller inputs.

HAND_TRACKING_SOURCE_NOT_TRACKED = 3

No hand tracking data is tracked, this either means the hand is obscured, the controller is turned off, or tracking is not supported for the current input type.

HAND_TRACKING_SOURCE_MAX = 4

Represents the size of the HandTrackingSource enum.

enum HandJoint
HAND_JOINT_PALM = 0

Palm joint.

HAND_JOINT_WRIST = 1

Wrist joint.

HAND_JOINT_THUMB_METACARPAL = 2

Thumb metacarpal joint.

HAND_JOINT_THUMB_PHALANX_PROXIMAL = 3

Thumb phalanx proximal joint.

HAND_JOINT_THUMB_PHALANX_DISTAL = 4

Thumb phalanx distal joint.

HAND_JOINT_THUMB_TIP = 5

Thumb tip joint.

HAND_JOINT_INDEX_FINGER_METACARPAL = 6

Index finger metacarpal joint.

HAND_JOINT_INDEX_FINGER_PHALANX_PROXIMAL = 7

Index finger phalanx proximal joint.

HAND_JOINT_INDEX_FINGER_PHALANX_INTERMEDIATE = 8

Index finger phalanx intermediate joint.

HAND_JOINT_INDEX_FINGER_PHALANX_DISTAL = 9

Index finger phalanx distal joint.

HAND_JOINT_INDEX_FINGER_TIP = 10

Index finger tip joint.

HAND_JOINT_MIDDLE_FINGER_METACARPAL = 11

Middle finger metacarpal joint.

HAND_JOINT_MIDDLE_FINGER_PHALANX_PROXIMAL = 12

Middle finger phalanx proximal joint.

HAND_JOINT_MIDDLE_FINGER_PHALANX_INTERMEDIATE = 13

Middle finger phalanx intermediate joint.

HAND_JOINT_MIDDLE_FINGER_PHALANX_DISTAL = 14

Middle finger phalanx distal joint.

HAND_JOINT_MIDDLE_FINGER_TIP = 15

Middle finger tip joint.

HAND_JOINT_RING_FINGER_METACARPAL = 16

Ring finger metacarpal joint.

HAND_JOINT_RING_FINGER_PHALANX_PROXIMAL = 17

Ring finger phalanx proximal joint.

HAND_JOINT_RING_FINGER_PHALANX_INTERMEDIATE = 18

Ring finger phalanx intermediate joint.

HAND_JOINT_RING_FINGER_PHALANX_DISTAL = 19

Ring finger phalanx distal joint.

HAND_JOINT_RING_FINGER_TIP = 20

Ring finger tip joint.

HAND_JOINT_PINKY_FINGER_METACARPAL = 21

Pinky finger metacarpal joint.

HAND_JOINT_PINKY_FINGER_PHALANX_PROXIMAL = 22

Pinky finger phalanx proximal joint.

HAND_JOINT_PINKY_FINGER_PHALANX_INTERMEDIATE = 23

Pinky finger phalanx intermediate joint.

HAND_JOINT_PINKY_FINGER_PHALANX_DISTAL = 24

Pinky finger phalanx distal joint.

HAND_JOINT_PINKY_FINGER_TIP = 25

Pinky finger tip joint.

HAND_JOINT_MAX = 26

Represents the size of the HandJoint enum.

enum HandJointFlags
HAND_JOINT_FLAG_ORIENTATION_VALID = 1

The hand joint's orientation data is valid.

HAND_JOINT_FLAG_ORIENTATION_TRACKED = 2

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

HAND_JOINT_FLAG_POSITION_VALID = 4

The hand joint's position data is valid.

HAND_JOINT_FLAG_POSITION_TRACKED = 8

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

HAND_JOINT_FLAG_LINEAR_VELOCITY_VALID = 16

The hand joint's linear velocity data is valid.

HAND_JOINT_FLAG_ANGULAR_VELOCITY_VALID = 32

The hand joint's angular velocity data is valid.