#include <ArmarXGui/libraries/ArmarXGuiBase/ArmarXWidgetController.h>

Inheritance diagram for ArmarXWidgetController:

Public Types
using	RecursiveMutex = std::recursive_mutex

using	RecursiveMutexLock = std::unique_lock<RecursiveMutex>

using	RecursiveMutexLockPtr = std::shared_ptr<RecursiveMutexLock>

using	RecursiveMutexPtr = std::shared_ptr<RecursiveMutex>

Public Slots
void	configAccepted ()

void	configRejected ()

void	enableMainWidget (bool enable)

Signals
void	configAccepted (ArmarXWidgetControllerPtr widget)

void	configRejected (ArmarXWidgetControllerPtr widget)

Public Member Functions
	ArmarXWidgetController ()

virtual void	configured ()
	This function must be implemented by the user, if he supplies a config dialog.

void	enableMainWidgetAsync (bool enable)
	This function enables/disables the main widget asynchronously (if called from a non qt thread).

virtual QPointer< QDialog >	getConfigDialog (QWidget *parent=0)
	getConfigDialog returns a pointer to the a configuration widget of this controller.

virtual QPointer< QWidget >	getCustomTitlebarWidget (QWidget *parent=0)
	getTitleToolbar returns a pointer to the a toolbar widget of this controller.

QString	getInstanceName ()

virtual QMainWindow *	getMainWindow ()
	Returns the ArmarX MainWindow.

virtual SoNode *	getScene ()
	Reimplementing this function and returning a SoNode* will show this SoNode in the 3DViewerWidget, so that you do not need to implement a viewer yourself.

virtual QPointer< QDialog >	getSceneConfigDialog (QWidget *parent=nullptr)
	Reimplementing this function and returning a QDialog* will enable a configuration button which opens the returned dialog.

QPointer< TipDialog >	getTipDialog () const
	Returns the default instance for the TipDialog used by all widgets (if not set otherwise).

virtual QPointer< QWidget >	getWidget ()
	getWidget returns a pointer to the a widget of this controller.

virtual QIcon	getWidgetCategoryIcon () const
	Implement this function to supply an icon for the category.

virtual QIcon	getWidgetIcon () const
	Implement this function to supply an icon for the menu.

virtual QString	getWidgetName () const =0
	Implement this function to specify the default name of your Widget.

virtual void	loadSettings (QSettings *settings)=0
	Implement to load the settings that are part of the GUI configuration.

virtual bool	onClose ()
	onClose is called before the DockWidget is closed.

virtual void	onLockWidget ()

virtual void	onUnlockWidget ()

virtual void	postDocking ()
	postDocking is called after the widget has been docked into the main window.

virtual void	saveSettings (QSettings *settings)=0
	Implement to save the settings as part of the GUI configuration.

bool	setInstanceName (QString instanceName)
	sets the name of this instance.

virtual void	setMainWindow (QMainWindow *mainWindow)

virtual void	setMutex3D (RecursiveMutexPtr const &mutex3D)
	This mutex is used to protect 3d scene updates. Usually called by the ArmarXGui main window on creation of this controller.

void	setTipDialog (QPointer< TipDialog > tipDialog)

	~ArmarXWidgetController () override

Public Member Functions inherited from Logging
SpamFilterDataPtr	deactivateSpam (float deactivationDurationSec=10.0f, const std::string &identifier="", bool deactivate=true) const
	disables the logging for the current line for the given amount of seconds.

MessageTypeT	getEffectiveLoggingLevel () const

	Logging ()

void	setLocalMinimumLoggingLevel (MessageTypeT level)
	With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set.

void	setTag (const LogTag &tag)

void	setTag (const std::string &tagName)

virtual	~Logging ()

Static Public Member Functions
template<typename Class>
static ArmarXWidgetControllerPtr	createInstance ()

static QIcon	GetWidgetCategoryIcon ()
	Implement this function to supply an icon for the menu (if you implemented static QString GetWidgetName()).

static QIcon	GetWidgetIcon ()
	Implement this function to supply an icon for the menu (if you implemented static QString GetWidgetName()).

static int	showMessageBox (const QString &msg)

Protected Attributes
std::shared_ptr< std::recursive_mutex >	mutex3D

Protected Attributes inherited from Logging
MessageTypeT	minimumLoggingLevel

SpamFilterDataPtr	spamFilter

LogTag	tag

Additional Inherited Members
Protected Member Functions inherited from Logging
bool	checkLogLevel (MessageTypeT level) const

const LogSenderPtr &	getLogSender () const
	Retrieve log sender.

LogSenderPtr	loghelper (const char file, int line, const char function) const

Member Typedef Documentation

◆ RecursiveMutex

using RecursiveMutex = std::recursive_mutex

◆ RecursiveMutexLock

using RecursiveMutexLock = std::unique_lock<RecursiveMutex>

◆ RecursiveMutexLockPtr

using RecursiveMutexLockPtr = std::shared_ptr<RecursiveMutexLock>

◆ RecursiveMutexPtr

using RecursiveMutexPtr = std::shared_ptr<RecursiveMutex>

Constructor & Destructor Documentation

◆ ArmarXWidgetController()

ArmarXWidgetController ( )

explicit

◆ ~ArmarXWidgetController()

~ArmarXWidgetController ( )

override

Member Function Documentation

◆ configAccepted [1/2]

void configAccepted ( )

slot

◆ configAccepted [2/2]

void configAccepted ( ArmarXWidgetControllerPtr widget )

signal

◆ configRejected [1/2]

void configRejected ( )

slot

◆ configRejected [2/2]

void configRejected ( ArmarXWidgetControllerPtr widget )

signal

◆ configured()

virtual void configured ( )

inlinevirtual

This function must be implemented by the user, if he supplies a config dialog.

This function is then automatically called, when the dialog was accepted.

See also: getConfigDialog()

Reimplemented in AffordancePipelineGuiWidgetController, ArMemMemoryViewerWidgetController, ArVizWidgetController, BoxToGraspCandidatesWidgetController, CartesianNaturalPositionControllerWidgetController, DebugPlotterWidgetWidgetController, DebugRobotUnitDataStreamingWidgetController, Base, FTSensorCalibrationGuiWidgetController, GraspCandidateViewerWidgetController, HandEyeCalibrationWidgetController, HandUnitWidget, HapticUnitWidget, ImageMaskPainterWidgetController, KinematicUnitWidgetController, LaserScannerPluginWidgetController, LaserScannerSelfLocalisationWidgetController, LookAtClickWidgetController, MotionPlanningServerWidgetController, WidgetController, ObjectPoseGuiWidgetController, OperatorViewWidgetController, PlatformUnitWidget, PointCloudVisualizationWidgetController, PresenterViewWidgetController, PrimitiveExtractionWidgetController, RemoteGuiWidgetController, RobotIKWidgetController, RobotUnitPluginWidgetController, RobotViewerWidgetController, SimoxCSpaceVisualizerWidgetController, SkillDashboardWidget, SkillManagerMonitorWidgetController, StatechartEditorController, TCPMover, ViewSelectionWidgetController, WidgetController, WriteToDebugObserverGuiPluginWidgetController, SceneEditorMainWindowController, GraphVisualizerWidget, PriorEditorController, WorkingMemoryController, ImageRecorderWidgetController, and UserAssistedSegmenterGuiWidgetController.

◆ createInstance()

template<typename Class>

static ArmarXWidgetControllerPtr createInstance ( )

inlinestatic

◆ enableMainWidget

void enableMainWidget ( bool enable )

slot

◆ enableMainWidgetAsync()

void enableMainWidgetAsync ( bool enable )

This function enables/disables the main widget asynchronously (if called from a non qt thread).

Call this function from onConnectComponent, onDisconnectComponent if your widget should be disabled if the connection was lost

Parameters

enable true to enable widget, false to disable widget

See also: onConnectComponent(), onDisconnectComponent(), getWidget()

◆ getConfigDialog()

QPointer< QDialog > getConfigDialog ( QWidget * parent = 0 )

