Refactored Controller visualization code, Oculus Touch uses their own standalone visualizer (#9589)

* Refactored some of the confusing controller visualization code, Oculus XRSDK Touch controllers no longer rely on MRTK for controller visualization, since they have their own standalone visualization

* added failsafe in case Oculus Integration package is not imported

* fixed bug where Oculus project config settings would get reset inexplicably

* Update Assets/MRTK/Providers/Oculus/XRSDK/Controllers/OculusXRSDKTouchController.cs

Co-authored-by: Kurtis <[email protected]>

* Update Assets/MRTK/Core/Providers/BaseController.cs

Co-authored-by: Kurtis <[email protected]>

* Update Assets/MRTK/Providers/Oculus/XRSDK/Controllers/OculusXRSDKTouchController.cs

Co-authored-by: Kurtis <[email protected]>

* addressing PR comments

* fixed obsolete reference

* added oculusintegration_present flags

* Update Assets/MRTK/Providers/Oculus/XRSDK/OculusXRSDKDeviceManager.cs

Co-authored-by: Kurtis <[email protected]>

* fixed double negative typo

* cached controller settings

Co-authored-by: Kurtis <[email protected]>

Author: RogPodge

Assets/MRTK/Core/Definitions/Devices/MixedRealityControllerVisualizationProfile.cs

@@ -154,24 +154,29 @@ public GameObject GlobalRightHandVisualizer
         /// </summary>
         public MixedRealityControllerVisualizationSetting[] ControllerVisualizationSettings => controllerVisualizationSettings;
 
-        /// <summary>
-        /// Gets the override model for a specific controller type and hand
-        /// </summary>
-        /// <param name="controllerType">The type of controller to query for</param>
-        /// <param name="hand">The specific hand assigned to the controller</param>
-        public GameObject GetControllerModelOverride(Type controllerType, Handedness hand)
+        private MixedRealityControllerVisualizationSetting? GetControllerVisualizationDefinition(Type controllerType, Handedness hand)
         {
             for (int i = 0; i < controllerVisualizationSettings.Length; i++)
             {
                 if (SettingContainsParameters(controllerVisualizationSettings[i], controllerType, hand))
                 {
-                    return controllerVisualizationSettings[i].OverrideControllerModel;
+                    return controllerVisualizationSettings[i];
                 }
             }
-
             return null;
         }
 
+        /// <summary>
+        /// Gets the override model for a specific controller type and hand
+        /// </summary>
+        /// <param name="controllerType">The type of controller to query for</param>
+        /// <param name="hand">The specific hand assigned to the controller</param>
+        public GameObject GetControllerModelOverride(Type controllerType, Handedness hand)
+        {
+            MixedRealityControllerVisualizationSetting? setting = GetControllerVisualizationDefinition(controllerType, hand);
+            return setting.HasValue ? setting.Value.OverrideControllerModel : null;
+        }
+
         /// <summary>
         /// Gets the override <see cref="IMixedRealityControllerVisualizer"/> type for a specific controller type and hand.
         /// If the requested controller type is not defined, DefaultControllerVisualizationType is returned.
@@ -180,53 +185,63 @@ public GameObject GetControllerModelOverride(Type controllerType, Handedness han
         /// <param name="hand">The specific hand assigned to the controller</param>
         public SystemType GetControllerVisualizationTypeOverride(Type controllerType, Handedness hand)
         {
-            for (int i = 0; i < controllerVisualizationSettings.Length; i++)
-            {
-                if (SettingContainsParameters(controllerVisualizationSettings[i], controllerType, hand))
-                {
-                    return controllerVisualizationSettings[i].ControllerVisualizationType;
-                }
-            }
-
-            return defaultControllerVisualizationType;
+            MixedRealityControllerVisualizationSetting? setting = GetControllerVisualizationDefinition(controllerType, hand);
+            return setting.HasValue ? setting.Value.ControllerVisualizationType : null;
         }
 
         /// <summary>
-        /// Gets the UseDefaultModels value defined for the specified controller definition.
-        /// If the requested controller type is not defined, the default UseDefaultModels is returned.
+        /// Gets the UsePlatformModels value defined for the specified controller definition.
+        /// If the requested controller type is not defined, the default UsePlatformModels is returned.
         /// </summary>
         /// <param name="controllerType">The type of controller to query for</param>
         /// <param name="hand">The specific hand assigned to the controller</param>
+        /// <remarks>
+        /// GetUseDefaultModelsOverride is obsolete and will be removed in a future Mixed Reality Toolkit release. Please use GetUsePlatformModelsOverride.
+        /// </remarks>
+        [Obsolete("GetUseDefaultModelsOverride is obsolete and will be removed in a future Mixed Reality Toolkit release. Please use GetUsePlatformModelsOverride.")]
         public bool GetUseDefaultModelsOverride(Type controllerType, Handedness hand)
         {
-            for (int i = 0; i < controllerVisualizationSettings.Length; i++)
-            {
-                if (SettingContainsParameters(controllerVisualizationSettings[i], controllerType, hand))
-                {
-                    return controllerVisualizationSettings[i].UsePlatformModels;
-                }
-            }
+            return GetUsePlatformModelsOverride(controllerType, hand);
+        }
 
-            return usePlatformModels;
+        /// <summary>
+        /// Gets the UsePlatformModels value defined for the specified controller definition.
+        /// If the requested controller type is not defined, the default UsePlatformModels is returned.
+        /// </summary>
+        /// <param name="controllerType">The type of controller to query for</param>
+        /// <param name="hand">The specific hand assigned to the controller</param>
+        public bool GetUsePlatformModelsOverride(Type controllerType, Handedness hand)
+        {
+            MixedRealityControllerVisualizationSetting? setting = GetControllerVisualizationDefinition(controllerType, hand);
+            return setting.HasValue ? setting.Value.UsePlatformModels : usePlatformModels;
         }
 
         /// <summary>
         /// Gets the DefaultModelMaterial value defined for the specified controller definition.
-        /// If the requested controller type is not defined, the global DefaultControllerModelMaterial is returned.
+        /// If the requested controller type is not defined, the global platformModelMaterial is returned.
         /// </summary>
         /// <param name="controllerType">The type of controller to query for</param>
         /// <param name="hand">The specific hand assigned to the controller</param>
+        /// <remarks>
+        /// GetDefaultControllerModelMaterialOverride is obsolete and will be removed in a future Mixed Reality Toolkit release. Please use GetPlatformModelMaterialOverride.
+        /// </remarks>
+        [Obsolete("GetDefaultControllerModelMaterialOverride is obsolete and will be removed in a future Mixed Reality Toolkit release. Please use GetPlatformModelMaterial.")]
         public Material GetDefaultControllerModelMaterialOverride(Type controllerType, Handedness hand)
         {
-            for (int i = 0; i < controllerVisualizationSettings.Length; i++)
-            {
-                if (SettingContainsParameters(controllerVisualizationSettings[i], controllerType, hand))
-                {
-                    return controllerVisualizationSettings[i].PlatformModelMaterial;
-                }
-            }
+            return GetPlatformModelMaterialOverride(controllerType, hand);
+        }
+
+        /// <summary>
+        /// Gets the PlatformModelMaterial value defined for the specified controller definition.
+        /// If the requested controller type is not defined, the global platformModelMaterial is returned.
+        /// </summary>
+        /// <param name="controllerType">The type of controller to query for</param>
+        /// <param name="hand">The specific hand assigned to the controller</param>
+        public Material GetPlatformModelMaterialOverride(Type controllerType, Handedness hand)
+        {
 
-            return platformModelMaterial;
+            MixedRealityControllerVisualizationSetting? setting = GetControllerVisualizationDefinition(controllerType, hand);
+            return setting.HasValue ? setting.Value.PlatformModelMaterial : platformModelMaterial;
         }
 
         private bool SettingContainsParameters(MixedRealityControllerVisualizationSetting setting, Type controllerType, Handedness hand)

Assets/MRTK/Core/Inspectors/Profiles/MixedRealityControllerVisualizationProfileInspector.cs

@@ -102,7 +102,7 @@ public override void OnInspectorGUI()
 
                     if (usePlatformControllerModels.boolValue && (leftHandModelPrefab != null || rightHandModelPrefab != null))
                     {
-                        EditorGUILayout.HelpBox("When default models are used, an attempt is made to obtain controller models from the platform SDK. The global left and right models are only shown if no model can be obtained.", MessageType.Warning);
+                        EditorGUILayout.HelpBox("When platform models are used, an attempt is made to obtain controller models from the platform SDK. The global left and right models are only shown if no model can be obtained.", MessageType.Warning);
                     }
 
                     EditorGUI.BeginChangeCheck();
@@ -208,6 +208,12 @@ private void RenderControllerList(SerializedProperty controllerList)
                     EditorGUILayout.HelpBox("A controller type must be defined!", MessageType.Error);
                 }
 
+                bool isOculusType = thisProfile.ControllerVisualizationSettings[i].ControllerType.Type.FullName.Contains("OculusXRSDKTouchController");
+                if (isOculusType)
+                {
+                    EditorGUILayout.HelpBox("Oculus Touch controller model visualization is not managed by MRTK, refer to the Oculus XRSDK Device Manager to configure controller visualization settings", MessageType.Error);
+                }
+
                 var handednessValue = mixedRealityControllerHandedness.intValue - 1;
 
                 // Reset in case it was set to something other than left or right.
@@ -233,11 +239,15 @@ private void RenderControllerList(SerializedProperty controllerList)
 
                 if (controllerUsePlatformModelOverride.boolValue && overrideModelPrefab != null)
                 {
-                    EditorGUILayout.HelpBox("When default model is used, the override model will only be used if the default model cannot be loaded from the driver.", MessageType.Warning);
+                    EditorGUILayout.HelpBox("When platform model is used, the override model will only be used if the default model cannot be loaded from the driver.", MessageType.Warning);
                 }
 
                 EditorGUI.BeginChangeCheck();
                 overrideModelPrefab = EditorGUILayout.ObjectField(new GUIContent(overrideModel.displayName, "If no override model is set, the global model is used."), overrideModelPrefab, typeof(GameObject), false) as GameObject;
+                if(overrideModelPrefab == null && !controllerUsePlatformModelOverride.boolValue)
+                {
+                    EditorGUILayout.HelpBox("No override model was assigned and this controller will not attempt to use the platform's model, the global model will be used instead", MessageType.Warning);
+                }
 
                 if (EditorGUI.EndChangeCheck() && CheckVisualizer(overrideModelPrefab))
                 {

Assets/MRTK/Core/Providers/BaseController.cs

@@ -234,50 +234,50 @@ public void AssignControllerMappings(MixedRealityInteractionMapping[] mappings)
         /// <returns>True if a model was successfully loaded or model rendering is disabled. False if a model tried to load but failed.</returns>
         protected virtual bool TryRenderControllerModel(Type controllerType, InputSourceType inputSourceType)
         {
-            if (GetControllerVisualizationProfile() == null ||
-                !GetControllerVisualizationProfile().RenderMotionControllers)
+            MixedRealityControllerVisualizationProfile controllerVisualizationProfile = GetControllerVisualizationProfile();
+            bool controllerVisualizationProfilePresent = controllerVisualizationProfile != null;
+           
+            if (!controllerVisualizationProfilePresent || !controllerVisualizationProfile.RenderMotionControllers)
             {
                 return true;
             }
 
             GameObject controllerModel = null;
+            bool usePlatformModels = controllerVisualizationProfile.GetUsePlatformModelsOverride(controllerType, ControllerHandedness);
 
-            // If a specific controller template wants to override the global model, assign that instead.
-            if (IsControllerMappingEnabled() &&
-                GetControllerVisualizationProfile() != null &&
-                !(GetControllerVisualizationProfile().GetUseDefaultModelsOverride(controllerType, ControllerHandedness)))
+            // If a specific controller template wants to override the global model, assign it
+            if (!usePlatformModels)
             {
-                controllerModel = GetControllerVisualizationProfile().GetControllerModelOverride(controllerType, ControllerHandedness);
+                controllerModel = controllerVisualizationProfile.GetControllerModelOverride(controllerType, ControllerHandedness);
             }
 
-            // Get the global controller model for each hand.
-            if (controllerModel == null &&
-                GetControllerVisualizationProfile() != null)
+            // If the Controller model is still null in the end, use the global defaults.
+            if (controllerModel == null)
             {
                 if (inputSourceType == InputSourceType.Controller)
                 {
                     if (ControllerHandedness == Handedness.Left &&
-                        GetControllerVisualizationProfile().GlobalLeftHandModel != null)
+                        controllerVisualizationProfile.GlobalLeftHandModel != null)
                     {
-                        controllerModel = GetControllerVisualizationProfile().GlobalLeftHandModel;
+                        controllerModel = controllerVisualizationProfile.GlobalLeftHandModel;
                     }
                     else if (ControllerHandedness == Handedness.Right &&
-                        GetControllerVisualizationProfile().GlobalRightHandModel != null)
+                        controllerVisualizationProfile.GlobalRightHandModel != null)
                     {
-                        controllerModel = GetControllerVisualizationProfile().GlobalRightHandModel;
+                        controllerModel = controllerVisualizationProfile.GlobalRightHandModel;
                     }
                 }
                 else if (inputSourceType == InputSourceType.Hand)
                 {
                     if (ControllerHandedness == Handedness.Left &&
-                        GetControllerVisualizationProfile().GlobalLeftHandVisualizer != null)
+                        controllerVisualizationProfile.GlobalLeftHandVisualizer != null)
                     {
-                        controllerModel = GetControllerVisualizationProfile().GlobalLeftHandVisualizer;
+                        controllerModel = controllerVisualizationProfile.GlobalLeftHandVisualizer;
                     }
                     else if (ControllerHandedness == Handedness.Right &&
-                        GetControllerVisualizationProfile().GlobalRightHandVisualizer != null)
+                        controllerVisualizationProfile.GlobalRightHandVisualizer != null)
                     {
-                        controllerModel = GetControllerVisualizationProfile().GlobalRightHandVisualizer;
+                        controllerModel = controllerVisualizationProfile.GlobalRightHandVisualizer;
                     }
                 }
             }

