Merge branch 'ign-gui6' into merge_6_7

.github/workflows/ci.yml

@@ -14,6 +14,7 @@ jobs:
         uses: ignition-tooling/action-ignition-ci@bionic
         with:
           codecov-enabled: true
+          doxygen-enabled: true
   focal-ci:
     runs-on: ubuntu-latest
     name: Ubuntu Focal CI

CMakeLists.txt

@@ -109,14 +109,15 @@ ign_create_docs(
   API_MAINPAGE_MD "${CMAKE_BINARY_DIR}/api.md"
   TUTORIALS_MAINPAGE_MD "${CMAKE_BINARY_DIR}/tutorials.md"
   ADDITIONAL_INPUT_DIRS "${CMAKE_SOURCE_DIR}/src/plugins"
+  IMAGE_PATH_DIRS "${CMAKE_SOURCE_DIR}/tutorials/images"
   TAGFILES
-   "${CMAKE_SOURCE_DIR}/doc/qt.tag.xml=http://doc.qt.io/qt-5/"
-   "${IGNITION-MATH_DOXYGEN_TAGFILE} = ${IGNITION-MATH_API_URL}"
-   "${IGNITION-MSGS_DOXYGEN_TAGFILE} = ${IGNITION-MSGS_API_URL}"
-   "${IGNITION-RENDERING_DOXYGEN_TAGFILE} = ${IGNITION-RENDERING_API_URL}"
-   "${IGNITION-TRANSPORT_DOXYGEN_TAGFILE} = ${IGNITION-TRANSPORT_API_URL}"
-   "${IGNITION-COMMON_DOXYGEN_TAGFILE} = ${IGNITION-COMMON_API_URL}"
-  )
+    "${CMAKE_SOURCE_DIR}/doc/qt.tag.xml=http://doc.qt.io/qt-5/"
+    "${IGNITION-MATH_DOXYGEN_TAGFILE} = ${IGNITION-MATH_API_URL}"
+    "${IGNITION-MSGS_DOXYGEN_TAGFILE} = ${IGNITION-MSGS_API_URL}"
+    "${IGNITION-RENDERING_DOXYGEN_TAGFILE} = ${IGNITION-RENDERING_API_URL}"
+    "${IGNITION-TRANSPORT_DOXYGEN_TAGFILE} = ${IGNITION-TRANSPORT_API_URL}"
+    "${IGNITION-COMMON_DOXYGEN_TAGFILE} = ${IGNITION-COMMON_API_URL}"
+)
 
 if(TARGET doc)
   file(COPY ${CMAKE_SOURCE_DIR}/tutorials/images/ DESTINATION ${CMAKE_BINARY_DIR}/doxygen/html/images/)

Changelog.md

@@ -1,15 +1,32 @@
-## Ignition Gui 6
+## Ignition Gui 7
 
 ### Ignition Gui 7.X.X
 
 ### Ignition Gui 7.0.0 (202X-XX-XX)
 
