2020-02-24 17:00:40 +01:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name= "Rect2i" version= "4.0" >
<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.
2020-09-21 14:27:50 +02:00
It uses integer coordinates. If you need floating-point coordinates, use [Rect2] instead.
2020-02-24 17:00:40 +01:00
</description>
<tutorials >
2020-08-05 14:43:40 +02:00
<link title= "Math tutorial index" > https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
2020-10-01 10:34:47 +02:00
<link title= "Vector math" > https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link>
2020-02-24 17:00:40 +01:00
</tutorials>
<methods >
2020-11-10 14:16:20 +01:00
<method name= "Rect2i" qualifiers= "constructor" >
2020-11-09 17:46:03 +01:00
<return type= "Rect2i" >
</return>
<description >
Constructs a default-initialized [Rect2i] with default (zero) values of [member position] and [member size].
</description>
</method>
2020-11-10 14:16:20 +01:00
<method name= "Rect2i" qualifiers= "constructor" >
2020-11-09 17:46:03 +01:00
<return type= "Rect2i" >
</return>
<argument index= "0" name= "from" type= "Rect2i" >
</argument>
<description >
Constructs a [Rect2i] as a copy of the given [Rect2i].
</description>
</method>
2020-11-10 14:16:20 +01:00
<method name= "Rect2i" qualifiers= "constructor" >
2020-11-09 17:46:03 +01:00
<return type= "Rect2i" >
</return>
<argument index= "0" name= "from" type= "Rect2" >
</argument>
<description >
Constructs a new [Rect2i] from [Rect2]. The floating point coordinates will be truncated.
</description>
</method>
2020-11-10 14:16:20 +01:00
<method name= "Rect2i" qualifiers= "constructor" >
2020-02-24 17:00:40 +01:00
<return type= "Rect2i" >
</return>
2020-11-04 15:38:26 +01:00
<argument index= "0" name= "position" type= "Vector2i" >
2020-02-24 17:00:40 +01:00
</argument>
2020-11-04 15:38:26 +01:00
<argument index= "1" name= "size" type= "Vector2i" >
2020-02-24 17:00:40 +01:00
</argument>
<description >
Constructs a [Rect2i] by position and size.
</description>
</method>
2020-11-10 14:16:20 +01:00
<method name= "Rect2i" qualifiers= "constructor" >
2020-02-24 17:00:40 +01:00
<return type= "Rect2i" >
</return>
<argument index= "0" name= "x" type= "int" >
</argument>
<argument index= "1" name= "y" type= "int" >
</argument>
<argument index= "2" name= "width" type= "int" >
</argument>
<argument index= "3" name= "height" type= "int" >
</argument>
<description >
Constructs a [Rect2i] by x, y, width, and height.
</description>
</method>
2020-06-03 14:22:26 +02:00
<method name= "abs" >
<return type= "Rect2i" >
</return>
<description >
Returns a [Rect2i] with equivalent position and area, modified so that the top-left corner is the origin and [code]width[/code] and [code]height[/code] are positive.
</description>
</method>
<method name= "encloses" >
<return type= "bool" >
</return>
<argument index= "0" name= "b" type= "Rect2i" >
</argument>
<description >
Returns [code]true[/code] if this [Rect2i] completely encloses another one.
</description>
</method>
<method name= "expand" >
<return type= "Rect2i" >
</return>
<argument index= "0" name= "to" type= "Vector2i" >
</argument>
<description >
Returns this [Rect2i] expanded to include a given point.
</description>
</method>
<method name= "get_area" >
<return type= "int" >
</return>
<description >
Returns the area of the [Rect2i].
</description>
</method>
<method name= "grow" >
<return type= "Rect2i" >
</return>
2020-12-28 10:11:58 +01:00
<argument index= "0" name= "amount" type= "int" >
2020-06-03 14:22:26 +02:00
</argument>
<description >
2020-12-28 10:11:58 +01:00
Returns a copy of the [Rect2i] grown by the specified [code]amount[/code] on all sides.
2020-06-03 14:22:26 +02:00
</description>
</method>
<method name= "grow_individual" >
<return type= "Rect2i" >
</return>
<argument index= "0" name= "left" type= "int" >
</argument>
<argument index= "1" name= "top" type= "int" >
</argument>
<argument index= "2" name= "right" type= "int" >
</argument>
2020-11-04 15:38:26 +01:00
<argument index= "3" name= "bottom" type= "int" >
2020-06-03 14:22:26 +02:00
</argument>
<description >
2020-12-28 10:11:58 +01:00
Returns a copy of the [Rect2i] grown by the specified amount on each side individually.
2020-06-03 14:22:26 +02:00
</description>
</method>
2020-12-28 10:11:58 +01:00
<method name= "grow_side" >
2020-06-03 14:22:26 +02:00
<return type= "Rect2i" >
</return>
2021-01-04 14:33:44 +01:00
<argument index= "0" name= "side" type= "int" >
2020-06-03 14:22:26 +02:00
</argument>
2020-12-28 10:11:58 +01:00
<argument index= "1" name= "amount" type= "int" >
2020-06-03 14:22:26 +02:00
</argument>
<description >
2020-12-28 10:11:58 +01:00
Returns a copy of the [Rect2i] grown by the specified [code]amount[/code] on the specified [enum Side].
2020-06-03 14:22:26 +02:00
</description>
</method>
<method name= "has_no_area" >
<return type= "bool" >
</return>
<description >
Returns [code]true[/code] if the [Rect2i] is flat or empty.
</description>
</method>
<method name= "has_point" >
<return type= "bool" >
</return>
<argument index= "0" name= "point" type= "Vector2i" >
</argument>
<description >
Returns [code]true[/code] if the [Rect2i] contains a point.
</description>
</method>
2021-01-04 14:33:44 +01:00
<method name= "intersection" >
<return type= "Rect2i" >
</return>
<argument index= "0" name= "b" type= "Rect2i" >
</argument>
<description >
Returns the intersection of this [Rect2i] and [code]b[/code].
If the rectangles do not intersect, an empty [Rect2i] is returned.
</description>
</method>
2020-06-03 14:22:26 +02:00
<method name= "intersects" >
<return type= "bool" >
</return>
<argument index= "0" name= "b" type= "Rect2i" >
</argument>
<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" >
<return type= "Rect2i" >
</return>
<argument index= "0" name= "b" type= "Rect2i" >
</argument>
<description >
Returns a larger [Rect2i] that contains this [Rect2i] and [code]b[/code].
</description>
</method>
2020-11-10 14:16:20 +01:00
<method name= "operator !=" qualifiers= "operator" >
<return type= "bool" >
</return>
<argument index= "0" name= "right" type= "Rect2i" >
</argument>
<description >
</description>
</method>
<method name= "operator ==" qualifiers= "operator" >
<return type= "bool" >
</return>
<argument index= "0" name= "right" type= "Rect2i" >
</argument>
<description >
</description>
</method>
2020-02-24 17:00:40 +01:00
</methods>
2020-06-03 14:22:26 +02:00
<members >
<member name= "end" type= "Vector2i" setter= "" getter= "" default= "Vector2i( 0, 0 )" >
2020-07-21 20:07:00 +02:00
Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size.
2020-06-03 14:22:26 +02:00
</member>
<member name= "position" type= "Vector2i" setter= "" getter= "" default= "Vector2i( 0, 0 )" >
2020-07-21 20:07:00 +02:00
Beginning corner. Typically has values lower than [member end].
2020-06-03 14:22:26 +02:00
</member>
<member name= "size" type= "Vector2i" setter= "" getter= "" default= "Vector2i( 0, 0 )" >
2020-07-21 20:07:00 +02:00
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.
2020-06-03 14:22:26 +02:00
</member>
</members>
2020-02-24 17:00:40 +01:00
<constants >
</constants>
</class>