Merge pull request #1056 from OpenBCI/simpler-overlap-check

retiutut · web-flow · commit 164969074cb7 · 2022-05-12T09:04:14.000-05:00
Simpler and more comprehensive Cp5 Overlap Checks
diff --git a/OpenBCI_GUI/ControlPanel.pde b/OpenBCI_GUI/ControlPanel.pde
@@ -142,11 +142,13 @@ class ControlPanel {
     public void open(){
         isOpen = true;
         topNav.controlPanelCollapser.setOn();
+        topNav.setDropdownMenuIsOpen(true);
     }
 
     public void close(){
         isOpen = false;
         topNav.controlPanelCollapser.setOff();
+        topNav.setDropdownMenuIsOpen(false);
     }
 
     public String getWifiSearchStyle() {
diff --git a/OpenBCI_GUI/Interactivity.pde b/OpenBCI_GUI/Interactivity.pde
@@ -286,7 +286,7 @@ synchronized void mousePressed() {
             //if clicked out of panel
             else {
                 println("OpenBCI_GUI: mousePressed: outside of CP clicked");
-                controlPanel.isOpen = false;
+                controlPanel.close();
                 topNav.controlPanelCollapser.setOff();
             }
         }
diff --git a/OpenBCI_GUI/OpenBCI_GUI.pde b/OpenBCI_GUI/OpenBCI_GUI.pde
@@ -1007,7 +1007,7 @@ void introAnimation() {
     if ((millis() >= settings.introAnimationInit + settings.introAnimationDuration)
         && controlPanel != null) {
         systemMode = SYSTEMMODE_PREINIT;
-        controlPanel.isOpen = true;
+        controlPanel.open();
     }
     popStyle();
 }
diff --git a/OpenBCI_GUI/TopNav.pde b/OpenBCI_GUI/TopNav.pde
@@ -52,6 +52,8 @@ class TopNav {
     private final int SUBNAV_BUT_H = 26;
     private final int TOPNAV_BUT_H = SUBNAV_BUT_H;
 
+    private boolean topNavDropdownMenuIsOpen = false;
+
     TopNav() {
         int controlPanel_W = 256;
 
@@ -469,7 +471,7 @@ class TopNav {
                 //make Help button and Settings button mutually exclusive
                 if (!tutorialSelector.isVisible) {
                     configSelector.toggleVisibility();
-                }   
+                }
             }
         });
         settingsButton.setDescription("Save and Load GUI Settings! Click Default to revert to factory settings.");
@@ -528,6 +530,14 @@ class TopNav {
         toggleDataStreamingButton.setLock(_b);
         filtersButton.setLock(_b);
     }
+
+    public boolean getDropdownMenuIsOpen() {
+        return topNavDropdownMenuIsOpen;
+    }
+
+    public void setDropdownMenuIsOpen(boolean b) {
+        topNavDropdownMenuIsOpen = b;
+    }
 }
 
 class LayoutSelector {
@@ -621,6 +631,7 @@ class LayoutSelector {
 
     void toggleVisibility() {
         isVisible = !isVisible;
+        topNav.setDropdownMenuIsOpen(isVisible);
         if (isVisible) {
             //the very convoluted way of locking all controllers of a single controlP5 instance...
             for (int i = 0; i < wm.widgets.size(); i++) {
@@ -804,6 +815,7 @@ class ConfigSelector {
 
     void toggleVisibility() {
         isVisible = !isVisible;
+        topNav.setDropdownMenuIsOpen(isVisible);
         if (systemMode >= SYSTEMMODE_POSTINIT) {
             if (isVisible) {
                 //the very convoluted way of locking all controllers of a single controlP5 instance...
@@ -1049,6 +1061,7 @@ class TutorialSelector {
 
     void toggleVisibility() {
         isVisible = !isVisible;
+        topNav.setDropdownMenuIsOpen(isVisible);
         if (systemMode >= SYSTEMMODE_POSTINIT) {
             if (isVisible) {
                 //the very convoluted way of locking all controllers of a single controlP5 instance...
diff --git a/OpenBCI_GUI/W_Accelerometer.pde b/OpenBCI_GUI/W_Accelerometer.pde
@@ -104,7 +104,9 @@ class W_Accelerometer extends Widget {
         }
         
         //ignore top left button interaction when widgetSelector dropdown is active
-        lockElementOnOverlapCheck(accelModeButton);
+        List<controlP5.Controller> cp5ElementsToCheck = new ArrayList<controlP5.Controller>();
+        cp5ElementsToCheck.add((controlP5.Controller)accelModeButton);
+        lockElementsOnOverlapCheck(cp5ElementsToCheck);
         
         if(!accelBoard.canDeactivateAccelerometer() && !(currentBoard instanceof BoardCyton)) {
             accelModeButton.getCaptionLabel().setText("Accel. On");
diff --git a/OpenBCI_GUI/W_AnalogRead.pde b/OpenBCI_GUI/W_AnalogRead.pde
@@ -104,7 +104,9 @@ class W_AnalogRead extends Widget {
         }
 
         //ignore top left button interaction when widgetSelector dropdown is active
-        lockElementOnOverlapCheck(analogModeButton);
+        List<controlP5.Controller> cp5ElementsToCheck = new ArrayList<controlP5.Controller>();
+        cp5ElementsToCheck.add((controlP5.Controller)analogModeButton);
+        lockElementsOnOverlapCheck(cp5ElementsToCheck);
 
         if (!analogBoard.canDeactivateAnalog()) {
             analogModeButton.setLock(true);
diff --git a/OpenBCI_GUI/W_BandPower.pde b/OpenBCI_GUI/W_BandPower.pde
@@ -32,12 +32,15 @@ class W_BandPower extends Widget {
     public ChannelSelect bpChanSelect;
     boolean prevChanSelectIsVisible = false;
 
+    List<controlP5.Controller> cp5ElementsToCheck = new ArrayList<controlP5.Controller>();
+
     W_BandPower(PApplet _parent) {
         super(_parent); //calls the parent CONSTRUCTOR method of Widget (DON'T REMOVE)
 
         //Add channel select dropdown to this widget
         bpChanSelect = new ChannelSelect(pApplet, this, x, y, w, navH, "BP_Channels");
         bpChanSelect.activateAllButtons();
+        cp5ElementsToCheck.addAll(bpChanSelect.getCp5ElementsForOverlapCheck());
         
         //Add settings dropdowns
         addDropdown("Smoothing", "Smooth", Arrays.asList(settings.fftSmoothingArray), smoothFac_ind); //smoothFac_ind is a global variable at the top of W_HeadPlot.pde
@@ -116,6 +119,10 @@ class W_BandPower extends Widget {
         bp_points.add(BETA + 0.5, activePower[BETA], "BETA\n13-32Hz");
         bp_points.add(GAMMA + 0.5, activePower[GAMMA], "GAMMA\n32-100Hz");
         bp_plot.setPoints(bp_points);
+
+        if (bpChanSelect.isVisible()) {
+            lockElementsOnOverlapCheck(cp5ElementsToCheck);
+        }
     } //end of update
 
     void draw() {
diff --git a/OpenBCI_GUI/W_DigitalRead.pde b/OpenBCI_GUI/W_DigitalRead.pde
@@ -93,7 +93,9 @@ class W_DigitalRead extends Widget {
         }
 
         //ignore top left button interaction when widgetSelector dropdown is active
-        lockElementOnOverlapCheck(digitalModeButton);
+        List<controlP5.Controller> cp5ElementsToCheck = new ArrayList<controlP5.Controller>();
+        cp5ElementsToCheck.add((controlP5.Controller)digitalModeButton);
+        lockElementsOnOverlapCheck(cp5ElementsToCheck);
 
         if (!digitalBoard.canDeactivateDigital()) {
             digitalModeButton.setLock(true);
diff --git a/OpenBCI_GUI/W_FFT.pde b/OpenBCI_GUI/W_FFT.pde
@@ -46,12 +46,15 @@ class W_fft extends Widget {
     int FFT_indexLim = int(1.0*xMax*(getNfftSafe()/currentBoard.getSampleRate()));   // maxim value of FFT index
     int yLim = yLimOptions[2];  //maximum value of y axis ... 100 uV
 
+    List<controlP5.Controller> cp5ElementsToCheck = new ArrayList<controlP5.Controller>();
+
     W_fft(PApplet _parent){
         super(_parent); //calls the parent CONSTRUCTOR method of Widget (DON'T REMOVE)
 
         //Add channel select dropdown to this widget
         fftChanSelect = new ChannelSelect(pApplet, this, x, y, w, navH, "BP_Channels");
         fftChanSelect.activateAllButtons();
+        cp5ElementsToCheck.addAll(fftChanSelect.getCp5ElementsForOverlapCheck());
 
         //Default FFT plot settings
         settings.fftMaxFrqSave = 2;
@@ -131,6 +134,10 @@ class W_fft extends Widget {
             flexGPlotSizeAndPosition();
             prevChanSelectIsVisible = fftChanSelect.isVisible();
         }
+
+        if (fftChanSelect.isVisible()) {
+            lockElementsOnOverlapCheck(cp5ElementsToCheck);
+        }
     }
 
     void draw(){
diff --git a/OpenBCI_GUI/W_Focus.pde b/OpenBCI_GUI/W_Focus.pde
@@ -66,14 +66,19 @@ class W_Focus extends Widget {
     private int graphPadding = 30;
     private color cBack, cDark, cMark, cFocus, cWave, cPanel;
 
+    List<controlP5.Controller> cp5ElementsToCheck = new ArrayList<controlP5.Controller>();
+
     W_Focus(PApplet _parent) {
         super(_parent); //calls the parent CONSTRUCTOR method of Widget (DON'T REMOVE)
 
          //Add channel select dropdown to this widget
         focusChanSelect = new ChannelSelect(pApplet, this, x, y, w, navH, "FocusChannelSelect");
         focusChanSelect.activateAllButtons();
+        cp5ElementsToCheck.addAll(focusChanSelect.getCp5ElementsForOverlapCheck());
 
         auditoryNeurofeedback = new AuditoryNeurofeedback(x + PAD_FIVE, y + PAD_FIVE, w/2 - PAD_FIVE*2, navBarHeight/2);
+        cp5ElementsToCheck.add((controlP5.Controller)auditoryNeurofeedback.startStopButton);
+        cp5ElementsToCheck.add((controlP5.Controller)auditoryNeurofeedback.modeButton);
 
         exgChannels = currentBoard.getEXGChannels();
         channelCount = currentBoard.getNumEXGChannels();
@@ -132,10 +137,7 @@ class W_Focus extends Widget {
             predictionExceedsThreshold = metricPrediction > focusThreshold.getValue();
         }
 
-        //ignore top left button interaction when widgetSelector dropdown is active
-        lockElementOnOverlapCheck(auditoryNeurofeedback.startStopButton);
-
-        //put your code here...
+        lockElementsOnOverlapCheck(cp5ElementsToCheck);
     }
 
     public void draw() {
diff --git a/OpenBCI_GUI/W_PulseSensor.pde b/OpenBCI_GUI/W_PulseSensor.pde
@@ -112,7 +112,9 @@ class W_PulseSensor extends Widget {
         }
 
         //ignore top left button interaction when widgetSelector dropdown is active
-        lockElementOnOverlapCheck(analogModeButton);
+        List<controlP5.Controller> cp5ElementsToCheck = new ArrayList<controlP5.Controller>();
+        cp5ElementsToCheck.add((controlP5.Controller)analogModeButton);
+        lockElementsOnOverlapCheck(cp5ElementsToCheck);
 
         if (!analogBoard.canDeactivateAnalog()) {
             analogModeButton.setLock(true);
diff --git a/OpenBCI_GUI/W_TimeSeries.pde b/OpenBCI_GUI/W_TimeSeries.pde
@@ -133,6 +133,8 @@ class W_timeSeries extends Widget {
     private boolean allowSpillover = false;
     private boolean hasScrollbar = true; //used to turn playback scrollbar widget on/off
 
+    List<controlP5.Controller> cp5ElementsToCheck = new ArrayList<controlP5.Controller>();
+
     W_timeSeries(PApplet _parent) {
         super(_parent); //calls the parent CONSTRUCTOR method of Widget (DON'T REMOVE)
 
@@ -143,6 +145,7 @@ class W_timeSeries extends Widget {
         tsChanSelect = new ChannelSelect(pApplet, this, x, y, w, navH, "TS_Channels");
         //activate all channels in channelSelect by default for this widget
         tsChanSelect.activateAllButtons();
+        cp5ElementsToCheck.addAll(tsChanSelect.getCp5ElementsForOverlapCheck());
 
         xF = float(x); //float(int( ... is a shortcut for rounding the float down... so that it doesn't creep into the 1px margin
         yF = float(y);
@@ -199,6 +202,7 @@ class W_timeSeries extends Widget {
 
         if (currentBoard instanceof ADS1299SettingsBoard) {
             hwSettingsButton = createHSCButton("HardwareSettings", "Hardware Settings", (int)(x0 + 80), (int)(y + navHeight + 3), 120, navHeight - 6);
+            cp5ElementsToCheck.add((controlP5.Controller)hwSettingsButton);
             adsSettingsController = new ADS1299SettingsController(_parent, tsChanSelect.activeChan, x_hsc, y_hsc, w_hsc, h_hsc, channelBarHeight);
         }
     }
@@ -234,8 +238,6 @@ class W_timeSeries extends Widget {
             int h_hsc = channelBarHeight * tsChanSelect.activeChan.size();        
             adsSettingsController.resize((int)channelBars[0].plot.getPos()[0], (int)channelBars[0].plot.getPos()[1], (int)channelBars[0].plot.getOuterDim()[0], h_hsc, cb_h);
             adsSettingsController.update(); //update channel controller
-            //ignore top left button interaction when widgetSelector dropdown is active
-            lockElementOnOverlapCheck((controlP5.Controller)hwSettingsButton);
         }
         
         //Update Playback scrollbar and/or display time
@@ -245,6 +247,8 @@ class W_timeSeries extends Widget {
         } else {
             timeDisplay.update();
         }
+
+        lockElementsOnOverlapCheck(cp5ElementsToCheck);
     }
 
     void draw() {
diff --git a/OpenBCI_GUI/Widget.pde b/OpenBCI_GUI/Widget.pde
@@ -24,6 +24,7 @@ class Widget{
 
     protected boolean dropdownIsActive = false;
     private boolean previousDropdownIsActive = false;
+    private boolean previousTopNavDropdownMenuIsOpen = false;
     private boolean widgetSelectorIsActive = false;
 
     private ArrayList<NavBarDropdown> dropdowns;
@@ -286,24 +287,30 @@ class Widget{
             return false;
         }
     }
-    
-    //For use with one Cp5 controller per class/widget. Can only be called once per widget during update loop.
-    protected void lockElementOnOverlapCheck(controlP5.Controller c) {
-        if (dropdownIsActive != previousDropdownIsActive) {
-            //println(c.getName(), " lock == ", dropdownIsActive);
-            c.setLock(dropdownIsActive);
-            previousDropdownIsActive = dropdownIsActive;
-        }
-    }
 
     //For use with multiple Cp5 controllers per class/widget. Can only be called once per widget during update loop.
     protected void lockElementsOnOverlapCheck(List<controlP5.Controller> listOfControllers) {
+        //Check against TopNav Menus
+        if (topNav.getDropdownMenuIsOpen() != previousTopNavDropdownMenuIsOpen) {
+            for (controlP5.Controller c : listOfControllers) {
+                if (c == null) {
+                    continue; //Gracefully skip over a controller if it is null
+                }
+                //println(widgetTitle, " ", c.getName(), " lock because of topnav == ", topNav.getDropdownMenuIsOpen());
+                c.setLock(topNav.getDropdownMenuIsOpen());
+            }
+            previousTopNavDropdownMenuIsOpen = topNav.getDropdownMenuIsOpen();
+            if (previousTopNavDropdownMenuIsOpen) {
+                return;
+            }
+        }
+        //Check against Widget Dropdowns
         if (dropdownIsActive != previousDropdownIsActive) {
             for (controlP5.Controller c : listOfControllers) {
                 if (c == null) {
                     continue; //Gracefully skip over a controller if it is null
                 }
-                //println(c.getName(), " lock == ", dropdownIsActive);
+                //println(widgetTitle, " ", c.getName(), " lock because of widget navbar dropdown == ", dropdownIsActive);
                 c.setLock(dropdownIsActive);
             } 
             previousDropdownIsActive = dropdownIsActive;
@@ -402,7 +409,7 @@ class ChannelSelect {
     private int labelWidth = 0;
     private int labelSpacer = 0;
     private String firstRowLabel = "Top";
-    private String secondRowLabel = "Bottom";
+    private String secondRowLabel = "Bot";
 
     ChannelSelect(PApplet _parent, Widget _widget, int _x, int _y, int _w, int _navH, String checkBoxName) {
         widget = _widget;
@@ -572,7 +579,7 @@ class ChannelSelect {
     public void setIsDualChannelSelect(boolean b) {
         isDualChannelSelect = b;
         if (isDualChannelSelect) {
-            labelWidth = 36;
+            labelWidth = 28;
             labelSpacer = 4;
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -142,11 +142,13 @@ class ControlPanel {`
`142`	`142`	`public void open(){`
`143`	`143`	`isOpen = true;`
`144`	`144`	`topNav.controlPanelCollapser.setOn();`
	`145`	`+ topNav.setDropdownMenuIsOpen(true);`
`145`	`146`	`}`
`146`	`147`
`147`	`148`	`public void close(){`
`148`	`149`	`isOpen = false;`
`149`	`150`	`topNav.controlPanelCollapser.setOff();`
	`151`	`+ topNav.setDropdownMenuIsOpen(false);`
`150`	`152`	`}`
`151`	`153`
`152`	`154`	`public String getWifiSearchStyle() {`
Original file line number	Diff line number	Diff line change
`@@ -286,7 +286,7 @@ synchronized void mousePressed() {`
`286`	`286`	`//if clicked out of panel`
`287`	`287`	`else {`
`288`	`288`	`println("OpenBCI_GUI: mousePressed: outside of CP clicked");`
`289`		`- controlPanel.isOpen = false;`
	`289`	`+ controlPanel.close();`
`290`	`290`	`topNav.controlPanelCollapser.setOff();`
`291`	`291`	`}`
`292`	`292`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1007,7 +1007,7 @@ void introAnimation() {`
`1007`	`1007`	`if ((millis() >= settings.introAnimationInit + settings.introAnimationDuration)`
`1008`	`1008`	`&& controlPanel != null) {`
`1009`	`1009`	`systemMode = SYSTEMMODE_PREINIT;`
`1010`		`- controlPanel.isOpen = true;`
	`1010`	`+ controlPanel.open();`
`1011`	`1011`	`}`
`1012`	`1012`	`popStyle();`
`1013`	`1013`	`}`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,9 @@ class W_Accelerometer extends Widget {`
`104`	`104`	`}`
`105`	`105`
`106`	`106`	`//ignore top left button interaction when widgetSelector dropdown is active`
`107`		`- lockElementOnOverlapCheck(accelModeButton);`
	`107`	`+ List<controlP5.Controller> cp5ElementsToCheck = new ArrayList<controlP5.Controller>();`
	`108`	`+ cp5ElementsToCheck.add((controlP5.Controller)accelModeButton);`
	`109`	`+ lockElementsOnOverlapCheck(cp5ElementsToCheck);`
`108`	`110`
`109`	`111`	`if(!accelBoard.canDeactivateAccelerometer() && !(currentBoard instanceof BoardCyton)) {`
`110`	`112`	`accelModeButton.getCaptionLabel().setText("Accel. On");`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,9 @@ class W_AnalogRead extends Widget {`
`104`	`104`	`}`
`105`	`105`
`106`	`106`	`//ignore top left button interaction when widgetSelector dropdown is active`
`107`		`- lockElementOnOverlapCheck(analogModeButton);`
	`107`	`+ List<controlP5.Controller> cp5ElementsToCheck = new ArrayList<controlP5.Controller>();`
	`108`	`+ cp5ElementsToCheck.add((controlP5.Controller)analogModeButton);`
	`109`	`+ lockElementsOnOverlapCheck(cp5ElementsToCheck);`
`108`	`110`
`109`	`111`	`if (!analogBoard.canDeactivateAnalog()) {`
`110`	`112`	`analogModeButton.setLock(true);`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,9 @@ class W_DigitalRead extends Widget {`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`//ignore top left button interaction when widgetSelector dropdown is active`
`96`		`- lockElementOnOverlapCheck(digitalModeButton);`
	`96`	`+ List<controlP5.Controller> cp5ElementsToCheck = new ArrayList<controlP5.Controller>();`
	`97`	`+ cp5ElementsToCheck.add((controlP5.Controller)digitalModeButton);`
	`98`	`+ lockElementsOnOverlapCheck(cp5ElementsToCheck);`
`97`	`99`
`98`	`100`	`if (!digitalBoard.canDeactivateDigital()) {`
`99`	`101`	`digitalModeButton.setLock(true);`