#include <panel.h>
Signals | |
| void | configChanged () |
| Subclasses must emit this whenever a configuration change happens. | |
Public Member Functions | |
| virtual QString | getClassId () const |
| Return the class identifier which was used to create this instance. This version just returns whatever was set with setClassId(). | |
| virtual QString | getDescription () const |
| Return a description of this Panel. | |
| virtual QString | getName () const |
| void | initialize (VisualizationManager *manager) |
| virtual void | load (const Config &config) |
| Override to load configuration data. This version loads the name of the panel. | |
| virtual void | onInitialize () |
| Panel (QWidget *parent=0) | |
| virtual void | save (Config config) const |
| Override to save configuration data. This version saves the name and class ID of the panel. | |
| virtual void | setClassId (const QString &class_id) |
| Set the class identifier used to create this instance. Typically this will be set by the factory object which created it. | |
| virtual void | setDescription (const QString &description) |
| Set a description of this Panel. Called by the factory which creates it. | |
| virtual void | setName (const QString &name) |
| virtual | ~Panel () |
Protected Attributes | |
| VisualizationManager * | vis_manager_ |
Private Attributes | |
| QString | class_id_ |
| QString | description_ |
| QString | name_ |
Detailed Description
Constructor & Destructor Documentation
| rviz::Panel::Panel | ( | QWidget * | parent = 0 | ) |
| rviz::Panel::~Panel | ( | ) | [virtual] |
Member Function Documentation
| void rviz::Panel::configChanged | ( | ) | [signal] |
Subclasses must emit this whenever a configuration change happens.
This is used to let the system know that changes have been made since the last time the config was saved.
| virtual QString rviz::Panel::getClassId | ( | ) | const [inline, virtual] |
Return the class identifier which was used to create this instance. This version just returns whatever was set with setClassId().
| virtual QString rviz::Panel::getDescription | ( | ) | const [inline, virtual] |
| virtual QString rviz::Panel::getName | ( | void | ) | const [inline, virtual] |
| void rviz::Panel::initialize | ( | VisualizationManager * | manager | ) |
Initialize the panel with a VisualizationManager. Called by VisualizationFrame during setup.
| void rviz::Panel::load | ( | const Config & | config | ) | [virtual] |
Override to load configuration data. This version loads the name of the panel.
Reimplemented in rviz::TimePanel, rviz::ViewsPanel, rviz::DisplaysPanel, rviz::ToolPropertiesPanel, and rviz::FailedPanel.
| virtual void rviz::Panel::onInitialize | ( | ) | [inline, virtual] |
Override to do initialization which depends on the VisualizationManager being available. This base implementation does nothing.
Reimplemented in rviz::DisplaysPanel, rviz::TimePanel, rviz::ViewsPanel, rviz::ToolPropertiesPanel, rviz::HelpPanel, and rviz::SelectionPanel.
| void rviz::Panel::save | ( | Config | config | ) | const [virtual] |
Override to save configuration data. This version saves the name and class ID of the panel.
Reimplemented in rviz::TimePanel, rviz::ViewsPanel, rviz::DisplaysPanel, rviz::ToolPropertiesPanel, and rviz::FailedPanel.
| virtual void rviz::Panel::setClassId | ( | const QString & | class_id | ) | [inline, virtual] |
| virtual void rviz::Panel::setDescription | ( | const QString & | description | ) | [inline, virtual] |
| virtual void rviz::Panel::setName | ( | const QString & | name | ) | [inline, virtual] |
Member Data Documentation
QString rviz::Panel::class_id_ [private] |
QString rviz::Panel::description_ [private] |
QString rviz::Panel::name_ [private] |
VisualizationManager* rviz::Panel::vis_manager_ [protected] |
The documentation for this class was generated from the following files: