summaryrefslogtreecommitdiff
path: root/doc/classes/Rect2i.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Rect2i.xml')
-rw-r--r--doc/classes/Rect2i.xml102
1 files changed, 62 insertions, 40 deletions
diff --git a/doc/classes/Rect2i.xml b/doc/classes/Rect2i.xml
index 0ba013cade..49fdd8e7e8 100644
--- a/doc/classes/Rect2i.xml
+++ b/doc/classes/Rect2i.xml
@@ -1,46 +1,47 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="Rect2i" version="4.0">
+<class name="Rect2i" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
2D axis-aligned bounding box using integer coordinates.
</brief_description>
<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">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
- <link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link>
+ <link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link>
+ <link title="Vector math">$DOCS_URL/tutorials/math/vector_math.html</link>
</tutorials>
- <methods>
- <method name="Rect2i" qualifiers="constructor">
+ <constructors>
+ <constructor name="Rect2i">
<return type="Rect2i" />
<description>
Constructs a default-initialized [Rect2i] with default (zero) values of [member position] and [member size].
</description>
- </method>
- <method name="Rect2i" qualifiers="constructor">
+ </constructor>
+ <constructor name="Rect2i">
<return type="Rect2i" />
<argument index="0" name="from" type="Rect2i" />
<description>
Constructs a [Rect2i] as a copy of the given [Rect2i].
</description>
- </method>
- <method name="Rect2i" qualifiers="constructor">
+ </constructor>
+ <constructor name="Rect2i">
<return type="Rect2i" />
<argument index="0" name="from" type="Rect2" />
<description>
Constructs a new [Rect2i] from [Rect2]. The floating point coordinates will be truncated.
</description>
- </method>
- <method name="Rect2i" qualifiers="constructor">
+ </constructor>
+ <constructor name="Rect2i">
<return type="Rect2i" />
<argument index="0" name="position" type="Vector2i" />
<argument index="1" name="size" type="Vector2i" />
<description>
Constructs a [Rect2i] by position and size.
</description>
- </method>
- <method name="Rect2i" qualifiers="constructor">
+ </constructor>
+ <constructor name="Rect2i">
<return type="Rect2i" />
<argument index="0" name="x" type="int" />
<argument index="1" name="y" type="int" />
@@ -49,7 +50,9 @@
<description>
Constructs a [Rect2i] by x, y, width, and height.
</description>
- </method>
+ </constructor>
+ </constructors>
+ <methods>
<method name="abs" qualifiers="const">
<return type="Rect2i" />
<description>
@@ -67,13 +70,27 @@
<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 so that the borders align with the 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">
<return type="int" />
<description>
- Returns the area of the [Rect2i].
+ Returns the area of the [Rect2i]. See also [method has_no_area].
</description>
</method>
<method name="get_center" qualifiers="const">
@@ -111,14 +128,16 @@
<method name="has_no_area" qualifiers="const">
<return type="bool" />
<description>
- Returns [code]true[/code] if the [Rect2i] is flat or empty.
+ Returns [code]true[/code] if the [Rect2i] is flat or empty, [code]false[/code] otherwise. See also [method get_area].
+ [b]Note:[/b] If the [Rect2i] has a negative size and is not flat or empty, [method has_no_area] will return [code]true[/code].
</description>
</method>
<method name="has_point" qualifiers="const">
<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">
@@ -134,7 +153,6 @@
<argument index="0" name="b" type="Rect2i" />
<description>
Returns [code]true[/code] if the [Rect2i] overlaps with [code]b[/code] (i.e. they have at least one point in common).
- If [code]include_borders[/code] is [code]true[/code], they will also be considered overlapping if their borders touch, even without intersection.
</description>
</method>
<method name="merge" qualifiers="const">
@@ -144,39 +162,43 @@
Returns a larger [Rect2i] that contains this [Rect2i] and [code]b[/code].
</description>
</method>
- <method name="operator !=" qualifiers="operator">
+ </methods>
+ <members>
+ <member name="end" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)">
+ Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size.
+ </member>
+ <member name="position" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)">
+ Beginning corner. Typically has values lower than [member end].
+ </member>
+ <member name="size" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)">
+ Size from [member position] to [member end]. Typically, all components are positive.
+ If the size is negative, you can use [method abs] to fix it.
+ </member>
+ </members>
+ <operators>
+ <operator name="operator !=">
<return type="bool" />
<description>
</description>
- </method>
- <method name="operator !=" qualifiers="operator">
+ </operator>
+ <operator name="operator !=">
<return type="bool" />
<argument index="0" name="right" type="Rect2i" />
<description>
+ Returns [code]true[/code] if the rectangles are not equal.
</description>
- </method>
- <method name="operator ==" qualifiers="operator">
+ </operator>
+ <operator name="operator ==">
<return type="bool" />
<description>
</description>
- </method>
- <method name="operator ==" qualifiers="operator">
+ </operator>
+ <operator name="operator ==">
<return type="bool" />
<argument index="0" name="right" type="Rect2i" />
<description>
+ Returns [code]true[/code] if the rectangles are equal.
</description>
- </method>
- </methods>
- <members>
- <member name="end" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)">
- Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size.
- </member>
- <member name="position" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)">
- Beginning corner. Typically has values lower than [member end].
- </member>
- <member name="size" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)">
- Size from [member position] to [member end]. Typically, all components are positive.
- If the size is negative, you can use [method abs] to fix it.
- </member>
- </members>
+ </operator>
+ </operators>
</class>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-28 03:52:19 +0000