]> SALOME platform Git repositories - modules/shaper.git/blob - src/PartSet/PartSet_SketcherMgr.h
Salome HOME
Merge branch 'Dev_1.1.0' of newgeom:newgeom.git into Dev_1.1.0
[modules/shaper.git] / src / PartSet / PartSet_SketcherMgr.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 // File:        PartSet_SketcherMgr.h
4 // Created:     19 Dec 2014
5 // Author:      Vitaly SMETANNIKOV
6
7 #ifndef PartSet_SketcherMgr_H
8 #define PartSet_SketcherMgr_H
9
10 #include "PartSet.h"
11
12 #include <ModelAPI_Feature.h>
13 #include <ModelAPI_Attribute.h>
14 #include <ModelAPI_CompositeFeature.h>
15 #include <ModelAPI_Result.h>
16
17 #include <ModuleBase_ViewerFilters.h>
18 #include <ModuleBase_Definitions.h>
19
20 #include <GeomAPI_Pln.h>
21 #include <SelectMgr_IndexedMapOfOwner.hxx>
22
23 #include <QObject>
24 #include <QList>
25 #include <QMap>
26
27 class PartSet_Module;
28 class ModuleBase_IViewWindow;
29 class ModuleBase_ModelWidget;
30 class ModuleBase_Operation;
31 class QMouseEvent;
32
33 /**
34 * \ingroup Modules
35 * A class for management of sketch operations
36   At the time of the sketcher operation active, only the sketch sub-feature results are
37   displayed in the viewer. After the sketch create/edit operation is finished, the sub-feature
38   are hidden, the sketch feature result is displayed
39 */
40 class PARTSET_EXPORT PartSet_SketcherMgr : public QObject
41 {
42   Q_OBJECT
43   /// Struct to define gp point, with the state is the point is initialized
44   struct Point
45   {
46     /// Constructor
47     Point()
48     {
49       myIsInitialized = false;
50     }
51     /// Destructor
52     ~Point()
53     {
54     }
55
56     /// clear the initialized flag.
57     void clear()
58     {
59       myIsInitialized = false;
60     }
61     /// set the point and switch on the initialized flag
62     /// \param thePoint the point
63     void setValue(const double theX, const double theY)
64     {
65       myIsInitialized = true;
66       myCurX = theX;
67       myCurY = theY;
68     }
69
70     bool myIsInitialized;  /// the state whether the point is set
71     double myCurX, myCurY; /// the point coordinates
72   };
73 public:
74   /// Constructor
75   /// \param theModule a pointer to PartSet module
76   PartSet_SketcherMgr(PartSet_Module* theModule);
77
78   virtual ~PartSet_SketcherMgr();
79
80   /// Returns true if the operation is the sketch
81   /// \param theOperation an operation
82   /// \return the boolean result
83   static bool isSketchOperation(ModuleBase_Operation* theOperation);
84
85   /// Returns true if the operation id is in the sketch operation id list
86   /// \param theOperation an operation
87   /// \return the boolean result
88   static bool isNestedSketchOperation(ModuleBase_Operation* theOperation);
89
90   /// Returns true if the operation is a create nested feature one
91   /// \param theOperation a checked operation
92   //// \return boolean value
93   static bool isNestedCreateOperation(ModuleBase_Operation* theOperation);
94
95   /// Returns whether the current operation is a sketch entity - line, point, arc or circle
96   /// \param the operation
97   /// \return a boolean value
98   static bool isEntityOperation(ModuleBase_Operation* theOperation);
99
100   /// Returns whether the current operation is a sketch distance - lenght, distance or radius
101   /// \param the operation
102   /// \return a boolean value
103   static bool isDistanceOperation(ModuleBase_Operation* theOperation);
104
105   /// Returns current Sketch feature/ Returns NULL if there is no launched sketch operation
106   CompositeFeaturePtr activeSketch() const { return myCurrentSketch; }
107
108   /// Starts sketch operation
109   void startSketch(ModuleBase_Operation* );
110
111   /// Stops sketch operation
112   void stopSketch(ModuleBase_Operation* );
113
114   /// Starts sketch operation, connects to the opeation property panel
115   /// \param theOperation a committed operation
116   void startNestedSketch(ModuleBase_Operation* theOperation);
117
118   /// Stop sketch operation, disconnects from the opeation property panel
119   /// \param theOperation a stopped operation
120   void stopNestedSketch(ModuleBase_Operation* theOperation);
121
122   /// Visualizes the operation feature if it is a creation nested feature operation
123   /// \param theOperation a committed operation
124   void commitNestedSketch(ModuleBase_Operation* theOperation);
125
126   /// Returns True if there are available Undos and the sketch manager allows undo
127   /// \return the boolean result
128   bool canUndo() const;
129
130   //! Returns True if there are available Redos and the sketch manager allows redo
131   /// \return the boolean result
132   bool canRedo() const;
133
134   /// Returns whether the object can be displayed at the bounds of the active operation.
135   /// Display only current operation results for usual operation and ask the sketcher manager
136   /// if it is a sketch operation
137   /// \param theObject a model object
138   bool canDisplayObject() const;
139
140   /// Returns true if the current operation is sketch entity create operation
141   /// \param theValue the current auxiliary value
142   /// \return the boolean result
143   bool canSetAuxiliary(bool& theValue) const;
144   
145   /// Changes the sketcher entity construction argument value
146   /// \param isChecked if true, the feature is a construction
147   void setAuxiliary(const bool isChecked);
148
149 public slots:
150   /// Process sketch plane selected event
151   void onPlaneSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
152
153 private slots:
154   /// Process the enter mouse to the view port. If the current operation is a create of
155   /// a nested sketch feature, it updates internal flags to display the feature on mouse move
156   void onEnterViewPort();
157   /// Process the leave mouse of the view port. If the current operation is a create of
158   /// a nested sketch feature, it hides the feature in the viewer
159   void onLeaveViewPort();
160   /// Listens to the value changed signal and display the current operation feature
161   void onBeforeValuesChangedInPropertyPanel();
162   /// Listens to the signal about values are to be changed in the property panel
163   void onValuesChangedInPropertyPanel();
164   /// Listens to the signal about the modification of the values have been done in the property panel
165   void onAfterValuesChangedInPropertyPanel();
166
167   void onMousePressed(ModuleBase_IViewWindow*, QMouseEvent*);
168   void onMouseReleased(ModuleBase_IViewWindow*, QMouseEvent*);
169   void onMouseMoved(ModuleBase_IViewWindow*, QMouseEvent*);
170   void onMouseDoubleClick(ModuleBase_IViewWindow*, QMouseEvent*);
171   void onApplicationStarted();
172   void onBeforeWidgetActivated(ModuleBase_ModelWidget* theWidget);
173
174   void onBeforeContextMenu();
175   void onAfterContextMenu();
176
177 private:
178   /// Launches the operation from current highlighting
179   void launchEditing();
180
181   /// Returns list of strings which contains id's of sketch operations
182   static QStringList sketchOperationIdList();
183
184   /// Converts mouse position to 2d coordinates. 
185   /// Member myCurrentSketch has to be correctly defined
186   void get2dPoint(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent, 
187                   Point& thePoint);
188
189   typedef QMap<FeaturePtr, std::pair<std::set<AttributePtr>, std::set<ResultPtr> > >
190                                                                        FeatureToSelectionMap;
191
192   /// Obtains the current selection of the object in the workshop viewer 
193   /// It includes the selection in all modes of activation, even local context - vertices, edges
194   /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
195   /// selection owners. If the owner is vertex, the corresponded attribute is seached in
196   /// the feature, if the owner is edge, the current result is added to the container of results.
197   /// \param theFeature a feature or result object
198   /// \param theSketch a current sketch feature
199   /// \param theWorkshop a workshop to have an access to AIS context and displayer
200   /// \param theSelection a container for the selection, to save results and attributres for a feature
201   static void getCurrentSelection(const FeaturePtr& theFeature,
202                                   const FeaturePtr& theSketch,
203                                   ModuleBase_IWorkshop* theWorkshop,
204                                   FeatureToSelectionMap& theSelection);
205
206   /// Applyes the current selection to the object in the workshop viewer 
207   /// It includes the selection in all modes of activation, even local context - vertexes, edges
208   /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
209   /// selection owners. If the owner is vertex, the corresponded attribute is seached in
210   /// the feature and if it is in the container of selected attributes, the owner is put in the
211   /// out container. If the owner is edge and the current result is in the container of selected
212   /// results, the owner is put in the out container.
213   /// \param theFeature a feature or result object
214   /// \param theSketch a current sketch feature
215   /// \param theWorkshop a workshop to have an access to AIS context and displayer
216   /// \param theSelection a container of the selection, it has results and attributres for a feature
217   /// \param theOwnersToSelect an out container of found owners
218   static void getSelectionOwners(const FeaturePtr& theFeature,
219                                   const FeaturePtr& theSketch,
220                                   ModuleBase_IWorkshop* theWorkshop,
221                                   const FeatureToSelectionMap& theSelection,
222                                   SelectMgr_IndexedMapOfOwner& anOwnersToSelect);
223
224   /// Connects or disconnects to the value changed signal of the property panel widgets
225   /// \param isToConnect a boolean value whether connect or disconnect
226   void connectToPropertyPanel(const bool isToConnect);
227
228   /// Returns true if the created feature is visible
229   /// \param 
230   bool isVisibleCreatedFeature() const;
231
232   /// Returns a current operation
233   /// \return an operation
234   ModuleBase_Operation* getCurrentOperation() const;
235
236   /// Erase or display the feature of the current operation. If the mouse over the active view or
237   /// a current value is changed by property panel, the feature is displayed otherwise it is hidden
238   /// \param theOperation an operation which feature is to be displayed, it is nested create operation
239   /// \param isToDisplay a flag about the display or erase the feature
240   void visualizeFeature(ModuleBase_Operation* theOperation, const bool isToDisplay);
241
242   /// Saves the current selection in the viewer into an internal container
243   /// It obtains the selected attributes. The highlighted objects can be processes as the selected ones
244   /// \param theHighlightedUse a boolean flag
245   void storeSelection(const bool theHighlightedOnly = false);
246   void restoreSelection();
247
248 private:
249   PartSet_Module* myModule;
250
251   bool myPreviousSelectionEnabled; // the previous selection enabled state in the viewer
252   bool myIsDragging;
253   bool myDragDone;
254   bool myIsPropertyPanelValueChanged; /// the state that value in the property panel is changed
255   bool myIsMouseOverWindow; /// the state that the mouse over the view
256   bool myIsMouseOverViewProcessed; /// the state whether the over view state is processed by mouseMove method
257   bool myIsPopupMenuActive; /// the state of the popup menu is shown
258   Point myCurrentPoint;
259   Point myClickedPoint;
260
261   CompositeFeaturePtr myCurrentSketch;
262
263   Handle(ModuleBase_ShapeInPlaneFilter) myPlaneFilter;
264   FeatureToSelectionMap myCurrentSelection;
265   bool myPreviousUpdateViewerEnabled;
266 };
267
268
269 #endif