Chapter 2. The Rocs User Interface

Main Elements of the User Interface

The user interface is divided into several logical parts as presented at the screenshot below.

GUI elements of the Rocs interface.
Graph Editor

The editor provides a whiteboard at that nodes and edges can be placed. Double-clicking at any of its elements opens a corresponding property menu. You can use the tools from the Graph Editor Toolbar to create and modify graphs.

Graph Editor Toolbar

The toolbar provides the Create Node or Create Edge tools, for creating new elements on the whiteboard. Note the extra-toolbar for selecting the respective node or edge type that becomes visible of one of these tools is selected. Also tools for selecting and moving as well as deleting elements are available here. For details see the section called “Graph Editor Toolbar”.

Side Bar

At the right, you can find the side bar that provides several tools for your workflow:

  • Element Types: This widget gives you direct access to the available edge and node types.

  • Journal: Each project has its own journal that can be used to, e.g. note tasks, results, or observations.

  • Scripting API: To get direct access to the script documentation, you can open this widget.

Script Editor

In this text editor you can write algorithms as explained in detail in Chapter 3, Scripting. You can work on several script documents simultaneously by using several tabs.

Script Output

This text area either shows debug information or the script output of your algorithm, depending on the toggled setting at the top of this widget. If the script throws an error, automatically the debug output is presented.

Controls

Here you can find the controls for executing scripts. You can execute the script that is currently open at the script editor by pressing Run. While the script is executed, it is possible to stop execution by pressing the Stop button.