PhysicsWorld.OverlapPolygon Method
Definition
Namespace: Brine2D.Physics
| Overloads | |
|---|---|
| OverlapPolygon\(ReadOnlySpan<Vector2>, Span<OverlapHit>, bool, Nullable<PhysicsQueryFilter>\) | Returns all bodies \(deduplicated by body\) overlapping the given convex polygon, written into results. Vertices are in world space \(3–8 vertices\). Use OverlapPolygonShapes\(ReadOnlySpan<Vector2>, Span<OverlapHit>, bool, Nullable<PhysicsQueryFilter>\) for per-shape granularity. |
| OverlapPolygon\(ReadOnlySpan<Vector2>, Span<OverlapHit>, Nullable<PhysicsQueryFilter>\) | Returns all bodies \(deduplicated by body\) overlapping the given convex polygon, written into results. Vertices are in world space \(3–8 vertices\). Use OverlapPolygonShapes\(ReadOnlySpan<Vector2>, Span<OverlapHit>, bool, Nullable<PhysicsQueryFilter>\) for per-shape granularity. |
PhysicsWorld.OverlapPolygon\(ReadOnlySpan\<Vector2\>, Span\<OverlapHit\>, bool, Nullable\<PhysicsQueryFilter\>\) Method
Returns all bodies \(deduplicated by body\) overlapping the given convex polygon, written into results. Vertices are in world space \(3–8 vertices\). Use OverlapPolygonShapes\(ReadOnlySpan<Vector2>, Span<OverlapHit>, bool, Nullable<PhysicsQueryFilter>\) for per-shape granularity.
public int OverlapPolygon(System.ReadOnlySpan<System.Numerics.Vector2> vertices, System.Span<Brine2D.Physics.OverlapHit> results, out bool wasTruncated, System.Nullable<Brine2D.Physics.PhysicsQueryFilter> filter=null);
Parameters
vertices System.ReadOnlySpan<System.Numerics.Vector2>
Convex polygon vertices in world space.
results System.Span<OverlapHit>
Buffer to receive results.
wasTruncated System.Boolean
Set to true when the internal collection buffer was too small.
filter System.Nullable<PhysicsQueryFilter>
Optional query filter.
Returns
System.Int32
Number of results written.
Exceptions
System.ArgumentOutOfRangeException
Thrown when vertex count is outside 3–8.
PhysicsWorld.OverlapPolygon\(ReadOnlySpan\<Vector2\>, Span\<OverlapHit\>, Nullable\<PhysicsQueryFilter\>\) Method
Returns all bodies \(deduplicated by body\) overlapping the given convex polygon, written into results. Vertices are in world space \(3–8 vertices\). Use OverlapPolygonShapes\(ReadOnlySpan<Vector2>, Span<OverlapHit>, bool, Nullable<PhysicsQueryFilter>\) for per-shape granularity.
public int OverlapPolygon(System.ReadOnlySpan<System.Numerics.Vector2> vertices, System.Span<Brine2D.Physics.OverlapHit> results, System.Nullable<Brine2D.Physics.PhysicsQueryFilter> filter=null);
Parameters
vertices System.ReadOnlySpan<System.Numerics.Vector2>
Convex polygon vertices in world space.
results System.Span<OverlapHit>
Buffer to receive results.
filter System.Nullable<PhysicsQueryFilter>
Optional query filter.
Returns
System.Int32
Number of results written.
Exceptions
System.ArgumentOutOfRangeException
Thrown when vertex count is outside 3–8.