:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/../../GodotApplePlugins/doc_classes/ARHandSkeleton.xml. .. _class_ARHandSkeleton: ARHandSkeleton ============== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Provides joint transforms for a tracked hand skeleton. .. rst-class:: classref-introduction-group Description ----------- Contains 27 joint transforms (wrist through forearm) for a tracked hand. Access individual joints with :ref:`get_joint_transform()` or get all at once with :ref:`get_all_joint_transforms()`. **visionOS only.** On iOS and macOS, this type exists for API consistency but returns empty/default values. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------+---------------------------------------------------------------+-------+ | :ref:`int` | :ref:`joint_count` | ``0`` | +-----------------------+---------------------------------------------------------------+-------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_all_joint_transforms`\ (\ ) | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_joint_is_tracked`\ (\ joint\: :ref:`JointName`\ ) | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`get_joint_transform`\ (\ joint\: :ref:`JointName`\ ) | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_ARHandSkeleton_JointName: .. rst-class:: classref-enumeration enum **JointName**: :ref:`🔗` .. _class_ARHandSkeleton_constant_WRIST: .. rst-class:: classref-enumeration-constant :ref:`JointName` **WRIST** = ``0`` Joint identifier for the wrist. .. _class_ARHandSkeleton_constant_THUMB_KNUCKLE: .. rst-class:: classref-enumeration-constant :ref:`JointName` **THUMB_KNUCKLE** = ``1`` Joint identifier for the thumb knuckle. .. _class_ARHandSkeleton_constant_THUMB_INTERMEDIATE_BASE: .. rst-class:: classref-enumeration-constant :ref:`JointName` **THUMB_INTERMEDIATE_BASE** = ``2`` Joint identifier for the thumb intermediate base. .. _class_ARHandSkeleton_constant_THUMB_INTERMEDIATE_TIP: .. rst-class:: classref-enumeration-constant :ref:`JointName` **THUMB_INTERMEDIATE_TIP** = ``3`` Joint identifier for the thumb intermediate tip. .. _class_ARHandSkeleton_constant_THUMB_TIP: .. rst-class:: classref-enumeration-constant :ref:`JointName` **THUMB_TIP** = ``4`` Joint identifier for the thumb tip. .. _class_ARHandSkeleton_constant_INDEX_FINGER_METACARPAL: .. rst-class:: classref-enumeration-constant :ref:`JointName` **INDEX_FINGER_METACARPAL** = ``5`` Joint identifier for the index finger metacarpal. .. _class_ARHandSkeleton_constant_INDEX_FINGER_KNUCKLE: .. rst-class:: classref-enumeration-constant :ref:`JointName` **INDEX_FINGER_KNUCKLE** = ``6`` Joint identifier for the index finger knuckle. .. _class_ARHandSkeleton_constant_INDEX_FINGER_INTERMEDIATE_BASE: .. rst-class:: classref-enumeration-constant :ref:`JointName` **INDEX_FINGER_INTERMEDIATE_BASE** = ``7`` Joint identifier for the index finger intermediate base. .. _class_ARHandSkeleton_constant_INDEX_FINGER_INTERMEDIATE_TIP: .. rst-class:: classref-enumeration-constant :ref:`JointName` **INDEX_FINGER_INTERMEDIATE_TIP** = ``8`` Joint identifier for the index finger intermediate tip. .. _class_ARHandSkeleton_constant_INDEX_FINGER_TIP: .. rst-class:: classref-enumeration-constant :ref:`JointName` **INDEX_FINGER_TIP** = ``9`` Joint identifier for the index finger tip. .. _class_ARHandSkeleton_constant_MIDDLE_FINGER_METACARPAL: .. rst-class:: classref-enumeration-constant :ref:`JointName` **MIDDLE_FINGER_METACARPAL** = ``10`` Joint identifier for the middle finger metacarpal. .. _class_ARHandSkeleton_constant_MIDDLE_FINGER_KNUCKLE: .. rst-class:: classref-enumeration-constant :ref:`JointName` **MIDDLE_FINGER_KNUCKLE** = ``11`` Joint identifier for the middle finger knuckle. .. _class_ARHandSkeleton_constant_MIDDLE_FINGER_INTERMEDIATE_BASE: .. rst-class:: classref-enumeration-constant :ref:`JointName` **MIDDLE_FINGER_INTERMEDIATE_BASE** = ``12`` Joint identifier for the middle finger intermediate base. .. _class_ARHandSkeleton_constant_MIDDLE_FINGER_INTERMEDIATE_TIP: .. rst-class:: classref-enumeration-constant :ref:`JointName` **MIDDLE_FINGER_INTERMEDIATE_TIP** = ``13`` Joint identifier for the middle finger intermediate tip. .. _class_ARHandSkeleton_constant_MIDDLE_FINGER_TIP: .. rst-class:: classref-enumeration-constant :ref:`JointName` **MIDDLE_FINGER_TIP** = ``14`` Joint identifier for the middle finger tip. .. _class_ARHandSkeleton_constant_RING_FINGER_METACARPAL: .. rst-class:: classref-enumeration-constant :ref:`JointName` **RING_FINGER_METACARPAL** = ``15`` Joint identifier for the ring finger metacarpal. .. _class_ARHandSkeleton_constant_RING_FINGER_KNUCKLE: .. rst-class:: classref-enumeration-constant :ref:`JointName` **RING_FINGER_KNUCKLE** = ``16`` Joint identifier for the ring finger knuckle. .. _class_ARHandSkeleton_constant_RING_FINGER_INTERMEDIATE_BASE: .. rst-class:: classref-enumeration-constant :ref:`JointName` **RING_FINGER_INTERMEDIATE_BASE** = ``17`` Joint identifier for the ring finger intermediate base. .. _class_ARHandSkeleton_constant_RING_FINGER_INTERMEDIATE_TIP: .. rst-class:: classref-enumeration-constant :ref:`JointName` **RING_FINGER_INTERMEDIATE_TIP** = ``18`` Joint identifier for the ring finger intermediate tip. .. _class_ARHandSkeleton_constant_RING_FINGER_TIP: .. rst-class:: classref-enumeration-constant :ref:`JointName` **RING_FINGER_TIP** = ``19`` Joint identifier for the ring finger tip. .. _class_ARHandSkeleton_constant_LITTLE_FINGER_METACARPAL: .. rst-class:: classref-enumeration-constant :ref:`JointName` **LITTLE_FINGER_METACARPAL** = ``20`` Joint identifier for the little finger metacarpal. .. _class_ARHandSkeleton_constant_LITTLE_FINGER_KNUCKLE: .. rst-class:: classref-enumeration-constant :ref:`JointName` **LITTLE_FINGER_KNUCKLE** = ``21`` Joint identifier for the little finger knuckle. .. _class_ARHandSkeleton_constant_LITTLE_FINGER_INTERMEDIATE_BASE: .. rst-class:: classref-enumeration-constant :ref:`JointName` **LITTLE_FINGER_INTERMEDIATE_BASE** = ``22`` Joint identifier for the little finger intermediate base. .. _class_ARHandSkeleton_constant_LITTLE_FINGER_INTERMEDIATE_TIP: .. rst-class:: classref-enumeration-constant :ref:`JointName` **LITTLE_FINGER_INTERMEDIATE_TIP** = ``23`` Joint identifier for the little finger intermediate tip. .. _class_ARHandSkeleton_constant_LITTLE_FINGER_TIP: .. rst-class:: classref-enumeration-constant :ref:`JointName` **LITTLE_FINGER_TIP** = ``24`` Joint identifier for the little finger tip. .. _class_ARHandSkeleton_constant_FOREARM_WRIST: .. rst-class:: classref-enumeration-constant :ref:`JointName` **FOREARM_WRIST** = ``25`` Joint identifier for the forearm wrist. .. _class_ARHandSkeleton_constant_FOREARM_ARM: .. rst-class:: classref-enumeration-constant :ref:`JointName` **FOREARM_ARM** = ``26`` Joint identifier for the forearm arm. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ARHandSkeleton_property_joint_count: .. rst-class:: classref-property :ref:`int` **joint_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_joint_count**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_joint_count**\ (\ ) The number of joints available in this hand skeleton. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_ARHandSkeleton_method_get_all_joint_transforms: .. rst-class:: classref-method :ref:`Array` **get_all_joint_transforms**\ (\ ) :ref:`🔗` Returns every joint transform in enum order as an :ref:`Array` of :ref:`Transform3D` values. .. rst-class:: classref-item-separator ---- .. _class_ARHandSkeleton_method_get_joint_is_tracked: .. rst-class:: classref-method :ref:`bool` **get_joint_is_tracked**\ (\ joint\: :ref:`JointName`\ ) :ref:`🔗` Returns whether the requested hand joint currently has reliable tracking data. .. rst-class:: classref-item-separator ---- .. _class_ARHandSkeleton_method_get_joint_transform: .. rst-class:: classref-method :ref:`Transform3D` **get_joint_transform**\ (\ joint\: :ref:`JointName`\ ) :ref:`🔗` Returns the transform for the requested hand joint, relative to the hand anchor. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`