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 "PartSet_Filters.h"
13 #include "PartSet_Tools.h"
15 #include <ModelAPI_Feature.h>
16 #include <ModelAPI_Attribute.h>
17 #include <ModelAPI_CompositeFeature.h>
18 #include <ModelAPI_Result.h>
20 #include <ModuleBase_ViewerFilters.h>
21 #include <ModuleBase_Definitions.h>
22 #include <ModuleBase_ModelWidget.h>
24 #include <GeomAPI_Pln.h>
25 #include <SelectMgr_IndexedMapOfOwner.hxx>
32 class ModuleBase_IViewWindow;
33 class ModuleBase_ModelWidget;
34 class ModuleBase_Operation;
35 class XGUI_OperationMgr;
42 * A class for management of sketch operations
43 At the time of the sketcher operation active, only the sketch sub-feature results are
44 displayed in the viewer. After the sketch create/edit operation is finished, the sub-feature
45 are hidden, the sketch feature result is displayed
47 class PARTSET_EXPORT PartSet_SketcherMgr : public QObject
50 /// Struct to define gp point, with the state is the point is initialized
56 myIsInitialized = false;
63 /// clear the initialized flag.
66 myIsInitialized = false;
68 /// set the point and switch on the initialized flag
69 /// \param thePoint the point
70 void setValue(const double theX, const double theY)
72 myIsInitialized = true;
77 bool myIsInitialized; /// the state whether the point is set
78 double myCurX, myCurY; /// the point coordinates
82 /// \param theModule a pointer to PartSet module
83 PartSet_SketcherMgr(PartSet_Module* theModule);
85 virtual ~PartSet_SketcherMgr();
87 /// Returns true if the operation is the sketch
88 /// \param theOperation an operation
89 /// \return the boolean result
90 static bool isSketchOperation(ModuleBase_Operation* theOperation);
92 /// Returns true if the operation id is in the sketch operation id list
93 /// \param theOperation an operation
94 /// \return the boolean result
95 static bool isNestedSketchOperation(ModuleBase_Operation* theOperation);
97 /// Returns true if the operation is a create nested feature one
98 /// \param theOperation a checked operation
99 //// \return boolean value
100 static bool isNestedCreateOperation(ModuleBase_Operation* theOperation);
102 /// Returns true if the operation is an edit nested feature one
103 /// \param theOperation a checked operation
104 //// \return boolean value
105 static bool isNestedEditOperation(ModuleBase_Operation* theOperation);
107 /// Returns whether the current operation is a sketch entity - line, point, arc or circle
108 /// \param theId is an id of object
109 /// \return a boolean value
110 static bool isEntity(const std::string& theId);
112 /// Returns whether the current operation is a sketch distance - lenght, distance or radius
113 /// \param theOperation the operation
114 /// \return a boolean value
115 static bool isDistanceOperation(ModuleBase_Operation* theOperation);
117 /// Returns whether the feature kind is a sketch distance - lenght, distance or radius
118 /// \param theKind the feature kind
119 /// \return a boolean value
120 static bool isDistanceKind(std::string& theKind);
122 /// Returns true if a mouse cursor is over viewer window
123 bool isMouseOverWindow() { return myIsMouseOverWindow; }
125 /// Returns current Sketch feature/ Returns NULL if there is no launched sketch operation
126 CompositeFeaturePtr activeSketch() const { return myCurrentSketch; }
128 /// Starts sketch operation
129 void startSketch(ModuleBase_Operation* );
131 /// Stops sketch operation
132 void stopSketch(ModuleBase_Operation* );
134 /// Starts sketch operation, connects to the opeation property panel
135 /// \param theOperation a committed operation
136 void startNestedSketch(ModuleBase_Operation* theOperation);
138 /// Stop sketch operation, disconnects from the opeation property panel
139 /// \param theOperation a stopped operation
140 void stopNestedSketch(ModuleBase_Operation* theOperation);
142 /// Visualizes the operation feature if it is a creation nested feature operation
143 /// \param theOperation a committed operation
144 void commitNestedSketch(ModuleBase_Operation* theOperation);
146 /// Append the sketch plane filter into the current viewer
147 /// \param toActivate state whether the filter should be activated/deactivated
148 void activatePlaneFilter(const bool& toActivate);
150 /// Commit the operation if it is possible. If the operation is dimention constraint,
151 /// it gives widget editor to input dimention value
152 void operationActivatedByPreselection();
154 /// Returns True if there are available Undos and the sketch manager allows undo
155 /// \return the boolean result
156 bool canUndo() const;
158 //! Returns True if there are available Redos and the sketch manager allows redo
159 /// \return the boolean result
160 bool canRedo() const;
162 /// Returns False only if the sketch creating feature can not be visualized.
163 /// \return a boolean value
164 //bool canCommitOperation() const;
166 /// Returns whether the object can be erased at the bounds of the active operation.
167 /// Sketch sub-entities can not be erased during the sketch operation
168 /// \param theObject a model object
169 bool canEraseObject(const ObjectPtr& theObject) const;
171 /// Returns whether the object can be displayed at the bounds of the active operation.
172 /// Display only current operation results for usual operation and ask the sketcher manager
173 /// if it is a sketch operation
174 /// \param theObject a model object
175 bool canDisplayObject(const ObjectPtr& theObject) const;
177 /// Returns whether the constraint object can be displayed. It depends on the sketch check
179 /// \param theObject a model object
180 /// \param theState the constraint visible state state to be checked
181 /// \param isProcessed an output parameter if it is processed
182 /// \return result value
183 bool canDisplayConstraint(const FeaturePtr& theObject,
184 const PartSet_Tools::ConstraintVisibleState& theState,
185 bool& isProcessed) const;
187 /// Check the given objects either there are some results of the current sketch. If so,
188 /// it suggests to delete them as there are no functionality to show back hidden sketch objects
189 /// \param theObjects a list of hidden objects
190 virtual void processHiddenObject(const std::list<ObjectPtr>& theObjects);
192 /// Returns true if the mouse is over viewer or property panel value is changed
193 /// \return boolean result
194 bool canDisplayCurrentCreatedFeature() const;
196 /// Returns true if the current operation is nested creation or internal reentrant edit
197 /// \param theOperation an operation
198 bool canChangeCursor(ModuleBase_Operation* theOperation) const;
200 /// Returns state of constraints showing flag
201 const QMap<PartSet_Tools::ConstraintVisibleState, bool>& showConstraintStates();
203 /// Returns true if the object is a current sketch sub feature of a result of the feature
204 /// \param theObject an object
205 /// \return boolean value
206 bool isObjectOfSketch(const ObjectPtr& theObject) const;
208 /// Saves the current selection in the viewer into an internal container
209 /// It obtains the selected attributes. The highlighted objects can be processes as the selected ones
210 /// \param theHighlightedOnly a boolean flag
211 void storeSelection(const bool theHighlightedOnly = false);
213 /// Restores previously saved selection state
214 void restoreSelection();
216 /// Return error state of the sketch feature, true if the error has happened
217 /// \return boolean value
218 bool sketchSolverError();
220 //! Returns the feature error if the current state of the feature in the sketch is not correct
221 //! If the feature is correct, it returns an empty value
222 //! Incorrect states: the feature is sketch, the solver error value
223 //! The feature value is reset, this is the flag of sketch mgr
224 //! \return string value
225 QString getFeatureError(const FeaturePtr& theFeature);
227 /// It nullify internal flags concerned to clicked mouse event
228 void clearClickedFlags();
230 /// Returns list of strings which contains id's of sketch operations
231 static const QStringList& sketchOperationIdList();
233 /// Returns list of strings which contains id's of constraints operations
234 static const QStringList& constraintsIdList();
236 /// Returns a list of modes, where the AIS objects should be activated
237 /// \param theModes a list of modes
238 static void sketchSelectionModes(QIntList& theModes);
240 /// Connects or disconnects to the value changed signal of the property panel widgets
241 /// \param theWidget a property contol widget
242 /// \param isToConnect a boolean value whether connect or disconnect
243 void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect);
245 /// Visualize the operation feature if the previous state is modified value in property panel
246 /// \param thePreviousState the previous widget value state
247 void widgetStateChanged(int thePreviousState);
250 /// Process sketch plane selected event
251 void onPlaneSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
253 /// Toggle show constraints
254 void onShowConstraintsToggle(int theType, bool theState);
257 /// Process the enter mouse to the view port. If the current operation is a create of
258 /// a nested sketch feature, it updates internal flags to display the feature on mouse move
259 void onEnterViewPort();
260 /// Process the leave mouse of the view port. If the current operation is a create of
261 /// a nested sketch feature, it hides the feature in the viewer
262 void onLeaveViewPort();
263 /// Listens to the value changed signal and display the current operation feature
264 void onBeforeValuesChangedInPropertyPanel();
265 /// Listens to the signal about the modification of the values have been done in the property panel
266 void onAfterValuesChangedInPropertyPanel();
268 void onMousePressed(ModuleBase_IViewWindow*, QMouseEvent*);
269 void onMouseReleased(ModuleBase_IViewWindow*, QMouseEvent*);
270 void onMouseMoved(ModuleBase_IViewWindow*, QMouseEvent*);
271 void onMouseDoubleClick(ModuleBase_IViewWindow*, QMouseEvent*);
272 void onApplicationStarted();
273 //void onBeforeWidgetActivated(ModuleBase_ModelWidget* theWidget);
275 void onBeforeContextMenu();
276 void onAfterContextMenu();
279 /// Launches the operation from current highlighting
280 void launchEditing();
282 /// Converts mouse position to 2d coordinates.
283 /// Member myCurrentSketch has to be correctly defined
284 void get2dPoint(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent,
287 typedef QMap<FeaturePtr, std::pair<std::set<AttributePtr>, std::set<ResultPtr> > >
288 FeatureToSelectionMap;
290 /// Obtains the current selection of the object in the workshop viewer
291 /// It includes the selection in all modes of activation, even local context - vertices, edges
292 /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
293 /// selection owners. If the owner is vertex, the corresponded attribute is seached in
294 /// the feature, if the owner is edge, the current result is added to the container of results.
295 /// \param theFeature a feature or result object
296 /// \param theSketch a current sketch feature
297 /// \param theWorkshop a workshop to have an access to AIS context and displayer
298 /// \param theSelection a container for the selection, to save results and attributres for a feature
299 static void getCurrentSelection(const FeaturePtr& theFeature,
300 const FeaturePtr& theSketch,
301 ModuleBase_IWorkshop* theWorkshop,
302 FeatureToSelectionMap& theSelection);
304 /// Applyes the current selection to the object in the workshop viewer
305 /// It includes the selection in all modes of activation, even local context - vertexes, edges
306 /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
307 /// selection owners. If the owner is vertex, the corresponded attribute is seached in
308 /// the feature and if it is in the container of selected attributes, the owner is put in the
309 /// out container. If the owner is edge and the current result is in the container of selected
310 /// results, the owner is put in the out container.
311 /// \param theFeature a feature or result object
312 /// \param theSketch a current sketch feature
313 /// \param theWorkshop a workshop to have an access to AIS context and displayer
314 /// \param theSelection a container of the selection, it has results and attributres for a feature
315 /// \param theOwnersToSelect an out container of found owners
316 static void getSelectionOwners(const FeaturePtr& theFeature,
317 const FeaturePtr& theSketch,
318 ModuleBase_IWorkshop* theWorkshop,
319 const FeatureToSelectionMap& theSelection,
320 SelectMgr_IndexedMapOfOwner& anOwnersToSelect);
322 /// Returns true if the created feature is visible
324 bool isVisibleCreatedFeature() const;
326 /// Returns a current operation
327 /// \return an operation
328 ModuleBase_Operation* getCurrentOperation() const;
330 /// Get the active widget in the property panel
331 ModuleBase_ModelWidget* getActiveWidget() const;
333 /// Erase or display the feature of the current operation. If the mouse over the active view or
334 /// a current value is changed by property panel, the feature is displayed otherwise it is hidden
335 /// \param theOperation an operation which feature is to be displayed, it is nested create operation
336 /// \param isToDisplay a flag about the display or erase the feature
337 void visualizeFeature(const FeaturePtr& theFeature, const bool isEditOperation,
338 const bool isToDisplay, const bool isFlushRedisplay = true);
341 /// Returns current workshop
342 XGUI_Workshop* workshop() const;
343 /// Returns operation manager
344 XGUI_OperationMgr* operationMgr() const;
347 PartSet_Module* myModule;
349 bool myPreviousDrawModeEnabled; // the previous selection enabled state in the viewer
352 bool myIsMouseOverWindow; /// the state that the mouse over the view
353 bool myIsMouseOverViewProcessed; /// the state whether the over view state is processed by mouseMove method
354 bool myIsPopupMenuActive; /// the state of the popup menu is shown
355 Point myCurrentPoint;
356 //Point myClickedPoint;
358 CompositeFeaturePtr myCurrentSketch;
360 Handle(PartSet_CirclePointFilter) myCirclePointFilter;
361 Handle(ModuleBase_ShapeInPlaneFilter) myPlaneFilter;
362 FeatureToSelectionMap myCurrentSelection;
363 bool myPreviousUpdateViewerEnabled;
365 QMap<PartSet_Tools::ConstraintVisibleState, bool> myIsConstraintsShown;