Rect2i

Vector2i end = Vector2i(0, 0)

The ending point. This is usually the bottom-right corner of the rectangle, and is equivalent to position + size. Setting this point affects the size.

Vector2i position = Vector2i(0, 0)

The origin point. This is usually the top-left corner of the rectangle.

Vector2i size = Vector2i(0, 0)

The rectangle's width and height, starting from position. Setting this value also affects the end point. Note: It's recommended setting the width and height to non-negative values, as most methods in Redot assume that the position is the top-left corner, and the end is the bottom-right corner. To get an equivalent rectangle with non-negative size, use abs().

Rect2i Rect2i()

Constructs a Rect2i with its position and size set to Vector2i.ZERO.

Rect2i Rect2i(Rect2i from)

Constructs a Rect2i as a copy of the given Rect2i.

Rect2i Rect2i(Rect2 from)

Constructs a Rect2i from a Rect2. The floating-point coordinates are truncated.

Rect2i Rect2i(Vector2i position, Vector2i size)

Constructs a Rect2i by position and size.

Rect2i Rect2i(int x, int y, int width, int height)

Constructs a Rect2i by setting its position to (x, y), and its size to (width, height).

Rect2i abs() const

Returns a Rect2i equivalent to this rectangle, with its width and height modified to be non-negative values, and with its position being the top-left corner of the rectangle.

				var rect = Rect2i(25, 25, -100, -50)
				var absolute = rect.abs() # absolute is Rect2i(-75, -25, 100, 50)
				

				var rect = new Rect2I(25, 25, -100, -50);
				var absolute = rect.Abs(); // absolute is Rect2I(-75, -25, 100, 50)
				

Note: It's recommended to use this method when size is negative, as most other methods in Redot assume that the position is the top-left corner, and the end is the bottom-right corner.

bool encloses(Rect2i b) const

Returns true if this Rect2i completely encloses another one.

Rect2i expand(Vector2i to) const

Returns a copy of this rectangle expanded to align the edges with the given to point, if necessary.

				var rect = Rect2i(0, 0, 5, 2)

				rect = rect.expand(Vector2i(10, 0)) # rect is Rect2i(0, 0, 10, 2)
				rect = rect.expand(Vector2i(-5, 5)) # rect is Rect2i(-5, 0, 15, 5)
				

				var rect = new Rect2I(0, 0, 5, 2);

				rect = rect.Expand(new Vector2I(10, 0)); // rect is Rect2I(0, 0, 10, 2)
				rect = rect.Expand(new Vector2I(-5, 5)); // rect is Rect2I(-5, 0, 15, 5)
				

int get_area() const

Returns the rectangle's area. This is equivalent to size.x * size.y. See also has_area().

Vector2i get_center() const

Returns the center point of the rectangle. This is the same as position + (size / 2). Note: If the size is odd, the result will be rounded towards position.

Rect2i grow(int amount) const

Returns a copy of this rectangle extended on all sides by the given amount. A negative amount shrinks the rectangle instead. See also grow_individual() and grow_side().

				var a = Rect2i(4, 4, 8, 8).grow(4) # a is Rect2i(0, 0, 16, 16)
				var b = Rect2i(0, 0, 8, 4).grow(2) # b is Rect2i(-2, -2, 12, 8)
				

				var a = new Rect2I(4, 4, 8, 8).Grow(4); // a is Rect2I(0, 0, 16, 16)
				var b = new Rect2I(0, 0, 8, 4).Grow(2); // b is Rect2I(-2, -2, 12, 8)
				

Rect2i grow_individual(int left, int top, int right, int bottom) const

Returns a copy of this rectangle with its left, top, right, and bottom sides extended by the given amounts. Negative values shrink the sides, instead. See also grow() and grow_side().

Rect2i grow_side(int side, int amount) const

Returns a copy of this rectangle with its side extended by the given amount (see Side constants). A negative amount shrinks the rectangle, instead. See also grow() and grow_individual().

bool has_area() const

Returns true if this rectangle has positive width and height. See also get_area().

bool has_point(Vector2i point) const

Returns true if the rectangle contains the given point. By convention, points on the right and bottom edges are not included. Note: This method is not reliable for Rect2i with a negative size. Use abs() first to get a valid rectangle.

Rect2i intersection(Rect2i b) const

Returns the intersection between this rectangle and b. If the rectangles do not intersect, returns an empty Rect2i.

				var a = Rect2i(0, 0, 5, 10)
				var b = Rect2i(2, 0, 8, 4)

				var c = a.intersection(b) # c is Rect2i(2, 0, 3, 4)
				

				var a = new Rect2I(0, 0, 5, 10);
				var b = new Rect2I(2, 0, 8, 4);

				var c = rect1.Intersection(rect2); // c is Rect2I(2, 0, 3, 4)
				

Note: If you only need to know whether two rectangles are overlapping, use intersects(), instead.

bool intersects(Rect2i b) const

Returns true if this rectangle overlaps with the b rectangle. The edges of both rectangles are excluded.

Rect2i merge(Rect2i b) const

Returns a Rect2i that encloses both this rectangle and b around the edges. See also encloses().

bool operator !=(Rect2i right)

Returns true if the position or size of both rectangles are not equal.

bool operator ==(Rect2i right)

Returns true if both position and size of the rectangles are equal, respectively.