1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 #ifndef PartSet_Module_H
4 #define PartSet_Module_H
7 #include "PartSet_DocumentDataModel.h"
9 #include <ModuleBase_IModule.h>
10 #include <ModuleBase_Definitions.h>
11 #include <ModelAPI_Feature.h>
12 #include <ModelAPI_Attribute.h>
13 #include <ModelAPI_CompositeFeature.h>
15 #include <Events_Listener.h>
17 //#include <StdSelect_FaceFilter.hxx>
18 #include <TopoDS_Shape.hxx>
19 #include <SelectMgr_ListOfFilter.hxx>
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 /// Realizes some functionality by an operation start
73 /// Displays all sketcher sub-Objects, hides sketcher result, appends selection filters
74 /// \param theOperation a started operation
75 virtual void onOperationStarted(ModuleBase_Operation* theOperation);
77 /// Realizes some functionality by an operation commit
78 /// Restarts sketcher operation automatically of it is necessary
79 /// \param theOperation a committed operation
80 virtual void onOperationCommitted(ModuleBase_Operation* theOperation);
82 /// Realizes some functionality by an operation abort
83 /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
84 /// \param theOperation an aborted operation
85 virtual void onOperationAborted(ModuleBase_Operation* theOperation);
87 /// Realizes some functionality by an operation stop
88 /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
89 /// \param theOperation a stopped operation
90 virtual void onOperationStopped(ModuleBase_Operation* theOperation);
92 /// Returns current operation
93 virtual ModuleBase_Operation* currentOperation() const;
95 /// Returns True if there are available Undos and the sketch manager allows undo
96 /// \return the boolean result
97 virtual bool canUndo() const;
99 //! Returns True if there are available Redos and the sketch manager allows redo
100 /// \return the boolean result
101 virtual bool canRedo() const;
103 /// Returnas true if the action can be applyed to the object
104 /// \param theObject a checked object
105 /// \param theActionId an identifier of action, to be found in the menu manager like "DELETE_CMD"
106 /// \return the a booean result
107 virtual bool canApplyAction(const ObjectPtr& theObject, const QString& theActionId) const;
109 /// Returns True if the current operation can be committed. Asks the sketch manager.
110 /// \return a boolean value
111 virtual bool canCommitOperation() const;
113 /// Returns whether the object can be erased at the bounds of the active operation.
114 /// The sub-objects of the current operation can not be erased
115 /// \param theObject a model object
116 virtual bool canEraseObject(const ObjectPtr& theObject) const;
118 /// Returns whether the object can be displayed at the bounds of the active operation.
119 /// Display only current operation results for usual operation and ask the sketcher manager
120 /// if it is a sketch operation
121 /// \param theObject a model object
122 virtual bool canDisplayObject(const ObjectPtr& theObject) const;
124 /// Returns true if selection for the object can be activate.
125 /// For sketch operation allow the selection activation if the operation is edit, for other
126 /// operation uses the default result
127 /// \param theObject a model object
128 virtual bool canActivateSelection(const ObjectPtr& theObject) const;
130 /// Add menu atems for object browser into the given menu
131 /// \param theMenu a popup menu to be shown in the object browser
132 virtual void addObjectBrowserMenu(QMenu* theMenu) const;
134 /// Add menu atems for viewer into the given menu
135 /// \param theMenu a popup menu to be shown in the viewer
136 /// \param theStdActions a map of standard actions
137 /// \return true if items are added and there is no necessity to provide standard menu
138 virtual bool addViewerMenu(QMenu* theMenu, const QMap<QString, QAction*>& theStdActions) const;
140 /// Returns a list of modes, where the AIS objects should be activated
141 /// \param theModes a list of modes
142 virtual void activeSelectionModes(QIntList& theModes);
144 /// Returns whether the mouse enter the viewer's window
145 /// \return true if items are added and there is no necessity to provide standard menu
146 bool isMouseOverWindow();
148 PartSet_SketcherMgr* sketchMgr() const { return mySketchMgr; }
150 /// Returns data model object for representation of data tree in Object browser
151 virtual ModuleBase_IDocumentDataModel* dataModel() const { return myDataModel; }
153 /// Performs functionality on closing document
154 virtual void closeDocument();
156 /// Clears specific presentations in the viewer
157 virtual void clearViewer();
159 /// Event Listener method
160 /// \param theMessage an event message
161 virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
163 /// Set the object with the object results are customized
164 /// \param theFeature a feature
165 void setCustomized(const FeaturePtr& theFeature);
167 /** Update the object presentable properties such as color, lines width and other
168 * If the object is result with the color attribute value set, it is used,
169 * otherwise the customize is applyed to the object's feature if it is a custom prs
170 * \param theObject an object instance
172 virtual void customizeObject(ObjectPtr theObject);
174 /// This method is called on object browser creation for customisation of module specific features
175 /// \param theObjectBrowser a pinter on Object Browser widget
176 virtual void customizeObjectBrowser(QWidget* theObjectBrowser);
178 /// Returns the viewer Z layer
179 int getVisualLayerId() const { return myVisualLayerId; }
181 //! Returns data object by AIS
182 virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const;
184 /// Update state of pop-up menu items in viewer
185 /// \param theStdActions - a map of standard actions
186 virtual void updateViewerMenu(const QMap<QString, QAction*>& theStdActions);
189 /// SLOT, that is called by no more widget signal emitted by property panel
190 /// Set a specific flag to restart the sketcher operation
191 void onNoMoreWidgets();
193 /// Redefines the parent method in order to customize the next case:
194 /// If the sketch nested operation is active and the presentation is not visualized in the viewer,
195 /// the operation should be always aborted.
196 virtual void onFeatureTriggered();
198 /// Slolt called on object display
199 /// \param theObject a data object
200 /// \param theAIS a presentation object
201 virtual void onObjectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS);
203 /// Slot called on before object erase
204 /// \param theObject a data object
205 /// \param theAIS a presentation object
206 virtual void onBeforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS);
208 /// Called on transformation in current viewer
209 /// \param theTrsfType type of tranformation
210 void onViewTransformed(int theTrsfType = 2);
213 /// Called when previous operation is finished
214 virtual void onSelectionChanged();
216 /// SLOT, that is called by key release in the viewer.
217 /// \param theWnd a view window
218 /// \param theEvent the key event
219 void onKeyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
221 /// SLOT, that is called by enter key released
222 /// Set a specific type of restarting the current operation
223 void onEnterReleased();
225 /// SLOT, that is called by the current operation filling with the preselection.
226 /// It commits the operation of it is can be committed
227 void onOperationActivatedByPreselection();
229 /// A slot called on view window creation
230 void onViewCreated(ModuleBase_IViewWindow*);
233 /// Register validators for this module
234 virtual void registerValidators();
236 /// Register selection filters for this module
237 virtual void registerFilters();
239 /// Register properties of this module
240 virtual void registerProperties();
243 /// Processing of vertex selected
244 void onVertexSelected();
246 void onTreeViewDoubleClick(const QModelIndex&);
249 /// Breaks sequense of automatically resterted operations
250 void breakOperationSequence();
253 virtual bool deleteObjects();
256 QString myLastOperationId;
257 FeaturePtr myLastFeature;
259 // Automatical restarting mode flag
260 RestartingMode myRestartingMode;
262 SelectMgr_ListOfFilter mySelectionFilters;
264 PartSet_SketcherMgr* mySketchMgr;
265 PartSet_MenuMgr* myMenuMgr;
266 /// A default custom presentation, which is used for references objects of started operation
267 PartSet_CustomPrs* myCustomPrs;
270 PartSet_DocumentDataModel* myDataModel;
272 QModelIndex aActivePartIndex;