Rect2

2D axis-aligned bounding box.

Description

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

Tutorials

Properties

Vector2endVector2( 0, 0 )
Vector2positionVector2( 0, 0 )
Vector2sizeVector2( 0, 0 )

Methods

Rect2Rect2 ( Vector2 position, Vector2 size )
Rect2Rect2 ( float x, float y, float width, float height )
Rect2abs ( )
Rect2clip ( Rect2 b )
boolencloses ( Rect2 b )
Rect2expand ( Vector2 to )
floatget_area ( )
Rect2grow ( float by )
Rect2grow_individual ( float left, float top, float right, float bottom )
Rect2grow_margin ( int margin, float by )
boolhas_no_area ( )
boolhas_point ( Vector2 point )
boolintersects ( Rect2 b, bool include_borders=false )
boolis_equal_approx ( Rect2 rect )
Rect2merge ( Rect2 b )

Property Descriptions

DefaultVector2( 0, 0 )

Ending corner.


DefaultVector2( 0, 0 )

Position (starting corner).


DefaultVector2( 0, 0 )

Size from position to end.

Method Descriptions

Constructs a Rect2 by position and size.


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


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


Returns the intersection of this Rect2 and b.


Returns true if this Rect2 completely encloses another one.


Returns this Rect2 expanded to include a given point.


Returns the area of the Rect2.


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


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


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.


Returns true if the Rect2 contains a point.


Returns true if the Rect2 overlaps with b (i.e. they have at least one point in common).

If include_borders is true, they will also be considered overlapping if their borders touch, even without intersection.


Returns true if this Rect2 and rect are approximately equal, by calling is_equal_approx on each component.


Returns a larger Rect2 that contains this Rect2 and b.

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.