Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

Distance

Calculates the minimum distance of this collider against all Collider2D attached to this Rigidbody2D.
Read time 2 minutesLast updated 4 days ago

Definition

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

Distance(Collider2D)

Calculates the minimum distance of this 
collider
against all Collider2D attached to this Rigidbody2D.
public ColliderDistance2D Distance(Collider2D collider)

Parameters

collider

Collider2D
A collider used to calculate the minimum distance against all colliders attached to this Rigidbody2D.

Returns

Type

Description

ColliderDistance2DThe minimum distance of 
collider
against all colliders attached to this Rigidbody2D.

Remarks

The provided 
collider
will be check against all Collider2D attached to this Rigidbody2D and the minimum distance from all attached Collider2D will be returned.
The provided 
collider
and at least one Collider2D attached to this Rigidbody2D must be valid for the returned ColliderDistance2D to be valid i.e. the Collider2D should not be disabled and must contain collision shapes and the provided 
collider
must not be NULL. You can check if the returned value is valid by checking _isValid.
Additional Resources: Physics2D.Distance, Collider2D.Distance

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

Calculates the minimum distance of this 
collider
against all Collider2D attached to this Rigidbody2D.
public ColliderDistance2D Distance(Vector2 thisPosition, float thisAngle, Collider2D collider, Vector2 position, float angle)

Parameters

thisPosition

Vector2
The position to use for this Rigidbody.

thisAngle

float
The rotation to use for this Rigidbody.

collider

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

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 distance of 
collider
against all colliders attached to this Rigidbody2D.

Remarks

The provided 
collider
will be check against all Collider2D attached to this Rigidbody2D and the minimum distance from all attached Collider2D will be returned.
The provided 
collider
and at least one Collider2D attached to this Rigidbody2D must be valid for the returned ColliderDistance2D to be valid i.e. the Collider2D should not be disabled and must contain collision shapes and the provided 
collider
must not be NULL. You can check if the returned value is valid by checking _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 specified 
collider
is not attached to a Rigidbody2D, this call cannot be used and will result in a warning.
Additional Resources: Physics2D.Distance, Collider2D.Distance