3.2 Graphical User Interface
The graphical user interface (GUI) can improve user productivity. It provides an easy way to control Cubit without learning command syntax. Many geometry commands are faster and easier with the GUI. The underlying GUI components are constructed using a cross-platform development environment. As such, the GUI will behave similarly across all platforms supported by Cubit, yet each GUI will make use of platform specific widgets. The GUI is built on top of the Cubit command line. This means that GUI actions are translated to a Cubit command-line string and journaled. Users familiar with command-line syntax can enter the same text in the GUI command-line window. Journal files can be created and played back in both environments with the same results. Although many things are faster and easier in the GUI, experienced users often use a combination of command line text and GUI button operations. The discussion of the Graphical User Interface and its features is based on the basic windows contained within the Cubit GUI Application Window. These are outlined in the subtopics listed above.
3.2.1 Coreform Cubit™ Application Window
Graphics Window- The current model will be displayed here. Graphical picking and view transformations are done here.
Model Tree - Tree view of the models components, including geometry, materials, boundary conditions, and so forth.
Power Tools - Geometry analysis and repair tool, meshing tool, meshing quality tool, and ITEM Wizard.
Property Editor - The Property Editor lists attributes of the current entity selection. Most of these properties can be edited from the window.
Command Panel - Most Cubit commands are available through the command panels.
Command Line Workspace - The command line workspace contains both the Cubit command and error windows. The command window is used to enter Cubit commands and view the output. The error window is used to view Cubit errors.
Drop Down Menus - Standard file operations, Cubit setup and defaults, display modes, and other functionality is available in the pull-down menus.
Toolbars - The most commonly used features are available by clicking toolbar icons.
3.2.1.1 Context Sensitive Help in the GUI
The Graphical User Interface has a context-sensitive help system. To obtain help using a specific window or control panel, press F1 when the focus is in the desired window. It may be necessary to click inside a text box to switch focus to a particular window. If no context specific help is available, it will open the Cubit help documentation where you can search for a particular topic.
3.2.1.2 Customizing the Application Window
All windows in the Cubit Application can be Floated or Docked. In the default configuration, all windows are docked. When a window is docked the user can click on the area indicated below.
By dragging with the left mouse button held down, the window will be un-docked from the Application Window. Dragging the window to another location on the Application Window and releasing the mouse button will cause it to dock again in a new location. The bounding box of the window will automatically change to fit the dimensions of the window as it is dragged. Releasing the mouse button while the window is not near an edge will cause the window to Float. To stop the window from automatically docking, hold the CONTROL key down while dragging.
When a window is floating, as shown in Figure 4, it is possible to dock it by clicking the title bar of the window and dragging it to its new docked location.
Double clicking on the title bar of an floating window will cause the window to redock in its last docked position.
3.2.2 Command Panels
Geometry Operations
Meshing Operations
Analysis Groups and Materials Operations
FEA Boundary Condition Operations
CFD Boundary Condition Operations
Post-meshing Launch Control
3.2.2.1 Command Panel Functionality
Use Tools/Options/Command Panels to control these options.
The Command Panel navigation hierarchy can be used in several different ways:
The Classic look includes rows of buttons with icons. The hierarchy is entity-based. Geometric, mesh, and other entity types are the focus of the hierarchy. A user navigates entity types then selects actions to perform on those entities.
The default hierarchy is action-based. Actions such as create, modify, delete, mesh sizing, mesh, boolean, and so forth are the focus of the hierarchy. A user navigates to the action to be performed then selects an entity type on which to perform the action.
Breadcrumb navigation is new in Cubit 2020.2. The breadcrumb navigation method will use the hierarchy chosen by the user but will present the options in a much more concise manner, freeing up valuable vertical space in the UI. The figures below show the Breadcrumb navigation method.
The Command Panel is arranged first by mode on the top row of buttons. Modes are arranged by task. All of the geometry related tasks, for instance, can be found under the Geometry mode. When a mode is selected, a second row of buttons becomes available, then a third. The second row of buttons shown depends on the selected mode.
Below is the command panel showing Geometry. Notice the second row shows actions, such as create, modify, transform, boolean, decomposing, and so forth. The third row shows geometry types. This hierarchy implies many geometry operation types are applicable to most entity types.
Below is the command panel showing Mesh. Here, the second row shows the various entity types. The third row shows operations that can be performed on those entity types. This hierarchy implies mesh operations tends to be more specific (when compared to geometry operations) to a given mesh entity.
In all cases, regardless of the button hierarchy, the user will finally be presented with a command panel. Shown is the command panel for creating lofted volume.
The edit fields are free form, which means the user may enter any valid string into the fields. Any string that is valid for the command line is valid for the command panel edit fields.
3.2.3 Drop Down Menus
The Cubit Drop-Down Menus, located at the top of the Cubit Application Window provide access to capabilities such as file management, checkpoints, display manipulation, journaling, system setup, component management, window management, and help.
3.2.3.1 Cubit (Mac Only)
This menu contains the Preferences dialog box, also called the Options dialog box on other platforms. It also contains the About Cubit menu and the Quit Cubit option. It is only available on Mac computers.
3.2.3.2 File
This menu provides common file operations, including importing and exporting of geometry and meshimport and export. A list of recently saved or imported files is also provided, allowing a quick way to import current or recent work. Non-Mac users can also exit and reset the program from this menu (These options are found under the Cubit tab for Mac Users).
3.2.3.3 Edit
This menu only provides a way to enable the Undo feature of the system. If Undo is enabled, one level of Undo is available to the user.
3.2.3.4 View
The View Menu lists all available toolbars and windows in the current Cubit session. Selecting a toolbar or window will make it visible. Deselecting a toolbar or window will hide it. You can also hide an undocked window or toolbar by clicking on the small "x" in the upper right corner. For more information on docking and undocking toolbars, see Cubit Application Window.
3.2.3.5 Display
View Point - Controls the camera view point. Choices are front, back, top, bottom, right, left and isometric views.
Render Mode - Controls visibility modes, including: wireframe, true hidden, hidden line, transparent, and shaded.
Geometry - Controls geometry visibility
Mesh - Controls mesh visibility
Graphics Composite - Controls the visibility of composited entities in the graphics window.
Refresh - Updates the graphics display
Background - Changes the background color
Zoom In - Enlarges the model in graphics window
Zoom Out -Shrinks the model in graphics window
Zoom To Fit - Enlarges or shrinks model in the graphics window so it fills the whole screen
Toggle Perspective - When this option is selected, the entities in the graphics display window are drawn in perspective mode.
Toggle Scale - Turns on or off a graphical scale that can be drawn in the graphics window to obtain a bearing on model or part sizes.
Toggle Clipping Plane - Turns on or off the graphics clipping plane
Toggle Clipping Plane Manipulation - Turns on or off manipulation of the graphics clipping plane
Show Curve Valence - Turns on or off the curve valence highlighting
3.2.3.6 Tools
Journal Editor - Opens journal file editor. The Journal Editor is used to write, edit, play, and save journal files. It can also be used to create and edit Python scripts. A built-in translator will convert between the two files types.
Play Journal File - Plays a specified journal file. You can browse through files and folders on your computer to select the journal file to play.
Options - Opens the Option dialog box. This dialog box controls all of the preferences for the GUI including display colors and widths, mouse settings, journal file options, mesh and geometry defaults, and general layout preferences. MAC users can find this menu under the Cubit tab.
Components - Opens the Components dialog box. This window is used to load and unload external and internal components.
3.2.3.7 Help
Tip of the Day - Open the tip of the day box.
Cubit Tutorials - Opens a menu of step-by-step tutorials for Cubit.
Cubit Manual - Menu to bring up on-line searchable documentation (this document).
About - Menu to show the current version number and trademark information. Mac users can find the version number under the About Cubit menu in the Cubit drop-down.
3.2.4 Options Menu
To change program preferences in the Graphical User Interface select: Tools > Options .
Mac users reach this dialog box by selecting the Cubit > Preferences menu.
3.2.4.1 Command Panels
This menu controls certain behaviors on all command panels.
Automatic Input Field Focus – If checked, when the user clicks the ’Apply’ button to generate a command, input focus will be given to the first field on the command panel.
Automatic Panel Reset – If checked, when the user clicks the ’Apply’ button, the contents of the command panel will be reset to default values.
Hide Mesh Warning – Is a user attempts to mesh an entity that already contains a mesh, a warning will be shown to the user indicating the situation. If this option is checked, the warning will not be shown.
3.2.4.2 Display Preferences
This menu controls entity display features for the graphics window which include the following:
Highlight Surfaces when Highlighting Volume
Set the Graphics Axis to Axis, Origin, or None.
3.2.4.3 General Preferences
This menu controls general program options including the following:
Prompt for Unsaved Application Data - When this is checked and the user opens a new .cub file or exits the application with unsaved changes, a dialog box will pop up asking if they want to save changes first. The user can uncheck this option to prevent that dialog box from appearing. This is checked by default.
Prompt for Unsaved Journal Data - When this button is checked and the user closes the journal file editor with unsaved changes the program will prompt to save the changes. The user can uncheck this button to prevent the dialog box from appearing. It is checked by default.
Change to Script Directory for Playback - When this option is checked, Claro will change the working directory to the directory the script is in when the script/journal file is run. When the script is finished, Claro will change the directory back to the previous one. This is useful when using relative paths in a journal file. When the option is unchecked, Claro won’t change the directory when a journal file is run in which case the user may have to manually change the working directory when their journal file has relative paths.
Prompt When Translating from Python - When checked, if the user translates a python script to a Cubit journal file, the journal editor will warn them that commands may be lost. When unchecked, the journal editor will not issue the warning. There is a checkbox on the warning dialog that sets this option as well.
Default Syntax - Sets the default syntax to use when creating a new journal file in the editor. The Cubit option is only available when the Cubit component is loaded.
Enable Focus Follows Cursor in Command Window – If checked, the focus will be automatically given to the command window when the user moves the cursor into the command window.
Show Startup Splash Screen - Option to hide the startup splash screen on opening Claro.
3.2.4.4 Geometry Defaults
This menu controls the geometry defaults.
Custom Colors for Geometry – The user may specify that all surfaces, curves, and/or vertices are to be colored uniformly.
The user can also change the default geometry engine to one of the following:
The faceting tolerance can also be controlled from this menu to change the way facets are drawn in the graphics window. The default file format may be set.
Cubit (*.Cubit) – HDF5 Cubit files contain the same information stored in Cubit files, that is, geometry, mesh, and mesh containers. In addition, a Cubit file includes the journal file used to create the model. Including the journal file is user-definable. The Cubit file is stored in HDF5 format making it possible for 3rd parties to store related data in the same file without disturbing the operation of Cubit.
Cubit (*.cub)
Mesh Auto Delete
Auto Delete On – When toggled on, will execute the command, "set mesh autodelete on". When toggled off, will execute the command "set mesh autodelete off".
3.2.4.5 History Preferences
This menu controls the input window history and journal file options. These include:
Maximum Number of Commands - The max number of commands kept in the current command history.
Comment Line Filtering - Whether to count comments in command history.
Maximum Number of Lines - Maximum number of lines in input window.
Journal Command History - Whether to use a journal file to save command history. Default is to use a journal file.
Journal File Directory - Where the journal file will be saved. Default is the starting directory.
Journal File Name - The name of the journal file. A name will be given by default if one is not specified. The default name for the GUI version of Cubit is historyxx.jou with xx as the highest used number between 01 and 999 incremented by 1.
3.2.4.5.1 Cubit History Preferences
Use Cubit Journaling - When this option is checked, Cubit journaling will be used. By default it is checked.
Output Log - When this option is checked, you can save error log to a separate output file.
3.2.4.6 Label Defaults
This menu controls the geometry and mesh entity labels in the graphics window.
Label Geometry and Mesh Entities Toggles- Choose label visibility for each type of geometry or mesh entity
3.2.4.7 Layout Preferences
This menu option controls input window formatting and control panel docking options.
Font for command line workspace
Font size for command line workspace
Reset Window Layout Button - Used to reset GUI windows to their default positions
Also included in the layout preferences is a list of available windows with a checkbox to show/hide each window.
3.2.4.7.1 Cubit Layout Settings
This menu controls the layout of Cubit specific buttons and tabs on the GUI.
Toolbars and Docking Windows - Show/hide various toolbars and docking windows.
Show script tab - Shows the script tab on the command line window
Window Tab Position - various Cubit tools are contained in Tabbed windows. The tabs can be shown at the top, bottom, left-side, or right-side of the window.
3.2.4.8 Mesh Defaults
Mesh Line Color - The same as "Color Lines" command.
Default Element Type - Tet/Tri or Hex/Quad
Surface Scheme Coloring (used in Meshing Power Tool) - This option allows you to select different colors for surface schemes when visualized using the meshing power tools.
3.2.4.9 Mouse Settings
This menu controls mouse button controls. Pressing the Emulate Command Line Settings button will cause all of the settings to simulate mouse controls in the command line version of Cubit. For a detailed description of mouse settings see the View Navigation-GUI page.
3.2.4.10 Post Meshing Settings
Executable – Specify an executable file to launch when the button is pressed
Arguments – Indicate the arguments that will be passed to the executable
Script – Provide a path to a script (journal file or python script) which will be run BEFORE launching the executable.
3.2.4.11 Quality Defaults
This menu controls quality defaults for different quality metrics. For a description of the different quality metrics see the respective pages:
3.2.5 Undo Button
Cubit has an undo capability. To enable the Undo feature click on the Enable Undo button on the Toolbar.
With undo enabled, click the undo button to reverse operations.
Alternatively to turn undo on and off, the following command may be used in the command line:
undo {on|off}
The Undo capability is implemented for geometry and some meshing commands including webcutting, geometry creation, transformations, and booleans. The commands will be undone in reverse order of their execution.
3.2.5.1 Limitations
The undo button is not currently enabled for some meshing commands
3.2.6 Graphics Window
3.2.6.1 Viewing Curve Valence
To view your model based on a color-coded curve valence scale, click on the curve valence button on the Display Toolbar. Curve valence refers to the number of surfaces attached to each curve. Curves with exactly two surfaces attached are shown in blue. Curves with exactly one surface are shown in red. Curves with more than two attached surfaces are shown in white.
