Version: Unity 6.5 Alpha (6000.5)
LanguageEnglish
  • C#

PhysicsShape.Distance

Leave feedback
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 DistanceResult Distance(PhysicsShape otherShape, bool useRadii);

Parameters

Parameter Description
otherShape The other shape to check the distance of.
useRadii Whether to use the radii of both shapes or not.

Returns

DistanceResult The distance result.

Description

Get the minimum distance between this shape and the specified shape.

Declaration

public DistanceResult Distance(PhysicsShape otherShape, PhysicsTransform otherTransform, bool useRadii);

Parameters

Parameter Description
otherShape The other shape to check the distance of.
otherTransform The transform used to specify where the other shape is positioned.
useRadii Whether to use the radii of both shapes or not.

Returns

DistanceResult The distance result.

Description

Get the minimum distance between this shape and the specified shape.

Declaration

public DistanceResult Distance(ReadOnlySpan<PhysicsShape> otherShapes, bool useRadii);

Parameters

Parameter Description
otherShapes A read-only span of the other shape to check the distance of.
useRadii Whether to use the radii of both shapes or not.

Returns

DistanceResult The distance result.

Description

Get the minimum distance between this shape and the specified shape(s) span.

Declaration

public DistanceResult Distance(PhysicsBody physicsBody, bool useRadii);

Parameters

Parameter Description
physicsBody The body whose attached shape(s) will be used to check the distance of.
useRadii Whether to use the radii of all shapes or not.

Description

Get the minimum distance between this shape and all the shapes attached to the specified body.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2005-2026 Unity Technologies. All rights reserved. Built from job ID 62702696. Built on: 2026-01-31.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Do Not Sell or Share My Personal Information