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

Rect2: Clarify docs for has_point excluding bottom and right borders

Browse source 
Improve tests, as well as documentation for `expand`.
This commit is contained in:
Rémi Verschelde 2021-11-11 11:31:30 +01:00
parent 2321e71a18
commit 36c4451a7b
No known key found for this signature in database
GPG key ID: C3336907360768E1
4 changed files with 167 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/classes/AABB.xml
View file

@ -54,7 +54,22 @@
<return type="AABB" />
<argument index="0" name="to_point" type="Vector3" />
<description>
Returns this [AABB] expanded to include a given point.
Returns a copy of this [AABB] expanded to include a given point.
[b]Example:[/b]
[codeblocks]
[gdscript]
# position (-3, 2, 0), size (1, 1, 1)
var box = AABB(Vector3(-3, 2, 0), Vector3(1, 1, 1))
# position (-3, -1, 0), size (3, 4, 2), so we fit both the original AABB and Vector3(0, -1, 2)
var box2 = box.expand(Vector3(0, -1, 2))
[/gdscript]
[csharp]
// position (-3, 2, 0), size (1, 1, 1)
var box = new AABB(new Vector3(-3, 2, 0), new Vector3(1, 1, 1));
// position (-3, -1, 0), size (3, 4, 2), so we fit both the original AABB and Vector3(0, -1, 2)
var box2 = box.Expand(new Vector3(0, -1, 2));
[/csharp]
[/codeblocks]
</description>
</method>
<method name="get_center" qualifiers="const">

20
doc/classes/Rect2.xml
View file

@ -71,7 +71,22 @@
<return type="Rect2" />
<argument index="0" name="to" type="Vector2" />
<description>
Returns this [Rect2] expanded to include a given point.
Returns a copy of this [Rect2] expanded to include a given point.
[b]Example:[/b]
[codeblocks]
[gdscript]
# position (-3, 2), size (1, 1)
var rect = Rect2(Vector2(-3, 2), Vector2(1, 1))
# position (-3, -1), size (3, 4), so we fit both rect and Vector2(0, -1)
var rect2 = rect.expand(Vector2(0, -1))
[/gdscript]
[csharp]
# position (-3, 2), size (1, 1)
var rect = new Rect2(new Vector2(-3, 2), new Vector2(1, 1));
# position (-3, -1), size (3, 4), so we fit both rect and Vector2(0, -1)
var rect2 = rect.Expand(new Vector2(0, -1));
[/csharp]
[/codeblocks]
</description>
</method>
<method name="get_area" qualifiers="const">
@ -121,7 +136,8 @@
<return type="bool" />
<argument index="0" name="point" type="Vector2" />
<description>
Returns [code]true[/code] if the [Rect2] contains a point.
Returns [code]true[/code] if the [Rect2] contains a point. By convention, the right and bottom edges of the [Rect2] are considered exclusive, so points on these edges are [b]not[/b] included.
[b]Note:[/b] This method is not reliable for [Rect2] with a [i]negative size[/i]. Use [method abs] to get a positive sized equivalent rectangle to check for contained points.
</description>
</method>
<method name="intersection" qualifiers="const">

19
doc/classes/Rect2i.xml
View file

@ -69,7 +69,21 @@
<return type="Rect2i" />
<argument index="0" name="to" type="Vector2i" />
<description>
Returns this [Rect2i] expanded to include a given point.
Returns a copy of this [Rect2i] expanded to include a given point.
[codeblocks]
[gdscript]
# position (-3, 2), size (1, 1)
var rect = Rect2i(Vector2i(-3, 2), Vector2i(1, 1))
# position (-3, -1), size (3, 4), so we fit both rect and Vector2i(0, -1)
var rect2 = rect.expand(Vector2i(0, -1))
[/gdscript]
[csharp]
# position (-3, 2), size (1, 1)
var rect = new Rect2i(new Vector2i(-3, 2), new Vector2i(1, 1));
# position (-3, -1), size (3, 4), so we fit both rect and Vector2i(0, -1)
var rect2 = rect.Expand(new Vector2i(0, -1));
[/csharp]
[/codeblocks]
</description>
</method>
<method name="get_area" qualifiers="const">
@ -120,7 +134,8 @@
<return type="bool" />
<argument index="0" name="point" type="Vector2i" />
<description>
Returns [code]true[/code] if the [Rect2i] contains a point.
Returns [code]true[/code] if the [Rect2i] contains a point. By convention, the right and bottom edges of the [Rect2i] are considered exclusive, so points on these edges are [b]not[/b] included.
[b]Note:[/b] This method is not reliable for [Rect2i] with a [i]negative size[/i]. Use [method abs] to get a positive sized equivalent rectangle to check for contained points.
</description>
</method>
<method name="intersection" qualifiers="const">

