Cherry-pick Updated XR SDK documentation (#9173) (#9176)

RogPodge · keveleigh · web-flow · commit f41b79baf70b · 2021-01-27T18:30:45.000-05:00
* Updated XR SDK documentation (#9173) * Updated to consistently refer to XR SDK, rewrote the getting started documentation * fixed doc errors * Update Documentation/GettingStartedWithMRTKAndXRSDK.md Co-authored-by: Kurtis <kurtie@microsoft.com> Co-authored-by: Kurtis <kurtie@microsoft.com> * forgot the save the merge changes * Update Assets/MRTK/Providers/Oculus/XRSDK/OculusXRSDKDeviceManager.cs Co-authored-by: Kurtis <kurtie@microsoft.com> Co-authored-by: Kurtis <kurtie@microsoft.com>
diff --git a/Assets/MRTK/Providers/Oculus/XRSDK/OculusXRSDKDeviceManager.cs b/Assets/MRTK/Providers/Oculus/XRSDK/OculusXRSDKDeviceManager.cs
@@ -17,7 +17,9 @@ namespace Microsoft.MixedReality.Toolkit.XRSDK.Oculus.Input
     [MixedRealityDataProvider(
         typeof(IMixedRealityInputSystem),
         SupportedPlatforms.WindowsStandalone | SupportedPlatforms.Android,
-        "XRSDK Oculus Device Manager")]
+        "XR SDK Oculus Device Manager",
+        "Oculus/XRSDK/Profiles/OculusXRSDKDeviceManagerProfile.asset",
+        "MixedRealityToolkit.Providers")]
     public class OculusXRSDKDeviceManager : XRSDKDeviceManager
     {
         /// <summary>
@@ -345,4 +347,3 @@ private void RemoveHandDevice(OculusHand handDevice)
 #endif
     }
 }
-
diff --git a/Assets/MRTK/Providers/Oculus/XRSDK/OculusXRSDKDeviceManagerProfile.cs b/Assets/MRTK/Providers/Oculus/XRSDK/OculusXRSDKDeviceManagerProfile.cs
@@ -38,7 +38,7 @@ namespace Microsoft.MixedReality.Toolkit.XRSDK.Oculus.Input
     /// The profile for the Oculus XRSDK Device Manager. The settings for this profile can be viewed if the Leap Motion Device Manager input data provider is 
     /// added to the MRTK input configuration profile.
     /// </summary>
