mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
191 lines
11 KiB
ReStructuredText
191 lines
11 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the Rect2.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_Rect2:
|
|
|
|
Rect2
|
|
=====
|
|
|
|
**Category:** Built-In Types
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
2D axis-aligned bounding box.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------+------------------------------------------------+-----------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`end<class_Rect2_property_end>` | Vector2( 0, 0 ) |
|
|
+-------------------------------+------------------------------------------------+-----------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`position<class_Rect2_property_position>` | Vector2( 0, 0 ) |
|
|
+-------------------------------+------------------------------------------------+-----------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`size<class_Rect2_property_size>` | Vector2( 0, 0 ) |
|
|
+-------------------------------+------------------------------------------------+-----------------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Rect2<class_Rect2>` | :ref:`Rect2<class_Rect2_method_Rect2>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`Vector2<class_Vector2>` size **)** |
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Rect2<class_Rect2>` | :ref:`Rect2<class_Rect2_method_Rect2>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` width, :ref:`float<class_float>` height **)** |
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Rect2<class_Rect2>` | :ref:`abs<class_Rect2_method_abs>` **(** **)** |
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Rect2<class_Rect2>` | :ref:`clip<class_Rect2_method_clip>` **(** :ref:`Rect2<class_Rect2>` b **)** |
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`encloses<class_Rect2_method_encloses>` **(** :ref:`Rect2<class_Rect2>` b **)** |
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Rect2<class_Rect2>` | :ref:`expand<class_Rect2_method_expand>` **(** :ref:`Vector2<class_Vector2>` to **)** |
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_area<class_Rect2_method_get_area>` **(** **)** |
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Rect2<class_Rect2>` | :ref:`grow<class_Rect2_method_grow>` **(** :ref:`float<class_float>` by **)** |
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Rect2<class_Rect2>` | :ref:`grow_individual<class_Rect2_method_grow_individual>` **(** :ref:`float<class_float>` left, :ref:`float<class_float>` top, :ref:`float<class_float>` right, :ref:`float<class_float>` bottom **)** |
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Rect2<class_Rect2>` | :ref:`grow_margin<class_Rect2_method_grow_margin>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` by **)** |
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`has_no_area<class_Rect2_method_has_no_area>` **(** **)** |
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`has_point<class_Rect2_method_has_point>` **(** :ref:`Vector2<class_Vector2>` point **)** |
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`intersects<class_Rect2_method_intersects>` **(** :ref:`Rect2<class_Rect2>` b **)** |
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Rect2<class_Rect2>` | :ref:`merge<class_Rect2_method_merge>` **(** :ref:`Rect2<class_Rect2>` b **)** |
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
Rect2 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`../tutorials/math/index`
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_Rect2_property_end:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **end**
|
|
|
|
+-----------+-----------------+
|
|
| *Default* | Vector2( 0, 0 ) |
|
|
+-----------+-----------------+
|
|
|
|
Ending corner.
|
|
|
|
.. _class_Rect2_property_position:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **position**
|
|
|
|
+-----------+-----------------+
|
|
| *Default* | Vector2( 0, 0 ) |
|
|
+-----------+-----------------+
|
|
|
|
Position (starting corner).
|
|
|
|
.. _class_Rect2_property_size:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **size**
|
|
|
|
+-----------+-----------------+
|
|
| *Default* | Vector2( 0, 0 ) |
|
|
+-----------+-----------------+
|
|
|
|
Size from position to end.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_Rect2_method_Rect2:
|
|
|
|
- :ref:`Rect2<class_Rect2>` **Rect2** **(** :ref:`Vector2<class_Vector2>` position, :ref:`Vector2<class_Vector2>` size **)**
|
|
|
|
Constructs a ``Rect2`` by position and size.
|
|
|
|
- :ref:`Rect2<class_Rect2>` **Rect2** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` width, :ref:`float<class_float>` height **)**
|
|
|
|
Constructs a ``Rect2`` by x, y, width, and height.
|
|
|
|
.. _class_Rect2_method_abs:
|
|
|
|
- :ref:`Rect2<class_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.
|
|
|
|
.. _class_Rect2_method_clip:
|
|
|
|
- :ref:`Rect2<class_Rect2>` **clip** **(** :ref:`Rect2<class_Rect2>` b **)**
|
|
|
|
Returns the intersection of this ``Rect2`` and b.
|
|
|
|
.. _class_Rect2_method_encloses:
|
|
|
|
- :ref:`bool<class_bool>` **encloses** **(** :ref:`Rect2<class_Rect2>` b **)**
|
|
|
|
Returns ``true`` if this ``Rect2`` completely encloses another one.
|
|
|
|
.. _class_Rect2_method_expand:
|
|
|
|
- :ref:`Rect2<class_Rect2>` **expand** **(** :ref:`Vector2<class_Vector2>` to **)**
|
|
|
|
Returns this ``Rect2`` expanded to include a given point.
|
|
|
|
.. _class_Rect2_method_get_area:
|
|
|
|
- :ref:`float<class_float>` **get_area** **(** **)**
|
|
|
|
Returns the area of the ``Rect2``.
|
|
|
|
.. _class_Rect2_method_grow:
|
|
|
|
- :ref:`Rect2<class_Rect2>` **grow** **(** :ref:`float<class_float>` by **)**
|
|
|
|
Returns a copy of the ``Rect2`` grown a given amount of units towards all the sides.
|
|
|
|
.. _class_Rect2_method_grow_individual:
|
|
|
|
- :ref:`Rect2<class_Rect2>` **grow_individual** **(** :ref:`float<class_float>` left, :ref:`float<class_float>` top, :ref:`float<class_float>` right, :ref:`float<class_float>` bottom **)**
|
|
|
|
Returns a copy of the ``Rect2`` grown a given amount of units towards each direction individually.
|
|
|
|
.. _class_Rect2_method_grow_margin:
|
|
|
|
- :ref:`Rect2<class_Rect2>` **grow_margin** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` by **)**
|
|
|
|
Returns a copy of the ``Rect2`` grown a given amount of units towards the :ref:`Margin<enum_@GlobalScope_Margin>` direction.
|
|
|
|
.. _class_Rect2_method_has_no_area:
|
|
|
|
- :ref:`bool<class_bool>` **has_no_area** **(** **)**
|
|
|
|
Returns ``true`` if the ``Rect2`` is flat or empty.
|
|
|
|
.. _class_Rect2_method_has_point:
|
|
|
|
- :ref:`bool<class_bool>` **has_point** **(** :ref:`Vector2<class_Vector2>` point **)**
|
|
|
|
Returns ``true`` if the ``Rect2`` contains a point.
|
|
|
|
.. _class_Rect2_method_intersects:
|
|
|
|
- :ref:`bool<class_bool>` **intersects** **(** :ref:`Rect2<class_Rect2>` b **)**
|
|
|
|
Returns ``true`` if the ``Rect2`` overlaps with another.
|
|
|
|
.. _class_Rect2_method_merge:
|
|
|
|
- :ref:`Rect2<class_Rect2>` **merge** **(** :ref:`Rect2<class_Rect2>` b **)**
|
|
|
|
Returns a larger Rect2 that contains this Rect2 and ``b``.
|
|
|