summaryrefslogtreecommitdiff
path: root/doc/classes/XRPositionalTracker.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2021-07-30 16:42:52 +0200
committerGitHub <noreply@github.com>2021-07-30 16:42:52 +0200
commit83ccf39adcefaa32325d607562f8f0889c215046 (patch)
tree61ea8e8a202e2998e745de04516a9a2f34c9be1b /doc/classes/XRPositionalTracker.xml
parenta7363f3dfd32ecff77d4d6937be9f232bfc699c7 (diff)
parent7adf4cc9b5de6701a41e27690a69b9892d5eed85 (diff)
Merge pull request #51067 from akien-mga/doc-return-argument-self-closing-tags
doc: Use self-closing tags for `return` and `argument`
Diffstat (limited to 'doc/classes/XRPositionalTracker.xml')
-rw-r--r--doc/classes/XRPositionalTracker.xml36
1 files changed, 12 insertions, 24 deletions
diff --git a/doc/classes/XRPositionalTracker.xml b/doc/classes/XRPositionalTracker.xml
index cd8cb71cd9..8cc7c872b6 100644
--- a/doc/classes/XRPositionalTracker.xml
+++ b/doc/classes/XRPositionalTracker.xml
@@ -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="Transform3D">
- </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>