GUI

java.lang.Object
- javafx.application.Application
- - jcgp.gui.GUI

```
public class GUI
extends javafx.application.Application
```
Main class for the graphical user interface (GUI).

This class declares the main method used when running the GUI. In addition, all main GUI panes are declared and instantiated here.

The user interface is divided into 3 main components: the node grid (PopulationPane), the control pane (SettingsPane) and the console (ConsolePane). Click on any of the links in brackets to see more information about each interface component.

This class also contains the instance of JCGP responsible for running the experiments in GUI mode. JCGP's execution must be delegated to a separate thread so that the GUI remains unblocked. This is done using a JavaFX Service which calls nextGeneration() in a loop until it is interrupted by the main JavaFX thread.
This service also handles flushing the console in a thread safe way. This is done by synchronizing the nextGeneration() and flush() method calls on a lock object.

Author:

Eduardo Pedroni

Nested Class Summary
- Nested classes/interfaces inherited from class javafx.application.Application
  javafx.application.Application.Parameters

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BAD_SELECTION_COLOUR` A string containing the hexadecimal colour used for representing a bad selection.
`static double`	`CONSOLE_MIN_HEIGHT` The minimum width of the console pane, to prevent it from being resized beyond visibility.
`static java.lang.String`	`GOOD_SELECTION_COLOUR` A string containing the hexadecimal colour used for representing a good selection.
`static java.lang.String`	`HARD_HIGHLIGHT_COLOUR` A string containing the hexadecimal colour used for representing a hard highlight.
`static java.lang.String`	`MEDIUM_HIGHLIGHT_COLOUR` A string containing the hexadecimal colour used for a medium highlight.
`static java.lang.String`	`NEUTRAL_COLOUR` A string containing the hexadecimal colour used for representing neutrality.
`static java.lang.String`	`NEUTRAL_SELECTION_COLOUR` A string containing the hexadecimal colour used for representing a neutral selection.
`static double`	`RESIZE_MARGIN` The width or height of the area that can be clicked on to drag-resize a pane.
`static double`	`SETTINGS_MIN_WIDTH` The minimum width of the settings pane, to prevent it from being resized beyond visibility.
`static java.lang.String`	`SOFT_HIGHLIGHT_COLOUR` A string containing the hexadecimal colour used for a soft highlight.

Fields inherited from class javafx.application.Application
STYLESHEET_CASPIAN, STYLESHEET_MODENA

Constructor Summary

Constructors
Constructor and Description

GUI()
Makes a new instance of GUI.

Constructors
Constructor and Description
`GUI()` Makes a new instance of GUI.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bringFunctionSelector(javafx.scene.input.MouseEvent event, GUINode node)` Relocate the function selector to the right position relative to the specified node and set it visible.
`void`	`evaluateTestCase(TestCaseProblem.TestCase<java.lang.Object> testCase)` Starts the evaluation process with the given test case.
`void`	`flushConsole()` Writes all buffered content out to the GUI console.
`int`	`getChromosomeIndex()`
`JCGP`	`getExperiment()`
`javafx.stage.Stage`	`getStage()`
`void`	`hideGeneValues()` Hide all evaluated values.
`boolean`	`isWorking()`
`static void`	`main(java.lang.String[] args)` Start JCGP with the user interface.
`void`	`reDraw()` Does a complete GUI refresh.
`void`	`reset()` Reset button callback.
`void`	`runPause()` Run/pause method.
`void`	`setEvaluating(boolean value)` Set the system into evaluation mode.
`void`	`start(javafx.stage.Stage primaryStage)`
`void`	`step()` Perform a single generation using `nextGeneration()`.
`void`	`updateFunctionSelector()` Refresh the function selector, used when functions are enabled or disabled.

Methods inherited from class javafx.application.Application
getHostServices, getParameters, getUserAgentStylesheet, init, launch, launch, notifyPreloader, setUserAgentStylesheet, stop

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NEUTRAL_COLOUR
```
public static final java.lang.String NEUTRAL_COLOUR
```
    A string containing the hexadecimal colour used for representing neutrality.
    
    See Also:
    
    Constant Field Values
  - HARD_HIGHLIGHT_COLOUR
```
public static final java.lang.String HARD_HIGHLIGHT_COLOUR
```
    A string containing the hexadecimal colour used for representing a hard highlight. A "hard" select, for instance, happens when an output path is locked on the chromosome pane.
    
    See Also:
    
    Constant Field Values
  - MEDIUM_HIGHLIGHT_COLOUR
```
public static final java.lang.String MEDIUM_HIGHLIGHT_COLOUR
```
    A string containing the hexadecimal colour used for a medium highlight. One example of such a selection is the colour applied to a node when it is hovered over.
    
    See Also:
    
    Constant Field Values
  - SOFT_HIGHLIGHT_COLOUR
```
public static final java.lang.String SOFT_HIGHLIGHT_COLOUR
```
    A string containing the hexadecimal colour used for a soft highlight. When hovering over a node, its connections are soft-selected.
    
    See Also:
    
    Constant Field Values
  - GOOD_SELECTION_COLOUR
```
public static final java.lang.String GOOD_SELECTION_COLOUR
```
    A string containing the hexadecimal colour used for representing a good selection. Ideally a shade of green, used for instance when a manual connection is valid.
    
    See Also:
    
    Constant Field Values
  - NEUTRAL_SELECTION_COLOUR
