mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
245 lines
9.4 KiB
ReStructuredText
245 lines
9.4 KiB
ReStructuredText
: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/modules/openxr/doc_classes/OpenXRSpatialCapabilityConfigurationAruco.xml.
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco:
|
|
|
|
OpenXRSpatialCapabilityConfigurationAruco
|
|
=========================================
|
|
|
|
**Experimental:** This class may be changed or removed in future versions.
|
|
|
|
**Inherits:** :ref:`OpenXRSpatialCapabilityConfigurationBaseHeader<class_OpenXRSpatialCapabilityConfigurationBaseHeader>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Configuration header for Aruco markers.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Configuration header for Aruco markers. Pass this to :ref:`OpenXRSpatialEntityExtension.create_spatial_context()<class_OpenXRSpatialEntityExtension_method_create_spatial_context>` to create a spatial context that can detect Aruco markers.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------+
|
|
| :ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` | :ref:`aruco_dict<class_OpenXRSpatialCapabilityConfigurationAruco_property_aruco_dict>` | ``16`` |
|
|
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------+
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Methods
|
|
-------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`get_enabled_components<class_OpenXRSpatialCapabilityConfigurationAruco_method_get_enabled_components>`\ (\ ) |const| |
|
|
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **ArucoDict**: :ref:`🔗<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>`
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_constant_ARUCO_DICT_4X4_50:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **ARUCO_DICT_4X4_50** = ``1``
|
|
|
|
4 by 4 pixel Aruco marker dictionary with 50 IDs.
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_constant_ARUCO_DICT_4X4_100:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **ARUCO_DICT_4X4_100** = ``2``
|
|
|
|
4 by 4 pixel Aruco marker dictionary with 100 IDs.
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_constant_ARUCO_DICT_4X4_250:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **ARUCO_DICT_4X4_250** = ``3``
|
|
|
|
4 by 4 pixel Aruco marker dictionary with 250 IDs.
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_constant_ARUCO_DICT_4X4_1000:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **ARUCO_DICT_4X4_1000** = ``4``
|
|
|
|
4 by 4 pixel Aruco marker dictionary with 1000 IDs.
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_constant_ARUCO_DICT_5X5_50:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **ARUCO_DICT_5X5_50** = ``5``
|
|
|
|
5 by 5 pixel Aruco marker dictionary with 50 IDs.
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_constant_ARUCO_DICT_5X5_100:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **ARUCO_DICT_5X5_100** = ``6``
|
|
|
|
5 by 5 pixel Aruco marker dictionary with 100 IDs.
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_constant_ARUCO_DICT_5X5_250:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **ARUCO_DICT_5X5_250** = ``7``
|
|
|
|
5 by 5 pixel Aruco marker dictionary with 250 IDs.
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_constant_ARUCO_DICT_5X5_1000:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **ARUCO_DICT_5X5_1000** = ``8``
|
|
|
|
5 by 5 pixel Aruco marker dictionary with 1000 IDs.
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_constant_ARUCO_DICT_6X6_50:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **ARUCO_DICT_6X6_50** = ``9``
|
|
|
|
6 by 6 pixel Aruco marker dictionary with 50 IDs.
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_constant_ARUCO_DICT_6X6_100:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **ARUCO_DICT_6X6_100** = ``10``
|
|
|
|
6 by 6 pixel Aruco marker dictionary with 100 IDs.
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_constant_ARUCO_DICT_6X6_250:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **ARUCO_DICT_6X6_250** = ``11``
|
|
|
|
6 by 6 pixel Aruco marker dictionary with 250 IDs.
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_constant_ARUCO_DICT_6X6_1000:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **ARUCO_DICT_6X6_1000** = ``12``
|
|
|
|
6 by 6 pixel Aruco marker dictionary with 1000 IDs.
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_constant_ARUCO_DICT_7X7_50:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **ARUCO_DICT_7X7_50** = ``13``
|
|
|
|
7 by 7 pixel Aruco marker dictionary with 50 IDs.
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_constant_ARUCO_DICT_7X7_100:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **ARUCO_DICT_7X7_100** = ``14``
|
|
|
|
7 by 7 pixel Aruco marker dictionary with 100 IDs.
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_constant_ARUCO_DICT_7X7_250:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **ARUCO_DICT_7X7_250** = ``15``
|
|
|
|
7 by 7 pixel Aruco marker dictionary with 250 IDs.
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_constant_ARUCO_DICT_7X7_1000:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **ARUCO_DICT_7X7_1000** = ``16``
|
|
|
|
7 by 7 pixel Aruco marker dictionary with 1000 IDs.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_property_aruco_dict:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **aruco_dict** = ``16`` :ref:`🔗<class_OpenXRSpatialCapabilityConfigurationAruco_property_aruco_dict>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_aruco_dict**\ (\ value\: :ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>`\ )
|
|
- :ref:`ArucoDict<enum_OpenXRSpatialCapabilityConfigurationAruco_ArucoDict>` **get_aruco_dict**\ (\ )
|
|
|
|
Dictionary to use to decode Aruco markers.
|
|
|
|
\ **Note:** Must be set before using this configuration to create a spatial context.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_OpenXRSpatialCapabilityConfigurationAruco_method_get_enabled_components:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`PackedInt64Array<class_PackedInt64Array>` **get_enabled_components**\ (\ ) |const| :ref:`🔗<class_OpenXRSpatialCapabilityConfigurationAruco_method_get_enabled_components>`
|
|
|
|
Returns the components enabled by this configuration.
|
|
|
|
\ **Note:** Only valid after this configuration was used to create a spatial context.
|
|
|
|
.. |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.)`
|