diff --git a/etc/doxygen/images/HandUnitGUI.png b/etc/doxygen/images/HandUnitGUI.png
index b590e868946a9def011f7cb5d7c590fb31462d31..dbcd1c8826385ab6ba02be8ca2081ed6755aa4e8 100644
Binary files a/etc/doxygen/images/HandUnitGUI.png and b/etc/doxygen/images/HandUnitGUI.png differ
diff --git a/etc/doxygen/images/KinematicUnitGUI.png b/etc/doxygen/images/KinematicUnitGUI.png
index 9a80ae60115ede8071588b9850cba74d959f4dc1..f567e03ccf1c84e7fcea5595d8e9e641c188b600 100644
Binary files a/etc/doxygen/images/KinematicUnitGUI.png and b/etc/doxygen/images/KinematicUnitGUI.png differ
diff --git a/etc/doxygen/images/PlatformUnitGuiPlugin_widgetpng.png b/etc/doxygen/images/PlatformUnitGuiPlugin_widgetpng.png
deleted file mode 100644
index 43f6ba7767598bc7fd95f9db3687b909e50ecb22..0000000000000000000000000000000000000000
Binary files a/etc/doxygen/images/PlatformUnitGuiPlugin_widgetpng.png and /dev/null differ
diff --git a/etc/doxygen/images/Plotter.png b/etc/doxygen/images/Plotter.png
deleted file mode 100644
index 4a2c93ebbe450cd40f8305c826b80c2d8571d924..0000000000000000000000000000000000000000
Binary files a/etc/doxygen/images/Plotter.png and /dev/null differ
diff --git a/etc/doxygen/images/PlotterGUI.png b/etc/doxygen/images/PlotterGUI.png
new file mode 100644
index 0000000000000000000000000000000000000000..26c25d1a468d84aed7c7f701aedc44bd8446addf
Binary files /dev/null and b/etc/doxygen/images/PlotterGUI.png differ
diff --git a/etc/doxygen/images/RobotViewerGUI.png b/etc/doxygen/images/RobotViewerGUI.png
index 51013ed4f40d00662935e6b3d14ffa96c77abeb7..50b156a9dad353c50546570d3071541a2e1675ad 100644
Binary files a/etc/doxygen/images/RobotViewerGUI.png and b/etc/doxygen/images/RobotViewerGUI.png differ
diff --git a/etc/doxygen/pages/RobotApi-Gui-plugins.dox b/etc/doxygen/pages/RobotApi-Gui-plugins.dox
index b703732f17679147c4230698fa4e05e9c935b2f9..7867bcb824db3a218f1ab0f4bd74364aa55550dc 100644
--- a/etc/doxygen/pages/RobotApi-Gui-plugins.dox
+++ b/etc/doxygen/pages/RobotApi-Gui-plugins.dox
@@ -1,4 +1,4 @@
/**
- * \defgroup ArmarXGuiPlugins-RobotAPI RobotAPI GUI plugins
+ * \defgroup RobotAPI-ArmarXGuiPlugins RobotAPI GUI plugins
* \ingroup ArmarXGuiPlugins
*/
\ No newline at end of file
diff --git a/source/RobotAPI/gui_plugins/HandUnitPlugin/HandUnitGuiPlugin.h b/source/RobotAPI/gui_plugins/HandUnitPlugin/HandUnitGuiPlugin.h
index b9f2d186d0ee380bd34a35f5ffa441ba68202905..1a354d398c8e3297877c6d5278ceb159441317e3 100644
--- a/source/RobotAPI/gui_plugins/HandUnitPlugin/HandUnitGuiPlugin.h
+++ b/source/RobotAPI/gui_plugins/HandUnitPlugin/HandUnitGuiPlugin.h
@@ -45,19 +45,7 @@ namespace armarx
/**
\class HandUnitGuiPlugin
- \brief With this plugin the HandUnit can be controlled.
- \image html HandUnitGUI.png
-
- When you add the widget to the Gui, you need to specify the following parameters:
-
- Parameter Name | Example Value | Required? | Description
- :---------------- | :-------------: | :-------------- |:--------------------
- Proxy | LeftHandUnit | Yes | The hand unit you want to control.
-
- You can either select a preshape from the drop-down-menu on top or set each
- joint individually.
-
- \ingroup ArmarXGuiPlugins-RobotAPI
+ \brief This plugin offers a widget witch which the HandUnit can be controlled.
\see HandUnitWidget
*/
class HandUnitGuiPlugin :
@@ -71,12 +59,21 @@ namespace armarx
}
};
- /**
- \class HandUnitWidget
- \brief With this widget the HandUnit can be controlled.
-
- \see HandUnitGuiPlugin
- */
+ /*!
+ * \class HandUnitWidget
+ * \brief With this widget the HandUnit can be controlled.
+ * \image html HandUnitGUI.png
+ * You can either select a preshape from the drop-down-menu on top or set each
+ * joint individually.
+ * When you add the widget to the Gui, you need to specify the following parameters:
+ *
+ * Parameter Name | Example Value | Required? | Description
+ * :---------------- | :-------------: | :-------------- |:--------------------
+ * Proxy | LeftHandUnit | Yes | The hand unit you want to control.
+ *
+ * \ingroup RobotAPI-ArmarXGuiPlugins ArmarXGuiPlugins
+ * \see HandUnitGuiPlugin
+ */
class HandUnitWidget :
public ArmarXComponentWidgetController,
public HandUnitListener
diff --git a/source/RobotAPI/gui_plugins/HapticUnitPlugin/HapticUnitGuiPlugin.h b/source/RobotAPI/gui_plugins/HapticUnitPlugin/HapticUnitGuiPlugin.h
index ec2c337afaa0f863df0f16cdb225c3f154c19e29..c33e99bd16c7723cc90b8afdb4f6850fe781f6e4 100644
--- a/source/RobotAPI/gui_plugins/HapticUnitPlugin/HapticUnitGuiPlugin.h
+++ b/source/RobotAPI/gui_plugins/HapticUnitPlugin/HapticUnitGuiPlugin.h
@@ -46,10 +46,9 @@ namespace armarx
{
class HapticUnitConfigDialog;
- /**
+ /*!
\class HapticUnitGuiPlugin
- \brief With this plugin the HapticUnit can be controlled.
- \ingroup ArmarXGuiPlugins-RobotAPI
+ \brief This plugin provides a widget with which the HapticUnit can be controlled.
\see HapticUnitWidget
*/
@@ -64,10 +63,11 @@ namespace armarx
}
};
- /**
+ /*!
\class HapticUnitWidget
\brief With this widget the HapticUnit can be controlled.
+ \ingroup RobotAPI-ArmarXGuiPlugins ArmarXGuiPlugins
\see HapticUnitGuiPlugin
*/
class HapticUnitWidget :
diff --git a/source/RobotAPI/gui_plugins/KinematicUnitPlugin/KinematicUnitGuiPlugin.h b/source/RobotAPI/gui_plugins/KinematicUnitPlugin/KinematicUnitGuiPlugin.h
index 92ff0b98f324adf7c16904f48876b94f4d6d396d..c0b5f6950784bfd138012eb66166e75d663f7ef2 100644
--- a/source/RobotAPI/gui_plugins/KinematicUnitPlugin/KinematicUnitGuiPlugin.h
+++ b/source/RobotAPI/gui_plugins/KinematicUnitPlugin/KinematicUnitGuiPlugin.h
@@ -66,27 +66,10 @@ namespace armarx
class KinematicUnitConfigDialog;
- /**
+ /*!
\class KinematicUnitGuiPlugin
\brief This plugin provides a generic widget showing position and velocity of all joints. Optionally a 3d robot model can be visualized.
-
- \image html KinematicUnitGUI.png
- When you add the widget to the Gui, you need to specify the following parameters:
-
- Parameter Name | Example Value | Required? | Description
- :---------------- | :-------------: | :-------------- |:--------------------
- Robot model filepath | $ArmarX_Core/Armar3/data/Armar3/robotmodel/ArmarIII.xml | Yes | The robot model to use. This needs to be the same model the kinematic unit is using.
- Robot nodeset name | Robot | Yes | ?
- Kinematic unit name - Proxy | Armar3KinematicUnit | Yes | The kinematic unit you wish to observe/control.
- RobotState Topic Name | RobotState | ? | ?
-
- This plugin allows you to both observe and control a kinematic unit. All joints are listed in
- the table in the center of the widget. The 3D viewer shows the current state of the robot.
-
- On the top you can select the joint you wish to control and the control mode. You can control
- a joint with the slider below.
\see KinematicUnitWidget
- \ingroup ArmarXGuiPlugins-RobotAPI
*/
class KinematicUnitGuiPlugin :
public ArmarXGuiPlugin
@@ -106,10 +89,29 @@ namespace armarx
void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const;
};
- /**
+ /*!
\class KinematicUnitWidget
+ \brief This widget shows position and velocity of all joints. Optionally a 3d robot model can be visualized.
+
+ \image html KinematicUnitGUI.png
+ When you add the widget to the Gui, you need to specify the following parameters:
+
+ Parameter Name | Example Value | Required? | Description
+ :---------------- | :-------------: | :-------------- |:--------------------
+ Robot model filepath | $ArmarX_Core/Armar3/data/Armar3/robotmodel/ArmarIII.xml | Yes | The robot model to use. This needs to be the same model the kinematic unit is using.
+ Robot nodeset name | Robot | Yes | ?
+ Kinematic unit name - Proxy | Armar3KinematicUnit | Yes | The kinematic unit you wish to observe/control.
+ RobotState Topic Name | RobotState | ? | ?
+
+ This widget allows you to both observe and control a kinematic unit. All joints are listed in
+ the table in the center of the widget. The 3D viewer shows the current state of the robot.
+
+ On the top you can select the joint you wish to control and the control mode. You can control
+ a joint with the slider below.
+
+ \ingroup RobotAPI-ArmarXGuiPlugins ArmarXGuiPlugins
\see KinematicUnitGuiPlugin
- */
+ */
class KinematicUnitWidgetController :
public ArmarXComponentWidgetController,
public KinematicUnitListener
diff --git a/source/RobotAPI/gui_plugins/PlatformUnitPlugin/PlatformUnitGuiPlugin.h b/source/RobotAPI/gui_plugins/PlatformUnitPlugin/PlatformUnitGuiPlugin.h
index 01dd216af8fae7b46316beea5f61cb2e2704986b..b0b9a2c91ffc18353d1d78019c642b626ee06294 100644
--- a/source/RobotAPI/gui_plugins/PlatformUnitPlugin/PlatformUnitGuiPlugin.h
+++ b/source/RobotAPI/gui_plugins/PlatformUnitPlugin/PlatformUnitGuiPlugin.h
@@ -47,23 +47,8 @@ namespace armarx
/**
\class PlatformUnitGuiPlugin
- \brief With this plugin the PlatformUnit can be controlled.
- \ingroup ArmarXGuiPlugins-RobotAPI
-
+ \brief This plugin provides a widget with which the PlatformUnit can be controlled.
\see PlatformUnitWidget
-
- \image html PlatformUnitGUI.png "The plugin's ui." width=300px
- -# The current position and rotation, fields to enter a new target and a button to set the platform in motion.
- -# A joystick like control widget to move the platform. The platform does not rotate to move in a direction. Up moves the platform forward.
- -# A joystick like control widget to rotate the platform.
- -# Be careful to set a maximum velocity before using the joysticks.
-
- When you add the widget to the Gui, you need to specify the following parameters:
-
- Parameter Name | Example Value | Required? | Description
- :---------------- | :-------------: | :-------------- |:--------------------
- PlatformUnit - Proxy | PlatformUnit | Yes | The name of the platform unit.
- Platform | Platform | Yes | The name of the platform.
*/
class PlatformUnitGuiPlugin :
public ArmarXGuiPlugin
@@ -76,11 +61,24 @@ namespace armarx
}
};
- /**
+ /*!
\class PlatformUnitWidget
\brief With this widget the PlatformUnit can be controlled.
+
+ \image html PlatformUnitGUI.png "The plugin's ui." width=300px
+ -# The current position and rotation, fields to enter a new target and a button to set the platform in motion.
+ -# A joystick like control widget to move the platform. The platform does not rotate to move in a direction. Up moves the platform forward.
+ -# A joystick like control widget to rotate the platform.
+ -# Be careful to set a maximum velocity before using the joysticks.
+ When you add the widget to the Gui, you need to specify the following parameters:
+
+ Parameter Name | Example Value | Required? | Description
+ :---------------- | :-------------: | :-------------- |:--------------------
+ PlatformUnit - Proxy | PlatformUnit | Yes | The name of the platform unit.
+ Platform | Platform | Yes | The name of the platform.
\see PlatformUnitGuiPlugin
+ \ingroup RobotAPI-ArmarXGuiPlugins ArmarXGuiPlugins
*/
class PlatformUnitWidget :
public ArmarXComponentWidgetController,
diff --git a/source/RobotAPI/gui_plugins/RobotViewerPlugin/RobotViewerGuiPlugin.h b/source/RobotAPI/gui_plugins/RobotViewerPlugin/RobotViewerGuiPlugin.h
index 969a9a2b9e60e9525dc06dde0b2c969830ba2f05..b52f4963e11e498a3c77a5c9156d9d0625c434e8 100644
--- a/source/RobotAPI/gui_plugins/RobotViewerPlugin/RobotViewerGuiPlugin.h
+++ b/source/RobotAPI/gui_plugins/RobotViewerPlugin/RobotViewerGuiPlugin.h
@@ -59,16 +59,6 @@ namespace armarx
\class RobotViewerGuiPlugin
\brief This plugin provides a generic widget showing a 3D model of the robot. The robot is articulated and moved according to the corresponding RemoteRobot.
Further, DebugDrawer methods are available.
-
- \image html RobotViewerGUI.png
-
- When you add the widget to the Gui, you need to specify the following parameters:
-
- Parameter Name | Example Value | Required? | Description
- :---------------- | :-------------: | :-------------- |:--------------------
- Proxy | RobotStateComponent | Yes | The name of the robot state component.
-
- \ingroup ArmarXGuiPlugins-RobotAPI
\see RobotViewerWidget
*/
class RobotViewerGuiPlugin :
@@ -84,9 +74,19 @@ namespace armarx
};
/**
- \class RobotViewerWidget
- \see RobotViewerGuiPlugin
- */
+ \class RobotViewerWidget
+ \brief This widget shows a 3D model of the robot. The robot is articulated and moved according to the corresponding RemoteRobot.
+ Further, DebugDrawer methods are available.
+ \image html RobotViewerGUI.png
+ When you add the widget to the Gui, you need to specify the following parameters:
+
+ Parameter Name | Example Value | Required? | Description
+ :---------------- | :-------------: | :-------------- |:--------------------
+ Proxy | RobotStateComponent | Yes | The name of the robot state component.
+
+ \ingroup RobotAPI-ArmarXGuiPlugins ArmarXGuiPlugins
+ \see RobotViewerGuiPlugin
+ */
class RobotViewerWidgetController :
public ArmarXComponentWidgetController
{
diff --git a/source/RobotAPI/gui_plugins/SensorActorWidgetsPlugin/ArmarXPlotter/ArmarXPlotter.h b/source/RobotAPI/gui_plugins/SensorActorWidgetsPlugin/ArmarXPlotter/ArmarXPlotter.h
index fdbb16794885d4215b3e2f5ed59c854c9b167f50..33f6c200ac19cad97310609a46363050cfe3e05f 100644
--- a/source/RobotAPI/gui_plugins/SensorActorWidgetsPlugin/ArmarXPlotter/ArmarXPlotter.h
+++ b/source/RobotAPI/gui_plugins/SensorActorWidgetsPlugin/ArmarXPlotter/ArmarXPlotter.h
@@ -62,8 +62,12 @@ namespace armarx
typedef std::map< std::string, std::vector<TimeData> > GraphDataMap;
class ArmarXPlotterDialog;
- /**
- \class ArmarXPlotter
+ /*!
+ * \class ArmarXPlotter
+ * \brief The plotter widget allows the user to plot any sensor channel.
+ * \image html PlotterGUI.png
+ * A sensor channel can be selected for plotting by clicking the wrench button at the bottom.
+ * \ingroup RobotAPI-ArmarXGuiPlugins ArmarXGuiPlugins
*/
class ARMARXCOMPONENT_IMPORT_EXPORT
ArmarXPlotter:
diff --git a/source/RobotAPI/gui_plugins/SensorActorWidgetsPlugin/ArmarXTCPMover/TCPMover.h b/source/RobotAPI/gui_plugins/SensorActorWidgetsPlugin/ArmarXTCPMover/TCPMover.h
index 0ef773289ed5bcac04629433bb2695a5dd59f126..945314aae829c6b5b57c08226abd6e12a93b2265 100644
--- a/source/RobotAPI/gui_plugins/SensorActorWidgetsPlugin/ArmarXTCPMover/TCPMover.h
+++ b/source/RobotAPI/gui_plugins/SensorActorWidgetsPlugin/ArmarXTCPMover/TCPMover.h
@@ -67,7 +67,10 @@ namespace armarx {
};
-
+ /*
+ * @brief The TCPMover widget...
+ * @ingroup RobotAPI-ArmarXGuiPlugins ArmarXGuiPlugins
+ */
class TCPMover :
public ArmarXComponentWidgetController
{
diff --git a/source/RobotAPI/gui_plugins/SensorActorWidgetsPlugin/SensorActorWidgetsPlugin.h b/source/RobotAPI/gui_plugins/SensorActorWidgetsPlugin/SensorActorWidgetsPlugin.h
index 578cd8d4ae63a3e71e5182d5a70d80372cb80452..74ff45f2be8a0a3edd54437038092523c84db2b1 100644
--- a/source/RobotAPI/gui_plugins/SensorActorWidgetsPlugin/SensorActorWidgetsPlugin.h
+++ b/source/RobotAPI/gui_plugins/SensorActorWidgetsPlugin/SensorActorWidgetsPlugin.h
@@ -33,13 +33,9 @@ namespace armarx
{
/**
* @brief The SensorActorWidgetPlugin offers the widgets Plotter and TCPMover.
- * @ingroup ArmarXGuiPlugins-RobotAPI
- *
- * The plotter widget allows the user to plot any sensor channel:
- * \image Plotter.png
- * A sensor channel can be selected for plotting by clicking the wrench button at the bottom.
*
* @see ArmarXPlotter
+ * @see TCPMover
*/
class ARMARXCOMPONENT_IMPORT_EXPORT SensorActorPlugin :
public ArmarXGuiPlugin