: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 ===== A 2D axis-aligned bounding box using floating-point coordinates. .. rst-class:: classref-introduction-group Description ----------- The **Rect2** built-in :ref:`Variant` type represents an axis-aligned rectangle in a 2D space. It is defined by its :ref:`position` and :ref:`size`, which are :ref:`Vector2`. It is frequently used for fast overlap tests (see :ref:`intersects`). Although **Rect2** itself is axis-aligned, it can be combined with :ref:`Transform2D` to represent a rotated or skewed rectangle. For integer coordinates, use :ref:`Rect2i`. The 3D equivalent to **Rect2** is :ref:`AABB`. \ **Note:** Negative values for :ref:`size` are not supported. With negative size, most **Rect2** methods do not work correctly. Use :ref:`abs` to get an equivalent **Rect2** with a non-negative size. \ **Note:** In a boolean context, a **Rect2** evaluates to ``false`` if both :ref:`position` and :ref:`size` are zero (equal to :ref:`Vector2.ZERO`). Otherwise, it always evaluates to ``true``. .. note:: There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. .. 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`\ (\ from\: :ref:`Rect2`\ ) | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`Rect2`\ (\ from\: :ref:`Rect2i`\ ) | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`Rect2`\ (\ position\: :ref:`Vector2`, size\: :ref:`Vector2`\ ) | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`Rect2`\ (\ x\: :ref:`float`, y\: :ref:`float`, width\: :ref:`float`, height\: :ref:`float`\ ) | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`abs`\ (\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`encloses`\ (\ b\: :ref:`Rect2`\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`expand`\ (\ to\: :ref:`Vector2`\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_area`\ (\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_center`\ (\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_support`\ (\ direction\: :ref:`Vector2`\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`grow`\ (\ amount\: :ref:`float`\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`grow_individual`\ (\ left\: :ref:`float`, top\: :ref:`float`, right\: :ref:`float`, bottom\: :ref:`float`\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`grow_side`\ (\ side\: :ref:`int`, amount\: :ref:`float`\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_area`\ (\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_point`\ (\ point\: :ref:`Vector2`\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`intersection`\ (\ b\: :ref:`Rect2`\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`intersects`\ (\ b\: :ref:`Rect2`, include_borders\: :ref:`bool` = false\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_equal_approx`\ (\ rect\: :ref:`Rect2`\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`merge`\ (\ b\: :ref:`Rect2`\ ) |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Operators --------- .. table:: :widths: auto +---------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Rect2`\ ) | +---------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`operator *`\ (\ right\: :ref:`Transform2D`\ ) | +---------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Rect2`\ ) | +---------------------------+--------------------------------------------------------------------------------------------------------------+ .. 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)`` :ref:`🔗` The ending point. This is usually the bottom-right corner of the rectangle, and is equivalent to ``position + size``. Setting this point affects the :ref:`size`. .. rst-class:: classref-item-separator ---- .. _class_Rect2_property_position: .. rst-class:: classref-property :ref:`Vector2` **position** = ``Vector2(0, 0)`` :ref:`🔗` The origin point. This is usually the top-left corner of the rectangle. .. rst-class:: classref-item-separator ---- .. _class_Rect2_property_size: .. rst-class:: classref-property :ref:`Vector2` **size** = ``Vector2(0, 0)`` :ref:`🔗` The rectangle's width and height, starting from :ref:`position`. Setting this value also affects the :ref:`end` point. \ **Note:** It's recommended setting the width and height to non-negative values, as most methods in Godot assume that the :ref:`position` is the top-left corner, and the :ref:`end` is the bottom-right corner. To get an equivalent rectangle with non-negative size, use :ref:`abs`. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constructor Descriptions ------------------------ .. _class_Rect2_constructor_Rect2: .. rst-class:: classref-constructor :ref:`Rect2` **Rect2**\ (\ ) :ref:`🔗` Constructs a **Rect2** with its :ref:`position` and :ref:`size` set to :ref:`Vector2.ZERO`. .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Rect2` **Rect2**\ (\ from\: :ref:`Rect2`\ ) Constructs a **Rect2** as a copy of the given **Rect2**. .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Rect2` **Rect2**\ (\ from\: :ref:`Rect2i`\ ) Constructs a **Rect2** from a :ref:`Rect2i`. .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Rect2` **Rect2**\ (\ position\: :ref:`Vector2`, size\: :ref:`Vector2`\ ) Constructs a **Rect2** by ``position`` and ``size``. .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Rect2` **Rect2**\ (\ x\: :ref:`float`, y\: :ref:`float`, width\: :ref:`float`, height\: :ref:`float`\ ) Constructs a **Rect2** by setting its :ref:`position` to (``x``, ``y``), and its :ref:`size` to (``width``, ``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| :ref:`🔗` Returns a **Rect2** equivalent to this rectangle, with its width and height modified to be non-negative values, and with its :ref:`position` being the top-left corner of the rectangle. .. tabs:: .. code-tab:: gdscript var rect = Rect2(25, 25, -100, -50) var absolute = rect.abs() # absolute is Rect2(-75, -25, 100, 50) .. code-tab:: csharp var rect = new Rect2(25, 25, -100, -50); var absolute = rect.Abs(); // absolute is Rect2(-75, -25, 100, 50) \ **Note:** It's recommended to use this method when :ref:`size` is negative, as most other methods in Godot assume that the :ref:`position` is the top-left corner, and the :ref:`end` is the bottom-right corner. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_encloses: .. rst-class:: classref-method :ref:`bool` **encloses**\ (\ b\: :ref:`Rect2`\ ) |const| :ref:`🔗` Returns ``true`` if this rectangle *completely* encloses the ``b`` rectangle. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_expand: .. rst-class:: classref-method :ref:`Rect2` **expand**\ (\ to\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns a copy of this rectangle expanded to align the edges with the given ``to`` point, if necessary. .. tabs:: .. code-tab:: gdscript var rect = Rect2(0, 0, 5, 2) rect = rect.expand(Vector2(10, 0)) # rect is Rect2(0, 0, 10, 2) rect = rect.expand(Vector2(-5, 5)) # rect is Rect2(-5, 0, 15, 5) .. code-tab:: csharp var rect = new Rect2(0, 0, 5, 2); rect = rect.Expand(new Vector2(10, 0)); // rect is Rect2(0, 0, 10, 2) rect = rect.Expand(new Vector2(-5, 5)); // rect is Rect2(-5, 0, 15, 5) .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_get_area: .. rst-class:: classref-method :ref:`float` **get_area**\ (\ ) |const| :ref:`🔗` Returns the rectangle's area. This is equivalent to ``size.x * size.y``. See also :ref:`has_area`. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_get_center: .. rst-class:: classref-method :ref:`Vector2` **get_center**\ (\ ) |const| :ref:`🔗` Returns the center point of the rectangle. This is the same as ``position + (size / 2.0)``. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_get_support: .. rst-class:: classref-method :ref:`Vector2` **get_support**\ (\ direction\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns the vertex's position of this rect that's the farthest in the given direction. This point is commonly known as the support point in collision detection algorithms. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_grow: .. rst-class:: classref-method :ref:`Rect2` **grow**\ (\ amount\: :ref:`float`\ ) |const| :ref:`🔗` Returns a copy of this rectangle extended on all sides by the given ``amount``. A negative ``amount`` shrinks the rectangle instead. See also :ref:`grow_individual` and :ref:`grow_side`. .. tabs:: .. code-tab:: gdscript var a = Rect2(4, 4, 8, 8).grow(4) # a is Rect2(0, 0, 16, 16) var b = Rect2(0, 0, 8, 4).grow(2) # b is Rect2(-2, -2, 12, 8) .. code-tab:: csharp var a = new Rect2(4, 4, 8, 8).Grow(4); // a is Rect2(0, 0, 16, 16) var b = new Rect2(0, 0, 8, 4).Grow(2); // b is Rect2(-2, -2, 12, 8) .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_grow_individual: .. rst-class:: classref-method :ref:`Rect2` **grow_individual**\ (\ left\: :ref:`float`, top\: :ref:`float`, right\: :ref:`float`, bottom\: :ref:`float`\ ) |const| :ref:`🔗` Returns a copy of this rectangle with its ``left``, ``top``, ``right``, and ``bottom`` sides extended by the given amounts. Negative values shrink the sides, instead. See also :ref:`grow` and :ref:`grow_side`. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_grow_side: .. rst-class:: classref-method :ref:`Rect2` **grow_side**\ (\ side\: :ref:`int`, amount\: :ref:`float`\ ) |const| :ref:`🔗` Returns a copy of this rectangle with its ``side`` extended by the given ``amount`` (see :ref:`Side` constants). A negative ``amount`` shrinks the rectangle, instead. See also :ref:`grow` and :ref:`grow_individual`. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_has_area: .. rst-class:: classref-method :ref:`bool` **has_area**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this rectangle has positive width and height. See also :ref:`get_area`. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_has_point: .. rst-class:: classref-method :ref:`bool` **has_point**\ (\ point\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns ``true`` if the rectangle contains the given ``point``. By convention, points on the right and bottom edges are **not** included. \ **Note:** This method is not reliable for **Rect2** with a *negative* :ref:`size`. Use :ref:`abs` first to get a valid rectangle. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_intersection: .. rst-class:: classref-method :ref:`Rect2` **intersection**\ (\ b\: :ref:`Rect2`\ ) |const| :ref:`🔗` Returns the intersection between this rectangle and ``b``. If the rectangles do not intersect, returns an empty **Rect2**. .. tabs:: .. code-tab:: gdscript var rect1 = Rect2(0, 0, 5, 10) var rect2 = Rect2(2, 0, 8, 4) var a = rect1.intersection(rect2) # a is Rect2(2, 0, 3, 4) .. code-tab:: csharp var rect1 = new Rect2(0, 0, 5, 10); var rect2 = new Rect2(2, 0, 8, 4); var a = rect1.Intersection(rect2); // a is Rect2(2, 0, 3, 4) \ **Note:** If you only need to know whether two rectangles are overlapping, use :ref:`intersects`, instead. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_intersects: .. rst-class:: classref-method :ref:`bool` **intersects**\ (\ b\: :ref:`Rect2`, include_borders\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns ``true`` if this rectangle overlaps with the ``b`` rectangle. The edges of both rectangles are excluded, unless ``include_borders`` is ``true``. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_is_equal_approx: .. rst-class:: classref-method :ref:`bool` **is_equal_approx**\ (\ rect\: :ref:`Rect2`\ ) |const| :ref:`🔗` Returns ``true`` if this rectangle and ``rect`` are approximately equal, by calling :ref:`Vector2.is_equal_approx` on the :ref:`position` and the :ref:`size`. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_is_finite: .. rst-class:: classref-method :ref:`bool` **is_finite**\ (\ ) |const| :ref:`🔗` Returns ``true`` if this rectangle's values are finite, by calling :ref:`Vector2.is_finite` on the :ref:`position` and the :ref:`size`. .. rst-class:: classref-item-separator ---- .. _class_Rect2_method_merge: .. rst-class:: classref-method :ref:`Rect2` **merge**\ (\ b\: :ref:`Rect2`\ ) |const| :ref:`🔗` Returns a **Rect2** that encloses both this rectangle and ``b`` around the edges. See also :ref:`encloses`. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Operator Descriptions --------------------- .. _class_Rect2_operator_neq_Rect2: .. rst-class:: classref-operator :ref:`bool` **operator !=**\ (\ right\: :ref:`Rect2`\ ) :ref:`🔗` Returns ``true`` if the :ref:`position` or :ref:`size` of both 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 ***\ (\ right\: :ref:`Transform2D`\ ) :ref:`🔗` Inversely transforms (multiplies) the **Rect2** by the given :ref:`Transform2D` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). \ ``rect * transform`` is equivalent to ``transform.inverse() * rect``. See :ref:`Transform2D.inverse`. For transforming by inverse of an affine transformation (e.g. with scaling) ``transform.affine_inverse() * rect`` can be used instead. See :ref:`Transform2D.affine_inverse`. .. rst-class:: classref-item-separator ---- .. _class_Rect2_operator_eq_Rect2: .. rst-class:: classref-operator :ref:`bool` **operator ==**\ (\ right\: :ref:`Rect2`\ ) :ref:`🔗` Returns ``true`` if both :ref:`position` and :ref:`size` of the rectangles are exactly equal, respectively. \ **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.)` .. |void| replace:: :abbr:`void (No return value.)`