:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/AABB.xml. .. _class_AABB: AABB ==== A 3D 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`. Negative values for :ref:`size` are not supported and will not work for most methods. Use :ref:`abs` to get an AABB with a positive size. \ **Note:** Unlike :ref:`Rect2`, **AABB** does not have a variant that uses integer coordinates. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Math documentation 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 Constructors ------------ .. table:: :widths: auto +-------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`AABB` **(** **)** | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`AABB` **(** :ref:`AABB` from **)** | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`AABB` **(** :ref:`Vector3` position, :ref:`Vector3` size **)** | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`abs` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`encloses` **(** :ref:`AABB` with **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`expand` **(** :ref:`Vector3` to_point **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_center` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_endpoint` **(** :ref:`int` idx **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_longest_axis` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_longest_axis_index` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_longest_axis_size` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_shortest_axis` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_shortest_axis_index` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_shortest_axis_size` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_support` **(** :ref:`Vector3` dir **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_volume` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`grow` **(** :ref:`float` by **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_surface` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_volume` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`intersection` **(** :ref:`AABB` with **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`intersects` **(** :ref:`AABB` with **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`intersects_plane` **(** :ref:`Plane` plane **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`intersects_ray` **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`intersects_segment` **(** :ref:`Vector3` from, :ref:`Vector3` to **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`AABB` aabb **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`merge` **(** :ref:`AABB` with **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Operators --------- .. table:: :widths: auto +-------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator !=` **(** :ref:`AABB` right **)** | +-------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`operator *` **(** :ref:`Transform3D` right **)** | +-------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator ==` **(** :ref:`AABB` right **)** | +-------------------------+----------------------------------------------------------------------------------------------------------------+ .. 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 Constructor Descriptions ------------------------ .. _class_AABB_constructor_AABB: .. rst-class:: classref-constructor :ref:`AABB` **AABB** **(** **)** Constructs a default-initialized **AABB** with default (zero) values of :ref:`position` and :ref:`size`. .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`AABB` **AABB** **(** :ref:`AABB` from **)** Constructs an **AABB** as a copy of the given **AABB**. .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`AABB` **AABB** **(** :ref:`Vector3` position, :ref:`Vector3` size **)** Constructs an **AABB** from a position and size. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_AABB_method_abs: .. rst-class:: classref-method :ref:`AABB` **abs** **(** **)** |const| 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 **)** |const| 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 **)** |const| Returns a copy of this **AABB** expanded to include a given point. \ **Example:**\ .. tabs:: .. code-tab:: 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)) .. code-tab:: 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)); .. rst-class:: classref-item-separator ---- .. _class_AABB_method_get_center: .. rst-class:: classref-method :ref:`Vector3` **get_center** **(** **)** |const| 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 **)** |const| 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** **(** **)** |const| 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** **(** **)** |const| 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** **(** **)** |const| 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** **(** **)** |const| 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** **(** **)** |const| 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** **(** **)** |const| 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 **)** |const| Returns the support point in a given direction. This is useful for collision detection algorithms. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_get_volume: .. rst-class:: classref-method :ref:`float` **get_volume** **(** **)** |const| Returns the volume of the **AABB**. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_grow: .. rst-class:: classref-method :ref:`AABB` **grow** **(** :ref:`float` by **)** |const| Returns a copy of the **AABB** grown a given number of units towards all the sides. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_has_point: .. rst-class:: classref-method :ref:`bool` **has_point** **(** :ref:`Vector3` point **)** |const| Returns ``true`` 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. \ **Note:** This method is not reliable for **AABB** with a *negative size*. Use :ref:`abs` to get a positive sized equivalent **AABB** to check for contained points. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_has_surface: .. rst-class:: classref-method :ref:`bool` **has_surface** **(** **)** |const| Returns ``true`` if the **AABB** has a surface or a length, and ``false`` if the **AABB** is empty (all components of :ref:`size` are zero or negative). .. rst-class:: classref-item-separator ---- .. _class_AABB_method_has_volume: .. rst-class:: classref-method :ref:`bool` **has_volume** **(** **)** |const| Returns ``true`` if the **AABB** has a volume, and ``false`` if the **AABB** is flat, empty, or has a negative :ref:`size`. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_intersection: .. rst-class:: classref-method :ref:`AABB` **intersection** **(** :ref:`AABB` with **)** |const| 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 **)** |const| 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 **)** |const| Returns ``true`` if the **AABB** is on both sides of a plane. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_intersects_ray: .. rst-class:: classref-method :ref:`Variant` **intersects_ray** **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** |const| Returns the point of intersection of the given ray with this **AABB** or ``null`` if there is no intersection. Ray length is infinite. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_intersects_segment: .. rst-class:: classref-method :ref:`Variant` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** |const| Returns the point of intersection between ``from`` and ``to`` with this **AABB** or ``null`` if there is no intersection. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_is_equal_approx: .. rst-class:: classref-method :ref:`bool` **is_equal_approx** **(** :ref:`AABB` aabb **)** |const| Returns ``true`` if this **AABB** and ``aabb`` are approximately equal, by calling :ref:`@GlobalScope.is_equal_approx` on each component. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_is_finite: .. rst-class:: classref-method :ref:`bool` **is_finite** **(** **)** |const| Returns ``true`` if this **AABB** is finite, by calling :ref:`@GlobalScope.is_finite` on each component. .. rst-class:: classref-item-separator ---- .. _class_AABB_method_merge: .. rst-class:: classref-method :ref:`AABB` **merge** **(** :ref:`AABB` with **)** |const| Returns a larger **AABB** that contains both this **AABB** and ``with``. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Operator Descriptions --------------------- .. _class_AABB_operator_neq_AABB: .. rst-class:: classref-operator :ref:`bool` **operator !=** **(** :ref:`AABB` right **)** Returns ``true`` if the AABBs are not equal. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx` instead, which is more reliable. .. rst-class:: classref-item-separator ---- .. _class_AABB_operator_mul_Transform3D: .. rst-class:: classref-operator :ref:`AABB` **operator *** **(** :ref:`Transform3D` right **)** Inversely transforms (multiplies) the **AABB** by the given :ref:`Transform3D` transformation matrix. .. rst-class:: classref-item-separator ---- .. _class_AABB_operator_eq_AABB: .. rst-class:: classref-operator :ref:`bool` **operator ==** **(** :ref:`AABB` right **)** Returns ``true`` if the AABBs are exactly equal. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx` instead, which is more reliable. .. |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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`