Last modification on 2019-01-29
IntroductionThis document provides an overview of the user interface. It is very brief as the majority of the interface is specified more in depth in the keyboard and graphics specifications.
Key Terms and Concepts
|Command prompt||An area where commands can be entered into the simulation|
|Commands||Messages sent to the simulation to affect it's behaviour or cause an action, such as creating new agents|
|HJKL||A method of directionally navigating using the keyboard|
|Insert mode||A mode in which key presses are entered as text into the command prompt|
|Interface bar||Both the status area and the command prompt area of the user interface|
|Key binds||Shortcuts for performing various commands|
|Mode||The state the user interface is in. Affects how key presses are handled|
|Normal mode||A mode where key presses are registered normally, as keyboard shortcuts|
|Select mode||A mode which allows the selection of areas on the screen|
The user interface is split into two main sections: the simulation section which take up the majority of the screen, and the interface bar along the bottom. This consists of the mode indicator and the command prompt
The user is able to interface with the simulation via various Vim inspired key binds, for example, hitting the ":" key will put the user into insert mode. Hitting Esc will return the user back into normal mode. For more information on all the key bindings, please see the keyboard specification document.
The user interface allows for three different modes: Insert mode, select mode, or normal mode, which are explained below:
- Insert mode: A user is able to type commands into the command prompt, normal key binds don't work as all key presses are sent to the command prompt area.
- Normal mode: A user is able to use regular key binds, which are shortcuts to regular commands.
- Selection mode: A user is able to use HJKL or the arrow keys to select an area which is then provided as an argument to a command, which could, for example, delete all agents within it.
LayoutBelow in figure 1. is an illustration of the user interface with an explanation of each component:
- Graphics: This is where the simulation will be displayed
- Mode indicator: This is where the current mode the UI is in will be displayed
- Command prompt: This is where the user is able to enter commands to interact with the simulation.