:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Rect2.xml. .. _class_Rect2: Rect2 ===== 2D axis-aligned bounding box using floating point coordinates. 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. Tutorials --------- - :doc:`Math documentation index <../tutorials/math/index>` - :doc:`Vector math <../tutorials/math/vector_math>` - :doc:`Advanced vector math <../tutorials/math/vectors_advanced>` Properties ---------- +-------------------------------+------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`end` | ``Vector2(0, 0)`` | +-------------------------------+------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`position` | ``Vector2(0, 0)`` | +-------------------------------+------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`size` | ``Vector2(0, 0)`` | +-------------------------------+------------------------------------------------+-------------------+ Constructors ------------ +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :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 **)** | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Methods ------- +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :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_no_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:`Rect2` | :ref:`merge` **(** :ref:`Rect2` b **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Operators --------- +---------------------------+-----------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator !=` **(** :ref:`Rect2` right **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`operator *` **(** :ref:`Transform2D` right **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator ==` **(** :ref:`Rect2` right **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- .. _class_Rect2_property_end: - :ref:`Vector2` **end** +-----------+-------------------+ | *Default* | ``Vector2(0, 0)`` | +-----------+-------------------+ Ending corner. This is calculated as ``position + size``. Setting this value will change the size. ---- .. _class_Rect2_property_position: - :ref:`Vector2` **position** +-----------+-------------------+ | *Default* | ``Vector2(0, 0)`` | +-----------+-------------------+ Beginning corner. Typically has values lower than :ref:`end`. ---- .. _class_Rect2_property_size: - :ref:`Vector2` **size** +-----------+-------------------+ | *Default* | ``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. Constructor Descriptions ------------------------ .. _class_Rect2_constructor_Rect2: - :ref:`Rect2` **Rect2** **(** **)** Constructs a default-initialized ``Rect2`` with default (zero) values of :ref:`position` and :ref:`size`. ---- - :ref:`Rect2` **Rect2** **(** :ref:`Rect2` from **)** Constructs a ``Rect2`` as a copy of the given ``Rect2``. ---- - :ref:`Rect2` **Rect2** **(** :ref:`Rect2i` from **)** Constructs a ``Rect2`` from a :ref:`Rect2i`. ---- - :ref:`Rect2` **Rect2** **(** :ref:`Vector2` position, :ref:`Vector2` size **)** Constructs a ``Rect2`` by position and size. ---- - :ref:`Rect2` **Rect2** **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** Constructs a ``Rect2`` by x, y, width, and height. Method Descriptions ------------------- .. _class_Rect2_method_abs: - :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. ---- .. _class_Rect2_method_encloses: - :ref:`bool` **encloses** **(** :ref:`Rect2` b **)** |const| Returns ``true`` if this ``Rect2`` completely encloses another one. ---- .. _class_Rect2_method_expand: - :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)); ---- .. _class_Rect2_method_get_area: - :ref:`float` **get_area** **(** **)** |const| Returns the area of the ``Rect2``. See also :ref:`has_no_area`. ---- .. _class_Rect2_method_get_center: - :ref:`Vector2` **get_center** **(** **)** |const| Returns the center of the ``Rect2``, which is equal to :ref:`position` + (:ref:`size` / 2). ---- .. _class_Rect2_method_grow: - :ref:`Rect2` **grow** **(** :ref:`float` amount **)** |const| Returns a copy of the ``Rect2`` grown by the specified ``amount`` on all sides. ---- .. _class_Rect2_method_grow_individual: - :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. ---- .. _class_Rect2_method_grow_side: - :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`. ---- .. _class_Rect2_method_has_no_area: - :ref:`bool` **has_no_area** **(** **)** |const| Returns ``true`` if the ``Rect2`` is flat or empty, ``false`` otherwise. See also :ref:`get_area`. \ **Note:** If the ``Rect2`` has a negative size and is not flat or empty, :ref:`has_no_area` will return ``true``. ---- .. _class_Rect2_method_has_point: - :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. ---- .. _class_Rect2_method_intersection: - :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. ---- .. _class_Rect2_method_intersects: - :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. ---- .. _class_Rect2_method_is_equal_approx: - :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. ---- .. _class_Rect2_method_merge: - :ref:`Rect2` **merge** **(** :ref:`Rect2` b **)** |const| Returns a larger ``Rect2`` that contains this ``Rect2`` and ``b``. Operator Descriptions --------------------- .. _class_Rect2_operator_neq_bool: - :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. ---- .. _class_Rect2_operator_mul_Rect2: - :ref:`Rect2` **operator *** **(** :ref:`Transform2D` right **)** Inversely transforms (multiplies) the ``Rect2`` by the given :ref:`Transform2D` transformation matrix. ---- .. _class_Rect2_operator_eq_bool: - :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.)`