Implementation of IWorkshop interface which provides access to Workshop services at module level. More...

Inheritance diagram for XGUI_ModuleConnector:

Signals
void	selectionChanged ()
	Signal selection changed. More...

void	propertyPanelActivated ()
	Signal which is emitted after activation of property panel. More...

Public Member Functions
	XGUI_ModuleConnector (XGUI_Workshop *theWorkshop)
	Constructor. More...

virtual ModuleBase_ISelection *	selection () const
	Returns list of currently selected data objects. More...

virtual ModuleBase_IModule *	module () const
	Returns instance of loaded module. More...

virtual ModuleBase_IViewer *	viewer () const
	Returns current viewer. More...

virtual ModuleBase_IPropertyPanel *	propertyPanel () const
	Returns property panel. More...

virtual ModuleBase_IErrorMgr *	errorMgr () const
	Returns error manager. More...

virtual ModuleBase_ISelectionActivate *	selectionActivate () const
	A selection activate in 3D View handler. More...

virtual ModuleBase_Operation *	currentOperation () const
	Returns currently active operation. More...

virtual bool	canStartOperation (QString theId, bool &isCommitted)
	Returns true if the operation with id theId can be started. More...

virtual void	processLaunchOperation (ModuleBase_Operation *theOperation)
	Performs the operation launch. More...

virtual ModuleBase_Operation *	findStartedOperation (const QString &theId)
	Returns started operation by the operation identifier. More...

virtual bool	canStopOperation (ModuleBase_Operation *theOperation)
	Returns true if the operation with id theId can be stopped. More...

virtual void	stopOperation (ModuleBase_Operation *theOperation, bool &isCommitted)
	Commits if possible or aborts the given operation. More...

virtual AISObjectPtr	findPresentation (const ObjectPtr &theObject) const
	Returns AIS object by data object. More...

virtual ObjectPtr	findPresentedObject (const AISObjectPtr &theAIS) const
	Returns data object by AIS. More...

virtual bool	isVisible (const ObjectPtr &theObject) const
	Returns true if the object is displayed. More...

virtual QObjectPtrList	displayedObjects () const
	Returns list of currently displayed objects. More...

virtual void	setSelected (const QList< std::shared_ptr< ModuleBase_ViewerPrs >> &theValues)
	Select features clearing previous selection. More...

virtual void	setStatusBarMessage (const QString &theMessage)
	Shows the message in the status bar. More...

virtual void	updateCommandStatus ()
	Update of commands status. More...

virtual std::shared_ptr< Config_FeatureMessage >	featureInfo (const QString &theId) const
	Returns Information about feature defined in corresponded XML. More...

virtual QMainWindow *	desktop () const
	Return application main window. More...

virtual bool	hasSHIFTPressed () const
	Returns true if SHIFT is pressed. More...

virtual void	deactivateCurrentSelector ()

virtual bool	enableUpdateViewer (bool isEnabled)
	Temporary enable or disable viewer update. More...

XGUI_Workshop *	workshop () const
	Returns workshop. More...

virtual void	applyCurrentSelectionModes (const AISObjectPtr &theAIS)
	The methods applies current defined selection modes to given AIS presentation. More...

virtual void	undo ()
	Undo last command. More...

virtual void	setCancelEnabled (bool toEnable)
	Set enabled state of cancel button in property panel. More...

virtual bool	isCancelEnabled () const
	Returns current state of cancel button. More...

virtual void	showHelpPage (const QString &thePage) const
	Show help of a current operation. More...

	HandlevvalidatorFilter ()
	A filter to process an attribute validators. More...

Protected Attributes
	HandlemmyValidatorFilter
	A filter to process an attribute validators. More...

Detailed Description

Implementation of IWorkshop interface which provides access to Workshop services at module level.

Constructor & Destructor Documentation

◆ XGUI_ModuleConnector()

XGUI_ModuleConnector::XGUI_ModuleConnector ( XGUI_Workshop * theWorkshop )

Constructor.

Parameters

theWorkshop a workshop

Member Function Documentation

◆ selection()

ModuleBase_ISelection * XGUI_ModuleConnector::selection ( ) const

virtual

Returns list of currently selected data objects.