-    [CreateAssetMenu(menuName = "Mixed Reality Toolkit/Profiles/Mixed Reality Oculus XRSDK Profile", fileName = "OculusXRSDKDeviceManagerProfile", order = 4)]
+    [CreateAssetMenu(menuName = "Mixed Reality Toolkit/Profiles/Mixed Reality Oculus XR SDK Profile", fileName = "OculusXRSDKDeviceManagerProfile", order = 4)]
     [MixedRealityServiceProfile(typeof(OculusXRSDKDeviceManager))]
     public class OculusXRSDKDeviceManagerProfile : BaseMixedRealityProfile
     {
diff --git a/Assets/MRTK/Providers/WindowsMixedReality/XRSDK/WindowsMixedRealityDeviceManager.cs b/Assets/MRTK/Providers/WindowsMixedReality/XRSDK/WindowsMixedRealityDeviceManager.cs
@@ -30,7 +30,7 @@ namespace Microsoft.MixedReality.Toolkit.XRSDK.WindowsMixedReality
     [MixedRealityDataProvider(
         typeof(IMixedRealityInputSystem),
         SupportedPlatforms.WindowsStandalone | SupportedPlatforms.WindowsUniversal,
-        "XRSDK Windows Mixed Reality Device Manager")]
+        "XR SDK Windows Mixed Reality Device Manager")]
     public class WindowsMixedRealityDeviceManager : XRSDKDeviceManager
     {
         /// <summary>
diff --git a/Assets/MRTK/Providers/XRSDK/XRSDKDeviceManager.cs b/Assets/MRTK/Providers/XRSDK/XRSDKDeviceManager.cs
@@ -17,7 +17,7 @@ namespace Microsoft.MixedReality.Toolkit.XRSDK.Input
     [MixedRealityDataProvider(
         typeof(IMixedRealityInputSystem),
         SupportedPlatforms.WindowsStandalone | SupportedPlatforms.MacStandalone | SupportedPlatforms.LinuxStandalone | SupportedPlatforms.WindowsUniversal,
-        "XRSDK Device Manager")]
+        "XR SDK Device Manager")]
     public class XRSDKDeviceManager : BaseInputDeviceManager, IMixedRealityCapabilityCheck
     {
         /// <summary>
diff --git a/Documentation/CrossPlatform/OculusQuestMRTK.md b/Documentation/CrossPlatform/OculusQuestMRTK.md
@@ -1,4 +1,4 @@
-# How to configure Oculus Quest in MRTK using the XRSDK pipeline
+# How to configure Oculus Quest in MRTK using the XR SDK pipeline
 
 A [Oculus Quest](https://www.oculus.com/quest/) is required.
 
@@ -46,9 +46,9 @@ to "Controllers and Hands".
 1. Create a new Unity scene or open a pre-existing scene like HandInteractionExamples
 1. Add MRTK to the scene by navigating to **Mixed Reality Toolkit** > **Add to Scene and Configure**
 
-## Using the Oculus XRSDK Data Provider
+## Using the Oculus XR SDK Data Provider
 
-1. Configure your profile to use the **Oculus XRSDK Data Provider**
+1. Configure your profile to use the **Oculus XR SDK Data Provider**
     - If not intending to modify the configuration profiles
         - Change your profile to DefaultXRSDKInputSystemProfile and go to [Build and deploy your project to Oculus Quest](OculusQuestMRTK.md#build-and-deploy-your-project-to-oculus-quest)
 
@@ -69,7 +69,7 @@ to "Controllers and Hands".
 
         ![OculusAddXRSDKDataProvider](../Images/CrossPlatform/OculusQuest/OculusAddDataXRSDKProvider.png)
 
-    - You can verify that the Oculus Controllers are detected by 
+1. The Oculus XR SDK Data Provider includes an OVR Camera Rig Prefab which automatically configures the project with an OVR Camera Rig and OVR Hands to properly route input. Manually adding an OVR Camera Rig to the scene will require manual configuration of settings and input.
 
 ## Build and deploy your project to Oculus Quest
 1. Plug in your Oculus Quest via a USB 3.0 -> USB C cable
diff --git a/Documentation/GettingStartedWithMRTKAndXRSDK.md b/Documentation/GettingStartedWithMRTKAndXRSDK.md
@@ -6,11 +6,28 @@ XR SDK is Unity's [new XR pipeline in Unity 2019.3 and beyond](https://blogs.uni
 
 To get started with the Mixed Reality Toolkit, follow [the provided steps](WelcomeToMRTK.md) to add MRTK to a project.
 
-## Add XR SDK to a Unity project
+## Configuring Unity for the XR SDK pipeline
 
-Windows Mixed Reality, Oculus, and OpenXR are supported on XR SDK.
+The XR SDK pipeline currently supports 3 platforms: Windows Mixed Reality, Oculus, and OpenXR. The sections below will cover the steps needed to configure XR SDK for each platform.
 
-### Required in Unity
+#### Windows Mixed Reality
+
+1. Go into Unity's Package Manager and install the Windows XR Plugin package, which adds support for Windows Mixed Reality on XR SDK. This will pull down a few dependency packages as well. Ensure that the following all successfully installed:
+   1. XR Plugin Management
+   1. Windows XR Plugin
+   1. XR Legacy Input Helpers
+1. Go to Edit > Project Settings.
+1. Click on the XR Plug-in Management tab in the Project Settings window.
+1. Go to the Universal Windows Platform settings and ensure Windows Mixed Reality is checked under Plug-in Providers.
+1. Ensure that Initialize XR on Startup is checked.
+1. (**_Required for in-editor HoloLens Remoting, otherwise optional_**) Go to the Standalone settings and ensure Windows Mixed Reality is checked under Plug-in Providers. Also ensure that Initialize XR on Startup is checked.
+1. (**_Optional_**) Click on the Windows Mixed Reality tab under XR Plug-in Management and create a custom settings profile to change the defaults. If the list of settings are already there, no profile needs to be created.
+
+![Plugin management](Images/XRSDK/PluginManagement.png)
+
+#### Oculus
+
+1. Follow the [How to configure Oculus Quest in MRTK using the XR SDK pipeline](CrossPlatform/OculusQuestMRTK.md) guide to the end. The guide outlines the steps needed to configure both Unity and MRTK to use the XR SDK pipeline for the Oculus Quest.
 
 #### OpenXR (Preview)
 
@@ -19,33 +36,27 @@ Windows Mixed Reality, Oculus, and OpenXR are supported on XR SDK.
 >
 > Currently, it also only supports x64 and ARM64 builds.
 
-1. Follow the [Using the Mixed Reality OpenXR Plugin for Unity](https://aka.ms/openxr-unity-install) guide, including the steps for configuring XR Plugin Management and Optimization to install the OpenXR plug-in to your project.
-1. Ensure that the following have successfully installed:
+1. Follow the [Using the Mixed Reality OpenXR Plugin for Unity](https://aka.ms/openxr-unity-install) guide, including the steps for configuring XR Plugin Management and Optimization to install the OpenXR plug-in to your project. Ensure that the following have successfully installed:
    1. XR Plugin Management
    1. OpenXR Plugin
    1. Mixed Reality OpenXR Plugin
-
-> [!NOTE]
-> For the initial release of MRTK and OpenXR, only the HoloLens 2 articulated hands and Windows Mixed Reality motion controllers are natively supported. Support for additional hardware will be added in upcoming releases.
+1. Go to Edit > Project Settings.
+1. Click on the XR Plug-in Management tab in the Project Settings window.
+1. Ensure that Initialize XR on Startup is checked.
+1. (**_Optional_**) If targeting HoloLens 2, make sure you're on the UWP platform and select Microsoft HoloLens Feature Set
 
 ![Plugin management](Images/XRSDK/PluginManagementOpenXR.png)
 
-#### Windows Mixed Reality
+> [!NOTE] 
+> If you have a pre-existing project that is using MRTK from UPM, make sure that the following line is in the **link.xml** file located in the MixedRealityToolkit.Generated folder.
+   
+`<assembly fullname = "Microsoft.MixedReality.Toolkit.Providers.OpenXR" preserve="all"/>`
 
-1. Go into Unity's Package Manager and install the Windows XR Plugin package, which adds support for Windows Mixed Reality on XR SDK. This will pull down a few dependency packages as well. Ensure the following all successfully installed:
-   1. XR Plugin Management
-   1. Windows XR Plugin
-   1. XR Legacy Input Helpers
-1. Go to Edit > Project Settings.
-1. Click on the XR Plug-in Management tab in the Project Settings window.
-1. Go to the Universal Windows Platform settings and ensure Windows Mixed Reality is checked under Plug-in Providers.
-1. Ensure that Initialize XR on Startup is checked.
-1. (**_Required for in-editor HoloLens Remoting, otherwise optional_**) Go to the Standalone settings and ensure Windows Mixed Reality is checked under Plug-in Providers. Also ensure that Initialize XR on Startup is checked.
-1. (**_Optional_**) Click on the Windows Mixed Reality tab under XR Plug-in Management and create a custom settings profile to change the defaults. If the list of settings are already there, no profile needs to be created.
+> [!NOTE]
+> For the initial release of MRTK and OpenXR, only the HoloLens 2 articulated hands and Windows Mixed Reality motion controllers are natively supported. Support for additional hardware will be added in upcoming releases.
 
-![Plugin management](Images/XRSDK/PluginManagement.png)
 
-### Required in MRTK
+### Configuring MRTK for the XR SDK pipeline
 
 If using OpenXR, choose "DefaultOpenXRConfigurationProfile" as the active profile or clone it to make customizations.
 

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,9 @@ namespace Microsoft.MixedReality.Toolkit.XRSDK.Oculus.Input`
`17`	`17`	`[MixedRealityDataProvider(`
`18`	`18`	`typeof(IMixedRealityInputSystem),`
`19`	`19`	`SupportedPlatforms.WindowsStandalone \| SupportedPlatforms.Android,`
`20`		`- "XRSDK Oculus Device Manager")]`
	`20`	`+ "XR SDK Oculus Device Manager",`
	`21`	`+ "Oculus/XRSDK/Profiles/OculusXRSDKDeviceManagerProfile.asset",`
	`22`	`+ "MixedRealityToolkit.Providers")]`
`21`	`23`	`public class OculusXRSDKDeviceManager : XRSDKDeviceManager`
`22`	`24`	`{`
`23`	`25`	`/// <summary>`
`@@ -345,4 +347,3 @@ private void RemoveHandDevice(OculusHand handDevice)`
`345`	`347`	`#endif`
`346`	`348`	`}`
`347`	`349`	`}`
`348`		`-`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ namespace Microsoft.MixedReality.Toolkit.XRSDK.Oculus.Input`
`38`	`38`	`/// The profile for the Oculus XRSDK Device Manager. The settings for this profile can be viewed if the Leap Motion Device Manager input data provider is`
`39`	`39`	`/// added to the MRTK input configuration profile.`
`40`	`40`	`/// </summary>`
`41`		`- [CreateAssetMenu(menuName = "Mixed Reality Toolkit/Profiles/Mixed Reality Oculus XRSDK Profile", fileName = "OculusXRSDKDeviceManagerProfile", order = 4)]`
	`41`	`+ [CreateAssetMenu(menuName = "Mixed Reality Toolkit/Profiles/Mixed Reality Oculus XR SDK Profile", fileName = "OculusXRSDKDeviceManagerProfile", order = 4)]`
`42`	`42`	`[MixedRealityServiceProfile(typeof(OculusXRSDKDeviceManager))]`
`43`	`43`	`public class OculusXRSDKDeviceManagerProfile : BaseMixedRealityProfile`
`44`	`44`	`{`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ namespace Microsoft.MixedReality.Toolkit.XRSDK.WindowsMixedReality`
`30`	`30`	`[MixedRealityDataProvider(`
`31`	`31`	`typeof(IMixedRealityInputSystem),`
`32`	`32`	`SupportedPlatforms.WindowsStandalone \| SupportedPlatforms.WindowsUniversal,`
`33`		`- "XRSDK Windows Mixed Reality Device Manager")]`
	`33`	`+ "XR SDK Windows Mixed Reality Device Manager")]`
`34`	`34`	`public class WindowsMixedRealityDeviceManager : XRSDKDeviceManager`
`35`	`35`	`{`
`36`	`36`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ namespace Microsoft.MixedReality.Toolkit.XRSDK.Input`
`17`	`17`	`[MixedRealityDataProvider(`
`18`	`18`	`typeof(IMixedRealityInputSystem),`
`19`	`19`	`SupportedPlatforms.WindowsStandalone \| SupportedPlatforms.MacStandalone \| SupportedPlatforms.LinuxStandalone \| SupportedPlatforms.WindowsUniversal,`
`20`		`- "XRSDK Device Manager")]`
	`20`	`+ "XR SDK Device Manager")]`
`21`	`21`	`public class XRSDKDeviceManager : BaseInputDeviceManager, IMixedRealityCapabilityCheck`
`22`	`22`	`{`
`23`	`23`	`/// <summary>`