Classes
class	RemoteGuiExample2
	Brief description of class RemoteGuiExample2. More...

Detailed Description

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:

A widgets tab focusing on how to add different widget types, such as sliders, spinners, check boxes and buttons.
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:

Start the component RemoteGuiProvider
Open the gui plugin RemoteGui
Start the component RemoteGuiExample2
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:

#include <ArmarXGui/libraries/ArmarXGuiComponentPlugins/LightweightRemoteGuiComponentPlugin.h>
Inherit from the armarx::LightweightRemoteGuiComponentPluginUser
Build and create a armarx::RemoteGui::Client::Tab in its onConnectComponent() using RemoteGui_createTab()
Start the update processing thread in onConnectComponent() using RemoteGui_startRunningTask()
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 also: RemoteGuiExample2

Classes

Detailed Description