godot-docs/classes/class_arvranchor.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ARVRAnchor.xml.

.. _class_ARVRAnchor:

ARVRAnchor
==========

**Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

An anchor point in AR space.

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

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

The **ARVRAnchor** point is a spatial node that maps a real world location identified by the AR platform to a position within the game world. For example, as long as plane detection in ARKit is on, ARKit will identify and update the position of planes (tables, floors, etc) and create anchors for them.

This node is mapped to one of the anchors through its unique ID. When you receive a signal that a new anchor is available, you should add this node to your scene for that anchor. You can predefine nodes and set the ID; the nodes will simply remain on 0,0,0 until a plane is recognized.

Keep in mind that, as long as plane detection is enabled, the size, placing and orientation of an anchor will be updated as the detection logic learns more about the real world out there especially if only part of the surface is in view.

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

Properties
----------

.. table::
   :widths: auto

   +-----------------------+-------------------------------------------------------+-------+
   | :ref:`int<class_int>` | :ref:`anchor_id<class_ARVRAnchor_property_anchor_id>` | ``1`` |
   +-----------------------+-------------------------------------------------------+-------+

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

Methods
-------

.. table::
   :widths: auto

   +-------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`   | :ref:`get_anchor_name<class_ARVRAnchor_method_get_anchor_name>` **(** **)** |const| |
   +-------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`       | :ref:`get_is_active<class_ARVRAnchor_method_get_is_active>` **(** **)** |const|     |
   +-------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`Mesh<class_Mesh>`       | :ref:`get_mesh<class_ARVRAnchor_method_get_mesh>` **(** **)** |const|               |
   +-------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`Plane<class_Plane>`     | :ref:`get_plane<class_ARVRAnchor_method_get_plane>` **(** **)** |const|             |
   +-------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`Vector3<class_Vector3>` | :ref:`get_size<class_ARVRAnchor_method_get_size>` **(** **)** |const|               |
   +-------------------------------+-------------------------------------------------------------------------------------+

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

----

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

Signals
-------

.. _class_ARVRAnchor_signal_mesh_updated:

.. rst-class:: classref-signal

**mesh_updated** **(** :ref:`Mesh<class_Mesh>` mesh **)**

Emitted when the mesh associated with the anchor changes or when one becomes available. This is especially important for topology that is constantly being ``mesh_updated``.

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

----

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

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

.. _class_ARVRAnchor_property_anchor_id:

.. rst-class:: classref-property

:ref:`int<class_int>` **anchor_id** = ``1``

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

- void **set_anchor_id** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_anchor_id** **(** **)**

The anchor's ID. You can set this before the anchor itself exists. The first anchor gets an ID of ``1``, the second an ID of ``2``, etc. When anchors get removed, the engine can then assign the corresponding ID to new anchors. The most common situation where anchors "disappear" is when the AR server identifies that two anchors represent different parts of the same plane and merges them.

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

----

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

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

.. _class_ARVRAnchor_method_get_anchor_name:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_anchor_name** **(** **)** |const|

Returns the name given to this anchor.

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

----

.. _class_ARVRAnchor_method_get_is_active:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **get_is_active** **(** **)** |const|

Returns ``true`` if the anchor is being tracked and ``false`` if no anchor with this ID is currently known.

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

----

.. _class_ARVRAnchor_method_get_mesh:

.. rst-class:: classref-method

:ref:`Mesh<class_Mesh>` **get_mesh** **(** **)** |const|

If provided by the :ref:`ARVRInterface<class_ARVRInterface>`, this returns a mesh object for the anchor. For an anchor, this can be a shape related to the object being tracked or it can be a mesh that provides topology related to the anchor and can be used to create shadows/reflections on surfaces or for generating collision shapes.

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

----

.. _class_ARVRAnchor_method_get_plane:

.. rst-class:: classref-method

:ref:`Plane<class_Plane>` **get_plane** **(** **)** |const|

Returns a plane aligned with our anchor; handy for intersection testing.

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

----

.. _class_ARVRAnchor_method_get_size:

.. rst-class:: classref-method

:ref:`Vector3<class_Vector3>` **get_size** **(** **)** |const|

Returns the estimated size of the plane that was detected. Say when the anchor relates to a table in the real world, this is the estimated size of the surface of that table.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |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.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`