virtual

getConfigDialog returns a pointer to the a configuration widget of this controller.

It is optional.

If you need your widget configured, before it is shown, you should implement this function and return a QDialog derived class.

Parameters

parent Pointer to the object, that should own this dialog.

Returns: pointer to a QDialog derived class, that should be used to configure your widget.

Note: When the dialog gets accepted (emit SIGNAL accepted()), the function configured() is called, which must be implemented as well.

See also: configured(), getWidget()

Reimplemented in AffordancePipelineGuiWidgetController, ArMemMemoryViewerWidgetController, ArVizWidgetController, BoxToGraspCandidatesWidgetController, CartesianNaturalPositionControllerWidgetController, DebugPlotterWidgetWidgetController, DebugRobotUnitDataStreamingWidgetController, Base, FTSensorCalibrationGuiWidgetController, GraspCandidateViewerWidgetController, HandEyeCalibrationWidgetController, HandUnitWidget, HapticUnitWidget, ImageMaskPainterWidgetController, KinematicUnitWidgetController, LaserScannerPluginWidgetController, LaserScannerSelfLocalisationWidgetController, LoadObjectsIntoMemoryWidgetController, LookAtClickWidgetController, MMMPlayerWidget, MotionPlanningServerWidgetController, WidgetController, ObjectPoseGuiWidgetController, OperatorViewWidgetController, PlatformUnitWidget, PointCloudVisualizationWidgetController, PresenterViewWidgetController, PrimitiveExtractionWidgetController, RemoteGuiWidgetController, RobotIKWidgetController, RobotUnitPluginWidgetController, RobotViewerWidgetController, SemanticRelationViewerWidgetController, SimoxCSpaceVisualizerWidgetController, SkillDashboardWidget, SkillManagerMonitorWidgetController, StatechartEditorController, TCPMover, ViewSelectionWidgetController, WidgetController, WriteToDebugObserverGuiPluginWidgetController, SceneEditorMainWindowController, GraphVisualizerWidget, PriorEditorController, WorkingMemoryController, ImageRecorderWidgetController, and UserAssistedSegmenterGuiWidgetController.

◆ getCustomTitlebarWidget()

QPointer< QWidget > getCustomTitlebarWidget ( QWidget * parent = 0 )

virtual

getTitleToolbar returns a pointer to the a toolbar widget of this controller.

It is optional. It must return the same instance on all calls.

The returned toolbar is displayed in the titlebar of the parent dockwidget. Use this to show button that should always be visible in the widget, but should not take up space in the widget. Keep the size of the toolbar to a minimum, so that it is not wider than the widget itself.

Reimplemented in AffordancePipelineGuiWidgetController, ConditionViewerWidgetController, KinematicUnitWidgetController, LogViewer, MessageDisplayPluginWidgetController, ObjectLocalizationRequesterWidgetController, ObserverWidgetController, RobotUnitPluginWidgetController, ScenarioManagerWidgetController, SimulatorControlController, SkillDashboardWidget, StatechartViewerController, StaticPlotterWidgetController, Viewer3DWidget, SceneEditorMainWindowController, WorkingMemoryController, and ImageMonitorWidgetController.

◆ getInstanceName()

QString getInstanceName ( )

◆ getMainWindow()

QMainWindow * getMainWindow ( )

virtual

Returns the ArmarX MainWindow.

◆ getScene()

virtual SoNode * getScene ( )

inlinevirtual

Reimplementing this function and returning a SoNode* will show this SoNode in the 3DViewerWidget, so that you do not need to implement a viewer yourself.

Returns

Reimplemented in ArVizWidgetController, DebugDrawerViewerWidgetController, KinematicUnitWidgetController, RobotViewerWidgetController, SimoxCSpaceVisualizerWidgetController, PriorEditorController, and WorkingMemoryController.

◆ getSceneConfigDialog()

QPointer< QDialog > getSceneConfigDialog ( QWidget * parent = nullptr )

virtual

Reimplementing this function and returning a QDialog* will enable a configuration button which opens the returned dialog.

