Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

GetLocalPositionAndRotation(out Vector3, out Quaternion)

Updates 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 ).
Read time 1 minuteLast updated 6 days ago

Definition

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

GetLocalPositionAndRotation(Vector3, Quaternion)

public void GetLocalPositionAndRotation(out Vector3 localPosition, out Quaternion localRotation)

Parameters

localPosition

Vector3
Out parameter that will receive the position of the transform in local space.

localRotation

Quaternion
Out parameter that will receive the rotation of the transform in local space.

Remarks

Note: When getting both the 
localPosition
and 
localRotation
of a 
TransformHandle
, calling this method is slightly more efficient than querying TransformHandle.localPosition and TransformHandle.localRotation individually.
If the transform has no parent, then calling this is equivalent to calling TransformHandle.GetPositionAndRotation.
The typical usage for this method is to retrieve a transform's 
position
and 
rotation
in local space, to either display them or evaluate them. For example:
 transformHandle.GetLocalPositionAndRotation(out Vector3 localPosition, out Quaternion localRotation)
The following example logs the position and rotation of a 
GameObject
's 
TransformHandle
in local space.
using UnityEngine;// Attach this script to a GameObject as a component.public class GetLocalPositionAndRotationExample : MonoBehaviour{    void Start()    {        // transformHandle refers to the <see cref="UnityEngine.TransformHandle"></see> of the <see cref="UnityEngine.GameObject"></see> this script is attached to.        transformHandle.GetLocalPositionAndRotation(out Vector3 localPosition, out Quaternion localRotation);        // We will convert the rotation <see cref="UnityEngine.Quaternion"></see> to Euler angles for readability.        Debug.Log($"{name} is located at {localPosition}, and has the rotation {localRotation.eulerAngles} relative to its parent.");    }}
Additional Resources: Quaternion, Vector3.