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 #include "rviz/rviz_export.h"
36 
37 namespace rviz
38 {
39 class VisualizationManager;
40 
41 class RVIZ_EXPORT Panel : public QWidget
42 {
43  Q_OBJECT
44 public:
45  Panel(QWidget* parent = nullptr);
46  ~Panel() override;
47 
50  void initialize(VisualizationManager* manager);
51 
57  virtual void onInitialize()
58  {
59  }
60 
61  virtual QString getName() const
62  {
63  return name_;
64  }
65  virtual void setName(const QString& name)
66  {
67  name_ = name;
68  }
69 
71  virtual QString getDescription() const
72  {
73  return description_;
74  }
75 
77  virtual void setDescription(const QString& description)
78  {
79  description_ = description;
80  }
81 
85  virtual QString getClassId() const
86  {
87  return class_id_;
88  }
89 
92  virtual void setClassId(const QString& class_id)
93  {
94  class_id_ = class_id;
95  }
96 
98  virtual void load(const Config& config);
99 
102  virtual void save(Config config) const;
103 
104 Q_SIGNALS:
110  void configChanged();
111 
112 protected:
114 
115 private:
116  QString class_id_;
117  QString name_;
118  QString description_;
119 };
120 
121 } // end namespace rviz
122 
123 #endif // RVIZ_PANEL_H
QString description_
Definition: panel.h:118
VisualizationManager * vis_manager_
Definition: panel.h:113
virtual QString getName() const
Definition: panel.h:61
ROSCONSOLE_DECL void initialize()
config
QString class_id_
Definition: panel.h:116
virtual void setDescription(const QString &description)
Set a description of this Panel. Called by the factory which creates it.
Definition: panel.h:77
virtual QString getDescription() const
Return a description of this Panel.
Definition: panel.h:71
Configuration data storage class.
Definition: config.h:124
virtual void setName(const QString &name)
Definition: panel.h:65
The VisualizationManager class is the central manager class of rviz, holding all the Displays...
virtual void onInitialize()
Definition: panel.h:57
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:92
virtual QString getClassId() const
Return the class identifier which was used to create this instance. This version just returns whateve...
Definition: panel.h:85
QString name_
Definition: panel.h:117


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Sat Aug 6 2022 02:06:51