From 12f2c1378a5e9eac91efb1ddd451e3255add3244 Mon Sep 17 00:00:00 2001 From: Bojidar Marinov Date: Sun, 29 Nov 2015 15:56:40 +0200 Subject: [PATCH] Edit documentation for AABB and Rect2. Docs for AABB were already present, but had a few mistakes. --- doc/base/classes.xml | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 48e7c304fdf..fd5df945bab 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -1603,7 +1603,7 @@ Axis-Aligned Bounding Box. - AABB provides an 3D Axis-Aligned Bounding Box. It consists of a position and a size, and several utility functions. It is typically used for simple (fast) overlap tests. + AABB provides an 3D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for simple (fast) overlap tests. @@ -1628,7 +1628,7 @@ - Get the area inside the [AABB]. + Get the area of the [AABB]. @@ -1697,7 +1697,7 @@ - Return a copy of the AABB grown a given a mount of units towards all the sides. + Return a copy of the [AABB] grown a given amount of units towards all the sides. @@ -1747,7 +1747,7 @@ - Return true if the AABB is at both sides of a plane. + Return true if the [AABB] is at both sides of a plane. @@ -1766,7 +1766,7 @@ - Combine this [AABB] with another one, a larger one is returned that contains both. + Combine this [AABB] with another, a larger one is returned that contains both. @@ -26734,8 +26734,10 @@ This method controls whether the position between two cached points is interpola + 2D Axis-aligned bounding box. + Rect2 provides an 2D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. @@ -26744,6 +26746,7 @@ This method controls whether the position between two cached points is interpola + Returns the intersection of this [Rect2] and b. @@ -26752,6 +26755,7 @@ This method controls whether the position between two cached points is interpola + Returns true if this [Rect2] completely encloses another one. @@ -26760,12 +26764,14 @@ This method controls whether the position between two cached points is interpola + Return this [Rect2] expanded to include a given point. + Get the area of the [Rect2]. @@ -26774,12 +26780,14 @@ This method controls whether the position between two cached points is interpola + Return a copy of the [Rect2] grown a given amount of units towards all the sides. + Return true if the [Rect2] is flat or empty. @@ -26788,6 +26796,7 @@ This method controls whether the position between two cached points is interpola + Return true if the [Rect2] contains a point. @@ -26796,6 +26805,7 @@ This method controls whether the position between two cached points is interpola + Return true if the [Rect2] overlaps with another. @@ -26804,6 +26814,7 @@ This method controls whether the position between two cached points is interpola + Combine this [Rect2] with another, a larger one is returned that contains both. @@ -26814,6 +26825,7 @@ This method controls whether the position between two cached points is interpola + Construct a [Rect2] by position and size. @@ -26828,6 +26840,7 @@ This method controls whether the position between two cached points is interpola + Construct a [Rect2] by x, y, width and height.