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

.. _class_ARBodyTrackingConfiguration:

ARBodyTrackingConfiguration
===========================

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

Configuration for body tracking AR sessions.

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

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

Configures a session for full-body skeletal tracking. Use with :ref:`ARSession.run_body_tracking()<class_ARSession_method_run_body_tracking>`. **iOS only.** On visionOS and macOS, :ref:`is_supported()<class_ARBodyTrackingConfiguration_method_is_supported>` returns false and the configuration is inert.

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

Properties
----------

.. table::
   :widths: auto

   +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-----------+
   | :ref:`bool<class_bool>` | :ref:`automatic_skeleton_scale_estimation_enabled<class_ARBodyTrackingConfiguration_property_automatic_skeleton_scale_estimation_enabled>` | ``false`` |
   +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-----------+
   | :ref:`bool<class_bool>` | :ref:`is_auto_focus_enabled<class_ARBodyTrackingConfiguration_property_is_auto_focus_enabled>`                                             | ``true``  |
   +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-----------+
   | :ref:`bool<class_bool>` | :ref:`is_light_estimation_enabled<class_ARBodyTrackingConfiguration_property_is_light_estimation_enabled>`                                 | ``true``  |
   +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-----------+

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

Methods
-------

.. table::
   :widths: auto

   +-------------------------+-------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>` | :ref:`is_supported<class_ARBodyTrackingConfiguration_method_is_supported>`\ (\ ) |static| |
   +-------------------------+-------------------------------------------------------------------------------------------+

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

----

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

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

.. _class_ARBodyTrackingConfiguration_property_automatic_skeleton_scale_estimation_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **automatic_skeleton_scale_estimation_enabled** = ``false`` :ref:`🔗<class_ARBodyTrackingConfiguration_property_automatic_skeleton_scale_estimation_enabled>`

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

- |void| **set_automatic_skeleton_scale_estimation_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_automatic_skeleton_scale_estimation_enabled**\ (\ )

When enabled, ARKit automatically estimates the body's skeleton scale.

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

----

.. _class_ARBodyTrackingConfiguration_property_is_auto_focus_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **is_auto_focus_enabled** = ``true`` :ref:`🔗<class_ARBodyTrackingConfiguration_property_is_auto_focus_enabled>`

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

- |void| **set_is_auto_focus_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_is_auto_focus_enabled**\ (\ )

When enabled, the camera may adjust focus automatically during tracking.

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

----

.. _class_ARBodyTrackingConfiguration_property_is_light_estimation_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **is_light_estimation_enabled** = ``true`` :ref:`🔗<class_ARBodyTrackingConfiguration_property_is_light_estimation_enabled>`

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

- |void| **set_is_light_estimation_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_is_light_estimation_enabled**\ (\ )

When enabled, ARKit produces :ref:`ARLightEstimate<class_ARLightEstimate>` data for each frame.

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

----

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

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

.. _class_ARBodyTrackingConfiguration_method_is_supported:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_supported**\ (\ ) |static| :ref:`🔗<class_ARBodyTrackingConfiguration_method_is_supported>`

Returns ``true`` when the current device supports ARKit body tracking.

.. |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.)`