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 whethe the current operation is a sketch distance - lenght, distance or radius
91 /// \param the operation
92 /// \return a boolean value
93 static bool isDistanceOperation(ModuleBase_Operation* theOperation);
95 /// Launches the operation from current highlighting
98 /// Returns current Sketch feature/ Returns NULL if there is no launched sketch operation
99 CompositeFeaturePtr activeSketch() const { return myCurrentSketch; }
101 /// Starts sketch operation
102 void startSketch(ModuleBase_Operation* );
104 /// Stops sketch operation
105 void stopSketch(ModuleBase_Operation* );
107 /// Starts sketch operation, connects to the opeation property panel
108 /// \param theOperation a committed operation
109 void startNestedSketch(ModuleBase_Operation* theOperation);
111 /// Stop sketch operation, disconnects from the opeation property panel
112 /// \param theOperation a stopped operation
113 void stopNestedSketch(ModuleBase_Operation* theOperation);
115 /// Visualizes the operation feature if it is a creation nested feature operation
116 /// \param theOperation a committed operation
117 void commitNestedSketch(ModuleBase_Operation* theOperation);
119 /// Returns True if there are available Undos and the sketch manager allows undo
120 /// \return the boolean result
121 bool canUndo() const;
123 //! Returns True if there are available Redos and the sketch manager allows redo
124 /// \return the boolean result
125 bool canRedo() const;
127 /// Returns whether the object can be displayed at the bounds of the active operation.
128 /// Display only current operation results for usual operation and ask the sketcher manager
129 /// if it is a sketch operation
130 /// \param theObject a model object
131 bool canDisplayObject() const;
134 /// Process sketch plane selected event
135 void onPlaneSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
138 /// Process the enter mouse to the view port. If the current operation is a create of
139 /// a nested sketch feature, it updates internal flags to display the feature on mouse move
140 void onEnterViewPort();
141 /// Process the leave mouse of the view port. If the current operation is a create of
142 /// a nested sketch feature, it hides the feature in the viewer
143 void onLeaveViewPort();
144 /// Listens the value changed signal and display the current operation feature
145 void onValuesChangedInPropertyPanel();
147 void onMousePressed(ModuleBase_IViewWindow*, QMouseEvent*);
148 void onMouseReleased(ModuleBase_IViewWindow*, QMouseEvent*);
149 void onMouseMoved(ModuleBase_IViewWindow*, QMouseEvent*);
150 void onMouseDoubleClick(ModuleBase_IViewWindow*, QMouseEvent*);
151 void onApplicationStarted();
152 void onBeforeWidgetActivated(ModuleBase_ModelWidget* theWidget);
155 /// Returns list of strings which contains id's of sketch operations
156 static QStringList sketchOperationIdList();
158 /// Converts mouse position to 2d coordinates.
159 /// Member myCurrentSketch has to be correctly defined
160 void get2dPoint(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent,
163 typedef QList<AttributePtr> AttributeList;
164 typedef QMap<FeaturePtr, AttributeList> FeatureToAttributesMap;
165 typedef std::map<FeaturePtr, std::pair<std::set<AttributePtr>, std::set<ResultPtr> > >
166 FeatureToSelectionMap;
167 /// Obtains the current selection of the object in the workshop viewer by a map of feature to attributes
168 /// It calls the next method for each feature
169 /// \param theFeatureToAttributes a map of feature to attributes
170 /// \param theSketch a current sketch feature
171 /// \param theWorkshop a workshop to have an access to AIS context and displayer
172 /// \param theSelection a container for the selection, to save results and attributres for a feature
173 static void getCurrentSelection(const FeatureToAttributesMap& theFeatureToAttributes,
174 const FeaturePtr& theSketch,
175 ModuleBase_IWorkshop* theWorkshop,
176 FeatureToSelectionMap& theSelection);
178 /// Obtains the current selection of the object in the workshop viewer
179 /// It includes the selection in all modes of activation, even local context - vertices, edges
180 /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
181 /// selection owners. If the owner is vertex, the corresponded attribute is seached in
182 /// the feature, if the owner is edge, the current result is added to the container of results.
183 /// \param theFeature a feature or result object
184 /// \param theSketch a current sketch feature
185 /// \param theWorkshop a workshop to have an access to AIS context and displayer
186 /// \param theSelection a container for the selection, to save results and attributres for a feature
187 static void getCurrentSelection(const FeaturePtr& theFeature,
188 const FeaturePtr& theSketch,
189 ModuleBase_IWorkshop* theWorkshop,
190 FeatureToSelectionMap& theSelection);
192 /// Applyes the current selection to the object in the workshop viewer
193 /// It includes the selection in all modes of activation, even local context - vertexes, edges
194 /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
195 /// selection owners. If the owner is vertex, the corresponded attribute is seached in
196 /// the feature and if it is in the container of selected attributes, the owner is put in the
197 /// out container. If the owner is edge and the current result is in the container of selected
198 /// results, the owner is put in the out container.
199 /// \param theFeature a feature or result object
200 /// \param theSketch a current sketch feature
201 /// \param theWorkshop a workshop to have an access to AIS context and displayer
202 /// \param theSelection a container of the selection, it has results and attributres for a feature
203 /// \param theOwnersToSelect an out container of found owners
204 static void getSelectionOwners(const FeaturePtr& theFeature,
205 const FeaturePtr& theSketch,
206 ModuleBase_IWorkshop* theWorkshop,
207 const FeatureToSelectionMap& theSelection,
208 SelectMgr_IndexedMapOfOwner& anOwnersToSelect);
210 /// Connects or disconnects to the value changed signal of the property panel widgets
211 /// \param isToConnect a boolean value whether connect or disconnect
212 void connectToPropertyPanel(const bool isToConnect);
214 /// Returns true if the created feature is visible
216 bool isVisibleCreatedFeature() const;
218 /// Returns a current operation
219 /// \return an operation
220 ModuleBase_Operation* getCurrentOperation() const;
222 /// Returns true if the operation is a create nested feature one
223 /// \param theOperation a checked operation
224 //// \return boolean value
225 bool isNestedCreateOperation(ModuleBase_Operation* theOperation) const;
227 /// Erase or display the feature of the current operation. If the mouse over the active view or
228 /// a current value is changed by property panel, the feature is displayed otherwise it is hidden
229 /// \param theOperation an operation which feature is to be displayed, it is nested create operation
230 /// \param isToDisplay a flag about the display or erase the feature
231 void visualizeFeature(ModuleBase_Operation* theOperation, const bool isToDisplay);
234 PartSet_Module* myModule;
236 bool myPreviousSelectionEnabled; // the previous selection enabled state in the viewer
239 bool myIsPropertyPanelValueChanged; /// the state that value in the property panel is changed
240 bool myIsMouseOverWindow; /// the state that the mouse over the view
241 bool myIsMouseOverViewProcessed; /// the state whether the over view state is processed by mouseMove method
242 Point myCurrentPoint;
243 Point myClickedPoint;
245 CompositeFeaturePtr myCurrentSketch;
247 FeatureToAttributesMap myFeature2AttributeMap; /// a map of a feature to attributes
249 Handle(ModuleBase_ShapeInPlaneFilter) myPlaneFilter;