AABB Structure |
Axis-Aligned Bounding Box. AABB consists of a position, a size, and
several utility functions. It is typically used for fast overlap tests.
Namespace: Godot
Assembly: GodotSharp (in GodotSharp.dll) Version: 1.0.0
SyntaxC#
[SerializableAttribute] public struct AABB : IEquatable<AABB>
The AABB type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AABB(Vector3, Vector3) |
Constructs an AABB from a position and size.
|
| AABB(Single, Single, Single, Vector3) |
Constructs an AABB from x, y, z, and size.
|
| AABB(Vector3, Single, Single, Single) |
Constructs an AABB from a position, width, height, and depth.
|
| AABB(Single, Single, Single, Single, Single, Single) |
Constructs an AABB from x, y, z, width, height, and depth.
|
Properties| Name | Description | |
|---|---|---|
 | End | |
| Position |
Beginning corner. Typically has values lower than End.
|
| Size |
Size from Position to End. Typically all components are positive.
If the size is negative, you can use Abs to fix it.
|
Methods| Name | Description | |
|---|---|---|
| Abs |
Returns an AABB with equivalent position and size, modified so that
the most-negative corner is the origin and the size is positive.
|
| Encloses |
Returns true if this AABB completely encloses another one.
|
| Equals(Object) | (Overrides ValueTypeEquals(Object).) |
| Equals(AABB) | |
| Expand |
Returns this AABB expanded to include a given point.
|
| GetArea |
Returns the area of the AABB.
|
| GetEndpoint |
Gets the position of one of the 8 endpoints of the AABB.
|
| GetHashCode | (Overrides ValueTypeGetHashCode.) |
| GetLongestAxis |
Returns the normalized longest axis of the AABB.
|
| GetLongestAxisIndex |
Returns the Vector3Axis index of the longest axis of the AABB.
|
| GetLongestAxisSize |
Returns the scalar length of the longest axis of the AABB.
|
| GetShortestAxis |
Returns the normalized shortest axis of the AABB.
|
| GetShortestAxisIndex |
Returns the Vector3Axis index of the shortest axis of the AABB.
|
| GetShortestAxisSize |
Returns the scalar length of the shortest axis of the AABB.
|
| GetSupport |
Returns the support point in a given direction.
This is useful for collision detection algorithms.
|
| GetType | (Inherited from Object.) |
| Grow |
Returns a copy of the AABB grown a given amount of units towards all the sides.
|
| HasNoArea |
Returns true if the AABB is flat or empty, or false otherwise.
|
| HasNoSurface |
Returns true if the AABB has no surface (no size), or false otherwise.
|
| HasPoint |
Returns true if the AABB contains a point, or false otherwise.
|
| Intersection |
Returns the intersection of this AABB and `b`.
|
| Intersects |
Returns true if the AABB overlaps with `b`
(i.e. they have at least one point in common).
If `includeBorders` is true, they will also be considered overlapping
if their borders touch, even without intersection.
|
| IntersectsPlane |
Returns true if the AABB is on both sides of `plane`.
|
| IntersectsSegment |
Returns true if the AABB intersects the line segment between `from` and `to`.
|
| IsEqualApprox |
Returns true if this AABB and `other` are approximately equal, by running
IsEqualApprox(Vector3) on each component.
|
| Merge |
Returns a larger AABB that contains this AABB and `b`.
|
| ToString | (Overrides ValueTypeToString.) |
| ToString(String) |
Operators| Name | Description | |
|---|---|---|
  | Equality | |
| Inequality |
See Also