PhysicsAABB
Represents a 2D axis-aligned bounding-box.
Read time 1 minuteLast updated 8 hours ago
Definition
- Type: Struct
- Namespace: Unity.U2D.Physics
- Assembly: UnityEngine.PhysicsCore2DModule
public struct PhysicsAABB
Constructors
Constructor | Description |
|---|---|
| PhysicsAABB(UnityEngine.Vector2) | Create an axis-aligned bounding-box that encapsulates the specified point. |
| PhysicsAABB(UnityEngine.Vector2,UnityEngine.Vector2) | Create an axis-aligned bounding-box with the specified bounds. |
Properties
Property | Description |
|---|---|
| center | Get the center of the AABB. |
| extents | Get the extents (half size) of the AABB. |
| isValid | Check if the AABB is valid. To be valid, PhysicsAABB.upperBound should be equal to or above PhysicsAABB.lowerBound. |
| lowerBound | The lower-left bounding vertex. This should be equal to or lower than PhysicsAABB.upperBound. |
| normalized | Get a new normalized copy of the AABB ensuring that PhysicsAABB.lowerBound is lower than or equal to PhysicsAABB.upperBound. |
| perimeter | Get the perimeter length of the AABB, which is twice the sum of its width and height. |
| upperBound | The upper-right bounding vertex. This should be equal to or above PhysicsAABB.lowerBound. |
Methods
Method | Description |
|---|---|
| CastRay | Perform a raycast against this AABB. Nothing will be detected if the ray starts inside the AABB. To check if the ray starts inside the AABB use PhysicsAABB.OverlapPoint. |
| Contains | Checks if the AABB contains (completely encapsulates) the specified AABB. |
| Normalize | Normalize the AABB ensuring that PhysicsAABB.lowerBound is lower than or equal to PhysicsAABB.upperBound. |
| Overlap | Check if the specified AABB overlaps this AABB. |
| OverlapPoint | Check if the specified point overlaps this AABB. |
| Translate | Create an AABB as a translated version of the current AABB. |
| Union | Create a union of the specified AABB and this AABB where resulting AABB completely encapsulates both AABB. |