mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-09 10:09:20 +08:00
Code Issues Packages Projects Releases Wiki Activity
d27f60f0e8
godot/doc/classes/AABB.xml

254 lines
9.8 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation 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.
2022-02-14 21:18:53 +08:00
<class name="AABB" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<brief_description>
Axis-Aligned Bounding Box.
</brief_description>
<description>
Cross-reference AABB and Rect2 in the class reference
2020-09-21 20:27:50 +08:00
[AABB] consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.
It uses floating-point coordinates. The 2D counterpart to [AABB] is [Rect2].
Warn when using an AABB or Rect2 with a negative size
2020-04-06 16:34:18 +08:00
Negative values for [member size] are not supported and will not work for most methods. Use [method abs] to get an AABB with a positive size.
Cross-reference AABB and Rect2 in the class reference
2020-09-21 20:27:50 +08:00
[b]Note:[/b] Unlike [Rect2], [AABB] does not have a variant that uses integer coordinates.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
<tutorials>
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 17:43:07 +08:00
<link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link>
<link title="Vector math">$DOCS_URL/tutorials/math/vector_math.html</link>
<link title="Advanced vector math">$DOCS_URL/tutorials/math/vectors_advanced.html</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</tutorials>
Move the docs for constructors and operators out of methods section
2021-09-21 10:49:02 +08:00
<constructors>
<constructor name="AABB">
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 21:28:05 +08:00
<return type="AABB" />
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-10 00:46:03 +08:00
<description>
Constructs a default-initialized [AABB] 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 10:49:02 +08:00
</constructor>
<constructor name="AABB">
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 21:28:05 +08:00
<return type="AABB" />
<argument index="0" name="from" type="AABB" />
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-10 00:46:03 +08:00
<description>
Constructs an [AABB] as a copy of the given [AABB].
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 10:49:02 +08:00
</constructor>
<constructor name="AABB">
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 21:28:05 +08:00
<return type="AABB" />
<argument index="0" name="position" type="Vector3" />
<argument index="1" name="size" type="Vector3" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Update core documentation to match recent C# changes Also a few minor API changes like adding AABB.abs() Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2020-07-22 02:07:00 +08:00
Constructs an [AABB] from a position and size.
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 10:49:02 +08:00
</constructor>
</constructors>
<methods>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08: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 21:28:05 +08:00
<return type="AABB" />
Update core documentation to match recent C# changes Also a few minor API changes like adding AABB.abs() Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2020-07-22 02:07:00 +08:00
<description>
Returns an AABB with equivalent position and size, modified so that the most-negative corner is the origin and the size is positive.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08: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 21:28:05 +08:00
<return type="bool" />
<argument index="0" name="with" type="AABB" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-30 06:37:35 +08:00
Returns [code]true[/code] if this [AABB] completely encloses another one.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08: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 21:28:05 +08:00
<return type="AABB" />
<argument index="0" name="to_point" type="Vector3" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Rect2: Clarify docs for `has_point` excluding bottom and right borders Improve tests, as well as documentation for `expand`.
2021-11-11 18:31:30 +08:00
Returns a copy of this [AABB] expanded to include a given point.
[b]Example:[/b]
[codeblocks]
[gdscript]
# position (-3, 2, 0), size (1, 1, 1)
var box = AABB(Vector3(-3, 2, 0), Vector3(1, 1, 1))
# position (-3, -1, 0), size (3, 4, 2), so we fit both the original AABB and Vector3(0, -1, 2)
var box2 = box.expand(Vector3(0, -1, 2))
[/gdscript]
[csharp]
// position (-3, 2, 0), size (1, 1, 1)
var box = new AABB(new Vector3(-3, 2, 0), new Vector3(1, 1, 1));
// position (-3, -1, 0), size (3, 4, 2), so we fit both the original AABB and Vector3(0, -1, 2)
var box2 = box.Expand(new Vector3(0, -1, 2));
[/csharp]
[/codeblocks]
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Add Get Center Method for Rect2/Rect2i and AABB.
2021-09-21 02:48:52 +08:00
<method name="get_center" qualifiers="const">
<return type="Vector3" />
<description>
Returns the center of the [AABB], which is equal to [member position] + ([member size] / 2).
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08:00
<method name="get_endpoint" 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 21:28:05 +08:00
<return type="Vector3" />
<argument index="0" name="idx" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-30 06:37:35 +08:00
Gets the position of the 8 endpoints of the [AABB] in space.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08:00
<method name="get_longest_axis" 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 21:28:05 +08:00
<return type="Vector3" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-30 06:37:35 +08:00
Returns the normalized longest axis of the [AABB].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08:00
<method name="get_longest_axis_index" 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 21:28:05 +08:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
doc: Markup fixes for enums and constants
2019-12-07 06:09:20 +08:00
Returns the index of the longest axis of the [AABB] (according to [Vector3]'s [code]AXIS_*[/code] constants).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08:00
<method name="get_longest_axis_size" 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 21:28:05 +08:00
<return type="float" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-30 06:37:35 +08:00
Returns the scalar length of the longest axis of the [AABB].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08:00
<method name="get_shortest_axis" 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 21:28:05 +08:00
<return type="Vector3" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-30 06:37:35 +08:00
Returns the normalized shortest axis of the [AABB].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08:00
<method name="get_shortest_axis_index" 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 21:28:05 +08:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-30 06:37:35 +08:00
Returns the index of the shortest axis of the [AABB] (according to [Vector3]::AXIS* enum).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08:00
<method name="get_shortest_axis_size" 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 21:28:05 +08:00
<return type="float" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-30 06:37:35 +08:00
Returns the scalar length of the shortest axis of the [AABB].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08:00
<method name="get_support" 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 21:28:05 +08:00
<return type="Vector3" />
<argument index="0" name="dir" type="Vector3" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Added various docs, mostly mathematical basics
2017-10-23 04:43:35 +08:00
Returns the support point in a given direction. This is useful for collision detection algorithms.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Rename AABB `get_area` to `get_volume`
2021-11-05 09:01:59 +08:00
<method name="get_volume" qualifiers="const">
<return type="float" />
<description>
Returns the volume of the [AABB].
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08: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 21:28:05 +08:00
<return type="AABB" />
<argument index="0" name="by" type="float" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-30 06:37:35 +08:00
Returns a copy of the [AABB] grown a given amount of units towards all the sides.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Rename AABB `get_area` to `get_volume`
2021-11-05 09:01:59 +08:00
<method name="has_no_surface" 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 21:28:05 +08:00
<return type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Rename AABB `get_area` to `get_volume`
2021-11-05 09:01:59 +08:00
Returns [code]true[/code] if the [AABB] is empty.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Rename AABB `get_area` to `get_volume`
2021-11-05 09:01:59 +08:00
<method name="has_no_volume" 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 21:28:05 +08:00
<return type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Rename AABB `get_area` to `get_volume`
2021-11-05 09:01:59 +08:00
Returns [code]true[/code] if the [AABB] is flat or empty.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08: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 21:28:05 +08:00
<return type="bool" />
<argument index="0" name="point" type="Vector3" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
AABB: Improve docs and test for `has_point` Contrarily to the 2D Rect2i counterpart, it doesn't make much sense in 3D and for floating-point AABBs to exclude points on some of its faces.
2021-12-02 22:45:18 +08:00
Returns [code]true[/code] if the [AABB] contains a point. Points on the faces of the AABB are considered included, though float-point precision errors may impact the accuracy of such checks.
[b]Note:[/b] This method is not reliable for [AABB] with a [i]negative size[/i]. Use [method abs] to get a positive sized equivalent [AABB] to check for contained points.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08: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 21:28:05 +08:00
<return type="AABB" />
<argument index="0" name="with" type="AABB" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
AABB: Improve docs and test for `has_point` Contrarily to the 2D Rect2i counterpart, it doesn't make much sense in 3D and for floating-point AABBs to exclude points on some of its faces.
2021-12-02 22:45:18 +08:00
Returns the intersection between two [AABB]. An empty AABB (size [code](0, 0, 0)[/code]) is returned on failure.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08: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 21:28:05 +08:00
<return type="bool" />
<argument index="0" name="with" type="AABB" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-30 06:37:35 +08:00
Returns [code]true[/code] if the [AABB] overlaps with another.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08:00
<method name="intersects_plane" 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 21:28:05 +08:00
<return type="bool" />
<argument index="0" name="plane" type="Plane" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-30 06:37:35 +08:00
Returns [code]true[/code] if the [AABB] is on both sides of a plane.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08:00
<method name="intersects_ray" 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 21:28:05 +08:00
<return type="Variant" />
<argument index="0" name="from" type="Vector3" />
<argument index="1" name="dir" type="Vector3" />
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 22:38:26 +08:00
<description>
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08:00
<method name="intersects_segment" 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 21:28:05 +08:00
<return type="Variant" />
<argument index="0" name="from" type="Vector3" />
<argument index="1" name="to" type="Vector3" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-30 06:37:35 +08:00
Returns [code]true[/code] if the [AABB] intersects the line segment between [code]from[/code] and [code]to[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08:00
<method name="is_equal_approx" 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 21:28:05 +08:00
<return type="bool" />
<argument index="0" name="aabb" type="AABB" />
doc: Sync classref with current source
2019-11-08 15:33:48 +08:00
<description>
doc: Sync classref with current source
2021-01-04 21:33:44 +08:00
Returns [code]true[/code] if this [AABB] and [code]aabb[/code] are approximately equal, by calling [method @GlobalScope.is_equal_approx] on each component.
doc: Sync classref with current source
2019-11-08 15:33:48 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08: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 21:28:05 +08:00
<return type="AABB" />
<argument index="0" name="with" type="AABB" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Add docs for is_equal_approx on structures
2019-12-01 04:08:50 +08:00
Returns a larger [AABB] that contains both this [AABB] and [code]with[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Move the docs for constructors and operators out of methods section
2021-09-21 10:49:02 +08:00
</methods>
<members>
<member name="end" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)">
Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size.
</member>
<member name="position" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)">
Beginning corner. Typically has values lower than [member end].
</member>
<member name="size" type="Vector3" setter="" getter="" default="Vector3(0, 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 !=">
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 21:28:05 +08:00
<return type="bool" />
<argument index="0" name="right" type="AABB" />
doc: Sync classref to add operators after #43419
2020-11-10 21:16:20 +08:00
<description>
Add documentation to operators for math types Co-authored-by: Raul Santos <raulsntos@gmail.com>
2021-11-04 23:58:20 +08:00
Returns [code]true[/code] if the vectors are not equal.
[b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable.
doc: Sync classref to add operators after #43419
2020-11-10 21:16:20 +08:00
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 10:49:02 +08: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 21:28:05 +08:00
<return type="AABB" />
<argument index="0" name="right" type="Transform3D" />
doc: Sync classref to add operators after #43419
2020-11-10 21:16:20 +08:00
<description>
Add documentation to operators for math types Co-authored-by: Raul Santos <raulsntos@gmail.com>
2021-11-04 23:58:20 +08:00
Inversely transforms (multiplies) the [AABB] by the given [Transform3D] transformation matrix.
doc: Sync classref to add operators after #43419
2020-11-10 21:16:20 +08:00
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 10:49:02 +08: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 21:28:05 +08:00
<return type="bool" />
<argument index="0" name="right" type="AABB" />
doc: Sync classref to add operators after #43419
2020-11-10 21:16:20 +08:00
<description>
Add documentation to operators for math types Co-authored-by: Raul Santos <raulsntos@gmail.com>
2021-11-04 23:58:20 +08:00
Returns [code]true[/code] if the AABBs are exactly equal.
[b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable.
doc: Sync classref to add operators after #43419
2020-11-10 21:16:20 +08:00
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 10:49:02 +08:00
</operator>
</operators>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</class>
Reference in New Issue Copy Permalink