From 9687f6fca34813ec6e63029244a95caf6b793a45 Mon Sep 17 00:00:00 2001 From: Aaron Franke Date: Mon, 6 Apr 2020 04:34:18 -0400 Subject: Warn when using an AABB or Rect2 with a negative size --- doc/classes/AABB.xml | 1 + doc/classes/Rect2.xml | 1 + doc/classes/Rect2i.xml | 1 + 3 files changed, 3 insertions(+) (limited to 'doc/classes') diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index 170cfea6f9..ac45682feb 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -6,6 +6,7 @@ [AABB] consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. It uses floating-point coordinates. The 2D counterpart to [AABB] is [Rect2]. + Negative values for [member size] are not supported and will not work for most methods. Use [method abs] to get an AABB with a positive size. [b]Note:[/b] Unlike [Rect2], [AABB] does not have a variant that uses integer coordinates. diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index 4dc3859ca5..65d1654c21 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -7,6 +7,7 @@ [Rect2] consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. It uses floating-point coordinates. If you need integer coordinates, use [Rect2i] instead. The 3D counterpart to [Rect2] is [AABB]. + Negative values for [member size] are not supported and will not work for most methods. Use [method abs] to get a Rect2 with a positive size. $DOCS_URL/tutorials/math/index.html diff --git a/doc/classes/Rect2i.xml b/doc/classes/Rect2i.xml index d66b589ec1..5909784135 100644 --- a/doc/classes/Rect2i.xml +++ b/doc/classes/Rect2i.xml @@ -6,6 +6,7 @@ [Rect2i] consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. It uses integer coordinates. If you need floating-point coordinates, use [Rect2] instead. + Negative values for [member size] are not supported and will not work for most methods. Use [method abs] to get a Rect2i with a positive size. $DOCS_URL/tutorials/math/index.html -- cgit v1.2.3