-### Ignition Gui 6.X.X
+## Ignition Gui 6
+
+### Ignition Gui 6.1.0 (2021-11-05)
+
+1. Improved doxygen
+    * [Pull request #275](https://github.com/ignitionrobotics/ign-gui/pull/275)
+
+1. Fix mimimal scene deadlock on shutdown
+    * [Pull request #300](https://github.com/ignitionrobotics/ign-gui/pull/300)
+
+1. Fix memory leak
+    * [Pull request #287](https://github.com/ignitionrobotics/ign-gui/pull/287)
+
+1. Set near/far camera clipping distance
+    * [Pull request #309](https://github.com/ignitionrobotics/ign-gui/pull/309)
+
+1. Support emitting an event on play/pause/step
+    * [Pull request #306](https://github.com/ignitionrobotics/ign-gui/pull/306)
 
 ### Ignition Gui 6.0.0 (2021-09-XX)
 
-1. Render engine GUI name argument to be set in the minimal scene
-    * [Pull request #286](https://github.com/ignitionrobotics/ign-gui/pull/286)
+1. Add a filter to the plugin menu
+    * [Pull request #277](https://github.com/ignitionrobotics/ign-gui/pull/277)
 
 1. New events
 
@@ -39,6 +56,9 @@
 1. PIMPL GUI events
     * [Pull request #253](https://github.com/ignitionrobotics/ign-gui/pull/253)
 
+1. Added winID to fix second windows in OGRE2.2
+    * [Pull request #292](https://github.com/ignitionrobotics/ign-gui/pull/292)
+
 1. Added camera tracking
     * [Pull request #226](https://github.com/ignitionrobotics/ign-gui/pull/226)
     * [Pull request #254](https://github.com/ignitionrobotics/ign-gui/pull/254)
@@ -49,6 +69,10 @@
     * [Pull request #285](https://github.com/ignitionrobotics/ign-gui/pull/285)
     * [Pull request #268](https://github.com/ignitionrobotics/ign-gui/pull/268)
     * [Pull request #224](https://github.com/ignitionrobotics/ign-gui/pull/224)
+    * [Pull request #282](https://github.com/ignitionrobotics/ign-gui/pull/282)
+    * [Pull request #273](https://github.com/ignitionrobotics/ign-gui/pull/273)
+    * [Pull request #286](https://github.com/ignitionrobotics/ign-gui/pull/286)
+    * [Pull request #295](https://github.com/ignitionrobotics/ign-gui/pull/295)
 
 1. Remove deprecations: tock
     * [Pull request #243](https://github.com/ignitionrobotics/ign-gui/pull/243)
@@ -66,6 +90,23 @@
 
 ### Ignition Gui 5.X.X (20XX-XX-XX)
 
+### Ignition Gui 5.3.0 (2021-10-13)
+
+1. Improved doxygen
+    * [Pull request #275](https://github.com/ignitionrobotics/ign-gui/pull/275)
+
+1. Fix memory leak
+    * [Pull request #287](https://github.com/ignitionrobotics/ign-gui/pull/287)
+
+1. Add a filter to the plugin menu
+    * [Pull request #277](https://github.com/ignitionrobotics/ign-gui/pull/277)
+
+1. 👩‍🌾 Remove bitbucket-pipelines.yml
+    * [Pull request #274](https://github.com/ignitionrobotics/ign-gui/pull/274)
+
+1. Fix doc build error
+    * [Pull request #266](https://github.com/ignitionrobotics/ign-gui/pull/266)
+
 ### Ignition Gui 5.2.0 (2021-07-27)
 
 1. New teleop plugin implementation.
@@ -329,6 +370,23 @@
 
 ### Ignition Gui 3.X.X (202X-XX-XX)
 
+### Ignition Gui 3.8.0 (2021-10-12)
+
+1. Improved doxygen
+    * [Pull request #275](https://github.com/ignitionrobotics/ign-gui/pull/275)
+
+1. Add a filter to the plugin menu
+    * [Pull request #277](https://github.com/ignitionrobotics/ign-gui/pull/277)
+
+1. 👩‍🌾 Remove bitbucket-pipelines.yml
+    * [Pull request #274](https://github.com/ignitionrobotics/ign-gui/pull/274)
+
+1. Require ign-rendering 3.5
+    * [Pull request #264](https://github.com/ignitionrobotics/ign-gui/pull/264)
+
+1. New teleop plugin implementation.
+    * [Pull request #245](https://github.com/ignitionrobotics/ign-gui/pull/245)
+
 ### Ignition Gui 3.7.0 (2021-07-14)
 
 1. Fix codeowners

README.md

@@ -9,10 +9,10 @@
 
 Build | Status
 -- | --
-Test coverage | [![codecov](https://codecov.io/gh/ignitionrobotics/ign-gui/branch/main/graph/badge.svg)](https://codecov.io/gh/ignitionrobotics/ign-gui/branch/main)
-Ubuntu Bionic | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_gui-ci-main-bionic-amd64)](https://build.osrfoundation.org/job/ignition_gui-ci-main-bionic-amd64)
-Homebrew      | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_gui-ci-main-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_gui-ci-main-homebrew-amd64)
-Windows       | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ign_gui-ci-win)](https://build.osrfoundation.org/job/ign_gui-ci-win)
+Test coverage | [![codecov](https://codecov.io/gh/ignitionrobotics/ign-gui/branch/ign-gui6/graph/badge.svg)](https://codecov.io/gh/ignitionrobotics/ign-gui/branch/ign-gui6)
+Ubuntu Bionic | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_gui-ci-ign-gui6-bionic-amd64)](https://build.osrfoundation.org/job/ignition_gui-ci-ign-gui6-bionic-amd64)
+Homebrew      | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_gui-ci-ign-gui6-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_gui-ci-ign-gui6-homebrew-amd64)
+Windows       | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ign_gui-ign-6-win)](https://build.osrfoundation.org/job/ign_gui-ign-6-win)
 
 Ignition GUI builds on top of [Qt](https://www.qt.io/) to provide widgets which are
 useful when developing robotics applications, such as a 3D view, plots, dashboard, etc,

include/ignition/gui/Application.hh

@@ -96,11 +96,11 @@ namespace ignition
       /// and plugins. This function doesn't instantiate the plugins, it just
       /// keeps them in memory and they can be applied later by either
       /// instantiating a window or several dialogs.
-      /// \param[in] _config Full path to configuration file.
+      /// \param[in] _path Full path to configuration file.
       /// \return True if successful
       /// \sa InitializeMainWindow
       /// \sa InitializeDialogs
-      public: bool LoadConfig(const std::string &_config);
+      public: bool LoadConfig(const std::string &_path);
 
       /// \brief Load the configuration from the default config file.
       /// \return True if successful

include/ignition/gui/GuiEvents.hh

@@ -27,6 +27,7 @@
 #include <ignition/common/MouseEvent.hh>
 #include <ignition/math/Vector2.hh>
 #include <ignition/math/Vector3.hh>
+#include <ignition/msgs/world_control.pb.h>
 #include <ignition/utils/ImplPtr.hh>
 
 #include "ignition/gui/Export.hh"
@@ -92,7 +93,7 @@ namespace ignition
       class IGNITION_GUI_VISIBLE SpawnFromDescription : public QEvent
       {
         /// \brief Constructor
-        /// \param[in] _string The resource's description as a string, such
+        /// \param[in] _description The resource's description as a string, such
         /// as an SDF file.
         public: explicit SpawnFromDescription(const std::string &_description);
 
@@ -368,7 +369,7 @@ namespace ignition
       class IGNITION_GUI_VISIBLE DropOnScene : public QEvent
       {
         /// \brief Constructor
-        /// \param[in] _drop Dropped string.
+        /// \param[in] _dropText Dropped string.
         /// \param[in] _dropMouse x and y  coordinate of mouse position.
         public: explicit DropOnScene(
           const std::string &_dropText,
@@ -449,6 +450,25 @@ namespace ignition
         /// \brief Private data pointer
         IGN_UTILS_IMPL_PTR(dataPtr)
       };
+
+      /// \brief Event which is called to share WorldControl information.
+      class IGNITION_GUI_VISIBLE WorldControl : public QEvent
+      {
+        /// \brief Constructor
+        /// \param[in] _worldControl The WorldControl information
+        public: explicit WorldControl(const msgs::WorldControl &_worldControl);
+
+        /// \brief Unique type for this event.
+        static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 19);
+
+        /// \brief Get the WorldControl information
+        /// \return The WorldControl information
+        public: const msgs::WorldControl &WorldControlInfo() const;
+
+        /// \internal
+        /// \brief Private data pointer
+        IGN_UTILS_IMPL_PTR(dataPtr)
+      };
     }
   }
 }

include/ignition/gui/PlottingInterface.hh

@@ -63,7 +63,7 @@ class IGNITION_GUI_VISIBLE PlotData
   public: double Value() const;
 
   /// \brief Set the field arrival time
-  /// \param[in] _value arrival time to set it
+  /// \param[in] _time arrival time to set it
   public: void SetTime(const double _time);
 
   /// \brief Get the arrival time
@@ -273,7 +273,6 @@ class IGNITION_GUI_VISIBLE PlottingInterface : public QObject
   /// \brief called by Qml to remove a chart from a component attribute
   /// \param[in] _entity entity id which has the component
   /// \param[in] _typeId component type id
-  /// \param[in] _type component data type
   /// \param[in] _attribute component specefice attribte
   /// \param[in] _chart chart id
   public slots: void onComponentUnSubscribe(QString _entity,
@@ -296,7 +295,6 @@ class IGNITION_GUI_VISIBLE PlottingInterface : public QObject
   /// \brief Notify the gazebo plugin to unsubscribe a component data
   /// \param[in] _entity entity id which has the component
   /// \param[in] _typeId component type id
-  /// \param[in] _type component data type
   /// \param[in] _attribute component specefice attribte
   /// \param[in] _chart chart id
   signals: void ComponentUnSubscribe(uint64_t _entity,
@@ -338,4 +336,3 @@ class IGNITION_GUI_VISIBLE PlottingInterface : public QObject
 }
 
 #endif
-

include/ignition/gui/Plugin.hh

@@ -102,7 +102,10 @@ namespace ignition
       /// \sa Load
       /// \param[in] _pluginElem Element containing configuration
       protected: virtual void LoadConfig(
-          const tinyxml2::XMLElement * /*_pluginElem*/) {}
+          const tinyxml2::XMLElement *_pluginElem)
+          {
+            (void)_pluginElem;
+          }
 
       /// \brief Get title
       /// \return Plugin title.

src/GuiEvents.cc

@@ -136,6 +136,12 @@ class ignition::gui::events::MousePressOnScene::Implementation
   public: common::MouseEvent mouse;
 };
 
+class ignition::gui::events::WorldControl::Implementation
+{
+  /// \brief WorldControl information.
+  public: msgs::WorldControl worldControl;
+};
+
 using namespace ignition;
 using namespace gui;
 using namespace events;
@@ -401,3 +407,16 @@ const common::MouseEvent &MousePressOnScene::Mouse() const
 {
   return this->dataPtr->mouse;
 }
+
+/////////////////////////////////////////////////
+WorldControl::WorldControl(const msgs::WorldControl &_worldControl)
+  : QEvent(kType), dataPtr(utils::MakeImpl<Implementation>())
+{
+  this->dataPtr->worldControl = _worldControl;
+}
+
+/////////////////////////////////////////////////
+const msgs::WorldControl &WorldControl::WorldControlInfo() const
+{
+  return this->dataPtr->worldControl;
+}

src/GuiEvents_TEST.cc

@@ -254,3 +254,32 @@ TEST(GuiEventsTest, MousePressOnScene)
   EXPECT_TRUE(event.Mouse().Alt());
   EXPECT_FALSE(event.Mouse().Shift());
 }
+
+/////////////////////////////////////////////////
+TEST(GuiEventsTest, WorldControl)
+{
+  ignition::msgs::WorldControl worldControl;
+  worldControl.set_pause(true);
+  worldControl.set_step(true);
+  worldControl.set_multi_step(5u);
+  worldControl.mutable_reset()->set_all(true);
+  worldControl.mutable_reset()->set_time_only(true);
+  worldControl.mutable_reset()->set_model_only(false);
+  worldControl.set_seed(10u);
+  worldControl.mutable_run_to_sim_time()->set_sec(2);
+  worldControl.mutable_run_to_sim_time()->set_nsec(3);
+  events::WorldControl playEvent(worldControl);
+
+  EXPECT_LT(QEvent::User, playEvent.type());
+  EXPECT_FALSE(playEvent.WorldControlInfo().has_header());
+  EXPECT_TRUE(playEvent.WorldControlInfo().pause());
+  EXPECT_TRUE(playEvent.WorldControlInfo().step());
+  EXPECT_EQ(5u, playEvent.WorldControlInfo().multi_step());
+  EXPECT_FALSE(playEvent.WorldControlInfo().reset().has_header());
+  EXPECT_TRUE(playEvent.WorldControlInfo().reset().all());
+  EXPECT_TRUE(playEvent.WorldControlInfo().reset().time_only());
+  EXPECT_FALSE(playEvent.WorldControlInfo().reset().model_only());
+  EXPECT_EQ(10u, playEvent.WorldControlInfo().seed());
+  EXPECT_EQ(2, playEvent.WorldControlInfo().run_to_sim_time().sec());
+  EXPECT_EQ(3, playEvent.WorldControlInfo().run_to_sim_time().nsec());
+}

src/plugins/grid_config/GridConfig.hh

@@ -49,7 +49,6 @@ namespace gui
     public: void UpdateGrid();
 
     /// \brief Callback to retrieve existing grid or create a new one.
-    /// \param[in] _scene Scene to look for grid.
     public: void LoadGrid();
 
     /// \brief Callback to update vertical cell count

src/plugins/image_display/ImageDisplay.cc

@@ -212,6 +212,8 @@ void ImageDisplay::ProcessImage()
         image.setPixel(i, j, value);
       }
     }
+
+    delete [] data;
   }
 
   this->dataPtr->provider->SetImage(image);

src/plugins/key_publisher/KeyPublisher.hh

@@ -46,7 +46,8 @@ namespace gui
     public: virtual ~KeyPublisher();
 
     // Documentation inherited
-    public: virtual void LoadConfig(const tinyxml2::XMLElement *) override;
+    public: virtual void LoadConfig(
+      const tinyxml2::XMLElement *_pluginElem) override;
 
     /// \brief Filter events in Qt
     /// \param[in] _obj The watched object