Interface: Difference between revisions

From LabRPS Documentation
Jump to navigation Jump to search
No edit summary
No edit summary
Line 7: Line 7:
[[File:LabRPS_interface_base_divisions.svg|1024px]]
[[File:LabRPS_interface_base_divisions.svg|1024px]]


{{Caption|Standard interface in v0.001.}}
{{Caption|Standard interface in v0.19.}}


The main window of the application can be roughly divided into 15 sections:
The main window of the application can be roughly divided into 11 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 [[3D_graph_view|3D graph view]], normally embedded in the [[main_view_area|main view area]]
# The [[3D_view|3D view]], normally embedded in the [[main_view_area|main view area]]
# The [[2D_graph_view|2D graph view]], normally embedded in the [[main_view_area|main view area]]
# The upper part of the [[combo_view|combo view]], which includes the [[tree_view|tree view]] and [[task_panel|task panel]]
# The [[Table_view|Table view]], normally embedded in the [[main_view_area|main view area]]
# The lower part of the [[combo_view|combo view]], which includes the [[property_editor|property editor]]
# The [[Matrix_view|Matrix view]], normally embedded in the [[main_view_area|main view area]]
# The [[selection_view|selection view]]
# The [[Note_view|Note view]], normally embedded in the [[main_view_area|main view area]]
# The [[report_view|report view]]
# The upper part of the [[combo_view|combo view]], which includes the [[Visual_objects_tree_view|visual objects tree view]] and the [[RPS_objects_tree_view|RPS objects tree view]]
# The [[Python_console|Python console]]
# The lower part of the [[combo_view|combo view]], which includes the [[Visual_objects_property_editor|Visual objects property editor]] and [[RPS_objects_property_browser|RPS objects property browser]]
# The [[Result_log_view|result log view]]
# The [[Scripting_console|Scripting console]]
# The [[Project_explorer_view|project explorer view]]
# 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
# The [[Std_Phenomenon|Phenomenon selector]], which itself is inside a the simulation toolbar
# The [[Std_Workbench|Workbench selector]], which itself is a toolbar
# The [[Standard_Menu|standard menu]]
# The [[Standard_Menu|standard menu]]


Line 32: Line 28:
=== Menus ===  
=== Menus ===  


The [[Standard_Menu|standard menus]] are: {{StdMenu|[[Std_File_Menu|{{MenuCommand|File}}]]}}, {{StdMenu|[[Std_Edit_Menu|{{MenuCommand|Edit}}]]}}, {{StdMenu|[[Std_View_Menu|{{MenuCommand|View}}]]}}, {{StdMenu|[[Std_Scripting_Menu|{{MenuCommand|Scripting}}]]}}, {{StdMenu|[[Std_Input_Menu|{{MenuCommand|Input}}]]}}, {{StdMenu|[[Std_Simulation_Menu|{{MenuCommand|Simulation}}]]}}, {{StdMenu|[[Std_Output_Menu|{{MenuCommand|Output}}]]}}, {{StdMenu|[[Std_Help_Menu|{{MenuCommand|Help}}]]}}.
The [[Standard_Menu|standard menus]] are: {{StdMenu|[[Std_File_Menu|{{MenuCommand|File}}]]}}, {{StdMenu|[[Std_Edit_Menu|{{MenuCommand|Edit}}]]}}, {{StdMenu|[[Std_View_Menu|{{MenuCommand|View}}]]}}, {{StdMenu|[[Std_Tools_Menu|{{MenuCommand|Tools}}]]}}, {{StdMenu|[[Std_Macro_Menu|{{MenuCommand|Macro}}]]}}, {{StdMenu|[[Std_Windows_Menu|{{MenuCommand|Windows}}]]}}, {{StdMenu|[[Std_Help_Menu|{{MenuCommand|Help}}]]}}.


=== Toolbars ===  
=== Toolbars ===  


