mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 17:28:58 +00:00
98 lines
4.6 KiB
ReStructuredText
98 lines
4.6 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/OpenXRInteractionProfile.xml.
|
|
|
|
.. _class_OpenXRInteractionProfile:
|
|
|
|
OpenXRInteractionProfile
|
|
========================
|
|
|
|
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Suggested bindings object for OpenXR.
|
|
|
|
Description
|
|
-----------
|
|
|
|
This object stores suggested bindings for an interaction profile. Interaction profiles define the meta data for a tracked XR device such as an XR controller.
|
|
|
|
For more information see the `interaction profiles info in the OpenXR specification <https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#semantic-path-interaction-profiles>`__.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-----------------------------+---------------------------------------------------------------------------------------------------+--------+
|
|
| :ref:`Array<class_Array>` | :ref:`bindings<class_OpenXRInteractionProfile_property_bindings>` | ``[]`` |
|
|
+-----------------------------+---------------------------------------------------------------------------------------------------+--------+
|
|
| :ref:`String<class_String>` | :ref:`interaction_profile_path<class_OpenXRInteractionProfile_property_interaction_profile_path>` | ``""`` |
|
|
+-----------------------------+---------------------------------------------------------------------------------------------------+--------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`OpenXRIPBinding<class_OpenXRIPBinding>` | :ref:`get_binding<class_OpenXRInteractionProfile_method_get_binding>` **(** :ref:`int<class_int>` index **)** |const| |
|
|
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_binding_count<class_OpenXRInteractionProfile_method_get_binding_count>` **(** **)** |const| |
|
|
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_OpenXRInteractionProfile_property_bindings:
|
|
|
|
- :ref:`Array<class_Array>` **bindings**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``[]`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_bindings(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | get_bindings() |
|
|
+-----------+---------------------+
|
|
|
|
Action bindings for this interaction profile.
|
|
|
|
----
|
|
|
|
.. _class_OpenXRInteractionProfile_property_interaction_profile_path:
|
|
|
|
- :ref:`String<class_String>` **interaction_profile_path**
|
|
|
|
+-----------+-------------------------------------+
|
|
| *Default* | ``""`` |
|
|
+-----------+-------------------------------------+
|
|
| *Setter* | set_interaction_profile_path(value) |
|
|
+-----------+-------------------------------------+
|
|
| *Getter* | get_interaction_profile_path() |
|
|
+-----------+-------------------------------------+
|
|
|
|
The interaction profile path identifying the XR device.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_OpenXRInteractionProfile_method_get_binding:
|
|
|
|
- :ref:`OpenXRIPBinding<class_OpenXRIPBinding>` **get_binding** **(** :ref:`int<class_int>` index **)** |const|
|
|
|
|
Retrieve the binding at this index.
|
|
|
|
----
|
|
|
|
.. _class_OpenXRInteractionProfile_method_get_binding_count:
|
|
|
|
- :ref:`int<class_int>` **get_binding_count** **(** **)** |const|
|
|
|
|
Get the number of bindings in this interaction profile.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |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.)`
|