b68dd2e189
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
206 lines
8.2 KiB
XML
206 lines
8.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Rect2i" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
2D axis-aligned bounding box using integer coordinates.
|
|
</brief_description>
|
|
<description>
|
|
[Rect2i] consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.
|
|
It uses integer coordinates. If you need floating-point coordinates, use [Rect2] instead.
|
|
Negative values for [member size] are not supported and will not work for most methods. Use [method abs] to get a Rect2i with a positive size.
|
|
</description>
|
|
<tutorials>
|
|
<link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link>
|
|
<link title="Vector math">$DOCS_URL/tutorials/math/vector_math.html</link>
|
|
</tutorials>
|
|
<constructors>
|
|
<constructor name="Rect2i">
|
|
<return type="Rect2i" />
|
|
<description>
|
|
Constructs a default-initialized [Rect2i] with default (zero) values of [member position] and [member size].
|
|
</description>
|
|
</constructor>
|
|
<constructor name="Rect2i">
|
|
<return type="Rect2i" />
|
|
<argument index="0" name="from" type="Rect2i" />
|
|
<description>
|
|
Constructs a [Rect2i] as a copy of the given [Rect2i].
|
|
</description>
|
|
</constructor>
|
|
<constructor name="Rect2i">
|
|
<return type="Rect2i" />
|
|
<argument index="0" name="from" type="Rect2" />
|
|
<description>
|
|
Constructs a new [Rect2i] from [Rect2]. The floating point coordinates will be truncated.
|
|
</description>
|
|
</constructor>
|
|
<constructor name="Rect2i">
|
|
<return type="Rect2i" />
|
|
<argument index="0" name="position" type="Vector2i" />
|
|
<argument index="1" name="size" type="Vector2i" />
|
|
<description>
|
|
Constructs a [Rect2i] by position and size.
|
|
</description>
|
|
</constructor>
|
|
<constructor name="Rect2i">
|
|
<return type="Rect2i" />
|
|
<argument index="0" name="x" type="int" />
|
|
<argument index="1" name="y" type="int" />
|
|
<argument index="2" name="width" type="int" />
|
|
<argument index="3" name="height" type="int" />
|
|
<description>
|
|
Constructs a [Rect2i] by x, y, width, and height.
|
|
</description>
|
|
</constructor>
|
|
</constructors>
|
|
<methods>
|
|
<method name="abs" qualifiers="const">
|
|
<return type="Rect2i" />
|
|
<description>
|
|
Returns a [Rect2i] 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="encloses" qualifiers="const">
|
|
<return type="bool" />
|
|
<argument index="0" name="b" type="Rect2i" />
|
|
<description>
|
|
Returns [code]true[/code] if this [Rect2i] completely encloses another one.
|
|
</description>
|
|
</method>
|
|
<method name="expand" qualifiers="const">
|
|
<return type="Rect2i" />
|
|
<argument index="0" name="to" type="Vector2i" />
|
|
<description>
|
|
Returns a copy of this [Rect2i] expanded so that the borders align with the given point.
|
|
[codeblocks]
|
|
[gdscript]
|
|
# position (-3, 2), size (1, 1)
|
|
var rect = Rect2i(Vector2i(-3, 2), Vector2i(1, 1))
|
|
# position (-3, -1), size (3, 4), so we fit both rect and Vector2i(0, -1)
|
|
var rect2 = rect.expand(Vector2i(0, -1))
|
|
[/gdscript]
|
|
[csharp]
|
|
# position (-3, 2), size (1, 1)
|
|
var rect = new Rect2i(new Vector2i(-3, 2), new Vector2i(1, 1));
|
|
# position (-3, -1), size (3, 4), so we fit both rect and Vector2i(0, -1)
|
|
var rect2 = rect.Expand(new Vector2i(0, -1));
|
|
[/csharp]
|
|
[/codeblocks]
|
|
</description>
|
|
</method>
|
|
<method name="get_area" qualifiers="const">
|
|
<return type="int" />
|
|
<description>
|
|
Returns the area of the [Rect2i]. See also [method has_no_area].
|
|
</description>
|
|
</method>
|
|
<method name="get_center" qualifiers="const">
|
|
<return type="Vector2i" />
|
|
<description>
|
|
Returns the center of the [Rect2i], which is equal to [member position] + ([member size] / 2).
|
|
If [member size] is an odd number, the returned center value will be rounded towards [member position].
|
|
</description>
|
|
</method>
|
|
<method name="grow" qualifiers="const">
|
|
<return type="Rect2i" />
|
|
<argument index="0" name="amount" type="int" />
|
|
<description>
|
|
Returns a copy of the [Rect2i] grown by the specified [code]amount[/code] on all sides.
|
|
</description>
|
|
</method>
|
|
<method name="grow_individual" qualifiers="const">
|
|
<return type="Rect2i" />
|
|
<argument index="0" name="left" type="int" />
|
|
<argument index="1" name="top" type="int" />
|
|
<argument index="2" name="right" type="int" />
|
|
<argument index="3" name="bottom" type="int" />
|
|
<description>
|
|
Returns a copy of the [Rect2i] grown by the specified amount on each side individually.
|
|
</description>
|
|
</method>
|
|
<method name="grow_side" qualifiers="const">
|
|
<return type="Rect2i" />
|
|
<argument index="0" name="side" type="int" />
|
|
<argument index="1" name="amount" type="int" />
|
|
<description>
|
|
Returns a copy of the [Rect2i] grown by the specified [code]amount[/code] on the specified [enum Side].
|
|
</description>
|
|
</method>
|
|
<method name="has_no_area" qualifiers="const">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns [code]true[/code] if the [Rect2i] is flat or empty, [code]false[/code] otherwise. See also [method get_area].
|
|
[b]Note:[/b] If the [Rect2i] has a negative size and is not flat or empty, [method has_no_area] will return [code]true[/code].
|
|
</description>
|
|
</method>
|
|
<method name="has_point" qualifiers="const">
|
|
<return type="bool" />
|
|
<argument index="0" name="point" type="Vector2i" />
|
|
<description>
|
|
Returns [code]true[/code] if the [Rect2i] contains a point. By convention, the right and bottom edges of the [Rect2i] are considered exclusive, so points on these edges are [b]not[/b] included.
|
|
[b]Note:[/b] This method is not reliable for [Rect2i] with a [i]negative size[/i]. Use [method abs] to get a positive sized equivalent rectangle to check for contained points.
|
|
</description>
|
|
</method>
|
|
<method name="intersection" qualifiers="const">
|
|
<return type="Rect2i" />
|
|
<argument index="0" name="b" type="Rect2i" />
|
|
<description>
|
|
Returns the intersection of this [Rect2i] and [code]b[/code].
|
|
If the rectangles do not intersect, an empty [Rect2i] is returned.
|
|
</description>
|
|
</method>
|
|
<method name="intersects" qualifiers="const">
|
|
<return type="bool" />
|
|
<argument index="0" name="b" type="Rect2i" />
|
|
<description>
|
|
Returns [code]true[/code] if the [Rect2i] 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="merge" qualifiers="const">
|
|
<return type="Rect2i" />
|
|
<argument index="0" name="b" type="Rect2i" />
|
|
<description>
|
|
Returns a larger [Rect2i] that contains this [Rect2i] and [code]b[/code].
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="end" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)">
|
|
Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size.
|
|
</member>
|
|
<member name="position" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)">
|
|
Beginning corner. Typically has values lower than [member end].
|
|
</member>
|
|
<member name="size" type="Vector2i" setter="" getter="" default="Vector2i(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>
|
|
<operators>
|
|
<operator name="operator !=">
|
|
<return type="bool" />
|
|
<description>
|
|
</description>
|
|
</operator>
|
|
<operator name="operator !=">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="Rect2i" />
|
|
<description>
|
|
Returns [code]true[/code] if the rectangles are not equal.
|
|
</description>
|
|
</operator>
|
|
<operator name="operator ==">
|
|
<return type="bool" />
|
|
<description>
|
|
</description>
|
|
</operator>
|
|
<operator name="operator ==">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="Rect2i" />
|
|
<description>
|
|
Returns [code]true[/code] if the rectangles are equal.
|
|
</description>
|
|
</operator>
|
|
</operators>
|
|
</class>
|