Skip to content
Snippets Groups Projects
Commit b8045f97 authored by Peter Kaiser's avatar Peter Kaiser
Browse files

Documentation: Rearranged gui plugins

parent 94a88193
No related branches found
No related tags found
No related merge requests found
Showing with 32 additions and 33 deletions
/**
* \defgroup RobotAPI-ArmarXGuiPlugins GUI Plugins
*/
\page RobotAPI-GuiPlugins GUI Plugins
The following Gui Plugins are available:
\subpage RobotAPI-GuiPlugins-ArmarXPlotter
\subpage RobotAPI-GuiPlugins-TCPMover
\subpage RobotAPI-GuiPlugins-HandUnitWidget
\subpage RobotAPI-GuiPlugins-HapticUnitPlugin
\subpage RobotAPI-GuiPlugins-KinematicUnitPlugin
\subpage RobotAPI-GuiPlugins-PlatformUnitPlugin
\subpage RobotAPI-GuiPlugins-RobotViewerPlugin
*/
......@@ -54,5 +54,5 @@ Available GUI-plugins provide access to the kinematic robot state, end effectors
RobotAPI also provides a GUI-plugin for robot visualization.
\par
\link RobotAPI-ArmarXGuiPlugins Read more \endlink
\link RobotAPI-GuiPlugins Read more \endlink
*/
/**
\mainpage
RobotAPI description
......@@ -11,4 +12,4 @@ RobotAPI description
\li \subpage RobotAPI-GuiPlugins "RobotAPI Gui Plugins"
\li \subpage RobotAPI-About "RobotAPI About"
\li \subpage RobotAPI-License "RobotAPI License"
*/
......@@ -61,7 +61,7 @@ namespace armarx
};
/*!
* \class HandUnitWidget
* \page RobotAPI-GuiPlugins-HandUnitWidget HandUnitGuiPlugin
* \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
......@@ -71,9 +71,6 @@ namespace armarx
* 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,
......
......@@ -45,12 +45,6 @@ namespace armarx
{
class HapticUnitConfigDialog;
/*!
\class HapticUnitGuiPlugin
\brief This plugin provides a widget with which the HapticUnit can be controlled.
\see HapticUnitWidget
*/
class HapticUnitGuiPlugin :
public ArmarXGuiPlugin
{
......@@ -63,11 +57,8 @@ namespace armarx
};
/*!
\class HapticUnitWidget
\page RobotAPI-GuiPlugins-HapticUnitPlugin HapticUnitPlugin
\brief With this widget the HapticUnit can be controlled.
\ingroup RobotAPI-ArmarXGuiPlugins ArmarXGuiPlugins
\see HapticUnitGuiPlugin
*/
class HapticUnitWidget :
public ArmarXComponentWidgetController
......
......@@ -85,7 +85,8 @@ namespace armarx
};
/*!
\class KinematicUnitWidget
\page RobotAPI-GuiPlugins-KinematicUnitPlugin KinematicUnitPlugin
\brief This widget shows position and velocity of all joints. Optionally a 3d robot model can be visualized.
\image html KinematicUnitGUI.png
......@@ -103,9 +104,6 @@ namespace armarx
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,
......
......@@ -61,7 +61,7 @@ namespace armarx
};
/*!
\class PlatformUnitWidget
\page RobotAPI-GuiPlugins-PlatformUnitPlugin PlatformUnitPlugin
\brief With this widget the PlatformUnit can be controlled.
\image html PlatformUnitGUI.png "The plugin's ui." width=300px
......@@ -76,8 +76,6 @@ namespace armarx
:---------------- | :-------------: | :-------------- |:--------------------
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,
......
......@@ -73,7 +73,8 @@ namespace armarx
};
/**
\class RobotViewerWidget
\page RobotAPI-GuiPlugins-RobotViewerPlugin RobotViewerPlugin
\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
......@@ -82,9 +83,6 @@ namespace armarx
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
......
......@@ -63,7 +63,7 @@ namespace armarx
class ArmarXPlotterDialog;
/*!
* \class ArmarXPlotter
* \page RobotAPI-GuiPlugins-ArmarXPlotter 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.
......
......@@ -69,10 +69,10 @@ namespace armarx {
};*/
/*
/**
* \page RobotAPI-GuiPlugins-TCPMover TCPMover
* @brief The TCPMover widget...
* @ingroup RobotAPI-ArmarXGuiPlugins ArmarXGuiPlugins
*/
*/
class TCPMover :
public ArmarXComponentWidgetController
{
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment