Interface: Difference between revisions

From LabRPS Documentation
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 5: Line 5:
The LabRPS [[interface|interface]] is based on Qt, a well known graphical user interface (GUI) toolkit, particularly used in Linux, but also available in Windows and MacOS.
The LabRPS [[interface|interface]] is based on Qt, a well known graphical user interface (GUI) toolkit, particularly used in Linux, but also available in Windows and MacOS.


[[File:LabRPS_interface_base_divisions.svg|1024px]]
[[File:LabRPS_interface_base_divisions.png|1024px]]


{{Caption|Standard interface in v0.1}}
{{Caption|Standard interface in v0.1}}


The main window of the application can be roughly divided into 14 sections:
The main window of the application can be roughly divided into 13 sections:
# The [[main_view_area|main view area]], which can contain different tabbed windows
# The [[main_view_area|main view area]], which can contain different tabbed windows
# The [[Dependency_graph_view|Dependency graph view]], normally embedded in the [[main_view_area|main view area]]
# The [[Dependency_graph_view|Dependency graph view]], normally embedded in the [[main_view_area|main view area]]
Line 17: Line 17:
# The [[report_view|report view]]
# The [[report_view|report view]]
# The [[Python_console|Python console]]
# The [[Python_console|Python console]]
# The [[Result_View|Result view]]
# The [[Result_view|Result view]]
# The [[Alphaplot_Property_Editor|Alphaplot property editor]]
# The [[Plot_editor|Plot editor]]
# The [[Alphaplot_Explorer|Alphaplot explorer]]
# The [[Plot_explorer|Plot explorer]]
# The [[status_bar|status bar]]
# The [[status_bar|status bar]]
# The toolbar area, see the following information on the toolbars
# The toolbar area, see the following information on the toolbars
Line 39: Line 39:
* [[Std_Workbench|Workbench toolbar]]: it contains a single widget to select the active [[workbenches|workbench]].
* [[Std_Workbench|Workbench toolbar]]: it contains a single widget to select the active [[workbenches|workbench]].
* Macro toolbar: tools to record, edit, and execute [[macros|macros]].
* Macro toolbar: tools to record, edit, and execute [[macros|macros]].
* View toolbar: tools to control how objects appear in the [[3D view|3D view]].
* View toolbar: tools to control how objects appear.
* Structure toolbar: tools to organize objects in the document, and create links to additional documents.
* Structure toolbar: tools to organize objects in the document, and create links to additional documents.


Line 47: Line 47:


The main panels that allow working with objects are:
The main panels that allow working with objects are:
* [[3D view|3D view]]: the area where 2D and 3D geometry is drawn.
* [[Combo view|Combo view]]: the panel that contains the [[tree view|tree view]], the [[task panel|task panel]], and the [[property editor|property editor]].
* [[Combo view|Combo view]]: the panel that contains the [[tree view|tree view]], the [[task panel|task panel]], and the [[property editor|property editor]].
* [[Tree view|Tree view]]: the element that shows all objects in the document and their parametric history.
* [[Tree view|Tree view]]: the element that shows all objects in the document and their parametric history.
Line 54: Line 53:
* [[Selection view|Selection view]]: the panel that shows elements that are currently selected.
* [[Selection view|Selection view]]: the panel that shows elements that are currently selected.
* [[Report view|Report view]]: the text box that shows different messages from the application and its tools.
* [[Report view|Report view]]: the text box that shows different messages from the application and its tools.
* [[Python console|Python console]]: the editor that allows running [[Python|Python]] code interactively to see results in the [[3D view|3D view]].
* [[Python console|Python console]]: the editor that allows running [[Python|Python]] code interactively.
* [[Status bar|Status bar]]: the bar that shows certain messages from the application, and that has the [[Mouse_navigation|mouse navigation]] selector.
* [[Status bar|Status bar]]: the bar that shows certain messages from the application, and that has the [[Mouse_navigation|mouse navigation]] selector.
* [[DAG view|DAG view]]: an alternative to the [[tree view|tree view]], which shows the relationships between different objects through a graph.


With the exception of the 3D view, all can be turned on and off by right clicking on an empty space on one of the top toolbars and choosing the desired element, or from the menu, {{MenuCommand|View → Panels}}.
With the exception of the dependency graph view, all can be turned on and off by right clicking on an empty space on one of the top toolbars and choosing the desired element, or from the menu, {{MenuCommand|View → Panels}}.


To activate and deactivate the status bar use the menu, {{MenuCommand|View → Status bar}}.
To activate and deactivate the status bar use the menu, {{MenuCommand|View → Status bar}}.
=== Other ===
Other useful interfaces and windows include:
* [[Std_SceneInspector|Scene inspector]]: a panel that shows the Coin3D nodes that make up the [[Scenegraph|scenegraph]]. For power users and developers, it may be useful to troubleshoot operations that manipulate the scene directly, and the objects created in the [[3D_view|3D view]].
* [[Std_DependencyGraph|Dependency graph]]: a window showing the dependency graph of all the objects in the document, created with the auxiliary program [https://graphviz.org/ Graphviz]. It is helpful to recognize problems in the creation of objects, such as circular dependencies, which may not be entirely evident from the [[Tree_view|tree view]] or the [[DAG_view|DAG view]].


=== Customization ===  
=== Customization ===  

Latest revision as of 19:46, 29 October 2024

Introduction

The LabRPS interface is based on Qt, a well known graphical user interface (GUI) toolkit, particularly used in Linux, but also available in Windows and MacOS.

LabRPS interface base divisions.png

Standard interface in v0.1

The main window of the application can be roughly divided into 13 sections:

  1. The main view area, which can contain different tabbed windows
  2. The Dependency graph view, normally embedded in the main view area
  3. The upper part of the combo view, which includes the tree view and task panel
  4. The lower part of the combo view, which includes the property editor
  5. The selection view
  6. The report view
  7. The Python console
  8. The Result view
  9. The Plot editor
  10. The Plot explorer
  11. The status bar
  12. The toolbar area, see the following information on the toolbars
  13. The Workbench selector, which itself is a toolbar
  14. The standard menu

Components of the interface

Like many pieces of software, LabRPS includes a standard menu bar, and then a series of toolbars and panels where the user tools are found.

Menus

The standard menus are: File, Edit, View, Tools, Macro, Windows, Help.

Toolbars

The standard toolbars that appear in the interface are:

  • File toolbar: tools to work with files, open documents, copy, paste, undo and redo actions.
  • Workbench toolbar: it contains a single widget to select the active workbench.
  • Macro toolbar: tools to record, edit, and execute macros.
  • View toolbar: tools to control how objects appear.
  • Structure toolbar: tools to organize objects in the document, and create links to additional documents.

These can be turned on and off by right clicking on an empty space on one of the toolbars and choosing the desired element, or from the menu, View → Toolbars.

Panels

The main panels that allow working with objects are:

With the exception of the dependency graph view, all can be turned on and off by right clicking on an empty space on one of the top toolbars and choosing the desired element, or from the menu, View → Panels.

To activate and deactivate the status bar use the menu, View → Status bar.

Customization

Toolbars can have more or fewer buttons, and custom toolbars can be created with a mix of different tools, and to store developed macros.

These options are in the menu, Tools → Customize. See interface customization.

Labrps.svg Interface
User hub.png User documentation
Retrieved from "https://wiki.labrps.com/index.php?title=Interface&oldid=2186"