OverlapAABB
Returns all shapes that potentially overlap the provided AABB. The overlap is between AABB of shapes in the world therefore it may not result in an exact overlap of the shape itself. See PhysicsAABB, PhysicsQuery.QueryFilter, PhysicsQuery.WorldOverlapResult and Allocator.
Read time 2 minutesLast updated 12 days ago
Definition
- Type: Method
- Namespace: Unity.U2D.Physics
- Assembly: UnityEngine.PhysicsCore2DModule
OverlapAABB(PhysicsAABB, QueryFilter, Allocator)
Returns all shapes that potentially overlap the provided AABB. The overlap is between AABB of shapes in the world therefore it may not result in an exact overlap of the shape itself. See PhysicsAABB, PhysicsQuery.QueryFilter, PhysicsQuery.WorldOverlapResult and Allocator.
public NativeArray<PhysicsQuery.WorldOverlapResult> OverlapAABB(PhysicsAABB aabb, PhysicsQuery.QueryFilter filter, Allocator allocator = Allocator.Temp)
Parameters
The AABB used to check overlap. This must be in world-space.
The filter to control what results are returned.
The memory allocator to use for the results. This can only be Allocator.Temp, Allocator.TempJob or Allocator.Persistent.
Returns
Type | Description |
|---|---|
| NativeArray<WorldOverlapResult> | The query overlap results. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty. |
OverlapAABB(ReadOnlySpan<PhysicsAABB>, QueryFilter, Allocator)
Returns all shapes that potentially overlap the provided AABBs. The overlap is between AABB of shapes in the world therefore it may not result in an exact overlap of the shape itself. See PhysicsAABB, PhysicsQuery.QueryFilter, PhysicsQuery.WorldOverlapResult and Allocator.
public NativeArray<PhysicsQuery.WorldOverlapResult> OverlapAABB(ReadOnlySpan<PhysicsAABB> aabbs, PhysicsQuery.QueryFilter filter, Allocator allocator = Allocator.Temp)
Parameters
The AABBs used to check overlap. These must be in world-space.
The filter to control what results are returned.
The memory allocator to use for the results. This can only be Allocator.Temp, Allocator.TempJob or Allocator.Persistent.
Returns
Type | Description |
|---|---|
| NativeArray<WorldOverlapResult> | The query overlap results. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty. |