Merge branch 'mrtk_development' into feature/doc_contribute

Author: thalbern

Assets/MixedRealityToolkit.Examples/Demos/EyeTracking/Demo_ScrollPanZoom/Scripts/BaseClasses/PanZoomBase.cs

@@ -27,23 +27,23 @@ public abstract class PanZoomBase : MonoBehaviour,
         /// Ability to pan using your eye gaze without any additional input (e.g., air tap or 
         /// button presses).  
         /// </summary>
-        internal bool AutoGazePanIsActive = true;
+        internal bool autoGazePanIsActive = true;
 
         /// <summary>
         ///  Horizontal panning speed. For example: 0.1f for slow panning. 0.6f for fast panning.
         /// </summary>
-        internal float PanSpeedLeftRight; // Comment: This could be improved by using panning step sizes depending on the zoom level. 
+        internal float panSpeedLeftRight; // Comment: This could be improved by using panning step sizes depending on the zoom level. 
 
         /// <summary>
         /// Vertical panning speed. For example: 0.1f for slow panning. 0.6f for fast panning.  
         /// </summary>
-        internal float PanSpeedUpDown;
+        internal float panSpeedUpDown;
 
         /// <summary>
         /// Minimal distance in x and y from center of the target (0, 0) to trigger panning. Thus, 
         /// values must range between 0 (always panning) and 0.5 (no panning).
         /// </summary>
-        internal Vector2 MinDistFromCenterForAutoPan = new Vector2(0.2f, 0.2f);
+        internal Vector2 minDistFromCenterForAutoPan = new Vector2(0.2f, 0.2f);
 
         // ZOOM
         /// <summary>
@@ -68,11 +68,6 @@ public abstract class PanZoomBase : MonoBehaviour,
         /// </summary>
         internal float ZoomMaxScale = 1.0f;
 
-        /// <summary>
-        /// Type of hand gesture to use for zooming
-        /// </summary>
-        internal MixedRealityInputAction ZoomGesture;
-
         /// <summary>
         /// Size of the GameObject's collider when being looked at.
         /// </summary>        
@@ -121,7 +116,7 @@ public abstract class PanZoomBase : MonoBehaviour,
         private Vector3 navPos = Vector3.zero;
         private bool isFocused = false;
         internal bool isZooming = false;
-        public bool handZoomEnabledOnStartup = false;
+        internal bool ZoomGestureEnabledOnStartup = false;
         private bool handZoomEnabled = false;
 
         protected Vector3 originalRatio;
@@ -145,7 +140,7 @@ protected virtual void Start()
         {
             // Init children
             Initialize();
-            handZoomEnabled = handZoomEnabledOnStartup;
+            handZoomEnabled = ZoomGestureEnabledOnStartup;
             Initialize();
 
             // Init eye tracking target
@@ -176,8 +171,8 @@ private Vector3 CustomColliderSizeOnLookAt
 
         public void AutoPan()
         {
-            PanHorizontally(ComputePanSpeed(cursorPos.x, PanSpeedLeftRight, MinDistFromCenterForAutoPan.x));
-            PanVertically(ComputePanSpeed(cursorPos.y, PanSpeedUpDown, MinDistFromCenterForAutoPan.y));
+            PanHorizontally(ComputePanSpeed(cursorPos.x, panSpeedLeftRight, minDistFromCenterForAutoPan.x));
+            PanVertically(ComputePanSpeed(cursorPos.y, panSpeedUpDown, minDistFromCenterForAutoPan.y));
         }
 
         /// <summary>
@@ -379,7 +374,7 @@ private void LateUpdate()
         /// </summary>
         private void AutomaticGazePanning()
         {
-            if (AutoGazePanIsActive)
+            if (autoGazePanIsActive)
             {
                 AutoPan();
             }

Assets/MixedRealityToolkit.Examples/Demos/EyeTracking/Demo_ScrollPanZoom/Scripts/BaseClasses/PanZoomBase_RectTransf.cs

@@ -56,8 +56,8 @@ public override void ZoomIn()
             ZoomInOut_RectTransform(zoomDir * zoomSpeed, cursorPos);
 
             // Panning across entire target (-0.5, +0.5) to move target of interest towards center while zooming in
-            PanHorizontally(ComputePanSpeed(cursorPos.x, PanSpeedLeftRight, MinDistFromCenterForAutoPan.x));
-            PanVertically(ComputePanSpeed(cursorPos.y, PanSpeedUpDown, MinDistFromCenterForAutoPan.y));
+            PanHorizontally(ComputePanSpeed(cursorPos.x, panSpeedLeftRight, minDistFromCenterForAutoPan.x));
+            PanVertically(ComputePanSpeed(cursorPos.y, panSpeedUpDown, minDistFromCenterForAutoPan.y));
         }
 
         public override void ZoomOut()

Assets/MixedRealityToolkit.Examples/Demos/EyeTracking/Demo_ScrollPanZoom/Scripts/BaseClasses/PanZoomBase_Texture.cs

@@ -26,8 +26,9 @@ public string TextureShaderProperty
             }
         }
 
