1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: PartSet_SketcherMgr.h
4 // Created: 19 Dec 2014
5 // Author: Vitaly SMETANNIKOV
7 #ifndef PartSet_SketcherMgr_H
8 #define PartSet_SketcherMgr_H
12 #include <ModelAPI_Feature.h>
13 #include <ModelAPI_Attribute.h>
14 #include <ModelAPI_CompositeFeature.h>
15 #include <ModelAPI_Result.h>
17 #include <ModuleBase_ViewerFilters.h>
18 #include <ModuleBase_Definitions.h>
19 #include <ModuleBase_ModelWidget.h>
21 #include <GeomAPI_Pln.h>
22 #include <SelectMgr_IndexedMapOfOwner.hxx>
29 class ModuleBase_IViewWindow;
30 class ModuleBase_ModelWidget;
31 class ModuleBase_Operation;
32 class XGUI_OperationMgr;
37 * A class for management of sketch operations
38 At the time of the sketcher operation active, only the sketch sub-feature results are
39 displayed in the viewer. After the sketch create/edit operation is finished, the sub-feature
40 are hidden, the sketch feature result is displayed
42 class PARTSET_EXPORT PartSet_SketcherMgr : public QObject
45 /// Struct to define gp point, with the state is the point is initialized
51 myIsInitialized = false;
58 /// clear the initialized flag.
61 myIsInitialized = false;
63 /// set the point and switch on the initialized flag
64 /// \param thePoint the point
65 void setValue(const double theX, const double theY)
67 myIsInitialized = true;
72 bool myIsInitialized; /// the state whether the point is set
73 double myCurX, myCurY; /// the point coordinates
77 /// \param theModule a pointer to PartSet module
78 PartSet_SketcherMgr(PartSet_Module* theModule);
80 virtual ~PartSet_SketcherMgr();
82 /// Returns true if the operation is the sketch
83 /// \param theOperation an operation
84 /// \return the boolean result
85 static bool isSketchOperation(ModuleBase_Operation* theOperation);
87 /// Returns true if the operation id is in the sketch operation id list
88 /// \param theOperation an operation
89 /// \return the boolean result
90 static bool isNestedSketchOperation(ModuleBase_Operation* theOperation);
92 /// Returns true if the operation is a create nested feature one
93 /// \param theOperation a checked operation
94 //// \return boolean value
95 static bool isNestedCreateOperation(ModuleBase_Operation* theOperation);
97 /// Returns whether the current operation is a sketch entity - line, point, arc or circle
98 /// \param theId is an id of object
99 /// \return a boolean value
100 static bool isEntity(const std::string& theId);
102 /// Returns whether the current operation is a sketch distance - lenght, distance or radius
103 /// \param theOperation the operation
104 /// \return a boolean value
105 static bool isDistanceOperation(ModuleBase_Operation* theOperation);
107 /// Returns true if a mouse cursor is over viewer window
108 bool isMouseOverWindow() { return myIsMouseOverWindow; }
110 /// Returns current Sketch feature/ Returns NULL if there is no launched sketch operation
111 CompositeFeaturePtr activeSketch() const { return myCurrentSketch; }
113 /// Starts sketch operation
114 void startSketch(ModuleBase_Operation* );
116 /// Stops sketch operation
117 void stopSketch(ModuleBase_Operation* );
119 /// Starts sketch operation, connects to the opeation property panel
120 /// \param theOperation a committed operation
121 void startNestedSketch(ModuleBase_Operation* theOperation);
123 /// Stop sketch operation, disconnects from the opeation property panel
124 /// \param theOperation a stopped operation
125 void stopNestedSketch(ModuleBase_Operation* theOperation);
127 /// Visualizes the operation feature if it is a creation nested feature operation
128 /// \param theOperation a committed operation
129 void commitNestedSketch(ModuleBase_Operation* theOperation);
131 /// Returns True if there are available Undos and the sketch manager allows undo
132 /// \return the boolean result
133 bool canUndo() const;
135 //! Returns True if there are available Redos and the sketch manager allows redo
136 /// \return the boolean result
137 bool canRedo() const;
139 /// Returns False only if the sketch creating feature can not be visualized.
140 /// \return a boolean value
141 //bool canCommitOperation() const;
143 /// Returns whether the object can be erased at the bounds of the active operation.
144 /// Sketch sub-entities can not be erased during the sketch operation
145 /// \param theObject a model object
146 bool canEraseObject(const ObjectPtr& theObject) const;
148 /// Returns whether the object can be displayed at the bounds of the active operation.
149 /// Display only current operation results for usual operation and ask the sketcher manager
150 /// if it is a sketch operation
151 /// \param theObject a model object
152 bool canDisplayObject(const ObjectPtr& theObject) const;
154 /// Returns true if the mouse is over viewer or property panel value is changed
155 /// \return boolean result
156 bool canDisplayCurrentCreatedFeature() const;
158 /// Returns true if the current operation is nested creation or internal reentrant edit
159 /// \param theOperation an operation
160 bool canChangeCursor(ModuleBase_Operation* theOperation) const;
162 /// Returns state of constraints showing flag
163 bool isConstraintsShown() const { return myIsConstraintsShown; }
165 /// Returns true if the object is a current sketch sub feature of a result of the feature
166 /// \param theObject an object
167 /// \return boolean value
168 bool isObjectOfSketch(const ObjectPtr& theObject) const;
170 /// Saves the current selection in the viewer into an internal container
171 /// It obtains the selected attributes. The highlighted objects can be processes as the selected ones
172 /// \param theHighlightedOnly a boolean flag
173 void storeSelection(const bool theHighlightedOnly = false);
175 /// Restores previously saved selection state
176 void restoreSelection();
178 /// Return error state of the sketch feature, true if the error has happened
179 /// \return boolean value
180 bool sketchSolverError();
182 //! Returns the feature error if the current state of the feature in the sketch is not correct
183 //! If the feature is correct, it returns an empty value
184 //! Incorrect states: the feature is sketch, the solver error value
185 //! The feature value is reset, this is the flag of sketch mgr
186 //! \return string value
187 QString getFeatureError(const FeaturePtr& theFeature, const bool isCheckGUI = true);
189 /// It nullify internal flags concerned to clicked mouse event
190 void clearClickedFlags();
192 /// Returns list of strings which contains id's of sketch operations
193 static const QStringList& sketchOperationIdList();
195 /// Returns list of strings which contains id's of constraints operations
196 static const QStringList& constraintsIdList();
198 /// Returns a list of modes, where the AIS objects should be activated
199 /// \param theModes a list of modes
200 static void sketchSelectionModes(QIntList& theModes);
202 /// Connects or disconnects to the value changed signal of the property panel widgets
203 /// \param theWidget a property contol widget
204 /// \param isToConnect a boolean value whether connect or disconnect
205 void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect);
207 /// Visualize the operation feature if the previous state is modified value in property panel
208 /// \param thePreviousState the previous widget value state
209 void widgetStateChanged(int thePreviousState);
212 /// Process sketch plane selected event
213 void onPlaneSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
215 /// Toggle show constraints
216 void onShowConstraintsToggle(bool);
219 /// Process the enter mouse to the view port. If the current operation is a create of
220 /// a nested sketch feature, it updates internal flags to display the feature on mouse move
221 void onEnterViewPort();
222 /// Process the leave mouse of the view port. If the current operation is a create of
223 /// a nested sketch feature, it hides the feature in the viewer
224 void onLeaveViewPort();
225 /// Listens to the value changed signal and display the current operation feature
226 void onBeforeValuesChangedInPropertyPanel();
227 /// Listens to the signal about the modification of the values have been done in the property panel
228 void onAfterValuesChangedInPropertyPanel();
230 void onMousePressed(ModuleBase_IViewWindow*, QMouseEvent*);
231 void onMouseReleased(ModuleBase_IViewWindow*, QMouseEvent*);
232 void onMouseMoved(ModuleBase_IViewWindow*, QMouseEvent*);
233 void onMouseDoubleClick(ModuleBase_IViewWindow*, QMouseEvent*);
234 void onApplicationStarted();
235 void onBeforeWidgetActivated(ModuleBase_ModelWidget* theWidget);
237 void onBeforeContextMenu();
238 void onAfterContextMenu();
241 /// Launches the operation from current highlighting
242 void launchEditing();
244 /// Converts mouse position to 2d coordinates.
245 /// Member myCurrentSketch has to be correctly defined
246 void get2dPoint(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent,
249 typedef QMap<FeaturePtr, std::pair<std::set<AttributePtr>, std::set<ResultPtr> > >
250 FeatureToSelectionMap;
252 /// Obtains the current selection of the object in the workshop viewer
253 /// It includes the selection in all modes of activation, even local context - vertices, edges
254 /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
255 /// selection owners. If the owner is vertex, the corresponded attribute is seached in
256 /// the feature, if the owner is edge, the current result is added to the container of results.
257 /// \param theFeature a feature or result object
258 /// \param theSketch a current sketch feature
259 /// \param theWorkshop a workshop to have an access to AIS context and displayer
260 /// \param theSelection a container for the selection, to save results and attributres for a feature
261 static void getCurrentSelection(const FeaturePtr& theFeature,
262 const FeaturePtr& theSketch,
263 ModuleBase_IWorkshop* theWorkshop,
264 FeatureToSelectionMap& theSelection);
266 /// Applyes the current selection to the object in the workshop viewer
267 /// It includes the selection in all modes of activation, even local context - vertexes, edges
268 /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
269 /// selection owners. If the owner is vertex, the corresponded attribute is seached in
270 /// the feature and if it is in the container of selected attributes, the owner is put in the
271 /// out container. If the owner is edge and the current result is in the container of selected
272 /// results, the owner is put in the out container.
273 /// \param theFeature a feature or result object
274 /// \param theSketch a current sketch feature
275 /// \param theWorkshop a workshop to have an access to AIS context and displayer
276 /// \param theSelection a container of the selection, it has results and attributres for a feature
277 /// \param theOwnersToSelect an out container of found owners
278 static void getSelectionOwners(const FeaturePtr& theFeature,
279 const FeaturePtr& theSketch,
280 ModuleBase_IWorkshop* theWorkshop,
281 const FeatureToSelectionMap& theSelection,
282 SelectMgr_IndexedMapOfOwner& anOwnersToSelect);
284 /// Returns true if the created feature is visible
286 bool isVisibleCreatedFeature() const;
288 /// Returns a current operation
289 /// \return an operation
290 ModuleBase_Operation* getCurrentOperation() const;
292 /// Get the active widget in the property panel
293 ModuleBase_ModelWidget* getActiveWidget() const;
295 /// Erase or display the feature of the current operation. If the mouse over the active view or
296 /// a current value is changed by property panel, the feature is displayed otherwise it is hidden
297 /// \param theOperation an operation which feature is to be displayed, it is nested create operation
298 /// \param isToDisplay a flag about the display or erase the feature
299 void visualizeFeature(const FeaturePtr& theFeature, const bool isEditOperation,
300 const bool isToDisplay, const bool isFlushRedisplay = true);
303 XGUI_OperationMgr* operationMgr() const;
306 PartSet_Module* myModule;
308 bool myPreviousDrawModeEnabled; // the previous selection enabled state in the viewer
311 bool myIsMouseOverWindow; /// the state that the mouse over the view
312 bool myIsMouseOverViewProcessed; /// the state whether the over view state is processed by mouseMove method
313 bool myIsPopupMenuActive; /// the state of the popup menu is shown
314 Point myCurrentPoint;
315 Point myClickedPoint;
317 CompositeFeaturePtr myCurrentSketch;
319 Handle(ModuleBase_ShapeInPlaneFilter) myPlaneFilter;
320 FeatureToSelectionMap myCurrentSelection;
321 bool myPreviousUpdateViewerEnabled;
323 bool myIsConstraintsShown;