class_openxrinteractionprofile.rst 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the OpenXRInteractionProfile.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_OpenXRInteractionProfile:
  6. OpenXRInteractionProfile
  7. ========================
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. Suggested bindings object for OpenXR.
  10. Description
  11. -----------
  12. 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.
  13. 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>`__.
  14. Properties
  15. ----------
  16. +-----------------------------+---------------------------------------------------------------------------------------------------+--------+
  17. | :ref:`Array<class_Array>` | :ref:`bindings<class_OpenXRInteractionProfile_property_bindings>` | ``[]`` |
  18. +-----------------------------+---------------------------------------------------------------------------------------------------+--------+
  19. | :ref:`String<class_String>` | :ref:`interaction_profile_path<class_OpenXRInteractionProfile_property_interaction_profile_path>` | ``""`` |
  20. +-----------------------------+---------------------------------------------------------------------------------------------------+--------+
  21. Property Descriptions
  22. ---------------------
  23. .. _class_OpenXRInteractionProfile_property_bindings:
  24. - :ref:`Array<class_Array>` **bindings**
  25. +-----------+---------------------+
  26. | *Default* | ``[]`` |
  27. +-----------+---------------------+
  28. | *Setter* | set_bindings(value) |
  29. +-----------+---------------------+
  30. | *Getter* | get_bindings() |
  31. +-----------+---------------------+
  32. Action bindings for this interaction profile.
  33. ----
  34. .. _class_OpenXRInteractionProfile_property_interaction_profile_path:
  35. - :ref:`String<class_String>` **interaction_profile_path**
  36. +-----------+-------------------------------------+
  37. | *Default* | ``""`` |
  38. +-----------+-------------------------------------+
  39. | *Setter* | set_interaction_profile_path(value) |
  40. +-----------+-------------------------------------+
  41. | *Getter* | get_interaction_profile_path() |
  42. +-----------+-------------------------------------+
  43. The interaction profile path identifying the XR device.
  44. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  45. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  46. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  47. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  48. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  49. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`