:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.1/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.1/doc/classes/Rect2.xml. .. _class_Rect2: Rect2 ===== A 2D axis-aligned bounding box using floating-point coordinates. .. rst-class:: classref-introduction-group Description ----------- **Rect2** consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. It uses floating-point coordinates. If you need integer coordinates, use :ref:`Rect2i` instead. The 3D counterpart to **Rect2** is :ref:`AABB`. Negative values for :ref:`size` are not supported and will not work for most methods. Use :ref:`abs` to get a Rect2 with a positive size. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Math documentation index <../tutorials/math/index>` - :doc:`Vector math <../tutorials/math/vector_math>` - :doc:`Advanced vector math <../tutorials/math/vectors_advanced>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------+------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`end` | ``Vector2(0, 0)`` | +-------------------------------+------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`position` | ``Vector2(0, 0)`` | +-------------------------------+------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`size` | ``Vector2(0, 0)`` | +-------------------------------+------------------------------------------------+-------------------+ .. rst-class:: classref-reftable-group Constructors ------------ .. table:: :widths: auto +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`Rect2` **(** **)** | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Rect2` from **)** | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Rect2i` from **)** | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Vector2` position, :ref:`Vector2` size **)** | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`Rect2` **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`abs` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`encloses` **(** :ref:`Rect2` b **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`expand` **(** :ref:`Vector2` to **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_area` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_center` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`grow` **(** :ref:`float` amount **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`grow_individual` **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`grow_side` **(** :ref:`int` side, :ref:`float` amount **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_area` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`intersection` **(** :ref:`Rect2` b **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`intersects` **(** :ref:`Rect2` b, :ref:`bool` include_borders=false **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Rect2` rect **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`merge` **(** :ref:`Rect2` b **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Operators --------- .. table:: :widths: auto +---------------------------+-----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator !=` **(** :ref:`Rect2` right **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`operator *` **(** :ref:`Transform2D` right **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator ==` **(** :ref:`Rect2` right **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_Rect2_property_end: .. rst-class:: classref-property :ref:`Vector2` **end** = ``Vector2(0, 0)`` Ending corner. This is calculated as ``position + size``. Setting this value will change the size. .. rst-class:: classref-item-separator ---- .. _class_Rect2_property_position: .. rst-class:: classref-property :ref:`Vector2` **position** = ``Vector2(0, 0)`` Beginning corner. Typically has values lower than :ref:`end`. .. rst-class:: classref-item-separator ---- .. _class_Rect2_property_size: .. rst-class:: classref-property :ref:`Vector2` **size** = ``Vector2(0, 0)`` Size from :ref:`position` to :ref:`end`. Typically, all components are positive. If the size is negative, you can use :ref:`abs` to fix it. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constructor Descriptions ------------------------ .. _class_Rect2_constructor_Rect2: .. rst-class:: classref-constructor :ref:`Rect2` **Rect2** **(** **)** Constructs a default-initialized **Rect2** with default (zero) values of :ref:`position` and :ref:`size`. .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Rect2` **Rect2** **(** :ref:`Rect2` from **)** Constructs a **Rect2** as a copy of the given **Rect2**. .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Rect2` **Rect2** **(** :ref:`Rect2i` from **)** Constructs a **Rect2** from a :ref:`Rect2i`. .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Rect2` **Rect2** **(** :ref:`Vector2` position, :ref:`Vector2` size **)** Constructs a **Rect2** by position and size. .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Rect2` **Rect2** **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** Constructs a **Rect2** by x, y, width, and height. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Rect2_method_abs: .. rst-class:: classref-method :ref:`Rect2` **abs** **(** **)** |const| Returns a **Rect2** with equivalent position and area, modified so that the top-left corner is the origin and ``width`` and ``height`` are positive. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_encloses: .. rst-class:: classref-method :ref:`bool` **encloses** **(** :ref:`Rect2` b **)** |const| Returns ``true`` if this **Rect2** completely encloses another one. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_expand: .. rst-class:: classref-method :ref:`Rect2` **expand** **(** :ref:`Vector2` to **)** |const| Returns a copy of this **Rect2** expanded to include a given point. \ **Example:**\ .. tabs:: .. code-tab:: gdscript # position (-3, 2), size (1, 1) var rect = Rect2(Vector2(-3, 2), Vector2(1, 1)) # position (-3, -1), size (3, 4), so we fit both rect and Vector2(0, -1) var rect2 = rect.expand(Vector2(0, -1)) .. code-tab:: csharp // position (-3, 2), size (1, 1) var rect = new Rect2(new Vector2(-3, 2), new Vector2(1, 1)); // position (-3, -1), size (3, 4), so we fit both rect and Vector2(0, -1) var rect2 = rect.Expand(new Vector2(0, -1)); .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_get_area: .. rst-class:: classref-method :ref:`float` **get_area** **(** **)** |const| Returns the area of the **Rect2**. See also :ref:`has_area`. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_get_center: .. rst-class:: classref-method :ref:`Vector2` **get_center** **(** **)** |const| Returns the center of the **Rect2**, which is equal to :ref:`position` + (:ref:`size` / 2). .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_grow: .. rst-class:: classref-method :ref:`Rect2` **grow** **(** :ref:`float` amount **)** |const| Returns a copy of the **Rect2** grown by the specified ``amount`` on all sides. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_grow_individual: .. rst-class:: classref-method :ref:`Rect2` **grow_individual** **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** |const| Returns a copy of the **Rect2** grown by the specified amount on each side individually. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_grow_side: .. rst-class:: classref-method :ref:`Rect2` **grow_side** **(** :ref:`int` side, :ref:`float` amount **)** |const| Returns a copy of the **Rect2** grown by the specified ``amount`` on the specified :ref:`Side`. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_has_area: .. rst-class:: classref-method :ref:`bool` **has_area** **(** **)** |const| Returns ``true`` if the **Rect2** has area, and ``false`` if the **Rect2** is linear, empty, or has a negative :ref:`size`. See also :ref:`get_area`. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_has_point: .. rst-class:: classref-method :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** |const| Returns ``true`` if the **Rect2** contains a point. By convention, the right and bottom edges of the **Rect2** are considered exclusive, so points on these edges are **not** included. \ **Note:** This method is not reliable for **Rect2** with a *negative size*. Use :ref:`abs` to get a positive sized equivalent rectangle to check for contained points. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_intersection: .. rst-class:: classref-method :ref:`Rect2` **intersection** **(** :ref:`Rect2` b **)** |const| Returns the intersection of this **Rect2** and ``b``. If the rectangles do not intersect, an empty **Rect2** is returned. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_intersects: .. rst-class:: classref-method :ref:`bool` **intersects** **(** :ref:`Rect2` b, :ref:`bool` include_borders=false **)** |const| 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. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_is_equal_approx: .. rst-class:: classref-method :ref:`bool` **is_equal_approx** **(** :ref:`Rect2` rect **)** |const| Returns ``true`` if this **Rect2** and ``rect`` are approximately equal, by calling ``is_equal_approx`` on each component. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_is_finite: .. rst-class:: classref-method :ref:`bool` **is_finite** **(** **)** |const| Returns ``true`` if this **Rect2** is finite, by calling :ref:`@GlobalScope.is_finite` on each component. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_merge: .. rst-class:: classref-method :ref:`Rect2` **merge** **(** :ref:`Rect2` b **)** |const| Returns a larger **Rect2** that contains this **Rect2** and ``b``. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Operator Descriptions --------------------- .. _class_Rect2_operator_neq_Rect2: .. rst-class:: classref-operator :ref:`bool` **operator !=** **(** :ref:`Rect2` right **)** Returns ``true`` if the rectangles are not equal. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx` instead, which is more reliable. .. rst-class:: classref-item-separator ---- .. _class_Rect2_operator_mul_Transform2D: .. rst-class:: classref-operator :ref:`Rect2` **operator *** **(** :ref:`Transform2D` right **)** Inversely transforms (multiplies) the **Rect2** by the given :ref:`Transform2D` transformation matrix. .. rst-class:: classref-item-separator ---- .. _class_Rect2_operator_eq_Rect2: .. rst-class:: classref-operator :ref:`bool` **operator ==** **(** :ref:`Rect2` right **)** Returns ``true`` if the rectangles are exactly equal. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx` instead, which is more reliable. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`