+        [Tooltip("Underlying aspect ratio of the loaded texture to correctly determine scaling.")]
         [SerializeField]
-        private float DefaultAspectRatio = 1.0f;
+        private float defaultAspectRatio = 1.0f;
 
         private float aspectRatio = -1;
 
@@ -37,7 +38,7 @@ public override void Initialize()
         {
             if (aspectRatio == -1)
             {
-                Initialize(DefaultAspectRatio);
+                Initialize(defaultAspectRatio);
             }
             else
             {
@@ -141,8 +142,8 @@ public override void ZoomIn()
                 ZoomInOut(zoomDir * zoomSpeed, cursorPos);
 
                 // Panning across entire target (-0.5, +0.5) to move target of interest towards center while zooming in
-                PanHorizontally(ComputePanSpeed(cursorPos.x, PanSpeedLeftRight, MinDistFromCenterForAutoPan.x));
-                PanVertically(ComputePanSpeed(cursorPos.y, PanSpeedUpDown, MinDistFromCenterForAutoPan.y));
+                PanHorizontally(ComputePanSpeed(cursorPos.x, panSpeedLeftRight, minDistFromCenterForAutoPan.x));
+                PanVertically(ComputePanSpeed(cursorPos.y, panSpeedUpDown, minDistFromCenterForAutoPan.y));
             }
         }
 

Assets/MixedRealityToolkit.Examples/Demos/EyeTracking/Demo_ScrollPanZoom/Scripts/PanZoom_RectTransf.cs

