ARHandSkeleton

Inherits: RefCounted < Object

Provides joint transforms for a tracked hand skeleton.

Description

Contains 27 joint transforms (wrist through forearm) for a tracked hand. Access individual joints with get_joint_transform() or get all at once with get_all_joint_transforms(). visionOS only. On iOS and macOS, this type exists for API consistency but returns empty/default values.

Properties

int

joint_count

0

Methods

Array	get_all_joint_transforms()
bool	get_joint_is_tracked(joint: JointName)
Transform3D	get_joint_transform(joint: JointName)

---

Enumerations

enum JointName: 🔗

JointName WRIST = 0

Joint identifier for the wrist.

JointName THUMB_KNUCKLE = 1

Joint identifier for the thumb knuckle.

JointName THUMB_INTERMEDIATE_BASE = 2

Joint identifier for the thumb intermediate base.

JointName THUMB_INTERMEDIATE_TIP = 3

Joint identifier for the thumb intermediate tip.

JointName THUMB_TIP = 4

Joint identifier for the thumb tip.

JointName INDEX_FINGER_METACARPAL = 5

Joint identifier for the index finger metacarpal.

JointName INDEX_FINGER_KNUCKLE = 6

Joint identifier for the index finger knuckle.

JointName INDEX_FINGER_INTERMEDIATE_BASE = 7

Joint identifier for the index finger intermediate base.

JointName INDEX_FINGER_INTERMEDIATE_TIP = 8

Joint identifier for the index finger intermediate tip.

JointName INDEX_FINGER_TIP = 9

Joint identifier for the index finger tip.

JointName MIDDLE_FINGER_METACARPAL = 10

Joint identifier for the middle finger metacarpal.

JointName MIDDLE_FINGER_KNUCKLE = 11

Joint identifier for the middle finger knuckle.

JointName MIDDLE_FINGER_INTERMEDIATE_BASE = 12

Joint identifier for the middle finger intermediate base.

JointName MIDDLE_FINGER_INTERMEDIATE_TIP = 13

Joint identifier for the middle finger intermediate tip.

JointName MIDDLE_FINGER_TIP = 14

Joint identifier for the middle finger tip.

JointName RING_FINGER_METACARPAL = 15

Joint identifier for the ring finger metacarpal.

JointName RING_FINGER_KNUCKLE = 16

Joint identifier for the ring finger knuckle.

JointName RING_FINGER_INTERMEDIATE_BASE = 17

Joint identifier for the ring finger intermediate base.

JointName RING_FINGER_INTERMEDIATE_TIP = 18

Joint identifier for the ring finger intermediate tip.

JointName RING_FINGER_TIP = 19

Joint identifier for the ring finger tip.

JointName LITTLE_FINGER_METACARPAL = 20

Joint identifier for the little finger metacarpal.

JointName LITTLE_FINGER_KNUCKLE = 21

Joint identifier for the little finger knuckle.

JointName LITTLE_FINGER_INTERMEDIATE_BASE = 22

Joint identifier for the little finger intermediate base.

JointName LITTLE_FINGER_INTERMEDIATE_TIP = 23

Joint identifier for the little finger intermediate tip.

JointName LITTLE_FINGER_TIP = 24

Joint identifier for the little finger tip.

JointName FOREARM_WRIST = 25

Joint identifier for the forearm wrist.

JointName FOREARM_ARM = 26

Joint identifier for the forearm arm.

---

Property Descriptions

int joint_count = 0 🔗

• void set_joint_count(value: int)

• int get_joint_count()

The number of joints available in this hand skeleton.

---

Method Descriptions

Array get_all_joint_transforms() 🔗

Returns every joint transform in enum order as an Array of Transform3D values.

---

bool get_joint_is_tracked(joint: JointName) 🔗

Returns whether the requested hand joint currently has reliable tracking data.

---

Transform3D get_joint_transform(joint: JointName) 🔗

Returns the transform for the requested hand joint, relative to the hand anchor.