Merge pull request #231 from open-ephys/issue-106-gui

Add GUI for Neuropixels V1e

Author: bparks13

Directory.Build.props

@@ -15,7 +15,7 @@
     <PackageIcon>icon.png</PackageIcon>
     <VersionPrefix>0.2.0</VersionPrefix>
     <VersionSuffix></VersionSuffix>
-    <LangVersion>9.0</LangVersion>
+    <LangVersion>10.0</LangVersion>
     <Features>strict</Features>
   </PropertyGroup>
 

OpenEphys.Onix1.Design/Bno055Dialog.Designer.cs

@@ -0,0 +1,42 @@
+using System;
+
+namespace OpenEphys.Onix1.Design
+{
+    /// <summary>
+    /// Simple dialog that attaches the <see cref="ConfigureBno055"/> to a property grid.
+    /// </summary>
+    public partial class Bno055Dialog : GenericDeviceDialog
+    {
+        /// <summary>
+        /// Gets or sets the <see cref="ConfigureBno055"/>, allowing for changes made in the dialog to be reflected in the main editor.
+        /// </summary>
+        public ConfigureBno055 ConfigureNode
+        {
+            get => (ConfigureBno055)propertyGrid.SelectedObject;
+            set => propertyGrid.SelectedObject = value;
+        }
+
+        /// <summary>
+        /// Initializes a new dialog for the <see cref="ConfigureBno055"/> operator.
+        /// </summary>
+        /// <param name="configureNode"></param>
+        public Bno055Dialog(ConfigureBno055 configureNode)
+        {
+            InitializeComponent();
+            Shown += FormShown;
+
+            ConfigureNode = new(configureNode);
+        }
+
+        private void FormShown(object sender, EventArgs e)
+        {
+            if (!TopLevel)
+            {
+                splitContainer1.Panel2Collapsed = true;
+                splitContainer1.Panel2.Hide();
+
+                MaximumSize = new System.Drawing.Size(0, 0);
+            }
+        }
+    }
+}

OpenEphys.Onix1.Design/Bno055Dialog.cs

@@ -0,0 +1,35 @@
+using Bonsai.Design;
+using System.ComponentModel;
+using System.Windows.Forms;
+using System;
+
+namespace OpenEphys.Onix1.Design
+{
+    /// <summary>
+    /// Class that opens a new dialog for a <see cref="ConfigureBno055"/>.
+    /// </summary>
+    public class Bno055Editor : WorkflowComponentEditor
+    {
+        /// <inheritdoc/>
+        public override bool EditComponent(ITypeDescriptorContext context, object component, IServiceProvider provider, IWin32Window owner)
+        {
+            if (provider != null)
+            {
+                var editorState = (IWorkflowEditorState)provider.GetService(typeof(IWorkflowEditorState));
+                if (editorState != null && !editorState.WorkflowRunning && component is ConfigureBno055 configureBno055)
+                {
+                    using var editorDialog = new Bno055Dialog(configureBno055);
+
+                    if (editorDialog.ShowDialog() == DialogResult.OK)
+                    {
+                        configureBno055.Enable = editorDialog.ConfigureNode.Enable;
+
+                        return true;
+                    }
+                }
+            }
+
+            return false;
+        }
+    }
+}

OpenEphys.Onix1.Design/Bno055Editor.cs

@@ -44,6 +44,8 @@ public ChannelConfigurationDialog(ProbeGroup probeGroup)
 
             SelectedContacts = new bool[ChannelConfiguration.NumberOfContacts];
 
+            ReferenceContacts = new List<int>();
+
             zedGraphChannels.MouseDownEvent += MouseDownEvent;
             zedGraphChannels.MouseMoveEvent += MouseMoveEvent;
             zedGraphChannels.MouseUpEvent += MouseUpEvent;
@@ -630,10 +632,34 @@ internal virtual void HighlightEnabledContacts()
 
                 foreach (var contact in contactsToEnable)
                 {
-                    var tag = (ContactTag)contact.Tag;
+                    contact.Fill.Color = EnabledContactFill;
+                }
+            }
+
+            HighlightReferenceContacts();
+        }
 
