Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

RectTransform

Namespace: UnityEngine

/

Inherits from: Transform

Suggest a change

Success!

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.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Description

Position, 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.

Variables

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.
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.

Functions

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.

Inherited members

Variables

animation The Animation attached to this GameObject (null if there is none attached).
audio The AudioSource attached to this GameObject (null if there is none attached).
camera The Camera attached to this GameObject (null if there is none attached).
collider The Collider attached to this GameObject (null if there is none attached).
collider2D The Collider2D component attached to the object.
constantForce The ConstantForce attached to this GameObject (null if there is none attached).
gameObject The game object this component is attached to. A component is always attached to a game object.
guiText The GUIText attached to this GameObject (null if there is none attached).
guiTexture The GUITexture attached to this GameObject (Read Only). (null if there is none attached).
hingeJoint The HingeJoint attached to this GameObject (null if there is none attached).
light The Light attached to this GameObject (null if there is none attached).
networkView The NetworkView attached to this GameObject (Read Only). (null if there is none attached).
particleEmitter The ParticleEmitter attached to this GameObject (null if there is none attached).
particleSystem The ParticleSystem attached to this GameObject (null if there is none attached).
renderer The Renderer attached to this GameObject (null if there is none attached).
rigidbody The Rigidbody attached to this GameObject (null if there is none attached).
rigidbody2D The Rigidbody2D that is attached to the Component's GameObject.
tag The tag of this game object.
transform The Transform attached to this GameObject (null if there is none attached).
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 Transform has.
eulerAngles The rotation as Euler angles in degrees.
forward The blue axis of the transform in world space.
hasChanged Has the transform changed since the last time the flag was set to 'false'?
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 parent transform's rotation.
localScale The scale of the transform relative to the 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 position of the transform in world space.
right The red axis of the transform in world space.
root Returns the topmost transform in the hierarchy.
rotation The rotation of the transform in world space stored as a Quaternion.
up The green axis of the transform in world space.
worldToLocalMatrix Matrix that transforms a point from world space into local space (Read Only).

Functions

BroadcastMessage Calls the method named methodName on every MonoBehaviour in this game object or any of its children.
CompareTag Is this game object tagged with /tag/?
GetComponent Returns the component of Type type if the game object has one attached, null if it doesn't.
GetComponentInChildren Returns the component of Type type in the GameObject or any of its children using depth first search.
GetComponentInParent Returns the component of Type type in the GameObject or any of its parents.
GetComponents Returns all components of Type type in the GameObject.
GetComponentsInChildren Returns all components of Type type in the GameObject or any of its children.
GetComponentsInParent Returns all components of Type type in the GameObject or any of its parents.
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.
GetInstanceID Returns the instance id of the object.
ToString Returns the name of the game object.
DetachChildren Unparents all children.
Find Finds a child by name and returns it.
GetChild Returns a transform child by index.
GetSiblingIndex Gets the sibling index.
InverseTransformDirection Transforms a direction from world space to local space. The opposite of Transform.TransformDirection.
InverseTransformPoint Transforms position from world space to local space. The opposite of Transform.TransformPoint.
InverseTransformVector Transforms a vector from world space to local space. The opposite of Transform.TransformVector.
IsChildOf Is this transform a child of /parent/?
LookAt Rotates the transform so the forward vector points at /target/'s current position.
Rotate Applies a rotation of /eulerAngles.z/ degrees around the z axis, /eulerAngles.x/ degrees around the x axis, and /eulerAngles.y/ degrees around the y axis (in that order).
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 transfrom list.
SetAsLastSibling Move the transform to the end of the local transfrom list.
SetParent Set the parent of the transform.
SetSiblingIndex Sets the sibling index.
TransformDirection Transforms direction from local space to world space.
TransformPoint Transforms position from local space to world space.
TransformVector Transforms vector from local space to world space.
Translate Moves the transform in the direction and distance of translation.

Static Functions

Destroy Removes a gameobject, component or asset.
DestroyImmediate Destroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoad Makes the object target not be destroyed automatically when loading a new scene.
FindObjectOfType Returns the first active loaded object of Type type.
FindObjectsOfType Returns a list of all active loaded objects of Type type.
Instantiate Clones the object original and returns the clone.

Operators

bool Does the object exist?
operator != Compares if two objects refer to a different object.
operator == Compares if two objects refer to the same.