225-partial Ephys Link stuff (#241)

* Switched Communication Manager to use properties

* Changed comment style

* ProbeConnectionSettingsPanel.cs

* Converted ephys link stuff in ProbeManager.cs

Author: kjy5

Assets/Scripts/EphysLink/CommunicationManager.cs

@@ -21,9 +21,18 @@ public class CommunicationManager : MonoBehaviour
 
         #region Properties
 
+        /// <summary>
+        ///     The current state of the connection to Ephys Link.
+        /// </summary>
+        public bool IsConnected { get; private set; }
+
+
+        #region Private
+
         private string _serverIp;
         private int _serverPort;
-        private bool _isConnected;
+
+        #endregion
 
         #endregion
 
@@ -81,7 +90,7 @@ public void ConnectToServer(string ip, int port, Action onConnected = null,
                 Debug.Log("Connected to WebSocket server at " + ip + ":" + port);
                 _serverIp = ip;
                 _serverPort = port;
-                _isConnected = true;
+                IsConnected = true;
                 PlayerPrefs.SaveEphysLinkConnectionData(ip, port);
                 onConnected?.Invoke();
             });
@@ -90,7 +99,7 @@ public void ConnectToServer(string ip, int port, Action onConnected = null,
                 var connectionErrorMessage =
                     "Error connecting to server at " + ip + ":" + port + ". Check server for details.";
                 Debug.LogWarning(connectionErrorMessage);
-                _isConnected = false;
+                IsConnected = false;
                 _connectionManager.Close();
                 _connectionManager = null;
                 _socket = null;
@@ -100,7 +109,7 @@ public void ConnectToServer(string ip, int port, Action onConnected = null,
             {
                 var connectionTimeoutMessage = "Connection to server at " + ip + ":" + port + " timed out";
                 Debug.LogWarning(connectionTimeoutMessage);
-                _isConnected = false;
+                IsConnected = false;
                 _connectionManager.Close();
                 _connectionManager = null;
                 _socket = null;
@@ -115,37 +124,10 @@ public void ConnectToServer(string ip, int port, Action onConnected = null,
         public void DisconnectFromServer(Action onDisconnected = null)
         {
             _connectionManager.Close();
-            _isConnected = false;
+            IsConnected = false;
             onDisconnected?.Invoke();
         }
 
-        /// <summary>
-        ///     Return the stored server IP address.
-        /// </summary>
-        /// <returns>Stored server IP address (can be an empty string)</returns>
-        public string GetServerIp()
-        {
-            return _serverIp;
-        }
-
-        /// <summary>
-        ///     Return the stored server port.
-        /// </summary>
-        /// <returns>Stored server port (can be 0)</returns>
-        public int GetServerPort()
-        {
-            return _serverPort;
-        }
-
-        /// <summary>
-        ///     Return if the server is connected.
-        /// </summary>
-        /// <returns>True if the server is connected, false otherwise</returns>
-        public bool IsConnected()
-        {
-            return _isConnected;
-        }
-
         #endregion
 
         #region Event Handlers

Assets/Scripts/Settings/EphysLinkSettings.cs

@@ -72,7 +72,7 @@ private void Awake()
         private void FixedUpdate()
         {
             // Update probe panels whenever they change
-            if (_trajectoryPlannerManager.GetAllProbes().Count(manager => !manager.IsGhost()) !=
+            if (_trajectoryPlannerManager.GetAllProbes().Count(manager => !manager.IsGhost) !=
                 _probeIdToProbeConnectionSettingsPanels.Count)
                 UpdateProbePanels();
         }
@@ -95,12 +95,12 @@ private void UpdateConnectionUI()
         {
             // Connection UI
             connectionErrorText.text = "";
-            connectButtonText.text = _communicationManager.IsConnected() ? "Disconnect" : "Connect";
+            connectButtonText.text = _communicationManager.IsConnected ? "Disconnect" : "Connect";
             serverConnectedText.text =
-                (_communicationManager.IsConnected() ? "Connected" : "Connect") + " to server at";
+                (_communicationManager.IsConnected ? "Connected" : "Connect") + " to server at";
 
             // Update available manipulators and their panels
-            if (_communicationManager.IsConnected())
+            if (_communicationManager.IsConnected)
             {
                 UpdateManipulatorPanelAndSelection();
             }
@@ -119,7 +119,7 @@ private void UpdateProbePanels()
             var handledProbeIds = new HashSet<int>();
 
             // Add any new probes in scene to list
-            foreach (var probeManager in _trajectoryPlannerManager.GetAllProbes().Where(manager => !manager.IsGhost()))
+            foreach (var probeManager in _trajectoryPlannerManager.GetAllProbes().Where(manager => !manager.IsGhost))
             {
                 var probeId = probeManager.GetID();
 
@@ -132,7 +132,7 @@ private void UpdateProbePanels()
                         probeConnectionSettingsPanelGameObject.GetComponent<ProbeConnectionSettingsPanel>();
 
                     probeConnectionSettingsPanel.SetProbeManager(probeManager);
-                    probeConnectionSettingsPanel.SetEphysLinkSettings(this);
+                    probeConnectionSettingsPanel.EphysLinkSettings = this;
 
                     _probeIdToProbeConnectionSettingsPanels.Add(probeId,
                         new ValueTuple<ProbeConnectionSettingsPanel, GameObject>(probeConnectionSettingsPanel,
@@ -168,14 +168,14 @@ public void UpdateManipulatorPanelAndSelection()
             {
                 // Update probes with selectable options
                 var usedManipulatorIds = _trajectoryPlannerManager.GetAllProbes()
-                    .Where(probeManager => probeManager.IsConnectedToManipulator())
-                    .Select(probeManager => probeManager.GetManipulatorId()).ToHashSet();
+                    .Where(probeManager => probeManager.IsEphysLinkControlled)
+                    .Select(probeManager => probeManager.ManipulatorId).ToHashSet();
                 foreach (var probeConnectionSettingsPanel in _probeIdToProbeConnectionSettingsPanels.Values.Select(
                              values => values.probeConnectionSettingsPanel))
                 {
                     var manipulatorDropdownOptions = new List<string> { "-" };
                     manipulatorDropdownOptions.AddRange(availableIds.Where(id =>
-                        id.Equals(probeConnectionSettingsPanel.GetProbeManager().GetManipulatorId()) ||
+                        id.Equals(probeConnectionSettingsPanel.ProbeManager.ManipulatorId) ||
                         !usedManipulatorIds.Contains(id)));
 
                     probeConnectionSettingsPanel.SetManipulatorIdDropdownOptions(manipulatorDropdownOptions);
@@ -221,7 +221,7 @@ public void UpdateManipulatorPanelAndSelection()
         /// </summary>
         public void OnConnectDisconnectPressed()
         {
-            if (!_communicationManager.IsConnected())
+            if (!_communicationManager.IsConnected)
             {
                 // Attempt to connect to server
                 try
@@ -248,8 +248,8 @@ public void OnConnectDisconnectPressed()
                 _questionDialogue.SetYesCallback(() =>
                 {
                     foreach (var probeManager in _trajectoryPlannerManager.GetAllProbes()
-                                 .Where(probeManager => probeManager.IsConnectedToManipulator()))
-                        probeManager.SetEphysLinkMovement(false);
+                                 .Where(probeManager => probeManager.IsEphysLinkControlled))
+                        probeManager.SetIsEphysLinkControlled(false);
 
                     _communicationManager.DisconnectFromServer(UpdateConnectionUI);
                 });

Assets/Scripts/Settings/ProbeConnectionSettingsPanel.cs

@@ -12,6 +12,22 @@ namespace Settings
     /// </summary>
     public class ProbeConnectionSettingsPanel : MonoBehaviour
     {
+        #region Property Getters and Setters
+
+        /// <summary>
+        ///     Set probe manager reference attached to this panel.
+        /// </summary>
+        /// <param name="probeManager">This panel's probe's corresponding probe manager</param>
+        public void SetProbeManager(ProbeManager probeManager)
+        {
+            ProbeManager = probeManager;
+
+            probeIdText.text = probeManager.GetID().ToString();
+            probeIdText.color = probeManager.GetColor();
+        }
+
+        #endregion
+
         #region Unity
 
         private void Awake()
@@ -24,29 +40,29 @@ private void Awake()
         /// </summary>
         private void FixedUpdate()
         {
-            if (!_probeManager.IsConnectedToManipulator()) return;
+            if (!ProbeManager.IsEphysLinkControlled) return;
             // Update display for zero coordinate offset
-            if (_probeManager.GetZeroCoordinateOffset() != _displayedZeroCoordinateOffset)
+            if (ProbeManager.ZeroCoordinateOffset != _displayedZeroCoordinateOffset)
             {
-                _displayedZeroCoordinateOffset = _probeManager.GetZeroCoordinateOffset();
+                _displayedZeroCoordinateOffset = ProbeManager.ZeroCoordinateOffset;
                 xInputField.text = _displayedZeroCoordinateOffset.x.ToString(CultureInfo.CurrentCulture);
                 yInputField.text = _displayedZeroCoordinateOffset.y.ToString(CultureInfo.CurrentCulture);
                 zInputField.text = _displayedZeroCoordinateOffset.z.ToString(CultureInfo.CurrentCulture);
                 dInputField.text = _displayedZeroCoordinateOffset.w.ToString(CultureInfo.CurrentCulture);
             }
 
             // Update brain surface offset drop direction dropdown
-            if (_probeManager.IsSetToDropToSurfaceWithDepth() != (brainSurfaceOffsetDirectionDropdown.value == 0))
+            if (ProbeManager.IsSetToDropToSurfaceWithDepth != (brainSurfaceOffsetDirectionDropdown.value == 0))
                 brainSurfaceOffsetDirectionDropdown.SetValueWithoutNotify(
-                    _probeManager.IsSetToDropToSurfaceWithDepth() ? 0 : 1);
-            
+                    ProbeManager.IsSetToDropToSurfaceWithDepth ? 0 : 1);
+
             // Enable/disable interactivity of brain surface offset axis
-            if (_probeManager.CanChangeBrainSurfaceOffsetAxis() != brainSurfaceOffsetDirectionDropdown.interactable)
-                brainSurfaceOffsetDirectionDropdown.interactable = _probeManager.CanChangeBrainSurfaceOffsetAxis();
+            if (ProbeManager.CanChangeBrainSurfaceOffsetAxis != brainSurfaceOffsetDirectionDropdown.interactable)
+                brainSurfaceOffsetDirectionDropdown.interactable = ProbeManager.CanChangeBrainSurfaceOffsetAxis;
 
             // Update display for brain surface offset
-            if (!(Math.Abs(_probeManager.GetBrainSurfaceOffset() - _displayedBrainSurfaceOffset) > 0.001f)) return;
-            _displayedBrainSurfaceOffset = _probeManager.GetBrainSurfaceOffset();
+            if (!(Math.Abs(ProbeManager.BrainSurfaceOffset - _displayedBrainSurfaceOffset) > 0.001f)) return;
+            _displayedBrainSurfaceOffset = ProbeManager.BrainSurfaceOffset;
             brainSurfaceOffsetInputField.text =
                 _displayedBrainSurfaceOffset.ToString(CultureInfo.CurrentCulture);
         }
@@ -70,8 +86,8 @@ private void FixedUpdate()
 
         #endregion
 
-        private ProbeManager _probeManager;
-        private EphysLinkSettings _ephysLinkSettings;
+        public ProbeManager ProbeManager { get; private set; }
+        public EphysLinkSettings EphysLinkSettings { private get; set; }
         private TrajectoryPlannerManager _trajectoryPlannerManager;
 
         #endregion
@@ -85,40 +101,6 @@ private void FixedUpdate()
 
         #endregion
 
-        #region Property Getters and Setters
-
-        /// <summary>
-        ///     Set probe manager reference attached to this panel.
-        /// </summary>
-        /// <param name="probeManager">This panel's probe's corresponding probe manager</param>
-        public void SetProbeManager(ProbeManager probeManager)
-        {
-            _probeManager = probeManager;
-
-            probeIdText.text = probeManager.GetID().ToString();
-            probeIdText.color = probeManager.GetColor();
-        }
-
-        /// <summary>
-        ///     Get the probe manager attached to this panel.
-        /// </summary>
-        /// <returns>This probe's probe manager</returns>
-        public ProbeManager GetProbeManager()
-        {
-            return _probeManager;
-        }
-
-        /// <summary>
-        ///     Set a reference to the Ephys Link settings panel.
-        /// </summary>
-        /// <param name="ephysLinkSettings">Reference to the Ephys Link settings menu.</param>
-        public void SetEphysLinkSettings(EphysLinkSettings ephysLinkSettings)
-        {
-            _ephysLinkSettings = ephysLinkSettings;
-        }
-
-        #endregion
-
         #region Component Methods
 
         /// <summary>
@@ -131,8 +113,8 @@ public void SetManipulatorIdDropdownOptions(List<string> idOptions)
             manipulatorIdDropdown.AddOptions(idOptions);
 
             // Select the option corresponding to the current manipulator id
-            var indexOfId = _probeManager.IsConnectedToManipulator()
-                ? Math.Max(0, idOptions.IndexOf(_probeManager.GetManipulatorId()))
+            var indexOfId = ProbeManager.IsEphysLinkControlled
+                ? Math.Max(0, idOptions.IndexOf(ProbeManager.ManipulatorId))
                 : 0;
             manipulatorIdDropdown.SetValueWithoutNotify(indexOfId);
         }
@@ -143,29 +125,31 @@ public void SetManipulatorIdDropdownOptions(List<string> idOptions)
         /// <param name="index">Manipulator option index that was selected (0 = no manipulator)</param>
         public void OnManipulatorDropdownValueChanged(int index)
         {
-            if (_probeManager.IsConnectedToManipulator())
-                _probeManager.SetEphysLinkMovement(false, "", false, () =>
+            if (ProbeManager.IsEphysLinkControlled)
+                ProbeManager.SetIsEphysLinkControlled(false, "", false, () =>
                 {
                     if (index != 0)
+                    {
                         AttachToManipulatorAndUpdateUI();
+                    }
                     else
                     {
-                        _ephysLinkSettings.UpdateManipulatorPanelAndSelection();
-                        
+                        EphysLinkSettings.UpdateManipulatorPanelAndSelection();
+
                         // Cleanup ghost prove stuff if applicable
-                        if (!_probeManager.HasGhost()) return;
-                        _trajectoryPlannerManager.DestroyProbe(_probeManager.GetGhostProbeManager());
-                        _probeManager.SetGhostProbeManager(null);
+                        if (!ProbeManager.HasGhost) return;
+                        _trajectoryPlannerManager.DestroyProbe(ProbeManager.GhostProbeManager);
+                        ProbeManager.GhostProbeManager = null;
                     }
                 });
             else
                 AttachToManipulatorAndUpdateUI();
 
             void AttachToManipulatorAndUpdateUI()
             {
-                _probeManager.SetEphysLinkMovement(true,
+                ProbeManager.SetIsEphysLinkControlled(true,
                     manipulatorIdDropdown.options[index].text,
-                    onSuccess: () => { _ephysLinkSettings.UpdateManipulatorPanelAndSelection(); });
+                    onSuccess: () => { EphysLinkSettings.UpdateManipulatorPanelAndSelection(); });
             }
         }
 
@@ -175,7 +159,7 @@ void AttachToManipulatorAndUpdateUI()
         /// <param name="x">X coordinate</param>
         public void OnZeroCoordinateXInputFieldEndEdit(string x)
         {
-            _probeManager.SetZeroCoordinateOffsetX(float.Parse(x));
+            ProbeManager.SetZeroCoordinateOffsetX(float.Parse(x));
         }
 
         /// <summary>
@@ -184,7 +168,7 @@ public void OnZeroCoordinateXInputFieldEndEdit(string x)
         /// <param name="y">Y coordinate</param>
         public void OnZeroCoordinateYInputFieldEndEdit(string y)
         {
-            _probeManager.SetZeroCoordinateOffsetY(float.Parse(y));
+            ProbeManager.SetZeroCoordinateOffsetY(float.Parse(y));
         }
 
         /// <summary>
@@ -193,7 +177,7 @@ public void OnZeroCoordinateYInputFieldEndEdit(string y)
         /// <param name="z">Z coordinate</param>
         public void OnZeroCoordinateZInputFieldEndEdit(string z)
         {
-            _probeManager.SetZeroCoordinateOffsetZ(float.Parse(z));
+            ProbeManager.SetZeroCoordinateOffsetZ(float.Parse(z));
         }
 
         /// <summary>
@@ -202,7 +186,7 @@ public void OnZeroCoordinateZInputFieldEndEdit(string z)
         /// <param name="d">Depth coordinate</param>
         public void OnZeroCoordinateDInputFieldEndEdit(string d)
         {
-            _probeManager.SetZeroCoordinateOffsetDepth(float.Parse(d));
+            ProbeManager.SetZeroCoordinateOffsetDepth(float.Parse(d));
         }
 
         /// <summary>
@@ -211,7 +195,7 @@ public void OnZeroCoordinateDInputFieldEndEdit(string d)
         /// <param name="value">Selected direction: 0 = depth, 1 = DV</param>
         public void OnBrainSurfaceOffsetDirectionDropdownValueChanged(int value)
         {
-            _probeManager.SetDropToSurfaceWithDepth(value == 0);
+            ProbeManager.SetDropToSurfaceWithDepth(value == 0);
         }
 
         /// <summary>
@@ -220,7 +204,7 @@ public void OnBrainSurfaceOffsetDirectionDropdownValueChanged(int value)
         /// <param name="value">Input field value</param>
         public void OnBrainSurfaceOffsetValueUpdated(string value)
         {
-            _probeManager.SetBrainSurfaceOffset(float.Parse(value));
+            ProbeManager.BrainSurfaceOffset = float.Parse(value);
         }
 
         /// <summary>
@@ -229,7 +213,7 @@ public void OnBrainSurfaceOffsetValueUpdated(string value)
         /// <param name="amount">Amount to increment by (negative numbers are valid)</param>
         public void IncrementBrainSurfaceOffset(float amount)
         {
-            _probeManager.IncrementBrainSurfaceOffset(amount);
+            ProbeManager.IncrementBrainSurfaceOffset(amount);
         }
 
         #endregion