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;
24 /// \ingroup PartSet_SketcherReetntrantMgr
25 /// It provides reentrant create operations in sketch, that is when all inputs are valid,
26 /// automatic validation of the creation and switch the created entity to edit mode
27 /// ('internal' edit operation), with the ability to simultaneously create the next entity
28 /// of same type (re-entrance of the operation).
29 /// OK valids the current edition and exits from the operation (no re-entrance).
30 /// Cancel removes (undo) the entity currently edited and exits from the operation (no re-entrance).
31 class PARTSET_EXPORT PartSet_SketcherReetntrantMgr : public QObject
35 /// Enumeration to specify the restart operation properties.
37 RM_None, /// the operation should not be restarted
38 RM_Forbided, /// the operation should not be restarted after there is no active widget
39 RM_LastFeatureUsed, /// the operation is restarted and use the previous feature for own initialization
40 RM_EmptyFeatureUsed /// the operation is restarted and does not use the previous feature
45 /// \param theParent a parent object
46 PartSet_SketcherReetntrantMgr(ModuleBase_IWorkshop* theWorkshop);
47 virtual ~PartSet_SketcherReetntrantMgr();
50 /// Returns a first widget of the current opeation if the internal edit operation is active
51 /// or return null. If the current widget of the operation is a viewer selector, it returns null.
52 ModuleBase_ModelWidget* internalActiveWidget() const;
54 /// Resets the internal flags
55 /// \param theOperation a started operation
56 void operationStarted(ModuleBase_Operation* theOperation);
58 /// Resets the internal flags
59 /// \param theOperation a started operation
60 /// \return state whether the internal edit operation was active
61 bool operationCommitted(ModuleBase_Operation* theOperation);
63 /// Resets the internal flags
64 /// \param theOperation a started operation
65 void operationAborted(ModuleBase_Operation* theOperation);
67 /// Return true if the manager processes the mouse move event
68 /// It happens if the current operation is an internal edit operation and the first
69 /// control can be filled by the mouse move event. The operation is restarted.
70 /// \return true if operation is committed.
71 bool processMouseMoved(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
73 /// Return true if the manager processes the mouse press event
74 /// \return true if the current operation is an internal edit operation.
75 bool processMousePressed(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
77 /// Return true if the manager processes the mouse enter event
78 /// It happens if the current operation is an internal edit operation.
79 /// The operation is restarted. If the first widget of the started operation is
80 /// the point 2d, it processes this mouse event
81 /// \return true if operation is committed.
82 bool processMouseReleased(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
84 /// It is called by the current operation filling with the preselection.
85 /// Returns false if the reentrant mode of the operation is not empty.
86 bool canBeCommittedByPreselection();
89 /// SLOT, that is called by a widget activating in the property panel
90 /// If the 'internal' edit operation is started, it activates the first widget selection
91 void onWidgetActivated();
93 /// SLOT, that is called by no more widget signal emitted by property panel
94 /// Start an internal edit operation or, if the internal flag is forbided, commits
95 /// the current operation
96 /// \param thePreviousAttributeID an index of the previous active attribute
97 void onNoMoreWidgets(const std::string& thePreviousAttributeID);
99 /// Processing of vertex selected. Set an internal reentrant flag to forbiddent state if
100 /// the current feature is a line and there are not obligate widgets anymore
101 void onVertexSelected();
103 /// SLOT, that is called by enter key released
104 /// Set a specific type of restarting the current operation to do not use the feature
105 /// for initialization of a new started operation.
106 void onEnterReleased();
109 /// Returns true if the current operation is a sketch or a nested sketch operation
110 bool isActiveMgr() const;
112 /// Sets the focus to the last control of the property panel and activates selection
113 /// of the first widget to can select first value of the next create operation
114 /// \param thePreviousAttributeID an index of the previous attribute to set focus to this widget
115 void startInternalEdit(const std::string& thePreviousAttributeID);
117 /// Commits the current operation and launches a new with the commited operation feature index
118 void restartOperation();
120 /// Breaks sequense of automatically resterted operations
123 /// Returns the workshop
124 XGUI_Workshop* workshop() const;
126 /// Returns the workshop module
127 PartSet_Module* module() const;
130 ModuleBase_IWorkshop* myWorkshop; /// the workshop
132 RestartingMode myRestartingMode; /// automatical restarting mode flag
133 bool myIsFlagsBlocked; /// true when reset of flags should not be perfromed
134 bool myIsInternalEditOperation; /// true when the 'internal' edit is started