Signals | Public Member Functions | Protected Attributes | Private Attributes | List of all members
rviz::Panel Class Reference

#include <panel.h>

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

Signals

void configChanged ()
 Subclasses must emit this whenever a configuration change happens. More...
 

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(). More...
 
virtual QString getDescription () const
 Return a description of this Panel. More...
 
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. More...
 
virtual void onInitialize ()
 
 Panel (QWidget *parent=nullptr)
 
virtual void save (Config config) const
 Override to save configuration data. This version saves the name and class ID of the panel. More...
 
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. More...
 
virtual void setDescription (const QString &description)
 Set a description of this Panel. Called by the factory which creates it. More...
 
virtual void setName (const QString &name)
 
 ~Panel () override
 

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

◆ Panel()

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

Definition at line 36 of file panel.cpp.

◆ ~Panel()

rviz::Panel::~Panel ( )
override

Definition at line 40 of file panel.cpp.

Member Function Documentation

◆ configChanged

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.

◆ getClassId()

virtual QString rviz::Panel::getClassId ( ) const
inlinevirtual

Return the class identifier which was used to create this instance. This version just returns whatever was set with setClassId().

Definition at line 85 of file panel.h.

◆ getDescription()

virtual QString rviz::Panel::getDescription ( ) const
inlinevirtual

Return a description of this Panel.

Definition at line 71 of file panel.h.

◆ getName()

virtual QString rviz::Panel::getName ( ) const
inlinevirtual

Definition at line 61 of file panel.h.

◆ initialize()

void rviz::Panel::initialize ( VisualizationManager manager)

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

Definition at line 44 of file panel.cpp.

◆ load()

void rviz::Panel::load ( const Config config)
virtual

Override to load configuration data. This version loads the name of the panel.

Reimplemented in rviz::ViewsPanel, rviz::DisplaysPanel, rviz::ToolPropertiesPanel, and rviz::FailedPanel.

Definition at line 56 of file panel.cpp.

◆ onInitialize()

virtual void rviz::Panel::onInitialize ( )
inlinevirtual

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.

◆ save()

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::ViewsPanel, rviz::DisplaysPanel, rviz::ToolPropertiesPanel, and rviz::FailedPanel.

Definition at line 50 of file panel.cpp.

◆ setClassId()

virtual void rviz::Panel::setClassId ( const QString &  class_id)
inlinevirtual

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

Definition at line 92 of file panel.h.

◆ setDescription()

virtual void rviz::Panel::setDescription ( const QString &  description)
inlinevirtual

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

Definition at line 77 of file panel.h.

◆ setName()

virtual void rviz::Panel::setName ( const QString &  name)
inlinevirtual

Definition at line 65 of file panel.h.

Member Data Documentation

◆ class_id_

QString rviz::Panel::class_id_
private

Definition at line 116 of file panel.h.

◆ description_

QString rviz::Panel::description_
private

Definition at line 118 of file panel.h.

◆ name_

QString rviz::Panel::name_
private

Definition at line 117 of file panel.h.

◆ vis_manager_

VisualizationManager* rviz::Panel::vis_manager_
protected

Definition at line 113 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 Mon Aug 15 2022 02:05:18