summaryrefslogtreecommitdiff
path: root/doc/classes/Rect2.xml
blob: 1bd2e812e6f6d37886c29e93eaebe7a5fddd820f (plain)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Rect2" category="Built-In Types" version="3.0-beta">
	<brief_description>
		2D Axis-aligned bounding box.
	</brief_description>
	<description>
		Rect2 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<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 [code]Rect2[/code] 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 [code]Rect2[/code] by x, y, width, and height.
			</description>
		</method>
		<method name="clip">
			<return type="Rect2">
			</return>
			<argument index="0" name="b" type="Rect2">
			</argument>
			<description>
				Returns the intersection of this [code]Rect2[/code] 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 [code]Rect2[/code] completely encloses another one.
			</description>
		</method>
		<method name="expand">
			<return type="Rect2">
			</return>
			<argument index="0" name="to" type="Vector2">
			</argument>
			<description>
				Returns this [code]Rect2[/code] expanded to include a given point.
			</description>
		</method>
		<method name="get_area">
			<return type="float">
			</return>
			<description>
				Returns the area of the [code]Rect2[/code].
			</description>
		</method>
		<method name="grow">
			<return type="Rect2">
			</return>
			<argument index="0" name="by" type="float">
			</argument>
			<description>
				Returns a copy of the [code]Rect2[/code] 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 [code]Rect2[/code] 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 [code]Rect2[/code] grown a given amount of units towards the [Margin] direction.
			</description>
		</method>
		<method name="has_no_area">
			<return type="bool">
			</return>
			<description>
				Returns [code]true[/code] if the [code]Rect2[/code] 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 [code]Rect2[/code] contains a point.
			</description>
		</method>
		<method name="intersects">
			<return type="bool">
			</return>
			<argument index="0" name="b" type="Rect2">
			</argument>
			<description>
				Returns [code]true[/code] if the [code]Rect2[/code] overlaps with another.
			</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]with[/code].
			</description>
		</method>
	</methods>
	<members>
		<member name="end" type="Vector2" setter="" getter="">
			Ending corner.
		</member>
		<member name="position" type="Vector2" setter="" getter="">
			Position (starting corner).
		</member>
		<member name="size" type="Vector2" setter="" getter="">
			Size from position to end.
		</member>
	</members>
	<constants>
	</constants>
</class>