diff options
Diffstat (limited to 'doc/classes/Rect2.xml')
| -rw-r--r-- | doc/classes/Rect2.xml | 121 |
1 files changed, 81 insertions, 40 deletions
diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index aaeaa7629d..352a18e326 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -14,33 +14,23 @@ <link title="Advanced vector math">https://docs.godotengine.org/en/latest/tutorials/math/vectors_advanced.html</link> </tutorials> <methods> - <method name="Rect2"> + <method name="Rect2" qualifiers="constructor"> <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. + Constructs a default-initialized [Rect2] with default (zero) values of [member position] and [member size]. </description> </method> - <method name="Rect2"> + <method name="Rect2" qualifiers="constructor"> <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 index="0" name="from" type="Rect2"> </argument> <description> - Constructs a [Rect2] by x, y, width, and height. + Constructs a [Rect2] as a copy of the given [Rect2]. </description> </method> - <method name="Rect2"> + <method name="Rect2" qualifiers="constructor"> <return type="Rect2"> </return> <argument index="0" name="from" type="Rect2i"> @@ -49,23 +39,40 @@ Constructs a [Rect2] from a [Rect2i]. </description> </method> - <method name="abs"> + <method name="Rect2" qualifiers="constructor"> <return type="Rect2"> </return> + <argument index="0" name="position" type="Vector2"> + </argument> + <argument index="1" name="size" type="Vector2"> + </argument> <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. + Constructs a [Rect2] by position and size. </description> </method> - <method name="clip"> + <method name="Rect2" qualifiers="constructor"> <return type="Rect2"> </return> - <argument index="0" name="b" type="Rect2"> + <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> - Returns the intersection of this [Rect2] and b. + Constructs a [Rect2] by x, y, width, and height. </description> </method> - <method name="encloses"> + <method name="abs" qualifiers="const"> + <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="encloses" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="b" type="Rect2"> @@ -74,7 +81,7 @@ Returns [code]true[/code] if this [Rect2] completely encloses another one. </description> </method> - <method name="expand"> + <method name="expand" qualifiers="const"> <return type="Rect2"> </return> <argument index="0" name="to" type="Vector2"> @@ -83,23 +90,23 @@ Returns this [Rect2] expanded to include a given point. </description> </method> - <method name="get_area"> + <method name="get_area" qualifiers="const"> <return type="float"> </return> <description> Returns the area of the [Rect2]. </description> </method> - <method name="grow"> + <method name="grow" qualifiers="const"> <return type="Rect2"> </return> - <argument index="0" name="by" type="float"> + <argument index="0" name="amount" type="float"> </argument> <description> - Returns a copy of the [Rect2] grown a given amount of units towards all the sides. + Returns a copy of the [Rect2] grown by the specified [code]amount[/code] on all sides. </description> </method> - <method name="grow_individual"> + <method name="grow_individual" qualifiers="const"> <return type="Rect2"> </return> <argument index="0" name="left" type="float"> @@ -108,31 +115,31 @@ </argument> <argument index="2" name="right" type="float"> </argument> - <argument index="3" name=" bottom" type="float"> + <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. + Returns a copy of the [Rect2] grown by the specified amount on each side individually. </description> </method> - <method name="grow_margin"> + <method name="grow_side" qualifiers="const"> <return type="Rect2"> </return> - <argument index="0" name="margin" type="int"> + <argument index="0" name="side" type="int"> </argument> - <argument index="1" name="by" type="float"> + <argument index="1" name="amount" type="float"> </argument> <description> - Returns a copy of the [Rect2] grown a given amount of units towards the [enum Margin] direction. + Returns a copy of the [Rect2] grown by the specified [code]amount[/code] on the specified [enum Side]. </description> </method> - <method name="has_no_area"> + <method name="has_no_area" qualifiers="const"> <return type="bool"> </return> <description> Returns [code]true[/code] if the [Rect2] is flat or empty. </description> </method> - <method name="has_point"> + <method name="has_point" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="point" type="Vector2"> @@ -141,7 +148,17 @@ Returns [code]true[/code] if the [Rect2] contains a point. </description> </method> - <method name="intersects"> + <method name="intersection" qualifiers="const"> + <return type="Rect2"> + </return> + <argument index="0" name="b" type="Rect2"> + </argument> + <description> + Returns the intersection of this [Rect2] and [code]b[/code]. + If the rectangles do not intersect, an empty [Rect2] is returned. + </description> + </method> + <method name="intersects" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="b" type="Rect2"> @@ -153,7 +170,7 @@ 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"> + <method name="is_equal_approx" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="rect" type="Rect2"> @@ -162,7 +179,7 @@ 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"> + <method name="merge" qualifiers="const"> <return type="Rect2"> </return> <argument index="0" name="b" type="Rect2"> @@ -171,6 +188,30 @@ Returns a larger [Rect2] that contains this [Rect2] and [code]b[/code]. </description> </method> + <method name="operator !=" qualifiers="operator"> + <return type="bool"> + </return> + <argument index="0" name="right" type="Rect2"> + </argument> + <description> + </description> + </method> + <method name="operator *" qualifiers="operator"> + <return type="Rect2"> + </return> + <argument index="0" name="right" type="Transform2D"> + </argument> + <description> + </description> + </method> + <method name="operator ==" qualifiers="operator"> + <return type="bool"> + </return> + <argument index="0" name="right" type="Rect2"> + </argument> + <description> + </description> + </method> </methods> <members> <member name="end" type="Vector2" setter="" getter="" default="Vector2( 0, 0 )"> @@ -180,7 +221,7 @@ 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. + 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> |