Version: Unity 6.3 Beta (6000.3)
LanguageEnglish
  • C#

PhysicsWorld.OverlapGeometry

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public NativeArray<WorldOverlapResult> OverlapGeometry(LowLevelPhysics2D.CircleGeometry geometry, LowLevelPhysics2D.PhysicsQuery.QueryFilter filter, Unity.Collections.Allocator allocator);

Parameters

Parameter Description
geometry The Circle geometry used to check overlap. This must be in world-space.
filter 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

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.

Description

Returns all shapes that overlap the provided Circle geometry. A circle with a radius of zero is equivalent to PhysicsWorld.OverlapPoint. See CircleGeometry, QueryFilter, WorldOverlapResult and Allocator


Declaration

public NativeArray<WorldOverlapResult> OverlapGeometry(LowLevelPhysics2D.CapsuleGeometry geometry, LowLevelPhysics2D.PhysicsQuery.QueryFilter filter, Unity.Collections.Allocator allocator);

Parameters

Parameter Description
geometry The Capsule geometry used to check overlap. This must be in world-space.
filter 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

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.

Description

Returns all shapes that overlap the provided Capsule geometry. See CapsuleGeometry, QueryFilter, WorldOverlapResult and Allocator.


Declaration

public NativeArray<WorldOverlapResult> OverlapGeometry(LowLevelPhysics2D.PolygonGeometry geometry, LowLevelPhysics2D.PhysicsQuery.QueryFilter filter, Unity.Collections.Allocator allocator);

Parameters

Parameter Description
geometry The Polygon geometry used to check overlap. This must be in world-space.
filter 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

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.

Description

Returns all shapes that overlap the provided Polygon geometry. See PolygonGeometry, QueryFilter, WorldOverlapResult and Allocator.


Declaration

public NativeArray<WorldOverlapResult> OverlapGeometry(LowLevelPhysics2D.SegmentGeometry geometry, LowLevelPhysics2D.PhysicsQuery.QueryFilter filter, Unity.Collections.Allocator allocator);

Parameters

Parameter Description
geometry The Segment geometry used to check overlap. This must be in world-space.
filter 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

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.

Description

Returns all shapes that overlap the provided Segment geometry. See SegmentGeometry, QueryFilter, WorldOverlapResult and Allocator.


Declaration

public NativeArray<WorldOverlapResult> OverlapGeometry(LowLevelPhysics2D.ChainSegmentGeometry geometry, LowLevelPhysics2D.PhysicsQuery.QueryFilter filter, Unity.Collections.Allocator allocator);

Parameters

Parameter Description
geometry The Chain-Segment geometry used to check overlap. This must be in world-space.
filter 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

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.

Description

Returns all shapes that overlap the provided Chain-Segment geometry. See ChainSegmentGeometry, QueryFilter, WorldOverlapResult and Allocator.