1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef PartSet_SketcherMgr_H
21 #define PartSet_SketcherMgr_H
25 #include "PartSet_PreviewSketchPlane.h"
26 #include "XGUI_SelectionFilterType.h"
27 #include "PartSet_Tools.h"
29 #include <ModelAPI_Feature.h>
30 #include <ModelAPI_Attribute.h>
31 #include <ModelAPI_CompositeFeature.h>
32 #include <ModelAPI_Result.h>
34 #include <ModuleBase_Definitions.h>
35 #include <ModuleBase_ModelWidget.h>
37 #include <GeomAPI_Pln.h>
39 #include <SelectMgr_IndexedMapOfOwner.hxx>
40 #include <SelectMgr_ListOfFilter.hxx>
42 #include <TopoDS_Shape.hxx>
43 #include <TopTools_MapOfShape.hxx>
52 class ModuleBase_IViewWindow;
53 class ModuleBase_ModelWidget;
54 class ModuleBase_Operation;
55 class XGUI_OperationMgr;
57 class PartSet_ExternalPointsMgr;
59 class AIS_InteractiveObject;
65 * A class for management of sketch operations
66 At the time of the sketcher operation active, only the sketch sub-feature results are
67 displayed in the viewer. After the sketch create/edit operation is finished, the sub-feature
68 are hidden, the sketch feature result is displayed
70 class PARTSET_EXPORT PartSet_SketcherMgr : public QObject
73 /// Struct to define gp point, with the state is the point is initialized
79 myIsInitialized = false;
86 /// clear the initialized flag.
89 myIsInitialized = false;
91 /// set the point and switch on the initialized flag
92 /// \param thePoint the point
93 void setValue(const double theX, const double theY)
95 myIsInitialized = true;
100 bool myIsInitialized; /// the state whether the point is set
101 double myCurX, myCurY; /// the point coordinates
105 /// Struct to define selection model information to store/restore selection
108 std::set<AttributePtr> myAttributes; /// the selected attributes
109 std::set<ResultPtr> myResults; /// the selected results
110 TopoDS_Shape myFirstResultShape; /// the first shape of feature result
111 TopTools_MapOfShape myLocalSelectedShapes; /// shapes of local selection
113 typedef QMap<FeaturePtr, SelectionInfo> FeatureToSelectionMap;
117 /// \param theModule a pointer to PartSet module
118 PartSet_SketcherMgr(PartSet_Module* theModule);
120 virtual ~PartSet_SketcherMgr();
122 /// Returns true if the operation is the sketch
123 /// \param theOperation an operation
124 /// \return the boolean result
125 static bool isSketchOperation(ModuleBase_Operation* theOperation);
127 /// Returns true if the operation feature belongs to list of granted features of Sketch
128 /// operation. An operation of a sketch should be started before.
129 /// \param theOperation an operation
130 /// \return the boolean result
131 bool isNestedSketchOperation(ModuleBase_Operation* theOperation) const;
133 /// Returns true if the feature kind belongs to list of granted features of Sketch
134 /// operation. An operation of a sketch should be started before.
135 /// \param theOperation an operation
136 /// \return the boolean result
137 bool isNestedSketchFeature(const QString& theFeatureKind) const;
139 /// Returns true if the operation is a create and nested sketch operationn
140 /// \param theOperation a checked operation
141 /// \param theSketch a sketch feature
142 //// \return boolean value
143 bool isNestedCreateOperation(ModuleBase_Operation* theOperation,
144 const CompositeFeaturePtr& /*theSketch*/) const;
146 /// Returns true if the operation is an edit nested feature one
147 /// \param theOperation a checked operation
148 //// \return boolean value
149 bool isNestedEditOperation(ModuleBase_Operation* theOperation,
150 const CompositeFeaturePtr& /*theSketch*/) const;
152 /// Returns whether the current operation is a sketch entity - line, point, arc or circle
153 /// \param theId is an id of object
154 /// \return a boolean value
155 static bool isEntity(const std::string& theId);
157 /// Returns whether the feature has external attribute filled with 'true' value
158 /// \param theFeature a feature object
159 /// \return a boolean value
160 static bool isExternalFeature(const FeaturePtr& theFeature);
162 /// Returns whether the current operation is a sketch distance - lenght, distance or radius
163 /// \param theOperation the operation
164 /// \return a boolean value
165 static bool isDistanceOperation(ModuleBase_Operation* theOperation);
167 /// Returns whether the feature kind is a sketch distance - lenght, distance or radius
168 /// \param theKind the feature kind
169 /// \return a boolean value
170 static bool isDistanceKind(std::string& theKind);
172 /// Returns true if a mouse cursor is over viewer window
173 bool isMouseOverWindow() { return myIsMouseOverWindow; }
175 /// Returns current Sketch feature/ Returns NULL if there is no launched sketch operation
176 CompositeFeaturePtr activeSketch() const { return myCurrentSketch; }
178 /// Returns help class to visualize sketcher plane
179 /// \return a preview plane
180 PartSet_PreviewSketchPlane* previewSketchPlane() const { return mySketchPlane; }
182 /// Starts sketch operation
183 void startSketch(ModuleBase_Operation* );
185 /// Stops sketch operation
186 void stopSketch(ModuleBase_Operation* );
188 /// Starts sketch operation, connects to the opeation property panel
189 /// \param theOperation a committed operation
190 void startNestedSketch(ModuleBase_Operation* theOperation);
192 /// Stop sketch operation, disconnects from the opeation property panel
193 /// \param theOperation a stopped operation
194 void stopNestedSketch(ModuleBase_Operation* theOperation);
196 /// Visualizes the operation feature if it is a creation nested feature operation
197 /// \param theOperation a committed operation
198 void commitNestedSketch(ModuleBase_Operation* theOperation);
200 /// Returns true if the filter is created by the sketch manager
201 /// \param theFilterType a checked type
202 /// \return boolean value
203 bool sketchSelectionFilter(const XGUI_SelectionFilterType theFilterType);
205 /// Append selection filter into the module and type of the filter in internal container
206 /// \param theFilterType selection filter type
207 /// \param theFilter added filter
208 void registerSelectionFilter(const XGUI_SelectionFilterType theFilterType,
209 const Handle(SelectMgr_Filter)& theFilter);
211 /// Commit the operation if it is possible. If the operation is dimention constraint,
212 /// it gives widget editor to input dimention value
213 /// \return true if the operation is stopped after activation
214 bool operationActivatedByPreselection();
216 /// Returns True if there are available Undos and the sketch manager allows undo
217 /// \return the boolean result
218 bool canUndo() const;
220 //! Returns True if there are available Redos and the sketch manager allows redo
221 /// \return the boolean result
222 bool canRedo() const;
224 /// Returns False only if the sketch creating feature can not be visualized.
225 /// \return a boolean value
226 //bool canCommitOperation() const;
228 /// Returns whether the object can be erased at the bounds of the active operation.
229 /// Sketch sub-entities can not be erased during the sketch operation
230 /// \param theObject a model object
231 bool canEraseObject(const ObjectPtr& theObject) const;
233 /// Returns whether the object can be displayed at the bounds of the active operation.
234 /// Display only current operation results for usual operation and ask the sketcher manager
235 /// if it is a sketch operation
236 /// \param theObject a model object
237 bool canDisplayObject(const ObjectPtr& theObject) const;
239 /// Returns whether the constraint object can be displayed. It depends on the sketch check
241 /// \param theObject a model object
242 /// \param theState the constraint visible state state to be checked
243 /// \param isProcessed an output parameter if it is processed
244 /// \return result value
245 bool canDisplayConstraint(const FeaturePtr& theObject,
246 const PartSet_Tools::ConstraintVisibleState& theState,
247 bool& isProcessed) const;
249 /// Check the given objects either there are some results of the current sketch. If so,
250 /// it suggests to delete them as there are no functionality to show back hidden sketch objects
251 /// \param theObjects a list of hidden objects
252 //virtual void processHiddenObject(const std::list<ObjectPtr>& theObjects);
254 /// Returns true if the mouse is over viewer or property panel value is changed
255 /// \return boolean result
256 bool canDisplayCurrentCreatedFeature() const;
258 /// Returns true if the current operation is nested creation or internal reentrant edit
259 /// \param theOperation an operation
260 bool canChangeCursor(ModuleBase_Operation* theOperation) const;
262 /// Returns state of constraints showing flag
263 const QMap<PartSet_Tools::ConstraintVisibleState, bool>& showConstraintStates();
265 /// Returns true if the object is a current sketch sub feature of a result of the feature
266 /// \param theObject an object
267 /// \return boolean value
268 bool isObjectOfSketch(const ObjectPtr& theObject) const;
270 /// Enumeration for selection mode used
272 ST_HighlightType, /// Only highlighted objects
273 ST_SelectType, /// Only selected objects
274 ST_SelectAndHighlightType /// Both, highlighted and selected objects
277 /// Saves the current selection in the viewer into an internal container
278 /// It obtains the selected attributes.
279 /// The highlighted objects can be processes as the selected ones
280 /// \param theHighlightedOnly a boolean flag
281 /// \param theCurrentSelection a container filled by the current selection
282 void storeSelection(const SelectionType theType, FeatureToSelectionMap& theCurrentSelection);
284 /// Restores previously saved selection state
285 /// \param theCurrentSelection a container filled by the current selection
286 void restoreSelection(FeatureToSelectionMap& theCurrentSelection);
288 /// Return error state of the sketch feature, true if the error has happened
289 /// \return boolean value
290 bool sketchSolverError();
292 //! Returns the feature error if the current state of the feature in the sketch is not correct
293 //! If the feature is correct, it returns an empty value
294 //! Incorrect states: the feature is sketch, the solver error value
295 //! The feature value is reset, this is the flag of sketch mgr
296 //! \return string value
297 QString getFeatureError(const FeaturePtr& theFeature);
299 /// It nullify internal flags concerned to clicked mouse event
300 void clearClickedFlags();
302 /// Returns list of strings which contains id's of sketch replication operations
303 static const QStringList& replicationsIdList();
305 /// Returns list of strings which contains id's of constraints operations
306 static const QStringList& constraintsIdList();
308 /// Returns a list of modes, where the AIS objects should be activated
309 /// \param theSketch a sketch object, modes are empty if sketch plane is not defined yet
310 /// \param theModes a list of modes
311 static void sketchSelectionModes(const CompositeFeaturePtr& theSketch, QIntList& theModes);
313 /// Create specific for the module presentation
314 /// \param theResult an object for presentation
315 /// \return created presentation or NULL(default value)
316 virtual Handle(AIS_InteractiveObject) createPresentation(const ResultPtr& theResult);
318 /// Connects or disconnects to the value changed signal of the property panel widgets
319 /// \param theWidget a property contol widget
320 /// \param isToConnect a boolean value whether connect or disconnect
321 void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect);
323 /// Visualize the operation feature if the previous state is modified value in property panel
324 /// \param thePreviousState the previous widget value state
325 void widgetStateChanged(int thePreviousState);
327 /// If the current operation is a dimention one, the style of dimension visualization is send for
328 /// the current object
329 /// \param theObject an object to be customized
330 void customizePresentation(const ObjectPtr& theObject);
332 /// Update sketch presentations according to the the state
333 /// \param theType a type of sketch visualization style
334 /// \param theState a boolean state
335 void updateBySketchParameters(const PartSet_Tools::ConstraintVisibleState& theType,
339 /// Process sketch plane selected event
340 void onPlaneSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
343 /// Toggle show constraints
344 void onShowConstraintsToggle(int theType, bool theState);
345 /// Process the enter mouse to the view port. If the current operation is a create of
346 /// a nested sketch feature, it updates internal flags to display the feature on mouse move
347 void onEnterViewPort();
348 /// Process the leave mouse of the view port. If the current operation is a create of
349 /// a nested sketch feature, it hides the feature in the viewer
350 void onLeaveViewPort();
351 /// Listens to the value changed signal and display the current operation feature
352 //void onBeforeValuesChangedInPropertyPanel();
353 /// Listens to the signal about the modification of the values
354 /// have been done in the property panel
355 //void onAfterValuesChangedInPropertyPanel();
357 void onMousePressed(ModuleBase_IViewWindow*, QMouseEvent*);
358 void onMouseReleased(ModuleBase_IViewWindow*, QMouseEvent*);
359 void onMouseMoved(ModuleBase_IViewWindow*, QMouseEvent*);
360 void onMouseDoubleClick(ModuleBase_IViewWindow*, QMouseEvent*);
361 void onApplicationStarted();
362 //void onBeforeWidgetActivated(ModuleBase_ModelWidget* theWidget);
364 void onBeforeContextMenu();
365 void onAfterContextMenu();
368 /// Launches the operation from current highlighting
369 void launchEditing();
371 /// Converts mouse position to 2d coordinates.
372 /// Member myCurrentSketch has to be correctly defined
373 void get2dPoint(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent,
376 /// Show distance value editor if it is a distance operation and all attribute references
377 /// are filled by preseletion
378 /// \return true if the value is accepted
379 static bool setDistanceValueByPreselection(ModuleBase_Operation* theOperation,
380 ModuleBase_IWorkshop* theWorkshop,
381 bool& theCanCommitOperation);
383 /// Applyes the current selection to the object in the workshop viewer
384 /// It includes the selection in all modes of activation, even local context - vertexes, edges
385 /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
386 /// selection owners. If the owner is vertex, the corresponded attribute is seached in
387 /// the feature and if it is in the container of selected attributes, the owner is put in the
388 /// out container. If the owner is edge and the current result is in the container of selected
389 /// results, the owner is put in the out container.
390 /// \param theFeature a feature or result object
391 /// \param theSketch a current sketch feature
392 /// \param theWorkshop a workshop to have an access to AIS context and displayer
393 /// \param theSelection a container of the selection, it has results and attributres for a feature
394 /// \param theOwnersToSelect an out container of found owners
395 static void getSelectionOwners(const FeaturePtr& theFeature,
396 const FeaturePtr& theSketch,
397 ModuleBase_IWorkshop* theWorkshop,
398 const FeatureToSelectionMap& theSelection,
399 SelectMgr_IndexedMapOfOwner& theOwnersToSelect);
401 /// Returns true if the created feature is visible
403 bool isVisibleCreatedFeature() const;
405 /// Returns a current operation
406 /// \return an operation
407 ModuleBase_Operation* getCurrentOperation() const;
409 /// Get the active widget in the property panel
410 ModuleBase_ModelWidget* getActiveWidget() const;
412 /// Erase or display the feature of the current operation. If the mouse over the active view or
413 /// a current value is changed by property panel, the feature is displayed otherwise it is hidden
414 /// \param theOperation an operation which feature is to be displayed,
415 /// it is nested create operation
416 /// \param isToDisplay a flag about the display or erase the feature
417 void visualizeFeature(const FeaturePtr& theFeature, const bool isEditOperation,
418 const bool isToDisplay, const bool isFlushRedisplay = true);
421 /// Updates selection priority of the presentation
422 /// \param theObject object to find a presentation which will be corrected
423 /// \param theFeature a feature of the presentation
424 void updateSelectionPriority(ObjectPtr theObject, FeaturePtr theFeature);
425 /// Returns current workshop
426 XGUI_Workshop* workshop() const;
427 /// Returns operation manager
428 XGUI_OperationMgr* operationMgr() const;
431 PartSet_Module* myModule;
432 PartSet_PreviewSketchPlane* mySketchPlane; // display/erase sketch plane on start/stop sketch
434 bool myPreviousDrawModeEnabled; // the previous selection enabled state in the viewer
435 bool myIsEditLaunching;
438 bool myIsMouseOverWindow; /// the state that the mouse over the view
439 /// the state whether the over view state is processed by mouseMove method
440 bool myIsMouseOverViewProcessed;
441 bool myIsPopupMenuActive; /// the state of the popup menu is shown
442 Point myCurrentPoint;
443 //Point myClickedPoint;
445 CompositeFeaturePtr myCurrentSketch;
447 std::set<XGUI_SelectionFilterType> mySelectionFilterTypes;
449 FeatureToSelectionMap myCurrentSelection;
450 bool myPreviousUpdateViewerEnabled;
452 QMap<PartSet_Tools::ConstraintVisibleState, bool> myIsConstraintsShown;
454 PartSet_ExternalPointsMgr* myExternalPointsMgr;