class_xrcontrollertracker.rst 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/XRControllerTracker.xml.
  6. .. _class_XRControllerTracker:
  7. XRControllerTracker
  8. ===================
  9. **Inherits:** :ref:`XRPositionalTracker<class_XRPositionalTracker>` **<** :ref:`XRTracker<class_XRTracker>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. A tracked controller.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. An instance of this object represents a controller that is tracked.
  15. As controllers are turned on and the :ref:`XRInterface<class_XRInterface>` detects them, instances of this object are automatically added to this list of active tracking objects accessible through the :ref:`XRServer<class_XRServer>`.
  16. The :ref:`XRController3D<class_XRController3D>` consumes objects of this type and should be used in your project.
  17. .. rst-class:: classref-introduction-group
  18. Tutorials
  19. ---------
  20. - :doc:`XR documentation index <../tutorials/xr/index>`
  21. .. rst-class:: classref-reftable-group
  22. Properties
  23. ----------
  24. .. table::
  25. :widths: auto
  26. +-----------------------------------------------+------+-------------------------------------------------------------------+
  27. | :ref:`TrackerType<enum_XRServer_TrackerType>` | type | ``2`` (overrides :ref:`XRTracker<class_XRTracker_property_type>`) |
  28. +-----------------------------------------------+------+-------------------------------------------------------------------+
  29. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  30. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  31. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  32. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  33. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  34. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  35. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  36. .. |void| replace:: :abbr:`void (No return value.)`