stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with latest 4.0-dev

Browse Source
This commit is contained in:
Rémi Verschelde
2021-11-15 12:28:38 +01:00
parent d6d97aaf5e
commit 30193215cf
829 changed files with 12891 additions and 7761 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_xrserver.rst
+26 -14
View File
@@ -1,6 +1,6 @@
:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the XRServer.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
@@ -60,9 +60,9 @@ Methods
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform3D<class_Transform3D>` | :ref:`get_reference_frame<class_XRServer_method_get_reference_frame>` **(** **)** |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`XRPositionalTracker<class_XRPositionalTracker>` | :ref:`get_tracker<class_XRServer_method_get_tracker>` **(** :ref:`int<class_int>` idx **)** |const| |
| :ref:`XRPositionalTracker<class_XRPositionalTracker>` | :ref:`get_tracker<class_XRServer_method_get_tracker>` **(** :ref:`StringName<class_StringName>` tracker_name **)** |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_tracker_count<class_XRServer_method_get_tracker_count>` **(** **)** |const| |
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_trackers<class_XRServer_method_get_trackers>` **(** :ref:`int<class_int>` tracker_types **)** |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_interface<class_XRServer_method_remove_interface>` **(** :ref:`XRInterface<class_XRInterface>` interface **)** |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -90,7 +90,7 @@ Emitted when an interface is removed.
.. _class_XRServer_signal_tracker_added:
- **tracker_added** **(** :ref:`StringName<class_StringName>` tracker_name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
- **tracker_added** **(** :ref:`StringName<class_StringName>` tracker_name, :ref:`int<class_int>` type **)**
Emitted when a new tracker has been added. If you don't use a fixed number of controllers or if you're using :ref:`XRAnchor3D<class_XRAnchor3D>`\ s for an AR solution, it is important to react to this signal to add the appropriate :ref:`XRController3D<class_XRController3D>` or :ref:`XRAnchor3D<class_XRAnchor3D>` nodes related to this new tracker.
@@ -98,15 +98,25 @@ Emitted when a new tracker has been added. If you don't use a fixed number of co
.. _class_XRServer_signal_tracker_removed:
- **tracker_removed** **(** :ref:`StringName<class_StringName>` tracker_name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
- **tracker_removed** **(** :ref:`StringName<class_StringName>` tracker_name, :ref:`int<class_int>` type **)**
Emitted when a tracker is removed. You should remove any :ref:`XRController3D<class_XRController3D>` or :ref:`XRAnchor3D<class_XRAnchor3D>` points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one).
----
.. _class_XRServer_signal_tracker_updated:
- **tracker_updated** **(** :ref:`StringName<class_StringName>` tracker_name, :ref:`int<class_int>` type **)**
Emitted when an existing tracker has been updated. This can happen if the user switches controllers.
Enumerations
------------
.. _enum_XRServer_TrackerType:
.. _class_XRServer_constant_TRACKER_HEAD:
.. _class_XRServer_constant_TRACKER_CONTROLLER:
.. _class_XRServer_constant_TRACKER_BASESTATION:
@@ -121,11 +131,13 @@ Enumerations
enum **TrackerType**:
- **TRACKER_CONTROLLER** = **1** --- The tracker tracks the location of a controller.
- **TRACKER_HEAD** = **1** --- The tracker tracks the location of the players head. This is usually a location centered between the players eyes. Note that for handheld AR devices this can be the current location of the device.
- **TRACKER_BASESTATION** = **2** --- The tracker tracks the location of a base station.
- **TRACKER_CONTROLLER** = **2** --- The tracker tracks the location of a controller.
- **TRACKER_ANCHOR** = **4** --- The tracker tracks the location and size of an AR anchor.
- **TRACKER_BASESTATION** = **4** --- The tracker tracks the location of a base station.
- **TRACKER_ANCHOR** = **8** --- The tracker tracks the location and size of an AR anchor.
- **TRACKER_ANY_KNOWN** = **127** --- Used internally to filter trackers of any known type.
@@ -287,23 +299,23 @@ Returns the absolute timestamp (in μs) of the last ``XRServer`` process callbac
- :ref:`Transform3D<class_Transform3D>` **get_reference_frame** **(** **)** |const|
Returns the reference frame transform. Mostly used internally and exposed for GDNative build interfaces.
Returns the reference frame transform. Mostly used internally and exposed for GDExtension build interfaces.
----
.. _class_XRServer_method_get_tracker:
- :ref:`XRPositionalTracker<class_XRPositionalTracker>` **get_tracker** **(** :ref:`int<class_int>` idx **)** |const|
- :ref:`XRPositionalTracker<class_XRPositionalTracker>` **get_tracker** **(** :ref:`StringName<class_StringName>` tracker_name **)** |const|
Returns the positional tracker at the given ID.
Returns the positional tracker with this name.
----
.. _class_XRServer_method_get_tracker_count:
.. _class_XRServer_method_get_trackers:
- :ref:`int<class_int>` **get_tracker_count** **(** **)** |const|
- :ref:`Dictionary<class_Dictionary>` **get_trackers** **(** :ref:`int<class_int>` tracker_types **)**
Returns the number of trackers currently registered.
Returns a dictionary of trackers for this type.
----