-                    contact.Fill.Color = ReferenceContacts.Any(x => x == tag.ContactIndex) ? ReferenceContactFill : EnabledContactFill;
+        internal void HighlightReferenceContacts()
+        {
+            if (ChannelConfiguration == null)
+                return;
+
+            var contactObjects = zedGraphChannels.GraphPane.GraphObjList.OfType<BoxObj>()
+                                                                        .Where(c => c is not PolyObj);
+
+            var referenceContacts = contactObjects.Where(c =>
+            {
+                if (c.Tag is ContactTag tag)
+                {
+                    return ReferenceContacts.Any(r => tag.ContactIndex == r);
                 }
+
+                return false;
+            });
+
+            foreach (var contact in referenceContacts)
+            {
+                contact.Fill.Color = ReferenceContactFill;
             }
         }
 
@@ -1079,7 +1105,6 @@ private bool MouseMoveEvent(ZedGraphControl sender, MouseEventArgs e)
         private bool MouseUpEvent(ZedGraphControl sender, MouseEventArgs e)
         {
             sender.Cursor = Cursors.Arrow;
-
             if (e.Button == MouseButtons.Left)
             {
                 if (sender.GraphPane.GraphObjList[SelectionAreaTag] is BoxObj selectionArea && selectionArea != null && ChannelConfiguration != null)
@@ -1095,7 +1120,6 @@ private bool MouseUpEvent(ZedGraphControl sender, MouseEventArgs e)
                                                                             {
                                                                                 var x = c.Location.X + c.Location.Width / 2;
                                                                                 var y = c.Location.Y - c.Location.Height / 2;
-
                                                                                 return c is not PolyObj &&
                                                                                         x >= rect.X &&
                                                                                         x <= rect.X + rect.Width &&

OpenEphys.Onix1.Design/ChannelConfigurationDialog.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 
 namespace OpenEphys.Onix1.Design
 {

OpenEphys.Onix1.Design/ContactTag.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;

OpenEphys.Onix1.Design/DesignHelper.cs

@@ -0,0 +1,42 @@
+using System;
+
+namespace OpenEphys.Onix1.Design
+{
+    /// <summary>
+    /// Partial class to create a GUI for <see cref="ConfigureNeuropixelsV1eBno055"/>.
+    /// </summary>
+    public partial class NeuropixelsV1eBno055Dialog : GenericDeviceDialog
+    {
+        /// <summary>
+        /// Gets or sets the <see cref="ConfigureNeuropixelsV1eBno055"/> object attached to
+        /// the property grid.
+        /// </summary>
+        public ConfigureNeuropixelsV1eBno055 ConfigureNode
+        {
+            get => (ConfigureNeuropixelsV1eBno055)propertyGrid.SelectedObject;
+            set => propertyGrid.SelectedObject = value;
+        }
+
+        /// <summary>
+        /// Initializes a new <see cref="NeuropixelsV1eBno055Dialog"/> instance with the given
+        /// <see cref="ConfigureNeuropixelsV1eBno055"/> object.
+        /// </summary>
+        /// <param name="configureNode">A <see cref="ConfigureNeuropixelsV1eBno055"/> object that contains configuration settings.</param>
+        public NeuropixelsV1eBno055Dialog(ConfigureNeuropixelsV1eBno055 configureNode)
+        {
+            InitializeComponent();
+            Shown += FormShown;
+
+            ConfigureNode = new(configureNode);
+        }
+
+        private void FormShown(object sender, EventArgs e)
+        {
+            if (!TopLevel)
+            {
+                splitContainer1.Panel2Collapsed = true;
+                splitContainer1.Panel2.Hide();
+            }
+        }
+    }
+}

OpenEphys.Onix1.Design/NeuropixelsV1eBno055Dialog.Designer.cs

@@ -0,0 +1,31 @@
+using System;
+using System.ComponentModel;
+using Bonsai.Design;
+using System.Windows.Forms;
+
+namespace OpenEphys.Onix1.Design
+{
+    internal class NeuropixelsV1eBno055Editor : WorkflowComponentEditor
+    {
+        public override bool EditComponent(ITypeDescriptorContext context, object component, IServiceProvider provider, IWin32Window owner)
+        {
+            if (provider != null)
+            {
+                var editorState = (IWorkflowEditorState)provider.GetService(typeof(IWorkflowEditorState));
+                if (editorState != null && !editorState.WorkflowRunning && component is ConfigureNeuropixelsV1eBno055 configureBno055)
+                {
+                    using var editorDialog = new NeuropixelsV1eBno055Dialog(configureBno055);
+
+                    if (editorDialog.ShowDialog() == DialogResult.OK)
+                    {
+                        configureBno055.Enable = editorDialog.ConfigureNode.Enable;
+
+                        return true;
+                    }
+                }
+            }
+
+            return false;
+        }
+    }
+}