2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 02:03:48 +01:00
<class name= "Rect2" version= "4.0" >
2017-09-12 22:42:36 +02:00
<brief_description >
2020-02-24 17:00:40 +01:00
2D axis-aligned bounding box using floating point coordinates.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2020-02-24 17:00:40 +01:00
[Rect2] consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.
It uses floating point coordinates.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
2018-11-05 08:46:27 +01:00
<link > https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
2017-09-12 22:42:36 +02:00
</tutorials>
<methods >
<method name= "Rect2" >
<return type= "Rect2" >
</return>
2017-09-10 15:37:49 +02:00
<argument index= "0" name= "position" type= "Vector2" >
2017-09-12 22:42:36 +02:00
</argument>
<argument index= "1" name= "size" type= "Vector2" >
</argument>
<description >
2019-03-29 23:37:35 +01:00
Constructs a [Rect2] by position and size.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "Rect2" >
<return type= "Rect2" >
</return>
<argument index= "0" name= "x" type= "float" >
</argument>
<argument index= "1" name= "y" type= "float" >
</argument>
<argument index= "2" name= "width" type= "float" >
</argument>
<argument index= "3" name= "height" type= "float" >
</argument>
<description >
2019-03-29 23:37:35 +01:00
Constructs a [Rect2] by x, y, width, and height.
2017-09-12 22:42:36 +02:00
</description>
</method>
2020-02-24 17:00:40 +01:00
<method name= "Rect2" >
<return type= "Rect2" >
</return>
<argument index= "0" name= "from" type= "Rect2i" >
</argument>
<description >
Constructs a [Rect2] from a [Rect2i].
</description>
</method>
2017-12-10 00:43:30 +01:00
<method name= "abs" >
<return type= "Rect2" >
</return>
<description >
2019-03-29 23:37:35 +01:00
Returns a [Rect2] with equivalent position and area, modified so that the top-left corner is the origin and [code]width[/code] and [code]height[/code] are positive.
2017-12-10 00:43:30 +01:00
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "clip" >
<return type= "Rect2" >
</return>
<argument index= "0" name= "b" type= "Rect2" >
</argument>
<description >
2019-03-29 23:37:35 +01:00
Returns the intersection of this [Rect2] and b.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "encloses" >
<return type= "bool" >
</return>
<argument index= "0" name= "b" type= "Rect2" >
</argument>
<description >
2019-03-29 23:37:35 +01:00
Returns [code]true[/code] if this [Rect2] completely encloses another one.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "expand" >
<return type= "Rect2" >
</return>
<argument index= "0" name= "to" type= "Vector2" >
</argument>
<description >
2019-03-29 23:37:35 +01:00
Returns this [Rect2] expanded to include a given point.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_area" >
<return type= "float" >
</return>
<description >
2019-03-29 23:37:35 +01:00
Returns the area of the [Rect2].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "grow" >
<return type= "Rect2" >
</return>
<argument index= "0" name= "by" type= "float" >
</argument>
<description >
2019-03-29 23:37:35 +01:00
Returns a copy of the [Rect2] grown a given amount of units towards all the sides.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "grow_individual" >
<return type= "Rect2" >
</return>
<argument index= "0" name= "left" type= "float" >
</argument>
<argument index= "1" name= "top" type= "float" >
</argument>
<argument index= "2" name= "right" type= "float" >
</argument>
<argument index= "3" name= " bottom" type= "float" >
</argument>
<description >
2019-03-29 23:37:35 +01:00
Returns a copy of the [Rect2] grown a given amount of units towards each direction individually.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "grow_margin" >
<return type= "Rect2" >
</return>
<argument index= "0" name= "margin" type= "int" >
</argument>
<argument index= "1" name= "by" type= "float" >
</argument>
<description >
2019-03-29 23:37:35 +01:00
Returns a copy of the [Rect2] grown a given amount of units towards the [enum Margin] direction.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "has_no_area" >
<return type= "bool" >
</return>
<description >
2019-03-29 23:37:35 +01:00
Returns [code]true[/code] if the [Rect2] is flat or empty.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "has_point" >
<return type= "bool" >
</return>
<argument index= "0" name= "point" type= "Vector2" >
</argument>
<description >
2019-03-29 23:37:35 +01:00
Returns [code]true[/code] if the [Rect2] contains a point.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "intersects" >
<return type= "bool" >
</return>
<argument index= "0" name= "b" type= "Rect2" >
</argument>
2020-02-08 18:43:08 +01:00
<argument index= "1" name= "include_borders" type= "bool" default= "false" >
</argument>
2017-09-12 22:42:36 +02:00
<description >
2020-02-08 18:43:08 +01:00
Returns [code]true[/code] if the [Rect2] overlaps with [code]b[/code] (i.e. they have at least one point in common).
If [code]include_borders[/code] is [code]true[/code], they will also be considered overlapping if their borders touch, even without intersection.
2017-09-12 22:42:36 +02:00
</description>
</method>
2019-11-08 08:33:48 +01:00
<method name= "is_equal_approx" >
<return type= "bool" >
</return>
<argument index= "0" name= "rect" type= "Rect2" >
</argument>
<description >
2019-11-30 21:08:50 +01:00
Returns [code]true[/code] if this [Rect2] and [code]rect[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
2019-11-08 08:33:48 +01:00
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "merge" >
<return type= "Rect2" >
</return>
<argument index= "0" name= "b" type= "Rect2" >
</argument>
<description >
2019-11-30 21:08:50 +01:00
Returns a larger [Rect2] that contains this [Rect2] and [code]b[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
<members >
2019-06-29 12:38:01 +02:00
<member name= "end" type= "Vector2" setter= "" getter= "" default= "Vector2( 0, 0 )" >
2017-09-12 22:42:36 +02:00
Ending corner.
</member>
2019-06-29 12:38:01 +02:00
<member name= "position" type= "Vector2" setter= "" getter= "" default= "Vector2( 0, 0 )" >
2017-09-12 22:42:36 +02:00
Position (starting corner).
</member>
2019-06-29 12:38:01 +02:00
<member name= "size" type= "Vector2" setter= "" getter= "" default= "Vector2( 0, 0 )" >
2017-09-12 22:42:36 +02:00
Size from position to end.
</member>
</members>
<constants >
</constants>
</class>