Improve inserting WorldControl and WorldStats from menu (#349)

Signed-off-by: Louise Poubel <[email protected]>

src/plugins/world_control/WorldControl.cc

@@ -85,6 +85,15 @@ void WorldControl::LoadConfig(const tinyxml2::XMLElement *_pluginElem)
     return;
   }
 
+  // If no elements were set, show all buttons. We assume that the user never
+  // wants to hide all buttons. This happens for example when the plugin is
+  // inserted from the menu.
+  if (_pluginElem->NoChildren())
+  {
+    this->PluginItem()->setProperty("showPlay", true);
+    this->PluginItem()->setProperty("showStep", true);
+  }
+
   // World name from window, to construct default topics and services
   std::string worldName;
   auto worldNames = gui::worldNames();

src/plugins/world_control/WorldControl.hh

@@ -54,15 +54,19 @@ namespace plugins
   ///
   /// ## Configuration
   ///
-  /// * \<play_pause\> : Set to true to see a play/pause and step buttons,
+  /// * \<play_pause\> : Set to true to see a play/pause button,
   ///                    false by default.
+  /// * \<step\> : Set to true to see a step button, false by default.
   /// * \<start_paused\> : Set to false to start playing, false by default.
   /// * \<service\> : Service for world control, optional. If not presnt,
   ///               the plugin will attempt to create a topic with the main
   ///               window's `worldName` property.
   /// * \<stats_topic\> : Topic to receive world statistics, optional. If not
   ///               present, the plugin will attempt to create a topic with the
   ///               main window's `worldName` property.
+  ///
+  /// If no elements are filled for the plugin, both the play/pause and the
+  /// step buttons will be displayed.
   class WorldControl_EXPORTS_API WorldControl: public ignition::gui::Plugin
   {
     Q_OBJECT

src/plugins/world_control/WorldControl.qml

@@ -87,6 +87,7 @@ RowLayout {
    */
   RoundButton {
     id: playButton
+    objectName: "playButton"
     visible: showPlay
     text: paused ? playIcon : pauseIcon
     checkable: true
@@ -123,6 +124,7 @@ RowLayout {
 
     RoundButton {
       id: stepButton
+      objectName: "stepButton"
       text: stepIcon
       visible: showStep
       height: playButton.height * 0.8

src/plugins/world_control/WorldControl_TEST.cc

@@ -58,6 +58,14 @@ TEST(WorldControlTest, IGN_UTILS_TEST_ENABLED_ONLY_ON_LINUX(Load))
   auto plugin = plugins[0];
   EXPECT_EQ(plugin->Title(), "World control");
 
+  // Check that all buttons are visible
+  for (auto name : {"playButton", "stepButton"})
+  {
+    auto obj = plugin->PluginItem()->findChild<QObject *>(name);
+    ASSERT_NE(nullptr, obj) << name;
+    EXPECT_TRUE(obj->property("visible").toBool()) << name;
+  }
+
   // Cleanup
   plugins.clear();
 }

src/plugins/world_stats/WorldStats.cc

@@ -88,6 +88,17 @@ void WorldStats::LoadConfig(const tinyxml2::XMLElement *_pluginElem)
     return;
   }
 
+  // If no elements were set, show everything. We assume that the user never
+  // wants to hide everything. This happens for example when the plugin is
+  // inserted from the menu.
+  if (_pluginElem->NoChildren())
+  {
+    this->PluginItem()->setProperty("showSimTime", true);
+    this->PluginItem()->setProperty("showRealTime", true);
+    this->PluginItem()->setProperty("showRealTimeFactor", true);
+    this->PluginItem()->setProperty("showIterations", true);
+  }
+
   // World name from window, to construct default topics and services
   std::string worldName;
   auto worldNames = gui::worldNames();

src/plugins/world_stats/WorldStats.hh

@@ -50,10 +50,11 @@ namespace plugins
 {
   class WorldStatsPrivate;
 
-  /// \brief This plugin provides a time panel which may:
-  /// * Display simulation time
-  /// * Display real time
-  /// * Have a play / pause and step buttons
+  /// \brief This plugin provides a time panel which may display:
+  /// * Simulation time
+  /// * Real time
+  /// * Real time factor
+  /// * Iterations
   ///
   /// ## Configuration
   ///
@@ -62,9 +63,13 @@ namespace plugins
   /// * \<real_time\> : True to display a real time widget, false by default.
   /// * \<real_time_factor\> : True to display a real time factor widget,
   ///                          false by default.
+  /// * \<iterations\> : True to display an iterations widget, false by default.
   /// * \<topic\> : Topic to receive world statistics, optional. If not present,
   ///               the plugin will attempt to create a topic with the main
   ///               window's `worldName` property.
+  ///
+  /// If no elements are filled for the plugin, all properties will be
+  /// displayed.
   class WorldStats_EXPORTS_API WorldStats: public ignition::gui::Plugin
   {
     Q_OBJECT

src/plugins/world_stats/WorldStats.qml

@@ -166,6 +166,7 @@ Rectangle {
         }
       }
       Label {
+        objectName: "realTimeFactorValue"
         text: WorldStats.realTimeFactor
         visible: showRealTimeFactor
         Layout.alignment: Qt.AlignRight
@@ -190,6 +191,7 @@ Rectangle {
         }
       }
       Label {
+        objectName: "simTimeValue"
         text: WorldStats.simTime
         visible: showSimTime
         Layout.alignment: Qt.AlignRight
@@ -214,6 +216,7 @@ Rectangle {
         }
       }
       Label {
+        objectName: "realTimeValue"
         text: WorldStats.realTime
         visible: showRealTime
         Layout.alignment: Qt.AlignRight
@@ -238,6 +241,7 @@ Rectangle {
         }
       }
       Label {
+        objectName: "iterationsValue"
         text: WorldStats.iterations
         visible: showIterations
         Layout.alignment: Qt.AlignRight

src/plugins/world_stats/WorldStats_TEST.cc

@@ -58,6 +58,19 @@ TEST(WorldStatsTest, IGN_UTILS_TEST_ENABLED_ONLY_ON_LINUX(Load))
   auto plugin = plugins[0];
   EXPECT_EQ(plugin->Title(), "World stats");
 
+  // Check that everything is visible
+  for (auto name : {
+      "realTimeFactorValue",
+      "simTimeValue",
+      "realTimeValue",
+      "iterationsValue",
+    })
+  {
+    auto obj = plugin->PluginItem()->findChild<QObject *>(name);
+    ASSERT_NE(nullptr, obj) << name;
+    EXPECT_TRUE(obj->property("visible").toBool()) << name;
+  }
+
   // Cleanup
   plugins.clear();
 }