Salome HOME
A sketcher operations manager is created
[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 <QObject>
21
22 #include <string>
23
24 #include <memory>
25
26 class ModuleBase_Operation;
27 class ModuleBase_IViewWindow;
28
29 class PARTSET_EXPORT PartSet_Module : public ModuleBase_IModule
30 {
31 Q_OBJECT
32
33 /// Enumeration to specify the restart operation properties.
34 enum RestartingMode {
35   RM_None, /// the operation should not be restarted
36   RM_Forbided, /// the operation should not be restarted after there is no active widget
37   RM_LastFeatureUsed, /// the operation is restarted and use the previous feature for own initialization
38   RM_EmptyFeatureUsed /// the operation is restarted and does not use the previous feature
39 };
40
41 public:
42   PartSet_Module(ModuleBase_IWorkshop* theWshop);
43   virtual ~PartSet_Module();
44
45   /// Creates custom widgets for property panel
46   virtual QWidget* createWidgetByType(const std::string& theType, QWidget* theParent,
47                                       Config_WidgetAPI* theWidgetApi, std::string theParentId,
48                                       QList<ModuleBase_ModelWidget*>& theModelWidgets);
49
50   /// Call back forlast tuning of property panel before operation performance
51   virtual void propertyPanelDefined(ModuleBase_Operation* theOperation);
52
53
54   /// Realizes some functionality by an operation start
55   /// Displays all sketcher sub-Objects, hides sketcher result, appends selection filters
56   /// \param theOperation a started operation
57   virtual void operationStarted(ModuleBase_Operation* theOperation);
58
59   /// Realizes some functionality by an operation commit
60   /// Restarts sketcher operation automatically of it is necessary
61   /// \param theOperation a committed operation
62   virtual void operationCommitted(ModuleBase_Operation* theOperation);
63
64   /// Realizes some functionality by an operation abort
65   /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
66   /// \param theOperation an aborted operation
67   virtual void operationAborted(ModuleBase_Operation* theOperation);
68
69   /// Realizes some functionality by an operation stop
70   /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
71   /// \param theOperation a stopped operation
72   virtual void operationStopped(ModuleBase_Operation* theOperation);
73
74 public slots:
75   /// SLOT, that is called by no more widget signal emitted by property panel
76   /// Set a specific flag to restart the sketcher operation
77   void onNoMoreWidgets();
78
79 protected slots:
80   /// Called when previous operation is finished
81   virtual void onSelectionChanged();
82
83   /// SLOT, that is called by mouse press in the viewer.
84   /// \param theWnd - the window where the event happens
85   /// \param theEvent the mouse event
86   //void onMousePressed(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
87
88   /// SLOT, that is called by mouse release in the viewer.
89   /// \param theWnd - the window where the event happens
90   /// \param theEvent the mouse event
91   //void onMouseReleased(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
92   
93   /// SLOT, that is called by mouse move in the viewer.
94   /// \param theWnd - the window where the event happens
95   /// \param theEvent the mouse event
96   //void onMouseMoved(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
97
98   /// SLOT, that is called by mouse double click in the viewer.
99   /// \param theWnd - the window where the event happens
100   /// \param theEvent the mouse event
101   //void onMouseDoubleClick(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
102
103   /// SLOT, that is called by key release in the viewer.
104   /// The mouse moved point is sent to the current operation to be processed.
105   /// \param theEvent the key event
106   void onKeyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
107
108   /// SLOT, that is called by enter key released
109   /// Set a specific type of restarting the current operation
110   void onEnterReleased();
111
112   /// SLOT, that is called by the current operation filling with the preselection.
113   /// It commits the operation of it is can be committed
114   void onOperationActivatedByPreselection();
115
116
117  protected:
118   /// Register validators for this module
119   virtual void registerValidators();
120
121   /// Register selection filters for this module
122   virtual void registerFilters();
123
124  private slots:
125    void onVertexSelected(ObjectPtr theObject, const TopoDS_Shape& theShape);
126
127
128  private:
129
130   /// Breaks sequense of automatically resterted operations
131   void breakOperationSequence();
132
133  private:
134    QString myLastOperationId;
135    FeaturePtr myLastFeature;
136
137    // Automatical restarting mode flag
138    RestartingMode myRestartingMode;
139
140   /// A filter which provides selection within a current document or whole PartSet
141   Handle(PartSet_GlobalFilter) myDocumentShapeFilter;
142
143   PartSet_SketcherMgr* mySketchMgr;
144 };
145
146 #endif