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_IModule_H
21 #define ModuleBase_IModule_H
23 #include "ModuleBase.h"
24 #include "ModuleBase_IWorkshop.h"
25 #include <ModuleBase_SelectionFilterType.h>
27 #include <ModelAPI_Feature.h>
28 #include <ModelAPI_Attribute.h>
30 #include <GeomAPI_Shape.h>
31 #include <GeomAPI_ICustomPrs.h>
33 #include <SelectMgr_ListOfFilter.hxx>
48 class Config_WidgetAPI;
50 class ModuleBase_ModelWidget;
51 class ModuleBase_Operation;
52 class ModuleBase_ViewerPrs;
53 class ModuleBase_ITreeNode;
54 class ModuleBase_IWorkshop;
56 class ModelAPI_Result;
59 class AIS_InteractiveObject;
63 * Interface to a module
65 class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
69 /// enumeration to know which objects should be customized
70 enum ModuleBase_CustomizeFlag {
71 CustomizeArguments = 0, /// references of other objects referenced to the current feature
72 CustomizeResults, /// results of the current feature
73 CustomizeHighlightedObjects /// highlighted objects of the active widget
77 /// \param theParent instance of workshop interface
78 ModuleBase_IModule(ModuleBase_IWorkshop* theParent);
80 virtual ~ModuleBase_IModule();
82 /// Stores the current selection
83 virtual void storeSelection() {}
85 /// Restores the current selection
86 virtual void restoreSelection() {}
88 /// Reads description of features from XML file
89 virtual void createFeatures();
91 /// Called on creation of menu item in desktop
92 virtual void actionCreated(QAction*);
94 /// Launching of a edit operation on the feature
95 /// \param theFeature feature for editing
96 virtual void editFeature(FeaturePtr theFeature);
98 /// Returns true if the operation can be committed. Result in default implementation is true.
99 /// \return boolean value
100 virtual bool canCommitOperation() const { return true; }
102 /// Creates an operation and send it to loop
103 /// \param theCmdId the operation name
104 /// \param isStartAfterCommitOnly operation is launched if there is no active operation or
106 virtual void launchOperation(const QString& theCmdId,
107 const bool& isStartAfterCommitOnly);
109 /// Executes feature as a modal dialog box
110 /// \param theCmdId the operation name
111 virtual void launchModal(const QString& theCmdId);
113 /// Realizes some functionality by an operation start
114 /// \param theOperation a started operation
115 virtual void operationStarted(ModuleBase_Operation* theOperation) {}
117 /// Realizes some functionality by an operation resume
118 /// By default it emits operationResumed signal
119 /// \param theOperation a resumed operation
120 virtual void operationResumed(ModuleBase_Operation* theOperation);
122 /// Realizes some functionality by an operation stop
123 virtual void operationStopped(ModuleBase_Operation* theOperation) {}
125 /// Realizes some functionality by an operation commit
126 virtual void operationCommitted(ModuleBase_Operation* theOperation) {}
128 /// Realizes some functionality by an operation abort
129 virtual void operationAborted(ModuleBase_Operation* theOperation) {}
131 /// Realizes some functionality by an operation start
132 virtual ModuleBase_Operation* currentOperation() const = 0;
134 /// Add menu items for viewer into the actions map
135 /// \param theStdActions a map of standard actions
136 /// \param theParent a parent widget
137 /// \param theMenuActions map of action/menu for the desirable index in the viewer menu
138 /// \return true if items are added and there is no necessity to provide standard menu
139 virtual bool addViewerMenu(const QMap<QString, QAction*>& theStdActions,
141 QMap<int, QAction*>& theMenuActions) const
144 /// Add menu items for object browser into the given menu
145 /// \param theMenu a popup menu to be shown in the object browser
146 virtual void addObjectBrowserMenu(QMenu* theMenu) const {};
148 /// Creates custom widgets for property panel
149 /// \param theType a type of widget
150 /// \param theParent the parent object
151 /// \param theWidgetApi the widget configuration.
152 /// The attribute of the model widget is obtained from
153 virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType,
155 Config_WidgetAPI* theWidgetApi)
160 /// Returns the active widget, by default it is the property panel active widget
161 virtual ModuleBase_ModelWidget* activeWidget() const = 0;
163 /// Returns current workshop
164 ModuleBase_IWorkshop* workshop() const { return myWorkshop; }
166 /// Call back forlast tuning of property panel before operation performance
167 /// It is called as on clearing of property panel as on filling with new widgets
168 virtual void propertyPanelDefined(ModuleBase_Operation* theOperation) {}
170 /// Have an opportunity to create widgets for the current operation
171 /// instead of standard creation in workshop
172 /// \param theOperation a started operation
173 /// \param theWidgets a list of created widgets
174 /// \return boolean result, false by default
175 virtual bool createWidgets(ModuleBase_Operation* theOperation,
176 QList<ModuleBase_ModelWidget*>& theWidgets) const { return false; }
178 //! Returns True if there are available Undos and there is not an active operation
179 virtual bool canUndo() const;
181 //! Returns True if there are available Redos and there is not an active operation
182 virtual bool canRedo() const;
184 /// Returns true if the action can be applyed to the object
185 /// \param theObject a checked object
186 /// \param theActionId an identifier of action, to be found in the menu manager like "DELETE_CMD"
187 /// \return the a boolean result
188 virtual bool canApplyAction(const ObjectPtr& theObject, const QString& theActionId) const = 0;
190 /// Returns True if the current operation can be committed. By default it is true.
191 /// \return a boolean value
192 //virtual bool canCommitOperation() const;
194 /// Returns whether the object can be erased. The default realization returns true.
195 /// \param theObject a model object
196 virtual bool canEraseObject(const ObjectPtr& theObject) const;
198 /// Returns whether the object can be displayed. The default realization returns true.
199 /// \param theObject a model object
200 virtual bool canDisplayObject(const ObjectPtr& theObject) const;
202 /// Returns whether the started operation may use preselection of the previous one
203 /// Cases are: previous operation is null, edit operation, previuos and started operations
204 /// kinds are the same
205 /// \param thePreviousOperationKind a kind of previous operation
206 /// \param theStartedOperationKind a kind of a started operation
207 virtual bool canUsePreselection(const QString& thePreviousOperationKind,
208 const QString& theStartedOperationKind);
210 /// Make some functionality after the objects are hidden in viewer
211 /// \param theObjects a list of hidden objects
212 //virtual void processHiddenObject(const std::list<ObjectPtr>& theObjects) {};
214 /// Returns true if selection for the object can be activate.
215 /// By default a result or feature of the current operation can not be activated
216 /// \param theObject a model object
217 virtual bool canActivateSelection(const ObjectPtr& theObject) const;
219 /// Reacts to the delete action in module
220 /// \returns true if the action is processed
221 virtual bool deleteObjects() { return false; };
223 /// Performs functionality on closing document
224 virtual void closeDocument() = 0;
226 /// Clears specific presentations in the viewer
227 virtual void clearViewer() = 0;
229 /// Returns a list of modes, where the AIS objects should be activated
230 /// \param theModes a list of modes
231 virtual void activeSelectionModes(QIntList& theModes) {}
233 /// Appends specific selection modes for the module to the list of types
234 /// \param theModesType combination of available selection filters
235 /// \param theModes a selection modes to be extended
236 virtual void moduleSelectionModes(int theModesType, QIntList& theModes) = 0;
238 /// Appends into container of filters module filters corresponded to the modes type
239 /// \param theFilterTypes container of available selection filters
240 /// \param theSelectionFilters [out] container to be extend by elements
241 virtual void moduleSelectionFilters(const QIntList& theFilterTypes,
242 SelectMgr_ListOfFilter& theSelectionFilters) = 0;
244 /// Returns types of registered module selection filters
245 /// \param theSelectionFilters [out] container of type value
246 virtual QIntList selectionFilters();
248 /// Returns selection filter
249 /// \param theType selection filter type
250 /// \param theFilter instance of filter
251 virtual Handle(SelectMgr_Filter) selectionFilter(const int theType);
253 /// Append selection filter into the module and type of the filter in internal container
254 /// \param theFilterType selection filter type
255 /// \param theFilter added filter
256 void registerSelectionFilter(const ModuleBase_SelectionFilterType theFilterType,
257 const Handle(SelectMgr_Filter)& theFilter);
259 /// Return true if the custom presentation is activated
260 /// \param theFlag a flag of level of customization, which means that only part of sub-elements
261 /// \return boolean value
262 virtual bool isCustomPrsActivated(const ModuleBase_CustomizeFlag& theFlag) const
265 /// Activate custom presentation for the object. Default realization is empty.
266 /// \param theFeature a feature instance
267 /// \param theFlag a flag of level of customization, which means that only part of sub-elements
268 /// \param theUpdateViewer the parameter whether the viewer should be update immediately
269 virtual void activateCustomPrs(const FeaturePtr& theFeature,
270 const ModuleBase_CustomizeFlag& theFlag,
271 const bool theUpdateViewer) {}
273 /// Deactivate custom presentation for the object. Default realization is empty.
274 /// \param theFlag a flag of level of customization, which means that only part of sub-elements
275 /// \param theUpdateViewer the parameter whether the viewer should be update immediately
276 virtual void deactivateCustomPrs(const ModuleBase_CustomizeFlag& theFlag,
277 const bool theUpdateViewer) {}
279 /// Modifies the given presentation in the custom way.
280 //virtual bool customisePresentation(std::shared_ptr<ModelAPI_Result> theResult,
281 // AISObjectPtr thePrs,
282 // GeomCustomPrsPtr theCustomPrs) { return false; };
284 ///// Modifies the given presentation in the custom way after usual customize is performed.
285 //virtual bool afterCustomisePresentation(std::shared_ptr<ModelAPI_Result> theResult,
286 // AISObjectPtr thePrs,
287 // GeomCustomPrsPtr theCustomPrs) { return false; };
289 /// Update the object presentable properties such as color, lines width and other
290 /// If the object is result with the color attribute value set, it is used,
291 /// otherwise the customize is applyed to the object's feature if it is a custom prs
292 /// \param theObject an object instance
293 /// \param theFlag a flag of level of customization, which means that only part of sub-elements
294 /// should be updated(e.g. only highlighted elements)
295 /// \param theUpdateViewer the parameter whether the viewer should be update immediately
296 /// \returns true if the object is modified
297 virtual bool customizeFeature(ObjectPtr theObject, const ModuleBase_CustomizeFlag& theFlag,
298 const bool theUpdateViewer) {
302 /// Disable displaying of custom mode
303 /// \param theMode a mode to disable
304 virtual void disableCustomMode(ModuleBase_CustomizeFlag theMode) {}
306 /// Enables disabled custom mode
307 virtual void enableCustomModes() {}
309 /// This method is called on object browser creation for customization of module specific features
310 /// \param theObjectBrowser a pinter on Object Browser widget
311 virtual void customizeObjectBrowser(QWidget* theObjectBrowser) {}
313 /// Creates a new operation
314 /// \param theCmdId the operation name
315 virtual ModuleBase_Operation* createOperation(const std::string& theCmdId);
317 /// Create specific for the module presentation. The presentation has to be
318 /// customized accordingly to the object.
319 /// \param theResult an object for presentation
320 /// \return created presentation or NULL(default value)
321 virtual AISObjectPtr createPresentation(const ObjectPtr& theResult);
323 /// Customize presentation according to objects attributes
324 /// \param theObject an object for presentation
325 /// \param thePrs a presentation object
326 virtual void customizePresentation(const ObjectPtr& theObject, const AISObjectPtr& thePrs) const
329 //! Returns data object by AIS
330 virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const = 0;
332 //! Returns true if the presentation can be shown in shading mode
333 //! \param theAIS presentation to be checked
334 //! \return boolean value
335 virtual bool canBeShaded(Handle(AIS_InteractiveObject) theAIS) const;
337 /// Update state of pop-up menu items in object browser
338 /// \param theStdActions - a map of standard actions
339 virtual void updateObjectBrowserMenu(const QMap<QString, QAction*>& theStdActions) {}
341 /// Update state of pop-up menu items in viewer
342 /// \param theStdActions - a map of standard actions
343 virtual void updateViewerMenu(const QMap<QString, QAction*>& theStdActions) {}
345 /// Returns true if the action should be always enabled
346 /// \param theActionId an action index: Accept or Accept All
347 /// \return boolean value
348 virtual bool isActionEnableStateFixed(const int theActionId) const { return false; }
350 //! Returns the feature error if the current state of the feature in the module is not correct
351 //! If the feature is correct, it returns an empty value
352 //! \return string value
353 virtual QString getFeatureError(const FeaturePtr& theFeature);
355 /// Returns list of granted operation indices
356 virtual void grantedOperationIds(ModuleBase_Operation* theOperation, QStringList& theIds) const;
358 /// Connects or disconnects to the value changed signal of the property panel widgets
359 /// \param theWidget a property contol widget
360 /// \param isToConnect a boolean value whether connect or disconnect
361 virtual void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect) {};
363 /// Validates the operation to change the "Apply" button state.
364 /// \param thePreviousState the previous state of the widget
365 virtual void widgetStateChanged(int thePreviousState) {};
367 /// Returns true if the event is processed.
368 /// \param thePreviousAttributeID an index of the previous active attribute
369 virtual bool processEnter(const std::string& thePreviousAttributeID) { return false; };
371 /// Performs some GUI actions before an operation transaction is stopped
372 /// Default realization is empty
373 virtual void beforeOperationStopped(ModuleBase_Operation* theOperation) {};
375 /// Finds a shape by attribute if it is possible
376 /// \param theAttribute an attribute
377 /// \return a geom shape
378 virtual GeomShapePtr findShape(const AttributePtr& theAttribute) = 0;
380 /// Finds an attribute by geom shape if it is possible
381 /// \param theObject an object of the attribute
382 /// \param theGeomShape a geom shape
383 /// \return theAttribute
384 virtual AttributePtr findAttribute(const ObjectPtr& theObject,
385 const GeomShapePtr& theGeomShape) = 0;
387 /// Returns reentrant message if it was accepted
388 virtual std::shared_ptr<Events_Message> reentrantMessage() = 0;
390 /// Put current selection into reentrant message
391 /// \param theMessage a message of reentrant operation
392 virtual void setReentrantPreSelection(const std::shared_ptr<Events_Message>& theMessage) = 0;
394 /// Returns XML information by the feature index
395 /// \param theFeatureId a feature id
396 /// \param theXmlCfg XML configuration
397 /// \param theDescription feature description
398 void getXMLRepresentation(const std::string& theFeatureId, std::string& theXmlCfg,
399 std::string& theDescription);
401 /// Returns root tree node which represents a data model
402 virtual ModuleBase_ITreeNode* rootNode() const = 0;
405 /// Segnal emitted when an operation is resumed
406 /// \param theOp a resumed operation
407 void resumed(ModuleBase_Operation* theOp);
410 /// Called on call of command corresponded to a feature
411 virtual void onFeatureTriggered();
413 /// Slot called on object display
414 /// \param theObject a data object
415 /// \param theAIS a presentation object
416 virtual void onObjectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS) {}
418 /// Slot called on before object erase
419 /// \param theObject a data object
420 /// \param theAIS a presentation object
421 virtual void onBeforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS) {}
424 /// Called on selection changed event
425 virtual void onSelectionChanged() {}
428 /// Register validators for this module
429 virtual void registerValidators() {}
431 /// Register properties of this module
432 virtual void registerProperties() {}
434 /// Returns new instance of operation object (used in createOperation for customization)
435 virtual ModuleBase_Operation* getNewOperation(const std::string& theFeatureId);
438 /// Reference to workshop
439 ModuleBase_IWorkshop* myWorkshop;
441 /// Map of features in XML
442 std::map<std::string, std::string> myFeaturesInFiles;
444 std::map<ModuleBase_SelectionFilterType, Handle(SelectMgr_Filter)> mySelectionFilters;
450 //! This function must return a new module instance.
452 typedef ModuleBase_IModule* (*CREATE_FUNC)(ModuleBase_IWorkshop*);
455 #define CREATE_MODULE "createModule"
457 #endif //ModuleBase_IModule