diff options
author | Bojidar Marinov <bojidar.marinov.bg@gmail.com> | 2015-11-29 15:56:40 +0200 |
---|---|---|
committer | Bojidar Marinov <bojidar.marinov.bg@gmail.com> | 2015-11-29 15:56:40 +0200 |
commit | 12f2c1378a5e9eac91efb1ddd451e3255add3244 (patch) | |
tree | a4e5efe396df35e15e83e898383ff87d43867746 /doc/base | |
parent | c81c671131e3a20b4d97f4b2207c62ca73dfdee2 (diff) |
Edit documentation for AABB and Rect2.
Docs for AABB were already present, but had a few mistakes.
Diffstat (limited to 'doc/base')
-rw-r--r-- | doc/base/classes.xml | 23 |
1 files changed, 18 insertions, 5 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 48e7c304fd..fd5df945ba 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -1603,7 +1603,7 @@ Axis-Aligned Bounding Box. </brief_description> <description> - 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. </description> <methods> <method name="encloses"> @@ -1628,7 +1628,7 @@ <return type="float"> </return> <description> - Get the area inside the [AABB]. + Get the area of the [AABB]. </description> </method> <method name="get_endpoint"> @@ -1697,7 +1697,7 @@ <argument index="0" name="by" type="float"> </argument> <description> - 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. </description> </method> <method name="has_no_area"> @@ -1747,7 +1747,7 @@ <argument index="0" name="plane" type="Plane"> </argument> <description> - Return true if the AABB is at both sides of a plane. + Return true if the [AABB] is at both sides of a plane. </description> </method> <method name="intersects_segment"> @@ -1766,7 +1766,7 @@ <argument index="0" name="with" type="AABB"> </argument> <description> - 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. </description> </method> <method name="AABB"> @@ -26734,8 +26734,10 @@ This method controls whether the position between two cached points is interpola </class> <class name="Rect2" category="Built-In Types"> <brief_description> + 2D Axis-aligned bounding box. </brief_description> <description> + 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. </description> <methods> <method name="clip"> @@ -26744,6 +26746,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="b" type="Rect2"> </argument> <description> + Returns the intersection of this [Rect2] and b. </description> </method> <method name="encloses"> @@ -26752,6 +26755,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="b" type="Rect2"> </argument> <description> + Returns true if this [Rect2] completely encloses another one. </description> </method> <method name="expand"> @@ -26760,12 +26764,14 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="to" type="Vector2"> </argument> <description> + Return this [Rect2] expanded to include a given point. </description> </method> <method name="get_area"> <return type="float"> </return> <description> + Get the area of the [Rect2]. </description> </method> <method name="grow"> @@ -26774,12 +26780,14 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="by" type="float"> </argument> <description> + Return a copy of the [Rect2] grown a given amount of units towards all the sides. </description> </method> <method name="has_no_area"> <return type="bool"> </return> <description> + Return true if the [Rect2] is flat or empty. </description> </method> <method name="has_point"> @@ -26788,6 +26796,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="point" type="Vector2"> </argument> <description> + Return true if the [Rect2] contains a point. </description> </method> <method name="intersects"> @@ -26796,6 +26805,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="b" type="Rect2"> </argument> <description> + Return true if the [Rect2] overlaps with another. </description> </method> <method name="merge"> @@ -26804,6 +26814,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="b" type="Rect2"> </argument> <description> + Combine this [Rect2] with another, a larger one is returned that contains both. </description> </method> <method name="Rect2"> @@ -26814,6 +26825,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="size" type="Vector2"> </argument> <description> + Construct a [Rect2] by position and size. </description> </method> <method name="Rect2"> @@ -26828,6 +26840,7 @@ This method controls whether the position between two cached points is interpola <argument index="3" name="height" type="float"> </argument> <description> + Construct a [Rect2] by x, y, width and height. </description> </method> </methods> |