Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

GetLocalCorners

Get the corners of the calculated rectangle in the local space of its Transform.
Read time 2 minutesLast updated 6 days ago

Definition

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

GetLocalCorners(Vector3[])

Get the corners of the calculated rectangle in the local space of its Transform.
public void GetLocalCorners(Vector3[] fourCornersArray)

Parameters

fourCornersArray

Vector3[]
The array that corners are filled into.

Remarks

Each corner provides its local space value. The returned array of 4 vertices is clockwise. It starts bottom left and rotates to top left, then top right, and finally bottom right. Note that bottom left, for example, is an (x, y, z) vector with x being left and y being bottom.
Note: If the RectTransform is rotated in Z then the dimensions of the RectTransform.GetLocalCorners will not be changed.
Additional Resources: RectTransform.GetWorldCorners.
using UnityEngine;

// GetLocalCorners():
//   Rotate the local corners and display
//   the corner values.

public class ExampleClass : MonoBehaviour
{
 RectTransform rt;

 void Start()
 {
 rt = GetComponent<RectTransform>();
 DisplayLocalCorners();
 }

 void DisplayLocalCorners()
 {
 Vector3[] v = new Vector3[4];

 rt.rotation = Quaternion.AngleAxis(45, Vector3.forward);
 rt.GetLocalCorners(v);

 Debug.Log("Local Corners");
 for (var i = 0; i < 4; i++)
 {
 Debug.Log("Local Corner " + i + " : " + v[i]);
 }
 }
}
Additional Resources: RectTransform.GetWorldCorners.

GetLocalCorners(Span<Vector3>)

Get the corners of the calculated rectangle in the local space of its Transform.
public void GetLocalCorners(Span<Vector3> fourCorners)

Parameters

fourCorners

Span<Vector3>

Remarks

Each corner provides its local space value. The returned array of 4 vertices is clockwise. It starts bottom left and rotates to top left, then top right, and finally bottom right. Note that bottom left, for example, is an (x, y, z) vector with x being left and y being bottom.
Note: If the RectTransform is rotated in Z then the dimensions of the RectTransform.GetLocalCorners will not be changed.
Additional Resources: RectTransform.GetWorldCorners.
using UnityEngine;

// GetLocalCorners():
//   Rotate the local corners and display
//   the corner values.

public class ExampleClass : MonoBehaviour
{
 RectTransform rt;

 void Start()
 {
 rt = GetComponent<RectTransform>();
 DisplayLocalCorners();
 }

 void DisplayLocalCorners()
 {
 Vector3[] v = new Vector3[4];

 rt.rotation = Quaternion.AngleAxis(45, Vector3.forward);
 rt.GetLocalCorners(v);

 Debug.Log("Local Corners");
 for (var i = 0; i < 4; i++)
 {
 Debug.Log("Local Corner " + i + " : " + v[i]);
 }
 }
}
Additional Resources: RectTransform.GetWorldCorners.