: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/ARPlaneAnchor.xml. .. _class_ARPlaneAnchor: ARPlaneAnchor ============= **Inherits:** :ref:`RefCounted` **<** :ref:`Object` An anchor describing a detected planar surface. .. rst-class:: classref-introduction-group Description ----------- Represents a detected horizontal, vertical, or slanted plane. Plane anchors expose center, extent, polygon boundary vertices, triangulated geometry, and optional surface classification. Use them to place content on floors, walls, tables, and similar surfaces. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`int` | :ref:`alignment` | ``0`` | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`PackedVector3Array` | :ref:`boundary_vertices` | ``PackedVector3Array()`` | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`Vector3` | :ref:`center` | ``Vector3(0, 0, 0)`` | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`int` | :ref:`classification` | ``0`` | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`int` | :ref:`classification_status` | ``0`` | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`Vector3` | :ref:`extent` | ``Vector3(0, 0, 0)`` | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`PackedVector3Array` | :ref:`geometry_vertices` | ``PackedVector3Array()`` | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`String` | :ref:`identifier` | ``""`` | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`float` | :ref:`plane_extent_height` | ``0.0`` | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`float` | :ref:`plane_extent_rotation_on_y_axis` | ``0.0`` | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`float` | :ref:`plane_extent_width` | ``0.0`` | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`PackedVector2Array` | :ref:`texture_coordinates` | ``PackedVector2Array()`` | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`Transform3D` | :ref:`transform` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`triangle_indices` | ``PackedInt32Array()`` | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_boundary_vertex`\ (\ index\: :ref:`int`\ ) | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_geometry_vertex`\ (\ index\: :ref:`int`\ ) | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_texture_coordinate`\ (\ index\: :ref:`int`\ ) | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_triangle_index`\ (\ index\: :ref:`int`\ ) | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_classification_supported`\ (\ ) |static| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_ARPlaneAnchor_Alignment: .. rst-class:: classref-enumeration enum **Alignment**: :ref:`🔗` .. _class_ARPlaneAnchor_constant_HORIZONTAL: .. rst-class:: classref-enumeration-constant :ref:`Alignment` **HORIZONTAL** = ``0`` The plane is horizontally aligned. .. _class_ARPlaneAnchor_constant_VERTICAL: .. rst-class:: classref-enumeration-constant :ref:`Alignment` **VERTICAL** = ``1`` The plane is vertically aligned. .. _class_ARPlaneAnchor_constant_SLANTED: .. rst-class:: classref-enumeration-constant :ref:`Alignment` **SLANTED** = ``2`` The plane is aligned to a slanted surface. .. rst-class:: classref-item-separator ---- .. _enum_ARPlaneAnchor_ClassificationStatus: .. rst-class:: classref-enumeration enum **ClassificationStatus**: :ref:`🔗` .. _class_ARPlaneAnchor_constant_NOT_AVAILABLE: .. rst-class:: classref-enumeration-constant :ref:`ClassificationStatus` **NOT_AVAILABLE** = ``0`` Plane classification is not available on this device. .. _class_ARPlaneAnchor_constant_UNDETERMINED: .. rst-class:: classref-enumeration-constant :ref:`ClassificationStatus` **UNDETERMINED** = ``1`` Plane classification support is present but no classification has been produced yet. .. _class_ARPlaneAnchor_constant_UNKNOWN: .. rst-class:: classref-enumeration-constant :ref:`ClassificationStatus` **UNKNOWN** = ``2`` The plane could not be classified. .. _class_ARPlaneAnchor_constant_KNOWN: .. rst-class:: classref-enumeration-constant :ref:`ClassificationStatus` **KNOWN** = ``3`` The plane has a valid semantic classification. .. rst-class:: classref-item-separator ---- .. _enum_ARPlaneAnchor_Classification: .. rst-class:: classref-enumeration enum **Classification**: :ref:`🔗` .. _class_ARPlaneAnchor_constant_NONE: .. rst-class:: classref-enumeration-constant :ref:`Classification` **NONE** = ``0`` No semantic classification is available for this plane. .. _class_ARPlaneAnchor_constant_WALL: .. rst-class:: classref-enumeration-constant :ref:`Classification` **WALL** = ``1`` The plane is classified as a wall. .. _class_ARPlaneAnchor_constant_FLOOR: .. rst-class:: classref-enumeration-constant :ref:`Classification` **FLOOR** = ``2`` The plane is classified as a floor. .. _class_ARPlaneAnchor_constant_CEILING: .. rst-class:: classref-enumeration-constant :ref:`Classification` **CEILING** = ``3`` The plane is classified as a ceiling. .. _class_ARPlaneAnchor_constant_TABLE: .. rst-class:: classref-enumeration-constant :ref:`Classification` **TABLE** = ``4`` The plane is classified as a table. .. _class_ARPlaneAnchor_constant_SEAT: .. rst-class:: classref-enumeration-constant :ref:`Classification` **SEAT** = ``5`` The plane is classified as a seat. .. _class_ARPlaneAnchor_constant_WINDOW: .. rst-class:: classref-enumeration-constant :ref:`Classification` **WINDOW** = ``6`` The plane is classified as a window. .. _class_ARPlaneAnchor_constant_DOOR: .. rst-class:: classref-enumeration-constant :ref:`Classification` **DOOR** = ``7`` The plane is classified as a door. .. _class_ARPlaneAnchor_constant_STAIRS: .. rst-class:: classref-enumeration-constant :ref:`Classification` **STAIRS** = ``8`` The plane is classified as stairs. .. _class_ARPlaneAnchor_constant_BED: .. rst-class:: classref-enumeration-constant :ref:`Classification` **BED** = ``9`` The plane is classified as a bed. .. _class_ARPlaneAnchor_constant_CABINET: .. rst-class:: classref-enumeration-constant :ref:`Classification` **CABINET** = ``10`` The plane is classified as a cabinet. .. _class_ARPlaneAnchor_constant_HOME_APPLIANCE: .. rst-class:: classref-enumeration-constant :ref:`Classification` **HOME_APPLIANCE** = ``11`` The plane is classified as a home appliance. .. _class_ARPlaneAnchor_constant_TV: .. rst-class:: classref-enumeration-constant :ref:`Classification` **TV** = ``12`` The plane is classified as a television. .. _class_ARPlaneAnchor_constant_PLANT: .. rst-class:: classref-enumeration-constant :ref:`Classification` **PLANT** = ``13`` The plane is classified as a plant. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ARPlaneAnchor_property_alignment: .. rst-class:: classref-property :ref:`int` **alignment** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_alignment**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_alignment**\ (\ ) The detected orientation of the plane. See :ref:`Alignment`. .. rst-class:: classref-item-separator ---- .. _class_ARPlaneAnchor_property_boundary_vertices: .. rst-class:: classref-property :ref:`PackedVector3Array` **boundary_vertices** = ``PackedVector3Array()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_boundary_vertices**\ (\ value\: :ref:`PackedVector3Array`\ ) - :ref:`PackedVector3Array` **get_boundary_vertices**\ (\ ) Vertices describing the polygon boundary of the detected plane. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedVector3Array` for more details. .. rst-class:: classref-item-separator ---- .. _class_ARPlaneAnchor_property_center: .. rst-class:: classref-property :ref:`Vector3` **center** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_center**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_center**\ (\ ) The center of the plane in anchor-local space. .. rst-class:: classref-item-separator ---- .. _class_ARPlaneAnchor_property_classification: .. rst-class:: classref-property :ref:`int` **classification** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_classification**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_classification**\ (\ ) Semantic classification for the plane surface. See :ref:`Classification`. .. rst-class:: classref-item-separator ---- .. _class_ARPlaneAnchor_property_classification_status: .. rst-class:: classref-property :ref:`int` **classification_status** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_classification_status**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_classification_status**\ (\ ) Whether plane classification is currently available and valid. See :ref:`ClassificationStatus`. .. rst-class:: classref-item-separator ---- .. _class_ARPlaneAnchor_property_extent: .. rst-class:: classref-property :ref:`Vector3` **extent** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_extent**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_extent**\ (\ ) The approximate plane size in anchor-local space. .. rst-class:: classref-item-separator ---- .. _class_ARPlaneAnchor_property_geometry_vertices: .. rst-class:: classref-property :ref:`PackedVector3Array` **geometry_vertices** = ``PackedVector3Array()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_geometry_vertices**\ (\ value\: :ref:`PackedVector3Array`\ ) - :ref:`PackedVector3Array` **get_geometry_vertices**\ (\ ) Vertices for the triangulated plane geometry. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedVector3Array` for more details. .. rst-class:: classref-item-separator ---- .. _class_ARPlaneAnchor_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 plane anchor. .. rst-class:: classref-item-separator ---- .. _class_ARPlaneAnchor_property_plane_extent_height: .. rst-class:: classref-property :ref:`float` **plane_extent_height** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_plane_extent_height**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_plane_extent_height**\ (\ ) Height of the rectangular plane extent in meters. .. rst-class:: classref-item-separator ---- .. _class_ARPlaneAnchor_property_plane_extent_rotation_on_y_axis: .. rst-class:: classref-property :ref:`float` **plane_extent_rotation_on_y_axis** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_plane_extent_rotation_on_y_axis**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_plane_extent_rotation_on_y_axis**\ (\ ) Rotation of the rectangular plane extent around the Y axis in radians. .. rst-class:: classref-item-separator ---- .. _class_ARPlaneAnchor_property_plane_extent_width: .. rst-class:: classref-property :ref:`float` **plane_extent_width** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_plane_extent_width**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_plane_extent_width**\ (\ ) Width of the rectangular plane extent in meters. .. rst-class:: classref-item-separator ---- .. _class_ARPlaneAnchor_property_texture_coordinates: .. rst-class:: classref-property :ref:`PackedVector2Array` **texture_coordinates** = ``PackedVector2Array()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_texture_coordinates**\ (\ value\: :ref:`PackedVector2Array`\ ) - :ref:`PackedVector2Array` **get_texture_coordinates**\ (\ ) Texture coordinates for the triangulated plane geometry. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedVector2Array` for more details. .. rst-class:: classref-item-separator ---- .. _class_ARPlaneAnchor_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 plane anchor transform in world space. .. rst-class:: classref-item-separator ---- .. _class_ARPlaneAnchor_property_triangle_indices: .. rst-class:: classref-property :ref:`PackedInt32Array` **triangle_indices** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_triangle_indices**\ (\ value\: :ref:`PackedInt32Array`\ ) - :ref:`PackedInt32Array` **get_triangle_indices**\ (\ ) Triangle index data for the triangulated plane geometry. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array` for more details. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_ARPlaneAnchor_method_get_boundary_vertex: .. rst-class:: classref-method :ref:`Vector3` **get_boundary_vertex**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the polygon boundary vertex at ``index``. .. rst-class:: classref-item-separator ---- .. _class_ARPlaneAnchor_method_get_geometry_vertex: .. rst-class:: classref-method :ref:`Vector3` **get_geometry_vertex**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the triangulated plane-geometry vertex at ``index``. .. rst-class:: classref-item-separator ---- .. _class_ARPlaneAnchor_method_get_texture_coordinate: .. rst-class:: classref-method :ref:`Vector2` **get_texture_coordinate**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the texture coordinate at ``index`` for the triangulated plane geometry. .. rst-class:: classref-item-separator ---- .. _class_ARPlaneAnchor_method_get_triangle_index: .. rst-class:: classref-method :ref:`int` **get_triangle_index**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the triangle index value at ``index`` from :ref:`triangle_indices`. .. rst-class:: classref-item-separator ---- .. _class_ARPlaneAnchor_method_is_classification_supported: .. rst-class:: classref-method :ref:`bool` **is_classification_supported**\ (\ ) |static| :ref:`🔗` Returns ``true`` when the current device can classify detected planes. .. |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.)`