1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
\r
3 #ifndef ModuleBase_IModule_H
\r
4 #define ModuleBase_IModule_H
\r
6 #include "ModuleBase.h"
\r
7 #include "ModuleBase_IWorkshop.h"
\r
9 #include <ModelAPI_Feature.h>
\r
10 #include <ModelAPI_Attribute.h>
\r
12 #include <GeomAPI_Shape.h>
\r
13 #include <GeomAPI_ICustomPrs.h>
\r
28 class Config_WidgetAPI;
\r
29 class ModuleBase_ModelWidget;
\r
30 class ModuleBase_Operation;
\r
31 class ModuleBase_IWorkshop;
\r
32 class ModelAPI_Result;
\r
34 class Handle_AIS_InteractiveObject;
\r
38 * Interface to a module
\r
40 class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
\r
44 /// enumeration to know which objects should be customized
\r
45 enum ModuleBase_CustomizeFlag {
\r
46 CustomizeArguments = 0, /// references of other objects referenced to the current feature
\r
47 CustomizeResults, /// results of the current feature
\r
48 CustomizeHighlightedObjects /// highlighted objects of the active widget
\r
52 /// \param theParent instance of workshop interface
\r
53 ModuleBase_IModule(ModuleBase_IWorkshop* theParent);
\r
55 virtual ~ModuleBase_IModule() {}
\r
57 /// Add default selection filters of the module to the current viewer
\r
58 virtual void activateSelectionFilters() {};
\r
60 /// Remove default selection filters of the module from the current viewer
\r
61 virtual void deactivateSelectionFilters() {};
\r
63 // Stores the current selection
\r
64 virtual void storeSelection() {};
\r
66 // Restores the current selection
\r
67 virtual void restoreSelection() {};
\r
69 /// Reads description of features from XML file
\r
70 virtual void createFeatures();
\r
72 /// Called on creation of menu item in desktop
\r
73 virtual void actionCreated(QAction*);
\r
75 /// Launching of a edit operation on the feature
\r
76 /// \param theFeature feature for editing
\r
77 virtual void editFeature(FeaturePtr theFeature);
\r
79 /// Returns true if the operation can be committed. Result in default implementation is true.
\r
80 /// \return boolean value
\r
81 virtual bool canCommitOperation() const { return true; }
\r
83 /// Creates an operation and send it to loop
\r
84 /// \param theCmdId the operation name
\r
85 virtual void launchOperation(const QString& theCmdId);
\r
87 /// Realizes some functionality by an operation start
\r
88 /// \param theOperation a started operation
\r
89 virtual void operationStarted(ModuleBase_Operation* theOperation) {}
\r
91 /// Realizes some functionality by an operation resume
\r
92 /// By default it emits operationResumed signal
\r
93 /// \param theOperation a resumed operation
\r
94 virtual void operationResumed(ModuleBase_Operation* theOperation);
\r
96 /// Realizes some functionality by an operation stop
\r
97 virtual void operationStopped(ModuleBase_Operation* theOperation) {}
\r
99 /// Realizes some functionality by an operation commit
\r
100 virtual void operationCommitted(ModuleBase_Operation* theOperation) {}
\r
102 /// Realizes some functionality by an operation abort
\r
103 virtual void operationAborted(ModuleBase_Operation* theOperation) {}
\r
105 /// Realizes some functionality by an operation start
\r
106 virtual ModuleBase_Operation* currentOperation() const = 0;
\r
108 /// Add menu items for viewer into the given menu
\r
109 /// \param theMenu a popup menu to be shown in the viewer
\r
110 /// \param theStdActions a map of standard actions
\r
111 /// \return true if items are added and there is no necessity to provide standard menu
\r
112 virtual bool addViewerMenu(QMenu* theMenu, const QMap<QString, QAction*>& theStdActions) const
\r
115 /// Add menu items for object browser into the given menu
\r
116 /// \param theMenu a popup menu to be shown in the object browser
\r
117 virtual void addObjectBrowserMenu(QMenu* theMenu) const {};
\r
119 /// Creates custom widgets for property panel
\r
120 /// \param theType a type of widget
\r
121 /// \param theParent the parent object
\r
122 /// \param theWidgetApi the widget configuration. The attribute of the model widget is obtained from
\r
123 virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,
\r
124 Config_WidgetAPI* theWidgetApi)
\r
129 /// Returns the active widget, by default it is the property panel active widget
\r
130 virtual ModuleBase_ModelWidget* activeWidget() const = 0;
\r
132 /// Returns current workshop
\r
133 ModuleBase_IWorkshop* workshop() const { return myWorkshop; }
\r
135 /// Call back forlast tuning of property panel before operation performance
\r
136 /// It is called as on clearing of property panel as on filling with new widgets
\r
137 virtual void propertyPanelDefined(ModuleBase_Operation* theOperation) {}
\r
139 /// Have an opportunity to create widgets for the current operation instead of standard creation in workshop
\r
140 /// \param theOperation a started operation
\r
141 /// \param theWidgets a list of created widgets
\r
142 /// \return boolean result, false by default
\r
143 virtual bool createWidgets(ModuleBase_Operation* theOperation,
\r
144 QList<ModuleBase_ModelWidget*>& theWidgets) const { return false; }
\r
146 //! Returns True if there are available Undos and there is not an active operation
\r
147 virtual bool canUndo() const;
\r
149 //! Returns True if there are available Redos and there is not an active operation
\r
150 virtual bool canRedo() const;
\r
152 /// Returns true if the action can be applyed to the object
\r
153 /// \param theObject a checked object
\r
154 /// \param theActionId an identifier of action, to be found in the menu manager like "DELETE_CMD"
\r
155 /// \return the a boolean result
\r
156 virtual bool canApplyAction(const ObjectPtr& theObject, const QString& theActionId) const = 0;
\r
158 /// Returns True if the current operation can be committed. By default it is true.
\r
159 /// \return a boolean value
\r
160 //virtual bool canCommitOperation() const;
\r
162 /// Returns whether the object can be erased. The default realization returns true.
\r
163 /// \param theObject a model object
\r
164 virtual bool canEraseObject(const ObjectPtr& theObject) const;
\r
166 /// Returns whether the object can be displayed. The default realization returns true.
\r
167 /// \param theObject a model object
\r
168 virtual bool canDisplayObject(const ObjectPtr& theObject) const;
\r
170 /// Make some functionality after the objects are hidden in viewer
\r
171 /// \param theObjects a list of hidden objects
\r
172 virtual void processHiddenObject(const std::list<ObjectPtr>& theObjects) {};
\r
174 /// Returns true if selection for the object can be activate.
\r
175 /// By default a result or feature of the current operation can not be activated
\r
176 /// \param theObject a model object
\r
177 virtual bool canActivateSelection(const ObjectPtr& theObject) const;
\r
179 /// Reacts to the delete action in module
\r
180 /// \returns true if the action is processed
\r
181 virtual bool deleteObjects() { return false; };
\r
183 /// Performs functionality on closing document
\r
184 virtual void closeDocument() = 0;
\r
186 /// Clears specific presentations in the viewer
\r
187 virtual void clearViewer() = 0;
\r
189 /// Returns a list of modes, where the AIS objects should be activated
\r
190 /// \param theModes a list of modes
\r
191 virtual void activeSelectionModes(QIntList& theModes) {}
\r
193 /// Activate custom presentation for the object. Default realization is empty.
\r
194 /// \param theObject an object instance
\r
195 /// \param theFlag a flag of level of customization, which means that only part of sub-elements
\r
196 /// \param theUpdateViewer the parameter whether the viewer should be update immediately
\r
197 virtual void activateCustomPrs(const FeaturePtr& theFeature,
\r
198 const ModuleBase_CustomizeFlag& theFlag,
\r
199 const bool theUpdateViewer) {}
\r
201 /// Deactivate custom presentation for the object. Default realization is empty.
\r
202 /// \param theFlag a flag of level of customization, which means that only part of sub-elements
\r
203 /// \param theUpdateViewer the parameter whether the viewer should be update immediately
\r
204 virtual void deactivateCustomPrs(const ModuleBase_CustomizeFlag& theFlag,
\r
205 const bool theUpdateViewer) {}
\r
207 /// Modifies the given presentation in the custom way.
\r
208 virtual bool customisePresentation(std::shared_ptr<ModelAPI_Result> theResult, AISObjectPtr thePrs,
\r
209 GeomCustomPrsPtr theCustomPrs) { return false; };
\r
211 /// Update the object presentable properties such as color, lines width and other
\r
212 /// If the object is result with the color attribute value set, it is used,
\r
213 /// otherwise the customize is applyed to the object's feature if it is a custom prs
\r
214 /// \param theObject an object instance
\r
215 /// \param theFlag a flag of level of customization, which means that only part of sub-elements
\r
216 /// should be updated(e.g. only highlighted elements)
\r
217 /// \param theUpdateViewer the parameter whether the viewer should be update immediately
\r
218 /// \returns true if the object is modified
\r
219 virtual bool customizeObject(ObjectPtr theObject, const ModuleBase_CustomizeFlag& theFlag,
\r
220 const bool theUpdateViewer);
\r
222 /// This method is called on object browser creation for customization of module specific features
\r
223 /// \param theObjectBrowser a pinter on Object Browser widget
\r
224 virtual void customizeObjectBrowser(QWidget* theObjectBrowser) {}
\r
226 /// Creates a new operation
\r
227 /// \param theCmdId the operation name
\r
228 virtual ModuleBase_Operation* createOperation(const std::string& theCmdId);
\r
230 /// Sends the operation for launching
\r
231 /// \param theOperation the operation
\r
232 virtual void sendOperation(ModuleBase_Operation* theOperation);
\r
234 /// Create specific for the module presentation
\r
235 /// \param theResult an object for presentation
\r
236 /// \return created presentation or NULL(default value)
\r
237 virtual Handle_AIS_InteractiveObject createPresentation(
\r
238 const std::shared_ptr<ModelAPI_Result>& theResult);
\r
240 //! Returns data object by AIS
\r
241 virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const = 0;
\r
243 //! Returns true if the presentation can be shown in shading mode
\r
244 //! \param theAIS presentation to be checked
\r
245 //! \return boolean value
\r
246 virtual bool canBeShaded(Handle(AIS_InteractiveObject) theAIS) const;
\r
248 /// Update state of pop-up menu items in object browser
\r
249 /// \param theStdActions - a map of standard actions
\r
250 virtual void updateObjectBrowserMenu(const QMap<QString, QAction*>& theStdActions) {}
\r
252 /// Update state of pop-up menu items in viewer
\r
253 /// \param theStdActions - a map of standard actions
\r
254 virtual void updateViewerMenu(const QMap<QString, QAction*>& theStdActions) {}
\r
256 //! Returns the feature error if the current state of the feature in the module is not correct
\r
257 //! If the feature is correct, it returns an empty value
\r
258 //! \return string value
\r
259 virtual QString getFeatureError(const FeaturePtr& theFeature);
\r
261 /// Returns list of granted operation indices
\r
262 virtual void grantedOperationIds(ModuleBase_Operation* theOperation, QStringList& theIds) const;
\r
264 /// Connects or disconnects to the value changed signal of the property panel widgets
\r
265 /// \param theWidget a property contol widget
\r
266 /// \param isToConnect a boolean value whether connect or disconnect
\r
267 virtual void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect) {};
\r
269 /// Validates the operation to change the "Apply" button state.
\r
270 /// \param thePreviousState the previous state of the widget
\r
271 virtual void widgetStateChanged(int thePreviousState) {};
\r
273 /// Returns true if the event is processed.
\r
274 /// \param thePreviousAttributeID an index of the previous active attribute
\r
275 virtual bool processEnter(const std::string& thePreviousAttributeID) { return false; };
\r
277 /// Performs some GUI actions after an operation transaction is opened
\r
278 /// Default realization is empty
\r
279 virtual void beforeOperationStarted(ModuleBase_Operation* theOperation) {};
\r
281 /// Performs some GUI actions before an operation transaction is stopped
\r
282 /// Default realization is empty
\r
283 virtual void beforeOperationStopped(ModuleBase_Operation* theOperation) {};
\r
285 /// Finds a shape by attribute if it is possible
\r
286 /// \param theAttribute an attribute
\r
287 /// \return a geom shape
\r
288 virtual GeomShapePtr findShape(const AttributePtr& theAttribute) = 0;
\r
290 /// Finds an attribute by geom shape if it is possible
\r
291 /// \param theObject an object of the attribute
\r
292 /// \param theGeomShape a geom shape
\r
293 /// \return theAttribute
\r
294 virtual AttributePtr findAttribute(const ObjectPtr& theObject,
\r
295 const GeomShapePtr& theGeomShape) = 0;
\r
297 /// Returns XML information by the feature index
\r
298 /// \param theFeatureId a feature id
\r
299 /// \param theXmlCfg XML configuration
\r
300 /// \param theDescription feature description
\r
301 void getXMLRepresentation(const std::string& theFeatureId, std::string& theXmlCfg,
\r
302 std::string& theDescription);
\r
305 /// Signal which is emitted when operation is launched
\r
306 void operationLaunched();
\r
308 /// Segnal emitted when an operation is resumed
\r
309 /// \param theOp a resumed operation
\r
310 void resumed(ModuleBase_Operation* theOp);
\r
313 /// Called on call of command corresponded to a feature
\r
314 virtual void onFeatureTriggered();
\r
316 /// Slot called on object display
\r
317 /// \param theObject a data object
\r
318 /// \param theAIS a presentation object
\r
319 virtual void onObjectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS) {}
\r
321 /// Slot called on before object erase
\r
322 /// \param theObject a data object
\r
323 /// \param theAIS a presentation object
\r
324 virtual void onBeforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS) {}
\r
327 /// Called on selection changed event
\r
328 virtual void onSelectionChanged() {}
\r
331 /// Register validators for this module
\r
332 virtual void registerValidators() {}
\r
334 /// Register selection filters for this module
\r
335 virtual void registerFilters() {}
\r
337 /// Register properties of this module
\r
338 virtual void registerProperties() {}
\r
340 /// Returns new instance of operation object (used in createOperation for customization)
\r
341 virtual ModuleBase_Operation* getNewOperation(const std::string& theFeatureId);
\r
344 /// Reference to workshop
\r
345 ModuleBase_IWorkshop* myWorkshop;
\r
347 /// Map of features in XML
\r
348 std::map<std::string, std::string> myFeaturesInFiles;
\r
353 //! This function must return a new module instance.
\r
355 typedef ModuleBase_IModule* (*CREATE_FUNC)(ModuleBase_IWorkshop*);
\r
358 #define CREATE_MODULE "createModule"
\r
360 #endif //ModuleBase_IModule
\r