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.
CloseFor 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.
CloseThe world space centroid (center) of the physics query shape when it intersects.
When the RaycastHit2D result is returned from a linecast or raycast query, the centroid
is identical to the returned point property because a line or ray uses a very small point with no area, so its position is the same as the position it intersects a Collider2D.
However, when using other physics queries that cast shapes that do have an area such as circles, capsules or boxes, the centroid
is the center of the respective shape used when it is in contact with the returned point. For example, a circle will always have its centroid
be its radius away from the returned point.
The centroid
helps identify the position the shape would be at for it to come into contact at the returned RaycastHit2D.point.
Additional resources: RaycastHit2D.point.
using UnityEngine;
public class Example : MonoBehaviour { // A stationary planet public Transform planet;
// A satellite moving around the planet public Transform satellite;
void Update() { // Cast a circle with a radius of 10 in from the satellite position to the planet position. RaycastHit2D hit = Physics2D.CircleCast(satellite.position, 10.0f, planet.position);
// If something was hit, draw a line from the planet to the position the satellite would be if it were to hit the planet. if (hit) Debug.DrawLine(planet.position, hit.centroid, Color.yellow); } }
Additional resources: RaycastHit2D.point.
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.