: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/ARImageAnchor.xml. .. _class_ARImageAnchor: ARImageAnchor ============= **Inherits:** :ref:`RefCounted` **<** :ref:`Object` An anchor created when a reference image is detected in the scene. .. rst-class:: classref-introduction-group Description ----------- Represents a detected reference image in the real world. Image anchors are produced when the session is configured with a reference image group. The anchor exposes the image name, physical size, tracking state, and estimated scale factor. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`float` | :ref:`estimated_scale_factor` | ``1.0`` | +---------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`String` | :ref:`identifier` | ``""`` | +---------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`bool` | :ref:`is_tracked` | ``false`` | +---------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`String` | :ref:`reference_image_name` | ``""`` | +---------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`Vector2` | :ref:`reference_image_physical_size` | ``Vector2(0, 0)`` | +---------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`Transform3D` | :ref:`transform` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | +---------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ARImageAnchor_property_estimated_scale_factor: .. rst-class:: classref-property :ref:`float` **estimated_scale_factor** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_estimated_scale_factor**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_estimated_scale_factor**\ (\ ) ARKit's current estimate of the detected image's scale relative to its reference size. .. rst-class:: classref-item-separator ---- .. _class_ARImageAnchor_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 image anchor. .. rst-class:: classref-item-separator ---- .. _class_ARImageAnchor_property_is_tracked: .. rst-class:: classref-property :ref:`bool` **is_tracked** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_is_tracked**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_is_tracked**\ (\ ) Whether the image is currently tracked with reliable pose updates. .. rst-class:: classref-item-separator ---- .. _class_ARImageAnchor_property_reference_image_name: .. rst-class:: classref-property :ref:`String` **reference_image_name** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_reference_image_name**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_reference_image_name**\ (\ ) The name of the detected reference image from the asset catalog. .. rst-class:: classref-item-separator ---- .. _class_ARImageAnchor_property_reference_image_physical_size: .. rst-class:: classref-property :ref:`Vector2` **reference_image_physical_size** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_reference_image_physical_size**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_reference_image_physical_size**\ (\ ) The physical size of the reference image in meters. .. rst-class:: classref-item-separator ---- .. _class_ARImageAnchor_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 image anchor transform in world space. .. |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.)`