Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

Distance

Calculates the minimum separation of this collider against another collider.
Read time 2 minutesLast updated 5 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.Physics2DModule

Distance(Collider2D)

Calculates the minimum separation of this collider against another collider.
public ColliderDistance2D Distance(Collider2D collider)

Parameters

collider

Collider2D
A collider used to calculate the minimum separation against this collider.

Returns

Type

Description

ColliderDistance2DThe minimum separation of 
collider
and this collider.

Remarks

A valid 
collider
must be provided for the ColliderDistance2D to be valid. If there are any problems with 
collider
or this Collider2D such as they are disabled or do not contain any collision shapes then the separation will be invalid as indicated by ColliderDistance2D.isValid.
Additional Resources: Physics2D.Distance and Rigidbody2D.Distance.

Distance(Vector2, float, Collider2D, Vector2, float)

A valid 
collider
must be provided for the ColliderDistance2D to be valid. If there are any problems with 
collider
or this Collider2D such as they are disabled or do not contain any collision shapes then the separation will be invalid as indicated by ColliderDistance2D.isValid.
public ColliderDistance2D Distance(Vector2 thisPosition, float thisAngle, Collider2D collider, Vector2 position, float angle)

Parameters

thisPosition

Vector2
The position to use for this Collider.

thisAngle

float
The rotation to use for this Collider.

collider

Collider2D
A collider used to calculate the minimum separation against this Collider.

position

Vector2
The position to use for the specified 
collider
.

angle

float
The rotation to use for the specified 
collider
.

Returns

Type

Description

ColliderDistance2DThe minimum separation of 
collider
and this collider.

Remarks

A valid 
collider
must be provided for the ColliderDistance2D to be valid. If there are any problems with 
collider
or this Collider2D such as they are disabled or do not contain any collision shapes then the separation will be invalid as indicated by ColliderDistance2D.isValid.
NOTE: The positions and angles used here represent the position of the Rigidbody2D the respective Collider2D is attached to. If the Collider2D is offset from the center of mass then the Collider2D will use the same offset. This can be confusing so it is recommened that only Collider2D that align with the center of mass are used. If not then you must take this into account. If the Collider2D is not attached to a Rigidbody2D, this call cannot be used and will result in a warning.
Additional Resources: Physics2D.Distance and Rigidbody2D.Distance.