.. 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/docs/gdscript/doc/classes/XRHandTracker.xml. .. _class_XRHandTracker: XRHandTracker ============= **Inherits:** :ref:`XRPositionalTracker` **<** :ref:`XRTracker` **<** :ref:`RefCounted` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +------------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ | :ref:`TrackerHand` | hand | ``1`` (overrides :ref:`XRPositionalTracker`) | +------------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ | :ref:`HandTrackingSource` | :ref:`hand_tracking_source` | ``0`` | +------------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_tracking_data` | ``false`` | +------------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ | :ref:`TrackerType` | type | ``16`` (overrides :ref:`XRTracker`) | +------------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_hand_joint_angular_velocity` **(** :ref:`HandJoint` joint **)** |const| | +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |bitfield|\<:ref:`HandJointFlags`\> | :ref:`get_hand_joint_flags` **(** :ref:`HandJoint` joint **)** |const| | +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_hand_joint_linear_velocity` **(** :ref:`HandJoint` joint **)** |const| | +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_hand_joint_radius` **(** :ref:`HandJoint` joint **)** |const| | +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`get_hand_joint_transform` **(** :ref:`HandJoint` joint **)** |const| | +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_hand_joint_angular_velocity` **(** :ref:`HandJoint` joint, :ref:`Vector3` angular_velocity **)** | +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_hand_joint_flags` **(** :ref:`HandJoint` joint, |bitfield|\<:ref:`HandJointFlags`\> flags **)** | +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_hand_joint_linear_velocity` **(** :ref:`HandJoint` joint, :ref:`Vector3` linear_velocity **)** | +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_hand_joint_radius` **(** :ref:`HandJoint` joint, :ref:`float` radius **)** | +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_hand_joint_transform` **(** :ref:`HandJoint` joint, :ref:`Transform3D` transform **)** | +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_XRHandTracker_HandTrackingSource: .. rst-class:: classref-enumeration enum **HandTrackingSource**: .. _class_XRHandTracker_constant_HAND_TRACKING_SOURCE_UNKNOWN: .. rst-class:: classref-enumeration-constant :ref:`HandTrackingSource` **HAND_TRACKING_SOURCE_UNKNOWN** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_TRACKING_SOURCE_UNOBSTRUCTED: .. rst-class:: classref-enumeration-constant :ref:`HandTrackingSource` **HAND_TRACKING_SOURCE_UNOBSTRUCTED** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_TRACKING_SOURCE_CONTROLLER: .. rst-class:: classref-enumeration-constant :ref:`HandTrackingSource` **HAND_TRACKING_SOURCE_CONTROLLER** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_TRACKING_SOURCE_MAX: .. rst-class:: classref-enumeration-constant :ref:`HandTrackingSource` **HAND_TRACKING_SOURCE_MAX** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_XRHandTracker_HandJoint: .. rst-class:: classref-enumeration enum **HandJoint**: .. _class_XRHandTracker_constant_HAND_JOINT_PALM: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_PALM** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_WRIST: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_WRIST** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_THUMB_METACARPAL: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_THUMB_METACARPAL** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_THUMB_PHALANX_PROXIMAL: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_THUMB_PHALANX_PROXIMAL** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_THUMB_PHALANX_DISTAL: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_THUMB_PHALANX_DISTAL** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_THUMB_TIP: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_THUMB_TIP** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_INDEX_FINGER_METACARPAL: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_INDEX_FINGER_METACARPAL** = ``6`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_INDEX_FINGER_PHALANX_PROXIMAL: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_INDEX_FINGER_PHALANX_PROXIMAL** = ``7`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_INDEX_FINGER_PHALANX_INTERMEDIATE: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_INDEX_FINGER_PHALANX_INTERMEDIATE** = ``8`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_INDEX_FINGER_PHALANX_DISTAL: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_INDEX_FINGER_PHALANX_DISTAL** = ``9`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_INDEX_FINGER_TIP: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_INDEX_FINGER_TIP** = ``10`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_MIDDLE_FINGER_METACARPAL: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_MIDDLE_FINGER_METACARPAL** = ``11`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_MIDDLE_FINGER_PHALANX_PROXIMAL: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_MIDDLE_FINGER_PHALANX_PROXIMAL** = ``12`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_MIDDLE_FINGER_PHALANX_INTERMEDIATE: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_MIDDLE_FINGER_PHALANX_INTERMEDIATE** = ``13`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_MIDDLE_FINGER_PHALANX_DISTAL: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_MIDDLE_FINGER_PHALANX_DISTAL** = ``14`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_MIDDLE_FINGER_TIP: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_MIDDLE_FINGER_TIP** = ``15`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_RING_FINGER_METACARPAL: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_RING_FINGER_METACARPAL** = ``16`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_RING_FINGER_PHALANX_PROXIMAL: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_RING_FINGER_PHALANX_PROXIMAL** = ``17`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_RING_FINGER_PHALANX_INTERMEDIATE: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_RING_FINGER_PHALANX_INTERMEDIATE** = ``18`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_RING_FINGER_PHALANX_DISTAL: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_RING_FINGER_PHALANX_DISTAL** = ``19`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_RING_FINGER_TIP: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_RING_FINGER_TIP** = ``20`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_PINKY_FINGER_METACARPAL: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_PINKY_FINGER_METACARPAL** = ``21`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_PINKY_FINGER_PHALANX_PROXIMAL: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_PINKY_FINGER_PHALANX_PROXIMAL** = ``22`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_PINKY_FINGER_PHALANX_INTERMEDIATE: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_PINKY_FINGER_PHALANX_INTERMEDIATE** = ``23`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_PINKY_FINGER_PHALANX_DISTAL: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_PINKY_FINGER_PHALANX_DISTAL** = ``24`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_PINKY_FINGER_TIP: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_PINKY_FINGER_TIP** = ``25`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_MAX: .. rst-class:: classref-enumeration-constant :ref:`HandJoint` **HAND_JOINT_MAX** = ``26`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_XRHandTracker_HandJointFlags: .. rst-class:: classref-enumeration flags **HandJointFlags**: .. _class_XRHandTracker_constant_HAND_JOINT_FLAG_ORIENTATION_VALID: .. rst-class:: classref-enumeration-constant :ref:`HandJointFlags` **HAND_JOINT_FLAG_ORIENTATION_VALID** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_FLAG_ORIENTATION_TRACKED: .. rst-class:: classref-enumeration-constant :ref:`HandJointFlags` **HAND_JOINT_FLAG_ORIENTATION_TRACKED** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_FLAG_POSITION_VALID: .. rst-class:: classref-enumeration-constant :ref:`HandJointFlags` **HAND_JOINT_FLAG_POSITION_VALID** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_FLAG_POSITION_TRACKED: .. rst-class:: classref-enumeration-constant :ref:`HandJointFlags` **HAND_JOINT_FLAG_POSITION_TRACKED** = ``8`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_FLAG_LINEAR_VELOCITY_VALID: .. rst-class:: classref-enumeration-constant :ref:`HandJointFlags` **HAND_JOINT_FLAG_LINEAR_VELOCITY_VALID** = ``16`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRHandTracker_constant_HAND_JOINT_FLAG_ANGULAR_VELOCITY_VALID: .. rst-class:: classref-enumeration-constant :ref:`HandJointFlags` **HAND_JOINT_FLAG_ANGULAR_VELOCITY_VALID** = ``32`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_XRHandTracker_property_hand_tracking_source: .. rst-class:: classref-property :ref:`HandTrackingSource` **hand_tracking_source** = ``0`` .. rst-class:: classref-property-setget - void **set_hand_tracking_source** **(** :ref:`HandTrackingSource` value **)** - :ref:`HandTrackingSource` **get_hand_tracking_source** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRHandTracker_property_has_tracking_data: .. rst-class:: classref-property :ref:`bool` **has_tracking_data** = ``false`` .. rst-class:: classref-property-setget - void **set_has_tracking_data** **(** :ref:`bool` value **)** - :ref:`bool` **get_has_tracking_data** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_XRHandTracker_method_get_hand_joint_angular_velocity: .. rst-class:: classref-method :ref:`Vector3` **get_hand_joint_angular_velocity** **(** :ref:`HandJoint` joint **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRHandTracker_method_get_hand_joint_flags: .. rst-class:: classref-method |bitfield|\<:ref:`HandJointFlags`\> **get_hand_joint_flags** **(** :ref:`HandJoint` joint **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRHandTracker_method_get_hand_joint_linear_velocity: .. rst-class:: classref-method :ref:`Vector3` **get_hand_joint_linear_velocity** **(** :ref:`HandJoint` joint **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRHandTracker_method_get_hand_joint_radius: .. rst-class:: classref-method :ref:`float` **get_hand_joint_radius** **(** :ref:`HandJoint` joint **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRHandTracker_method_get_hand_joint_transform: .. rst-class:: classref-method :ref:`Transform3D` **get_hand_joint_transform** **(** :ref:`HandJoint` joint **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRHandTracker_method_set_hand_joint_angular_velocity: .. rst-class:: classref-method void **set_hand_joint_angular_velocity** **(** :ref:`HandJoint` joint, :ref:`Vector3` angular_velocity **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRHandTracker_method_set_hand_joint_flags: .. rst-class:: classref-method void **set_hand_joint_flags** **(** :ref:`HandJoint` joint, |bitfield|\<:ref:`HandJointFlags`\> flags **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRHandTracker_method_set_hand_joint_linear_velocity: .. rst-class:: classref-method void **set_hand_joint_linear_velocity** **(** :ref:`HandJoint` joint, :ref:`Vector3` linear_velocity **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRHandTracker_method_set_hand_joint_radius: .. rst-class:: classref-method void **set_hand_joint_radius** **(** :ref:`HandJoint` joint, :ref:`float` radius **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRHandTracker_method_set_hand_joint_transform: .. rst-class:: classref-method void **set_hand_joint_transform** **(** :ref:`HandJoint` joint, :ref:`Transform3D` transform **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`