ARBodySkeleton

Inherits: RefCounted < Object

Provides joint transforms for a tracked body skeleton.

Description

Contains the 3D joint transforms for a tracked body. Access joints by index using get_joint_transform() and get_joint_name(). iOS only. On visionOS and macOS, this type exists for API consistency but returns empty/default values.

Properties

int

joint_count

0

Methods

bool

get_joint_is_tracked(index: int)

String

get_joint_name(index: int)

Transform3D

get_joint_transform(index: int)


Property Descriptions

int joint_count = 0 🔗

  • void set_joint_count(value: int)

  • int get_joint_count()

The number of joints available in this skeleton.


Method Descriptions

bool get_joint_is_tracked(index: int) 🔗

Returns whether the joint at index is currently tracked with reliable data.


String get_joint_name(index: int) 🔗

Returns the Apple-defined name for the joint at index.


Transform3D get_joint_transform(index: int) 🔗

Returns the joint transform for the joint at index, relative to the body anchor.