: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/ARGeoAnchor.xml. .. _class_ARGeoAnchor: ARGeoAnchor =========== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` A GPS-positioned anchor for geo-referenced AR content. .. rst-class:: classref-introduction-group Description ----------- Represents a world position defined by latitude, longitude, and altitude. Used with :ref:`ARSession.run_geo_tracking()`. **iOS 14+ only.** On visionOS and macOS, this type exists for API consistency but is never populated with real tracking data. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------+--------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`float` | :ref:`altitude` | ``0.0`` | +---------------------------------------+--------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`int` | :ref:`altitude_source` | ``0`` | +---------------------------------------+--------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`Vector2` | :ref:`coordinate` | ``Vector2(0, 0)`` | +---------------------------------------+--------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`String` | :ref:`identifier` | ``""`` | +---------------------------------------+--------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`Transform3D` | :ref:`transform` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | +---------------------------------------+--------------------------------------------------------------------+-----------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ARGeoAnchor` | :ref:`create`\ (\ latitude\: :ref:`float`, longitude\: :ref:`float`, altitude\: :ref:`float`\ ) |static| | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ARGeoAnchor` | :ref:`create_at_coordinate`\ (\ latitude\: :ref:`float`, longitude\: :ref:`float`\ ) |static| | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_ARGeoAnchor_AltitudeSource: .. rst-class:: classref-enumeration enum **AltitudeSource**: :ref:`🔗` .. _class_ARGeoAnchor_constant_UNKNOWN: .. rst-class:: classref-enumeration-constant :ref:`AltitudeSource` **UNKNOWN** = ``0`` The altitude source is unknown. .. _class_ARGeoAnchor_constant_COARSE: .. rst-class:: classref-enumeration-constant :ref:`AltitudeSource` **COARSE** = ``1`` The altitude was estimated from a coarse data source. .. _class_ARGeoAnchor_constant_PRECISE: .. rst-class:: classref-enumeration-constant :ref:`AltitudeSource` **PRECISE** = ``2`` The altitude was determined from a precise data source. .. _class_ARGeoAnchor_constant_USER_DEFINED: .. rst-class:: classref-enumeration-constant :ref:`AltitudeSource` **USER_DEFINED** = ``3`` The altitude value was provided explicitly by the user or app. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ARGeoAnchor_property_altitude: .. rst-class:: classref-property :ref:`float` **altitude** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_altitude**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_altitude**\ (\ ) The anchor altitude in meters. .. rst-class:: classref-item-separator ---- .. _class_ARGeoAnchor_property_altitude_source: .. rst-class:: classref-property :ref:`int` **altitude_source** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_altitude_source**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_altitude_source**\ (\ ) How the altitude value was determined. See :ref:`AltitudeSource`. .. rst-class:: classref-item-separator ---- .. _class_ARGeoAnchor_property_coordinate: .. rst-class:: classref-property :ref:`Vector2` **coordinate** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_coordinate**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_coordinate**\ (\ ) The geographic coordinate stored as ``Vector2(latitude, longitude)``. .. rst-class:: classref-item-separator ---- .. _class_ARGeoAnchor_property_identifier: .. rst-class:: classref-property :ref:`String` **identifier** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_identifier**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_identifier**\ (\ ) A unique identifier for this geo anchor. .. rst-class:: classref-item-separator ---- .. _class_ARGeoAnchor_property_transform: .. rst-class:: classref-property :ref:`Transform3D` **transform** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_transform**\ (\ value\: :ref:`Transform3D`\ ) - :ref:`Transform3D` **get_transform**\ (\ ) The anchor transform in world space once geo tracking has localized it. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_ARGeoAnchor_method_create: .. rst-class:: classref-method :ref:`ARGeoAnchor` **create**\ (\ latitude\: :ref:`float`, longitude\: :ref:`float`, altitude\: :ref:`float`\ ) |static| :ref:`🔗` Creates a geo anchor at the given latitude, longitude, and altitude. .. rst-class:: classref-item-separator ---- .. _class_ARGeoAnchor_method_create_at_coordinate: .. rst-class:: classref-method :ref:`ARGeoAnchor` **create_at_coordinate**\ (\ latitude\: :ref:`float`, longitude\: :ref:`float`\ ) |static| :ref:`🔗` Creates a geo anchor at the given latitude and longitude, letting ARKit determine the altitude when possible. .. |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.)`