Class which provides access to Workshop object services. More...

Inheritance diagram for ModuleBase_IWorkshop:

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

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

Public Member Functions
	ModuleBase_IWorkshop (QObject *theParent)
	Constructor. More...

virtual ModuleBase_ISelection *	selection () const =0
	Return current selection instance. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual std::shared_ptr< Config_FeatureMessage >	featureInfo (const QString &theId) const =0
	Returns feature info according to given feature ID. More...

virtual QMainWindow *	desktop () const =0
	Returns main window of the application. More...

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

virtual void	deactivateCurrentSelector ()=0

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

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

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

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

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

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

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

Detailed Description

Class which provides access to Workshop object services.

Constructor & Destructor Documentation

◆ ModuleBase_IWorkshop()

ModuleBase_IWorkshop::ModuleBase_IWorkshop ( QObject * theParent )

Constructor.

Parameters

theParent parent object

Member Function Documentation

◆ selection()

virtual ModuleBase_ISelection* ModuleBase_IWorkshop::selection ( ) const

pure virtual

Return current selection instance.

Implemented in XGUI_ModuleConnector.

◆ module()

virtual ModuleBase_IModule* ModuleBase_IWorkshop::module ( ) const

pure virtual

Returns instance of loaded module.

Implemented in XGUI_ModuleConnector.

◆ viewer()

virtual ModuleBase_IViewer* ModuleBase_IWorkshop::viewer ( ) const

pure virtual

Returns current viewer.

Implemented in XGUI_ModuleConnector.

◆ propertyPanel()

virtual ModuleBase_IPropertyPanel* ModuleBase_IWorkshop::propertyPanel ( ) const

pure virtual

Returns property panel.

Implemented in XGUI_ModuleConnector.

◆ errorMgr()

virtual ModuleBase_IErrorMgr* ModuleBase_IWorkshop::errorMgr ( ) const

pure virtual

Returns error manager.

Implemented in XGUI_ModuleConnector.

◆ HandlevvalidatorFilter()

ModuleBase_IWorkshop::HandlevvalidatorFilter ( )

A filter to process an attribute validators.

Returns: a filter

◆ selectionActivate()

virtual ModuleBase_ISelectionActivate* ModuleBase_IWorkshop::selectionActivate ( ) const

pure virtual

A selection activate in 3D View handler.

Implemented in XGUI_ModuleConnector.

◆ currentOperation()

virtual ModuleBase_Operation* ModuleBase_IWorkshop::currentOperation ( ) const

pure virtual

Returns currently active operation.

Implemented in XGUI_ModuleConnector.

◆ canStartOperation()

virtual bool ModuleBase_IWorkshop::canStartOperation	(	QString	theId,
		bool &	isCommitted
	)

pure virtual

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

Implemented in XGUI_ModuleConnector.

◆ processLaunchOperation()

virtual void ModuleBase_IWorkshop::processLaunchOperation ( ModuleBase_Operation * theOperation )

pure virtual

Performs the operation launch.

Parameters

theOperation an operation to be launched

Implemented in XGUI_ModuleConnector.

◆ findStartedOperation()

virtual ModuleBase_Operation* ModuleBase_IWorkshop::findStartedOperation ( const QString & theId )

pure virtual

Returns started operation by the operation identifier.

Parameters

theId an operation id

Returns: an operation instance or NULL

Implemented in XGUI_ModuleConnector.

◆ canStopOperation()

virtual bool ModuleBase_IWorkshop::canStopOperation ( ModuleBase_Operation * theOperation )

pure virtual

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

Parameters

theOperation a stopped operation

Returns: boolean result

Implemented in XGUI_ModuleConnector.

◆ stopOperation()

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

pure 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

Implemented in XGUI_ModuleConnector.

◆ findPresentation()

virtual AISObjectPtr ModuleBase_IWorkshop::findPresentation ( const ObjectPtr & theObject ) const

pure virtual

Returns AIS object by data object.

Parameters

theObject a data object

Implemented in XGUI_ModuleConnector.

◆ findPresentedObject()

virtual ObjectPtr ModuleBase_IWorkshop::findPresentedObject ( const AISObjectPtr & theAIS ) const

pure virtual

Returns data object by AIS.

Parameters

theAIS a presentation

Implemented in XGUI_ModuleConnector.

◆ isVisible()

virtual bool ModuleBase_IWorkshop::isVisible ( const ObjectPtr & theObject ) const

