Files
godot-docs-l10n/classes/es/class_xrpositionaltracker.rst

333 lines
16 KiB
ReStructuredText

:github_url: hide
.. _class_XRPositionalTracker:
XRPositionalTracker
===================
**Hereda:** :ref:`XRTracker<class_XRTracker>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
**Heredado por:** :ref:`XRBodyTracker<class_XRBodyTracker>`, :ref:`XRControllerTracker<class_XRControllerTracker>`, :ref:`XRHandTracker<class_XRHandTracker>`
Un objeto rastreado.
.. rst-class:: classref-introduction-group
Descripción
----------------------
Una instancia de este objeto representa un dispositivo rastreado, como un controlador o un punto de anclaje. Los HMD no se representan aquí, ya que se gestionan internamente.
A medida que se activan los controladores y :ref:`XRInterface<class_XRInterface>` los detecta, las instancias de este objeto se añaden automáticamente a la lista de objetos de seguimiento activos, accesibles a través de :ref:`XRServer<class_XRServer>`.
Tanto :ref:`XRNode3D<class_XRNode3D>` como :ref:`XRAnchor3D<class_XRAnchor3D>` consumen objetos de este tipo y deberían usarse en el proyecto. Los rastreadores posicionales son objetos internos que hacen que todo esto funcione. Estos se exponen principalmente para que las interfaces basadas en GDExtension puedan interactuar con ellos.
.. rst-class:: classref-introduction-group
Tutoriales
--------------------
- :doc:`Índice de documentación XR <../tutorials/xr/index>`
.. rst-class:: classref-reftable-group
Propiedades
----------------------
.. table::
:widths: auto
+----------------------------------------------------------+------------------------------------------------------------+--------+
| :ref:`TrackerHand<enum_XRPositionalTracker_TrackerHand>` | :ref:`hand<class_XRPositionalTracker_property_hand>` | ``0`` |
+----------------------------------------------------------+------------------------------------------------------------+--------+
| :ref:`String<class_String>` | :ref:`profile<class_XRPositionalTracker_property_profile>` | ``""`` |
+----------------------------------------------------------+------------------------------------------------------------+--------+
.. rst-class:: classref-reftable-group
Métodos
--------------
.. table::
:widths: auto
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`get_input<class_XRPositionalTracker_method_get_input>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`XRPose<class_XRPose>` | :ref:`get_pose<class_XRPositionalTracker_method_get_pose>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_pose<class_XRPositionalTracker_method_has_pose>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`invalidate_pose<class_XRPositionalTracker_method_invalidate_pose>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_input<class_XRPositionalTracker_method_set_input>`\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_pose<class_XRPositionalTracker_method_set_pose>`\ (\ name\: :ref:`StringName<class_StringName>`, transform\: :ref:`Transform3D<class_Transform3D>`, linear_velocity\: :ref:`Vector3<class_Vector3>`, angular_velocity\: :ref:`Vector3<class_Vector3>`, tracking_confidence\: :ref:`TrackingConfidence<enum_XRPose_TrackingConfidence>`\ ) |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Señales
--------------
.. _class_XRPositionalTracker_signal_button_pressed:
.. rst-class:: classref-signal
**button_pressed**\ (\ name\: :ref:`String<class_String>`\ ) :ref:`🔗<class_XRPositionalTracker_signal_button_pressed>`
Emitida al pulsar un botón de este tracker. Ten en cuenta que muchos entornos de ejecución XR permiten asignar otras entradas a los botones.
.. rst-class:: classref-item-separator
----
.. _class_XRPositionalTracker_signal_button_released:
.. rst-class:: classref-signal
**button_released**\ (\ name\: :ref:`String<class_String>`\ ) :ref:`🔗<class_XRPositionalTracker_signal_button_released>`
Emitida cuando se libera un botón de este controlador.
.. rst-class:: classref-item-separator
----
.. _class_XRPositionalTracker_signal_input_float_changed:
.. rst-class:: classref-signal
**input_float_changed**\ (\ name\: :ref:`String<class_String>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_XRPositionalTracker_signal_input_float_changed>`
Emitida cuando un disparador o entrada similar en este rastreador cambia de valor.
.. rst-class:: classref-item-separator
----
.. _class_XRPositionalTracker_signal_input_vector2_changed:
.. rst-class:: classref-signal
**input_vector2_changed**\ (\ name\: :ref:`String<class_String>`, vector\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_XRPositionalTracker_signal_input_vector2_changed>`
Emitida cuando se mueve un joystick o un pad en este rastreador.
.. rst-class:: classref-item-separator
----
.. _class_XRPositionalTracker_signal_pose_changed:
.. rst-class:: classref-signal
**pose_changed**\ (\ pose\: :ref:`XRPose<class_XRPose>`\ ) :ref:`🔗<class_XRPositionalTracker_signal_pose_changed>`
Emitida cuando cambia el estado de una pose rastreada por este rastreador.
.. rst-class:: classref-item-separator
----
.. _class_XRPositionalTracker_signal_pose_lost_tracking:
.. rst-class:: classref-signal
**pose_lost_tracking**\ (\ pose\: :ref:`XRPose<class_XRPose>`\ ) :ref:`🔗<class_XRPositionalTracker_signal_pose_lost_tracking>`
Emitida cuando una pose rastreada por este rastreador deja de recibir datos de seguimiento actualizados.
.. rst-class:: classref-item-separator
----
.. _class_XRPositionalTracker_signal_profile_changed:
.. rst-class:: classref-signal
**profile_changed**\ (\ role\: :ref:`String<class_String>`\ ) :ref:`🔗<class_XRPositionalTracker_signal_profile_changed>`
Emitida cuando cambia el perfil de nuestro rastreador.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Enumeraciones
--------------------------
.. _enum_XRPositionalTracker_TrackerHand:
.. rst-class:: classref-enumeration
enum **TrackerHand**: :ref:`🔗<enum_XRPositionalTracker_TrackerHand>`
.. _class_XRPositionalTracker_constant_TRACKER_HAND_UNKNOWN:
.. rst-class:: classref-enumeration-constant
:ref:`TrackerHand<enum_XRPositionalTracker_TrackerHand>` **TRACKER_HAND_UNKNOWN** = ``0``
La mano con la que se sostiene este rastreador es desconocida o no aplicable.
.. _class_XRPositionalTracker_constant_TRACKER_HAND_LEFT:
.. rst-class:: classref-enumeration-constant
:ref:`TrackerHand<enum_XRPositionalTracker_TrackerHand>` **TRACKER_HAND_LEFT** = ``1``
Este rastreador es el controlador de la mano izquierda.
.. _class_XRPositionalTracker_constant_TRACKER_HAND_RIGHT:
.. rst-class:: classref-enumeration-constant
:ref:`TrackerHand<enum_XRPositionalTracker_TrackerHand>` **TRACKER_HAND_RIGHT** = ``2``
Este rastreador es el controlador de la mano derecha.
.. _class_XRPositionalTracker_constant_TRACKER_HAND_MAX:
.. rst-class:: classref-enumeration-constant
:ref:`TrackerHand<enum_XRPositionalTracker_TrackerHand>` **TRACKER_HAND_MAX** = ``3``
Representa el tamaño del enum :ref:`TrackerHand<enum_XRPositionalTracker_TrackerHand>`.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descripciones de Propiedades
--------------------------------------------------------
.. _class_XRPositionalTracker_property_hand:
.. rst-class:: classref-property
:ref:`TrackerHand<enum_XRPositionalTracker_TrackerHand>` **hand** = ``0`` :ref:`🔗<class_XRPositionalTracker_property_hand>`
.. rst-class:: classref-property-setget
- |void| **set_tracker_hand**\ (\ value\: :ref:`TrackerHand<enum_XRPositionalTracker_TrackerHand>`\ )
- :ref:`TrackerHand<enum_XRPositionalTracker_TrackerHand>` **get_tracker_hand**\ (\ )
Define a qué mano se relaciona este rastreador.
.. rst-class:: classref-item-separator
----
.. _class_XRPositionalTracker_property_profile:
.. rst-class:: classref-property
:ref:`String<class_String>` **profile** = ``""`` :ref:`🔗<class_XRPositionalTracker_property_profile>`
.. rst-class:: classref-property-setget
- |void| **set_tracker_profile**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_String>` **get_tracker_profile**\ (\ )
El perfil asociado a este rastreador depende de la interfaz, pero indicará el tipo de controlador que se está rastreando.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descripciones de Métodos
------------------------------------------------
.. _class_XRPositionalTracker_method_get_input:
.. rst-class:: classref-method
:ref:`Variant<class_Variant>` **get_input**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_XRPositionalTracker_method_get_input>`
**Obsoleto:** Use through :ref:`XRControllerTracker<class_XRControllerTracker>`.
Devuelve una entrada para este rastreador. Puede devolver un valor booleano, de punto flotante o :ref:`Vector2<class_Vector2>`, dependiendo de si la entrada es un botón, un disparador o un joystick/pad.
.. rst-class:: classref-item-separator
----
.. _class_XRPositionalTracker_method_get_pose:
.. rst-class:: classref-method
:ref:`XRPose<class_XRPose>` **get_pose**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_XRPositionalTracker_method_get_pose>`
Devuelve el objeto de estado :ref:`XRPose<class_XRPose>` actual para la pose del ``name`` enlazado.
.. rst-class:: classref-item-separator
----
.. _class_XRPositionalTracker_method_has_pose:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **has_pose**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_XRPositionalTracker_method_has_pose>`
Devuelve ``true`` si el rastreador está disponible y actualmente está rastreando la pose enlazada ``name``.
.. rst-class:: classref-item-separator
----
.. _class_XRPositionalTracker_method_invalidate_pose:
.. rst-class:: classref-method
|void| **invalidate_pose**\ (\ name\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_XRPositionalTracker_method_invalidate_pose>`
Marca esta pose como inválida, no borramos el último estado informado pero permite a los usuarios decidir si los rastreadores deben ocultarse si perdemos el rastreo o simplemente permanecer en su última posición conocida.
.. rst-class:: classref-item-separator
----
.. _class_XRPositionalTracker_method_set_input:
.. rst-class:: classref-method
|void| **set_input**\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_XRPositionalTracker_method_set_input>`
**Obsoleto:** Use through :ref:`XRControllerTracker<class_XRControllerTracker>`.
Cambia el valor de la entrada dada. Este método es llamado por una implementación de :ref:`XRInterface<class_XRInterface>` y no debe usarse directamente.
.. rst-class:: classref-item-separator
----
.. _class_XRPositionalTracker_method_set_pose:
.. rst-class:: classref-method
|void| **set_pose**\ (\ name\: :ref:`StringName<class_StringName>`, transform\: :ref:`Transform3D<class_Transform3D>`, linear_velocity\: :ref:`Vector3<class_Vector3>`, angular_velocity\: :ref:`Vector3<class_Vector3>`, tracking_confidence\: :ref:`TrackingConfidence<enum_XRPose_TrackingConfidence>`\ ) :ref:`🔗<class_XRPositionalTracker_method_set_pose>`
Establece la transformación, la velocidad lineal, la velocidad angular y la confianza de seguimiento para la pose dada. Este método es llamado por una implementación de :ref:`XRInterface<class_XRInterface>` y no debe usarse directamente.
.. |virtual| replace:: :abbr:`virtual (Normalmente, este método debería ser sobreescrito por el usuario para que tenga algún efecto.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (Este método no tiene efectos secundarios. No modifica ninguna de las variables miembro de la instancia.)`
.. |vararg| replace:: :abbr:`vararg (Este método permite agregar cualquier número de argumentos después de los descritos aquí.)`
.. |constructor| replace:: :abbr:`constructor (Este método se utiliza para construir un tipo.)`
.. |static| replace:: :abbr:`static (Este método no necesita una instancia para ser llamado, por lo que puede llamarse directamente utilizando el nombre de la clase.)`
.. |operator| replace:: :abbr:`operator (Este método describe un operador válido para usar con este tipo como operando izquierdo.)`
.. |bitfield| replace:: :abbr:`BitField (Este valor es un entero compuesto como una máscara de bits de las siguientes banderas.)`
.. |void| replace:: :abbr:`void (Sin valor de retorno.)`