summaryrefslogtreecommitdiff
path: root/doc/classes/XRPositionalTracker.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/XRPositionalTracker.xml')
-rw-r--r--doc/classes/XRPositionalTracker.xml50
1 files changed, 25 insertions, 25 deletions
diff --git a/doc/classes/XRPositionalTracker.xml b/doc/classes/XRPositionalTracker.xml
index 0b57c9478f..36cd6e2ea0 100644
--- a/doc/classes/XRPositionalTracker.xml
+++ b/doc/classes/XRPositionalTracker.xml
@@ -12,13 +12,6 @@
<link title="VR tutorial index">https://docs.godotengine.org/en/latest/tutorials/vr/index.html</link>
</tutorials>
<methods>
- <method name="get_hand" qualifiers="const">
- <return type="int" enum="XRPositionalTracker.TrackerHand">
- </return>
- <description>
- Returns the hand holding this tracker, if known. See [enum TrackerHand] constants.
- </description>
- </method>
<method name="get_joy_id" qualifiers="const">
<return type="int">
</return>
@@ -33,13 +26,6 @@
Returns the mesh related to a controller or anchor point if one is available.
</description>
</method>
- <method name="get_name" qualifiers="const">
- <return type="StringName">
- </return>
- <description>
- Returns the controller or anchor point's name if available.
- </description>
- </method>
<method name="get_orientation" qualifiers="const">
<return type="Basis">
</return>
@@ -54,6 +40,13 @@
Returns the world-space controller position.
</description>
</method>
+ <method name="get_tracker_hand" qualifiers="const">
+ <return type="int" enum="XRPositionalTracker.TrackerHand">
+ </return>
+ <description>
+ Returns the hand holding this tracker, if known. See [enum TrackerHand] constants.
+ </description>
+ </method>
<method name="get_tracker_id" qualifiers="const">
<return type="int">
</return>
@@ -61,18 +54,18 @@
Returns the internal tracker ID. This uniquely identifies the tracker per tracker type and matches the ID you need to specify for nodes such as the [XRController3D] and [XRAnchor3D] nodes.
</description>
</method>
- <method name="get_tracks_orientation" qualifiers="const">
- <return type="bool">
+ <method name="get_tracker_name" qualifiers="const">
+ <return type="StringName">
</return>
<description>
- Returns [code]true[/code] if this device tracks orientation.
+ Returns the controller or anchor point's name, if applicable.
</description>
</method>
- <method name="get_tracks_position" qualifiers="const">
- <return type="bool">
+ <method name="get_tracker_type" qualifiers="const">
+ <return type="int" enum="XRServer.TrackerType">
</return>
<description>
- Returns [code]true[/code] if this device tracks position.
+ Returns the tracker's type, which will be one of the values from the [enum XRServer.TrackerType] enum.
</description>
</method>
<method name="get_transform" qualifiers="const">
@@ -84,11 +77,18 @@
Returns the transform combining this device's orientation and position.
</description>
</method>
- <method name="get_type" qualifiers="const">
- <return type="int" enum="XRServer.TrackerType">
+ <method name="is_tracking_orientation" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ Returns [code]true[/code] if this device is tracking orientation.
+ </description>
+ </method>
+ <method name="is_tracking_position" qualifiers="const">
+ <return type="bool">
</return>
<description>
- Returns the tracker's type.
+ Returns [code]true[/code] if this device is tracking position.
</description>
</method>
</methods>
@@ -101,10 +101,10 @@
<constant name="TRACKER_HAND_UNKNOWN" value="0" enum="TrackerHand">
The hand this tracker is held in is unknown or not applicable.
</constant>
- <constant name="TRACKER_LEFT_HAND" value="1" enum="TrackerHand">
+ <constant name="TRACKER_HAND_LEFT" value="1" enum="TrackerHand">
This tracker is the left hand controller.
</constant>
- <constant name="TRACKER_RIGHT_HAND" value="2" enum="TrackerHand">
+ <constant name="TRACKER_HAND_RIGHT" value="2" enum="TrackerHand">
This tracker is the right hand controller.
</constant>
</constants>