class in UnityEngine
/
Inherits from:Transform
/
Implemented in:UnityEngine.CoreModule
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.
ClosePosition, size, anchor and pivot information for a rectangle.
RectTransforms are used for GUI but can also be used for other things.
It's used to store and manipulate the position, size, and anchoring of a rectangle and supports various forms of scaling based on a parent RectTransform.
Note: The Inspector changes which properties are exposed based on which anchor preset is in use. For more information see Rect Transform and Basic Layout.
anchoredPosition | The position of the pivot of this RectTransform relative to the anchor reference point. |
anchoredPosition3D | The 3D position of the pivot of this RectTransform relative to the anchor reference point. |
anchorMax | The normalized position in the parent RectTransform that the upper right corner is anchored to. |
anchorMin | The normalized position in the parent RectTransform that the lower left corner is anchored to. |
drivenByObject | The object that is driving the values of this RectTransform. Value is null if not driven. |
offsetMax | The offset of the upper right corner of the rectangle relative to the upper right anchor. |
offsetMin | The offset of the lower left corner of the rectangle relative to the lower left anchor. |
pivot | The normalized position in this RectTransform that it rotates around. |
rect | The calculated rectangle in the local space of the Transform. |
sizeDelta | The size of this RectTransform relative to the distances between the anchors. |
ForceUpdateRectTransforms | Force the recalculation of RectTransforms internal data. |
GetLocalCorners | Get the corners of the calculated rectangle in the local space of its Transform. |
GetWorldCorners | Get the corners of the calculated rectangle in world space. |
SetInsetAndSizeFromParentEdge | Set the distance of this rectangle relative to a specified edge of the parent rectangle, while also setting its size. |
SetSizeWithCurrentAnchors | Makes the RectTransform calculated rect be a given size on the specified axis. |
reapplyDrivenProperties | Event that is invoked for RectTransforms that need to have their driven properties reapplied. |
ReapplyDrivenProperties | Delegate used for the reapplyDrivenProperties event. |
gameObject | The game object this component is attached to. A component is always attached to a game object. |
tag | The tag of this game object. |
transform | The Transform attached to this GameObject. |
hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
name | The name of the object. |
childCount | The number of children the parent Transform has. |
eulerAngles | The rotation as Euler angles in degrees. |
forward | Returns a normalized vector representing the blue axis of the transform in world space. |
hasChanged | Has the transform changed since the last time the flag was set to 'false'? |
hierarchyCapacity | The transform capacity of the transform's hierarchy data structure. |
hierarchyCount | The number of transforms in the transform's hierarchy data structure. |
localEulerAngles | The rotation as Euler angles in degrees relative to the parent transform's rotation. |
localPosition | Position of the transform relative to the parent transform. |
localRotation | The rotation of the transform relative to the transform rotation of the parent. |
localScale | The scale of the transform relative to the GameObjects parent. |
localToWorldMatrix | Matrix that transforms a point from local space into world space (Read Only). |
lossyScale | The global scale of the object (Read Only). |
parent | The parent of the transform. |
position | The world space position of the Transform. |
right | The red axis of the transform in world space. |
root | Returns the topmost transform in the hierarchy. |
rotation | A Quaternion that stores the rotation of the Transform in world space. |
up | The green axis of the transform in world space. |
worldToLocalMatrix | Matrix that transforms a point from world space into local space (Read Only). |
BroadcastMessage | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
CompareTag | Checks the GameObject's tag against the defined tag. |
GetComponent | Gets a reference to a component of type T on the same GameObject as the component specified. |
GetComponentInChildren | Gets a reference to a component of type T on the same GameObject as the component specified, or any child of the GameObject. |
GetComponentIndex | Gets the index of the component on its parent GameObject. |
GetComponentInParent | Gets a reference to a component of type T on the same GameObject as the component specified, or any parent of the GameObject. |
GetComponents | Gets references to all components of type T on the same GameObject as the component specified. |
GetComponentsInChildren | Gets references to all components of type T on the same GameObject as the component specified, and any child of the GameObject. |
GetComponentsInParent | Gets references to all components of type T on the same GameObject as the component specified, and any parent of the GameObject. |
SendMessage | Calls the method named methodName on every MonoBehaviour in this game object. |
SendMessageUpwards | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
TryGetComponent | Gets the component of the specified type, if it exists. |
GetInstanceID | Gets the instance ID of the object. |
ToString | Returns the name of the object. |
DetachChildren | Unparents all children. |
Find | Finds a child by name n and returns it. |
GetChild | Returns a transform child by index. |
GetLocalPositionAndRotation | Gets the position and rotation of the Transform component in local space (that is, relative to its parent transform). |
GetPositionAndRotation | Gets the position and rotation of the Transform component in world space. |
GetSiblingIndex | Gets the sibling index. |
InverseTransformDirection | Transforms a direction from world space to local space. The opposite of Transform.TransformDirection. |
InverseTransformDirections | Transforms multiple directions from world space to local space overwriting each original position with the transformed version. The opposite of Transform.TransformDirections. |
InverseTransformPoint | Transforms position from world space to local space. |
InverseTransformPoints | Transforms multiple positions from world space to local space overwriting each original position with the transformed version. |
InverseTransformVector | Transforms a vector from world space to local space. The opposite of Transform.TransformVector. |
InverseTransformVectors | Transforms multiple vectors from world space to local space overwriting each original position with the transformed version. The opposite of Transform.TransformVectors. |
IsChildOf | Is this transform a child of parent? |
LookAt | Rotates the transform so the forward vector points at /target/'s current position. |
Rotate | Use Transform.Rotate to rotate GameObjects in a variety of ways. The rotation is often provided as an Euler angle and not a Quaternion. |
RotateAround | Rotates the transform about axis passing through point in world coordinates by angle degrees. |
SetAsFirstSibling | Move the transform to the start of the local transform list. |
SetAsLastSibling | Move the transform to the end of the local transform list. |
SetLocalPositionAndRotation | Sets the position and rotation of the Transform component in local space (i.e. relative to its parent transform). |
SetParent | Set the parent of the transform. |
SetPositionAndRotation | Sets the world space position and rotation of the Transform component. |
SetSiblingIndex | Sets the sibling index. |
TransformDirection | Transforms direction from local space to world space. |
TransformDirections | Transforms multiple directions from local space to world space overwriting each original direction with the transformed version. |
TransformPoint | Transforms position from local space to world space. |
TransformPoints | Transforms multiple points from local space to world space overwriting each original point with the transformed version. |
TransformVector | Transforms vector from local space to world space. |
TransformVectors | Transforms multiple vectors from local space to world space overwriting each original vector with the transformed version. |
Translate | Moves the transform in the direction and distance of translation. |
Destroy | Removes a GameObject, component or asset. |
DestroyImmediate | Destroys the object obj immediately. You are strongly recommended to use Destroy instead. |
DontDestroyOnLoad | Do not destroy the target Object when loading a new Scene. |
FindAnyObjectByType | Retrieves any active loaded object of Type type. |
FindFirstObjectByType | Retrieves the first active loaded object of Type type. |
FindObjectsByType | Retrieves a list of all loaded objects of Type type. |
Instantiate | Clones the object original and returns the clone. |
InstantiateAsync | Captures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation. |
bool | Does the object exist? |
operator != | Compares if two objects refer to a different object. |
operator == | Compares two object references to see if they refer to the same object. |
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.