: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/ARGeoTrackingConfiguration.xml. .. _class_ARGeoTrackingConfiguration: ARGeoTrackingConfiguration ========================== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Configuration for GPS-anchored geo tracking AR sessions. .. rst-class:: classref-introduction-group Description ----------- Configures a session for geo tracking, which combines visual localization with GPS to place content at real-world geographic coordinates. Use with :ref:`ARSession.run_geo_tracking()`. Call :ref:`check_availability()` to verify the current location supports geo tracking before starting. **iOS 14+ only.** On visionOS and macOS, :ref:`is_supported()` returns false. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------+-----------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`detection_image_group_name` | ``""`` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`environment_texturing` | ``0`` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`is_light_estimation_enabled` | ``true`` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`plane_detection_mask` | ``0`` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`wants_hdr_environment_textures` | ``false`` | +-----------------------------+-----------------------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`check_availability`\ (\ callback\: :ref:`Callable`\ ) |static| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_supported`\ (\ ) |static| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`set_detection_image_group`\ (\ groupName\: :ref:`String`\ ) | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ARGeoTrackingConfiguration_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 during geo tracking. .. rst-class:: classref-item-separator ---- .. _class_ARGeoTrackingConfiguration_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 probes are generated during geo tracking. .. rst-class:: classref-item-separator ---- .. _class_ARGeoTrackingConfiguration_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 geo-tracking frames. .. rst-class:: classref-item-separator ---- .. _class_ARGeoTrackingConfiguration_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 to detect while geo tracking. .. rst-class:: classref-item-separator ---- .. _class_ARGeoTrackingConfiguration_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-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_ARGeoTrackingConfiguration_method_check_availability: .. rst-class:: classref-method |void| **check_availability**\ (\ callback\: :ref:`Callable`\ ) |static| :ref:`🔗` Checks whether geo tracking is currently available at the user's location. The callback receives a boolean result and an optional error message. .. rst-class:: classref-item-separator ---- .. _class_ARGeoTrackingConfiguration_method_is_supported: .. rst-class:: classref-method :ref:`bool` **is_supported**\ (\ ) |static| :ref:`🔗` Returns ``true`` when the current device supports geo tracking. .. rst-class:: classref-item-separator ---- .. _class_ARGeoTrackingConfiguration_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. .. |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.)`