Rect2

Category: Built-In Types

Brief Description

2D Axis-aligned bounding box.

Properties

Methods

Description

Rect2 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.

Tutorials

• Math

Property Descriptions

• Vector2 end

Ending corner.

• Vector2 position

Position (starting corner).

• Vector2 size

Size from position to end.

Method Descriptions

• Rect2 Rect2 ( Vector2 position, Vector2 size )

Constructs a Rect2 by position and size.

• Rect2 Rect2 ( float x, float y, float width, float height )

Constructs a Rect2 by x, y, width, and height.

• Rect2 abs ( )

Returns a Rect2 with equivalent position and area, modified so that the top-left corner is the origin and width and height are positive.

• Rect2 clip ( Rect2 b )

Returns the intersection of this Rect2 and b.

• bool encloses ( Rect2 b )

Returns true if this Rect2 completely encloses another one.

• Rect2 expand ( Vector2 to )

Returns this Rect2 expanded to include a given point.

• float get_area ( )

Returns the area of the Rect2.

• Rect2 grow ( float by )

Returns a copy of the Rect2 grown a given amount of units towards all the sides.

• Rect2 grow_individual ( float left, float top, float right, float bottom )

Returns a copy of the Rect2 grown a given amount of units towards each direction individually.

• Rect2 grow_margin ( int margin, float by )

Returns a copy of the Rect2 grown a given amount of units towards the Margin direction.

• bool has_no_area ( )

Returns true if the Rect2 is flat or empty.

• bool has_point ( Vector2 point )

Returns true if the Rect2 contains a point.

• bool intersects ( Rect2 b )

Returns true if the Rect2 overlaps with another.

• Rect2 merge ( Rect2 b )

Returns a larger Rect2 that contains this Rect2 and b.