class_openxrspatialcomponentmesh3dlist.rst 3.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRSpatialComponentMesh3DList.xml.
  6. .. _class_OpenXRSpatialComponentMesh3DList:
  7. OpenXRSpatialComponentMesh3DList
  8. ================================
  9. **Experimental:** This class may be changed or removed in future versions.
  10. **Inherits:** :ref:`OpenXRSpatialComponentData<class_OpenXRSpatialComponentData>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  11. Object for storing the queries mesh3d result data.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. Object for storing the queries 3d mesh result data when calling :ref:`OpenXRSpatialEntityExtension.query_snapshot()<class_OpenXRSpatialEntityExtension_method_query_snapshot>`.
  16. .. rst-class:: classref-reftable-group
  17. Methods
  18. -------
  19. .. table::
  20. :widths: auto
  21. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`Mesh<class_Mesh>` | :ref:`get_mesh<class_OpenXRSpatialComponentMesh3DList_method_get_mesh>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
  23. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`Transform3D<class_Transform3D>` | :ref:`get_transform<class_OpenXRSpatialComponentMesh3DList_method_get_transform>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
  25. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  26. .. rst-class:: classref-section-separator
  27. ----
  28. .. rst-class:: classref-descriptions-group
  29. Method Descriptions
  30. -------------------
  31. .. _class_OpenXRSpatialComponentMesh3DList_method_get_mesh:
  32. .. rst-class:: classref-method
  33. :ref:`Mesh<class_Mesh>` **get_mesh**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_OpenXRSpatialComponentMesh3DList_method_get_mesh>`
  34. Returns the mesh for the entity at this ``index``.
  35. .. rst-class:: classref-item-separator
  36. ----
  37. .. _class_OpenXRSpatialComponentMesh3DList_method_get_transform:
  38. .. rst-class:: classref-method
  39. :ref:`Transform3D<class_Transform3D>` **get_transform**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_OpenXRSpatialComponentMesh3DList_method_get_transform>`
  40. Returns the transform for positioning our mesh for the entity at this ``index``.
  41. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  42. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
  43. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  44. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  45. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  46. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  47. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  48. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  49. .. |void| replace:: :abbr:`void (No return value.)`