summaryrefslogtreecommitdiff
path: root/doc/classes/ARVRPositionalTracker.xml
diff options
context:
space:
mode:
authorWill Nations <willnationsdev@gmail.com>2017-12-07 00:16:27 -0600
committerWill Nations <willnationsdev@gmail.com>2017-12-07 00:16:27 -0600
commit5b820bc247d17de7624bd71bcdb4f93fbc6d4664 (patch)
treee9c1bdeaf4bd09a2a4ed48836c1d43a29f0b5500 /doc/classes/ARVRPositionalTracker.xml
parentb38378dd6c963d71d0c1ad40c53b29588e581757 (diff)
[DOCS] ARVR, AStar, AtlasTexture, Basis
Diffstat (limited to 'doc/classes/ARVRPositionalTracker.xml')
-rw-r--r--doc/classes/ARVRPositionalTracker.xml15
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/classes/ARVRPositionalTracker.xml b/doc/classes/ARVRPositionalTracker.xml
index f171e4fc5a..88740f5dc1 100644
--- a/doc/classes/ARVRPositionalTracker.xml
+++ b/doc/classes/ARVRPositionalTracker.xml
@@ -31,35 +31,35 @@
<return type="String">
</return>
<description>
- If available this returns the name of the controller or anchor point.
+ Returns the controller or anchor point's name if available.
</description>
</method>
<method name="get_orientation" qualifiers="const">
<return type="Basis">
</return>
<description>
- Returns the orientation matrix of the controller.
+ Returns the controller's orientation matrix.
</description>
</method>
<method name="get_position" qualifiers="const">
<return type="Vector3">
</return>
<description>
- Returns the position of the controller adjusted by world scale.
+ Returns the world-space controller position.
</description>
</method>
<method name="get_tracks_orientation" qualifiers="const">
<return type="bool">
</return>
<description>
- Returns true if the orientation of this device is being tracked.
+ Returns [code]true[/code] if this device tracks orientation.
</description>
</method>
<method name="get_tracks_position" qualifiers="const">
<return type="bool">
</return>
<description>
- Returns true if the position of this device is being tracked.
+ Returns [code]true[/code] if this device tracks position.
</description>
</method>
<method name="get_transform" qualifiers="const">
@@ -68,19 +68,20 @@
<argument index="0" name="adjust_by_reference_frame" type="bool">
</argument>
<description>
- Returns the transform combining the orientation and position of this device.
+ Returns the transform combining this device's orientation and position.
</description>
</method>
<method name="get_type" qualifiers="const">
<return type="int" enum="ARVRServer.TrackerType">
</return>
<description>
- Type of tracker.
+ Returns the tracker's type.
</description>
</method>
</methods>
<members>
<member name="rumble" type="float" setter="set_rumble" getter="get_rumble">
+ The degree to which the tracker rumbles. Ranges from [code]0.0[/code] to [code]1.0[/code] with precision [code].01[/code].
</member>
</members>
<constants>