Signals | Public Member Functions | Protected Attributes | Private Attributes
rviz::Panel Class Reference

#include <panel.h>

Inheritance diagram for rviz::Panel:
Inheritance graph
[legend]

List of all members.

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

VisualizationManagervis_manager_

Private Attributes

QString class_id_
QString description_
QString name_

Detailed Description

Definition at line 41 of file panel.h.


Constructor & Destructor Documentation

rviz::Panel::Panel ( QWidget *  parent = 0)

Definition at line 37 of file panel.cpp.

rviz::Panel::~Panel ( ) [virtual]

Definition at line 42 of file panel.cpp.


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().

Definition at line 71 of file panel.h.

virtual QString rviz::Panel::getDescription ( ) const [inline, virtual]

Return a description of this Panel.

Definition at line 63 of file panel.h.

virtual QString rviz::Panel::getName ( void  ) const [inline, virtual]

Definition at line 59 of file panel.h.

Initialize the panel with a VisualizationManager. Called by VisualizationFrame during setup.

Definition at line 46 of file panel.cpp.

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.

Definition at line 58 of file panel.cpp.

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.

Definition at line 57 of file panel.h.

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.

Definition at line 52 of file panel.cpp.

virtual void rviz::Panel::setClassId ( const QString &  class_id) [inline, virtual]

Set the class identifier used to create this instance. Typically this will be set by the factory object which created it.

Definition at line 75 of file panel.h.

virtual void rviz::Panel::setDescription ( const QString &  description) [inline, virtual]

Set a description of this Panel. Called by the factory which creates it.

Definition at line 66 of file panel.h.

virtual void rviz::Panel::setName ( const QString &  name) [inline, virtual]

Definition at line 60 of file panel.h.


Member Data Documentation

QString rviz::Panel::class_id_ [private]

Definition at line 95 of file panel.h.

QString rviz::Panel::description_ [private]

Definition at line 97 of file panel.h.

QString rviz::Panel::name_ [private]

Definition at line 96 of file panel.h.

Definition at line 92 of file panel.h.


The documentation for this class was generated from the following files:


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Thu Aug 27 2015 15:02:29