@@ -13,111 +13,107 @@ public class PanZoom_RectTransf : PanZoomBase_RectTransf
     {
         [Tooltip("RectTransform from, for example, your TextMeshPro game object.")]
         [SerializeField]
-        private RectTransform RectTransfToNavigate = null;
+        private RectTransform rectTransfToNavigate = null;
 
         [Tooltip("Reference to the viewport restricting the viewbox. This is important for identifying the max constrains for panning.")]
         [SerializeField]
-        private RectTransform RefToViewPort = null;
+        private RectTransform refToViewPort = null;
 
-        // Scroll
-        [Tooltip("Ability to scroll using your eye gaze without any additional input (e.g., air tap or button presses).")]
+        // Zoom
+        [Tooltip("Zoom acceleration defining the steepness of logistic speed function mapping.")]
         [SerializeField]
-        private bool AutoGazeScrollIsActive = true;
+        private float zoomAcceleration = 10f;
 
-        [Tooltip("Horizontal scroll speed. For example: 0.1f for slow panning. 0.6f for fast panning.")]
+        [Tooltip("Maximum zoom speed.")]
         [SerializeField]
-        private float ScrollSpeed_x = 0.2f;
+        private float zoomSpeedMax = 0.02f;
 
-        [Tooltip("Vertical scroll speed. For example: 0.1f for slow panning. 0.6f for fast panning.")]
+        [Tooltip("Minimum scale of the texture for zoom in - e.g., 0.5f (half the original size)")]
         [SerializeField]
-        private float ScrollSpeed_y = 0.2f;
+        private float zoomMinScale = 0.1f;
 
-        [Tooltip("Minimal distance in x and y from center of the target's hit box (0, 0) to scroll. Thus, values must range between 0 (always scroll) and 0.5 (no scroll).")]
+        [Tooltip("Maximum scale of the texture for zoom out - e.g., 1f (the original size) or 2.0f (double the original size).")]
         [SerializeField]
-        private Vector2 MinDistFromCenterForAutoScroll = new Vector2(0.2f, 0.2f);
+        private float zoomMaxScale = 1.0f;
 
-        [Tooltip("Set to true to prevent sudden scrolling when quickly looking around. This may make scrolling feel less responsive though.")]
+        [Tooltip("Timed zoom: Once triggered, a zoom in/out will be performed for the given amount of time in seconds.")]
         [SerializeField]
-        private bool UseSkimProofing = false;
+        private float zoomTimeInSecToZoom = 0.5f;
 
-        [Tooltip("The lower the value, the slower the scrolling will speed up after skimming. Recommended value: 5.")]
+        [Tooltip("Enable or disable hand gestures for zooming on startup.")]
         [SerializeField]
-        [Range(0, 10)]
-        private float SkimProofUpdateSpeed = 5f;
+        private bool zoomGestureEnabledOnStartup = false;
 
-        // Zoom
-        [Tooltip("Zoom acceleration defining the steepness of logistic speed function mapping.")]
+        // Pan
+        [Tooltip("Ability to scroll using your eye gaze without any additional input (e.g., air tap or button presses).")]
         [SerializeField]
-        private float Zoom_Acceleration = 10f;
+        private bool panAutoScrollIsActive = true;
 
-        [Tooltip("Maximum zoom speed.")]
+        [Tooltip("Horizontal scroll speed. For example: 0.1f for slow panning. 0.6f for fast panning.")]
         [SerializeField]
-        private float Zoom_SpeedMax = 0.02f;
+        private float panSpeedHorizontal = 0.3f;
 
-        [Tooltip("Minimum scale of the texture for zoom in - e.g., 0.5f (half the original size)")]
+        [Tooltip("Vertical scroll speed. For example: 0.1f for slow panning. 0.6f for fast panning.")]
         [SerializeField]
-        private float Zoom_MinScale = 0.1f;
+        private float panSpeedVertical = 0.3f;
 
-        [Tooltip("Maximum scale of the texture for zoom out - e.g., 1f (the original size) or 2.0f (double the original size).")]
+        [Tooltip("Minimal distance in x and y from center of the target's hit box (0, 0) to scroll. Thus, values must range between 0 (always scroll) and 0.5 (no scroll).")]
         [SerializeField]
-        private float Zoom_MaxScale = 1.0f;
+        private Vector2 panMinDistFromCenter = new Vector2(0.2f, 0.2f);
 
-        [Tooltip("Timed zoom: Once triggered, a zoom in/out will be performed for the given amount of time in seconds.")]
+        [Tooltip("Set to true to prevent sudden scrolling when quickly looking around. This may make scrolling feel less responsive though.")]
         [SerializeField]
-        private float Zoom_TimeInSecToZoom = 0.5f;
+        private bool useSkimProofing = false;
 
-        [Tooltip("Type of hand gesture to use to zoom in/out.")]
+        [Tooltip("The lower the value, the slower the scrolling will speed up after skimming. Recommended value: 5.")]
         [SerializeField]
-        private MixedRealityInputAction Zoom_Gesture = MixedRealityInputAction.None;
-
-        // The base PanAndZoom class can also be used with UV textures for which the dimensions are different to a RectTransform.
-        // To allow to keep the speed values that users can assign consistent, let's internally convert the values.
-        private float convertSpeedToUVSpace = -200.0f;
+        [Range(0, 10)]
+        private float skimProofUpdateSpeed = 5f;
 
         protected override void Start()
         {
             // Assigning values to base PanZoom class
-            AutoGazePanIsActive = AutoGazeScrollIsActive;
-            PanSpeedLeftRight = ScrollSpeed_x * convertSpeedToUVSpace;
-            PanSpeedUpDown = ScrollSpeed_y * convertSpeedToUVSpace;
-            MinDistFromCenterForAutoPan = MinDistFromCenterForAutoScroll;
-            useSkimProof = UseSkimProofing;
+            // Zoom
+            ZoomAcceleration = zoomAcceleration;
+            ZoomSpeedMax = zoomSpeedMax;
+            ZoomMinScale = zoomMinScale;
+            ZoomMaxScale = zoomMaxScale;
+            ZoomGestureEnabledOnStartup = zoomGestureEnabledOnStartup;
+            timeInSecondsToZoom = zoomTimeInSecToZoom;
+
+            // Pan
+            autoGazePanIsActive = panAutoScrollIsActive;
+            panSpeedLeftRight = panSpeedHorizontal;
+            panSpeedUpDown = panSpeedVertical;
+            minDistFromCenterForAutoPan = panMinDistFromCenter;
+            useSkimProof = useSkimProofing;
 
             // Set up rect transform
-            viewportRectTransf = RefToViewPort;
-            navRectTransf = RectTransfToNavigate;
+            viewportRectTransf = refToViewPort;
+            navRectTransf = rectTransfToNavigate;
             navRectTransf.anchorMin = new Vector2(0.5f, 0.5f);
             navRectTransf.anchorMax = new Vector2(0.5f, 0.5f);
             navRectTransf.pivot = new Vector2(0.5f, 0.5f);
 
-            // Zoom
-            ZoomAcceleration = Zoom_Acceleration;
-            ZoomSpeedMax = Zoom_SpeedMax;
-            ZoomMinScale = Zoom_MinScale;
-            ZoomMaxScale = Zoom_MaxScale;
-            ZoomGesture = Zoom_Gesture;
-            timeInSecondsToZoom = Zoom_TimeInSecToZoom;
-
             base.Start();
         }
 
         protected override void Update()
         {
-            UpdateValues(ref navRectTransf, RectTransfToNavigate);
-            UpdateValues(ref ZoomAcceleration, Zoom_Acceleration);
-            UpdateValues(ref ZoomSpeedMax, Zoom_SpeedMax);
-            UpdateValues(ref ZoomMinScale, Zoom_MinScale);
-            UpdateValues(ref ZoomMaxScale, Zoom_MaxScale);
-            UpdateValues(ref ZoomGesture, Zoom_Gesture);
-            UpdateValues(ref timeInSecondsToZoom, Zoom_TimeInSecToZoom);
-
-            UpdateValues(ref AutoGazePanIsActive, AutoGazeScrollIsActive);
-            UpdateValues(ref PanSpeedLeftRight, ScrollSpeed_x * convertSpeedToUVSpace);
-            UpdateValues(ref PanSpeedUpDown, ScrollSpeed_y * convertSpeedToUVSpace);
-            UpdateValues(ref MinDistFromCenterForAutoPan, MinDistFromCenterForAutoScroll);
-            UpdateValues(ref useSkimProof, UseSkimProofing);
-
-            if (UpdateValues(ref skimproof_UpdateSpeedFromUser, SkimProofUpdateSpeed))
+            UpdateValues(ref navRectTransf, rectTransfToNavigate);
+            UpdateValues(ref ZoomAcceleration, zoomAcceleration);
+            UpdateValues(ref ZoomSpeedMax, zoomSpeedMax);
+            UpdateValues(ref ZoomMinScale, zoomMinScale);
+            UpdateValues(ref ZoomMaxScale, zoomMaxScale);
+            UpdateValues(ref timeInSecondsToZoom, zoomTimeInSecToZoom);
+
+            UpdateValues(ref autoGazePanIsActive, panAutoScrollIsActive);
+            UpdateValues(ref panSpeedLeftRight, panSpeedHorizontal);
+            UpdateValues(ref panSpeedUpDown, panSpeedVertical);
+            UpdateValues(ref minDistFromCenterForAutoPan, panMinDistFromCenter);
+            UpdateValues(ref useSkimProof, useSkimProofing);
+
+            if (UpdateValues(ref skimproof_UpdateSpeedFromUser, skimProofUpdateSpeed))
             {
                 SetSkimProofUpdateSpeed(skimproof_UpdateSpeedFromUser);
             }