Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

TransformHandle

Position, rotation and scale of an object.
Read time 4 minutesLast updated 6 days ago

Definition

public struct TransformHandle : IEquatable<TransformHandle>, IComparable<TransformHandle>

Remarks

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.

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.
SubhierarchyAn enumerable representing this TransformHandle instance and all of its descendants. The TransformHandle instance itself is yielded first, followed by its descendants in depth-first order.
upThe green axis of the transform in world space.
worldToLocalMatrixMatrix that transforms a point from world space into local space (Read Only).

Static Properties

Property

Description

NoneAn invalid transform handle.

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).
GetSubhierarchyEnumeratorReturns an enumerator that iterates over this transform handle and all of its descendants in its hierarchy.
HasParentDoes this transform have a parent?
InverseTransformDirectionTransforms the direction 
x
, 
y
, 
z
from world space to local space. The opposite of TransformHandle.TransformDirection.
InverseTransformDirectionsTransforms multiple directions from world space to local space writing the transformed positions to a possibly different location. The opposite of TransformHandle.TransformDirections.
InverseTransformPointTransforms the position 
x
, 
y
, 
z
from world space to local space.
InverseTransformPointsTransforms multiple positions from world space to local space writing the transformed positions to a possibly different location.
InverseTransformVectorTransforms the vector 
x
, 
y
, 
z
from world space to local space. The opposite of TransformHandle.TransformVector.
InverseTransformVectorsTransforms the vector 
x
, 
y
, 
z
from world space to local space writing the transformed positions to a possibly different location. The opposite of TransformHandle.TransformVector.
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.
RotateThe implementation of this method applies a rotation of 
zAngle
degrees around the z axis, 
xAngle
degrees around the x axis, and 
yAngle
degrees around the y axis (in that order).
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 
x
, 
y
, 
z
from local space to world space.
TransformDirectionsTransforms multiple directions from local space to world space writing the transformed directions to a possibly different location.
TransformPointTransforms the position 
x
, 
y
, 
z
from local space to world space.
TransformPointsTransforms multiple points from local space to world space writing the transformed points to a possibly different location.
TransformVectorTransforms vector 
x
, 
y
, 
z
from local space to world space.
TransformVectorsTransforms multiple vectors from local space to world space writing the transformed versions to a possibly different location.
TranslateMoves the transform by x along the x axis, y along the y axis, and z along the z axis.

Operators

Operator

Description

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

Structs

Struct

Description

TransformHandle.DirectChildrenEnumerableAn enumerable representing the direct children of a transform handle.
TransformHandle.DirectChildrenEnumeratorAn enumerator that allows you to iterate over all direct children of a transform handle.
TransformHandle.SubhierarchyEnumerableAn enumerable representing a TransformHandle instance and all of its descendants.
TransformHandle.SubhierarchyEnumeratorAn enumerator that iterates over a TransformHandle instance and all of its descendants. The TransformHandle instance itself is yielded first, followed by its descendants in depth-first order.