diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2021-12-02 15:45:18 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2021-12-02 15:45:55 +0100 |
| commit | 2017590ef6ebb27a6c3ae0d9d7880a0fa6dd9b3c (patch) | |
| tree | 1948e51aada93f862818a8156d6392d8983a9563 /doc/classes | |
| parent | 837e6bdf1859d2054b31730fb71c636f681300da (diff) | |
AABB: Improve docs and test for `has_point`
Contrarily to the 2D Rect2i counterpart, it doesn't make much sense in 3D
and for floating-point AABBs to exclude points on some of its faces.
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/AABB.xml | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index ac45682feb..bdf8a78dc3 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -158,14 +158,15 @@ <return type="bool" /> <argument index="0" name="point" type="Vector3" /> <description> - Returns [code]true[/code] if the [AABB] contains a point. + Returns [code]true[/code] if the [AABB] contains a point. Points on the faces of the AABB are considered included, though float-point precision errors may impact the accuracy of such checks. + [b]Note:[/b] This method is not reliable for [AABB] with a [i]negative size[/i]. Use [method abs] to get a positive sized equivalent [AABB] to check for contained points. </description> </method> <method name="intersection" qualifiers="const"> <return type="AABB" /> <argument index="0" name="with" type="AABB" /> <description> - Returns the intersection between two [AABB]. An empty AABB (size 0,0,0) is returned on failure. + Returns the intersection between two [AABB]. An empty AABB (size [code](0, 0, 0)[/code]) is returned on failure. </description> </method> <method name="intersects" qualifiers="const"> |