Clarified eye tracking settings wording and added links to documentation (#10535)

* Clarified eye tracking settings wording and added links to documentation

* Update Assets/MRTK/Core/Inspectors/Profiles/MixedRealityPointerProfileInspector.cs

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

* PR feedback

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

Author: RogPodge

Assets/MRTK/Core/Definitions/InputSystem/MixedRealityPointerProfile.cs

@@ -82,11 +82,11 @@ public SystemType GazeProviderType
         public bool UseHeadGazeOverride => useHeadGazeOverride;
 
         [SerializeField]
-        [Tooltip("If true, eye-based tracking will be used as gaze input when available. Requires the 'Gaze Input' permission and device eye calibration to have been run.")]
+        [Tooltip("If true, eye-based tracking will be used as gaze input when available. This field does not control whether eye tracking data is provided.")]
         private bool isEyeTrackingEnabled = false;
 
         /// <summary>
-        /// If true, eye-based tracking will be used as gaze input when available.
+        /// If true, eye-based tracking will be used as gaze input when available. This field does not control whether eye tracking data is provided.
         /// </summary>
         public bool IsEyeTrackingEnabled
         {

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

@@ -16,6 +16,7 @@ public class MixedRealityPointerProfileInspector : BaseMixedRealityToolkitConfig
         private static readonly GUIContent MinusButtonContent = new GUIContent("-", "Remove Pointer Option");
         private static readonly GUIContent AddButtonContent = new GUIContent("+ Add a New Pointer Option", "Add Pointer Option");
         private static readonly GUIContent GazeCursorPrefabContent = new GUIContent("Gaze Cursor Prefab");
+        private static readonly GUIContent UseEyeTrackingDataContent = new GUIContent("Use Eye Tracking Data");
         private static readonly GUIContent RaycastLayerMaskContent = new GUIContent("Default Raycast LayerMasks");
 
         private const string ProfileTitle = "Pointer Settings";
@@ -31,7 +32,7 @@ public class MixedRealityPointerProfileInspector : BaseMixedRealityToolkitConfig
         private SerializedProperty gazeCursorPrefab;
         private SerializedProperty gazeProviderType;
         private SerializedProperty useHeadGazeOverride;
-        private SerializedProperty isEyeTrackingEnabled;
+        private SerializedProperty useEyeTrackingDataWhenAvailable;
 
         private static bool showGazeProviderProperties = true;
         private UnityEditor.Editor gazeProviderEditor;
@@ -51,7 +52,7 @@ protected override void OnEnable()
             gazeCursorPrefab = serializedObject.FindProperty("gazeCursorPrefab");
             gazeProviderType = serializedObject.FindProperty("gazeProviderType");
             useHeadGazeOverride = serializedObject.FindProperty("useHeadGazeOverride");
-            isEyeTrackingEnabled = serializedObject.FindProperty("isEyeTrackingEnabled");
+            useEyeTrackingDataWhenAvailable = serializedObject.FindProperty("isEyeTrackingEnabled");
             pointerMediator = serializedObject.FindProperty("pointerMediator");
             primaryPointerSelector = serializedObject.FindProperty("primaryPointerSelector");
         }
@@ -82,7 +83,14 @@ public override void OnInspectorGUI()
                     EditorGUILayout.PropertyField(gazeCursorPrefab, GazeCursorPrefabContent);
                     EditorGUILayout.PropertyField(gazeProviderType);
                     EditorGUILayout.PropertyField(useHeadGazeOverride);
-                    EditorGUILayout.PropertyField(isEyeTrackingEnabled);
+
+                    EditorGUILayout.BeginHorizontal();
+                    EditorGUILayout.PropertyField(useEyeTrackingDataWhenAvailable, UseEyeTrackingDataContent);
+                    // Render a help link for getting started with eyetracking documentation
+                    string helpURL = "https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/input/eye-tracking/eye-tracking-basic-setup";
+                    InspectorUIUtility.RenderDocumentationButton(helpURL);
+                    EditorGUILayout.EndHorizontal();
+
                     EditorGUILayout.Space();
 
                     var gazeProvider = CameraCache.Main.GetComponent<IMixedRealityGazeProvider>();

Assets/MRTK/Core/Interfaces/InputSystem/IMixedRealityEyeGazeProvider.cs

@@ -33,6 +33,7 @@ public interface IMixedRealityEyeGazeProvider : IMixedRealityGazeProvider
 
         /// <summary>
         /// If true, eye-based tracking will be used when available.
+        /// This field does not control whether eye tracking data is provided.
         /// </summary>
         /// <remarks>
         /// <para>The usage of eye-based tracking depends on having the Gaze Input permission set