mirror of
https://github.com/godotengine/godot.git
synced 2024-11-13 23:52:41 +00:00
29 lines
1.7 KiB
XML
29 lines
1.7 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="XRAnchor3D" inherits="XRNode3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
An anchor point in AR space.
|
|
</brief_description>
|
|
<description>
|
|
The [XRAnchor3D] 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.
|
|
</description>
|
|
<tutorials>
|
|
<link title="XR documentation index">$DOCS_URL/tutorials/xr/index.html</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="get_plane" qualifiers="const">
|
|
<return type="Plane" />
|
|
<description>
|
|
Returns a plane aligned with our anchor; handy for intersection testing.
|
|
</description>
|
|
</method>
|
|
<method name="get_size" qualifiers="const">
|
|
<return type="Vector3" />
|
|
<description>
|
|
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.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
</class>
|