```
public static final java.lang.String NEUTRAL_SELECTION_COLOUR
```
    A string containing the hexadecimal colour used for representing a neutral selection. Ideally a shade of yellow, used for instance when a manual connection is already the current connection.
    
    See Also:
    
    Constant Field Values
  - BAD_SELECTION_COLOUR
```
public static final java.lang.String BAD_SELECTION_COLOUR
```
    A string containing the hexadecimal colour used for representing a bad selection. Ideally a shade of red, use for instance when a manual connection is not valid.
    
    See Also:
    
    Constant Field Values
  - RESIZE_MARGIN
```
public static final double RESIZE_MARGIN
```
    The width or height of the area that can be clicked on to drag-resize a pane.
    
    See Also:
    
    Constant Field Values
  - SETTINGS_MIN_WIDTH
```
public static final double SETTINGS_MIN_WIDTH
```
    The minimum width of the settings pane, to prevent it from being resized beyond visibility.
    
    See Also:
    
    Constant Field Values
  - CONSOLE_MIN_HEIGHT
```
public static final double CONSOLE_MIN_HEIGHT
```
    The minimum width of the console pane, to prevent it from being resized beyond visibility.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GUI
```
public GUI()
```
    Makes a new instance of GUI. This initialises the JCGP experiment and instantiates the function selector. It also creates the console flush task and the service responsible for running the JCGP experiment.
- Method Detail
  - main
```
public static void main(java.lang.String[] args)
```
    Start JCGP with the user interface.
    
    Parameters:
    
    args - no arguments are used.
  - start
```
public void start(javafx.stage.Stage primaryStage)
           throws java.lang.Exception
```
    Specified by:
    
    start in class javafx.application.Application
    
    Throws:
    
    java.lang.Exception
  - runPause
```
public void runPause()
```
    Run/pause method. Run the experiment if it is paused, or pause it if it is running.
    This method is the callback used by the run/pause button. It controls the jcgp service.
  - step
```
public void step()
```
    Perform a single generation using nextGeneration().
    On top of that, this method performs all of the housekeeping that is normally done before and after running, such as refreshing the chromosome panes.
  - reset
```
public void reset()
```
    Reset button callback. If the parameters are valid, this resets the entire experiment by calling reset() on jcgp.
  - reDraw
```
public void reDraw()
```
    Does a complete GUI refresh. This is potentially lengthy, so use with care.
  - updateFunctionSelector
```
public void updateFunctionSelector()
```
    Refresh the function selector, used when functions are enabled or disabled.
  - isWorking
```
public boolean isWorking()
```
    Returns:
    
    true if jcgp is evolving.
  - bringFunctionSelector
```
public void bringFunctionSelector(javafx.scene.input.MouseEvent event,
                                  GUINode node)
```
    Relocate the function selector to the right position relative to the specified node and set it visible.
    
    Parameters:
    
    event - the mouse event containing cursor coordinates.
    
    node - the node whose function should be changed.
  - getExperiment
```
public JCGP getExperiment()
```
    Returns:
    
    a reference to the JCGP experiment.
  - evaluateTestCase
```
public void evaluateTestCase(TestCaseProblem.TestCase<java.lang.Object> testCase)
```
    Starts the evaluation process with the given test case. It does so by calling evaluateTestCase() on the population pane.
    
    Parameters:
    
    testCase - the test case to evaluate.
  - hideGeneValues
```
public void hideGeneValues()
```
    Hide all evaluated values. This should be called when evaluations are no longer being performed.
  - setEvaluating
```
public void setEvaluating(boolean value)
```
    Set the system into evaluation mode. When in evaluation mode, the population pane refreshes the node values whenever connection changes happen.
    
    Parameters:
    
    value - true if evaluations are happening, false otherwise.
  - getStage
```
public javafx.stage.Stage getStage()
```
    Returns:
    
    a reference to the GUI stage.
  - flushConsole
```
public void flushConsole()
```
    Writes all buffered content out to the GUI console.
  - getChromosomeIndex
```
public int getChromosomeIndex()
```
    Returns:
    
    the index of the chromosome currently being looked at.

Class GUI

Nested Class Summary

Nested classes/interfaces inherited from class javafx.application.Application

Field Summary

Fields inherited from class javafx.application.Application

Constructor Summary

Method Summary

Methods inherited from class javafx.application.Application

Methods inherited from class java.lang.Object

Field Detail

NEUTRAL_COLOUR

HARD_HIGHLIGHT_COLOUR

MEDIUM_HIGHLIGHT_COLOUR

SOFT_HIGHLIGHT_COLOUR

GOOD_SELECTION_COLOUR

NEUTRAL_SELECTION_COLOUR

BAD_SELECTION_COLOUR

RESIZE_MARGIN

SETTINGS_MIN_WIDTH

CONSOLE_MIN_HEIGHT

Constructor Detail

GUI

Method Detail

main

start

runPause

step

reset

reDraw

updateFunctionSelector

isWorking

bringFunctionSelector

getExperiment

evaluateTestCase

hideGeneValues

setEvaluating

getStage

flushConsole

getChromosomeIndex