: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/ARBodySkeleton.xml.

.. _class_ARBodySkeleton:

ARBodySkeleton
==============

**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

Provides joint transforms for a tracked body skeleton.

.. rst-class:: classref-introduction-group

Description
-----------

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

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +-----------------------+---------------------------------------------------------------+-------+
   | :ref:`int<class_int>` | :ref:`joint_count<class_ARBodySkeleton_property_joint_count>` | ``0`` |
   +-----------------------+---------------------------------------------------------------+-------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +---------------------------------------+--------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`               | :ref:`get_joint_is_tracked<class_ARBodySkeleton_method_get_joint_is_tracked>`\ (\ index\: :ref:`int<class_int>`\ ) |
   +---------------------------------------+--------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`           | :ref:`get_joint_name<class_ARBodySkeleton_method_get_joint_name>`\ (\ index\: :ref:`int<class_int>`\ )             |
   +---------------------------------------+--------------------------------------------------------------------------------------------------------------------+
   | :ref:`Transform3D<class_Transform3D>` | :ref:`get_joint_transform<class_ARBodySkeleton_method_get_joint_transform>`\ (\ index\: :ref:`int<class_int>`\ )   |
   +---------------------------------------+--------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_ARBodySkeleton_property_joint_count:

.. rst-class:: classref-property

:ref:`int<class_int>` **joint_count** = ``0`` :ref:`🔗<class_ARBodySkeleton_property_joint_count>`

.. rst-class:: classref-property-setget

- |void| **set_joint_count**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_joint_count**\ (\ )

The number of joints available in this skeleton.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_ARBodySkeleton_method_get_joint_is_tracked:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **get_joint_is_tracked**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_ARBodySkeleton_method_get_joint_is_tracked>`

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

.. rst-class:: classref-item-separator

----

.. _class_ARBodySkeleton_method_get_joint_name:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_joint_name**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_ARBodySkeleton_method_get_joint_name>`

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

.. rst-class:: classref-item-separator

----

.. _class_ARBodySkeleton_method_get_joint_transform:

.. rst-class:: classref-method

:ref:`Transform3D<class_Transform3D>` **get_joint_transform**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_ARBodySkeleton_method_get_joint_transform>`

Returns the joint transform for the joint at ``index``, relative to the body 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.)`