Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


OverlapPoint

Returns all shapes that overlap the provided point. This first converts the shape to a PhysicsShape.ShapeProxy and uses PhysicsWorld.TestOverlapShapeProxy. See PhysicsQuery.QueryFilter, PhysicsQuery.WorldOverlapResult and Allocator.
Read time 2 minutesLast updated 10 days ago

Definition

  • Type: Method
  • Namespace: Unity.U2D.Physics
  • Assembly: UnityEngine.PhysicsCore2DModule

OverlapPoint(Vector2, QueryFilter, Allocator)

Returns all shapes that overlap the provided point. This first converts the shape to a PhysicsShape.ShapeProxy and uses PhysicsWorld.TestOverlapShapeProxy. See PhysicsQuery.QueryFilter, PhysicsQuery.WorldOverlapResult and Allocator.
public NativeArray<PhysicsQuery.WorldOverlapResult> OverlapPoint(Vector2 point, PhysicsQuery.QueryFilter filter, Allocator allocator = Allocator.Temp)

Parameters

point

The point used to check overlap. This must be in world-space.

The filter to control what results are returned.

allocator

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.

OverlapPoint(ReadOnlySpan<Vector2>, QueryFilter, Allocator)

Returns all shapes that overlap the provided point(s). This first converts the shape to a PhysicsShape.ShapeProxy and uses PhysicsWorld.TestOverlapShapeProxy. See PhysicsQuery.QueryFilter, PhysicsQuery.WorldOverlapResult and Allocator.
public NativeArray<PhysicsQuery.WorldOverlapResult> OverlapPoint(ReadOnlySpan<Vector2> points, PhysicsQuery.QueryFilter filter, Allocator allocator = Allocator.Temp)

Parameters

The points used to check overlap. These must be in world-space.

The filter to control what results are returned.

allocator

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.