| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697 |
- :github_url: hide
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the ARVRAnchor.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_ARVRAnchor:
- ARVRAnchor
- ==========
- **Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- **Category:** Core
- Brief Description
- -----------------
- Anchor point in AR Space.
- Properties
- ----------
- +-----------------------+-------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`anchor_id<class_ARVRAnchor_property_anchor_id>` |
- +-----------------------+-------------------------------------------------------+
- Methods
- -------
- +-------------------------------+-----------------------------------------------------------------------------------+
- | :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:`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 |
- +-------------------------------+-----------------------------------------------------------------------------------+
- Description
- -----------
- The ARVR Anchor 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 and 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.
- Property Descriptions
- ---------------------
- .. _class_ARVRAnchor_property_anchor_id:
- - :ref:`int<class_int>` **anchor_id**
- +----------+----------------------+
- | *Setter* | set_anchor_id(value) |
- +----------+----------------------+
- | *Getter* | 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.
- Method Descriptions
- -------------------
- .. _class_ARVRAnchor_method_get_anchor_name:
- - :ref:`String<class_String>` **get_anchor_name** **(** **)** const
- Returns the name given to this anchor.
- ----
- .. _class_ARVRAnchor_method_get_is_active:
- - :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.
- ----
- .. _class_ARVRAnchor_method_get_plane:
- - :ref:`Plane<class_Plane>` **get_plane** **(** **)** const
- Returns a plane aligned with our anchor; handy for intersection testing.
- ----
- .. _class_ARVRAnchor_method_get_size:
- - :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.
|
