Version: Unity 6.3 Beta (6000.3)
LanguageEnglish
  • C#

TransformHandle

struct in UnityEngine

/

Implemented in:UnityEngine.CoreModule

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

Submission failed

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

Close

Cancel

Description

Position, rotation and scale of an object.

Every object in a Scene has a TransformHandle. It's used to store and manipulate the position, rotation and scale of the object. Every TransformHandle can have a parent, which allows you to apply position, rotation and scale hierarchically. This is the hierarchy seen in the Hierarchy pane.

Static Properties

Property Description
NoneAn invalid transform handle.

Properties

Property Description
childCountThe number of children the parent TransformHandle has.
DirectChildrenAn enumerable representing the direct children of this transform handle.
eulerAnglesThe rotation as Euler angles in degrees.
forwardReturns a normalized vector representing the blue axis of the transform in world space.
hierarchyCapacityThe transform capacity of the transform's hierarchy data structure.
hierarchyCountThe number of transforms in the transform's hierarchy data structure.
localEulerAnglesThe rotation as Euler angles in degrees relative to the parent transform's rotation.
localPositionPosition of the transform relative to the parent transform.
localRotationThe rotation of the transform relative to the transform rotation of the parent.
localScaleThe scale of the transform relative to the GameObjects parent.
localToWorldMatrixMatrix that transforms a point from local space into world space (Read Only).
lossyScaleThe global scale of the object (Read Only).
parentThe parent of the transform.
positionThe world space position of the Transform.
rightThe red axis of the transform in world space.
rootReturns the topmost transform in the hierarchy.
rotationA Quaternion that stores the rotation of the Transform in world space.
upThe green axis of the transform in world space.
worldToLocalMatrixMatrix that transforms a point from world space into local space (Read Only).

Public Methods

Method Description
DetachChildrenUnparents all of the target object's children.
GetChildReturns a transform child by index.
GetDirectChildrenEnumeratorReturns an enumerator that allows you to iterate over all direct children of this transform handle.
GetLocalPositionAndRotationUpdates the value of the out parameters localPosition and localRotation with the transform's current position and rotation in local space (that is, relative to its parent's transformHandle).
GetPositionAndRotationUpdates the value of the out parameters position and rotation with the transform's current position and rotation in world space (that is, relative to the scene's origin coordinates).
HasParentDoes this transform have a parent?
InverseTransformDirectionTransforms a direction from world space to local space. The opposite of TransformHandle.TransformDirection.
InverseTransformDirectionsTransforms multiple directions from world space to local space overwriting each original position with the transformed version. The opposite of TransformHandle.TransformDirections.
InverseTransformPointTransforms position from world space to local space.
InverseTransformPointsTransforms multiple positions from world space to local space overwriting each original position with the transformed version.
InverseTransformVectorTransforms a vector from world space to local space. The opposite of TransformHandle.TransformVector.
InverseTransformVectorsTransforms multiple vectors from world space to local space overwriting each original position with the transformed version. The opposite of TransformHandle.TransformVectors.
IsChildOfIs this transform a child of parent?
IsValidChecks if the transform handle is valid or not.
LookAtRotates the transform so the forward vector points at /target/'s current position.
RotateUse TransformHandle.Rotate to rotate GameObjects in a variety of ways. The rotation is often provided as an Euler angle and not a Quaternion.
RotateAroundRotates the transform about axis passing through point in world coordinates by angle degrees.
SetLocalPositionAndRotationSets the position and rotation of the Transform component in local space (i.e. relative to its parent transform).
SetParentSet the parent of the transform.
SetPositionAndRotationSets the world space position and rotation of the transform.
TransformDirectionTransforms direction from local space to world space.
TransformDirectionsTransforms multiple directions from local space to world space overwriting each original direction with the transformed version.
TransformPointTransforms position from local space to world space.
TransformPointsTransforms multiple points from local space to world space overwriting each original point with the transformed version.
TransformVectorTransforms vector from local space to world space.
TransformVectorsTransforms multiple vectors from local space to world space overwriting each original vector with the transformed version.
TranslateMoves the transform along its x, y, and z axes by the values of the translation parameter's x, y, and z components respectively.

Operators

Operator Description
operator !=Returns true if two TransformHandles are different.
operator ==Returns true if two TransformHandles are equal.