Implements ModuleBase_IWorkshop.

◆ module()

ModuleBase_IModule * XGUI_ModuleConnector::module ( ) const

virtual

Returns instance of loaded module.

Implements ModuleBase_IWorkshop.

◆ viewer()

ModuleBase_IViewer * XGUI_ModuleConnector::viewer ( ) const

virtual

Returns current viewer.

Implements ModuleBase_IWorkshop.

◆ propertyPanel()

ModuleBase_IPropertyPanel * XGUI_ModuleConnector::propertyPanel ( ) const

virtual

Returns property panel.

Implements ModuleBase_IWorkshop.

◆ errorMgr()

ModuleBase_IErrorMgr * XGUI_ModuleConnector::errorMgr ( ) const

virtual

Returns error manager.

Implements ModuleBase_IWorkshop.

◆ selectionActivate()

ModuleBase_ISelectionActivate * XGUI_ModuleConnector::selectionActivate ( ) const

virtual

A selection activate in 3D View handler.

Implements ModuleBase_IWorkshop.

◆ currentOperation()

ModuleBase_Operation * XGUI_ModuleConnector::currentOperation ( ) const

virtual

Returns currently active operation.

Implements ModuleBase_IWorkshop.

◆ canStartOperation()

bool XGUI_ModuleConnector::canStartOperation	(	QString	theId,
		bool &	isCommitted
	)

virtual

Returns true if the operation with id theId can be started.

Parameters

theId	id of the operation which is going to start
isCommitted	boolean value if the operation was committed otherwise it was aborted

Implements ModuleBase_IWorkshop.

◆ processLaunchOperation()

void XGUI_ModuleConnector::processLaunchOperation ( ModuleBase_Operation * theOperation )

virtual

Performs the operation launch.

Parameters

theOperation an operation to be launched

Implements ModuleBase_IWorkshop.

◆ findStartedOperation()

ModuleBase_Operation * XGUI_ModuleConnector::findStartedOperation ( const QString & theId )

virtual

Returns started operation by the operation identifier.

The operation manager is called.

Parameters

theId an operation id

Returns: an operation instance or NULL

Implements ModuleBase_IWorkshop.

◆ canStopOperation()

bool XGUI_ModuleConnector::canStopOperation ( ModuleBase_Operation * theOperation )

virtual

Returns true if the operation with id theId can be stopped.

The operation manager is called.

Parameters

theOperation a stopped operation

Returns: boolean result

Implements ModuleBase_IWorkshop.

◆ stopOperation()

void XGUI_ModuleConnector::stopOperation	(	ModuleBase_Operation *	theOperation,
		bool &	isCommitted
	)

virtual

Commits if possible or aborts the given operation.

Parameters

theOperation	an aborted operation
isCommitted	boolean value if the operation was committed otherwise it was aborted

Implements ModuleBase_IWorkshop.

◆ findPresentation()

AISObjectPtr XGUI_ModuleConnector::findPresentation ( const ObjectPtr & theObject ) const

virtual

Returns AIS object by data object.

Implements ModuleBase_IWorkshop.

◆ findPresentedObject()

ObjectPtr XGUI_ModuleConnector::findPresentedObject ( const AISObjectPtr & theAIS ) const

virtual

Returns data object by AIS.

Implements ModuleBase_IWorkshop.

◆ isVisible()

bool XGUI_ModuleConnector::isVisible ( const ObjectPtr & theObject ) const

virtual

Returns true if the object is displayed.

Parameters

theObject a data object

Implements ModuleBase_IWorkshop.

◆ displayedObjects()

QObjectPtrList XGUI_ModuleConnector::displayedObjects ( ) const

virtual

Returns list of currently displayed objects.

Implements ModuleBase_IWorkshop.

◆ setSelected()

void XGUI_ModuleConnector::setSelected ( const QList< std::shared_ptr< ModuleBase_ViewerPrs >> & theValues )

virtual

Select features clearing previous selection.

If the list is empty then selection will be cleared

Implements ModuleBase_IWorkshop.

◆ setStatusBarMessage()

void XGUI_ModuleConnector::setStatusBarMessage ( const QString & theMessage )

virtual