Parameters

parent The parent widget which should be used as parent of the dialog

Returns: The dialog to open wehen the configuration button is clicked

Reimplemented in WorkingMemoryController.

◆ getTipDialog()

QPointer< TipDialog > getTipDialog ( ) const

Returns the default instance for the TipDialog used by all widgets (if not set otherwise).

This dialog has always the checkbox to not show a tip again, which is stored persistently.

◆ getWidget()

QPointer< QWidget > getWidget ( )

virtual

getWidget returns a pointer to the a widget of this controller.

This widget should be the main widget of this WidgetController. The standard implementation of this function creates a QWidget on the first call and assigns the pointer to the widget-member and returns the member.

Returns: pointer to the main widget.

Note: This function must always, at any time return a valid pointer. So if you reimplement it, you should create the widget in this function on the first call.

Reimplemented in ConditionViewerWidgetController, ObserverWidgetController, PlatformUnitWidget, StatechartEditorController, SceneEditorMainWindowController, and ImageMonitorWidgetController.

◆ GetWidgetCategoryIcon()

QIcon GetWidgetCategoryIcon ( )

static

Implement this function to supply an icon for the menu (if you implemented static QString GetWidgetName()).

The implementation should look like this:

static QIcon GetWidgetCategoryIcon()
{
     return QIcon{"my_resource_path"};
}
virtual QIcon getWidgetCategoryIcon() const override
{
     return GetWidgetCategoryIcon();
}

◆ getWidgetCategoryIcon()

QIcon getWidgetCategoryIcon ( ) const

virtual

Implement this function to supply an icon for the category.

Returns

◆ GetWidgetIcon()

QIcon GetWidgetIcon ( )

static

Implement this function to supply an icon for the menu (if you implemented static QString GetWidgetName()).

The implementation should look like this:

static QIcon GetWidgetIcon()
{
     return QIcon{"my_resource_path"};
}
virtual QIcon getWidgetIcon() const override
{
     return GetWidgetIcon();
}

◆ getWidgetIcon()

QIcon getWidgetIcon ( ) const

virtual

Implement this function to supply an icon for the menu.

Returns

◆ getWidgetName()

virtual QString getWidgetName ( ) const

pure virtual

Implement this function to specify the default name of your Widget.

Implement the function as:

static QString GetWidgetName()
{
     return "my_widget_category.my_widget_name"
}
virtual QString getWidgetName() const override
{
     return GetWidgetName();
}

If you implement the static GetWidgetName() function, the armarx gui does not need to instantiate this widget only to get the name.

Dot-Notation can be used to insert the widget in categories and subcategories (e.g.: "Statecharts.StatechartEditor"). Categories must not collide with Widget names.

Returns: Default name of the implemented Widget.

◆ loadSettings()

virtual void loadSettings ( QSettings * settings )

pure virtual

Implement to load the settings that are part of the GUI configuration.

These settings are NOT loaded automatically on widget startup, but when a GUI config is loaded (instead of the optional config dialog).

