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>
20 #include <GeomAPI_Pln.h>
21 #include <SelectMgr_IndexedMapOfOwner.hxx>
28 class ModuleBase_IViewWindow;
29 class ModuleBase_ModelWidget;
30 class ModuleBase_Operation;
35 * A class for management of sketch operations
36 At the time of the sketcher operation active, only the sketch sub-feature results are
37 displayed in the viewer. After the sketch create/edit operation is finished, the sub-feature
38 are hidden, the sketch feature result is displayed
40 class PARTSET_EXPORT PartSet_SketcherMgr : public QObject
43 /// Struct to define gp point, with the state is the point is initialized
49 myIsInitialized = false;
56 /// clear the initialized flag.
59 myIsInitialized = false;
61 /// set the point and switch on the initialized flag
62 /// \param thePoint the point
63 void setValue(const double theX, const double theY)
65 myIsInitialized = true;
70 bool myIsInitialized; /// the state whether the point is set
71 double myCurX, myCurY; /// the point coordinates
75 /// \param theModule a pointer to PartSet module
76 PartSet_SketcherMgr(PartSet_Module* theModule);
78 virtual ~PartSet_SketcherMgr();
80 /// Returns true if the operation is the sketch
81 /// \param theOperation an operation
82 /// \return the boolean result
83 static bool isSketchOperation(ModuleBase_Operation* theOperation);
85 /// Returns true if the operation id is in the sketch operation id list
86 /// \param theOperation an operation
87 /// \return the boolean result
88 static bool isNestedSketchOperation(ModuleBase_Operation* theOperation);
90 /// Returns true if the operation is a create nested feature one
91 /// \param theOperation a checked operation
92 //// \return boolean value
93 static bool isNestedCreateOperation(ModuleBase_Operation* theOperation);
95 /// Returns whether the current operation is a sketch entity - line, point, arc or circle
96 /// \param the operation
97 /// \return a boolean value
98 static bool isEntityOperation(ModuleBase_Operation* theOperation);
100 /// Returns whether the current operation is a sketch distance - lenght, distance or radius
101 /// \param the operation
102 /// \return a boolean value
103 static bool isDistanceOperation(ModuleBase_Operation* theOperation);
105 /// Returns current Sketch feature/ Returns NULL if there is no launched sketch operation
106 CompositeFeaturePtr activeSketch() const { return myCurrentSketch; }
108 /// Starts sketch operation
109 void startSketch(ModuleBase_Operation* );
111 /// Stops sketch operation
112 void stopSketch(ModuleBase_Operation* );
114 /// Starts sketch operation, connects to the opeation property panel
115 /// \param theOperation a committed operation
116 void startNestedSketch(ModuleBase_Operation* theOperation);
118 /// Stop sketch operation, disconnects from the opeation property panel
119 /// \param theOperation a stopped operation
120 void stopNestedSketch(ModuleBase_Operation* theOperation);
122 /// Visualizes the operation feature if it is a creation nested feature operation
123 /// \param theOperation a committed operation
124 void commitNestedSketch(ModuleBase_Operation* theOperation);
126 /// Returns True if there are available Undos and the sketch manager allows undo
127 /// \return the boolean result
128 bool canUndo() const;
130 //! Returns True if there are available Redos and the sketch manager allows redo
131 /// \return the boolean result
132 bool canRedo() const;
134 /// Returns whether the object can be displayed at the bounds of the active operation.
135 /// Display only current operation results for usual operation and ask the sketcher manager
136 /// if it is a sketch operation
137 /// \param theObject a model object
138 bool canDisplayObject(const ObjectPtr& theObject) const;
140 /// Returns true if the current operation is sketch entity create operation
141 /// \param theValue the current auxiliary value
142 /// \return the boolean result
143 bool canSetAuxiliary(bool& theValue) const;
145 /// Changes the sketcher entity construction argument value
146 /// \param isChecked if true, the feature is a construction
147 void setAuxiliary(const bool isChecked);
150 bool isConstraintsShown() const { return myIsConstraintsShown; }
153 /// Returns list of strings which contains id's of sketch operations
154 static const QStringList& sketchOperationIdList();
156 /// Returns list of strings which contains id's of constraints operations
157 static const QStringList& constraintsIdList();
160 /// Process sketch plane selected event
161 void onPlaneSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
164 /// Process the enter mouse to the view port. If the current operation is a create of
165 /// a nested sketch feature, it updates internal flags to display the feature on mouse move
166 void onEnterViewPort();
167 /// Process the leave mouse of the view port. If the current operation is a create of
168 /// a nested sketch feature, it hides the feature in the viewer
169 void onLeaveViewPort();
170 /// Listens to the value changed signal and display the current operation feature
171 void onBeforeValuesChangedInPropertyPanel();
172 /// Listens to the signal about values are to be changed in the property panel
173 void onValuesChangedInPropertyPanel();
174 /// Listens to the signal about the modification of the values have been done in the property panel
175 void onAfterValuesChangedInPropertyPanel();
177 void onMousePressed(ModuleBase_IViewWindow*, QMouseEvent*);
178 void onMouseReleased(ModuleBase_IViewWindow*, QMouseEvent*);
179 void onMouseMoved(ModuleBase_IViewWindow*, QMouseEvent*);
180 void onMouseDoubleClick(ModuleBase_IViewWindow*, QMouseEvent*);
181 void onApplicationStarted();
182 void onBeforeWidgetActivated(ModuleBase_ModelWidget* theWidget);
184 void onBeforeContextMenu();
185 void onAfterContextMenu();
187 void onShowConstraintsToggle(bool);
190 /// Launches the operation from current highlighting
191 void launchEditing();
193 /// Converts mouse position to 2d coordinates.
194 /// Member myCurrentSketch has to be correctly defined
195 void get2dPoint(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent,
198 typedef QMap<FeaturePtr, std::pair<std::set<AttributePtr>, std::set<ResultPtr> > >
199 FeatureToSelectionMap;
201 /// Obtains the current selection of the object in the workshop viewer
202 /// It includes the selection in all modes of activation, even local context - vertices, edges
203 /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
204 /// selection owners. If the owner is vertex, the corresponded attribute is seached in
205 /// the feature, if the owner is edge, the current result is added to the container of results.
206 /// \param theFeature a feature or result object
207 /// \param theSketch a current sketch feature
208 /// \param theWorkshop a workshop to have an access to AIS context and displayer
209 /// \param theSelection a container for the selection, to save results and attributres for a feature
210 static void getCurrentSelection(const FeaturePtr& theFeature,
211 const FeaturePtr& theSketch,
212 ModuleBase_IWorkshop* theWorkshop,
213 FeatureToSelectionMap& theSelection);
215 /// Applyes the current selection to the object in the workshop viewer
216 /// It includes the selection in all modes of activation, even local context - vertexes, edges
217 /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
218 /// selection owners. If the owner is vertex, the corresponded attribute is seached in
219 /// the feature and if it is in the container of selected attributes, the owner is put in the
220 /// out container. If the owner is edge and the current result is in the container of selected
221 /// results, the owner is put in the out container.
222 /// \param theFeature a feature or result object
223 /// \param theSketch a current sketch feature
224 /// \param theWorkshop a workshop to have an access to AIS context and displayer
225 /// \param theSelection a container of the selection, it has results and attributres for a feature
226 /// \param theOwnersToSelect an out container of found owners
227 static void getSelectionOwners(const FeaturePtr& theFeature,
228 const FeaturePtr& theSketch,
229 ModuleBase_IWorkshop* theWorkshop,
230 const FeatureToSelectionMap& theSelection,
231 SelectMgr_IndexedMapOfOwner& anOwnersToSelect);
233 /// Connects or disconnects to the value changed signal of the property panel widgets
234 /// \param isToConnect a boolean value whether connect or disconnect
235 void connectToPropertyPanel(const bool isToConnect);
237 /// Returns true if the created feature is visible
239 bool isVisibleCreatedFeature() const;
241 /// Returns a current operation
242 /// \return an operation
243 ModuleBase_Operation* getCurrentOperation() const;
245 /// Erase or display the feature of the current operation. If the mouse over the active view or
246 /// a current value is changed by property panel, the feature is displayed otherwise it is hidden
247 /// \param theOperation an operation which feature is to be displayed, it is nested create operation
248 /// \param isToDisplay a flag about the display or erase the feature
249 void visualizeFeature(ModuleBase_Operation* theOperation, const bool isToDisplay);
251 /// Saves the current selection in the viewer into an internal container
252 /// It obtains the selected attributes. The highlighted objects can be processes as the selected ones
253 /// \param theHighlightedUse a boolean flag
254 void storeSelection(const bool theHighlightedOnly = false);
255 void restoreSelection();
258 PartSet_Module* myModule;
260 bool myPreviousSelectionEnabled; // the previous selection enabled state in the viewer
263 bool myIsPropertyPanelValueChanged; /// the state that value in the property panel is changed
264 bool myIsMouseOverWindow; /// the state that the mouse over the view
265 bool myIsMouseOverViewProcessed; /// the state whether the over view state is processed by mouseMove method
266 bool myIsPopupMenuActive; /// the state of the popup menu is shown
267 Point myCurrentPoint;
268 Point myClickedPoint;
270 CompositeFeaturePtr myCurrentSketch;
272 Handle(ModuleBase_ShapeInPlaneFilter) myPlaneFilter;
273 FeatureToSelectionMap myCurrentSelection;
274 bool myPreviousUpdateViewerEnabled;
276 bool myIsConstraintsShown;