Represents the separation or overlap of two Collider2D.
The ColliderDistance2D primarily defines a point on the exterior of each Collider2D along with the distance between those two points. The distance between them can be positive indicating that the Collider2D are separated (not overlapped), zero indicating that they are touching (but not overlapped) or negative indicating that they are overlapped.
A normal is provided that is a normalized vector that points from pointB to pointA. This vector, when scaled with the distance, provide a vector that can be used to move the Collider2D so that they are no longer overlapped (if the distance is negative) or so they are touching (if the distance is positive).
A common use-case for this is solving overlaps between two Collider2D, particularly when attached to a Rigidbody2D set to be RigidbodyType2D.Kinematic.
See Also: Physics2D.Distance, Collider2D.Distance and Rigidbody2D.Distance.
distance | Gets the distance between two colliders. |
isOverlapped | Gets whether the distance represents an overlap or not. |
isValid | Gets whether the distance is valid or not. |
normal | A normalized vector that points from pointB to pointA. |
pointA | A point on a Collider2D that is a specific distance away from pointB. |
pointB | A point on a Collider2D that is a specific distance away from pointA. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.