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;
38 class Handle_AIS_InteractiveObject;
44 * A class for management of sketch operations
45 At the time of the sketcher operation active, only the sketch sub-feature results are
46 displayed in the viewer. After the sketch create/edit operation is finished, the sub-feature
47 are hidden, the sketch feature result is displayed
49 class PARTSET_EXPORT PartSet_SketcherMgr : public QObject
52 /// Struct to define gp point, with the state is the point is initialized
58 myIsInitialized = false;
65 /// clear the initialized flag.
68 myIsInitialized = false;
70 /// set the point and switch on the initialized flag
71 /// \param thePoint the point
72 void setValue(const double theX, const double theY)
74 myIsInitialized = true;
79 bool myIsInitialized; /// the state whether the point is set
80 double myCurX, myCurY; /// the point coordinates
84 /// \param theModule a pointer to PartSet module
85 PartSet_SketcherMgr(PartSet_Module* theModule);
87 virtual ~PartSet_SketcherMgr();
89 /// Returns true if the operation is the sketch
90 /// \param theOperation an operation
91 /// \return the boolean result
92 static bool isSketchOperation(ModuleBase_Operation* theOperation);
94 /// Returns true if the operation feature is a sub in the given sketch
95 /// \param theOperation an operation
96 /// \param theSketch a sketch feature
97 /// \return the boolean result
98 static bool isNestedSketchOperation(ModuleBase_Operation* theOperation,
99 const CompositeFeaturePtr& theSketch);
101 /// Returns true if the operation is a create and nested sketch operationn
102 /// \param theOperation a checked operation
103 /// \param theSketch a sketch feature
104 //// \return boolean value
105 static bool isNestedCreateOperation(ModuleBase_Operation* theOperation,
106 const CompositeFeaturePtr& theSketch);
108 /// Returns true if the operation is an edit nested feature one
109 /// \param theOperation a checked operation
110 //// \return boolean value
111 static bool isNestedEditOperation(ModuleBase_Operation* theOperation,
112 const CompositeFeaturePtr& theSketch);
114 /// Returns whether the current operation is a sketch entity - line, point, arc or circle
115 /// \param theId is an id of object
116 /// \return a boolean value
117 static bool isEntity(const std::string& theId);
119 /// Returns whether the current operation is a sketch distance - lenght, distance or radius
120 /// \param theOperation the operation
121 /// \return a boolean value
122 static bool isDistanceOperation(ModuleBase_Operation* theOperation);
124 /// Returns whether the feature kind is a sketch distance - lenght, distance or radius
125 /// \param theKind the feature kind
126 /// \return a boolean value
127 static bool isDistanceKind(std::string& theKind);
129 /// Returns true if a mouse cursor is over viewer window
130 bool isMouseOverWindow() { return myIsMouseOverWindow; }
132 /// Returns current Sketch feature/ Returns NULL if there is no launched sketch operation
133 CompositeFeaturePtr activeSketch() const { return myCurrentSketch; }
135 /// Starts sketch operation
136 void startSketch(ModuleBase_Operation* );
138 /// Stops sketch operation
139 void stopSketch(ModuleBase_Operation* );
141 /// Starts sketch operation, connects to the opeation property panel
142 /// \param theOperation a committed operation
143 void startNestedSketch(ModuleBase_Operation* theOperation);
145 /// Stop sketch operation, disconnects from the opeation property panel
146 /// \param theOperation a stopped operation
147 void stopNestedSketch(ModuleBase_Operation* theOperation);
149 /// Visualizes the operation feature if it is a creation nested feature operation
150 /// \param theOperation a committed operation
151 void commitNestedSketch(ModuleBase_Operation* theOperation);
153 /// Append the sketch plane filter into the current viewer
154 /// \param toActivate state whether the filter should be activated/deactivated
155 void activatePlaneFilter(const bool& toActivate);
157 /// Commit the operation if it is possible. If the operation is dimention constraint,
158 /// it gives widget editor to input dimention value
159 /// \return true if the operation is stopped after activation
160 bool operationActivatedByPreselection();
162 /// Returns True if there are available Undos and the sketch manager allows undo
163 /// \return the boolean result
164 bool canUndo() const;
166 //! Returns True if there are available Redos and the sketch manager allows redo
167 /// \return the boolean result
168 bool canRedo() const;
170 /// Returns False only if the sketch creating feature can not be visualized.
171 /// \return a boolean value
172 //bool canCommitOperation() const;
174 /// Returns whether the object can be erased at the bounds of the active operation.
175 /// Sketch sub-entities can not be erased during the sketch operation
176 /// \param theObject a model object
177 bool canEraseObject(const ObjectPtr& theObject) const;
179 /// Returns whether the object can be displayed at the bounds of the active operation.
180 /// Display only current operation results for usual operation and ask the sketcher manager
181 /// if it is a sketch operation
182 /// \param theObject a model object
183 bool canDisplayObject(const ObjectPtr& theObject) const;
185 /// Returns whether the constraint object can be displayed. It depends on the sketch check
187 /// \param theObject a model object
188 /// \param theState the constraint visible state state to be checked
189 /// \param isProcessed an output parameter if it is processed
190 /// \return result value
191 bool canDisplayConstraint(const FeaturePtr& theObject,
192 const PartSet_Tools::ConstraintVisibleState& theState,
193 bool& isProcessed) const;
195 /// Check the given objects either there are some results of the current sketch. If so,
196 /// it suggests to delete them as there are no functionality to show back hidden sketch objects
197 /// \param theObjects a list of hidden objects
198 //virtual void processHiddenObject(const std::list<ObjectPtr>& theObjects);
200 /// Returns true if the mouse is over viewer or property panel value is changed
201 /// \return boolean result
202 bool canDisplayCurrentCreatedFeature() const;
204 /// Returns true if the current operation is nested creation or internal reentrant edit
205 /// \param theOperation an operation
206 bool canChangeCursor(ModuleBase_Operation* theOperation) const;
208 /// Returns state of constraints showing flag
209 const QMap<PartSet_Tools::ConstraintVisibleState, bool>& showConstraintStates();
211 /// Returns true if the object is a current sketch sub feature of a result of the feature
212 /// \param theObject an object
213 /// \return boolean value
214 bool isObjectOfSketch(const ObjectPtr& theObject) const;
216 /// Saves the current selection in the viewer into an internal container
217 /// It obtains the selected attributes. The highlighted objects can be processes as the selected ones
218 /// \param theHighlightedOnly a boolean flag
219 void storeSelection(const bool theHighlightedOnly = false);
221 /// Restores previously saved selection state
222 void restoreSelection();
224 /// Return error state of the sketch feature, true if the error has happened
225 /// \return boolean value
226 bool sketchSolverError();
228 //! Returns the feature error if the current state of the feature in the sketch is not correct
229 //! If the feature is correct, it returns an empty value
230 //! Incorrect states: the feature is sketch, the solver error value
231 //! The feature value is reset, this is the flag of sketch mgr
232 //! \return string value
233 QString getFeatureError(const FeaturePtr& theFeature);
235 /// It nullify internal flags concerned to clicked mouse event
236 void clearClickedFlags();
238 /// Returns list of strings which contains id's of sketch replication operations
239 static const QStringList& replicationsIdList();
241 /// Returns list of strings which contains id's of constraints operations
242 static const QStringList& constraintsIdList();
244 /// Returns a list of modes, where the AIS objects should be activated
245 /// \param theModes a list of modes
246 static void sketchSelectionModes(QIntList& theModes);
248 /// Create specific for the module presentation
249 /// \param theResult an object for presentation
250 /// \return created presentation or NULL(default value)
251 virtual Handle_AIS_InteractiveObject createPresentation(const ResultPtr& theResult);
253 /// Connects or disconnects to the value changed signal of the property panel widgets
254 /// \param theWidget a property contol widget
255 /// \param isToConnect a boolean value whether connect or disconnect
256 void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect);
258 /// Visualize the operation feature if the previous state is modified value in property panel
259 /// \param thePreviousState the previous widget value state
260 void widgetStateChanged(int thePreviousState);
262 /// If the current operation is a dimention one, the style of dimension visualization is send for
263 /// the current object
264 /// \param theObject an object to be customized
265 void customizePresentation(const ObjectPtr& theObject);
267 /// Update sketch presentations according to the the state
268 /// \param theType a type of sketch visualization style
269 /// \param theState a boolean state
270 void updateBySketchParameters(const PartSet_Tools::ConstraintVisibleState& theType,
274 /// Process sketch plane selected event
275 void onPlaneSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
278 /// Toggle show constraints
279 void onShowConstraintsToggle(int theType, bool theState);
280 /// Process the enter mouse to the view port. If the current operation is a create of
281 /// a nested sketch feature, it updates internal flags to display the feature on mouse move
282 void onEnterViewPort();
283 /// Process the leave mouse of the view port. If the current operation is a create of
284 /// a nested sketch feature, it hides the feature in the viewer
285 void onLeaveViewPort();
286 /// Listens to the value changed signal and display the current operation feature
287 void onBeforeValuesChangedInPropertyPanel();
288 /// Listens to the signal about the modification of the values have been done in the property panel
289 void onAfterValuesChangedInPropertyPanel();
291 void onMousePressed(ModuleBase_IViewWindow*, QMouseEvent*);
292 void onMouseReleased(ModuleBase_IViewWindow*, QMouseEvent*);
293 void onMouseMoved(ModuleBase_IViewWindow*, QMouseEvent*);
294 void onMouseDoubleClick(ModuleBase_IViewWindow*, QMouseEvent*);
295 void onApplicationStarted();
296 //void onBeforeWidgetActivated(ModuleBase_ModelWidget* theWidget);
298 void onBeforeContextMenu();
299 void onAfterContextMenu();
302 /// Launches the operation from current highlighting
303 void launchEditing();
305 /// Converts mouse position to 2d coordinates.
306 /// Member myCurrentSketch has to be correctly defined
307 void get2dPoint(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent,
310 /// Show distance value editor if it is a distance operation and all attribute references
311 /// are filled by preseletion
312 /// \return true if the value is accepted
313 static bool setDistanceValueByPreselection(ModuleBase_Operation* theOperation,
314 ModuleBase_IWorkshop* theWorkshop,
315 bool& theCanCommitOperation);
317 typedef QMap<FeaturePtr, std::pair<std::set<AttributePtr>, std::set<ResultPtr> > >
318 FeatureToSelectionMap;
320 /// Applyes the current selection to the object in the workshop viewer
321 /// It includes the selection in all modes of activation, even local context - vertexes, edges
322 /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
323 /// selection owners. If the owner is vertex, the corresponded attribute is seached in
324 /// the feature and if it is in the container of selected attributes, the owner is put in the
325 /// out container. If the owner is edge and the current result is in the container of selected
326 /// results, the owner is put in the out container.
327 /// \param theFeature a feature or result object
328 /// \param theSketch a current sketch feature
329 /// \param theWorkshop a workshop to have an access to AIS context and displayer
330 /// \param theSelection a container of the selection, it has results and attributres for a feature
331 /// \param theOwnersToSelect an out container of found owners
332 static void getSelectionOwners(const FeaturePtr& theFeature,
333 const FeaturePtr& theSketch,
334 ModuleBase_IWorkshop* theWorkshop,
335 const FeatureToSelectionMap& theSelection,
336 SelectMgr_IndexedMapOfOwner& anOwnersToSelect);
338 /// Returns true if the created feature is visible
340 bool isVisibleCreatedFeature() const;
342 /// Returns a current operation
343 /// \return an operation
344 ModuleBase_Operation* getCurrentOperation() const;
346 /// Get the active widget in the property panel
347 ModuleBase_ModelWidget* getActiveWidget() const;
349 /// Erase or display the feature of the current operation. If the mouse over the active view or
350 /// a current value is changed by property panel, the feature is displayed otherwise it is hidden
351 /// \param theOperation an operation which feature is to be displayed, it is nested create operation
352 /// \param isToDisplay a flag about the display or erase the feature
353 void visualizeFeature(const FeaturePtr& theFeature, const bool isEditOperation,
354 const bool isToDisplay, const bool isFlushRedisplay = true);
357 /// Updates selection priority of the presentation
358 /// \param theObject object to find a presentation which will be corrected
359 /// \param theFeature a feature of the presentation
360 void updateSelectionPriority(ObjectPtr theObject, FeaturePtr theFeature);
361 /// Returns current workshop
362 XGUI_Workshop* workshop() const;
363 /// Returns operation manager
364 XGUI_OperationMgr* operationMgr() const;
367 PartSet_Module* myModule;
369 bool myPreviousDrawModeEnabled; // the previous selection enabled state in the viewer
372 bool myIsMouseOverWindow; /// the state that the mouse over the view
373 bool myIsMouseOverViewProcessed; /// the state whether the over view state is processed by mouseMove method
374 bool myIsPopupMenuActive; /// the state of the popup menu is shown
375 Point myCurrentPoint;
376 //Point myClickedPoint;
378 CompositeFeaturePtr myCurrentSketch;
380 Handle(PartSet_CirclePointFilter) myCirclePointFilter;
381 Handle(ModuleBase_ShapeInPlaneFilter) myPlaneFilter;
382 FeatureToSelectionMap myCurrentSelection;
383 bool myPreviousUpdateViewerEnabled;
385 QMap<PartSet_Tools::ConstraintVisibleState, bool> myIsConstraintsShown;