1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Rect2" version="4.0">
<brief_description>
2D axis-aligned bounding box using floating point coordinates.
</brief_description>
<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 [Rect2i] instead.
The 3D counterpart to [Rect2] is [AABB].
</description>
<tutorials>
<link title="Math tutorial index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
<link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link>
<link title="Advanced vector math">https://docs.godotengine.org/en/latest/tutorials/math/vectors_advanced.html</link>
</tutorials>
<methods>
<method name="Rect2">
<return type="Rect2">
</return>
<argument index="0" name="position" type="Vector2">
</argument>
<argument index="1" name="size" type="Vector2">
</argument>
<description>
Constructs a [Rect2] by position and size.
</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>
Constructs a [Rect2] by x, y, width, and height.
</description>
</method>
<method name="Rect2">
<return type="Rect2">
</return>
<argument index="0" name="from" type="Rect2i">
</argument>
<description>
Constructs a [Rect2] from a [Rect2i].
</description>
</method>
<method name="abs">
<return type="Rect2">
</return>
<description>
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.
</description>
</method>
<method name="clip">
<return type="Rect2">
</return>
<argument index="0" name="b" type="Rect2">
</argument>
<description>
Returns the intersection of this [Rect2] and b.
</description>
</method>
<method name="encloses">
<return type="bool">
</return>
<argument index="0" name="b" type="Rect2">
</argument>
<description>
Returns [code]true[/code] if this [Rect2] completely encloses another one.
</description>
</method>
<method name="expand">
<return type="Rect2">
</return>
<argument index="0" name="to" type="Vector2">
</argument>
<description>
Returns this [Rect2] expanded to include a given point.
</description>
</method>
<method name="get_area">
<return type="float">
</return>
<description>
Returns the area of the [Rect2].
</description>
</method>
<method name="grow">
<return type="Rect2">
</return>
<argument index="0" name="by" type="float">
</argument>
<description>
Returns a copy of the [Rect2] grown a given amount of units towards all the sides.
</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>
Returns a copy of the [Rect2] grown a given amount of units towards each direction individually.
</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>
Returns a copy of the [Rect2] grown a given amount of units towards the [enum Margin] direction.
</description>
</method>
<method name="has_no_area">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the [Rect2] is flat or empty.
</description>
</method>
<method name="has_point">
<return type="bool">
</return>
<argument index="0" name="point" type="Vector2">
</argument>
<description>
Returns [code]true[/code] if the [Rect2] contains a point.
</description>
</method>
<method name="intersects">
<return type="bool">
</return>
<argument index="0" name="b" type="Rect2">
</argument>
<argument index="1" name="include_borders" type="bool" default="false">
</argument>
<description>
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.
</description>
</method>
<method name="is_equal_approx">
<return type="bool">
</return>
<argument index="0" name="rect" type="Rect2">
</argument>
<description>
Returns [code]true[/code] if this [Rect2] and [code]rect[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
</description>
</method>
<method name="merge">
<return type="Rect2">
</return>
<argument index="0" name="b" type="Rect2">
</argument>
<description>
Returns a larger [Rect2] that contains this [Rect2] and [code]b[/code].
</description>
</method>
</methods>
<members>
<member name="end" type="Vector2" setter="" getter="" default="Vector2( 0, 0 )">
Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size.
</member>
<member name="position" type="Vector2" setter="" getter="" default="Vector2( 0, 0 )">
Beginning corner. Typically has values lower than [member end].
</member>
<member name="size" type="Vector2" setter="" getter="" default="Vector2( 0, 0 )">
Size from [member position] to [member end]. Typically all components are positive.
If the size is negative, you can use [method abs] to fix it.
</member>
</members>
<constants>
</constants>
</class>
|