Assets/MRTK/Providers/Oculus/XRSDK/Controllers/OculusXRSDKTouchController.cs

@@ -7,6 +7,7 @@
 using Unity.Profiling;
 using UnityEngine;
 using UnityEngine.XR;
+using System;
 
 #if OCULUS_ENABLED
 using Unity.XR.Oculus;
@@ -88,5 +89,27 @@ protected override void UpdateButtonData(MixedRealityInteractionMapping interact
                 }
             }
         }
+
+        /// <summary>
+        /// Determines whether or not this controller uses MRTK for controller visualization or not
+        /// </summary>
+        internal bool UseMRTKControllerVisualization { get; set; } = false;
+
+        /// <inheritdoc/>
+        /// <remarks>
+        /// If UseMRTKControllerVisualization is false, Oculus Touch controller model visualization will not be managed by MRTK
+        /// Ensure that the Oculus Integration Package is installed and the Ovr Camera Rig is set correctly in the Oculus XRSDK Device Manager
+        /// </remarks>
+        protected override bool TryRenderControllerModel(Type controllerType, InputSourceType inputSourceType)
+        {
+            if (UseMRTKControllerVisualization)
+            {
+                return base.TryRenderControllerModel(controllerType, inputSourceType);
+            }
+            else
+            {
+                return false;
+            }
+        }
     }
 }

