⚙️rect

__call

Constructor

Creates a new rectangle.

Arguments

1. Default rectangle (0, 0 position; 0, 0 size).

None.

2. Single value.

Name	Type	Description
value	float	Mins XY, maxs XY value.

3. Single vector.

Name	Type	Description
value	vec2	Mins vector, maxs vector.

4. Double value.

Name	Type	Description
x	float	Mins/maxs X coordinate.
y	float	Mins/maxs Y coordinate.

5. Double vector.

Name	Type	Description
mins	vec2	Mins vector.
maxs	vec2	Maxs vector.

6. Four values.

Name	Type	Description
x0	float	Mins X coordinate.
y0	float	Mins Y coordinate.
x1	float	Maxs X coordinate.
y1	float	Maxs Y coordinate.

Returns

Type	Description
rect	New rectangle.

Example

local my_rect = draw.rect(50, 50, 150, 150);

---

mins

Field

Type: vec2

Mins (top-left) vector.

---

maxs

Field

Type: vec2

Maxs (bottom-right) vector.

---

width

Method

Either returns rectangle's width, or sets a new width.

Arguments

1. Get width.

None.

2. Set width.

Name	Type	Description
value	float	New width.

Returns

1. Get width.

Type	Description
float	Width.

2. Set width.

Type	Description
rect	New rectangle with changed width.

Example

local half_width = rect:width(rect:width() * 0.5);

---

height

Method

Either returns rectangle's height, or sets a new height.

Arguments

1. Get height.

None.

2. Set height.

Name	Type	Description
value	float	New height.

Returns

1. Get height.

Type	Description
float	Height.

2. Set height.

Type	Description
rect	New rectangle with changed height.

Example

local half_height = rect:height(rect:height() * 0.5);

---

size

Method

Either returns rectangle's size, or sets a new size.

Arguments

1. Get size.

None.

2. Set size.

Name	Type	Description
value	vec2	New size.

Returns

1. Get size.

Type	Description
vec2	Size.

2. Set size.

Type	Description
rect	New rectangle with changed size.

Example

local half_size = rect:size(rect:size() * draw.vec2(0.5, 0.5));

---

explode

Method

Explodes the rectangle by given vector (increase size from center into all directions by coordinates in the vector).

Arguments

Name	Type	Description
value	vec2	Explode size.

Returns

Type	Description
rect	Exploded rectangle.

Example

local exp = rect:explode(draw.vec2(6, 6)); -- will subtract -3,-3 from mins and add 3,3 to maxs

---

half_width

Method

Returns a rectangle with half of the width of this rectangle.

Arguments

None.

Returns

Type	Description
rect	Rectangle with halved width.

Example

local half = rect:half_width();

---

translate

Method

Translates (moves) this rectangle by vector coordinates.

Arguments

Name	Type	Description
value	vec2	Translation amount.

Returns

Type	Description
rect	Translated rectangle.

Example

local rect = draw.rect(50, 50, 150, 150);
local translated = rect:translate(draw.vec2(5, 5)); -- mins/maxs will be 55,55 and 155,155

---

margin_left

Method

Move rectangle from the left by given amount.

Arguments

Name	Type	Description
value	float	Margin amount.

Returns

Type	Description
rect	Moved rectangle.

Example

local new = rect:margin_left(5); -- moves to the right by 5px

---

margin_right

Method

Move rectangle from the right by given amount.

Arguments

Name	Type	Description
value	float	Margin amount.

Returns

Type	Description
rect	Moved rectangle.

Example

local new = rect:margin_right(5); -- moves to the left by 5px

---

margin_top

Method

Move rectangle from the top by given amount.

Arguments

Name	Type	Description
value	float	Margin amount.

Returns

Type	Description
rect	Moved rectangle.

Example

local new = rect:margin_top(5); -- moves to the bottom by 5px

---

margin_bottom

Method

Move rectangle from the bottom by given amount.

Arguments

Name	Type	Description
value	float	Margin amount.

Returns

Type	Description
rect	Moved rectangle.

Example

local new = rect:margin_bottom(5); -- moves to the top by 5px

---

padding_left

Method

Adds the value to the left side of the rectangle.

Arguments

Name	Type	Description
value	float	Padding amount.

Returns

Type	Description
rect	Resized rectangle.

Example

local new = rect:padding_left(5); -- adds 5 to mins x

