The main rviz window.
More...
#include <visualization_frame.h>
|
PanelDockWidget * | addPane (const QString &name, QWidget *panel, Qt::DockWidgetArea area=Qt::LeftDockWidgetArea, bool floating=false) override |
|
QDockWidget * | addPanelByName (const QString &name, const QString &class_lookup_name, Qt::DockWidgetArea area=Qt::LeftDockWidgetArea, bool floating=false) |
|
QString | getErrorMessage () const |
|
VisualizationManager * | getManager () |
|
QWidget * | getParentWindow () override |
|
void | initialize (const QString &display_config_file="") |
| Initialize the visualizer. Creates the VisualizationManager. More...
|
|
virtual void | load (const Config &config) |
| Load the properties of all subsystems from the given Config. More...
|
|
void | loadDisplayConfig (const QString &path) |
| Load display and other settings from the given file. More...
|
|
bool | loadDisplayConfigHelper (const std::string &full_path, const bool discard_changes=false) |
| Load display and other settings from the given full file path. More...
|
|
void | loadPersistentSettings () |
| Load the "general" config file, which has just the few things which should not be saved with a display config. More...
|
|
virtual void | save (Config config) |
| Save the properties of each subsystem and most editable rviz data. More...
|
|
bool | saveDisplayConfig (const QString &path) |
| Save display and other settings to the given file. More...
|
|
void | savePersistentSettings () |
| Save the "general" config file, which has just the few things which should not be saved with a display config. More...
|
|
void | setApp (QApplication *app) |
|
void | setHelpPath (const QString &help_path) |
| Set the path to the help file. Should contain HTML. Default is a file in the RViz package. More...
|
|
void | setHideButtonVisibility (bool visible) |
| Hide or show the hide-dock buttons. More...
|
|
void | setShowChooseNewMaster (bool show) |
| Call this before initialize() to have it take effect. More...
|
|
void | setSplashPath (const QString &splash_path) |
| Set the path to the "splash" image file. This image is shown during initialization and loading of the first config file. Default is a file in the RViz package. To prevent splash image from showing, set this to an empty string. More...
|
|
| VisualizationFrame (QWidget *parent=nullptr) |
|
| ~VisualizationFrame () override |
|
virtual void | setStatus (const QString &message)=0 |
|
|
typedef std::deque< std::string > | D_string |
|
The main rviz window.
VisualizationFrame is a QMainWindow, which means it has a center area and a bunch of dock areas around it. The central widget here is a RenderPanel, and around it (by default) are a DisplaysPanel, ViewsPanel, TimePanel, SelectionPanel, and ToolPropertiesPanel. At the top is a toolbar with "Move Camera", "Select", etc. There is also a menu bar with file/open, etc.
Definition at line 74 of file visualization_frame.h.
◆ D_string
◆ VisualizationFrame()
rviz::VisualizationFrame::VisualizationFrame |
( |
QWidget * |
parent = nullptr | ) |
|
◆ ~VisualizationFrame()
rviz::VisualizationFrame::~VisualizationFrame |
( |
| ) |
|
|
override |
◆ addPane()
PanelDockWidget * rviz::VisualizationFrame::addPane |
( |
const QString & |
name, |
|
|
QWidget * |
pane, |
|
|
Qt::DockWidgetArea |
area = Qt::LeftDockWidgetArea , |
|
|
bool |
floating = false |
|
) |
| |
|
overridevirtual |
◆ addPanelByName()
QDockWidget * rviz::VisualizationFrame::addPanelByName |
( |
const QString & |
name, |
|
|
const QString & |
class_lookup_name, |
|
|
Qt::DockWidgetArea |
area = Qt::LeftDockWidgetArea , |
|
|
bool |
floating = false |
|
) |
| |
◆ addTool
void rviz::VisualizationFrame::addTool |
( |
Tool * |
tool | ) |
|
|
protectedslot |
◆ changeMaster
void rviz::VisualizationFrame::changeMaster |
( |
| ) |
|
|
protectedslot |
Save the current state and quit with exit code 255 to signal the wrapper that we would like to restart with a different ROS master URI.
Definition at line 219 of file visualization_frame.cpp.
◆ closeEvent()
void rviz::VisualizationFrame::closeEvent |
( |
QCloseEvent * |
event | ) |
|
|
overrideprotected |
◆ configureToolbars()
void rviz::VisualizationFrame::configureToolbars |
( |
const Config & |
config | ) |
|
|
protected |
Applies the user defined toolbar configuration from the given config node.
Definition at line 915 of file visualization_frame.cpp.
◆ displayConfigFileChanged
void rviz::VisualizationFrame::displayConfigFileChanged |
( |
const QString & |
fullpath | ) |
|
|
signal |
Emitted when the config file has changed.
◆ exitFullScreen
void rviz::VisualizationFrame::exitFullScreen |
( |
| ) |
|
|
slot |
◆ fullScreenChange
void rviz::VisualizationFrame::fullScreenChange |
( |
bool |
hidden | ) |
|
|
signal |
Emitted when the interface enters or leaves full screen mode.
◆ getErrorMessage()
QString rviz::VisualizationFrame::getErrorMessage |
( |
| ) |
const |
|
inline |
◆ getManager()
◆ getParentWindow()
QWidget * rviz::VisualizationFrame::getParentWindow |
( |
| ) |
|
|
overridevirtual |
◆ hideDockImpl()
void rviz::VisualizationFrame::hideDockImpl |
( |
Qt::DockWidgetArea |
area, |
|
|
bool |
hide |
|
) |
| |
|
protected |
◆ hideLeftDock
void rviz::VisualizationFrame::hideLeftDock |
( |
bool |
hide | ) |
|
|
protectedslot |
◆ hideRightDock
void rviz::VisualizationFrame::hideRightDock |
( |
bool |
hide | ) |
|
|
protectedslot |
◆ indicateToolIsCurrent
void rviz::VisualizationFrame::indicateToolIsCurrent |
( |
Tool * |
tool | ) |
|
|
protectedslot |
Mark the given tool as the current one.
This is purely a visual change in the GUI, it does not call any tool functions.
Definition at line 1261 of file visualization_frame.cpp.
◆ initConfigs()
void rviz::VisualizationFrame::initConfigs |
( |
| ) |
|
|
protected |
Initialize the default config directory (~/.rviz) and set up the persistent_settings_file_ and display_config_file_ variables.
Definition at line 382 of file visualization_frame.cpp.
◆ initialize()
void rviz::VisualizationFrame::initialize |
( |
const QString & |
display_config_file = "" | ) |
|
◆ initMenus()
void rviz::VisualizationFrame::initMenus |
( |
| ) |
|
|
protected |
◆ initToolbars()
void rviz::VisualizationFrame::initToolbars |
( |
| ) |
|
|
protected |
Sets up the top toolbar with QToolbuttions for adding/deleting tools and modifiying the tool view.
Definition at line 503 of file visualization_frame.cpp.
◆ leaveEvent()
void rviz::VisualizationFrame::leaveEvent |
( |
QEvent * |
event | ) |
|
|
overrideprotected |
◆ load()
void rviz::VisualizationFrame::load |
( |
const Config & |
config | ) |
|
|
virtual |
◆ loadDisplayConfig()
void rviz::VisualizationFrame::loadDisplayConfig |
( |
const QString & |
path | ) |
|
Load display and other settings from the given file.
- Parameters
-
path | The path of the config file to load from. |
- Returns
- True on success, False on failure.
Definition at line 724 of file visualization_frame.cpp.
◆ loadDisplayConfigHelper()
bool rviz::VisualizationFrame::loadDisplayConfigHelper |
( |
const std::string & |
full_path, |
|
|
const bool |
discard_changes = false |
|
) |
| |
Load display and other settings from the given full file path.
- Parameters
-
full_path | The (absolute) path to the config file to load |
discard_changes | Flag indicating whether to discard any unsaved config changes |
- Returns
- True on success, False on failure.
Definition at line 752 of file visualization_frame.cpp.
◆ loadPanels()
void rviz::VisualizationFrame::loadPanels |
( |
const Config & |
config | ) |
|
|
protected |
◆ loadPersistentSettings()
void rviz::VisualizationFrame::loadPersistentSettings |
( |
| ) |
|
Load the "general" config file, which has just the few things which should not be saved with a display config.
Loads from the file named in persistent_settings_file_.
Definition at line 404 of file visualization_frame.cpp.
◆ loadPreferences()
void rviz::VisualizationFrame::loadPreferences |
( |
const Config & |
config | ) |
|
|
protected |
◆ loadWindowGeometry()
void rviz::VisualizationFrame::loadWindowGeometry |
( |
const Config & |
config | ) |
|
|
protected |
◆ markLoadingDone
void rviz::VisualizationFrame::markLoadingDone |
( |
| ) |
|
|
protectedslot |
◆ markRecentConfig()
void rviz::VisualizationFrame::markRecentConfig |
( |
const std::string & |
path | ) |
|
|
protected |
◆ onButtonStyleTool
void rviz::VisualizationFrame::onButtonStyleTool |
( |
QAction * |
button_style_tool_menu_action | ) |
|
|
protectedslot |
◆ onDeletePanel
void rviz::VisualizationFrame::onDeletePanel |
( |
| ) |
|
|
protectedslot |
Delete a panel widget.
The sender() of the signal should be a QAction whose text() is the name of the panel.
Definition at line 1348 of file visualization_frame.cpp.
◆ onDockPanelChange
void rviz::VisualizationFrame::onDockPanelChange |
( |
| ) |
|
|
protectedslot |
◆ onDockPanelVisibilityChange
void rviz::VisualizationFrame::onDockPanelVisibilityChange |
( |
bool |
visible | ) |
|
|
protectedvirtualslot |
◆ onHelpAbout
void rviz::VisualizationFrame::onHelpAbout |
( |
| ) |
|
|
protectedslot |
◆ onHelpDestroyed
void rviz::VisualizationFrame::onHelpDestroyed |
( |
| ) |
|
|
protectedslot |
◆ onHelpWiki
void rviz::VisualizationFrame::onHelpWiki |
( |
| ) |
|
|
protectedslot |
◆ onOpen
void rviz::VisualizationFrame::onOpen |
( |
| ) |
|
|
protectedslot |
◆ onPanelDeleted
void rviz::VisualizationFrame::onPanelDeleted |
( |
QObject * |
dock | ) |
|
|
protectedslot |
◆ onRecentConfigSelected
void rviz::VisualizationFrame::onRecentConfigSelected |
( |
| ) |
|
|
protectedslot |
◆ onSave
void rviz::VisualizationFrame::onSave |
( |
| ) |
|
|
protectedslot |
◆ onSaveAs
void rviz::VisualizationFrame::onSaveAs |
( |
| ) |
|
|
protectedslot |
◆ onSaveImage
void rviz::VisualizationFrame::onSaveImage |
( |
| ) |
|
|
protectedslot |
◆ onToolbarActionTriggered
void rviz::VisualizationFrame::onToolbarActionTriggered |
( |
QAction * |
action | ) |
|
|
protectedslot |
◆ onToolbarRemoveTool
void rviz::VisualizationFrame::onToolbarRemoveTool |
( |
QAction * |
remove_tool_menu_action | ) |
|
|
protectedslot |
◆ onToolNameChanged
void rviz::VisualizationFrame::onToolNameChanged |
( |
const QString & |
name | ) |
|
|
protectedslot |
◆ openNewPanelDialog
void rviz::VisualizationFrame::openNewPanelDialog |
( |
| ) |
|
|
protectedslot |
◆ openNewToolDialog
void rviz::VisualizationFrame::openNewToolDialog |
( |
| ) |
|
|
protectedslot |
◆ openPreferencesDialog
void rviz::VisualizationFrame::openPreferencesDialog |
( |
| ) |
|
|
protectedslot |
◆ prepareToExit()
bool rviz::VisualizationFrame::prepareToExit |
( |
| ) |
|
|
protected |
Check for unsaved changes, prompt to save config, etc.
- Returns
- true if it is OK to exit, false if not.
Definition at line 1008 of file visualization_frame.cpp.
◆ refreshTool
void rviz::VisualizationFrame::refreshTool |
( |
Tool * |
tool | ) |
|
|
protectedslot |
Refresh the given tool in this frame's' toolbar.
This will update the icon and the text of the corresponding QAction.
Definition at line 1254 of file visualization_frame.cpp.
◆ removeTool
void rviz::VisualizationFrame::removeTool |
( |
Tool * |
tool | ) |
|
|
protectedslot |
◆ reset
void rviz::VisualizationFrame::reset |
( |
| ) |
|
|
protectedslot |
◆ save()
void rviz::VisualizationFrame::save |
( |
Config |
config | ) |
|
|
virtual |
◆ saveDisplayConfig()
bool rviz::VisualizationFrame::saveDisplayConfig |
( |
const QString & |
path | ) |
|
Save display and other settings to the given file.
- Parameters
-
path | The full path of the config file to save into. |
- Returns
- True on success, False on failure.
On failure, also sets error_message_ with information about the problem. Can be retrieved with getErrorMessage().
Definition at line 833 of file visualization_frame.cpp.
◆ savePanels()
void rviz::VisualizationFrame::savePanels |
( |
Config |
config | ) |
|
|
protected |
◆ savePersistentSettings()
void rviz::VisualizationFrame::savePersistentSettings |
( |
| ) |
|
Save the "general" config file, which has just the few things which should not be saved with a display config.
Saves to the file named in persistent_settings_file_.
Definition at line 433 of file visualization_frame.cpp.
◆ savePreferences()
void rviz::VisualizationFrame::savePreferences |
( |
Config |
config | ) |
|
|
protected |
◆ saveToolbars()
void rviz::VisualizationFrame::saveToolbars |
( |
Config |
config | ) |
|
|
protected |
◆ saveWindowGeometry()
void rviz::VisualizationFrame::saveWindowGeometry |
( |
Config |
config | ) |
|
|
protected |
◆ setApp()
void rviz::VisualizationFrame::setApp |
( |
QApplication * |
app | ) |
|
◆ setDisplayConfigFile()
void rviz::VisualizationFrame::setDisplayConfigFile |
( |
const std::string & |
path | ) |
|
|
protected |
Set the display config file path.
This does not load the given file, it just sets the member variable and updates the window title.
Definition at line 816 of file visualization_frame.cpp.
◆ setDisplayConfigModified
void rviz::VisualizationFrame::setDisplayConfigModified |
( |
| ) |
|
|
slot |
Call this to let the frame know that something that would get saved in the display config has changed.
Definition at line 805 of file visualization_frame.cpp.
◆ setFullScreen
void rviz::VisualizationFrame::setFullScreen |
( |
bool |
full_screen | ) |
|
|
slot |
◆ setHelpPath()
void rviz::VisualizationFrame::setHelpPath |
( |
const QString & |
help_path | ) |
|
Set the path to the help file. Should contain HTML. Default is a file in the RViz package.
Definition at line 232 of file visualization_frame.cpp.
◆ setHideButtonVisibility()
void rviz::VisualizationFrame::setHideButtonVisibility |
( |
bool |
visible | ) |
|
◆ setImageSaveDirectory
void rviz::VisualizationFrame::setImageSaveDirectory |
( |
const QString & |
directory | ) |
|
|
protectedslot |
◆ setShowChooseNewMaster()
void rviz::VisualizationFrame::setShowChooseNewMaster |
( |
bool |
show | ) |
|
◆ setSplashPath()
void rviz::VisualizationFrame::setSplashPath |
( |
const QString & |
splash_path | ) |
|
Set the path to the "splash" image file. This image is shown during initialization and loading of the first config file. Default is a file in the RViz package. To prevent splash image from showing, set this to an empty string.
Definition at line 238 of file visualization_frame.cpp.
◆ setStatus
void rviz::VisualizationFrame::setStatus |
( |
const QString & |
message | ) |
|
|
overrideslot |
◆ showHelpPanel
void rviz::VisualizationFrame::showHelpPanel |
( |
| ) |
|
|
protectedslot |
◆ statusUpdate
void rviz::VisualizationFrame::statusUpdate |
( |
const QString & |
message | ) |
|
|
signal |
Emitted during file-loading and initialization to indicate progress.
◆ updateFps
void rviz::VisualizationFrame::updateFps |
( |
| ) |
|
|
protectedslot |
◆ updateRecentConfigMenu()
void rviz::VisualizationFrame::updateRecentConfigMenu |
( |
| ) |
|
|
protected |
◆ action_to_tool_map_
std::map<QAction*, Tool*> rviz::VisualizationFrame::action_to_tool_map_ |
|
protected |
◆ config_dir_
std::string rviz::VisualizationFrame::config_dir_ |
|
protected |
◆ custom_panels_
QList<PanelRecord> rviz::VisualizationFrame::custom_panels_ |
|
protected |
◆ default_display_config_file_
std::string rviz::VisualizationFrame::default_display_config_file_ |
|
protected |
◆ delete_view_menu_
QMenu* rviz::VisualizationFrame::delete_view_menu_ |
|
protected |
◆ display_config_file_
std::string rviz::VisualizationFrame::display_config_file_ |
|
protected |
◆ error_message_
QString rviz::VisualizationFrame::error_message_ |
|
protected |
◆ file_menu_
QMenu* rviz::VisualizationFrame::file_menu_ |
|
protected |
◆ fps_label_
QLabel* rviz::VisualizationFrame::fps_label_ |
|
protected |
◆ frame_count_
int rviz::VisualizationFrame::frame_count_ |
|
protected |
◆ geom_change_detector_
◆ help_path_
QString rviz::VisualizationFrame::help_path_ |
|
protected |
◆ hide_left_dock_button_
QToolButton* rviz::VisualizationFrame::hide_left_dock_button_ |
|
protected |
◆ hide_right_dock_button_
QToolButton* rviz::VisualizationFrame::hide_right_dock_button_ |
|
protected |
◆ home_dir_
std::string rviz::VisualizationFrame::home_dir_ |
|
protected |
◆ initialized_
bool rviz::VisualizationFrame::initialized_ |
|
protected |
◆ last_config_dir_
std::string rviz::VisualizationFrame::last_config_dir_ |
|
protected |
◆ last_fps_calc_time_
◆ last_image_dir_
std::string rviz::VisualizationFrame::last_image_dir_ |
|
protected |
◆ loading_
bool rviz::VisualizationFrame::loading_ |
|
protected |
True just when loading a display config file, false all other times.
Definition at line 389 of file visualization_frame.h.
◆ manager_
◆ original_status_bar_
QStatusBar* rviz::VisualizationFrame::original_status_bar_ |
|
protected |
◆ package_path_
std::string rviz::VisualizationFrame::package_path_ |
|
protected |
◆ panel_factory_
◆ persistent_settings_file_
std::string rviz::VisualizationFrame::persistent_settings_file_ |
|
protected |
◆ plugins_menu_
QMenu* rviz::VisualizationFrame::plugins_menu_ |
|
protected |
◆ post_load_timer_
QTimer* rviz::VisualizationFrame::post_load_timer_ |
|
protected |
◆ preferences_
◆ recent_configs_
D_string rviz::VisualizationFrame::recent_configs_ |
|
protected |
◆ recent_configs_menu_
QMenu* rviz::VisualizationFrame::recent_configs_menu_ |
|
protected |
◆ remove_tool_menu_
QMenu* rviz::VisualizationFrame::remove_tool_menu_ |
|
protected |
◆ render_panel_
◆ show_choose_new_master_option_
bool rviz::VisualizationFrame::show_choose_new_master_option_ |
|
protected |
◆ show_help_action_
QAction* rviz::VisualizationFrame::show_help_action_ |
|
protected |
◆ splash_
QSplashScreen* rviz::VisualizationFrame::splash_ |
|
protected |
◆ splash_path_
QString rviz::VisualizationFrame::splash_path_ |
|
protected |
◆ status_label_
QLabel* rviz::VisualizationFrame::status_label_ |
|
protected |
◆ tool_to_action_map_
std::map<Tool*, QAction*> rviz::VisualizationFrame::tool_to_action_map_ |
|
protected |
◆ toolbar_
QToolBar* rviz::VisualizationFrame::toolbar_ |
|
protected |
◆ toolbar_actions_
QActionGroup* rviz::VisualizationFrame::toolbar_actions_ |
|
protected |
◆ toolbar_separator_
QAction* rviz::VisualizationFrame::toolbar_separator_ |
|
protected |
◆ toolbar_visible_
bool rviz::VisualizationFrame::toolbar_visible_ |
|
protected |
Indicates if the toolbar should be visible outside of fullscreen mode.
Definition at line 403 of file visualization_frame.h.
◆ view_menu_
QMenu* rviz::VisualizationFrame::view_menu_ |
|
protected |
The documentation for this class was generated from the following files:
rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust, William Woodall
autogenerated on Fri Aug 2 2024 08:43:11