Populate plugins that were empty (#366)

Signed-off-by: Louise Poubel <louise@openrobotics.org> Signed-off-by: ahcorde <ahcorde@gmail.com> Co-authored-by: ahcorde <ahcorde@gmail.com>
gazebosim · Mar 4, 2022 · ce4c368 · ce4c368
1 parent 70255cc
commit ce4c368
Show file tree

Hide file tree

Showing 7 changed files with 141 additions and 66 deletions.
diff --git a/src/plugins/camera_tracking/CameraTracking.hh b/src/plugins/camera_tracking/CameraTracking.hh
@@ -30,6 +30,19 @@ namespace plugins
 {
   class CameraTrackingPrivate;
 
+  /// \brief This plugin provides camera tracking capabilities such as "move to"
+  /// and "follow".
+  ///
+  /// Services:
+  /// * `/gui/move_to`: Move the user camera to look at a given target,
+  ///                   identified by name.
+  /// * `/gui/move_to/pose`: Move the user camera to a given pose.
+  /// * `/gui/follow`: Set the user camera to follow a given target,
+  ///                   identified by name.
+  /// * `/gui/follow/offset`: Set the offset for following.
+  ///
+  /// Topics:
+  /// * `/gui/camera/pose`: Publishes the current user camera pose.
   class CameraTracking : public Plugin
   {
     Q_OBJECT

diff --git a/src/plugins/camera_tracking/CameraTracking.qml b/src/plugins/camera_tracking/CameraTracking.qml
@@ -15,14 +15,31 @@
  *
 */
 
-import QtQuick 2.0
-import QtQuick.Controls 2.0
+import QtQuick 2.9
+import QtQuick.Controls 2.1
 import QtQuick.Layouts 1.3
 
-// TODO: remove invisible rectangle, see
-// https://github.com/ignitionrobotics/ign-gui/issues/220
-Rectangle {
-  visible: false
-  Layout.minimumWidth: 100
-  Layout.minimumHeight: 100
+ColumnLayout {
+  Layout.minimumWidth: 350
+  Layout.minimumHeight: 260
+  anchors.fill: parent
+  anchors.margins: 10
+
+  property string message: 'Services provided:<br><ul>' +
+      '<li>/gui/move_to</li>' +
+      '<li>/gui/move_to/pose</li>' +
+      '<li>/gui/follow</li>' +
+      '<li>/gui/follow/offset</li></ul><br>Topics provided:<br><ul>' +
+      '<li>/gui/camera/pose</li></ul>'
+
+  Label {
+    Layout.fillWidth: true
+    wrapMode: Text.WordWrap
+    text: message
+  }
+
+  Item {
+    width: 10
+    Layout.fillHeight: true
+  }
 }
diff --git a/src/plugins/interactive_view_control/InteractiveViewControl.cc b/src/plugins/interactive_view_control/InteractiveViewControl.cc
@@ -258,6 +258,9 @@ InteractiveViewControl::~InteractiveViewControl() = default;
 void InteractiveViewControl::LoadConfig(
   const tinyxml2::XMLElement * /*_pluginElem*/)
 {
+  if (this->title.empty())
+    this->title = "Interactive view control";
+
   // camera view control mode
   this->dataPtr->cameraViewControlService = "/gui/camera/view_control";
   this->dataPtr->node.Advertise(this->dataPtr->cameraViewControlService,

diff --git a/src/plugins/interactive_view_control/InteractiveViewControl.qml b/src/plugins/interactive_view_control/InteractiveViewControl.qml
@@ -15,14 +15,27 @@
  *
 */
 
-import QtQuick 2.0
-import QtQuick.Controls 2.0
+import QtQuick 2.9
+import QtQuick.Controls 2.1
 import QtQuick.Layouts 1.3
 
-// TODO: remove invisible rectangle, see
-// https://github.com/ignitionrobotics/ign-gui/issues/220
-Rectangle {
-  visible: false
-  Layout.minimumWidth: 100
-  Layout.minimumHeight: 100
+ColumnLayout {
+  Layout.minimumWidth: 350
+  Layout.minimumHeight: 110
+  anchors.fill: parent
+  anchors.margins: 10
+
+  property string message: '<ul><li>Adding mouse controls to the 3D scene.</li>' +
+      '<li>Providing the /gui/camera/view_control service</li></ul>'
+
+  Label {
+    Layout.fillWidth: true
+    wrapMode: Text.WordWrap
+    text: message
+  }
+
+  Item {
+    width: 10
+    Layout.fillHeight: true
+  }
 }
diff --git a/src/plugins/marker_manager/MarkerManager.cc b/src/plugins/marker_manager/MarkerManager.cc
@@ -20,6 +20,8 @@
 #include <map>
 #include <string>
 
+#include <QQmlProperty>
+
 #include <ignition/common/Console.hh>
 #include <ignition/common/Profiler.hh>
 #include <ignition/common/StringUtils.hh>
@@ -677,6 +679,7 @@ void MarkerManager::LoadConfig(const tinyxml2::XMLElement * _pluginElem)
     this->title = "Marker Manager";
 
   // Custom parameters
+  std::string statsTopic;
   if (_pluginElem)
   {
     auto elem = _pluginElem->FirstChildElement("topic_name");
@@ -704,59 +707,64 @@ void MarkerManager::LoadConfig(const tinyxml2::XMLElement * _pluginElem)
       }
     }
 
-    // World name from window, to construct default topics and services
-    std::string worldName = "example";
-    auto worldNames = gui::worldNames();
-    if (!worldNames.empty())
-      worldName = worldNames[0].toStdString();
-
-    // Subscribe to world stats
-    std::string statsTopic;
+    // Stats topic
     auto statsTopicElem = _pluginElem->FirstChildElement("stats_topic");
     if (nullptr != statsTopicElem && nullptr != statsTopicElem->GetText())
       statsTopic = statsTopicElem->GetText();
+  }
 
-    // Service specified with different world name
-    auto parts = common::Split(statsTopic, '/');
-    if (!worldName.empty() &&
-        parts.size() == 4 &&
-        parts[0] == "" &&
-        parts[1] == "world" &&
-        parts[2] != worldName &&
-        parts[3] == "stats")
-    {
-      ignwarn << "Ignoring topic [" << statsTopic
-              << "], world name different from [" << worldName
-              << "]. Fix or remove your <stats_topic> tag." << std::endl;
+  // World name from window, to construct default topics and services
+  std::string worldName = "example";
+  auto worldNames = gui::worldNames();
+  if (!worldNames.empty())
+    worldName = worldNames[0].toStdString();
+
+  // Subscribe to world stats
+  // Service specified with different world name
+  auto parts = common::Split(statsTopic, '/');
+  if (!worldName.empty() &&
+      parts.size() == 4 &&
+      parts[0] == "" &&
+      parts[1] == "world" &&
+      parts[2] != worldName &&
+      parts[3] == "stats")
+  {
+    ignwarn << "Ignoring topic [" << statsTopic
+            << "], world name different from [" << worldName
+            << "]. Fix or remove your <stats_topic> tag." << std::endl;
 
-      statsTopic = "/world/" + worldName + "/stats";
-    }
+    statsTopic = "/world/" + worldName + "/stats";
+  }
 
-    if (statsTopic.empty() && !worldName.empty())
-    {
-      statsTopic = "/world/" + worldName + "/stats";
-    }
+  if (statsTopic.empty() && !worldName.empty())
+  {
+    statsTopic = "/world/" + worldName + "/stats";
+  }
 
-    statsTopic = transport::TopicUtils::AsValidTopic(statsTopic);
-    if (!statsTopic.empty())
+  statsTopic = transport::TopicUtils::AsValidTopic(statsTopic);
+  if (!statsTopic.empty())
+  {
+    // Subscribe to world_stats
+    if (!this->dataPtr->node.Subscribe(statsTopic,
+        &MarkerManagerPrivate::OnWorldStatsMsg, this->dataPtr.get()))
     {
-      // Subscribe to world_stats
-      if (!this->dataPtr->node.Subscribe(statsTopic,
-          &MarkerManagerPrivate::OnWorldStatsMsg, this->dataPtr.get()))
-      {
-        ignerr << "Failed to subscribe to [" << statsTopic << "]" << std::endl;
-      }
-      else
-      {
-        ignmsg << "Listening to stats on [" << statsTopic << "]" << std::endl;
-      }
+      ignerr << "Failed to subscribe to [" << statsTopic << "]" << std::endl;
     }
     else
     {
-      ignerr << "Failed to create valid topic for world [" << worldName << "]"
-             << std::endl;
+      ignmsg << "Listening to stats on [" << statsTopic << "]" << std::endl;
     }
   }
+  else
+  {
+    ignerr << "Failed to create valid topic for world [" << worldName << "]"
+           << std::endl;
+  }
+
+  QQmlProperty::write(this->PluginItem(), "topicName",
+      QString::fromStdString(this->dataPtr->topicName));
+  QQmlProperty::write(this->PluginItem(), "statsTopic",
+      QString::fromStdString(statsTopic));
 
   App()->findChild<MainWindow *>()->installEventFilter(this);
 }

diff --git a/src/plugins/marker_manager/MarkerManager.hh b/src/plugins/marker_manager/MarkerManager.hh
@@ -30,13 +30,15 @@ namespace plugins
 {
   class MarkerManagerPrivate;
 
-  /// \brief This plugin will be in charge of handeling the markers in the
+  /// \brief This plugin will be in charge of handling the markers in the
   /// scene. It will allow to add, modify or remove markers.
   ///
   /// ## Parameters
   ///
-  /// * `<topic_name>`: Options. Name of topic for marker service. Defaults
+  /// * `<topic_name>`: Optional. Name of topic for marker service. Defaults
   /// to `/marker`.
+  /// * `<stats_topic>`: Optional. Name of topic to receive world stats.
+  /// Defaults to `/world/[world name]/stats`.
   /// * `<warn_on_action_failure>`: True to display warnings if the user
   /// attempts to perform an invalid action. Defaults to true.
   class MarkerManager : public Plugin

diff --git a/src/plugins/marker_manager/MarkerManager.qml b/src/plugins/marker_manager/MarkerManager.qml
@@ -15,14 +15,33 @@
  *
 */
 
-import QtQuick 2.0
-import QtQuick.Controls 2.0
+import QtQuick 2.9
+import QtQuick.Controls 2.1
 import QtQuick.Layouts 1.3
 
-// TODO: remove invisible rectangle, see
-// https://github.com/ignitionrobotics/ign-gui/issues/220
-Rectangle {
-  visible: false
-  Layout.minimumWidth: 100
-  Layout.minimumHeight: 100
+ColumnLayout {
+  Layout.minimumWidth: 350
+  Layout.minimumHeight: 230
+  anchors.fill: parent
+  anchors.margins: 10
+
+  property string topicName: ''
+  property string statsTopic: ''
+
+  property string message: 'Services provided:<br><ul>' +
+      '<li>' + topicName + '</li>' +
+      '<li>' + topicName + '_array</li>' +
+      '<li>' + topicName + '/list</li></ul><br>Topics subscribed:<br><ul>' +
+      '<li>' + statsTopic + '</li></ul>'
+
+  Label {
+    Layout.fillWidth: true
+    wrapMode: Text.WordWrap
+    text: message
+  }
+
+  Item {
+    width: 10
+    Layout.fillHeight: true
+  }
 }