panel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012, Willow Garage, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Willow Garage, Inc. nor the names of its
14  * contributors may be used to endorse or promote products derived from
15  * this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 #ifndef RVIZ_PANEL_H
30 #define RVIZ_PANEL_H
31 
32 #include <QWidget>
33 
34 #include "rviz/config.h"
35 
36 namespace rviz
37 {
38 
39 class VisualizationManager;
40 
41 class Panel: public QWidget
42 {
43 Q_OBJECT
44 public:
45  Panel( QWidget* parent = 0 );
46  virtual ~Panel();
47 
50  void initialize( VisualizationManager* manager );
51 
57  virtual void onInitialize() {}
58 
59  virtual QString getName() const { return name_; }
60  virtual void setName( const QString& name ) { name_ = name; }
61 
63  virtual QString getDescription() const { return description_; }
64 
66  virtual void setDescription( const QString& description ) { description_ = description; }
67 
71  virtual QString getClassId() const { return class_id_; }
72 
75  virtual void setClassId( const QString& class_id ) { class_id_ = class_id; }
76 
78  virtual void load( const Config& config );
79 
81  virtual void save( Config config ) const;
82 
83 Q_SIGNALS:
89  void configChanged();
90 
91 protected:
93 
94 private:
95  QString class_id_;
96  QString name_;
97  QString description_;
98 };
99 
100 } // end namespace rviz
101 
102 #endif // RVIZ_PANEL_H
QString description_
Definition: panel.h:97
VisualizationManager * vis_manager_
Definition: panel.h:92
void initialize(VisualizationManager *manager)
Definition: panel.cpp:46
config
QString class_id_
Definition: panel.h:95
void configChanged()
Subclasses must emit this whenever a configuration change happens.
virtual void setDescription(const QString &description)
Set a description of this Panel. Called by the factory which creates it.
Definition: panel.h:66
Configuration data storage class.
Definition: config.h:125
virtual void setName(const QString &name)
Definition: panel.h:60
virtual QString getDescription() const
Return a description of this Panel.
Definition: panel.h:63
The VisualizationManager class is the central manager class of rviz, holding all the Displays...
virtual QString getName() const
Definition: panel.h:59
virtual void onInitialize()
Definition: panel.h:57
virtual ~Panel()
Definition: panel.cpp:42
virtual void setClassId(const QString &class_id)
Set the class identifier used to create this instance. Typically this will be set by the factory obje...
Definition: panel.h:75
Panel(QWidget *parent=0)
Definition: panel.cpp:37
virtual void save(Config config) const
Override to save configuration data. This version saves the name and class ID of the panel...
Definition: panel.cpp:52
virtual void load(const Config &config)
Override to load configuration data. This version loads the name of the panel.
Definition: panel.cpp:58
QString name_
Definition: panel.h:96
virtual QString getClassId() const
Return the class identifier which was used to create this instance. This version just returns whateve...
Definition: panel.h:71


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Sat Apr 27 2019 02:33:41