Implemented in AffordancePipelineGuiWidgetController, ArmarXPlotter, ArMemMemoryViewerWidgetController, ArVizDrawerGuiWidgetController, ArVizWidgetController, BatteryWidget, BoxToGraspCandidatesWidgetController, CartesianNaturalPositionControllerWidgetController, ClockWidgetController, ClutteredSceneGeneratorWidgetController, ConditionViewerWidgetController, DebugDrawerGuiPluginWidgetController, DebugDrawerViewerWidgetController, DebugPlotterWidgetWidgetController, DebugRobotUnitDataStreamingWidgetController, Base, EmergencyStopWidget, EventSenderOverview, FeatureLearningWidgetController, FTSensorCalibrationGuiWidgetController, GraspCandidateViewerWidgetController, GridFSFileEditorWidgetController, GuiHealthClientWidgetController, HandEyeCalibrationWidgetController, HandUnitWidget, HapticUnitWidget, HomogeneousMatrixCalculatorWidgetController, HsvColorSegmentationWidgetController, IceGridViewer, IceProxyWidgetController, ImageMaskPainterWidgetController, KinematicUnitWidgetController, LaserScannerPluginWidgetController, LaserScannerSelfLocalisationWidgetController, LoadObjectsIntoMemoryWidgetController, LogViewer, LookAtClickWidgetController, MessageDisplayPluginWidgetController, MMMPlayerWidget, MotionPlanningServerWidgetController, WidgetController, ObjectLocalizationRequesterWidgetController, ObjectPoseGuiWidgetController, ObserverWidgetController, OperatorViewWidgetController, PlatformUnitWidget, PointCloudVisualizationWidgetController, PresenterViewWidgetController, PrimitiveExtractionWidgetController, RemoteGuiWidgetController, RobotIKWidgetController, RobotTrajectoryDesignerGuiPluginWidgetController, RobotUnitPluginWidgetController, RobotViewerWidgetController, ScenarioManagerWidgetController, SemanticRelationViewerWidgetController, SimoxCSpaceVisualizerWidgetController, SimulatorControlController, SkillDashboardWidget, SkillManagerMonitorWidgetController, SnapshotControlWidgetController, StatechartEditorController, StatechartViewerController, StaticPlotterWidgetController, SystemStateMonitorWidget, TCPMover, ThreadViewer, TopicReplayerWidgetController, Viewer3DWidget, ViewSelectionWidgetController, WidgetController, WriteToDebugObserverGuiPluginWidgetController, SceneEditorMainWindowController, GraphVisualizerWidget, PriorEditorController, WorkingMemoryController, ImageMonitorWidgetController, ImageRecorderWidgetController, UserAssistedSegmenterGuiWidgetController, and WidgetController.

◆ onClose()

virtual bool onClose ( )

inlinevirtual

onClose is called before the DockWidget is closed.

Returns: returns close, if the widget should really be closed

Reimplemented in ArmarXComponentWidgetController, LogViewer, MMMPlayerWidget, and StatechartEditorController.

◆ onLockWidget()

void onLockWidget ( )

virtual

Reimplemented in RemoteGuiWidgetController, Viewer3DWidget, and WidgetController.

◆ onUnlockWidget()

void onUnlockWidget ( )

virtual

Reimplemented in RemoteGuiWidgetController, Viewer3DWidget, and WidgetController.

◆ postDocking()

virtual void postDocking ( )

inlinevirtual

postDocking is called after the widget has been docked into the main window.

This can be used to initialize OpenGL etc. to avoid strange effects like window plopping out.

Reimplemented in Viewer3DWidget, SceneEditorMainWindowController, and WidgetController.

◆ saveSettings()

virtual void saveSettings ( QSettings * settings )

pure virtual

Implement to save the settings as part of the GUI configuration.

These settings are NOT saved automatically when closing the widget, but when a GUI config is saved.

