.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/XRServer.xml. .. _class_XRServer: XRServer ======== **Inherits:** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`XRInterface` | :ref:`primary_interface` | | +---------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`Transform3D` | :ref:`world_origin` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | +---------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`float` | :ref:`world_scale` | ``1.0`` | +---------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_interface` **(** :ref:`XRInterface` interface **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_tracker` **(** :ref:`XRTracker` tracker **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`center_on_hmd` **(** :ref:`RotationMode` rotation_mode, :ref:`bool` keep_height **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_reference_frame` **(** **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`XRInterface` | :ref:`find_interface` **(** :ref:`String` name **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`get_hmd_transform` **(** **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`XRInterface` | :ref:`get_interface` **(** :ref:`int` idx **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_interface_count` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary[]` | :ref:`get_interfaces` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`get_reference_frame` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`XRTracker` | :ref:`get_tracker` **(** :ref:`StringName` tracker_name **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_trackers` **(** :ref:`int` tracker_types **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_interface` **(** :ref:`XRInterface` interface **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_tracker` **(** :ref:`XRTracker` tracker **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_XRServer_signal_interface_added: .. rst-class:: classref-signal **interface_added** **(** :ref:`StringName` interface_name **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_signal_interface_removed: .. rst-class:: classref-signal **interface_removed** **(** :ref:`StringName` interface_name **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_signal_reference_frame_changed: .. rst-class:: classref-signal **reference_frame_changed** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_signal_tracker_added: .. rst-class:: classref-signal **tracker_added** **(** :ref:`StringName` tracker_name, :ref:`int` type **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_signal_tracker_removed: .. rst-class:: classref-signal **tracker_removed** **(** :ref:`StringName` tracker_name, :ref:`int` type **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_signal_tracker_updated: .. rst-class:: classref-signal **tracker_updated** **(** :ref:`StringName` tracker_name, :ref:`int` type **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_XRServer_TrackerType: .. rst-class:: classref-enumeration enum **TrackerType**: .. _class_XRServer_constant_TRACKER_HEAD: .. rst-class:: classref-enumeration-constant :ref:`TrackerType` **TRACKER_HEAD** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRServer_constant_TRACKER_CONTROLLER: .. rst-class:: classref-enumeration-constant :ref:`TrackerType` **TRACKER_CONTROLLER** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRServer_constant_TRACKER_BASESTATION: .. rst-class:: classref-enumeration-constant :ref:`TrackerType` **TRACKER_BASESTATION** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRServer_constant_TRACKER_ANCHOR: .. rst-class:: classref-enumeration-constant :ref:`TrackerType` **TRACKER_ANCHOR** = ``8`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRServer_constant_TRACKER_HAND: .. rst-class:: classref-enumeration-constant :ref:`TrackerType` **TRACKER_HAND** = ``16`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRServer_constant_TRACKER_BODY: .. rst-class:: classref-enumeration-constant :ref:`TrackerType` **TRACKER_BODY** = ``32`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRServer_constant_TRACKER_FACE: .. rst-class:: classref-enumeration-constant :ref:`TrackerType` **TRACKER_FACE** = ``64`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRServer_constant_TRACKER_ANY_KNOWN: .. rst-class:: classref-enumeration-constant :ref:`TrackerType` **TRACKER_ANY_KNOWN** = ``127`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRServer_constant_TRACKER_UNKNOWN: .. rst-class:: classref-enumeration-constant :ref:`TrackerType` **TRACKER_UNKNOWN** = ``128`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRServer_constant_TRACKER_ANY: .. rst-class:: classref-enumeration-constant :ref:`TrackerType` **TRACKER_ANY** = ``255`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_XRServer_RotationMode: .. rst-class:: classref-enumeration enum **RotationMode**: .. _class_XRServer_constant_RESET_FULL_ROTATION: .. rst-class:: classref-enumeration-constant :ref:`RotationMode` **RESET_FULL_ROTATION** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRServer_constant_RESET_BUT_KEEP_TILT: .. rst-class:: classref-enumeration-constant :ref:`RotationMode` **RESET_BUT_KEEP_TILT** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRServer_constant_DONT_RESET_ROTATION: .. rst-class:: classref-enumeration-constant :ref:`RotationMode` **DONT_RESET_ROTATION** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_XRServer_property_primary_interface: .. rst-class:: classref-property :ref:`XRInterface` **primary_interface** .. rst-class:: classref-property-setget - void **set_primary_interface** **(** :ref:`XRInterface` value **)** - :ref:`XRInterface` **get_primary_interface** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_property_world_origin: .. rst-class:: classref-property :ref:`Transform3D` **world_origin** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` .. rst-class:: classref-property-setget - void **set_world_origin** **(** :ref:`Transform3D` value **)** - :ref:`Transform3D` **get_world_origin** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_property_world_scale: .. rst-class:: classref-property :ref:`float` **world_scale** = ``1.0`` .. rst-class:: classref-property-setget - void **set_world_scale** **(** :ref:`float` value **)** - :ref:`float` **get_world_scale** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_XRServer_method_add_interface: .. rst-class:: classref-method void **add_interface** **(** :ref:`XRInterface` interface **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_method_add_tracker: .. rst-class:: classref-method void **add_tracker** **(** :ref:`XRTracker` tracker **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_method_center_on_hmd: .. rst-class:: classref-method void **center_on_hmd** **(** :ref:`RotationMode` rotation_mode, :ref:`bool` keep_height **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_method_clear_reference_frame: .. rst-class:: classref-method void **clear_reference_frame** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_method_find_interface: .. rst-class:: classref-method :ref:`XRInterface` **find_interface** **(** :ref:`String` name **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_method_get_hmd_transform: .. rst-class:: classref-method :ref:`Transform3D` **get_hmd_transform** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_method_get_interface: .. rst-class:: classref-method :ref:`XRInterface` **get_interface** **(** :ref:`int` idx **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_method_get_interface_count: .. rst-class:: classref-method :ref:`int` **get_interface_count** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_method_get_interfaces: .. rst-class:: classref-method :ref:`Dictionary[]` **get_interfaces** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_method_get_reference_frame: .. rst-class:: classref-method :ref:`Transform3D` **get_reference_frame** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_method_get_tracker: .. rst-class:: classref-method :ref:`XRTracker` **get_tracker** **(** :ref:`StringName` tracker_name **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_method_get_trackers: .. rst-class:: classref-method :ref:`Dictionary` **get_trackers** **(** :ref:`int` tracker_types **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_method_remove_interface: .. rst-class:: classref-method void **remove_interface** **(** :ref:`XRInterface` interface **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRServer_method_remove_tracker: .. rst-class:: classref-method void **remove_tracker** **(** :ref:`XRTracker` tracker **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`