A 2D axis-aligned bounding box using integer coordinates.
[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 $DOCS_URL/tutorials/math/vector_math.html
Constructs a default-initialized [Rect2i] with default (zero) values of [member position] and [member size].
Constructs a [Rect2i] as a copy of the given [Rect2i].
Constructs a new [Rect2i] from [Rect2]. The floating point coordinates will be truncated.
Constructs a [Rect2i] by position and size.
Constructs a [Rect2i] by x, y, width, and height.
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.
Returns [code]true[/code] if this [Rect2i] completely encloses another one.
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]
Returns the area of the [Rect2i]. See also [method has_area].
Returns the center of the [Rect2i], which is equal to [member position] + ([member size] / 2). If [member size] is an odd number, the returned center value will be rounded towards [member position].
Returns a copy of the [Rect2i] grown by the specified [param amount] on all sides.
Returns a copy of the [Rect2i] grown by the specified amount on each side individually.
Returns a copy of the [Rect2i] grown by the specified [param amount] on the specified [enum Side].
Returns [code]true[/code] if the [Rect2i] has area, and [code]false[/code] if the [Rect2i] is linear, empty, or has a negative [member size]. See also [method get_area].
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.
Returns the intersection of this [Rect2i] and [param b]. If the rectangles do not intersect, an empty [Rect2i] is returned.
Returns [code]true[/code] if the [Rect2i] overlaps with [param b] (i.e. they have at least one point in common).
Returns a larger [Rect2i] that contains this [Rect2i] and [param b].
- Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size.
- Beginning corner. Typically has values lower than [member end].
- 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.
Returns [code]true[/code] if the rectangles are not equal.
Returns [code]true[/code] if the rectangles are equal.