A 3D axis-aligned bounding box.
The AABB built-in Variant type represents an axis-aligned bounding box in a 3D space. It is defined by its position and size, which are Vector3. It is frequently used for fast overlap tests (see intersects()). Although AABB itself is axis-aligned, it can be combined with Transform3D to represent a rotated or skewed bounding box.
It uses floating-point coordinates. The 2D counterpart to AABB is Rect2. There is no version of AABB that uses integer coordinates.
Note: Negative values for size are not supported. With negative size, most AABB methods do not work correctly. Use abs() to get an equivalent AABB with a non-negative size.
Note: In a boolean context, an AABB evaluates to false if both position and size are zero (equal to Vector3.ZERO). Otherwise, it always evaluates to true.
The ending point. This is usually the corner on the top-right and back of the bounding box, and is equivalent to position + size. Setting this point affects the size.
The bounding box's width, height, and depth starting from position. Setting this value also affects the end point.
Note: It's recommended setting the width, height, and depth to non-negative values. This is because most methods in Godot assume that the position is the bottom-left-forward corner, and the end is the top-right-back corner. To get an equivalent bounding box with non-negative size, use abs().
Returns an AABB equivalent to this bounding box, with its width, height, and depth modified to be non-negative values.
var box = AABB(Vector3(5, 0, 5), Vector3(-20, -10, -5))
var absolute = box.abs()
print(absolute.position) # Prints (-15.0, -10.0, 0.0)
print(absolute.size) # Prints (20.0, 10.0, 5.0)Note: It's recommended to use this method when size is negative, as most other methods in Godot assume that the size's components are greater than 0.
Returns true if this bounding box completely encloses the with box. The edges of both boxes are included.
var a = AABB(Vector3(0, 0, 0), Vector3(4, 4, 4))
var b = AABB(Vector3(1, 1, 1), Vector3(3, 3, 3))
var c = AABB(Vector3(2, 2, 2), Vector3(8, 8, 8))
print(a.encloses(a)) # Prints true
print(a.encloses(b)) # Prints true
print(a.encloses(c)) # Prints falseReturns a copy of this bounding box expanded to align the edges with the given to_point, if necessary.
var box = AABB(Vector3(0, 0, 0), Vector3(5, 2, 5))
box = box.expand(Vector3(10, 0, 0))
print(box.position) # Prints (0.0, 0.0, 0.0)
print(box.size) # Prints (10.0, 2.0, 5.0)
box = box.expand(Vector3(-5, 0, 5))
print(box.position) # Prints (-5.0, 0.0, 0.0)
print(box.size) # Prints (15.0, 2.0, 5.0)Returns the longest normalized axis of this bounding box's size, as a Vector3 (Vector3.RIGHT, Vector3.UP, or Vector3.BACK).
var box = AABB(Vector3(0, 0, 0), Vector3(2, 4, 8))
print(box.get_longest_axis()) # Prints (0.0, 0.0, 1.0)
print(box.get_longest_axis_index()) # Prints 2
print(box.get_longest_axis_size()) # Prints 8.0See also get_longest_axis_index() and get_longest_axis_size().
Returns the index to the longest axis of this bounding box's size (see Vector3.AXIS_X, Vector3.AXIS_Y, and Vector3.AXIS_Z).
For an example, see get_longest_axis().
Returns the longest dimension of this bounding box's size.
For an example, see get_longest_axis().
Returns the shortest normalized axis of this bounding box's size, as a Vector3 (Vector3.RIGHT, Vector3.UP, or Vector3.BACK).
var box = AABB(Vector3(0, 0, 0), Vector3(2, 4, 8))
print(box.get_shortest_axis()) # Prints (1.0, 0.0, 0.0)
print(box.get_shortest_axis_index()) # Prints 0
print(box.get_shortest_axis_size()) # Prints 2.0See also get_shortest_axis_index() and get_shortest_axis_size().
Returns the index to the shortest axis of this bounding box's size (see Vector3.AXIS_X, Vector3.AXIS_Y, and Vector3.AXIS_Z).
For an example, see get_shortest_axis().
Returns the shortest dimension of this bounding box's size.
For an example, see get_shortest_axis().
Returns the vertex's position of this bounding box that's the farthest in the given direction. This point is commonly known as the support point in collision detection algorithms.
Returns the bounding box's volume. This is equivalent to size.x * size.y * size.z. See also has_volume().
Returns a copy of this bounding box extended on all sides by the given amount by. A negative amount shrinks the box instead.
var a = AABB(Vector3(4, 4, 4), Vector3(8, 8, 8)).grow(4)
print(a.position) # Prints (0.0, 0.0, 0.0)
print(a.size) # Prints (16.0, 16.0, 16.0)
var b = AABB(Vector3(0, 0, 0), Vector3(8, 4, 2)).grow(2)
print(b.position) # Prints (-2.0, -2.0, -2.0)
print(b.size) # Prints (12.0, 8.0, 6.0)Returns true if this bounding box has a surface or a length, that is, at least one component of size is greater than 0. Otherwise, returns false.
Returns true if this bounding box's width, height, and depth are all positive. See also get_volume().
Returns the intersection between this bounding box and with. If the boxes do not intersect, returns an empty AABB. If the boxes intersect at the edge, returns a flat AABB with no volume (see has_surface() and has_volume()).
var box1 = AABB(Vector3(0, 0, 0), Vector3(5, 2, 8))
var box2 = AABB(Vector3(2, 0, 2), Vector3(8, 4, 4))
var intersection = box1.intersection(box2)
print(intersection.position) # Prints (2.0, 0.0, 2.0)
print(intersection.size) # Prints (3.0, 2.0, 4.0)Note: If you only need to know whether two bounding boxes are intersecting, use intersects(), instead.
Returns true if this bounding box overlaps with the box with. The edges of both boxes are always excluded.
Returns the first point where this bounding box and the given ray intersect, as a Vector3. If no intersection occurs, returns null.
The ray begin at from, faces dir and extends towards infinity.
Returns the first point where this bounding box and the given segment intersect, as a Vector3. If no intersection occurs, returns null.
The segment begins at from and ends at to.
Returns true if this bounding box and aabb are approximately equal, by calling Vector3.is_equal_approx() on the position and the size.
Returns true if this bounding box's values are finite, by calling Vector3.is_finite() on the position and the size.
Returns an AABB that encloses both this bounding box and with around the edges. See also encloses().