2017-09-12 22:42:36 +02:00
|
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
2019-04-01 12:33:56 +02:00
|
|
|
<class name="AABB" category="Built-In Types" version="3.2">
|
2017-09-12 22:42:36 +02:00
|
|
|
<brief_description>
|
|
|
|
Axis-Aligned Bounding Box.
|
|
|
|
</brief_description>
|
|
|
|
<description>
|
2017-11-17 03:09:00 +01:00
|
|
|
AABB consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
<tutorials>
|
2018-11-05 08:46:27 +01:00
|
|
|
<link>https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
|
2017-09-12 22:42:36 +02:00
|
|
|
</tutorials>
|
|
|
|
<methods>
|
2017-11-17 03:09:00 +01:00
|
|
|
<method name="AABB">
|
|
|
|
<return type="AABB">
|
2017-09-12 22:42:36 +02:00
|
|
|
</return>
|
2017-09-10 15:37:49 +02:00
|
|
|
<argument index="0" name="position" type="Vector3">
|
2017-09-12 22:42:36 +02:00
|
|
|
</argument>
|
|
|
|
<argument index="1" name="size" type="Vector3">
|
|
|
|
</argument>
|
|
|
|
<description>
|
|
|
|
Optional constructor, accepts position and size.
|
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="encloses">
|
|
|
|
<return type="bool">
|
|
|
|
</return>
|
2017-11-17 03:09:00 +01:00
|
|
|
<argument index="0" name="with" type="AABB">
|
2017-09-12 22:42:36 +02:00
|
|
|
</argument>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Returns [code]true[/code] if this [AABB] completely encloses another one.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="expand">
|
2017-11-17 03:09:00 +01:00
|
|
|
<return type="AABB">
|
2017-09-12 22:42:36 +02:00
|
|
|
</return>
|
|
|
|
<argument index="0" name="to_point" type="Vector3">
|
|
|
|
</argument>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Returns this [AABB] expanded to include a given point.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_area">
|
|
|
|
<return type="float">
|
|
|
|
</return>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Gets the area of the [AABB].
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_endpoint">
|
|
|
|
<return type="Vector3">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="idx" type="int">
|
|
|
|
</argument>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Gets the position of the 8 endpoints of the [AABB] in space.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_longest_axis">
|
|
|
|
<return type="Vector3">
|
|
|
|
</return>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Returns the normalized longest axis of the [AABB].
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_longest_axis_index">
|
|
|
|
<return type="int">
|
|
|
|
</return>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Returns the index of the longest axis of the [AABB] (according to [Vector3]::AXIS* enum).
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_longest_axis_size">
|
|
|
|
<return type="float">
|
|
|
|
</return>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Returns the scalar length of the longest axis of the [AABB].
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_shortest_axis">
|
|
|
|
<return type="Vector3">
|
|
|
|
</return>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Returns the normalized shortest axis of the [AABB].
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_shortest_axis_index">
|
|
|
|
<return type="int">
|
|
|
|
</return>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Returns the index of the shortest axis of the [AABB] (according to [Vector3]::AXIS* enum).
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_shortest_axis_size">
|
|
|
|
<return type="float">
|
|
|
|
</return>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Returns the scalar length of the shortest axis of the [AABB].
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_support">
|
|
|
|
<return type="Vector3">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="dir" type="Vector3">
|
|
|
|
</argument>
|
|
|
|
<description>
|
2017-10-22 22:43:35 +02:00
|
|
|
Returns the support point in a given direction. This is useful for collision detection algorithms.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="grow">
|
2017-11-17 03:09:00 +01:00
|
|
|
<return type="AABB">
|
2017-09-12 22:42:36 +02:00
|
|
|
</return>
|
|
|
|
<argument index="0" name="by" type="float">
|
|
|
|
</argument>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Returns a copy of the [AABB] grown a given amount of units towards all the sides.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="has_no_area">
|
|
|
|
<return type="bool">
|
|
|
|
</return>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Returns [code]true[/code] if the [AABB] is flat or empty.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="has_no_surface">
|
|
|
|
<return type="bool">
|
|
|
|
</return>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Returns [code]true[/code] if the [AABB] is empty.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="has_point">
|
|
|
|
<return type="bool">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="point" type="Vector3">
|
|
|
|
</argument>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Returns [code]true[/code] if the [AABB] contains a point.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="intersection">
|
2017-11-17 03:09:00 +01:00
|
|
|
<return type="AABB">
|
2017-09-12 22:42:36 +02:00
|
|
|
</return>
|
2017-11-17 03:09:00 +01:00
|
|
|
<argument index="0" name="with" type="AABB">
|
2017-09-12 22:42:36 +02:00
|
|
|
</argument>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Returns the intersection between two [AABB]. An empty AABB (size 0,0,0) is returned on failure.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="intersects">
|
|
|
|
<return type="bool">
|
|
|
|
</return>
|
2017-11-17 03:09:00 +01:00
|
|
|
<argument index="0" name="with" type="AABB">
|
2017-09-12 22:42:36 +02:00
|
|
|
</argument>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Returns [code]true[/code] if the [AABB] overlaps with another.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="intersects_plane">
|
|
|
|
<return type="bool">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="plane" type="Plane">
|
|
|
|
</argument>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Returns [code]true[/code] if the [AABB] is on both sides of a plane.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="intersects_segment">
|
|
|
|
<return type="bool">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="from" type="Vector3">
|
|
|
|
</argument>
|
|
|
|
<argument index="1" name="to" type="Vector3">
|
|
|
|
</argument>
|
|
|
|
<description>
|
2019-03-29 23:37:35 +01:00
|
|
|
Returns [code]true[/code] if the [AABB] intersects the line segment between [code]from[/code] and [code]to[/code].
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
2019-11-08 08:33:48 +01:00
|
|
|
<method name="is_equal_approx">
|
|
|
|
<return type="bool">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="aabb" type="AABB">
|
|
|
|
</argument>
|
|
|
|
<description>
|
2019-11-30 21:08:50 +01:00
|
|
|
Returns [code]true[/code] if this [AABB] and [code]aabb[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
|
2019-11-08 08:33:48 +01:00
|
|
|
</description>
|
|
|
|
</method>
|
2017-09-12 22:42:36 +02:00
|
|
|
<method name="merge">
|
2017-11-17 03:09:00 +01:00
|
|
|
<return type="AABB">
|
2017-09-12 22:42:36 +02:00
|
|
|
</return>
|
2017-11-17 03:09:00 +01:00
|
|
|
<argument index="0" name="with" type="AABB">
|
2017-09-12 22:42:36 +02:00
|
|
|
</argument>
|
|
|
|
<description>
|
2019-11-30 21:08:50 +01:00
|
|
|
Returns a larger [AABB] that contains both this [AABB] and [code]with[/code].
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
</methods>
|
|
|
|
<members>
|
2019-06-29 12:38:01 +02:00
|
|
|
<member name="end" type="Vector3" setter="" getter="" default="Vector3( 0, 0, 0 )">
|
2017-09-12 22:42:36 +02:00
|
|
|
Ending corner.
|
|
|
|
</member>
|
2019-06-29 12:38:01 +02:00
|
|
|
<member name="position" type="Vector3" setter="" getter="" default="Vector3( 0, 0, 0 )">
|
2017-10-22 22:43:35 +02:00
|
|
|
Beginning corner.
|
2017-09-12 22:42:36 +02:00
|
|
|
</member>
|
2019-06-29 12:38:01 +02:00
|
|
|
<member name="size" type="Vector3" setter="" getter="" default="Vector3( 0, 0, 0 )">
|
2017-09-12 22:42:36 +02:00
|
|
|
Size from position to end.
|
|
|
|
</member>
|
|
|
|
</members>
|
|
|
|
<constants>
|
|
|
|
</constants>
|
|
|
|
</class>
|