2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 09:03:48 +08:00
<class name= "AABB" version= "4.0" >
2017-09-13 04:42:36 +08:00
<brief_description >
Axis-Aligned Bounding Box.
</brief_description>
<description >
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].
[b]Note:[/b] Unlike [Rect2], [AABB] does not have a variant that uses integer coordinates.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
2020-08-05 20:43:40 +08:00
<link title= "Math tutorial index" > https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
2020-10-01 16:34:47 +08:00
<link title= "Vector math" > https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link>
<link title= "Advanced vector math" > https://docs.godotengine.org/en/latest/tutorials/math/vectors_advanced.html</link>
2017-09-13 04:42:36 +08:00
</tutorials>
<methods >
2020-11-10 21:16:20 +08:00
<method name= "AABB" qualifiers= "constructor" >
2021-07-30 21:28:05 +08:00
<return type= "AABB" />
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>
</method>
2020-11-10 21:16:20 +08:00
<method name= "AABB" qualifiers= "constructor" >
2021-07-30 21:28:05 +08:00
<return type= "AABB" />
<argument index= "0" name= "from" type= "AABB" />
2020-11-10 00:46:03 +08:00
<description >
Constructs an [AABB] as a copy of the given [AABB].
</description>
</method>
2020-11-10 21:16:20 +08:00
<method name= "AABB" qualifiers= "constructor" >
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" />
2017-09-13 04:42:36 +08:00
<description >
2020-07-22 02:07:00 +08:00
Constructs an [AABB] from a position and size.
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "abs" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "AABB" />
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.
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "encloses" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
<argument index= "0" name= "with" type= "AABB" />
2017-09-13 04:42:36 +08:00
<description >
2019-03-30 06:37:35 +08:00
Returns [code]true[/code] if this [AABB] completely encloses another one.
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "expand" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "AABB" />
<argument index= "0" name= "to_point" type= "Vector3" />
2017-09-13 04:42:36 +08:00
<description >
2019-03-30 06:37:35 +08:00
Returns this [AABB] expanded to include a given point.
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "get_area" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "float" />
2017-09-13 04:42:36 +08:00
<description >
2019-12-18 15:09:11 +08:00
Returns the volume of the [AABB].
2017-09-13 04:42:36 +08:00
</description>
</method>
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>
2021-03-18 21:44:42 +08:00
<method name= "get_endpoint" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "Vector3" />
<argument index= "0" name= "idx" type= "int" />
2017-09-13 04:42:36 +08:00
<description >
2019-03-30 06:37:35 +08:00
Gets the position of the 8 endpoints of the [AABB] in space.
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "get_longest_axis" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "Vector3" />
2017-09-13 04:42:36 +08:00
<description >
2019-03-30 06:37:35 +08:00
Returns the normalized longest axis of the [AABB].
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "get_longest_axis_index" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "int" />
2017-09-13 04:42:36 +08:00
<description >
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).
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "get_longest_axis_size" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "float" />
2017-09-13 04:42:36 +08:00
<description >
2019-03-30 06:37:35 +08:00
Returns the scalar length of the longest axis of the [AABB].
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "get_shortest_axis" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "Vector3" />
2017-09-13 04:42:36 +08:00
<description >
2019-03-30 06:37:35 +08:00
Returns the normalized shortest axis of the [AABB].
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "get_shortest_axis_index" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "int" />
2017-09-13 04:42:36 +08:00
<description >
2019-03-30 06:37:35 +08:00
Returns the index of the shortest axis of the [AABB] (according to [Vector3]::AXIS* enum).
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "get_shortest_axis_size" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "float" />
2017-09-13 04:42:36 +08:00
<description >
2019-03-30 06:37:35 +08:00
Returns the scalar length of the shortest axis of the [AABB].
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "get_support" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "Vector3" />
<argument index= "0" name= "dir" type= "Vector3" />
2017-09-13 04:42:36 +08:00
<description >
2017-10-23 04:43:35 +08:00
Returns the support point in a given direction. This is useful for collision detection algorithms.
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "grow" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "AABB" />
<argument index= "0" name= "by" type= "float" />
2017-09-13 04:42:36 +08:00
<description >
2019-03-30 06:37:35 +08:00
Returns a copy of the [AABB] grown a given amount of units towards all the sides.
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "has_no_area" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2017-09-13 04:42:36 +08:00
<description >
2019-03-30 06:37:35 +08:00
Returns [code]true[/code] if the [AABB] is flat or empty.
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "has_no_surface" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2017-09-13 04:42:36 +08:00
<description >
2019-03-30 06:37:35 +08:00
Returns [code]true[/code] if the [AABB] is empty.
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "has_point" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
<argument index= "0" name= "point" type= "Vector3" />
2017-09-13 04:42:36 +08:00
<description >
2019-03-30 06:37:35 +08:00
Returns [code]true[/code] if the [AABB] contains a point.
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "intersection" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "AABB" />
<argument index= "0" name= "with" type= "AABB" />
2017-09-13 04:42:36 +08:00
<description >
2019-03-30 06:37:35 +08:00
Returns the intersection between two [AABB]. An empty AABB (size 0,0,0) is returned on failure.
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "intersects" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
<argument index= "0" name= "with" type= "AABB" />
2017-09-13 04:42:36 +08:00
<description >
2019-03-30 06:37:35 +08:00
Returns [code]true[/code] if the [AABB] overlaps with another.
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "intersects_plane" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
<argument index= "0" name= "plane" type= "Plane" />
2017-09-13 04:42:36 +08:00
<description >
2019-03-30 06:37:35 +08:00
Returns [code]true[/code] if the [AABB] is on both sides of a plane.
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "intersects_ray" qualifiers= "const" >
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" />
2020-11-04 22:38:26 +08:00
<description >
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "intersects_segment" qualifiers= "const" >
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" />
2017-09-13 04:42:36 +08:00
<description >
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].
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "is_equal_approx" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
<argument index= "0" name= "aabb" type= "AABB" />
2019-11-08 15:33:48 +08:00
<description >
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.
2019-11-08 15:33:48 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "merge" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "AABB" />
<argument index= "0" name= "with" type= "AABB" />
2017-09-13 04:42:36 +08:00
<description >
2019-12-01 04:08:50 +08:00
Returns a larger [AABB] that contains both this [AABB] and [code]with[/code].
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-09-17 23:22:48 +08:00
<method name= "operator !=" qualifiers= "operator" >
<return type= "bool" />
<description >
</description>
</method>
2020-11-10 21:16:20 +08:00
<method name= "operator !=" qualifiers= "operator" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
<argument index= "0" name= "right" type= "AABB" />
2020-11-10 21:16:20 +08:00
<description >
</description>
</method>
<method name= "operator *" qualifiers= "operator" >
2021-07-30 21:28:05 +08:00
<return type= "AABB" />
<argument index= "0" name= "right" type= "Transform3D" />
2020-11-10 21:16:20 +08:00
<description >
</description>
</method>
2021-09-17 23:22:48 +08:00
<method name= "operator ==" qualifiers= "operator" >
<return type= "bool" />
<description >
</description>
</method>
2020-11-10 21:16:20 +08:00
<method name= "operator ==" qualifiers= "operator" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
<argument index= "0" name= "right" type= "AABB" />
2020-11-10 21:16:20 +08:00
<description >
</description>
</method>
2017-09-13 04:42:36 +08:00
</methods>
<members >
2019-09-25 01:45:03 +08:00
<member name= "end" type= "Vector3" setter= "" getter= "" default= "Vector3(0, 0, 0)" >
2020-07-22 02:07:00 +08:00
Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size.
2017-09-13 04:42:36 +08:00
</member>
2019-09-25 01:45:03 +08:00
<member name= "position" type= "Vector3" setter= "" getter= "" default= "Vector3(0, 0, 0)" >
2020-07-22 02:07:00 +08:00
Beginning corner. Typically has values lower than [member end].
2017-09-13 04:42:36 +08:00
</member>
2019-09-25 01:45:03 +08:00
<member name= "size" type= "Vector3" setter= "" getter= "" default= "Vector3(0, 0, 0)" >
2021-03-18 19:04:28 +08:00
Size from [member position] to [member end]. Typically, all components are positive.
2020-07-22 02:07:00 +08:00
If the size is negative, you can use [method abs] to fix it.
2017-09-13 04:42:36 +08:00
</member>
</members>
</class>