136
tests/core/math/test_rect2.h
View file

@ -211,26 +211,74 @@ TEST_CASE("[Rect2] Growing") {
}
TEST_CASE("[Rect2] Has point") {
Rect2 rect = Rect2(0, 100, 1280, 720);
CHECK_MESSAGE(
Rect2(0, 100, 1280, 720).has_point(Vector2(500, 600)),
rect.has_point(Vector2(500, 600)),
"has_point() with contained Vector2 should return the expected result.");
CHECK_MESSAGE(
!Rect2(0, 100, 1280, 720).has_point(Vector2(0, 0)),
!rect.has_point(Vector2(0, 0)),
"has_point() with non-contained Vector2 should return the expected result.");
CHECK_MESSAGE(
Rect2(0, 100, 1280, 720).has_point(Vector2(0, 110)),
"has_point() with positive Vector2 on left edge should return the expected result.");
rect.has_point(rect.position),
"has_point() with positive size should include `position`.");
CHECK_MESSAGE(
!Rect2(0, 100, 1280, 720).has_point(Vector2(1280, 110)),
"has_point() with positive Vector2 on right edge should return the expected result.");
rect.has_point(rect.position + Vector2(1, 1)),
"has_point() with positive size should include `position + (1, 1)`.");
CHECK_MESSAGE(
!rect.has_point(rect.position + Vector2(1, -1)),
"has_point() with positive size should not include `position + (1, -1)`.");
CHECK_MESSAGE(
!rect.has_point(rect.position + rect.size),
"has_point() with positive size should not include `position + size`.");
CHECK_MESSAGE(
!rect.has_point(rect.position + rect.size + Vector2(1, 1)),
"has_point() with positive size should not include `position + size + (1, 1)`.");
CHECK_MESSAGE(
rect.has_point(rect.position + rect.size + Vector2(-1, -1)),
"has_point() with positive size should include `position + size + (-1, -1)`.");
CHECK_MESSAGE(
!rect.has_point(rect.position + rect.size + Vector2(-1, 1)),
"has_point() with positive size should not include `position + size + (-1, 1)`.");
CHECK_MESSAGE(
Rect2(-4000, 100, 1280, 720).has_point(Vector2(-4000, 110)),
"has_point() with negative Vector2 on left edge should return the expected result.");
rect.has_point(rect.position + Vector2(0, 10)),
"has_point() with point located on left edge should return true.");
CHECK_MESSAGE(
!Rect2(-4000, 100, 1280, 720).has_point(Vector2(-2720, 110)),
"has_point() with negative Vector2 on right edge should return the expected result.");
!rect.has_point(rect.position + Vector2(rect.size.x, 10)),
"has_point() with point located on right edge should return false.");
CHECK_MESSAGE(
rect.has_point(rect.position + Vector2(10, 0)),
"has_point() with point located on top edge should return true.");
CHECK_MESSAGE(
!rect.has_point(rect.position + Vector2(10, rect.size.y)),
"has_point() with point located on bottom edge should return false.");
/*
// FIXME: Disabled for now until GH-37617 is fixed one way or another.
// More tests should then be written like for the positive size case.
rect = Rect2(0, 100, -1280, -720);
CHECK_MESSAGE(
rect.has_point(rect.position),
"has_point() with negative size should include `position`.");
CHECK_MESSAGE(
!rect.has_point(rect.position + rect.size),
"has_point() with negative size should not include `position + size`.");
*/
rect = Rect2(-4000, -200, 1280, 720);
CHECK_MESSAGE(
rect.has_point(rect.position + Vector2(0, 10)),
"has_point() with negative position and point located on left edge should return true.");
CHECK_MESSAGE(
!rect.has_point(rect.position + Vector2(rect.size.x, 10)),
"has_point() with negative position and point located on right edge should return false.");
CHECK_MESSAGE(
rect.has_point(rect.position + Vector2(10, 0)),
"has_point() with negative position and point located on top edge should return true.");
CHECK_MESSAGE(
!rect.has_point(rect.position + Vector2(10, rect.size.y)),
"has_point() with negative position and point located on bottom edge should return false.");
}
TEST_CASE("[Rect2] Intersection") {
@ -429,26 +477,74 @@ TEST_CASE("[Rect2i] Growing") {
}
TEST_CASE("[Rect2i] Has point") {
Rect2i rect = Rect2i(0, 100, 1280, 720);
CHECK_MESSAGE(
Rect2i(0, 100, 1280, 720).has_point(Vector2i(500, 600)),
rect.has_point(Vector2i(500, 600)),
"has_point() with contained Vector2i should return the expected result.");
CHECK_MESSAGE(
!Rect2i(0, 100, 1280, 720).has_point(Vector2i(0, 0)),
!rect.has_point(Vector2i(0, 0)),
"has_point() with non-contained Vector2i should return the expected result.");
CHECK_MESSAGE(
Rect2i(0, 100, 1280, 720).has_point(Vector2(0, 110)),
"has_point() with positive Vector2 on left edge should return the expected result.");
rect.has_point(rect.position),
"has_point() with positive size should include `position`.");
CHECK_MESSAGE(
!Rect2i(0, 100, 1280, 720).has_point(Vector2(1280, 110)),
"has_point() with positive Vector2 on right edge should return the expected result.");
rect.has_point(rect.position + Vector2i(1, 1)),
"has_point() with positive size should include `position + (1, 1)`.");
CHECK_MESSAGE(
!rect.has_point(rect.position + Vector2i(1, -1)),
"has_point() with positive size should not include `position + (1, -1)`.");
CHECK_MESSAGE(
!rect.has_point(rect.position + rect.size),
"has_point() with positive size should not include `position + size`.");
CHECK_MESSAGE(
!rect.has_point(rect.position + rect.size + Vector2i(1, 1)),
"has_point() with positive size should not include `position + size + (1, 1)`.");
CHECK_MESSAGE(
rect.has_point(rect.position + rect.size + Vector2i(-1, -1)),
"has_point() with positive size should include `position + size + (-1, -1)`.");
CHECK_MESSAGE(
!rect.has_point(rect.position + rect.size + Vector2i(-1, 1)),
"has_point() with positive size should not include `position + size + (-1, 1)`.");
CHECK_MESSAGE(
Rect2i(-4000, 100, 1280, 720).has_point(Vector2(-4000, 110)),
"has_point() with negative Vector2 on left edge should return the expected result.");
rect.has_point(rect.position + Vector2i(0, 10)),
"has_point() with point located on left edge should return true.");
CHECK_MESSAGE(
!Rect2i(-4000, 100, 1280, 720).has_point(Vector2(-2720, 110)),
"has_point() with negative Vector2 on right edge should return the expected result.");
!rect.has_point(rect.position + Vector2i(rect.size.x, 10)),
"has_point() with point located on right edge should return false.");
CHECK_MESSAGE(
rect.has_point(rect.position + Vector2i(10, 0)),
"has_point() with point located on top edge should return true.");
CHECK_MESSAGE(
!rect.has_point(rect.position + Vector2i(10, rect.size.y)),
"has_point() with point located on bottom edge should return false.");
/*
// FIXME: Disabled for now until GH-37617 is fixed one way or another.
// More tests should then be written like for the positive size case.
rect = Rect2i(0, 100, -1280, -720);
CHECK_MESSAGE(
rect.has_point(rect.position),
"has_point() with negative size should include `position`.");
CHECK_MESSAGE(
!rect.has_point(rect.position + rect.size),
"has_point() with negative size should not include `position + size`.");
*/
rect = Rect2i(-4000, -200, 1280, 720);
CHECK_MESSAGE(
rect.has_point(rect.position + Vector2i(0, 10)),
"has_point() with negative position and point located on left edge should return true.");
CHECK_MESSAGE(
!rect.has_point(rect.position + Vector2i(rect.size.x, 10)),
"has_point() with negative position and point located on right edge should return false.");
CHECK_MESSAGE(
rect.has_point(rect.position + Vector2i(10, 0)),
"has_point() with negative position and point located on top edge should return true.");
CHECK_MESSAGE(
!rect.has_point(rect.position + Vector2i(10, rect.size.y)),
"has_point() with negative position and point located on bottom edge should return false.");
}
TEST_CASE("[Rect2i] Intersection") {