docs.unity3d.com
    Show / Hide Table of Contents

    XR Origin

    The XR Origin represents the center of worldspace in an XR scene.

    XR Origin

    The purpose of the XR Origin is to transform objects and trackable features to their final position, orientation, and scale in the Unity scene. It specifies an Origin, a Camera Floor Offset Object, and a Camera.

    Adding XR Origin to Scene

    To create a pre-configured XR Origin with a floor offset GameObject and camera already set up, you should right-click anywhere in the scene inspector and select XR > XR Origin.

    Right-click to open Scene Inspector Menu Select XR Origin
    Scene Inspector Menu XR Submenu

    For a non-configured XR Origin, add the XROrigin component to any GameObject.

    How to Setup for AR

    To use XROrigin for an AR experience:

    • Install com.unity.xr.arfoundation.
    • Right-click anywhere in the scene inspector and select XR > XR Origin.
    • To display the camera feed onto which the AR graphics are mapped, under the Camera object associated with the XR Origin, attach the ARCameraManager and ARCameraBackground scripts.

    How to Setup with XR Controllers

    To create a pre-configured XR Origin with controllers:

    • Install com.unity.xr.interaction.toolkit.
    • Right-click anywhere in the scene inspector and select XR > XR Origin (Action-based).

    Note that Action-based menu items in the XR Interaction Toolkit make use of the InputSystem. For more about the difference between Device-based and Action-based behaviors in XRI, see the com.unity.xr.interaction.toolkit documentation linked above.

    How to Setup Tracked Pose Driver

    In order to get position and rotation data from the XR device applied to the camera associated with the XR origin, users should add a Tracked Pose Driver component from com.unity.inputsystem

    The bindings should be as follows for an XR HMD:

    • <XRHMD>/centerEyePosition
    • <XRHMD>/centerEyeRotation

    Tracked Pose Driver

    Note

    There is currently an issue with finding the bindings for Mobile AR via the component editor. To add Mobile AR support, input the following binding paths when adding a new binding to Position Input or Rotation Input respectively:

    • <HandheldARInputDevice>/devicePosition
    • <HandheldARInputDevice>/deviceRotation

    Binding

    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023