[AddComponentMenu("XR/XR Origin")]
[DisallowMultipleComponent]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.core-utils@2.0/api/Unity.XR.CoreUtils.XROrigin.html")]
public class XROrigin : MonoBehaviour

Remarks

The XR Origin component is typically attached to the base object of the XR Origin, and stores the GameObject that will be manipulated via locomotion. It is also used for offsetting the camera.

Properties

Name	Description
Camera	The Camera used to render the scene from the point of view of the XR device. Must be a child of the GameObject containing this `XROrigin` component.
CameraFloorOffsetObject	The GameObject to move to desired height off the floor (defaults to this object if none provided). This is used to transform the XR device from camera space to XR Origin space.
CameraInOriginSpaceHeight	(Read Only) The camera's height relative to the origin.
CameraInOriginSpacePos	(Read Only) The camera's local position in origin space.
CameraYOffset	Camera height to be used when in `Device` Tracking Origin Mode to define the height of the user from the floor. This is the amount that the camera is offset from the floor when moving the CameraFloorOffsetObject.
CurrentTrackingOriginMode	(Read Only) The Tracking Origin Mode of this XR Origin.
Origin	The "Origin" GameObject is used to refer to the base of the XR Origin, by default it is this GameObject. This is the GameObject that will be manipulated via locomotion.
OriginInCameraSpacePos	(Read Only) The origin's local position in camera space.
RequestedTrackingOriginMode	The type of tracking origin to use for this XROrigin. Tracking origins identify where (0, 0, 0) is in the world of tracking. Not all devices support all tracking origin modes.
TrackablesParent	The parent `Transform` for all "trackables" (for example, planes and feature points).

Methods

Name	Description
Awake()	See MonoBehaviour.
MatchOriginUp(Vector3)	This function will rotate the XR Origin object such that the XR Origin's up vector will match the provided vector.
MatchOriginUpCameraForward(Vector3, Vector3)	This function will rotate the XR Origin object around the camera object using the `destinationUp` vector such that: The camera will look at the area in the direction of the `destinationForward` The projection of camera's forward vector on the plane with the normal `destinationUp` will be in the direction of `destinationForward` The up vector of the XR Origin object will match the provided `destinationUp` vector (note that the camera's Up vector can not be manipulated)
MatchOriginUpOriginForward(Vector3, Vector3)	This function will rotate the XR Origin object around the camera object using the `destinationUp` vector such that: The forward vector of the XR Origin object, which is the direction the player moves in Unity when walking forward in the physical world, will match the provided `destinationUp` vector The up vector of the XR Origin object will match the provided `destinationUp` vector
MoveCameraToWorldLocation(Vector3)	This function moves the camera to the world location provided by `desiredWorldLocation`. It does this by moving the XR Origin object so that the camera's world location matches the desiredWorldLocation
OnDestroy()	See MonoBehaviour.
OnDisable()	See MonoBehaviour.
OnEnable()	See MonoBehaviour.
OnValidate()	See MonoBehaviour.
RotateAroundCameraPosition(Vector3, float)	Rotates the XR origin object around the camera object's position in world space using the provided `vector` as the rotation axis. The XR Origin object is rotated by the amount of degrees provided in `angleDegrees`.
RotateAroundCameraUsingOriginUp(float)	Rotates the XR origin object around the camera object by the provided `angleDegrees`. This rotation only occurs around the origin's Up vector
Start()	See MonoBehaviour.

Events

Name	Description
TrackablesParentTransformChanged	Invoked during Application.onBeforeRender whenever the TrackablesParent transform changes.

Extension Methods

MonoBehaviourExtensions.StartRunInEditMode(MonoBehaviour)

MonoBehaviourExtensions.StopRunInEditMode(MonoBehaviour)