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
108 void startNestedSketch(ModuleBase_Operation* );
110 /// Stops sketch operation
111 void stopNestedSketch(ModuleBase_Operation* );
113 /// Returns True if there are available Undos and the sketch manager allows undo
114 /// \return the boolean result
115 bool canUndo() const;
117 //! Returns True if there are available Redos and the sketch manager allows redo
118 /// \return the boolean result
119 bool canRedo() const;
121 /// Returns whether the object can be displayed at the bounds of the active operation.
122 /// Display only current operation results for usual operation and ask the sketcher manager
123 /// if it is a sketch operation
124 /// \param theObject a model object
125 bool canDisplayObject(const ObjectPtr& theObject) const;
128 /// Process sketch plane selected event
129 void onPlaneSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
133 /// Process the enter mouse to the view port. If the current operation is a create of
134 /// a nested sketch feature, it updates internal flags to display the feature on mouse move
135 void onEnterViewPort();
136 /// Process the leave mouse of the view port. If the current operation is a create of
137 /// a nested sketch feature, it hides the feature in the viewer
138 void onLeaveViewPort();
140 void onValuesChangedInPropertyPanel();
141 void onMousePressed(ModuleBase_IViewWindow*, QMouseEvent*);
142 void onMouseReleased(ModuleBase_IViewWindow*, QMouseEvent*);
143 void onMouseMoved(ModuleBase_IViewWindow*, QMouseEvent*);
144 void onMouseDoubleClick(ModuleBase_IViewWindow*, QMouseEvent*);
145 void onApplicationStarted();
146 void onBeforeWidgetActivated(ModuleBase_ModelWidget* theWidget);
149 /// Returns list of strings which contains id's of sketch operations
150 static QStringList sketchOperationIdList();
152 /// Converts mouse position to 2d coordinates.
153 /// Member myCurrentSketch has to be correctly defined
154 void get2dPoint(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent,
157 typedef QList<AttributePtr> AttributeList;
158 typedef QMap<FeaturePtr, AttributeList> FeatureToAttributesMap;
159 typedef std::map<FeaturePtr, std::pair<std::set<AttributePtr>, std::set<ResultPtr> > >
160 FeatureToSelectionMap;
161 /// Obtains the current selection of the object in the workshop viewer by a map of feature to attributes
162 /// It calls the next method for each feature
163 /// \param theFeatureToAttributes a map of feature to attributes
164 /// \param theSketch a current sketch feature
165 /// \param theWorkshop a workshop to have an access to AIS context and displayer
166 /// \param theSelection a container for the selection, to save results and attributres for a feature
167 static void getCurrentSelection(const FeatureToAttributesMap& theFeatureToAttributes,
168 const FeaturePtr& theSketch,
169 ModuleBase_IWorkshop* theWorkshop,
170 FeatureToSelectionMap& theSelection);
172 /// Obtains the current selection of the object in the workshop viewer
173 /// It includes the selection in all modes of activation, even local context - vertices, edges
174 /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
175 /// selection owners. If the owner is vertex, the corresponded attribute is seached in
176 /// the feature, if the owner is edge, the current result is added to the container of results.
177 /// \param theFeature a feature or result object
178 /// \param theSketch a current sketch feature
179 /// \param theWorkshop a workshop to have an access to AIS context and displayer
180 /// \param theSelection a container for the selection, to save results and attributres for a feature
181 static void getCurrentSelection(const FeaturePtr& theFeature,
182 const FeaturePtr& theSketch,
183 ModuleBase_IWorkshop* theWorkshop,
184 FeatureToSelectionMap& theSelection);
186 /// Applyes the current selection to the object in the workshop viewer
187 /// It includes the selection in all modes of activation, even local context - vertexes, edges
188 /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
189 /// selection owners. If the owner is vertex, the corresponded attribute is seached in
190 /// the feature and if it is in the container of selected attributes, the owner is put in the
191 /// out container. If the owner is edge and the current result is in the container of selected
192 /// results, the owner is put in the out container.
193 /// \param theFeature a feature or result object
194 /// \param theSketch a current sketch feature
195 /// \param theWorkshop a workshop to have an access to AIS context and displayer
196 /// \param theSelection a container of the selection, it has results and attributres for a feature
197 /// \param theOwnersToSelect an out container of found owners
198 static void getSelectionOwners(const FeaturePtr& theFeature,
199 const FeaturePtr& theSketch,
200 ModuleBase_IWorkshop* theWorkshop,
201 const FeatureToSelectionMap& theSelection,
202 SelectMgr_IndexedMapOfOwner& anOwnersToSelect);
204 /// Connects or disconnects to the value changed signal of the property panel widgets
205 /// \param isToConnect a boolean value whether connect or disconnect
206 void connectToPropertyPanel(const bool isToConnect);
208 /// Returns true if the created feature is visible
210 bool isVisibleCreatedFeature() const;
212 /// Returns true if the current operation is create a nested feature
213 //// \return boolean value
214 bool isNestedCreateOperation() const;
216 /// Erase or display the feature of the current operation. If the mouse over the active view or
217 /// a current value is changed by property panel, the feature is displayed otherwise it is hidden
218 void updateVisibilityOfCreatedFeature();
221 PartSet_Module* myModule;
223 bool myPreviousSelectionEnabled; // the previous selection enabled state in the viewer
226 bool myIsPropertyPanelValueChanged; /// the state that value in the property panel is changed
227 bool myIsMouseOverWindow; /// the state that the mouse over the view
228 bool myIsMouseOverViewProcessed; /// the state whether the over view state is processed by mouseMove method
229 Point myCurrentPoint;
230 Point myClickedPoint;
232 CompositeFeaturePtr myCurrentSketch;
234 FeatureToAttributesMap myFeature2AttributeMap; /// a map of a feature to attributes
236 Handle(ModuleBase_ShapeInPlaneFilter) myPlaneFilter;