Shows the message in the status bar.

Parameters

theMessage a message

Implements ModuleBase_IWorkshop.

◆ updateCommandStatus()

void XGUI_ModuleConnector::updateCommandStatus ( )

virtual

Update of commands status.

Implements ModuleBase_IWorkshop.

◆ featureInfo()

std::shared_ptr< Config_FeatureMessage > XGUI_ModuleConnector::featureInfo ( const QString & theId ) const

virtual

Returns Information about feature defined in corresponded XML.

Parameters

theId - id of the feature

Implements ModuleBase_IWorkshop.

◆ desktop()

QMainWindow * XGUI_ModuleConnector::desktop ( ) const

virtual

Return application main window.

Implements ModuleBase_IWorkshop.

◆ hasSHIFTPressed()

bool XGUI_ModuleConnector::hasSHIFTPressed ( ) const

virtual

Returns true if SHIFT is pressed.

Returns: boolean value

Implements ModuleBase_IWorkshop.

◆ enableUpdateViewer()

bool XGUI_ModuleConnector::enableUpdateViewer ( bool isEnabled )

virtual

Temporary enable or disable viewer update.

Returns previous state of updating

Parameters

isEnabled new state of the viewer update

Implements ModuleBase_IWorkshop.

◆ workshop()

XGUI_Workshop* XGUI_ModuleConnector::workshop ( ) const

inline

Returns workshop.

◆ applyCurrentSelectionModes()

void XGUI_ModuleConnector::applyCurrentSelectionModes ( const AISObjectPtr & theAIS )

virtual

The methods applies current defined selection modes to given AIS presentation.

The AIS presentation has to be already displayed. After activation viewer has to be updated

Parameters

theAIS the object which has to be activated

Implements ModuleBase_IWorkshop.

◆ undo()

void XGUI_ModuleConnector::undo ( )

virtual

Undo last command.

Implements ModuleBase_IWorkshop.

◆ setCancelEnabled()

void XGUI_ModuleConnector::setCancelEnabled ( bool toEnable )

virtual

Set enabled state of cancel button in property panel.

Implements ModuleBase_IWorkshop.

◆ isCancelEnabled()

bool XGUI_ModuleConnector::isCancelEnabled ( ) const

virtual

Returns current state of cancel button.

Implements ModuleBase_IWorkshop.

◆ showHelpPage()

void XGUI_ModuleConnector::showHelpPage ( const QString & thePage ) const

virtual

Show help of a current operation.

Implements ModuleBase_IWorkshop.

◆ HandlevvalidatorFilter()

ModuleBase_IWorkshop::HandlevvalidatorFilter ( )

inherited

A filter to process an attribute validators.

Returns: a filter

◆ selectionChanged

void ModuleBase_IWorkshop::selectionChanged ( )

signalinherited

Signal selection changed.

◆ propertyPanelActivated

void ModuleBase_IWorkshop::propertyPanelActivated ( )

signalinherited

Signal which is emitted after activation of property panel.

Field Documentation

◆ HandlemmyValidatorFilter

ModuleBase_IWorkshop::HandlemmyValidatorFilter

protectedinherited

A filter to process an attribute validators.

Signals

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ XGUI_ModuleConnector()

Member Function Documentation

◆ selection()

◆ module()

◆ viewer()

◆ propertyPanel()

◆ errorMgr()

◆ selectionActivate()

◆ currentOperation()

◆ canStartOperation()

◆ processLaunchOperation()

◆ findStartedOperation()

◆ canStopOperation()

◆ stopOperation()

◆ findPresentation()

◆ findPresentedObject()

◆ isVisible()

◆ displayedObjects()

◆ setSelected()

◆ setStatusBarMessage()

◆ updateCommandStatus()

◆ featureInfo()

◆ desktop()

◆ hasSHIFTPressed()

◆ enableUpdateViewer()

◆ workshop()

◆ applyCurrentSelectionModes()

◆ undo()

◆ setCancelEnabled()

◆ isCancelEnabled()

◆ showHelpPage()

◆ HandlevvalidatorFilter()

◆ selectionChanged

◆ propertyPanelActivated

Field Documentation

◆ HandlemmyValidatorFilter