: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/ARMeshAnchor.xml. .. _class_ARMeshAnchor: ARMeshAnchor ============ **Inherits:** :ref:`RefCounted` **<** :ref:`Object` A scene-reconstruction mesh anchored in world space. .. rst-class:: classref-introduction-group Description ----------- Represents a chunk of reconstructed scene geometry. Mesh anchors expose vertices, normals, triangle indices, and optional per-face classifications such as wall, floor, or table. These anchors are useful for occlusion, physics, spatial understanding, and procedural mesh generation. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`classification_per_face` | ``PackedInt32Array()`` | +-----------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`PackedVector3Array` | :ref:`geometry_normals` | ``PackedVector3Array()`` | +-----------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`PackedVector3Array` | :ref:`geometry_vertices` | ``PackedVector3Array()`` | +-----------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`String` | :ref:`identifier` | ``""`` | +-----------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------------------------------------+ | :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:`int` | :ref:`get_face_classification`\ (\ faceIndex\: :ref:`int`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_normal`\ (\ index\: :ref:`int`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_vertex`\ (\ index\: :ref:`int`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_ARMeshAnchor_MeshClassification: .. rst-class:: classref-enumeration enum **MeshClassification**: :ref:`🔗` .. _class_ARMeshAnchor_constant_NONE: .. rst-class:: classref-enumeration-constant :ref:`MeshClassification` **NONE** = ``0`` No semantic classification is available for this face. .. _class_ARMeshAnchor_constant_WALL: .. rst-class:: classref-enumeration-constant :ref:`MeshClassification` **WALL** = ``1`` The mesh face is classified as a wall. .. _class_ARMeshAnchor_constant_FLOOR: .. rst-class:: classref-enumeration-constant :ref:`MeshClassification` **FLOOR** = ``2`` The mesh face is classified as a floor. .. _class_ARMeshAnchor_constant_CEILING: .. rst-class:: classref-enumeration-constant :ref:`MeshClassification` **CEILING** = ``3`` The mesh face is classified as a ceiling. .. _class_ARMeshAnchor_constant_TABLE: .. rst-class:: classref-enumeration-constant :ref:`MeshClassification` **TABLE** = ``4`` The mesh face is classified as a table-like surface. .. _class_ARMeshAnchor_constant_SEAT: .. rst-class:: classref-enumeration-constant :ref:`MeshClassification` **SEAT** = ``5`` The mesh face is classified as a seat. .. _class_ARMeshAnchor_constant_WINDOW: .. rst-class:: classref-enumeration-constant :ref:`MeshClassification` **WINDOW** = ``6`` The mesh face is classified as a window. .. _class_ARMeshAnchor_constant_DOOR: .. rst-class:: classref-enumeration-constant :ref:`MeshClassification` **DOOR** = ``7`` The mesh face is classified as a door. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ARMeshAnchor_property_classification_per_face: .. rst-class:: classref-property :ref:`PackedInt32Array` **classification_per_face** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_classification_per_face**\ (\ value\: :ref:`PackedInt32Array`\ ) - :ref:`PackedInt32Array` **get_classification_per_face**\ (\ ) Semantic classification value for each mesh face. **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-item-separator ---- .. _class_ARMeshAnchor_property_geometry_normals: .. rst-class:: classref-property :ref:`PackedVector3Array` **geometry_normals** = ``PackedVector3Array()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_geometry_normals**\ (\ value\: :ref:`PackedVector3Array`\ ) - :ref:`PackedVector3Array` **get_geometry_normals**\ (\ ) Normal vectors for the mesh vertices. **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_ARMeshAnchor_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**\ (\ ) Mesh vertices in anchor-local space. **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_ARMeshAnchor_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 mesh anchor. .. rst-class:: classref-item-separator ---- .. _class_ARMeshAnchor_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 mesh anchor transform in world space. .. rst-class:: classref-item-separator ---- .. _class_ARMeshAnchor_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 reconstructed mesh. **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_ARMeshAnchor_method_get_face_classification: .. rst-class:: classref-method :ref:`int` **get_face_classification**\ (\ faceIndex\: :ref:`int`\ ) :ref:`🔗` Returns the semantic classification for the triangle face at ``faceIndex``. .. rst-class:: classref-item-separator ---- .. _class_ARMeshAnchor_method_get_normal: .. rst-class:: classref-method :ref:`Vector3` **get_normal**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the surface normal at vertex ``index``. .. rst-class:: classref-item-separator ---- .. _class_ARMeshAnchor_method_get_vertex: .. rst-class:: classref-method :ref:`Vector3` **get_vertex**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the mesh vertex at ``index``. .. |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.)`