Add doc for RemoteGuiExample2 and add it to tutorials

etc/doxygen/pages/Tutorials.dox

@@ -2,7 +2,10 @@
 
 \page ArmarXGui-Tutorials ArmarXGui Tutorials
 
-Tutorials related to ArmarXGui
+Tutorials from ArmarXGui:
+
 \li \subpage ArmarXGui-Tutorials-CreateGuiPlugin
 
+\li  \ref Component-RemoteGuiExample2 (Example component for how to use the RemoteGui)
+
 */

source/ArmarXGui/applications/RemoteGuiExample/RemoteGuiExample2.cpp

@@ -24,14 +24,35 @@
 
 #include <ArmarXCore/libraries/DecoupledSingleComponent/Decoupled.h>
 
+
 namespace armarx
 {
-    ARMARX_DECOUPLED_REGISTER_COMPONENT(RemoteGuiExample2);
 
     RemoteGuiExample2::RemoteGuiExample2()
     {
     }
 
+
+    std::string RemoteGuiExample2::getDefaultName() const
+    {
+        return GetDefaultName();
+    }
+
+
+    std::string RemoteGuiExample2::GetDefaultName()
+    {
+        return "RemoteGuiExample2";
+    }
+
+
+    armarx::PropertyDefinitionsPtr RemoteGuiExample2::createPropertyDefinitions()
+    {
+        armarx::PropertyDefinitionsPtr defs(new armarx::ComponentPropertyDefinitions(getConfigIdentifier()));
+
+        return defs;
+    }
+
+
     void RemoteGuiExample2::onInitComponent()
     {
     }
@@ -59,11 +80,6 @@ namespace armarx
         onDisconnectComponent();
     }
 
-    armarx::PropertyDefinitionsPtr RemoteGuiExample2::createPropertyDefinitions()
-    {
-        return armarx::PropertyDefinitionsPtr(new armarx::ComponentPropertyDefinitions(
-                getConfigIdentifier()));
-    }
 
     void RemoteGuiExample2::RemoteGui_update()
     {
@@ -71,6 +87,7 @@ namespace armarx
         updateTab_Events();
     }
 
+
     void RemoteGuiExample2::createTab_Widgets()
     {
         // Just add a lot of widgets...
@@ -185,6 +202,7 @@ namespace armarx
         RemoteGui_createTab("Example2_Widgets", root, &ui);
     }
 
+
     void RemoteGuiExample2::updateTab_Widgets()
     {
         auto& ui = widgetsTab;
@@ -202,6 +220,7 @@ namespace armarx
         ui.sendUpdates();
     }
 
+
     void RemoteGuiExample2::createTab_Events()
     {
         auto& ui = eventsTab;
@@ -239,6 +258,7 @@ namespace armarx
         RemoteGui_createTab("Example2_Events", vLayout, &ui);
     }
 
+
     void RemoteGuiExample2::updateTab_Events()
     {
         auto& ui = eventsTab;
@@ -255,4 +275,7 @@ namespace armarx
 
         ui.spinInt.setValue(currentValue);
     }
+
+
+    ARMARX_REGISTER_COMPONENT_EXECUTABLE(RemoteGuiExample2, RemoteGuiExample2::GetDefaultName());
 }

source/ArmarXGui/applications/RemoteGuiExample/RemoteGuiExample2.h

@@ -58,73 +58,103 @@ namespace armarx
     };
 
 
