1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef ModuleBase_IWorkshop_H
21 #define ModuleBase_IWorkshop_H
23 #include "ModuleBase.h"
24 #include "ModuleBase_Definitions.h"
25 #include <ModuleBase_FilterValidated.h>
27 #include <ModelAPI_Object.h>
28 #include <GeomAPI_AISObject.h>
29 #include <Config_FeatureMessage.h>
33 class ModuleBase_IModule;
34 class ModuleBase_ISelection;
35 class ModuleBase_IViewer;
36 class ModuleBase_IPropertyPanel;
37 class ModuleBase_IErrorMgr;
38 class ModuleBase_Operation;
39 class ModuleBase_ISelectionActivate;
40 class ModuleBase_ViewerPrs;
45 * Class which provides access to Workshop object services
47 class MODULEBASE_EXPORT ModuleBase_IWorkshop : public QObject
52 /// \param theParent parent object
53 ModuleBase_IWorkshop(QObject* theParent);
55 virtual ~ModuleBase_IWorkshop()
58 /// Return current selection instance
59 virtual ModuleBase_ISelection* selection() const = 0;
61 //! Returns instance of loaded module
62 virtual ModuleBase_IModule* module() const = 0;
64 //! Returns current viewer
65 virtual ModuleBase_IViewer* viewer() const = 0;
67 //! Returns property panel
68 virtual ModuleBase_IPropertyPanel* propertyPanel() const = 0;
70 //! Returns error manager
71 virtual ModuleBase_IErrorMgr* errorMgr() const = 0;
73 /// A filter to process an attribute validators
75 Handle(ModuleBase_FilterValidated) validatorFilter();
77 /// A selection activate in 3D View handler
78 virtual ModuleBase_ISelectionActivate* selectionActivate() const = 0;
80 //! Returns currently active operation
81 virtual ModuleBase_Operation* currentOperation() const = 0;
83 //! Returns true if the operation with id theId can be started
84 virtual bool canStartOperation(QString theId, bool& isCommitted) = 0;
86 //! Performs the operation launch
87 //! \param theOperation an operation to be launched
88 virtual void processLaunchOperation(ModuleBase_Operation* theOperation) = 0;
90 //! Returns started operation by the operation identifier
91 //! \param theId an operation id
92 //! \return an operation instance or NULL
93 virtual ModuleBase_Operation* findStartedOperation(const QString& theId) = 0;
95 //! Returns true if the operation with id theId can be stopped
96 //! \param theOperation a stopped operation
97 //! \return boolean result
98 virtual bool canStopOperation(ModuleBase_Operation* theOperation) = 0;
100 //! Commits if possible or aborts the given operation.
101 //! \param theOperation an aborted operation
102 /// \param isCommitted boolean value if the operation was committed otherwise it was aborted
103 virtual void stopOperation(ModuleBase_Operation* theOperation,
104 bool& isCommitted) = 0;
106 //! Returns AIS object by data object
107 //! \param theObject a data object
108 virtual AISObjectPtr findPresentation(const ObjectPtr& theObject) const = 0;
110 //! Returns data object by AIS
111 //! \param theAIS a presentation
112 virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const = 0;
114 //! Returns true if the object is displayed
115 //! \param theObject a data object
116 virtual bool isVisible(const ObjectPtr& theObject) const = 0;
118 //! Select features clearing previous selection.
119 //! If the list is empty then selection will be cleared
120 //! \param theValues a list of presentations
121 virtual void setSelected(const QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues) = 0;
123 //! Shows the message in the status bar
124 //! \param theMessage a message
125 virtual void setStatusBarMessage(const QString& theMessage) = 0;
127 /// Update of commands status
128 virtual void updateCommandStatus() = 0;
130 /// Returns feature info according to given feature ID
131 /// \param theId a feature Id
132 virtual std::shared_ptr<Config_FeatureMessage> featureInfo(const QString& theId) const = 0;
134 /// Returns main window of the application
135 virtual QMainWindow* desktop() const = 0;
137 /// Returns true if SHIFT is pressed
138 /// \return boolean value
139 virtual bool hasSHIFTPressed() const = 0;
141 virtual void deactivateCurrentSelector() = 0;
144 /// Signal selection changed.
145 void selectionChanged();
147 /// Signal which is emited after activation of property panel
148 void propertyPanelActivated();
151 /// A filter to process an attribute validators
152 Handle(ModuleBase_FilterValidated) myValidatorFilter;