godot-docs/classes/class_arvrserver.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ARVRServer.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_ARVRServer:

ARVRServer
==========

**Inherits:** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------

This is our AR/VR Server.

Member Functions
----------------

+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                       | :ref:`center_on_hmd<class_ARVRServer_center_on_hmd>` **(** :ref:`int<class_int>` rotation_mode, :ref:`bool<class_bool>` keep_height **)** |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ARVRInterface<class_arvrinterface>`                  | :ref:`find_interface<class_ARVRServer_find_interface>` **(** :ref:`String<class_string>` name **)** const                                 |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ARVRInterface<class_arvrinterface>`                  | :ref:`get_interface<class_ARVRServer_get_interface>` **(** :ref:`int<class_int>` idx **)** const                                          |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                                      | :ref:`get_interface_count<class_ARVRServer_get_interface_count>` **(** **)** const                                                        |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>`                                  | :ref:`get_interfaces<class_ARVRServer_get_interfaces>` **(** **)** const                                                                  |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>`                          | :ref:`get_reference_frame<class_ARVRServer_get_reference_frame>` **(** **)** const                                                        |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ARVRPositionalTracker<class_arvrpositionaltracker>`  | :ref:`get_tracker<class_ARVRServer_get_tracker>` **(** :ref:`int<class_int>` idx **)** const                                              |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                                      | :ref:`get_tracker_count<class_ARVRServer_get_tracker_count>` **(** **)** const                                                            |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                       | :ref:`set_primary_interface<class_ARVRServer_set_primary_interface>` **(** :ref:`ARVRInterface<class_arvrinterface>` interface **)**      |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+

Signals
-------

.. _class_ARVRServer_interface_added:

- **interface_added** **(** :ref:`String<class_string>` interface_name **)**

Signal send when a new interface has been added.

.. _class_ARVRServer_interface_removed:

- **interface_removed** **(** :ref:`String<class_string>` interface_name **)**

Signal send when an interface is removed.

.. _class_ARVRServer_tracker_added:

- **tracker_added** **(** :ref:`String<class_string>` tracker_name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**

Signal send when a new tracker has been added. If you don't use a fixed number of controllers or if you're using ARVRAnchors for an AR solution it is important to react to this signal and add the appropriate ARVRController or ARVRAnchor node related to this new tracker.

.. _class_ARVRServer_tracker_removed:

- **tracker_removed** **(** :ref:`String<class_string>` tracker_name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**

Signal send when a tracker is removed, you should remove any ARVRController or ARVRAnchor 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).


Member Variables
----------------

  .. _class_ARVRServer_world_scale:

- :ref:`float<class_float>` **world_scale** - Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world.


Enums
-----

  .. _enum_ARVRServer_RotationMode:

enum **RotationMode**

- **RESET_FULL_ROTATION** = **0** --- Fully reset the orientation of the HMD. Regardless of what direction the user is looking to in the real world. The user will look dead ahead in the virtual world.
- **RESET_BUT_KEEP_TILT** = **1** --- Resets the orientation but keeps the tilt of the device. So if we're looking down, we keep looking down but heading will be reset.
- **DONT_RESET_ROTATION** = **2** --- Does not reset the orientation of the HMD, only the position of the player gets centered.

  .. _enum_ARVRServer_TrackerType:

enum **TrackerType**

- **TRACKER_CONTROLLER** = **1** --- Our tracker tracks the location of a controller.
- **TRACKER_BASESTATION** = **2** --- Our tracker tracks the location of a base station.
- **TRACKER_ANCHOR** = **4** --- Our tracker tracks the location and size of an AR anchor.
- **TRACKER_ANY_KNOWN** = **127** --- Used internally to filter trackers of any known type.
- **TRACKER_UNKNOWN** = **128** --- Used internally if we haven't set the tracker type yet.
- **TRACKER_ANY** = **255** --- Used internally to select all trackers.


Description
-----------

The AR/VR Server is the heart of our AR/VR solution and handles all the processing.

Member Function Description
---------------------------

.. _class_ARVRServer_center_on_hmd:

- void **center_on_hmd** **(** :ref:`int<class_int>` rotation_mode, :ref:`bool<class_bool>` keep_height **)**

This is a really important function to understand correctly. AR and VR platforms all handle positioning slightly differently.

For platforms that do not offer spatial tracking our origin point (0,0,0) is the location of our HMD but you have little control over the direction the player is facing in the real world.

For platforms that do offer spatial tracking our origin point depends very much on the system. For OpenVR our origin point is usually the center of the tracking space, on the ground. For other platforms its often the location of the tracking camera.

This method allows you to center our tracker on the location of the HMD, it will take the current location of the HMD and use that to adjust all our tracking data in essence realigning the real world to your players current position in your game world.

For this method to produce usable results tracking information should be available and this often takes a few frames after starting your game.

You should call this method after a few seconds have passed, when the user requests a realignment of the display holding a designated button on a controller for a short period of time, and when implementing a teleport mechanism.

.. _class_ARVRServer_find_interface:

- :ref:`ARVRInterface<class_arvrinterface>` **find_interface** **(** :ref:`String<class_string>` name **)** const

Find an interface by its name. Say that you're making a game that uses specific capabilities of an AR/VR platform you can find the interface for that platform by name and initialize it.

.. _class_ARVRServer_get_interface:

- :ref:`ARVRInterface<class_arvrinterface>` **get_interface** **(** :ref:`int<class_int>` idx **)** const

Get the interface registered at a given index in our list of interfaces.

.. _class_ARVRServer_get_interface_count:

- :ref:`int<class_int>` **get_interface_count** **(** **)** const

Get the number of interfaces currently registered with the AR/VR server. If you're game supports multiple AR/VR platforms you can look through the available interface and either present the user with a selection or simply try an initialize each interface and use the first one that returns true.

.. _class_ARVRServer_get_interfaces:

- :ref:`Array<class_array>` **get_interfaces** **(** **)** const

Returns a list of available interfaces with both id and name of the interface.

.. _class_ARVRServer_get_reference_frame:

- :ref:`Transform<class_transform>` **get_reference_frame** **(** **)** const

Gets our reference frame transform, mostly used internally and exposed for GDNative build interfaces.

.. _class_ARVRServer_get_tracker:

- :ref:`ARVRPositionalTracker<class_arvrpositionaltracker>` **get_tracker** **(** :ref:`int<class_int>` idx **)** const

Get the positional tracker at the given ID.

.. _class_ARVRServer_get_tracker_count:

- :ref:`int<class_int>` **get_tracker_count** **(** **)** const

Get the number of trackers currently registered.

.. _class_ARVRServer_set_primary_interface:

- void **set_primary_interface** **(** :ref:`ARVRInterface<class_arvrinterface>` interface **)**

Changes the primary interface to the specified interface. Again mostly exposed for GDNative interfaces.