1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 #ifndef PartSet_Module_H
4 #define PartSet_Module_H
8 #include <ModuleBase_IModule.h>
9 #include <ModuleBase_Definitions.h>
10 #include <ModelAPI_Feature.h>
11 #include <ModelAPI_Attribute.h>
12 #include <ModelAPI_CompositeFeature.h>
14 #include <Events_Listener.h>
16 //#include <StdSelect_FaceFilter.hxx>
17 #include <TopoDS_Shape.hxx>
18 #include <SelectMgr_ListOfFilter.hxx>
23 #include <QModelIndex>
29 class ModuleBase_Operation;
30 class ModuleBase_IViewWindow;
31 class PartSet_MenuMgr;
32 class PartSet_CustomPrs;
33 class PartSet_SketcherMgr;
39 * Implementation of Partset module
41 class PARTSET_EXPORT PartSet_Module : public ModuleBase_IModule, public Events_Listener
45 /// Enumeration to specify the restart operation properties.
47 RM_None, /// the operation should not be restarted
48 RM_Forbided, /// the operation should not be restarted after there is no active widget
49 RM_LastFeatureUsed, /// the operation is restarted and use the previous feature for own initialization
50 RM_EmptyFeatureUsed /// the operation is restarted and does not use the previous feature
56 /// \param theWshop a pointer to a workshop
57 PartSet_Module(ModuleBase_IWorkshop* theWshop);
58 virtual ~PartSet_Module();
60 // Add default selection filters of the module to the current viewer
61 virtual void activateSelectionFilters();
62 // Remove default selection filters of the module from the current viewer
63 virtual void deactivateSelectionFilters();
65 /// Creates custom widgets for property panel
66 virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,
67 Config_WidgetAPI* theWidgetApi, std::string theParentId);
69 /// Call back forlast tuning of property panel before operation performance
70 virtual void propertyPanelDefined(ModuleBase_Operation* theOperation);
72 /// Creates an operation and send it to loop
73 /// \param theCmdId the operation name
74 virtual void launchOperation(const QString& theCmdId);
76 /// Realizes some functionality by an operation start
77 /// Displays all sketcher sub-Objects, hides sketcher result, appends selection filters
78 /// Activate the operation presentation
79 /// \param theOperation a started operation
80 virtual void onOperationStarted(ModuleBase_Operation* theOperation);
82 /// Realizes some functionality by an operation resume
83 /// Activate the operation presentation
84 /// \param theOperation a resumed operation
85 virtual void onOperationResumed(ModuleBase_Operation* theOperation);
87 /// Realizes some functionality by an operation commit
88 /// Restarts sketcher operation automatically of it is necessary
89 /// \param theOperation a committed operation
90 virtual void onOperationCommitted(ModuleBase_Operation* theOperation);
92 /// Realizes some functionality by an operation abort
93 /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
94 /// \param theOperation an aborted operation
95 virtual void onOperationAborted(ModuleBase_Operation* theOperation);
97 /// Realizes some functionality by an operation stop
98 /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
99 /// \param theOperation a stopped operation
100 virtual void onOperationStopped(ModuleBase_Operation* theOperation);
102 /// Returns current operation
103 virtual ModuleBase_Operation* currentOperation() const;
105 /// Returns True if there are available Undos and the sketch manager allows undo
106 /// \return the boolean result
107 virtual bool canUndo() const;
109 //! Returns True if there are available Redos and the sketch manager allows redo
110 /// \return the boolean result
111 virtual bool canRedo() const;
113 /// Returnas true if the action can be applyed to the object
114 /// \param theObject a checked object
115 /// \param theActionId an identifier of action, to be found in the menu manager like "DELETE_CMD"
116 /// \return the a booean result
117 virtual bool canApplyAction(const ObjectPtr& theObject, const QString& theActionId) const;
119 /// Returns True if the current operation can be committed. Asks the sketch manager.
120 /// \return a boolean value
121 virtual bool canCommitOperation() const;
123 /// Returns whether the object can be erased at the bounds of the active operation.
124 /// The sub-objects of the current operation can not be erased
125 /// \param theObject a model object
126 virtual bool canEraseObject(const ObjectPtr& theObject) const;
128 /// Returns whether the object can be displayed at the bounds of the active operation.
129 /// Display only current operation results for usual operation and ask the sketcher manager
130 /// if it is a sketch operation
131 /// \param theObject a model object
132 virtual bool canDisplayObject(const ObjectPtr& theObject) const;
134 /// Returns true if selection for the object can be activate.
135 /// For sketch operation allow the selection activation if the operation is edit, for other
136 /// operation uses the default result
137 /// \param theObject a model object
138 virtual bool canActivateSelection(const ObjectPtr& theObject) const;
140 /// Add menu atems for object browser into the given menu
141 /// \param theMenu a popup menu to be shown in the object browser
142 virtual void addObjectBrowserMenu(QMenu* theMenu) const;
144 /// Add menu atems for viewer into the given menu
145 /// \param theMenu a popup menu to be shown in the viewer
146 /// \param theStdActions a map of standard actions
147 /// \return true if items are added and there is no necessity to provide standard menu
148 virtual bool addViewerMenu(QMenu* theMenu, const QMap<QString, QAction*>& theStdActions) const;
150 /// Returns a list of modes, where the AIS objects should be activated
151 /// \param theModes a list of modes
152 virtual void activeSelectionModes(QIntList& theModes);
154 /// Returns whether the mouse enter the viewer's window
155 /// \return true if items are added and there is no necessity to provide standard menu
156 bool isMouseOverWindow();
158 /// Returns sketch manager object
159 PartSet_SketcherMgr* sketchMgr() const { return mySketchMgr; }
161 /// Performs functionality on closing document
162 virtual void closeDocument();
164 /// Clears specific presentations in the viewer
165 virtual void clearViewer();
167 /// Event Listener method
168 /// \param theMessage an event message
169 virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
171 /// Set the object with the object results are customized
172 /// \param theFeature a feature
173 void setCustomized(const FeaturePtr& theFeature);
175 /** Update the object presentable properties such as color, lines width and other
176 * If the object is result with the color attribute value set, it is used,
177 * otherwise the customize is applyed to the object's feature if it is a custom prs
178 * \param theObject an object instance
179 * \param theUpdateViewer the parameter whether the viewer should be update immediatelly
180 * \returns true if the object is modified
182 virtual bool customizeObject(ObjectPtr theObject, const bool theUpdateViewer);
184 /// This method is called on object browser creation for customisation of module specific features
185 /// \param theObjectBrowser a pinter on Object Browser widget
186 virtual void customizeObjectBrowser(QWidget* theObjectBrowser);
188 /// Returns the viewer Z layer
189 int getVisualLayerId() const { return myVisualLayerId; }
191 //! Returns data object by AIS
192 virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const;
194 /// Update state of pop-up menu items in viewer
195 /// \param theStdActions - a map of standard actions
196 virtual void updateViewerMenu(const QMap<QString, QAction*>& theStdActions);
198 //! Returns the feature error if the current state of the feature in the module is not correct
199 //! If the feature is correct, it returns an empty value
200 //! \return string value
201 virtual QString getFeatureError(const FeaturePtr& theFeature);
203 /// Returns list of granted operation indices
204 virtual void grantedOperationIds(ModuleBase_Operation* theOperation, QStringList& theIds) const;
207 /// SLOT, that is called by no more widget signal emitted by property panel
208 /// Set a specific flag to restart the sketcher operation
209 void onNoMoreWidgets();
211 /// Redefines the parent method in order to customize the next case:
212 /// If the sketch nested operation is active and the presentation is not visualized in the viewer,
213 /// the operation should be always aborted.
214 virtual void onFeatureTriggered();
216 /// Slolt called on object display
217 /// \param theObject a data object
218 /// \param theAIS a presentation object
219 virtual void onObjectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS);
221 /// Slot called on before object erase
222 /// \param theObject a data object
223 /// \param theAIS a presentation object
224 virtual void onBeforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS);
226 /// Called on transformation in current viewer
227 /// \param theTrsfType type of tranformation
228 void onViewTransformed(int theTrsfType = 2);
231 /// Called when previous operation is finished
232 virtual void onSelectionChanged();
234 /// SLOT, that is called by key release in the viewer.
235 /// \param theWnd a view window
236 /// \param theEvent the key event
237 void onKeyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
239 /// SLOT, that is called by enter key released
240 /// Set a specific type of restarting the current operation
241 void onEnterReleased();
243 /// SLOT, that is called by the current operation filling with the preselection.
244 /// It commits the operation of it is can be committed
245 void onOperationActivatedByPreselection();
247 /// A slot called on view window creation
248 void onViewCreated(ModuleBase_IViewWindow*);
251 /// Register validators for this module
252 virtual void registerValidators();
254 /// Register selection filters for this module
255 virtual void registerFilters();
257 /// Register properties of this module
258 virtual void registerProperties();
261 /// Processing of vertex selected
262 void onVertexSelected();
264 void onTreeViewDoubleClick(const QModelIndex&);
266 void onActiveDocPopup(const QPoint&);
269 /// Breaks sequense of automatically resterted operations
270 void breakOperationSequence();
273 virtual bool deleteObjects();
276 QString myLastOperationId;
277 FeaturePtr myLastFeature;
279 // Automatical restarting mode flag
280 RestartingMode myRestartingMode;
282 SelectMgr_ListOfFilter mySelectionFilters;
284 PartSet_SketcherMgr* mySketchMgr;
285 PartSet_MenuMgr* myMenuMgr;
286 /// A default custom presentation, which is used for references objects of started operation
287 PartSet_CustomPrs* myCustomPrs;
290 bool myHasConstraintShown;
292 QModelIndex aActivePartIndex;