virtualx-engine/doc/classes/Rect2.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Rect2" category="Built-In Types" version="3.1">
	<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>
		<link>http://docs.godotengine.org/en/3.0/tutorials/math/index.html</link>
	</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="abs">
			<return type="Rect2">
			</return>
			<description>
				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.
			</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>