The main rviz window.
More...
#include <visualization_frame.h>
|
void | fullScreenChange (bool hidden) |
| Emitted when the interface enters or leaves full screen mode. More...
|
|
void | statusUpdate (const QString &message) |
| Emitted during file-loading and initialization to indicate progress. More...
|
|
|
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 71 of file visualization_frame.h.
rviz::VisualizationFrame::VisualizationFrame |
( |
QWidget * |
parent = 0 | ) |
|
rviz::VisualizationFrame::~VisualizationFrame |
( |
| ) |
|
PanelDockWidget * rviz::VisualizationFrame::addPane |
( |
const QString & |
name, |
|
|
QWidget * |
pane, |
|
|
Qt::DockWidgetArea |
area = Qt::LeftDockWidgetArea , |
|
|
bool |
floating = true |
|
) |
| |
|
virtual |
QDockWidget * rviz::VisualizationFrame::addPanelByName |
( |
const QString & |
name, |
|
|
const QString & |
class_lookup_name, |
|
|
Qt::DockWidgetArea |
area = Qt::LeftDockWidgetArea , |
|
|
bool |
floating = true |
|
) |
| |
void rviz::VisualizationFrame::addTool |
( |
Tool * |
tool | ) |
|
|
protectedslot |
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 225 of file visualization_frame.cpp.
void rviz::VisualizationFrame::closeEvent |
( |
QCloseEvent * |
event | ) |
|
|
protectedvirtual |
void rviz::VisualizationFrame::configureToolbars |
( |
const Config & |
config | ) |
|
|
protected |
Applies the user defined toolbar configuration from the given config node.
Definition at line 872 of file visualization_frame.cpp.
void rviz::VisualizationFrame::exitFullScreen |
( |
| ) |
|
|
protectedslot |
void rviz::VisualizationFrame::fullScreenChange |
( |
bool |
hidden | ) |
|
|
signal |
Emitted when the interface enters or leaves full screen mode.
QString rviz::VisualizationFrame::getErrorMessage |
( |
| ) |
const |
|
inline |
QWidget * rviz::VisualizationFrame::getParentWindow |
( |
| ) |
|
|
virtual |
void rviz::VisualizationFrame::hideDockImpl |
( |
Qt::DockWidgetArea |
area, |
|
|
bool |
hide |
|
) |
| |
|
protected |
void rviz::VisualizationFrame::hideLeftDock |
( |
bool |
hide | ) |
|
|
protectedslot |
void rviz::VisualizationFrame::hideRightDock |
( |
bool |
hide | ) |
|
|
protectedslot |
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 1193 of file visualization_frame.cpp.
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 378 of file visualization_frame.cpp.
void rviz::VisualizationFrame::initialize |
( |
const QString & |
display_config_file = "" | ) |
|
void rviz::VisualizationFrame::initMenus |
( |
| ) |
|
|
protected |
void rviz::VisualizationFrame::initToolbars |
( |
| ) |
|
|
protected |
Sets up the top toolbar with QToolbuttions for adding/deleting tools and modifiying the tool view.
Definition at line 491 of file visualization_frame.cpp.
void rviz::VisualizationFrame::leaveEvent |
( |
QEvent * |
event | ) |
|
|
protectedvirtual |
void rviz::VisualizationFrame::load |
( |
const Config & |
config | ) |
|
|
virtual |
void rviz::VisualizationFrame::loadDisplayConfig |
( |
const QString & |
path | ) |
|
Load display and other settings from the given file.
- Parameters
-
path | The full path of the config file to load from. |
Definition at line 702 of file visualization_frame.cpp.
void rviz::VisualizationFrame::loadPanels |
( |
const Config & |
config | ) |
|
|
protected |
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 400 of file visualization_frame.cpp.
void rviz::VisualizationFrame::loadWindowGeometry |
( |
const Config & |
config | ) |
|
|
protected |
void rviz::VisualizationFrame::markLoadingDone |
( |
| ) |
|
|
protectedslot |
void rviz::VisualizationFrame::markRecentConfig |
( |
const std::string & |
path | ) |
|
|
protected |
void rviz::VisualizationFrame::onButtonStyleTool |
( |
QAction * |
button_style_tool_menu_action | ) |
|
|
protectedslot |
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 1275 of file visualization_frame.cpp.
void rviz::VisualizationFrame::onDockPanelChange |
( |
| ) |
|
|
protectedslot |
void rviz::VisualizationFrame::onDockPanelVisibilityChange |
( |
bool |
visible | ) |
|
|
protectedvirtualslot |
void rviz::VisualizationFrame::onHelpAbout |
( |
| ) |
|
|
protectedslot |
void rviz::VisualizationFrame::onHelpDestroyed |
( |
| ) |
|
|
protectedslot |
void rviz::VisualizationFrame::onHelpWiki |
( |
| ) |
|
|
protectedslot |
void rviz::VisualizationFrame::onOpen |
( |
| ) |
|
|
protectedslot |
void rviz::VisualizationFrame::onRecentConfigSelected |
( |
| ) |
|
|
protectedslot |
void rviz::VisualizationFrame::onSave |
( |
| ) |
|
|
protectedslot |
void rviz::VisualizationFrame::onSaveAs |
( |
| ) |
|
|
protectedslot |
void rviz::VisualizationFrame::onSaveImage |
( |
| ) |
|
|
protectedslot |
void rviz::VisualizationFrame::onToolbarActionTriggered |
( |
QAction * |
action | ) |
|
|
protectedslot |
void rviz::VisualizationFrame::onToolbarRemoveTool |
( |
QAction * |
remove_tool_menu_action | ) |
|
|
protectedslot |
void rviz::VisualizationFrame::openNewPanelDialog |
( |
| ) |
|
|
protectedslot |
void rviz::VisualizationFrame::openNewToolDialog |
( |
| ) |
|
|
protectedslot |
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 957 of file visualization_frame.cpp.
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 1186 of file visualization_frame.cpp.
void rviz::VisualizationFrame::removeTool |
( |
Tool * |
tool | ) |
|
|
protectedslot |
void rviz::VisualizationFrame::reset |
( |
| ) |
|
|
protectedslot |
void rviz::VisualizationFrame::save |
( |
Config |
config | ) |
|
|
virtual |
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 790 of file visualization_frame.cpp.
void rviz::VisualizationFrame::savePanels |
( |
Config |
config | ) |
|
|
protected |
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 429 of file visualization_frame.cpp.
void rviz::VisualizationFrame::saveToolbars |
( |
Config |
config | ) |
|
|
protected |
void rviz::VisualizationFrame::saveWindowGeometry |
( |
Config |
config | ) |
|
|
protected |
void rviz::VisualizationFrame::setApp |
( |
QApplication * |
app | ) |
|
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 774 of file visualization_frame.cpp.
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 763 of file visualization_frame.cpp.
void rviz::VisualizationFrame::setFullScreen |
( |
bool |
full_screen | ) |
|
|
protectedslot |
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 238 of file visualization_frame.cpp.
void rviz::VisualizationFrame::setHideButtonVisibility |
( |
bool |
visible | ) |
|
void rviz::VisualizationFrame::setImageSaveDirectory |
( |
const QString & |
directory | ) |
|
|
protectedslot |
void rviz::VisualizationFrame::setShowChooseNewMaster |
( |
bool |
show | ) |
|
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 244 of file visualization_frame.cpp.
void rviz::VisualizationFrame::setStatus |
( |
const QString & |
message | ) |
|
|
virtualslot |
void rviz::VisualizationFrame::showHelpPanel |
( |
| ) |
|
|
protectedslot |
void rviz::VisualizationFrame::statusUpdate |
( |
const QString & |
message | ) |
|
|
signal |
Emitted during file-loading and initialization to indicate progress.
void rviz::VisualizationFrame::updateFps |
( |
| ) |
|
|
protectedslot |
void rviz::VisualizationFrame::updateRecentConfigMenu |
( |
| ) |
|
|
protected |
std::map<QAction*,Tool*> rviz::VisualizationFrame::action_to_tool_map_ |
|
protected |
QAction* rviz::VisualizationFrame::add_tool_action_ |
|
protected |
QApplication* rviz::VisualizationFrame::app_ |
|
protected |
std::string rviz::VisualizationFrame::config_dir_ |
|
protected |
QList<PanelRecord> rviz::VisualizationFrame::custom_panels_ |
|
protected |
std::string rviz::VisualizationFrame::default_display_config_file_ |
|
protected |
QMenu* rviz::VisualizationFrame::delete_view_menu_ |
|
protected |
std::string rviz::VisualizationFrame::display_config_file_ |
|
protected |
QString rviz::VisualizationFrame::error_message_ |
|
protected |
QMenu* rviz::VisualizationFrame::file_menu_ |
|
protected |
QLabel* rviz::VisualizationFrame::fps_label_ |
|
protected |
int rviz::VisualizationFrame::frame_count_ |
|
protected |
QString rviz::VisualizationFrame::help_path_ |
|
protected |
QToolButton* rviz::VisualizationFrame::hide_left_dock_button_ |
|
protected |
QToolButton* rviz::VisualizationFrame::hide_right_dock_button_ |
|
protected |
std::string rviz::VisualizationFrame::home_dir_ |
|
protected |
bool rviz::VisualizationFrame::initialized_ |
|
protected |
std::string rviz::VisualizationFrame::last_config_dir_ |
|
protected |
std::string rviz::VisualizationFrame::last_image_dir_ |
|
protected |
bool rviz::VisualizationFrame::loading_ |
|
protected |
True just when loading a display config file, false all other times.
Definition at line 362 of file visualization_frame.h.
QStatusBar* rviz::VisualizationFrame::original_status_bar_ |
|
protected |
std::string rviz::VisualizationFrame::package_path_ |
|
protected |
std::string rviz::VisualizationFrame::persistent_settings_file_ |
|
protected |
QMenu* rviz::VisualizationFrame::plugins_menu_ |
|
protected |
QTimer* rviz::VisualizationFrame::post_load_timer_ |
|
protected |
D_string rviz::VisualizationFrame::recent_configs_ |
|
protected |
QMenu* rviz::VisualizationFrame::recent_configs_menu_ |
|
protected |
QMenu* rviz::VisualizationFrame::remove_tool_menu_ |
|
protected |
bool rviz::VisualizationFrame::show_choose_new_master_option_ |
|
protected |
QAction* rviz::VisualizationFrame::show_help_action_ |
|
protected |
QSplashScreen* rviz::VisualizationFrame::splash_ |
|
protected |
QString rviz::VisualizationFrame::splash_path_ |
|
protected |
QLabel* rviz::VisualizationFrame::status_label_ |
|
protected |
std::map<Tool*,QAction*> rviz::VisualizationFrame::tool_to_action_map_ |
|
protected |
QToolBar* rviz::VisualizationFrame::toolbar_ |
|
protected |
QActionGroup* rviz::VisualizationFrame::toolbar_actions_ |
|
protected |
bool rviz::VisualizationFrame::toolbar_visible_ |
|
protected |
Indicates if the toolbar should be visible outside of fullscreen mode.
Definition at line 375 of file visualization_frame.h.
QMenu* rviz::VisualizationFrame::view_menu_ |
|
protected |
The documentation for this class was generated from the following files: