Gazebo Gazebo

API Reference

6.16.0
Spawn.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2021 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 
18 #ifndef IGNITION_GAZEBO_GUI_SPAWN_HH_
19 #define IGNITION_GAZEBO_GUI_SPAWN_HH_
20 
21 #include <memory>
22 
23 #include <gz/gui/GuiEvents.hh>
24 #include <gz/gui/Plugin.hh>
25 
26 namespace ignition
27 {
28 namespace gazebo
29 {
30  class SpawnPrivate;
31 
34  class Spawn : public gz::gui::Plugin
35  {
36  Q_OBJECT
37 
39  Q_PROPERTY(
40  QString errorPopupText
41  READ ErrorPopupText
42  WRITE SetErrorPopupText
44  )
45 
46 
47  public: Spawn();
48 
50  public: ~Spawn() override;
51 
52  // Documentation inherited
53  public: void LoadConfig(const tinyxml2::XMLElement *_pluginElem) override;
54 
57  public: void OnDropped(const gz::gui::events::DropOnScene *_event);
58 
61  public: Q_INVOKABLE QString ErrorPopupText() const;
62 
65  public: Q_INVOKABLE void SetErrorPopupText(const QString &_errorTxt);
66 
67  // Documentation inherited
68  protected: bool eventFilter(QObject *_obj, QEvent *_event) override;
69 
71  signals: void ErrorPopupTextChanged();
72 
76  signals: void popupError();
77 
80  private: std::unique_ptr<SpawnPrivate> dataPtr;
81  };
82 }
83 }
84 
85 #endif
Q_INVOKABLE QString ErrorPopupText() const
Get the text for the popup error message.
This library is part of the Gazebo project.
void popupError()
Notify that an error has occurred (opens popup) Note that the function name needs to start with lower...
void LoadConfig(const tinyxml2::XMLElement *_pluginElem) override
Q_INVOKABLE void SetErrorPopupText(const QString &_errorTxt)
Set the text for the popup error message.
bool eventFilter(QObject *_obj, QEvent *_event) override
Allows to spawn models and lights using the spawn gui events or drag and drop.
Definition: Spawn.hh:34
QString errorPopupText
Text for popup error.
Definition: Spawn.hh:44
void ErrorPopupTextChanged()
Notify the popup error text has changed.
STL namespace.
void OnDropped(const gz::gui::events::DropOnScene *_event)
Handle drop events.