:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AABB.xml. .. _class_AABB: AABB ==== Axis-Aligned Bounding Box. .. rst-class:: classref-introduction-group Description ----------- **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 :ref:`Rect2`. \ **Note:** Unlike :ref:`Rect2`, **AABB** does not have a variant that uses integer coordinates. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Math tutorial index <../tutorials/math/index>` - :doc:`Vector math <../tutorials/math/vector_math>` - :doc:`Advanced vector math <../tutorials/math/vectors_advanced>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------+-----------------------------------------------+------------------------+ | :ref:`Vector3` | :ref:`end` | ``Vector3( 0, 0, 0 )`` | +-------------------------------+-----------------------------------------------+------------------------+ | :ref:`Vector3` | :ref:`position` | ``Vector3( 0, 0, 0 )`` | +-------------------------------+-----------------------------------------------+------------------------+ | :ref:`Vector3` | :ref:`size` | ``Vector3( 0, 0, 0 )`` | +-------------------------------+-----------------------------------------------+------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`AABB` **(** :ref:`Vector3` position, :ref:`Vector3` size **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`abs` **(** **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`encloses` **(** :ref:`AABB` with **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`expand` **(** :ref:`Vector3` to_point **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_area` **(** **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_center` **(** **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_endpoint` **(** :ref:`int` idx **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_longest_axis` **(** **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_longest_axis_index` **(** **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_longest_axis_size` **(** **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_shortest_axis` **(** **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_shortest_axis_index` **(** **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_shortest_axis_size` **(** **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_support` **(** :ref:`Vector3` dir **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`grow` **(** :ref:`float` by **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_no_area` **(** **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_no_surface` **(** **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`intersection` **(** :ref:`AABB` with **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`intersects` **(** :ref:`AABB` with **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`intersects_plane` **(** :ref:`Plane` plane **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`intersects_segment` **(** :ref:`Vector3` from, :ref:`Vector3` to **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`AABB` aabb **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`merge` **(** :ref:`AABB` with **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_AABB_property_end: .. rst-class:: classref-property :ref:`Vector3` **end** = ``Vector3( 0, 0, 0 )`` Ending corner. This is calculated as ``position + size``. Setting this value will change the size. .. rst-class:: classref-item-separator ---- .. _class_AABB_property_position: .. rst-class:: classref-property :ref:`Vector3` **position** = ``Vector3( 0, 0, 0 )`` Beginning corner. Typically has values lower than :ref:`end`. .. rst-class:: classref-item-separator ---- .. _class_AABB_property_size: .. rst-class:: classref-property :ref:`Vector3` **size** = ``Vector3( 0, 0, 0 )`` Size from :ref:`position` to :ref:`end`. Typically, all components are positive. If the size is negative, you can use :ref:`abs` to fix it. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_AABB_method_AABB: .. rst-class:: classref-method :ref:`AABB` **AABB** **(** :ref:`Vector3` position, :ref:`Vector3` size **)** Constructs an **AABB** from a position and size. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_abs: .. rst-class:: classref-method :ref:`AABB` **abs** **(** **)** Returns an AABB with equivalent position and size, modified so that the most-negative corner is the origin and the size is positive. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_encloses: .. rst-class:: classref-method :ref:`bool` **encloses** **(** :ref:`AABB` with **)** Returns ``true`` if this **AABB** completely encloses another one. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_expand: .. rst-class:: classref-method :ref:`AABB` **expand** **(** :ref:`Vector3` to_point **)** Returns a copy of this **AABB** expanded to include a given point. \ **Example:**\ :: # 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)) .. rst-class:: classref-item-separator ---- .. _class_AABB_method_get_area: .. rst-class:: classref-method :ref:`float` **get_area** **(** **)** Returns the volume of the **AABB**. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_get_center: .. rst-class:: classref-method :ref:`Vector3` **get_center** **(** **)** Returns the center of the **AABB**, which is equal to :ref:`position` + (:ref:`size` / 2). .. rst-class:: classref-item-separator ---- .. _class_AABB_method_get_endpoint: .. rst-class:: classref-method :ref:`Vector3` **get_endpoint** **(** :ref:`int` idx **)** Gets the position of the 8 endpoints of the **AABB** in space. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_get_longest_axis: .. rst-class:: classref-method :ref:`Vector3` **get_longest_axis** **(** **)** Returns the normalized longest axis of the **AABB**. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_get_longest_axis_index: .. rst-class:: classref-method :ref:`int` **get_longest_axis_index** **(** **)** Returns the index of the longest axis of the **AABB** (according to :ref:`Vector3`'s ``AXIS_*`` constants). .. rst-class:: classref-item-separator ---- .. _class_AABB_method_get_longest_axis_size: .. rst-class:: classref-method :ref:`float` **get_longest_axis_size** **(** **)** Returns the scalar length of the longest axis of the **AABB**. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_get_shortest_axis: .. rst-class:: classref-method :ref:`Vector3` **get_shortest_axis** **(** **)** Returns the normalized shortest axis of the **AABB**. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_get_shortest_axis_index: .. rst-class:: classref-method :ref:`int` **get_shortest_axis_index** **(** **)** Returns the index of the shortest axis of the **AABB** (according to :ref:`Vector3`::AXIS\* enum). .. rst-class:: classref-item-separator ---- .. _class_AABB_method_get_shortest_axis_size: .. rst-class:: classref-method :ref:`float` **get_shortest_axis_size** **(** **)** Returns the scalar length of the shortest axis of the **AABB**. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_get_support: .. rst-class:: classref-method :ref:`Vector3` **get_support** **(** :ref:`Vector3` dir **)** Returns the support point in a given direction. This is useful for collision detection algorithms. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_grow: .. rst-class:: classref-method :ref:`AABB` **grow** **(** :ref:`float` by **)** Returns a copy of the **AABB** grown a given amount of units towards all the sides. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_has_no_area: .. rst-class:: classref-method :ref:`bool` **has_no_area** **(** **)** Returns ``true`` if the **AABB** is flat or empty. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_has_no_surface: .. rst-class:: classref-method :ref:`bool` **has_no_surface** **(** **)** Returns ``true`` if the **AABB** is empty. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_has_point: .. rst-class:: classref-method :ref:`bool` **has_point** **(** :ref:`Vector3` point **)** Returns ``true`` if the **AABB** contains a point. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_intersection: .. rst-class:: classref-method :ref:`AABB` **intersection** **(** :ref:`AABB` with **)** Returns the intersection between two **AABB**. An empty AABB (size 0,0,0) is returned on failure. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_intersects: .. rst-class:: classref-method :ref:`bool` **intersects** **(** :ref:`AABB` with **)** Returns ``true`` if the **AABB** overlaps with another. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_intersects_plane: .. rst-class:: classref-method :ref:`bool` **intersects_plane** **(** :ref:`Plane` plane **)** Returns ``true`` if the **AABB** is on both sides of a plane. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_intersects_segment: .. rst-class:: classref-method :ref:`bool` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** Returns ``true`` if the **AABB** intersects the line segment between ``from`` and ``to``. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_is_equal_approx: .. rst-class:: classref-method :ref:`bool` **is_equal_approx** **(** :ref:`AABB` aabb **)** Returns ``true`` if this **AABB** and ``aabb`` are approximately equal, by calling :ref:`@GDScript.is_equal_approx` on each component. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_merge: .. rst-class:: classref-method :ref:`AABB` **merge** **(** :ref:`AABB` with **)** Returns a larger **AABB** that contains both this **AABB** and ``with``. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`