1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 #ifndef PartSet_SketcherReetntrantMgr_H
4 #define PartSet_SketcherReetntrantMgr_H
8 #include <ModelAPI_Feature.h>
14 class ModuleBase_IWorkshop;
15 class ModuleBase_Operation;
16 class ModuleBase_ModelWidget;
17 class ModuleBase_IViewWindow;
19 class ModelAPI_CompositeFeature;
26 /// \ingroup PartSet_SketcherReetntrantMgr
27 /// It provides reentrant create operations in sketch, that is when all inputs are valid,
28 /// automatic validation of the creation and switch the created entity to edit mode
29 /// ('internal' edit operation), with the ability to simultaneously create the next entity
30 /// of same type (re-entrance of the operation).
31 /// OK valids the current edition and exits from the operation (no re-entrance).
32 /// Cancel removes (undo) the entity currently edited and
33 /// exits from the operation (no re-entrance).
34 class PARTSET_EXPORT PartSet_SketcherReetntrantMgr : public QObject
38 /// Enumeration to specify the restart operation properties.
40 RM_None, /// the operation should not be restarted
41 RM_Forbided, /// the operation should not be restarted after there is no active widget
42 RM_LastFeatureUsed, /// the operation is restarted and use
43 /// the previous feature for own initialization
44 RM_EmptyFeatureUsed /// the operation is restarted and does not use the previous feature
49 /// \param theWorkshop a workshop instance
50 PartSet_SketcherReetntrantMgr(ModuleBase_IWorkshop* theWorkshop);
51 virtual ~PartSet_SketcherReetntrantMgr();
54 /// Returns a first widget of the current opeation if the internal edit operation is active
55 /// or return null. If the current widget of the operation is a viewer selector, it returns null.
56 ModuleBase_ModelWidget* internalActiveWidget() const;
58 /// Return true if the current edit operation is an internal
59 bool isInternalEditActive() const;
61 /// Stop internal edit if the operation feature is invalid
62 void updateInternalEditActiveState();
64 /// if the internal flags allow it and the manager is active, it starts an internal edit operation
65 /// for the created operation.
66 /// \param thePreviousAttributeID an index of the previous active attribute
67 //bool restartOperation(const std::string& thePreviousAttributeID);
68 bool processEnter(const std::string& thePreviousAttributeID);
70 /// Resets the internal flags
71 /// \param theOperation a started operation
72 void operationStarted(ModuleBase_Operation* theOperation);
74 /// Resets the internal flags
75 /// \param theOperation a started operation
76 /// \return state whether the internal edit operation was active
77 bool operationCommitted(ModuleBase_Operation* theOperation);
79 /// Resets the internal flags
80 /// \param theOperation a started operation
81 void operationAborted(ModuleBase_Operation* theOperation);
83 /// Return true if the manager processes the mouse move event
84 /// It happens if the current operation is an internal edit operation and the first
85 /// control can be filled by the mouse move event. The operation is restarted.
86 /// \return true if operation is committed.
87 bool processMouseMoved(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
89 /// Return true if the manager processes the mouse press event
90 /// \return true if the current operation is an internal edit operation.
91 bool processMousePressed(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
93 /// Return true if the manager processes the mouse enter event
94 /// It happens if the current operation is an internal edit operation.
95 /// The operation is restarted. If the first widget of the started operation is
96 /// the point 2d, it processes this mouse event
97 /// \return true if operation is committed.
98 bool processMouseReleased(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
100 /// It is called by the current operation filling with the preselection.
101 /// Returns false if the reentrant mode of the operation is not empty.
102 bool canBeCommittedByPreselection();
104 /// returns true if an internal edit operation is started
105 /// \return boolean value
106 bool isInternalEditStarted() const;
109 /// SLOT, that is called by a widget activating in the property panel
110 /// If the 'internal' edit operation is started, it activates the first widget selection
111 void onWidgetActivated();
113 /// SLOT, that is called by no more widget signal emitted by property panel
114 /// Start an internal edit operation or, if the internal flag is forbided, commits
115 /// the current operation
116 /// \param thePreviousAttributeID an index of the previous active attribute
117 void onNoMoreWidgets(const std::string& thePreviousAttributeID);
119 /// Processing of vertex selected. Set an internal reentrant flag to forbiddent state if
120 /// the current feature is a line and there are not obligate widgets anymore
121 void onVertexSelected();
123 /// Deactivates selection and filters of the first operation widget if it is an internal
125 void onBeforeStopped();
128 /// Returns true if the current operation is a sketch or a nested sketch operation
129 bool isActiveMgr() const;
131 /// Sets the focus to the last control of the property panel and activates selection
132 /// of the first widget to can select first value of the next create operation
133 /// \param thePreviousAttributeID an index of the previous attribute to set focus to this widget
134 /// \return true if it is started
135 bool startInternalEdit(const std::string& thePreviousAttributeID);
137 /// Disconnects this manager from operation signals, deactivate selection of the first control
139 void beforeStopInternalEdit();
141 /// Commits the current operation and launches a new with the commited operation feature index
142 void restartOperation();
144 /// Creates an internal feature and controls to process it
145 void createInternalFeature();
147 /// A pair method for an internal creation to remove it and clear all created controls
148 void deleteInternalFeature();
150 /// Breaks sequense of automatically resterted operations
153 /// Copy some feature specific attributes from the source to a new feature
154 /// This is type for Circle and Arc features
155 /// \param theSourceFeature a source feature
156 /// \param theNewFeature a new feature
157 /// \param theSketch an active sketch
158 /// \param isTemporary is used to do not create additional features(e.g. coicidence for line)
159 /// \return true is something is copied
160 static bool copyReetntrantAttributes(const FeaturePtr& theSourceFeature,
161 const FeaturePtr& theNewFeature,
162 const std::shared_ptr<ModelAPI_CompositeFeature>& theSketch,
163 const bool isTemporary = false);
165 /// Checks whethe the feature of the given operation has kind an arc and the arc type is tangent
166 bool isTangentArc(ModuleBase_Operation* theOperation,
167 const std::shared_ptr<ModelAPI_CompositeFeature>& /*theSketch*/) const;
169 /// Accept All action is enabled if an internal edit is started.
170 /// It updates the state of the button
171 void updateAcceptAllAction();
173 /// Returns the workshop
174 XGUI_Workshop* workshop() const;
176 /// Returns the workshop module
177 PartSet_Module* module() const;
180 ModuleBase_IWorkshop* myWorkshop; /// the workshop
182 RestartingMode myRestartingMode; /// automatical restarting mode flag
183 bool myIsFlagsBlocked; /// true when reset of flags should not be perfromed
184 bool myIsInternalEditOperation; /// true when the 'internal' edit is started
186 FeaturePtr myPreviousFeature; /// feature of the previous operation, which is restarted
187 FeaturePtr myInternalFeature;
188 QWidget* myInternalWidget;
189 ModuleBase_ModelWidget* myInternalActiveWidget;
190 std::string myNoMoreWidgetsAttribute;