]> SALOME platform Git repositories - modules/shaper.git/blob - src/PartSet/PartSet_SketcherReentrantMgr.h
Salome HOME
Make tests working on new results structure and selection of feature as argument
[modules/shaper.git] / src / PartSet / PartSet_SketcherReentrantMgr.h
1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #ifndef PartSet_SketcherReentrantMgr_H
22 #define PartSet_SketcherReentrantMgr_H
23
24 #include "PartSet.h"
25
26 #include <ModelAPI_Feature.h>
27
28 #include <string>
29 #include <memory>
30
31 #include <QObject>
32
33 class ModuleBase_IWorkshop;
34 class ModuleBase_Operation;
35 class ModuleBase_ModelWidget;
36 class ModuleBase_IViewWindow;
37
38 class ModelAPI_CompositeFeature;
39
40 class QMouseEvent;
41
42 class XGUI_Workshop;
43 class PartSet_Module;
44 class ModuleBase_ViewerPrs;
45 class Events_Message;
46 class ModelAPI_Attribute;
47 class GeomAPI_Pnt2d;
48
49 /// \ingroup PartSet_SketcherReentrantMgr
50 /// It provides reentrant create operations in sketch, that is when all inputs are valid,
51 /// automatic validation of the creation and switch the created entity to edit mode
52 /// ('internal' edit operation), with the ability to simultaneously create the next entity
53 /// of same type (re-entrance of the operation).
54 /// OK valids the current edition and exits from the operation (no re-entrance).
55 /// Cancel removes (undo) the entity currently edited and
56 /// exits from the operation (no re-entrance).
57 class PARTSET_EXPORT PartSet_SketcherReentrantMgr : public QObject
58 {
59 Q_OBJECT
60
61 /// Enumeration to specify the restart operation properties.
62 enum RestartingMode {
63   RM_None, /// the operation should not be restarted
64   RM_Forbided, /// the operation should not be restarted after there is no active widget
65   RM_LastFeatureUsed, /// the operation is restarted and use
66                       /// the previous feature for own initialization
67   RM_EmptyFeatureUsed /// the operation is restarted and does not use the previous feature
68 };
69
70 public:
71   /// Constructor
72   /// \param theWorkshop a workshop instance
73   PartSet_SketcherReentrantMgr(ModuleBase_IWorkshop* theWorkshop);
74   virtual ~PartSet_SketcherReentrantMgr();
75
76 public:
77   /// Return true if the current edit operation is an internal
78   bool isInternalEditActive() const;
79
80   /// Stop internal edit if the operation feature is invalid
81   void updateInternalEditActiveState();
82
83   /// if the internal flags allow it and the manager is active, it starts an internal edit operation
84   /// for the created operation.
85   /// \param thePreviousAttributeID an index of the previous active attribute
86   //bool restartOperation(const std::string& thePreviousAttributeID);
87   bool processEnter(const std::string& thePreviousAttributeID);
88
89   /// Resets the internal flags
90   /// \param theOperation a started operation
91   void operationStarted(ModuleBase_Operation* theOperation);
92
93   /// Resets the internal flags
94   /// \param theOperation a started operation
95   /// \return state whether the internal edit operation was active
96   bool operationCommitted(ModuleBase_Operation* theOperation);
97
98   /// Resets the internal flags
99   /// \param theOperation a started operation
100   void operationAborted(ModuleBase_Operation* theOperation);
101
102   /// Return true if the manager processes the mouse move event
103   /// It happens if the current operation is an internal edit operation and the first
104   /// control can be filled by the mouse move event. The operation is restarted.
105   /// \return true if operation is committed.
106   bool processMouseMoved(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
107
108   /// Return true if the manager processes the mouse press event
109   /// \return true if the current operation is an internal edit operation.
110   bool processMousePressed(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
111
112   /// Return true if the manager processes the mouse enter event
113   /// It happens if the current operation is an internal edit operation.
114   /// The operation is restarted. If the first widget of the started operation is
115   /// the point 2d, it processes this mouse event
116   /// \return true if operation is committed.
117   bool processMouseReleased(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
118
119   /// It is called by the current operation filling with the preselection.
120   /// Returns false if the reentrant mode of the operation is not empty.
121   bool canBeCommittedByPreselection();
122
123   /// Fills reentrant message during restarting operation
124   /// \param theMessage reentrant message
125   void setReentrantMessage(const std::shared_ptr<Events_Message>& theMessage)
126   { myReentrantMessage = theMessage; }
127
128   /// Returnss reentrant message
129   std::shared_ptr<Events_Message> reentrantMessage() const { return myReentrantMessage; }
130
131   /// Put current selection into reentrant message
132   /// \param theMessage a message of reentrant operation
133   void setReentrantPreSelection(const std::shared_ptr<Events_Message>& theMessage);
134
135 private slots:
136   /// SLOT, that is called by a widget activating in the property panel
137   /// If the 'internal' edit operation is started, it activates the first widget selection
138   //void onWidgetActivated();
139
140   /// SLOT, that is called by no more widget signal emitted by property panel
141   /// Start an internal edit operation or, if the internal flag is forbided, commits
142   /// the current operation
143   /// \param thePreviousAttributeID an index of the previous active attribute
144   void onNoMoreWidgets(const std::string& thePreviousAttributeID);
145
146   /// Processing of vertex selected. Set an internal reentrant flag to forbiddent state if
147   /// the current feature is a line and there are not obligate widgets anymore
148   void onVertexSelected();
149
150   /// Listens to the signal about the modification of the values
151   /// have been done in the property panel. If the manager has active edit operation and
152   /// the active widget does not process the modification of value, the manager will
153   /// restart current operation and fill a new feature attribute by the value of current
154   /// widget
155   void onAfterValuesChangedInPropertyPanel();
156
157   /// Deactivates selection and filters of the first operation widget if it is an internal
158   /// 'edit' operation
159   void onBeforeStopped();
160
161 private:
162   /// Returns true if the current operation is a sketch or a nested sketch operation
163   bool isActiveMgr() const;
164
165   /// Sets the focus to the last control of the property panel and activates selection
166   /// of the first widget to can select first value of the next create operation
167   /// \param thePreviousAttributeID an index of the previous attribute to set focus to this widget
168   /// \return true if it is started
169   bool startInternalEdit(const std::string& thePreviousAttributeID);
170
171   /// Disconnects this manager from operation signals, deactivate selection of the first control
172   /// in the viewer.
173   void beforeStopInternalEdit();
174
175   /// Commits the current operation and launches a new with the commited operation feature index
176   void restartOperation();
177
178   /// Creates an internal feature and controls to process it
179   void createInternalFeature();
180
181   /// A pair method for an internal creation to remove it and clear all created controls
182   void deleteInternalFeature();
183
184   /// Breaks sequense of automatically resterted operations
185   void resetFlags();
186
187   /// Copy some feature specific attributes from the source to a new feature
188   /// This is type for Circle and Arc features
189   /// \param theSourceFeature a source feature
190   /// \param theNewFeature a new feature
191   /// \param theSketch an active sketch
192   /// \param isTemporary is used to do not create additional features(e.g. coicidence for line)
193   /// \return true is something is copied
194   static bool copyReetntrantAttributes(const FeaturePtr& theSourceFeature,
195                                       const FeaturePtr& theNewFeature,
196                                       const std::shared_ptr<ModelAPI_CompositeFeature>& theSketch,
197                                       const bool isTemporary = false);
198
199   /// Checks whethe the feature of the given operation has kind an arc and the arc type is tangent
200   bool isTangentArc(ModuleBase_Operation* theOperation,
201                     const std::shared_ptr<ModelAPI_CompositeFeature>& /*theSketch*/) const;
202
203   /// Accept All action is enabled if an internal edit is started.
204   /// It updates the state of the button
205   void updateAcceptAllAction();
206
207   /// Returns the workshop
208   XGUI_Workshop* workshop() const;
209
210   /// Returns the workshop module
211   PartSet_Module* module() const;
212
213   void setInternalActiveWidget(ModuleBase_ModelWidget* theWidget);
214
215 private:
216   ModuleBase_IWorkshop* myWorkshop; /// the workshop
217
218   RestartingMode myRestartingMode;  /// automatical restarting mode flag
219   bool myIsFlagsBlocked; /// true when reset of flags should not be perfromed
220   bool myIsInternalEditOperation; /// true when the 'internal' edit is started
221
222   FeaturePtr myPreviousFeature; /// feature of the previous operation, which is restarted
223   FeaturePtr myInternalFeature;
224   QWidget* myInternalWidget;
225   std::string myNoMoreWidgetsAttribute;
226
227   std::shared_ptr<Events_Message> myReentrantMessage; /// message obtained by operation restart
228   ObjectPtr mySelectedObject; /// cashed selected object
229   std::shared_ptr<ModelAPI_Attribute> mySelectedAttribute; /// cashed selected attribute
230   std::shared_ptr<GeomAPI_Pnt2d> myClickedSketchPoint; /// cashed clicked point
231 };
232
233 #endif