: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/ARWorldTrackingConfiguration.xml. .. _class_ARWorldTrackingConfiguration: ARWorldTrackingConfiguration ============================ **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Configuration for world-tracking AR sessions. .. rst-class:: classref-introduction-group Description ----------- Configures a world-tracking session for 6DoF device tracking plus optional features such as plane detection, scene reconstruction, image tracking, collaboration, and frame semantics. Use this configuration with :ref:`ARSession.run()`. Availability of individual features varies by platform and device. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`app_clip_code_tracking_enabled` | ``false`` | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`automatic_image_scale_estimation_enabled` | ``false`` | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`detection_image_group_name` | ``""`` | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`environment_texturing` | ``0`` | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`frame_semantics_mask` | ``0`` | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`hand_tracking_enabled` | ``false`` | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`is_auto_focus_enabled` | ``true`` | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`is_collaboration_enabled` | ``false`` | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`is_light_estimation_enabled` | ``true`` | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`maximum_number_of_tracked_images` | ``0`` | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`plane_detection_mask` | ``0`` | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`provides_audio_data` | ``false`` | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`scene_reconstruction` | ``0`` | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`user_face_tracking_enabled` | ``false`` | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`wants_hdr_environment_textures` | ``false`` | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`world_alignment` | ``0`` | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_supported`\ (\ ) |static| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`set_detection_image_group`\ (\ groupName\: :ref:`String`\ ) | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`supports_app_clip_code_tracking`\ (\ ) |static| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`supports_scene_reconstruction`\ (\ scene_reconstruction\: :ref:`SceneReconstruction`\ ) |static| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`supports_user_face_tracking`\ (\ ) |static| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_ARWorldTrackingConfiguration_WorldAlignment: .. rst-class:: classref-enumeration enum **WorldAlignment**: :ref:`🔗` .. _class_ARWorldTrackingConfiguration_constant_GRAVITY: .. rst-class:: classref-enumeration-constant :ref:`WorldAlignment` **GRAVITY** = ``0`` Align the world so the Y axis matches gravity. .. _class_ARWorldTrackingConfiguration_constant_GRAVITY_AND_HEADING: .. rst-class:: classref-enumeration-constant :ref:`WorldAlignment` **GRAVITY_AND_HEADING** = ``1`` Align the world to gravity and the device heading. .. _class_ARWorldTrackingConfiguration_constant_CAMERA: .. rst-class:: classref-enumeration-constant :ref:`WorldAlignment` **CAMERA** = ``2`` Align the world relative to the camera orientation at session start. .. rst-class:: classref-item-separator ---- .. _enum_ARWorldTrackingConfiguration_EnvironmentTexturing: .. rst-class:: classref-enumeration enum **EnvironmentTexturing**: :ref:`🔗` .. _class_ARWorldTrackingConfiguration_constant_NONE: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentTexturing` **NONE** = ``0`` Disable environment texturing. .. _class_ARWorldTrackingConfiguration_constant_MANUAL: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentTexturing` **MANUAL** = ``1`` Use manually provided environment probes only. .. _class_ARWorldTrackingConfiguration_constant_AUTOMATIC: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentTexturing` **AUTOMATIC** = ``2`` Allow ARKit to generate environment probes automatically. .. rst-class:: classref-item-separator ---- .. _enum_ARWorldTrackingConfiguration_PlaneDetection: .. rst-class:: classref-enumeration enum **PlaneDetection**: :ref:`🔗` .. _class_ARWorldTrackingConfiguration_constant_HORIZONTAL: .. rst-class:: classref-enumeration-constant :ref:`PlaneDetection` **HORIZONTAL** = ``1`` Detect horizontal planes. .. _class_ARWorldTrackingConfiguration_constant_VERTICAL: .. rst-class:: classref-enumeration-constant :ref:`PlaneDetection` **VERTICAL** = ``2`` Detect vertical planes. .. _class_ARWorldTrackingConfiguration_constant_SLANTED: .. rst-class:: classref-enumeration-constant :ref:`PlaneDetection` **SLANTED** = ``4`` Detect slanted planes when supported. .. rst-class:: classref-item-separator ---- .. _enum_ARWorldTrackingConfiguration_SceneReconstruction: .. rst-class:: classref-enumeration enum **SceneReconstruction**: :ref:`🔗` .. _class_ARWorldTrackingConfiguration_constant_MESH: .. rst-class:: classref-enumeration-constant :ref:`SceneReconstruction` **MESH** = ``1`` Reconstruct scene geometry as a mesh. .. _class_ARWorldTrackingConfiguration_constant_MESH_WITH_CLASSIFICATION: .. rst-class:: classref-enumeration-constant :ref:`SceneReconstruction` **MESH_WITH_CLASSIFICATION** = ``3`` Reconstruct scene geometry and classify mesh faces. .. rst-class:: classref-item-separator ---- .. _enum_ARWorldTrackingConfiguration_FrameSemantics: .. rst-class:: classref-enumeration enum **FrameSemantics**: :ref:`🔗` .. _class_ARWorldTrackingConfiguration_constant_PERSON_SEGMENTATION: .. rst-class:: classref-enumeration-constant :ref:`FrameSemantics` **PERSON_SEGMENTATION** = ``1`` Enable person segmentation mattes. .. _class_ARWorldTrackingConfiguration_constant_PERSON_SEGMENTATION_WITH_DEPTH: .. rst-class:: classref-enumeration-constant :ref:`FrameSemantics` **PERSON_SEGMENTATION_WITH_DEPTH** = ``2`` Enable person segmentation mattes with estimated depth. .. _class_ARWorldTrackingConfiguration_constant_BODY_DETECTION: .. rst-class:: classref-enumeration-constant :ref:`FrameSemantics` **BODY_DETECTION** = ``4`` Enable body detection semantics. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ARWorldTrackingConfiguration_property_app_clip_code_tracking_enabled: .. rst-class:: classref-property :ref:`bool` **app_clip_code_tracking_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_app_clip_code_tracking_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_app_clip_code_tracking_enabled**\ (\ ) When enabled, the session attempts to detect App Clip codes. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_property_automatic_image_scale_estimation_enabled: .. rst-class:: classref-property :ref:`bool` **automatic_image_scale_estimation_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_automatic_image_scale_estimation_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_automatic_image_scale_estimation_enabled**\ (\ ) When enabled, ARKit refines the physical scale estimate of tracked reference images. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_property_detection_image_group_name: .. rst-class:: classref-property :ref:`String` **detection_image_group_name** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_detection_image_group_name**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_detection_image_group_name**\ (\ ) The asset-catalog image group used for reference-image detection. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_property_environment_texturing: .. rst-class:: classref-property :ref:`int` **environment_texturing** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_environment_texturing**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_environment_texturing**\ (\ ) Controls how environment textures are generated. See :ref:`EnvironmentTexturing`. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_property_frame_semantics_mask: .. rst-class:: classref-property :ref:`int` **frame_semantics_mask** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_frame_semantics_mask**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_frame_semantics_mask**\ (\ ) Bitmask of :ref:`FrameSemantics` values enabled for the session. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_property_hand_tracking_enabled: .. rst-class:: classref-property :ref:`bool` **hand_tracking_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_hand_tracking_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_hand_tracking_enabled**\ (\ ) When enabled, visionOS hand-tracking data is included when supported. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_property_is_auto_focus_enabled: .. rst-class:: classref-property :ref:`bool` **is_auto_focus_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_is_auto_focus_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_is_auto_focus_enabled**\ (\ ) When enabled, the camera may adjust focus automatically during tracking. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_property_is_collaboration_enabled: .. rst-class:: classref-property :ref:`bool` **is_collaboration_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_is_collaboration_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_is_collaboration_enabled**\ (\ ) When enabled, the session produces collaboration data for multi-user AR. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_property_is_light_estimation_enabled: .. rst-class:: classref-property :ref:`bool` **is_light_estimation_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_is_light_estimation_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_is_light_estimation_enabled**\ (\ ) When enabled, ARKit produces :ref:`ARLightEstimate` data for each frame. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_property_maximum_number_of_tracked_images: .. rst-class:: classref-property :ref:`int` **maximum_number_of_tracked_images** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_maximum_number_of_tracked_images**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_maximum_number_of_tracked_images**\ (\ ) Maximum number of reference images to track simultaneously. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_property_plane_detection_mask: .. rst-class:: classref-property :ref:`int` **plane_detection_mask** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_plane_detection_mask**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_plane_detection_mask**\ (\ ) Bitmask of :ref:`PlaneDetection` values that should be detected. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_property_provides_audio_data: .. rst-class:: classref-property :ref:`bool` **provides_audio_data** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_provides_audio_data**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_provides_audio_data**\ (\ ) When enabled on supported platforms, captured audio data is included with the session. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_property_scene_reconstruction: .. rst-class:: classref-property :ref:`int` **scene_reconstruction** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_scene_reconstruction**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_scene_reconstruction**\ (\ ) The requested scene reconstruction mode. See :ref:`SceneReconstruction`. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_property_user_face_tracking_enabled: .. rst-class:: classref-property :ref:`bool` **user_face_tracking_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_user_face_tracking_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_user_face_tracking_enabled**\ (\ ) When enabled on supported iOS devices, ARKit also tracks the user's face during world tracking. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_property_wants_hdr_environment_textures: .. rst-class:: classref-property :ref:`bool` **wants_hdr_environment_textures** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_wants_hdr_environment_textures**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_wants_hdr_environment_textures**\ (\ ) Requests HDR environment textures when environment texturing is enabled. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_property_world_alignment: .. rst-class:: classref-property :ref:`int` **world_alignment** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_world_alignment**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_world_alignment**\ (\ ) Defines how the world coordinate system is aligned. See :ref:`WorldAlignment`. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_ARWorldTrackingConfiguration_method_is_supported: .. rst-class:: classref-method :ref:`bool` **is_supported**\ (\ ) |static| :ref:`🔗` Returns ``true`` when the current device supports world tracking. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_method_set_detection_image_group: .. rst-class:: classref-method :ref:`bool` **set_detection_image_group**\ (\ groupName\: :ref:`String`\ ) :ref:`🔗` Loads a reference image group from the asset catalog and assigns it to :ref:`detection_image_group_name`. Returns ``true`` on success. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_method_supports_app_clip_code_tracking: .. rst-class:: classref-method :ref:`bool` **supports_app_clip_code_tracking**\ (\ ) |static| :ref:`🔗` Returns ``true`` when App Clip code tracking is supported on the current device. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_method_supports_scene_reconstruction: .. rst-class:: classref-method :ref:`bool` **supports_scene_reconstruction**\ (\ scene_reconstruction\: :ref:`SceneReconstruction`\ ) |static| :ref:`🔗` Returns ``true`` when the requested scene reconstruction mode is supported. .. rst-class:: classref-item-separator ---- .. _class_ARWorldTrackingConfiguration_method_supports_user_face_tracking: .. rst-class:: classref-method :ref:`bool` **supports_user_face_tracking**\ (\ ) |static| :ref:`🔗` Returns ``true`` when simultaneous world and user face tracking is supported. .. |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.)`