---

padding_right

Method

Adds the value to the right side of the rectangle.

Arguments

Name	Type	Description
value	float	Padding amount.

Returns

Type	Description
rect	Resized rectangle.

Example

local new = rect:padding_right(5); -- adds 5 to maxs x

---

padding_top

Method

Adds the value to the top side of the rectangle.

Arguments

Name	Type	Description
value	float	Padding amount.

Returns

Type	Description
rect	Resized rectangle.

Example

local new = rect:padding_top(5); -- adds 5 to mins y

---

padding_bottom

Method

Adds the value to the bottom side of the rectangle.

Arguments

Name	Type	Description
value	float	Padding amount.

Returns

Type	Description
rect	Resized rectangle.

Example

local new = rect:padding_bottom(5); -- adds 5 to maxs y

---

shrink

Method

Shrinks (implodes) the rectangle by given amount.

Arguments

Name	Type	Description
value	float	Shrink value.

Returns

Type	Description
rect	Resized rectangle.

Example

local shrinked = rect:shrink(5); -- adds 5,5 to mins and subtracts 5,5 from maxs

---

expand

Method

Expands (explodes) the rectangle by given amount.

Arguments

Name	Type	Description
value	float	Expand value.

Returns

Type	Description
rect	Resized rectangle.

Example

local expanded = rect:expand(5); -- subtracts 5,5 from mins and adds 5,5 to maxs

---

contains

Method

Returns true if this rectangle contains either vector or another rectangle.

Rectangle overload will return true ONLY of entire other rectangle is within the bounds of this one.

Arguments

1. Vector variant.

Name	Type	Description
other	vec2	Vector to check against.

2. Rectangle variant.

Name	Type	Description
other	rect	Rectangle to check against.

Returns

Type	Description
bool	true if other object is in bounds of this rectangle.

Example

if rect:contains(cursor_pos) then
    -- ...
end

---

overlaps

Method

Returns true if the other rectangle overlaps with this rectangle.

Arguments

Name	Type	Description
other	rect	Rectangle to check against.

Returns

Type	Description
bool	true if other rectangle overlaps with this rectangle.

Example

if rect:overlaps(another_rect) then
    -- ...
end

---

intersect

Method

Intersects this rectangle with another rectangle.

Arguments

Name	Type	Description
other	rect	Rectangle to intersect with.

Returns

Type	Description
rect	Intersected rectangle.

Example

local intersected = rect:intersect(another_rect);

---

tl

Method

Returns top-left vector.

Arguments

None.

Returns

Type	Description
vec2	Top-left vector.

Example

local tl = rect:tl();

---

tr

Method

Returns top-right vector.

Arguments

None.

Returns

Type	Description
vec2	Top-right vector.

Example

local tr = rect:tr();

---

br

Method

Returns bottom-right vector.

Arguments

None.

Returns

Type	Description
vec2	Bottom-right vector.

Example

local br = rect:br();

---

bl

Method

Returns bottom-left vector.

Arguments

None.

Returns

Type	Description
vec2	Bottom-left vector.

Example

local bl = rect:bl();

---

center

Method

Returns center point of this rectangle.

Arguments

None.

Returns

Type	Description
vec2	Center point.

Example

local center = rect:center();

---

circle

Method

Treats this rectangle as an ellipsis and returns point on it. Note, that this "ellipsis" will be perfect with no modified curvature (basically if this rectangle is a box - you will get a point on a perfect circle).

Arguments

Name	Type	Description
r	float	Radians value.

Returns

Type	Description
vec2	Point on the ellipsis.

Example

local point = rect:circle(rad(250)); -- returns point on the 250th degree

---

floor

Method

Returns floored rectangle.

Arguments

None.

Returns

Type	Description
rect	Floored rectangle.

Example

local floored = rect:floor();

---

ceil

Method

Returns ceiled rectangle.

Arguments

None.

Returns

Type	Description
rect	Ceiled rectangle.

Example

local ceiled = rect:ceil();

---

round

Method

Returns rounded rectangle.

Arguments

None.

Returns

Type	Description
rect	Rounded rectangle.

Example

local rounded = rect:round();

---

is_zero

Method

Returns true if both mins and maxs are equal to 0.

Arguments

None.

Returns

Type	Description
bool	true if this is a zero rectangle.

Example

if rect:is_zero() then
    -- ...
end