mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
175 lines
5.6 KiB
ReStructuredText
175 lines
5.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/OpenXRHand.xml.
|
|
|
|
.. _class_OpenXRHand:
|
|
|
|
OpenXRHand
|
|
==========
|
|
|
|
**Inherits:** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
Node supporting finger tracking in OpenXR.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
This node enables OpenXR's hand tracking functionality. The node should be a child node of an :ref:`XROrigin3D<class_XROrigin3D>` node, tracking will update its position to where the player's actual hand is positioned. This node also updates the skeleton of a properly skinned hand model. The hand mesh should be a child node of this node.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------------------------------+---------------------------------------------------------------+------------------+
|
|
| :ref:`Hands<enum_OpenXRHand_Hands>` | :ref:`hand<class_OpenXRHand_property_hand>` | ``0`` |
|
|
+-------------------------------------------------+---------------------------------------------------------------+------------------+
|
|
| :ref:`NodePath<class_NodePath>` | :ref:`hand_skeleton<class_OpenXRHand_property_hand_skeleton>` | ``NodePath("")`` |
|
|
+-------------------------------------------------+---------------------------------------------------------------+------------------+
|
|
| :ref:`MotionRange<enum_OpenXRHand_MotionRange>` | :ref:`motion_range<class_OpenXRHand_property_motion_range>` | ``0`` |
|
|
+-------------------------------------------------+---------------------------------------------------------------+------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_OpenXRHand_Hands:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **Hands**:
|
|
|
|
.. _class_OpenXRHand_constant_HAND_LEFT:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Hands<enum_OpenXRHand_Hands>` **HAND_LEFT** = ``0``
|
|
|
|
Tracking the player's left hand.
|
|
|
|
.. _class_OpenXRHand_constant_HAND_RIGHT:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Hands<enum_OpenXRHand_Hands>` **HAND_RIGHT** = ``1``
|
|
|
|
Tracking the player's right hand.
|
|
|
|
.. _class_OpenXRHand_constant_HAND_MAX:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Hands<enum_OpenXRHand_Hands>` **HAND_MAX** = ``2``
|
|
|
|
Maximum supported hands.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _enum_OpenXRHand_MotionRange:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **MotionRange**:
|
|
|
|
.. _class_OpenXRHand_constant_MOTION_RANGE_UNOBSTRUCTED:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`MotionRange<enum_OpenXRHand_MotionRange>` **MOTION_RANGE_UNOBSTRUCTED** = ``0``
|
|
|
|
When player grips, hand skeleton will form a full fist.
|
|
|
|
.. _class_OpenXRHand_constant_MOTION_RANGE_CONFORM_TO_CONTROLLER:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`MotionRange<enum_OpenXRHand_MotionRange>` **MOTION_RANGE_CONFORM_TO_CONTROLLER** = ``1``
|
|
|
|
When player grips, hand skeleton conforms to the controller the player is holding.
|
|
|
|
.. _class_OpenXRHand_constant_MOTION_RANGE_MAX:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`MotionRange<enum_OpenXRHand_MotionRange>` **MOTION_RANGE_MAX** = ``2``
|
|
|
|
Maximum supported motion ranges.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_OpenXRHand_property_hand:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Hands<enum_OpenXRHand_Hands>` **hand** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_hand** **(** :ref:`Hands<enum_OpenXRHand_Hands>` value **)**
|
|
- :ref:`Hands<enum_OpenXRHand_Hands>` **get_hand** **(** **)**
|
|
|
|
Specifies whether this node tracks the left or right hand of the player.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_OpenXRHand_property_hand_skeleton:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`NodePath<class_NodePath>` **hand_skeleton** = ``NodePath("")``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_hand_skeleton** **(** :ref:`NodePath<class_NodePath>` value **)**
|
|
- :ref:`NodePath<class_NodePath>` **get_hand_skeleton** **(** **)**
|
|
|
|
Set a :ref:`Skeleton3D<class_Skeleton3D>` node for which the pose positions will be updated.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_OpenXRHand_property_motion_range:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`MotionRange<enum_OpenXRHand_MotionRange>` **motion_range** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_motion_range** **(** :ref:`MotionRange<enum_OpenXRHand_MotionRange>` value **)**
|
|
- :ref:`MotionRange<enum_OpenXRHand_MotionRange>` **get_motion_range** **(** **)**
|
|
|
|
Set the motion range (if supported) limiting the hand motion.
|
|
|
|
.. |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.)`
|