godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/Rect2i.xml

187 lines
6.8 KiB
XML
Raw Normal View History

Update docs and bindings for new integer vector types
2020-02-24 16:00:40 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Rect2i" version="4.0">
<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.
Cross-reference AABB and Rect2 in the class reference
2020-09-21 12:27:50 +00:00
It uses integer coordinates. If you need floating-point coordinates, use [Rect2] instead.
Update docs and bindings for new integer vector types
2020-02-24 16:00:40 +00:00
</description>
<tutorials>
doc: Update links to latest documentation after content reorganization
2021-10-06 11:48:48 +00:00
<link title="Math documentation index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
Link to demos from within the class reference
2020-10-01 08:34:47 +00:00
<link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link>
Update docs and bindings for new integer vector types
2020-02-24 16:00:40 +00:00
</tutorials>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
<constructors>
<constructor name="Rect2i">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Rect2i" />
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
<description>
Constructs a default-initialized [Rect2i] with default (zero) values of [member position] and [member size].
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</constructor>
<constructor name="Rect2i">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Rect2i" />
<argument index="0" name="from" type="Rect2i" />
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
<description>
Constructs a [Rect2i] as a copy of the given [Rect2i].
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</constructor>
<constructor name="Rect2i">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Rect2i" />
<argument index="0" name="from" type="Rect2" />
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
<description>
Constructs a new [Rect2i] from [Rect2]. The floating point coordinates will be truncated.
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</constructor>
<constructor name="Rect2i">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Rect2i" />
<argument index="0" name="position" type="Vector2i" />
<argument index="1" name="size" type="Vector2i" />
Update docs and bindings for new integer vector types
2020-02-24 16:00:40 +00:00
<description>
Constructs a [Rect2i] by position and size.
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</constructor>
<constructor name="Rect2i">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<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" />
Update docs and bindings for new integer vector types
2020-02-24 16:00:40 +00:00
<description>
Constructs a [Rect2i] by x, y, width, and height.
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</constructor>
</constructors>
<methods>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="abs" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Rect2i" />
Fix docs generation for Vector2i/Vector3i/Rect2i
2020-06-03 12:22:26 +00:00
<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>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="encloses" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="b" type="Rect2i" />
Fix docs generation for Vector2i/Vector3i/Rect2i
2020-06-03 12:22:26 +00:00
<description>
Returns [code]true[/code] if this [Rect2i] completely encloses another one.
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="expand" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Rect2i" />
<argument index="0" name="to" type="Vector2i" />
Fix docs generation for Vector2i/Vector3i/Rect2i
2020-06-03 12:22:26 +00:00
<description>
Returns this [Rect2i] expanded to include a given point.
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="get_area" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Fix docs generation for Vector2i/Vector3i/Rect2i
2020-06-03 12:22:26 +00:00
<description>
Returns the area of the [Rect2i].
</description>
</method>
Add Get Center Method for Rect2/Rect2i and AABB.
2021-09-20 18:48:52 +00:00
<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>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="grow" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Rect2i" />
<argument index="0" name="amount" type="int" />
Fix docs generation for Vector2i/Vector3i/Rect2i
2020-06-03 12:22:26 +00:00
<description>
Rename Rect2 and Rect2i grow_margin() to grow_side()
2020-12-28 09:11:58 +00:00
Returns a copy of the [Rect2i] grown by the specified [code]amount[/code] on all sides.
Fix docs generation for Vector2i/Vector3i/Rect2i
2020-06-03 12:22:26 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="grow_individual" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<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" />
Fix docs generation for Vector2i/Vector3i/Rect2i
2020-06-03 12:22:26 +00:00
<description>
Rename Rect2 and Rect2i grow_margin() to grow_side()
2020-12-28 09:11:58 +00:00
Returns a copy of the [Rect2i] grown by the specified amount on each side individually.
Fix docs generation for Vector2i/Vector3i/Rect2i
2020-06-03 12:22:26 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="grow_side" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Rect2i" />
<argument index="0" name="side" type="int" />
<argument index="1" name="amount" type="int" />
Fix docs generation for Vector2i/Vector3i/Rect2i
2020-06-03 12:22:26 +00:00
<description>
Rename Rect2 and Rect2i grow_margin() to grow_side()
2020-12-28 09:11:58 +00:00
Returns a copy of the [Rect2i] grown by the specified [code]amount[/code] on the specified [enum Side].
Fix docs generation for Vector2i/Vector3i/Rect2i
2020-06-03 12:22:26 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="has_no_area" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Fix docs generation for Vector2i/Vector3i/Rect2i
2020-06-03 12:22:26 +00:00
<description>
Returns [code]true[/code] if the [Rect2i] is flat or empty.
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="has_point" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="point" type="Vector2i" />
Fix docs generation for Vector2i/Vector3i/Rect2i
2020-06-03 12:22:26 +00:00
<description>
Returns [code]true[/code] if the [Rect2i] contains a point.
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="intersection" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Rect2i" />
<argument index="0" name="b" type="Rect2i" />
doc: Sync classref with current source
2021-01-04 13:33:44 +00:00
<description>
Returns the intersection of this [Rect2i] and [code]b[/code].
If the rectangles do not intersect, an empty [Rect2i] is returned.
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="intersects" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="b" type="Rect2i" />
Fix docs generation for Vector2i/Vector3i/Rect2i
2020-06-03 12:22:26 +00:00
<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>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="merge" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Rect2i" />
<argument index="0" name="b" type="Rect2i" />
Fix docs generation for Vector2i/Vector3i/Rect2i
2020-06-03 12:22:26 +00:00
<description>
Returns a larger [Rect2i] that contains this [Rect2i] and [code]b[/code].
</description>
</method>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</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 !=">
Allow comparing equality between builtin types and null
2021-09-17 15:22:48 +00:00
<return type="bool" />
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator !=">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="right" type="Rect2i" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator ==">
Allow comparing equality between builtin types and null
2021-09-17 15:22:48 +00:00
<return type="bool" />
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
<operator name="operator ==">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="right" type="Rect2i" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</operator>
</operators>
Update docs and bindings for new integer vector types
2020-02-24 16:00:40 +00:00
</class>