| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the ARVRPositionalTracker.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_ARVRPositionalTracker:
- ARVRPositionalTracker
- =====================
- **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
- A tracked object.
- Description
- -----------
- An instance of this object represents a device that is tracked, such as a controller or anchor point. HMDs aren't represented here as they are handled internally.
- As controllers are turned on and the AR/VR interface detects them, instances of this object are automatically added to this list of active tracking objects accessible through the :ref:`ARVRServer<class_ARVRServer>`.
- The :ref:`ARVRController<class_ARVRController>` and :ref:`ARVRAnchor<class_ARVRAnchor>` both consume objects of this type and should be used in your project. The positional trackers are just under-the-hood objects that make this all work. These are mostly exposed so that GDNative-based interfaces can interact with them.
- Tutorials
- ---------
- - :doc:`../tutorials/vr/index`
- Properties
- ----------
- +---------------------------+------------------------------------------------------------+---------+
- | :ref:`float<class_float>` | :ref:`rumble<class_ARVRPositionalTracker_property_rumble>` | ``0.0`` |
- +---------------------------+------------------------------------------------------------+---------+
- Methods
- -------
- +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`TrackerHand<enum_ARVRPositionalTracker_TrackerHand>` | :ref:`get_hand<class_ARVRPositionalTracker_method_get_hand>` **(** **)** |const| |
- +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_joy_id<class_ARVRPositionalTracker_method_get_joy_id>` **(** **)** |const| |
- +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Mesh<class_Mesh>` | :ref:`get_mesh<class_ARVRPositionalTracker_method_get_mesh>` **(** **)** |const| |
- +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_name<class_ARVRPositionalTracker_method_get_name>` **(** **)** |const| |
- +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Basis<class_Basis>` | :ref:`get_orientation<class_ARVRPositionalTracker_method_get_orientation>` **(** **)** |const| |
- +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`get_position<class_ARVRPositionalTracker_method_get_position>` **(** **)** |const| |
- +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_tracker_id<class_ARVRPositionalTracker_method_get_tracker_id>` **(** **)** |const| |
- +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`get_tracks_orientation<class_ARVRPositionalTracker_method_get_tracks_orientation>` **(** **)** |const| |
- +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`get_tracks_position<class_ARVRPositionalTracker_method_get_tracks_position>` **(** **)** |const| |
- +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Transform<class_Transform>` | :ref:`get_transform<class_ARVRPositionalTracker_method_get_transform>` **(** :ref:`bool<class_bool>` adjust_by_reference_frame **)** |const| |
- +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`TrackerType<enum_ARVRServer_TrackerType>` | :ref:`get_type<class_ARVRPositionalTracker_method_get_type>` **(** **)** |const| |
- +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- Enumerations
- ------------
- .. _enum_ARVRPositionalTracker_TrackerHand:
- .. _class_ARVRPositionalTracker_constant_TRACKER_HAND_UNKNOWN:
- .. _class_ARVRPositionalTracker_constant_TRACKER_LEFT_HAND:
- .. _class_ARVRPositionalTracker_constant_TRACKER_RIGHT_HAND:
- enum **TrackerHand**:
- - **TRACKER_HAND_UNKNOWN** = **0** --- The hand this tracker is held in is unknown or not applicable.
- - **TRACKER_LEFT_HAND** = **1** --- This tracker is the left hand controller.
- - **TRACKER_RIGHT_HAND** = **2** --- This tracker is the right hand controller.
- Property Descriptions
- ---------------------
- .. _class_ARVRPositionalTracker_property_rumble:
- - :ref:`float<class_float>` **rumble**
- +-----------+-------------------+
- | *Default* | ``0.0`` |
- +-----------+-------------------+
- | *Setter* | set_rumble(value) |
- +-----------+-------------------+
- | *Getter* | get_rumble() |
- +-----------+-------------------+
- The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``.
- Method Descriptions
- -------------------
- .. _class_ARVRPositionalTracker_method_get_hand:
- - :ref:`TrackerHand<enum_ARVRPositionalTracker_TrackerHand>` **get_hand** **(** **)** |const|
- Returns the hand holding this tracker, if known. See :ref:`TrackerHand<enum_ARVRPositionalTracker_TrackerHand>` constants.
- ----
- .. _class_ARVRPositionalTracker_method_get_joy_id:
- - :ref:`int<class_int>` **get_joy_id** **(** **)** |const|
- If this is a controller that is being tracked, the controller will also be represented by a joystick entry with this ID.
- ----
- .. _class_ARVRPositionalTracker_method_get_mesh:
- - :ref:`Mesh<class_Mesh>` **get_mesh** **(** **)** |const|
- Returns the mesh related to a controller or anchor point if one is available.
- ----
- .. _class_ARVRPositionalTracker_method_get_name:
- - :ref:`String<class_String>` **get_name** **(** **)** |const|
- Returns the controller or anchor point's name if available.
- ----
- .. _class_ARVRPositionalTracker_method_get_orientation:
- - :ref:`Basis<class_Basis>` **get_orientation** **(** **)** |const|
- Returns the controller's orientation matrix.
- ----
- .. _class_ARVRPositionalTracker_method_get_position:
- - :ref:`Vector3<class_Vector3>` **get_position** **(** **)** |const|
- Returns the world-space controller position.
- ----
- .. _class_ARVRPositionalTracker_method_get_tracker_id:
- - :ref:`int<class_int>` **get_tracker_id** **(** **)** |const|
- Returns the internal tracker ID. This uniquely identifies the tracker per tracker type and matches the ID you need to specify for nodes such as the :ref:`ARVRController<class_ARVRController>` and :ref:`ARVRAnchor<class_ARVRAnchor>` nodes.
- ----
- .. _class_ARVRPositionalTracker_method_get_tracks_orientation:
- - :ref:`bool<class_bool>` **get_tracks_orientation** **(** **)** |const|
- Returns ``true`` if this device tracks orientation.
- ----
- .. _class_ARVRPositionalTracker_method_get_tracks_position:
- - :ref:`bool<class_bool>` **get_tracks_position** **(** **)** |const|
- Returns ``true`` if this device tracks position.
- ----
- .. _class_ARVRPositionalTracker_method_get_transform:
- - :ref:`Transform<class_Transform>` **get_transform** **(** :ref:`bool<class_bool>` adjust_by_reference_frame **)** |const|
- Returns the transform combining this device's orientation and position.
- ----
- .. _class_ARVRPositionalTracker_method_get_type:
- - :ref:`TrackerType<enum_ARVRServer_TrackerType>` **get_type** **(** **)** |const|
- Returns the tracker's type.
- .. |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.)`
|