-    /**
-     * @class RemoteGuiExample2PropertyDefinitions
-     * @brief
-     */
-    class RemoteGuiExample2PropertyDefinitions:
-        public armarx::ComponentPropertyDefinitions
-    {
-    public:
-        RemoteGuiExample2PropertyDefinitions(std::string prefix):
-            armarx::ComponentPropertyDefinitions(prefix)
-        {
-        }
-    };
 
     /**
      * @defgroup Component-RemoteGuiExample2 RemoteGuiExample2
      * @ingroup ArmarXGui-Components
-     * A description of the component RemoteGuiExample2.
+     *
+     * An example for how to use the remote gui framework for building simple
+     * user interfaces over ice.
+     *
+     * Often, you want to allow simple user interactions with an ArmarX
+     * component, e.g. to tweak a parameter, enable a feature or visualization
+     * or trigger an action. Building a dedicated, full-blown gui plugin can
+     * be very tedious for simple cases.
+     * For this use case, ArmarX offers a remote gui framework for building
+     * user interfaces over ice.
+     *
+     * This component demonstrates how to do this based on two examples:
+     * \li A *widgets* tab focusing on how to add different widget types,
+     *     such as sliders, spinners, check boxes and buttons.
+     * \li An *events* tab showing how you can change the remote gui as a
+     *     reaction to events triggered by the user via the remote gui.
+     *
+     * To run the example:
+     * \li Start the component `RemoteGuiProvider`
+     * \li Open the gui plugin `RemoteGui`
+     * \li Start the component `RemoteGuiExample2`
+     * \li Observe and interact with the created tabs in the `RemoteGui` widget.
+     *
+     * The scenario `RemoteGuiTest` starts the necessary components,
+     * including the example component.
+     *
+     * A component which wants to offer a remote gui needs to:
+     * \li `#include <ArmarXGui/libraries/ArmarXGuiComponentPlugins/LightweightRemoteGuiComponentPlugin.h>`
+     * \li Inherit from the `armarx::LightweightRemoteGuiComponentPluginUser`
+     * \li Build and create a `armarx::RemoteGui::Client::Tab` in its
+     *     `onConnectComponent()` using `RemoteGui_createTab()`
+     * \li Start the update processing thread in `onConnectComponent()`
+     *     using `RemoteGui_startRunningTask()`
+     * \li Implement the virtual function `RemoteGui_update()` to process gui
+     *     events (e.g. changed values, pressed buttons)
+     *
+     * `RemoteGui_createTab()` can be called once by the component to create
+     * a tab in the `RemoteGui` widget. In can be called again later to
+     * rebuild the tab, e.g. if the gui's structure should change.
+     *
+     * `RemoteGui_update()` is called by a processing thread at a regular
+     * interval. There, you can check the widgets for whether their value has
+     * changed (`.hasValueChanged()`) or whether a button was pressed
+     * (`.wasClicked()`).
+     *
+     * **Important note:** `RemoteGui_update()` is called from a separate thread,
+     * so you have to use synchronization mechanisms such as `std::mutex` and
+     * `std::scoped_lock` to synchronize access to variables which are
+     * accessed by different threads.
+     *
+     * \see RemoteGuiExample2
+     *
      *
      * @class RemoteGuiExample2
      * @ingroup Component-RemoteGuiExample2
+     *
      * @brief Brief description of class RemoteGuiExample2.
      *
-     * Detailed description of class RemoteGuiExample2.
+     * @see @ref Component-RemoteGuiExample2
      */
     class RemoteGuiExample2
         : virtual public armarx::Component
         , virtual public armarx::LightweightRemoteGuiComponentPluginUser
     {
     public:
+
         RemoteGuiExample2();
 
-        /**
-         * @see armarx::ManagedIceObject::getDefaultName()
-         */
-        std::string getDefaultName() const override
-        {
-            return "RemoteGuiExample2";
-        }
+        /// @see armarx::ManagedIceObject::getDefaultName()
+        std::string getDefaultName() const override;
+        static std::string GetDefaultName();
+
 
     protected:
-        /**
-         * @see armarx::ManagedIceObject::onInitComponent()
-         */
+
+        /// @see PropertyUser::createPropertyDefinitions()
+        armarx::PropertyDefinitionsPtr createPropertyDefinitions() override;
+
+        /// @see armarx::ManagedIceObject::onInitComponent()
         void onInitComponent() override;
 
-        /**
-         * @see armarx::ManagedIceObject::onConnectComponent()
-         */
+        /// @see armarx::ManagedIceObject::onConnectComponent()
         void onConnectComponent() override;
 
-        /**
-         * @see armarx::ManagedIceObject::onDisconnectComponent()
-         */
+        /// @see armarx::ManagedIceObject::onDisconnectComponent()
         void onDisconnectComponent() override;
 
-        /**
-         * @see armarx::ManagedIceObject::onExitComponent()
-         */
+        /// @see armarx::ManagedIceObject::onExitComponent()
         void onExitComponent() override;
 
-        /**
-         * @see PropertyUser::createPropertyDefinitions()
-         */
-        armarx::PropertyDefinitionsPtr createPropertyDefinitions() override;
 
     private:
+
         void RemoteGui_update() override;
 
         void createTab_Widgets();
@@ -133,8 +163,11 @@ namespace armarx
         void createTab_Events();
         void updateTab_Events();
 
+
     private:
+
         EventsTab eventsTab;
         WidgetsTab widgetsTab;
+
     };
 }