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.xml38
1 files changed, 13 insertions, 25 deletions
diff --git a/doc/classes/XRPositionalTracker.xml b/doc/classes/XRPositionalTracker.xml
index 36cd6e2ea0..8cc7c872b6 100644
--- a/doc/classes/XRPositionalTracker.xml
+++ b/doc/classes/XRPositionalTracker.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="XRPositionalTracker" inherits="Object" version="4.0">
+<class name="XRPositionalTracker" inherits="RefCounted" version="4.0">
<brief_description>
A tracked object.
</brief_description>
@@ -13,80 +13,68 @@
</tutorials>
<methods>
<method name="get_joy_id" qualifiers="const">
- <return type="int">
- </return>
+ <return type="int" />
<description>
If this is a controller that is being tracked, the controller will also be represented by a joystick entry with this ID.
</description>
</method>
<method name="get_mesh" qualifiers="const">
- <return type="Mesh">
- </return>
+ <return type="Mesh" />
<description>
Returns the mesh related to a controller or anchor point if one is available.
</description>
</method>
<method name="get_orientation" qualifiers="const">
- <return type="Basis">
- </return>
+ <return type="Basis" />
<description>
Returns the controller's orientation matrix.
</description>
</method>
<method name="get_position" qualifiers="const">
- <return type="Vector3">
- </return>
+ <return type="Vector3" />
<description>
Returns the world-space controller position.
</description>
</method>
<method name="get_tracker_hand" qualifiers="const">
- <return type="int" enum="XRPositionalTracker.TrackerHand">
- </return>
+ <return type="int" enum="XRPositionalTracker.TrackerHand" />
<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>
+ <return type="int" />
<description>
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_tracker_name" qualifiers="const">
- <return type="StringName">
- </return>
+ <return type="StringName" />
<description>
Returns the controller or anchor point's name, if applicable.
</description>
</method>
<method name="get_tracker_type" qualifiers="const">
- <return type="int" enum="XRServer.TrackerType">
- </return>
+ <return type="int" enum="XRServer.TrackerType" />
<description>
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">
- <return type="Transform">
- </return>
- <argument index="0" name="adjust_by_reference_frame" type="bool">
- </argument>
+ <return type="Transform3D" />
+ <argument index="0" name="adjust_by_reference_frame" type="bool" />
<description>
Returns the transform combining this device's orientation and position.
</description>
</method>
<method name="is_tracking_orientation" qualifiers="const">
- <return type="bool">
- </return>
+ <return type="bool" />
<description>
Returns [code]true[/code] if this device is tracking orientation.
</description>
</method>
<method name="is_tracking_position" qualifiers="const">
- <return type="bool">
- </return>
+ <return type="bool" />
<description>
Returns [code]true[/code] if this device is tracking position.
</description>