Assets/MRTK/Providers/Oculus/XRSDK/MRTK-Quest/Editor/OculusXRSDKHandtrackingConfigurationChecker.cs

@@ -125,6 +125,8 @@ internal static void InitializeOculusProjectConfig()
                 defaultOculusProjectConfig.handTrackingSupport = OVRProjectConfig.HandTrackingSupport.ControllersAndHands;
                 defaultOculusProjectConfig.requiresSystemKeyboard = true;
 
+                OVRProjectConfig.CommitProjectConfig(defaultOculusProjectConfig);
+
                 Debug.Log("Enabled Oculus Quest Keyboard and Handtracking in the Oculus Project Config");
             }
 #endif

Assets/MRTK/Providers/Oculus/XRSDK/OculusXRSDKDeviceManager.cs

@@ -88,6 +88,20 @@ public override bool CheckCapability(MixedRealityCapability capability)
 
         #region Controller Utilities
 
+#if OCULUSINTEGRATION_PRESENT
+        /// <inheritdoc />
+        protected override GenericXRSDKController GetOrAddController(InputDevice inputDevice)
+        {
+            GenericXRSDKController controller = base.GetOrAddController(inputDevice);
+            if (controller is OculusXRSDKTouchController oculusTouchController)
+            {
+                oculusTouchController.UseMRTKControllerVisualization = cameraRig.IsNull();
+            }
+
+            return controller;
+        }
+#endif
+
         /// <inheritdoc />
         protected override Type GetControllerType(SupportedControllerType supportedControllerType)
         {

Assets/MRTK/Providers/OpenVR/GenericOpenVRController.cs

@@ -254,7 +254,7 @@ protected override bool TryRenderControllerModel(Type controllerType, InputSourc
 
             // Intercept this call if we are using the default driver provided models.
             if (visualizationProfile == null ||
-                !visualizationProfile.GetUseDefaultModelsOverride(GetType(), ControllerHandedness))
+                !visualizationProfile.GetUsePlatformModelsOverride(GetType(), ControllerHandedness))
             {
                 return base.TryRenderControllerModel(controllerType, inputSourceType);
             }
@@ -282,7 +282,7 @@ protected override bool TryRenderControllerModel(Type controllerType, InputSourc
                 }
 
                 OpenVRRenderModel openVRRenderModel = controllerModelGameObject.AddComponent<OpenVRRenderModel>();
-                Material overrideMaterial = visualizationProfile.GetDefaultControllerModelMaterialOverride(GetType(), ControllerHandedness);
+                Material overrideMaterial = visualizationProfile.GetPlatformModelMaterialOverride(GetType(), ControllerHandedness);
                 if (overrideMaterial != null)
                 {
                     openVRRenderModel.shader = overrideMaterial.shader;