]> SALOME platform Git repositories - modules/shaper.git/blob - src/PartSet/PartSet_Module.h
Salome HOME
67484a6d7f985e07bb7ed8360166f803906515a6
[modules/shaper.git] / src / PartSet / PartSet_Module.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 #ifndef PartSet_Module_H
4 #define PartSet_Module_H
5
6 #include "PartSet.h"
7 #include "PartSet_Filters.h"
8 #include "PartSet_SketcherMgr.h"
9
10 #include <ModuleBase_IModule.h>
11 #include <ModuleBase_Definitions.h>
12 #include <ModelAPI_Feature.h>
13 #include <ModelAPI_Attribute.h>
14 #include <ModelAPI_CompositeFeature.h>
15
16 //#include <StdSelect_FaceFilter.hxx>
17 #include <TopoDS_Shape.hxx>
18
19 #include <QMap>
20 #include <QMenu>
21 #include <QObject>
22
23 #include <string>
24
25 #include <memory>
26
27 class ModuleBase_Operation;
28 class ModuleBase_IViewWindow;
29
30 class QAction;
31
32 /**
33 * \ingroup Modules
34 * Implementation of Partset module
35 */
36 class PARTSET_EXPORT PartSet_Module : public ModuleBase_IModule
37 {
38 Q_OBJECT
39
40 /// Enumeration to specify the restart operation properties.
41 enum RestartingMode {
42   RM_None, /// the operation should not be restarted
43   RM_Forbided, /// the operation should not be restarted after there is no active widget
44   RM_LastFeatureUsed, /// the operation is restarted and use the previous feature for own initialization
45   RM_EmptyFeatureUsed /// the operation is restarted and does not use the previous feature
46 };
47
48 public:
49   /// Constructor
50   /// \param theWshop a pointer to a workshop
51   PartSet_Module(ModuleBase_IWorkshop* theWshop);
52   virtual ~PartSet_Module();
53
54   /// Creates custom widgets for property panel
55   virtual QWidget* createWidgetByType(const std::string& theType, QWidget* theParent,
56                                       Config_WidgetAPI* theWidgetApi, std::string theParentId,
57                                       QList<ModuleBase_ModelWidget*>& theModelWidgets);
58
59   /// Call back forlast tuning of property panel before operation performance
60   virtual void propertyPanelDefined(ModuleBase_Operation* theOperation);
61
62
63   /// Realizes some functionality by an operation start
64   /// Displays all sketcher sub-Objects, hides sketcher result, appends selection filters
65   /// \param theOperation a started operation
66   virtual void operationStarted(ModuleBase_Operation* theOperation);
67
68   /// Realizes some functionality by an operation commit
69   /// Restarts sketcher operation automatically of it is necessary
70   /// \param theOperation a committed operation
71   virtual void operationCommitted(ModuleBase_Operation* theOperation);
72
73   /// Realizes some functionality by an operation abort
74   /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
75   /// \param theOperation an aborted operation
76   virtual void operationAborted(ModuleBase_Operation* theOperation);
77
78   /// Realizes some functionality by an operation stop
79   /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
80   /// \param theOperation a stopped operation
81   virtual void operationStopped(ModuleBase_Operation* theOperation);
82
83   /// Returns action according to the given ID
84   /// \param theId an action identifier, it should be uniqued in the bounds of the module
85   QAction* action(const QString& theId) const;
86
87   /// Returns True if there are available Undos and the sketch manager allows undo
88   /// \return the boolean result
89   virtual bool canUndo() const;
90
91   //! Returns True if there are available Redos and the sketch manager allows redo
92   /// \return the boolean result
93   virtual bool canRedo() const;
94
95   /// Returns whether the object can be displayed at the bounds of the active operation.
96   /// Display only current operation results for usual operation and ask the sketcher manager
97   /// if it is a sketch operation
98   /// \param theObject a model object
99   virtual bool canDisplayObject(const ObjectPtr& theObject) const;
100   /// Add menu atems for viewer into the given menu
101   /// \param theMenu a popup menu to be shown in the viewer
102   virtual void addViewerItems(QMenu* theMenu) const;
103
104 public slots:
105   /// SLOT, that is called by no more widget signal emitted by property panel
106   /// Set a specific flag to restart the sketcher operation
107   void onNoMoreWidgets();
108
109   /// Processes the context menu action click
110   /// \param isChecked a state of toggle if the action is checkable
111   void onAction(bool isChecked);
112
113 protected slots:
114   /// Called when previous operation is finished
115   virtual void onSelectionChanged();
116
117   /// SLOT, that is called by key release in the viewer.
118   /// \param theWnd a view window
119   /// \param theEvent the key event
120   void onKeyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
121
122   /// SLOT, that is called by enter key released
123   /// Set a specific type of restarting the current operation
124   void onEnterReleased();
125
126   /// SLOT, that is called by the current operation filling with the preselection.
127   /// It commits the operation of it is can be committed
128   void onOperationActivatedByPreselection();
129
130  protected:
131   /// Register validators for this module
132   virtual void registerValidators();
133
134   /// Register selection filters for this module
135   virtual void registerFilters();
136
137   /// Register properties of this module
138   virtual void registerProperties();
139
140  private slots:
141    /// Processing of vertex selected
142    void onVertexSelected();
143
144  private:
145   /// Breaks sequense of automatically resterted operations
146   void breakOperationSequence();
147
148   /// Create all actions for context menus. It is called on creation of module
149   /// Put the created actions into an internal map
150   void createActions();
151
152   /// Add action to the internal map
153   /// \param theId - string ID of the item
154   /// \param theAction - action to add
155   void addAction(const QString& theId, QAction* theAction);
156
157   //! Delete features
158   virtual bool deleteObjects();
159
160  private:
161    QString myLastOperationId;
162    FeaturePtr myLastFeature;
163
164    // Automatical restarting mode flag
165    RestartingMode myRestartingMode;
166
167   /// A filter which provides selection within a current document or whole PartSet
168   Handle(PartSet_GlobalFilter) myDocumentShapeFilter;
169
170   PartSet_SketcherMgr* mySketchMgr;
171
172   QMap<QString, QAction*> myActions; // the popup menu actions
173 };
174
175 #endif