From 5b820bc247d17de7624bd71bcdb4f93fbc6d4664 Mon Sep 17 00:00:00 2001 From: Will Nations Date: Thu, 7 Dec 2017 00:16:27 -0600 Subject: [PATCH] [DOCS] ARVR, AStar, AtlasTexture, Basis --- doc/classes/ARVRController.xml | 11 ++++++----- doc/classes/ARVRPositionalTracker.xml | 15 ++++++++------- doc/classes/AStar.xml | 19 ++++++++++--------- doc/classes/AtlasTexture.xml | 1 + doc/classes/Basis.xml | 3 +++ 5 files changed, 28 insertions(+), 21 deletions(-) diff --git a/doc/classes/ARVRController.xml b/doc/classes/ARVRController.xml index d813479cf1b..0c404e7c3c9 100644 --- a/doc/classes/ARVRController.xml +++ b/doc/classes/ARVRController.xml @@ -31,7 +31,7 @@ - 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. @@ -56,7 +56,7 @@ - Is the given button currently pressed? + Returns [code]true[/code] if the button at index [code]button[/code] is pressed. @@ -65,21 +65,22 @@ 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. - + 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. + - When a button on this controller is pressed, this signal is given. + Emitted when a button on this controller is pressed. - When a button on this controller is released, this signal is given. + Emitted when a button on this controller is released. diff --git a/doc/classes/ARVRPositionalTracker.xml b/doc/classes/ARVRPositionalTracker.xml index f171e4fc5a7..88740f5dc10 100644 --- a/doc/classes/ARVRPositionalTracker.xml +++ b/doc/classes/ARVRPositionalTracker.xml @@ -31,35 +31,35 @@ - If available this returns the name of the controller or anchor point. + Returns the controller or anchor point's name if available. - Returns the orientation matrix of the controller. + Returns the controller's orientation matrix. - Returns the position of the controller adjusted by world scale. + Returns the world-space controller position. - Returns true if the orientation of this device is being tracked. + Returns [code]true[/code] if this device tracks orientation. - Returns true if the position of this device is being tracked. + Returns [code]true[/code] if this device tracks position. @@ -68,19 +68,20 @@ - Returns the transform combining the orientation and position of this device. + Returns the transform combining this device's orientation and position. - Type of tracker. + Returns the tracker's type. + The degree to which the tracker rumbles. Ranges from [code]0.0[/code] to [code]1.0[/code] with precision [code].01[/code]. diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml index acbd49afb9c..eefdf4d7a76 100644 --- a/doc/classes/AStar.xml +++ b/doc/classes/AStar.xml @@ -47,7 +47,7 @@ Adds a new point at the given position with the given identifier. The algorithm prefers points with lower [code]weight_scale[/code] to form a path. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 1 or larger. [codeblock] var as = AStar.new() - + as.add_point(1, Vector3(1,0,0), 4) # Adds the point (1,0,0) with weight_scale=4 and id=1 [/codeblock] If there already exists a point for the given id, its position and weight scale are updated to the given values. @@ -84,10 +84,10 @@ Creates a segment between the given points. [codeblock] var as = AStar.new() - + as.add_point(1, Vector3(1,1,0)) as.add_point(2, Vector3(0,5,0)) - + as.connect_points(1, 2, false) # If bidirectional=false it's only possible to go from point 1 to point 2 # and not from point 2 to point 1. [/codeblock] @@ -129,12 +129,12 @@ Returns the closest position to [code]to_position[/code] that resides inside a segment between two connected points. [codeblock] var as = AStar.new() - + as.add_point(1, Vector3(0,0,0)) as.add_point(2, Vector3(0,5,0)) - + as.connect_points(1, 2) - + var res = as.get_closest_position_in_segment(Vector3(3,3,0)) # returns (0, 3, 0) [/codeblock] The result is in the segment that goes from [code]y=0[/code] to [code]y=5[/code]. It's the closest position in the segment to the given point. @@ -151,18 +151,18 @@ Returns an array with the ids of the points that form the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. [codeblock] var as = AStar.new() - + as.add_point(1, Vector3(0,0,0)) as.add_point(2, Vector3(0,1,0), 1) # default weight is 1 as.add_point(3, Vector3(1,1,0)) as.add_point(4, Vector3(2,0,0)) - + as.connect_points(1, 2, false) as.connect_points(2, 3, false) as.connect_points(4, 3, false) as.connect_points(1, 4, false) as.connect_points(5, 4, false) - + var res = as.get_id_path(1, 3) # returns [1, 2, 3] [/codeblock] If you change the 2nd point's weight to 3, then the result will be [code][1, 4, 3][/code] instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2. @@ -223,6 +223,7 @@ + Returns an array of all points. diff --git a/doc/classes/AtlasTexture.xml b/doc/classes/AtlasTexture.xml index 33566d9ec12..f1a79bc312a 100644 --- a/doc/classes/AtlasTexture.xml +++ b/doc/classes/AtlasTexture.xml @@ -18,6 +18,7 @@ The texture that contains the atlas. Can be any [Texture] subtype. + If [code]true[/code] clips the area outside of the region to avoid bleeding of the surrounding texture pixels. 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. diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index 5b3b27ec60a..a873bd9a27f 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -171,10 +171,13 @@ + The basis matrix's x vector. + The basis matrix's y vector. + The basis matrix's z vector.