pure virtual

Returns true if the object is displayed.

Parameters

theObject a data object

Implemented in XGUI_ModuleConnector.

◆ displayedObjects()

virtual QObjectPtrList ModuleBase_IWorkshop::displayedObjects ( ) const

pure virtual

Returns list of currently displayed objects.

Implemented in XGUI_ModuleConnector.

◆ setSelected()

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

pure virtual

Select features clearing previous selection.

If the list is empty then selection will be cleared

Parameters

theValues a list of presentations

Implemented in XGUI_ModuleConnector.

◆ setStatusBarMessage()

virtual void ModuleBase_IWorkshop::setStatusBarMessage ( const QString & theMessage )

pure virtual

Shows the message in the status bar.

Parameters

theMessage a message

Implemented in XGUI_ModuleConnector.

◆ updateCommandStatus()

virtual void ModuleBase_IWorkshop::updateCommandStatus ( )

pure virtual

Update of commands status.

Implemented in XGUI_ModuleConnector.

◆ featureInfo()

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

pure virtual

Returns feature info according to given feature ID.

Parameters

theId a feature Id

Implemented in XGUI_ModuleConnector.

◆ desktop()

virtual QMainWindow* ModuleBase_IWorkshop::desktop ( ) const

pure virtual

Returns main window of the application.

Implemented in XGUI_ModuleConnector.

◆ hasSHIFTPressed()

virtual bool ModuleBase_IWorkshop::hasSHIFTPressed ( ) const

pure virtual

Returns true if SHIFT is pressed.

Returns: boolean value

Implemented in XGUI_ModuleConnector.

◆ enableUpdateViewer()

virtual bool ModuleBase_IWorkshop::enableUpdateViewer ( bool isEnabled )

pure virtual

Temporary enable or disable viewer update.

Returns previous state of updating

Parameters

isEnabled new state of the viewer update

Implemented in XGUI_ModuleConnector.

◆ applyCurrentSelectionModes()

virtual void ModuleBase_IWorkshop::applyCurrentSelectionModes ( const AISObjectPtr & theAIS )

pure 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

Implemented in XGUI_ModuleConnector.

◆ undo()

virtual void ModuleBase_IWorkshop::undo ( )

pure virtual

Undo last command.

Implemented in XGUI_ModuleConnector.

◆ setCancelEnabled()

virtual void ModuleBase_IWorkshop::setCancelEnabled ( bool toEnable )

pure virtual

Set enabled state of cancel button in property panel.

Implemented in XGUI_ModuleConnector.

◆ isCancelEnabled()

virtual bool ModuleBase_IWorkshop::isCancelEnabled ( ) const

pure virtual

Returns current state of cancel button.

Implemented in XGUI_ModuleConnector.

◆ showHelpPage()

virtual void ModuleBase_IWorkshop::showHelpPage ( const QString & thePage ) const

pure virtual

Show help of a current operation.

Implemented in XGUI_ModuleConnector.

◆ selectionChanged

void ModuleBase_IWorkshop::selectionChanged ( )

signal

Signal selection changed.

◆ propertyPanelActivated

void ModuleBase_IWorkshop::propertyPanelActivated ( )

signal

Signal which is emitted after activation of property panel.

Field Documentation

◆ HandlemmyValidatorFilter

ModuleBase_IWorkshop::HandlemmyValidatorFilter

protected

A filter to process an attribute validators.

Signals

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ModuleBase_IWorkshop()

Member Function Documentation

◆ selection()

◆ module()

◆ viewer()

◆ propertyPanel()

◆ errorMgr()

◆ HandlevvalidatorFilter()

◆ selectionActivate()

◆ currentOperation()

◆ canStartOperation()

◆ processLaunchOperation()

◆ findStartedOperation()

◆ canStopOperation()

◆ stopOperation()

◆ findPresentation()

◆ findPresentedObject()

◆ isVisible()

◆ displayedObjects()

◆ setSelected()

◆ setStatusBarMessage()

◆ updateCommandStatus()

◆ featureInfo()

◆ desktop()

◆ hasSHIFTPressed()

◆ enableUpdateViewer()

◆ applyCurrentSelectionModes()

◆ undo()

◆ setCancelEnabled()

◆ isCancelEnabled()

◆ showHelpPage()

◆ selectionChanged

◆ propertyPanelActivated

Field Documentation

◆ HandlemmyValidatorFilter