diff options
| author | Aaron Franke <arnfranke@yahoo.com> | 2020-04-06 04:34:18 -0400 |
|---|---|---|
| committer | Aaron Franke <arnfranke@yahoo.com> | 2021-11-30 18:27:58 -0600 |
| commit | 9687f6fca34813ec6e63029244a95caf6b793a45 (patch) | |
| tree | 9b14705349e8e150b440d8855194aa25d7d30e6a /doc/classes | |
| parent | e223a9c12905b99bb1fe93a56ae634b34eadd359 (diff) | |
Warn when using an AABB or Rect2 with a negative size
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/AABB.xml | 1 | ||||
| -rw-r--r-- | doc/classes/Rect2.xml | 1 | ||||
| -rw-r--r-- | doc/classes/Rect2i.xml | 1 |
3 files changed, 3 insertions, 0 deletions
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 @@ <description> [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. </description> <tutorials> 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. </description> <tutorials> <link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link> 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 @@ <description> [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. </description> <tutorials> <link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link> |