Implemented in AffordancePipelineGuiWidgetController, ArmarXPlotter, ArMemMemoryViewerWidgetController, ArVizDrawerGuiWidgetController, ArVizWidgetController, BatteryWidget, BoxToGraspCandidatesWidgetController, CartesianNaturalPositionControllerWidgetController, ClockWidgetController, ClutteredSceneGeneratorWidgetController, ConditionViewerWidgetController, DebugDrawerGuiPluginWidgetController, DebugDrawerViewerWidgetController, DebugPlotterWidgetWidgetController, DebugRobotUnitDataStreamingWidgetController, Base, EmergencyStopWidget, EventSenderOverview, FeatureLearningWidgetController, FTSensorCalibrationGuiWidgetController, GraspCandidateViewerWidgetController, GridFSFileEditorWidgetController, GuiHealthClientWidgetController, HandEyeCalibrationWidgetController, HandUnitWidget, HapticUnitWidget, HomogeneousMatrixCalculatorWidgetController, HsvColorSegmentationWidgetController, IceGridViewer, IceProxyWidgetController, ImageMaskPainterWidgetController, KinematicUnitWidgetController, LaserScannerPluginWidgetController, LaserScannerSelfLocalisationWidgetController, LoadObjectsIntoMemoryWidgetController, LogViewer, LookAtClickWidgetController, MessageDisplayPluginWidgetController, MMMPlayerWidget, MotionPlanningServerWidgetController, WidgetController, ObjectLocalizationRequesterWidgetController, ObjectPoseGuiWidgetController, ObserverWidgetController, OperatorViewWidgetController, PlatformUnitWidget, PointCloudVisualizationWidgetController, PresenterViewWidgetController, PrimitiveExtractionWidgetController, RemoteGuiWidgetController, RobotIKWidgetController, RobotTrajectoryDesignerGuiPluginWidgetController, RobotUnitPluginWidgetController, RobotViewerWidgetController, ScenarioManagerWidgetController, SemanticRelationViewerWidgetController, SimoxCSpaceVisualizerWidgetController, SimulatorControlController, SkillDashboardWidget, SkillManagerMonitorWidgetController, SnapshotControlWidgetController, StatechartEditorController, StatechartViewerController, StaticPlotterWidgetController, SystemStateMonitorWidget, TCPMover, ThreadViewer, TopicReplayerWidgetController, Viewer3DWidget, ViewSelectionWidgetController, WidgetController, WriteToDebugObserverGuiPluginWidgetController, SceneEditorMainWindowController, GraphVisualizerWidget, PriorEditorController, WorkingMemoryController, ImageMonitorWidgetController, ImageRecorderWidgetController, UserAssistedSegmenterGuiWidgetController, and WidgetController.

◆ setInstanceName()

bool setInstanceName ( QString instanceName )

sets the name of this instance.

Can only be set once. Only the first call has an effect. Further calls are ignored.

Returns: True on first call, else false.

◆ setMainWindow()

void setMainWindow ( QMainWindow * mainWindow )

virtual

Reimplemented in Viewer3DWidget.

◆ setMutex3D()

void setMutex3D ( RecursiveMutexPtr const & mutex3D )

virtual

This mutex is used to protect 3d scene updates. Usually called by the ArmarXGui main window on creation of this controller.

Parameters

mutex3D

Reimplemented in KinematicUnitWidgetController, RobotViewerWidgetController, SimoxCSpaceVisualizerWidgetController, Viewer3DWidget, and WorkingMemoryController.

◆ setTipDialog()

void setTipDialog ( QPointer< TipDialog > tipDialog )

◆ showMessageBox()

int showMessageBox ( const QString & msg )

static

Member Data Documentation

◆ mutex3D

std::shared_ptr<std::recursive_mutex> mutex3D

protected

The documentation for this class was generated from the following files:

ArmarXGui/libraries/ArmarXGuiBase/ArmarXWidgetController.h
ArmarXGui/libraries/ArmarXGuiBase/ArmarXWidgetController.cpp

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

◆ RecursiveMutex

◆ RecursiveMutexLock

◆ RecursiveMutexLockPtr

◆ RecursiveMutexPtr

Constructor & Destructor Documentation

◆ ArmarXWidgetController()

◆ ~ArmarXWidgetController()

Member Function Documentation

◆ configAccepted [1/2]

◆ configAccepted [2/2]

◆ configRejected [1/2]

◆ configRejected [2/2]

◆ configured()

◆ createInstance()

◆ enableMainWidget

◆ enableMainWidgetAsync()

◆ getConfigDialog()

◆ getCustomTitlebarWidget()

◆ getInstanceName()

◆ getMainWindow()

◆ getScene()

◆ getSceneConfigDialog()

◆ getTipDialog()

◆ getWidget()

◆ GetWidgetCategoryIcon()

◆ getWidgetCategoryIcon()

◆ GetWidgetIcon()

◆ getWidgetIcon()

◆ getWidgetName()

◆ loadSettings()

◆ onClose()

◆ onLockWidget()

◆ onUnlockWidget()

◆ postDocking()

◆ saveSettings()

◆ setInstanceName()

◆ setMainWindow()

◆ setMutex3D()

◆ setTipDialog()

◆ showMessageBox()

Member Data Documentation

◆ mutex3D