Chapter 2. The Rocs User Interface

General 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.
Document Selector

At this top menubar you must select the current document and data structure. Creating and deleting of data structures as well as access to data structure properties is also possible there.

Visual Graph Editor

This is the whiteboard at which data structures can be created and modified. Right click at the whiteboard, at data elements, or at pointers to open context menus. You can use the tools from the Visual Graph Editor Toolbar to modify the elements at the visual graph editor whiteboard.

Visual Graph Editor Toolbar

This toolbar provides all tools for the visual graph editor. Use the Add Element or Add Connection buttons to create new elements or to connect elements, respectively. New data elements are added to the data structure that is currently selected at the Document Selector bar. Note that Add Element and Add Connection buttons both have menus to select the type of which the created elements shall be. For details see the section called “Toolbars”.

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 pointer and data types.

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

  • Handbook: To get direct access to the handbook and by this to the script documentation, you can open this widget.

  • 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, Writing and Executing Algorithms in Rocs. You can work on several script documents simultaneously by using several tabs. The disk symbol at a tab appears if the script contains unsaved changes.

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. Note that the One Step execution only stops at specific keywords (see Chapter 3, Writing and Executing Algorithms in Rocs).