Remove usage of pApplet from Widget class and instead use global existing ourApplet variable and clean up legacy comments in Widgets

Author: retiutut

OpenBCI_GUI/ADS1299SettingsController.pde

@@ -64,14 +64,14 @@ class ADS1299SettingsController {
     protected int channelCount;
     protected List<Integer> activeChannels;
 
-    ADS1299SettingsController(PApplet _parent, List<Integer> _activeChannels, int _x, int _y, int _w, int _h, int _channelBarHeight) {
+    ADS1299SettingsController(PApplet _parentApplet, List<Integer> _activeChannels, int _x, int _y, int _w, int _h, int _channelBarHeight) {
         x = _x;
         y = _y;
         w = _w;
         h = _h;
         channelBarHeight = _channelBarHeight;
 
-        _parentApplet = _parent;
+        _parentApplet = _parentApplet;
         hwsCp5 = new ControlP5(_parentApplet);
         hwsCp5.setGraphics(_parentApplet, 0,0);
         hwsCp5.setAutoDraw(false);

OpenBCI_GUI/ChannelSelect.pde

@@ -10,16 +10,16 @@ class ChannelSelect {
     protected boolean channelSelectHover;
     protected boolean isVisible;
 
-    ChannelSelect(PApplet _parent, int _x, int _y, int _w, int _navH) {
+    ChannelSelect(PApplet _parentApplet, int _x, int _y, int _w, int _navH) {
         x = _x;
         y = _y;
         w = _w;
         h = _navH;
         navH = _navH;
 
         //setup for checkboxes
-        cp5_chanSelect = new ControlP5(_parent);
-        cp5_chanSelect.setGraphics(_parent, 0, 0);
+        cp5_chanSelect = new ControlP5(_parentApplet);
+        cp5_chanSelect.setGraphics(_parentApplet, 0, 0);
         cp5_chanSelect.setAutoDraw(false); //draw only when specified
     }
 
@@ -66,8 +66,8 @@ class ChannelSelect {
         popStyle();
     }
 
-    public void screenResized(PApplet _parent) {
-        cp5_chanSelect.setGraphics(_parent, 0, 0);
+    public void screenResized(PApplet _parentApplet) {
+        cp5_chanSelect.setGraphics(_parentApplet, 0, 0);
     }
 
     public void mousePressed(boolean dropdownIsActive) {
@@ -111,8 +111,8 @@ class ExGChannelSelect extends ChannelSelect {
     protected List<Toggle> channelButtons;
     private List<Integer> activeChannels = new ArrayList<Integer>();
 
-    ExGChannelSelect(PApplet _parent, int _x, int _y, int _w, int _navH) {
-        super(_parent, _x, _y, _w, _navH);
+    ExGChannelSelect(PApplet _parentApplet, int _x, int _y, int _w, int _navH) {
+        super(_parentApplet, _x, _y, _w, _navH);
         createButtons();
     }
 
@@ -282,8 +282,8 @@ class DualExGChannelSelect extends ExGChannelSelect {
 
     DualChannelSelector dualChannelSelector;
 
-    DualExGChannelSelect(PApplet _parent, int _x, int _y, int _w, int _navH, boolean isFirstRow) {
-        super(_parent, _x, _y, _w, _navH);
+    DualExGChannelSelect(PApplet _parentApplet, int _x, int _y, int _w, int _navH, boolean isFirstRow) {
+        super(_parentApplet, _x, _y, _w, _navH);
         dualChannelSelector = new DualChannelSelector(isFirstRow);
     }
 

OpenBCI_GUI/FifoChannelBar.pde

@@ -25,7 +25,7 @@ class FifoChannelBar {
 
     private GPlotAutoscaler gplotAutoscaler = new GPlotAutoscaler();
 
-    FifoChannelBar(PApplet _parent, String yAxisLabel, int xLimit, float yLimit, int _x, int _y, int _w, int _h, color lineColor, int _layerCount, int _samplingRate, int _totalBufferSeconds) {
+    FifoChannelBar(PApplet _parentApplet, String yAxisLabel, int xLimit, float yLimit, int _x, int _y, int _w, int _h, color lineColor, int _layerCount, int _samplingRate, int _totalBufferSeconds) {
         x = _x;
         y = _y;
         w = _w;
@@ -42,7 +42,7 @@ class FifoChannelBar {
             isOpenness = true;
         }
 
-        plot = new GPlot(_parent);
+        plot = new GPlot(_parentApplet);
         plot.setPos(x + 36 + 4 + xOffset, y);
         plot.setDim(w - 36 - 4 - xOffset, h);
         plot.setMar(0f, 0f, 0f, 0f);
@@ -77,12 +77,12 @@ class FifoChannelBar {
         valueTextBox.setVisible(false);
     }
 
-    FifoChannelBar(PApplet _parent, String yAxisLabel, int xLimit, int _x, int _y, int _w, int _h, color lineColor, int layerCount, int _totalBufferSeconds) {
-        this(_parent, yAxisLabel, xLimit, 1, _x, _y, _w, _h, lineColor, layerCount, 200, _totalBufferSeconds);
+    FifoChannelBar(PApplet _parentApplet, String yAxisLabel, int xLimit, int _x, int _y, int _w, int _h, color lineColor, int layerCount, int _totalBufferSeconds) {
+        this(_parentApplet, yAxisLabel, xLimit, 1, _x, _y, _w, _h, lineColor, layerCount, 200, _totalBufferSeconds);
     }
 
-    FifoChannelBar(PApplet _parent, String yAxisLabel, int xLimit, float yLimit, int _x, int _y, int _w, int _h, color lineColor, int _totalBufferSeconds) {
-        this(_parent, yAxisLabel, xLimit, yLimit, _x, _y, _w, _h, lineColor, 1, 200, _totalBufferSeconds);
+    FifoChannelBar(PApplet _parentApplet, String yAxisLabel, int xLimit, float yLimit, int _x, int _y, int _w, int _h, color lineColor, int _totalBufferSeconds) {
+        this(_parentApplet, yAxisLabel, xLimit, yLimit, _x, _y, _w, _h, lineColor, 1, 200, _totalBufferSeconds);
     }
 
     private void initArrays() {

OpenBCI_GUI/OpenBCI_GUI.pde

@@ -342,6 +342,9 @@ void settings() {
 }
 
 void setup() {
+
+    ourApplet = this;
+
     frameRate(120);
 
     copyPaste = new CopyPaste();
@@ -432,9 +435,6 @@ void setup() {
     guiSettings = new GuiSettings(directoryManager.getSettingsPath());
     userPlaybackHistoryFile = directoryManager.getSettingsPath()+"UserPlaybackHistory.json";
 
-    //open window
-    ourApplet = this;
-
     // Bug #426: If setup takes too long, JOGL will time out waiting for the GUI to draw something.
     // moving the setup to a separate thread solves this. We just have to make sure not to
     // start drawing until delayed setup is done.
@@ -743,7 +743,7 @@ void initSystem() {
     topNav.controlPanelCollapser.setOff();
 
     verbosePrint("OpenBCI_GUI: initSystem: -- Init 4 -- " + millis());
-    wm = new WidgetManager(this);
+    wm = new WidgetManager();
 
     verbosePrint("OpenBCI_GUI: initSystem: -- Init 5 -- " + millis());
 

OpenBCI_GUI/W_Accelerometer.pde

@@ -44,13 +44,11 @@ class W_Accelerometer extends Widget {
 
     private AccelerometerCapableBoard accelBoard;
 
-    W_Accelerometer(PApplet _parent) {
-        super(_parent); //calls the parent CONSTRUCTOR method of Widget (DON'T REMOVE)
+    W_Accelerometer(String _widgetName) {
+        super(_widgetName);
 
         accelBoard = (AccelerometerCapableBoard)currentBoard;
 
-        
-
         //Make dropdowns
         addDropdown("accelerometerVerticalScaleDropdown", "Vert Scale", verticalScale.getEnumStringsAsList(), verticalScale.getIndex());
         addDropdown("accelerometerHorizontalScaleDropdown", "Window", horizontalScale.getEnumStringsAsList(), horizontalScale.getIndex());
@@ -62,7 +60,7 @@ class W_Accelerometer extends Widget {
         lastDataSampleValues = new float[NUM_ACCEL_DIMS];
 
         //Create our channel bar and populate our accelerometerBar array
-        accelerometerBar = new AccelerometerBar(_parent, verticalScale.getHighestValue(), accelGraphX, accelGraphY, accelGraphWidth, accelGraphHeight);
+        accelerometerBar = new AccelerometerBar(ourApplet, verticalScale.getHighestValue(), accelGraphX, accelGraphY, accelGraphWidth, accelGraphHeight);
         accelerometerBar.adjustTimeAxis(horizontalScale.getValue());
         accelerometerBar.adjustVertScale(verticalScale.getValue());
 
@@ -82,7 +80,7 @@ class W_Accelerometer extends Widget {
     }
 
     void update() {
-        super.update(); //calls the parent update() method of Widget (DON'T REMOVE)
+        super.update();
 
         if (accelBoard.isAccelerometerActive()) {
             //update the line graph and corresponding gplot points
@@ -109,7 +107,7 @@ class W_Accelerometer extends Widget {
     }
 
     void draw() {
-        super.draw(); //calls the parent draw() method of Widget (DON'T REMOVE)
+        super.draw();
 
         pushStyle();
 
@@ -159,7 +157,7 @@ class W_Accelerometer extends Widget {
         int prevY = y;
         int prevW = w;
         int prevH = h;
-        super.screenResized(); //calls the parent screenResized() method of Widget (DON'T REMOVE)
+        super.screenResized();
         setGraphDimensions();
         //resize the accelerometer line graph
         accelerometerBar.screenResized(accelGraphX, accelGraphY, accelGraphWidth, accelGraphHeight); //bar x, bar y, bar w, bar h
@@ -168,11 +166,11 @@ class W_Accelerometer extends Widget {
     }
 
     void mousePressed() {
-        super.mousePressed(); //calls the parent mousePressed() method of Widget (DON'T REMOVE)
+        super.mousePressed();
     }
 
     void mouseReleased() {
-        super.mouseReleased(); //calls the parent mouseReleased() method of Widget (DON'T REMOVE)
+        super.mouseReleased();
     }
 
     private void createAccelModeButton(String name, String text, int _x, int _y, int _w, int _h, PFont _font, int _fontSize, color _bg, color _textColor) {
@@ -316,7 +314,7 @@ class AccelerometerBar {
 
     private AccelerometerCapableBoard accelBoard;
 
-    AccelerometerBar(PApplet _parent, float _yLimit, int _x, int _y, int _w, int _h) { //channel number, x/y location, height, width
+    AccelerometerBar(PApplet _parentApplet, float _yLimit, int _x, int _y, int _w, int _h) { //channel number, x/y location, height, width
 
         // This widget is only instantiated when the board is accel capable, so we don't need to check
         accelBoard = (AccelerometerCapableBoard)currentBoard;
@@ -326,7 +324,7 @@ class AccelerometerBar {
         w = _w;
         h = _h;
 
-        plot = new GPlot(_parent);
+        plot = new GPlot(_parentApplet);
         plot.setPos(x + 36 + 4, y); //match Accelerometer plot position with Time Series
         plot.setDim(w - 36 - 4, h);
         plot.setMar(0f, 0f, 0f, 0f);

OpenBCI_GUI/W_AnalogRead.pde

@@ -28,8 +28,8 @@ class W_AnalogRead extends Widget {
 
     private AnalogCapableBoard analogBoard;
 
-    W_AnalogRead(PApplet _parent) {
-        super(_parent);
+    W_AnalogRead(String _widgetName) {
+        super(_widgetName);
 
         analogBoard = (AnalogCapableBoard)currentBoard;
 
@@ -49,7 +49,7 @@ class W_AnalogRead extends Widget {
         //create our channel bars and populate our analogReadBars array!
         for(int i = 0; i < analogReadBars.length; i++) {
             int analogReadBarY = int(ar_y) + i*(analogReadBarHeight); //iterate through bar locations
-            AnalogReadBar tempBar = new AnalogReadBar(_parent, i+5, int(ar_x), analogReadBarY, int(ar_w), analogReadBarHeight); //int _channelNumber, int _x, int _y, int _w, int _h
+            AnalogReadBar tempBar = new AnalogReadBar(ourApplet, i+5, int(ar_x), analogReadBarY, int(ar_w), analogReadBarHeight); //int _channelNumber, int _x, int _y, int _w, int _h
             analogReadBars[i] = tempBar;
         }
 
@@ -60,7 +60,7 @@ class W_AnalogRead extends Widget {
     }
 
     public void update() {
-        super.update(); //calls the parent update() method of Widget (DON'T REMOVE)
+        super.update();
 
         if (currentBoard instanceof DataSourcePlayback) {
             if (((DataSourcePlayback)currentBoard) instanceof AnalogCapableBoard
@@ -87,7 +87,7 @@ class W_AnalogRead extends Widget {
     }
 
     public void draw() {
-        super.draw(); //calls the parent draw() method of Widget (DON'T REMOVE)
+        super.draw();
 
         //remember to refer to x,y,w,h which are the positioning variables of the Widget class
         if (analogBoard.isAnalogActive()) {
@@ -98,7 +98,7 @@ class W_AnalogRead extends Widget {
     }
 
     public void screenResized() {
-        super.screenResized(); //calls the parent screenResized() method of Widget (DON'T REMOVE)
+        super.screenResized();
 
         ar_x = float(x) + arPadding;
         ar_y = float(y) + (arPadding);
@@ -115,11 +115,11 @@ class W_AnalogRead extends Widget {
     }
 
     public void mousePressed() {
-        super.mousePressed(); //calls the parent mousePressed() method of Widget (DON'T REMOVE)
+        super.mousePressed();
     }
 
     public void mouseReleased() {
-        super.mouseReleased(); //calls the parent mouseReleased() method of Widget (DON'T REMOVE)
+        super.mouseReleased();
     }
 
     private void createAnalogModeButton(String name, String text, int _x, int _y, int _w, int _h, PFont _font, int _fontSize, color _bg, color _textColor) {
@@ -212,7 +212,7 @@ class AnalogReadBar{
 
     private AnalogCapableBoard analogBoard;
 
-    AnalogReadBar(PApplet _parent, int _analogInputPin, int _x, int _y, int _w, int _h) { // channel number, x/y location, height, width
+    AnalogReadBar(PApplet _parentApplet, int _analogInputPin, int _x, int _y, int _w, int _h) { // channel number, x/y location, height, width
 
         analogInputPin = _analogInputPin;
         int digitalPinNum = 0;
@@ -236,7 +236,7 @@ class AnalogReadBar{
         h = _h;
 
         numSeconds = 20;
-        plot = new GPlot(_parent);
+        plot = new GPlot(_parentApplet);
         plot.setPos(x + 36 + 4, y);
         plot.setDim(w - 36 - 4, h);
         plot.setMar(0f, 0f, 0f, 0f);

OpenBCI_GUI/W_BandPower.pde

@@ -40,14 +40,14 @@ class W_BandPower extends Widget {
     int[] autoCleanTimers;
     boolean[] previousThresholdCrossed;
 
-    W_BandPower(PApplet _parent) {
-        super(_parent); //calls the parent CONSTRUCTOR method of Widget (DON'T REMOVE)
+    W_BandPower(String _widgetName) {
+        super(_widgetName);
 
         autoCleanTimers = new int[currentBoard.getNumEXGChannels()];
         previousThresholdCrossed = new boolean[currentBoard.getNumEXGChannels()];
 
         //Add channel select dropdown to this widget
-        bpChanSelect = new ExGChannelSelect(pApplet, x, y, w, navH);
+        bpChanSelect = new ExGChannelSelect(ourApplet, x, y, w, navH);
         bpChanSelect.activateAllButtons();
 
         cp5ElementsToCheck.addAll(bpChanSelect.getCp5ElementsForOverlapCheck());
@@ -65,7 +65,7 @@ class W_BandPower extends Widget {
         addDropdown("bandPowerDataFilteringDropdown", "Filtered?", filteredEnum.getEnumStringsAsList(), filteredEnum.getIndex());
 
         // Setup for the BandPower plot
-        bp_plot = new GPlot(_parent, x, y-navHeight, w, h+navHeight);
+        bp_plot = new GPlot(ourApplet, x, y-navHeight, w, h+navHeight);
         // bp_plot.setPos(x, y+navHeight);
         bp_plot.setDim(w, h);
         bp_plot.setLogScale("y");
@@ -107,7 +107,7 @@ class W_BandPower extends Widget {
     }
 
     public void update() {
-        super.update(); //calls the parent update() method of Widget (DON'T REMOVE)
+        super.update();
 
         // If enabled, automatically turn channels on or off in ExGChannelSelect for this widget
         autoCleanByEnableDisableChannels();
@@ -135,7 +135,7 @@ class W_BandPower extends Widget {
     }
 
     public void draw() {
-        super.draw(); //calls the parent draw() method of Widget (DON'T REMOVE)
+        super.draw();
         pushStyle();
 
         //remember to refer to x,y,w,h which are the positioning variables of the Widget class
@@ -158,15 +158,15 @@ class W_BandPower extends Widget {
     }
 
     public void screenResized() {
-        super.screenResized(); //calls the parent screenResized() method of Widget (DON'T REMOVE)
+        super.screenResized();
 
         flexGPlotSizeAndPosition();
 
-        bpChanSelect.screenResized(pApplet);
+        bpChanSelect.screenResized(ourApplet);
     }
 
     public void mousePressed() {
-        super.mousePressed(); //calls the parent mousePressed() method of Widget (DON'T REMOVE)
+        super.mousePressed();
         bpChanSelect.mousePressed(this.dropdownIsActive); //Calls channel select mousePressed and checks if clicked
     }