2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-07-05 11:32:53 +02:00
<class name= "Rect2" category= "Built-In Types" version= "3.1.2" >
2017-09-12 22:42:36 +02:00
<brief_description >
2D Axis-aligned bounding box.
</brief_description>
<description >
2017-10-22 22:43:35 +02:00
Rect2 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
2019-06-01 11:39:12 +02:00
<link > https://docs.godotengine.org/en/3.1/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 >
2017-10-22 22:43:35 +02:00
Constructs a [code]Rect2[/code] 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 >
2017-10-22 22:43:35 +02:00
Constructs a [code]Rect2[/code] by x, y, width, and height.
2017-09-12 22:42:36 +02:00
</description>
</method>
2017-12-10 00:43:30 +01:00
<method name= "abs" >
<return type= "Rect2" >
</return>
<description >
2018-06-14 00:26:04 +02:00
Returns a [code]Rect2[/code] 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 >
2017-10-22 12:56:11 +02:00
Returns the intersection of this [code]Rect2[/code] 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 >
2017-10-22 22:43:35 +02:00
Returns [code]true[/code] if this [code]Rect2[/code] 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 >
2017-10-22 22:43:35 +02:00
Returns this [code]Rect2[/code] 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 >
2017-10-22 22:43:35 +02:00
Returns the area of the [code]Rect2[/code].
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 >
2017-10-22 22:43:35 +02:00
Returns a copy of the [code]Rect2[/code] 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 >
2017-10-22 22:43:35 +02:00
Returns a copy of the [code]Rect2[/code] 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-01-07 10:02:04 +01:00
Returns a copy of the [code]Rect2[/code] 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 >
2017-10-22 22:43:35 +02:00
Returns [code]true[/code] if the [code]Rect2[/code] 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 >
2017-10-22 22:43:35 +02:00
Returns [code]true[/code] if the [code]Rect2[/code] 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>
<description >
2017-10-22 22:43:35 +02:00
Returns [code]true[/code] if the [code]Rect2[/code] overlaps with another.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "merge" >
<return type= "Rect2" >
</return>
<argument index= "0" name= "b" type= "Rect2" >
</argument>
<description >
2019-03-14 01:08:14 +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 >
2017-09-13 08:49:40 +02:00
<member name= "end" type= "Vector2" setter= "" getter= "" >
2017-09-12 22:42:36 +02:00
Ending corner.
</member>
2017-09-13 08:49:40 +02:00
<member name= "position" type= "Vector2" setter= "" getter= "" >
2017-09-12 22:42:36 +02:00
Position (starting corner).
</member>
2017-09-13 08:49:40 +02:00
<member name= "size" type= "Vector2" setter= "" getter= "" >
2017-09-12 22:42:36 +02:00
Size from position to end.
</member>
</members>
<constants >
</constants>
</class>