asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[DOCS] ARVR, AStar, AtlasTexture, Basis

Browse source
This commit is contained in:
Will Nations 2017-12-07 00:16:27 -06:00
parent b38378dd6c
commit 5b820bc247
5 changed files with 28 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/classes/ARVRController.xml
View file

@ -31,7 +31,7 @@
<return type="bool">
</return>
<description>
Returns true if the controller bound to this node is currently active and being tracked.
Returns [code]true[/code] if the bound controller is active. ARVR systems attempt to track active controllers.
</description>
</method>
<method name="get_joystick_axis" qualifiers="const">
@ -56,7 +56,7 @@
<argument index="0" name="button" type="int">
</argument>
<description>
Is the given button currently pressed?
Returns [code]true[/code] if the button at index [code]button[/code] is pressed.
</description>
</method>
</methods>
@ -65,6 +65,7 @@
The controller's id. The first controller that the [ARVRServer] detects will have id 1, the second id 2, the third id 3, etc. When a controller is turned off, it's slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off.
</member>
<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]. If changed, updates [member ARVRPositionalTracker.rumble] accordingly.
</member>
</members>
<signals>
@ -72,14 +73,14 @@
<argument index="0" name="button" type="int">
</argument>
<description>
When a button on this controller is pressed, this signal is given.
Emitted when a button on this controller is pressed.
</description>
</signal>
<signal name="button_release">
<argument index="0" name="button" type="int">
</argument>
<description>
When a button on this controller is released, this signal is given.
Emitted when a button on this controller is released.
</description>
</signal>
</signals>

15
doc/classes/ARVRPositionalTracker.xml
View file

@ -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>

1
doc/classes/AStar.xml
View file

@ -223,6 +223,7 @@
<return type="Array">
</return>
<description>
Returns an array of all points.
</description>
</method>
<method name="has_point" qualifiers="const">

1
doc/classes/AtlasTexture.xml
View file

@ -18,6 +18,7 @@
The texture that contains the atlas. Can be any [Texture] subtype.
</member>
<member name="filter_clip" type="bool" setter="set_filter_clip" getter="has_filter_clip">
If [code]true[/code] clips the area outside of the region to avoid bleeding of the surrounding texture pixels.
</member>
<member name="margin" type="Rect2" setter="set_margin" getter="get_margin">
The margin around the region. The [Rect2]'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin.

3
doc/classes/Basis.xml
View file

@ -171,10 +171,13 @@
</methods>
<members>
<member name="x" type="Vector3" setter="" getter="">
The basis matrix's x vector.
</member>
<member name="y" type="Vector3" setter="" getter="">
The basis matrix's y vector.
</member>
<member name="z" type="Vector3" setter="" getter="">
The basis matrix's z vector.
</member>
</members>
<constants>