diff options
Diffstat (limited to 'doc/classes/Rect2i.xml')
| -rw-r--r-- | doc/classes/Rect2i.xml | 183 |
1 files changed, 87 insertions, 96 deletions
diff --git a/doc/classes/Rect2i.xml b/doc/classes/Rect2i.xml index 8b29daa264..a75c31a007 100644 --- a/doc/classes/Rect2i.xml +++ b/doc/classes/Rect2i.xml @@ -12,162 +12,153 @@ <link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link> </tutorials> <methods> - <method name="Rect2i"> - <return type="Rect2i"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <argument index="1" name="size" type="Vector2"> - </argument> + <method name="Rect2i" qualifiers="constructor"> + <return type="Rect2i" /> <description> - Constructs a [Rect2i] by position and size. + Constructs a default-initialized [Rect2i] with default (zero) values of [member position] and [member size]. </description> </method> - <method name="Rect2i"> - <return type="Rect2i"> - </return> - <argument index="0" name="x" type="int"> - </argument> - <argument index="1" name="y" type="int"> - </argument> - <argument index="2" name="width" type="int"> - </argument> - <argument index="3" name="height" type="int"> - </argument> + <method name="Rect2i" qualifiers="constructor"> + <return type="Rect2i" /> + <argument index="0" name="from" type="Rect2i" /> <description> - Constructs a [Rect2i] by x, y, width, and height. + Constructs a [Rect2i] as a copy of the given [Rect2i]. </description> </method> - <method name="Rect2i"> - <return type="Rect2i"> - </return> - <argument index="0" name="from" type="Rect2"> - </argument> + <method name="Rect2i" qualifiers="constructor"> + <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> </method> - <method name="abs"> - <return type="Rect2i"> - </return> + <method name="Rect2i" qualifiers="constructor"> + <return type="Rect2i" /> + <argument index="0" name="position" type="Vector2i" /> + <argument index="1" name="size" type="Vector2i" /> <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. + Constructs a [Rect2i] by position and size. </description> </method> - <method name="clip"> - <return type="Rect2i"> - </return> - <argument index="0" name="b" type="Rect2i"> - </argument> + <method name="Rect2i" qualifiers="constructor"> + <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> - Returns the intersection of this [Rect2i] and b. + Constructs a [Rect2i] by x, y, width, and height. + </description> + </method> + <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"> - <return type="bool"> - </return> - <argument index="0" name="b" type="Rect2i"> - </argument> + <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"> - <return type="Rect2i"> - </return> - <argument index="0" name="to" type="Vector2i"> - </argument> + <method name="expand" qualifiers="const"> + <return type="Rect2i" /> + <argument index="0" name="to" type="Vector2i" /> <description> Returns this [Rect2i] expanded to include a given point. </description> </method> - <method name="get_area"> - <return type="int"> - </return> + <method name="get_area" qualifiers="const"> + <return type="int" /> <description> Returns the area of the [Rect2i]. </description> </method> - <method name="grow"> - <return type="Rect2i"> - </return> - <argument index="0" name="by" type="int"> - </argument> + <method name="grow" qualifiers="const"> + <return type="Rect2i" /> + <argument index="0" name="amount" type="int" /> <description> - Returns a copy of the [Rect2i] grown a given amount of units towards all the sides. + Returns a copy of the [Rect2i] grown by the specified [code]amount[/code] on all sides. </description> </method> - <method name="grow_individual"> - <return type="Rect2i"> - </return> - <argument index="0" name="left" type="int"> - </argument> - <argument index="1" name="top" type="int"> - </argument> - <argument index="2" name="right" type="int"> - </argument> - <argument index="3" name=" bottom" type="int"> - </argument> + <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 a given amount of units towards each direction individually. + Returns a copy of the [Rect2i] grown by the specified amount on each side individually. </description> </method> - <method name="grow_margin"> - <return type="Rect2i"> - </return> - <argument index="0" name="margin" type="int"> - </argument> - <argument index="1" name="by" type="int"> - </argument> + <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 a given amount of units towards the [enum Margin] direction. + 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"> - <return type="bool"> - </return> + <method name="has_no_area" qualifiers="const"> + <return type="bool" /> <description> Returns [code]true[/code] if the [Rect2i] is flat or empty. </description> </method> - <method name="has_point"> - <return type="bool"> - </return> - <argument index="0" name="point" type="Vector2i"> - </argument> + <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. </description> </method> - <method name="intersects"> - <return type="bool"> - </return> - <argument index="0" name="b" type="Rect2i"> - </argument> + <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"> - <return type="Rect2i"> - </return> - <argument index="0" name="b" type="Rect2i"> - </argument> + <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> + <method name="operator !=" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="Rect2i" /> + <description> + </description> + </method> + <method name="operator ==" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="Rect2i" /> + <description> + </description> + </method> </methods> <members> - <member name="end" type="Vector2i" setter="" getter="" default="Vector2i( 0, 0 )"> + <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 )"> + <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. + <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> |