The standard toolbars that appear in the interface are:
The standard toolbars that appear in the interface are:
* File toolbar: tools to work with files, open, save, import, export documents actions.
* File toolbar: tools to work with files, open documents, copy, paste, undo and redo actions.
* Edit toolbar: tools to work with files, copy, paste, undo and redo actions.
* [[Std_Workbench|Workbench toolbar]]: it contains a single widget to select the active [[workbenches|workbench]].
* Table toolbar: tools to work with table, work on rows and colums.
* Macro toolbar: tools to record, edit, and execute [[macros|macros]].
* Matrix toolbar: tools to work with matrices.
* View toolbar: tools to control how objects appear in the [[3D view|3D view]].
* 2D Plot toolbar: tools to work with 2D graphs.
* Structure toolbar: tools to organize objects in the document, and create links to additional documents.
* 3D Plot toolbar: tools to work with 3D graphs.
* Input toolbar: tools to work with simulation data input.
* Simulation toolbar: tools to control the simulation options.
* Output toolbar: tools to work with simulation data output.


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, {{MenuCommand|View → Toolbars}}.
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, {{MenuCommand|View → Toolbars}}.
Line 52: Line 44:


The main panels that allow working with objects are:
The main panels that allow working with objects are:
* [[3D grap view|3D gragh view]]: the area where 3D graph is drawn.
* [[3D view|3D view]]: the area where 2D and 3D geometry is drawn.
* [[2D grap view|2D gragh view]]: the area where 2D graph 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 [[Visual objects tree view|visual objects tree view]], the [[RPS objects tree view|RPS objects tree view]].
* [[Tree view|Tree view]]: the element that shows all objects in the document and their parametric history.
* [[Visual objects tree view|Visual objects tree view]]: the element that shows all visualization objects (tables, matrices, notes, plots...) in the document.
* [[Task panel|Task panel]]: the panel that shows different actions and options depending on the drawing tool selected.
* [[RPS objects tree view|RPS objects tree view]]: the element that shows all plugins and RPS objects (spectrum models, coherence functions, modulation functions, simulation methods...) in the document.
* [[Property editor|Property editor]]: the place where object properties are modified.
* [[Visual objects property editor|Visual objects property editor]]: the place where visualization object properties are modified.
* [[Selection view|Selection view]]: the panel that shows elements that are currently selected.
* [[RPS objects property browser|RPS objects property browser]]: the place where RPS object properties are shown.
* [[Report view|Report view]]: the text box that shows different messages from the application and its tools.
* [[Result log view|Result log 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]].
* [[Project explorer view|Project explorer view]]: the place where the structure and the containts of the document are shown.
* [[Status bar|Status bar]]: the bar that shows certain messages from the application, and that has the [[Mouse_navigation|mouse navigation]] selector.
* [[Scripting console|Scripting console]]: the editor that allows running [[Scripting|Scripting]] code interactively.
* [[DAG view|DAG view]]: an alternative to the [[tree view|tree view]], which shows the relationships between different objects through a graph.
* [[Status bar|Status bar]]: the bar that shows certain messages from the application.


With the exception of the main view area, 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 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}}.
 
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 ===
 
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, {{MenuCommand|Tools → Customize}}. See [[Interface Customization|interface customization]].


{{Interface navi}}
{{Interface navi}}
{{Userdocnavi}}
{{Userdocnavi}}

Revision as of 14:12, 21 June 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.

File:LabRPS interface base divisions.svg

Standard interface in v0.19.

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

  1. The main view area, which can contain different tabbed windows
  2. The 3D 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 status bar
  9. The toolbar area, see the following information on the toolbars
  10. The Workbench selector, which itself is a toolbar
  11. 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 in the 3D view.
  • 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:

  • 3D view: the area where 2D and 3D geometry is drawn.
  • Combo view: the panel that contains the tree view, the task panel, and the property editor.
  • Tree view: the element that shows all objects in the document and their parametric history.
  • Task panel: the panel that shows different actions and options depending on the drawing tool selected.
  • Property editor: the place where object properties are modified.
  • Selection view: the panel that shows elements that are currently selected.
  • Report view: the text box that shows different messages from the application and its tools.
  • Python console: the editor that allows running Python code interactively to see results in the 3D view.
  • Status bar: the bar that shows certain messages from the application, and that has the mouse navigation selector.
  • DAG view: an alternative to the 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, View → Panels.

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

Other

Other useful interfaces and windows include:

  • Scene inspector: a panel that shows the Coin3D nodes that make up the 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.
  • Dependency graph: a window showing the dependency graph of all the objects in the document, created with the auxiliary program 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 or the DAG view.

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=1569"