Ignition Gazebo

API Reference

5.0.0
GuiRunner.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2019 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16 */
17 #ifndef IGNITION_GAZEBO_GUI_GUIRUNNER_HH_
18 #define IGNITION_GAZEBO_GUI_GUIRUNNER_HH_
19 
21 
22 #include <QtCore>
23 #include <memory>
24 #include <string>
25 
26 #include <ignition/utils/ImplPtr.hh>
27 
28 #include "ignition/gazebo/config.hh"
29 #include "ignition/gazebo/gui/Export.hh"
30 
31 namespace ignition
32 {
33 namespace gazebo
34 {
35 // Inline bracket to help doxygen filtering.
36 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
39 
40 class IGNITION_GAZEBO_GUI_VISIBLE GuiRunner : public QObject
41 {
42  Q_OBJECT
43 
47  public: explicit IGN_DEPRECATED(5.0) GuiRunner(
48  const std::string &_worldName);
49 
51  public: ~GuiRunner() override;
52 
55  public slots: void OnPluginAdded(const QString &_objectName);
56 
58  public slots: void RequestState();
59 
62  private: void OnStateAsyncService(const msgs::SerializedStepMap &_res);
63 
66  private: void OnState(const msgs::SerializedStepMap &_msg);
67 
69  IGN_UTILS_UNIQUE_IMPL_PTR(dataPtr)
70 };
71 }
72 }
73 }
74 #endif
Responsible for running GUI systems as new states are received from the backend.
Definition: GuiRunner.hh:40
STL class.
#define IGN_DEPRECATED(version)
This library is part of the Ignition Robotics project.