summaryrefslogtreecommitdiff
path: root/doc/classes/XRServer.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/XRServer.xml')
-rw-r--r--doc/classes/XRServer.xml89
1 files changed, 40 insertions, 49 deletions
diff --git a/doc/classes/XRServer.xml b/doc/classes/XRServer.xml
index 85170804cc..7e96b33edd 100644
--- a/doc/classes/XRServer.xml
+++ b/doc/classes/XRServer.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="XRServer" inherits="Object" version="4.0">
+<class name="XRServer" inherits="Object" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Server for AR and VR features.
</brief_description>
@@ -7,27 +7,27 @@
The AR/VR server is the heart of our Advanced and Virtual Reality solution and handles all the processing.
</description>
<tutorials>
- <link title="VR tutorial index">https://docs.godotengine.org/en/latest/tutorials/vr/index.html</link>
+ <link title="XR documentation index">$DOCS_URL/tutorials/xr/index.html</link>
</tutorials>
<methods>
<method name="add_interface">
<return type="void" />
- <argument index="0" name="interface" type="XRInterface" />
+ <param index="0" name="interface" type="XRInterface" />
<description>
Registers an [XRInterface] object.
</description>
</method>
<method name="add_tracker">
<return type="void" />
- <argument index="0" name="tracker" type="XRPositionalTracker" />
+ <param index="0" name="tracker" type="XRPositionalTracker" />
<description>
Registers a new [XRPositionalTracker] that tracks a spatial location in real space.
</description>
</method>
<method name="center_on_hmd">
<return type="void" />
- <argument index="0" name="rotation_mode" type="int" enum="XRServer.RotationMode" />
- <argument index="1" name="keep_height" type="bool" />
+ <param index="0" name="rotation_mode" type="int" enum="XRServer.RotationMode" />
+ <param index="1" name="keep_height" type="bool" />
<description>
This is an 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.
@@ -39,9 +39,9 @@
</method>
<method name="find_interface" qualifiers="const">
<return type="XRInterface" />
- <argument index="0" name="name" type="String" />
+ <param index="0" name="name" type="String" />
<description>
- Finds an interface by its name. For instance, if your project uses capabilities of an AR/VR platform, you can find the interface for that platform by name and initialize it.
+ Finds an interface by its [param name]. For instance, if your project uses capabilities of an AR/VR platform, you can find the interface for that platform by name and initialize it.
</description>
</method>
<method name="get_hmd_transform">
@@ -52,9 +52,9 @@
</method>
<method name="get_interface" qualifiers="const">
<return type="XRInterface" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
- Returns the interface registered at a given index in our list of interfaces.
+ Returns the interface registered at the given [param idx] index in the list of interfaces.
</description>
</method>
<method name="get_interface_count" qualifiers="const">
@@ -69,55 +69,38 @@
Returns a list of available interfaces the ID and name of each interface.
</description>
</method>
- <method name="get_last_commit_usec">
- <return type="int" />
- <description>
- Returns the absolute timestamp (in μs) of the last [XRServer] commit of the AR/VR eyes to [RenderingServer]. The value comes from an internal call to [method Time.get_ticks_usec].
- </description>
- </method>
- <method name="get_last_frame_usec">
- <return type="int" />
- <description>
- Returns the duration (in μs) of the last frame. This is computed as the difference between [method get_last_commit_usec] and [method get_last_process_usec] when committing.
- </description>
- </method>
- <method name="get_last_process_usec">
- <return type="int" />
- <description>
- Returns the absolute timestamp (in μs) of the last [XRServer] process callback. The value comes from an internal call to [method Time.get_ticks_usec].
- </description>
- </method>
<method name="get_reference_frame" qualifiers="const">
<return type="Transform3D" />
<description>
- 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.
</description>
</method>
<method name="get_tracker" qualifiers="const">
<return type="XRPositionalTracker" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="tracker_name" type="StringName" />
<description>
- Returns the positional tracker at the given ID.
+ Returns the positional tracker with the given [param tracker_name].
</description>
</method>
- <method name="get_tracker_count" qualifiers="const">
- <return type="int" />
+ <method name="get_trackers">
+ <return type="Dictionary" />
+ <param index="0" name="tracker_types" type="int" />
<description>
- Returns the number of trackers currently registered.
+ Returns a dictionary of trackers for [param tracker_types].
</description>
</method>
<method name="remove_interface">
<return type="void" />
- <argument index="0" name="interface" type="XRInterface" />
+ <param index="0" name="interface" type="XRInterface" />
<description>
- Removes this interface.
+ Removes this [param interface].
</description>
</method>
<method name="remove_tracker">
<return type="void" />
- <argument index="0" name="tracker" type="XRPositionalTracker" />
+ <param index="0" name="tracker" type="XRPositionalTracker" />
<description>
- Removes this positional tracker.
+ Removes this positional [param tracker].
</description>
</method>
</methods>
@@ -131,42 +114,50 @@
</members>
<signals>
<signal name="interface_added">
- <argument index="0" name="interface_name" type="StringName" />
+ <param index="0" name="interface_name" type="StringName" />
<description>
Emitted when a new interface has been added.
</description>
</signal>
<signal name="interface_removed">
- <argument index="0" name="interface_name" type="StringName" />
+ <param index="0" name="interface_name" type="StringName" />
<description>
Emitted when an interface is removed.
</description>
</signal>
<signal name="tracker_added">
- <argument index="0" name="tracker_name" type="StringName" />
- <argument index="1" name="type" type="int" />
- <argument index="2" name="id" type="int" />
+ <param index="0" name="tracker_name" type="StringName" />
+ <param index="1" name="type" type="int" />
<description>
Emitted when a new tracker has been added. If you don't use a fixed number of controllers or if you're using [XRAnchor3D]s for an AR solution, it is important to react to this signal to add the appropriate [XRController3D] or [XRAnchor3D] nodes related to this new tracker.
</description>
</signal>
<signal name="tracker_removed">
- <argument index="0" name="tracker_name" type="StringName" />
- <argument index="1" name="type" type="int" />
- <argument index="2" name="id" type="int" />
+ <param index="0" name="tracker_name" type="StringName" />
+ <param index="1" name="type" type="int" />
<description>
Emitted when a tracker is removed. You should remove any [XRController3D] or [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).
</description>
</signal>
+ <signal name="tracker_updated">
+ <param index="0" name="tracker_name" type="StringName" />
+ <param index="1" name="type" type="int" />
+ <description>
+ Emitted when an existing tracker has been updated. This can happen if the user switches controllers.
+ </description>
+ </signal>
</signals>
<constants>
- <constant name="TRACKER_CONTROLLER" value="1" enum="TrackerType">
+ <constant name="TRACKER_HEAD" value="1" enum="TrackerType">
+ 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.
+ </constant>
+ <constant name="TRACKER_CONTROLLER" value="2" enum="TrackerType">
The tracker tracks the location of a controller.
</constant>
- <constant name="TRACKER_BASESTATION" value="2" enum="TrackerType">
+ <constant name="TRACKER_BASESTATION" value="4" enum="TrackerType">
The tracker tracks the location of a base station.
</constant>
- <constant name="TRACKER_ANCHOR" value="4" enum="TrackerType">
+ <constant name="TRACKER_ANCHOR" value="8" enum="TrackerType">
The tracker tracks the location and size of an AR anchor.
</constant>
<constant name="TRACKER_ANY_KNOWN" value="127" enum="TrackerType">
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-06 19:42:52 +0000