Merge pull request #7295 from keveleigh/more-docs

More XR SDK docs

Author: David Kline

Assets/MixedRealityToolkit.Providers/WindowsMixedReality/XRSDK/WindowsMixedRealityDeviceManager.cs

@@ -25,7 +25,7 @@ namespace Microsoft.MixedReality.Toolkit.XRSDK.WindowsMixedReality
         typeof(IMixedRealityInputSystem),
         SupportedPlatforms.WindowsStandalone | SupportedPlatforms.WindowsUniversal,
         "XRSDK Windows Mixed Reality Device Manager")]
-    public class WindowsMixedRealityDataProvider : XRSDKDeviceManager
+    public class WindowsMixedRealityDeviceManager : XRSDKDeviceManager
     {
         /// <summary>
         /// Constructor.
@@ -34,7 +34,7 @@ public class WindowsMixedRealityDataProvider : XRSDKDeviceManager
         /// <param name="name">Friendly name of the service.</param>
         /// <param name="priority">Service priority. Used to determine order of instantiation.</param>
         /// <param name="profile">The service's configuration profile.</param>
-        public WindowsMixedRealityDataProvider(
+        public WindowsMixedRealityDeviceManager(
             IMixedRealityInputSystem inputSystem,
             string name = null,
             uint priority = DefaultPriority,

Assets/MixedRealityToolkit.Providers/XRSDK/Profiles/DefaultXRSDKInputSystemProfile.asset

@@ -15,7 +15,7 @@ MonoBehaviour:
   isCustomProfile: 0
   dataProviderConfigurations:
   - componentType:
-      reference: Microsoft.MixedReality.Toolkit.XRSDK.WindowsMixedReality.WindowsMixedRealityDataProvider,
+      reference: Microsoft.MixedReality.Toolkit.XRSDK.WindowsMixedReality.WindowsMixedRealityDeviceManager,
         Microsoft.MixedReality.Toolkit.Providers.XRSDK.WindowsMixedReality
     componentName: XRSDK Windows Mixed Reality Device Manager
     priority: 0

Documentation/GettingStartedWithMRTKAndXRSDK.md

@@ -0,0 +1,43 @@
+# Getting started with MRTK and XR SDK
+
+XR SDK is Unity's [new XR pipeline in Unity 2019.3 and beyond](https://blogs.unity3d.com/2020/01/24/unity-xr-platform-updates/). In Unity 2019, it provides an alternative to the existing XR pipeline. In Unity 2020, it will become the only XR pipeline in Unity.
+
+## Prerequisites
+
+To get started with the Mixed Reality Toolkit, follow [the provided steps](GettingStartedWithTheMRTK.md) to add MRTK to a project.
+
+## Add XR SDK to a Unity project
+
+For MRTK 2.3, Windows Mixed Reality is supported on XR SDK.
+
+### Required in Unity
+
+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 Management
+   1. Windows XR Plugin
+   1. XR Legacy Input Helpers
+1. Go to Edit > Project Settings.
+1. Click on the XR Plugin Management tab in the Project Settings window.
+1. Go to the Universal Windows Platform settings, then click the + to add a Windows MR Loader.
+1. Ensure that Initialize on Startup is checked.
+1. (**_Optional_**) Click on the Windows Mixed Reality tab under XR Plugin Management and create a custom settings profile to change the defaults.
+
+![Plugin management](Images/XRSDK/PluginManagement.png)
+
+### Required in MRTK
+
+Choose the "DefaultXRSDKConfigurationProfile" as the active profile or clone it to make customizations. This profile is set up with MRTK's XR SDK systems and providers, where needed. If you want to migrate an existing profile to XR SDK, the following services and data providers should be updated:
+
+| Feature | Legacy XR pipeline | XR SDK |
+|---------|--------------------|--------|
+| Camera | [`WindowsMixedReality.WindowsMixedRealityCameraSettings`](xref:Microsoft.MixedReality.Toolkit.WindowsMixedReality.WindowsMixedRealityCameraSettings) | [`XRSDK.WindowsMixedReality.WindowsMixedRealityCameraSettings`](xref:Microsoft.MixedReality.Toolkit.XRSDK.WindowsMixedReality.WindowsMixedRealityCameraSettings) and [`GenericXRSDKCameraSettings`](xref:Microsoft.MixedReality.Toolkit.XRSDK.GenericXRSDKCameraSettings)|
+| Input | [`WindowsMixedReality.Input.WindowsMixedRealityDeviceManager`](xref:Microsoft.MixedReality.Toolkit.WindowsMixedReality.Input.WindowsMixedRealityDeviceManager) | [`XRSDK.WindowsMixedReality.WindowsMixedRealityDeviceManager`](xref:Microsoft.MixedReality.Toolkit.XRSDK.WindowsMixedReality.WindowsMixedRealityDeviceManager) |
+| Boundary | [`MixedRealityBoundarySystem`](xref:Microsoft.MixedReality.Toolkit.Boundary.MixedRealityBoundarySystem) | [`XRSDKBoundarySystem`](xref:Microsoft.MixedReality.Toolkit.XRSDK.XRSDKBoundarySystem) |
+| Spatial awareness | [`WindowsMixedReality.SpatialAwareness.WindowsMixedRealitySpatialMeshObserver`](xref:Microsoft.MixedReality.Toolkit.WindowsMixedReality.SpatialAwareness.WindowsMixedRealitySpatialMeshObserver) | [`XRSDK.WindowsMixedReality.WindowsMixedRealitySpatialMeshObserver`](xref:Microsoft.MixedReality.Toolkit.XRSDK.WindowsMixedReality.WindowsMixedRealitySpatialMeshObserver) |
+
+If using custom controller mapping profiles, open one of them and run the Mixed Reality Toolkit -> Utilities -> Update -> Controller Mapping Profiles menu item to ensure the new XR SDK controller types are defined.
+
+## See also
+
+* [Getting started with AR development in Unity](https://docs.unity3d.com/Manual/AROverview.html)
+* [Getting started with VR development in Unity](https://docs.unity3d.com/Manual/VROverview.html)

Documentation/GettingStartedWithTheMRTK.md

@@ -196,15 +196,4 @@ There is not a direct upgrade path from the HoloToolkit to Mixed Reality Toolkit
 
 ## Getting started with Unity's XR SDK
 
-If you're using Unity's XR SDK in Unity 2019.3 or later, you should choose the "DefaultXRSDKConfigurationProfile" as your active profile. This profile is set up with MRTK's XR SDK systems and providers, where needed.
-Then, follow these steps to set up support in Unity:
-
-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 are all installed:
-   1. XR Management
-   1. Windows XR Plugin
-   1. XR Legacy Input Helpers
-1. Go to Edit > Project Settings.
-1. Click on the XR Plugin Management tab in the Project Settings window.
-1. Go to the Universal Windows Platform settings, then click the + to add a Windows MR Loader.
-1. Ensure that Initialize on Startup is checked.
-1. (**_Optional_**) Click on the Windows Mixed Reality tab under XR Plugin Management and create a custom settings profile to change the defaults.
+Complete instructions and information can be found in our [XR SDK getting started guide](GettingStartedWithMRTKAndXRSDK.md).

Documentation/Images/XRSDK/PluginManagement.png

@@ -3,7 +3,7 @@
 Mixed Reality Toolkit (MRTK) is now available as a NuGet package on NuGet.org. There are some differences when it comes to consuming NuGet version of MRTK as opposed to a .unitypackage, read [NuGet Package Considerations](#nuget-package-considerations) below. If any issues are encountered, file an issue using this [template](https://github.com/microsoft/MixedRealityToolkit-Unity/issues/new?assignees=&labels=Bug,Package%20Management%20-%20NuGet&template=bug-report.md&title=).
 
 > [!NOTE]
-> Migration of existing projects to consume MRTK as a NuGet package is not yet supported, use MRTK via NuGet only for new projects.
+> Migration of existing projects to consume MRTK as a NuGet package is not yet supported. Use MRTK via NuGet only for new projects.
 
 ## Installing the NuGet package
 

Documentation/MRTKNuGetPackage.md

@@ -13,6 +13,8 @@
     href: BuildAndDeploy.md
   - name: NuGet Packages
     href: MRTKNuGetPackage.md
+  - name: Getting started with MRTK and XR SDK
+    href: GettingStartedWithMRTKAndXRSDK.md
   - name: Performance
     href: Performance/PerfGettingStarted.md
   - name: Hologram Stabilization