src/PartSet/PartSet_SketcherMgr.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        PartSet_SketcherMgr.h
   4 // Created:     19 Dec 2014
   5 // Author:      Vitaly SMETANNIKOV
   6
   7 #ifndef PartSet_SketcherMgr_H
   8 #define PartSet_SketcherMgr_H
   9
  10 #include "PartSet.h"
  11
  12 #include <ModelAPI_Feature.h>
  13 #include <ModelAPI_Attribute.h>
  14 #include <ModelAPI_CompositeFeature.h>
  15 #include <ModelAPI_Result.h>
  16
  17 #include <ModuleBase_ViewerFilters.h>
  18 #include <ModuleBase_Definitions.h>
  19
  20 #include <GeomAPI_Pln.h>
  21 #include <SelectMgr_IndexedMapOfOwner.hxx>
  22
  23 #include <QObject>
  24 #include <QList>
  25 #include <QMap>
  26
  27 class PartSet_Module;
  28 class ModuleBase_IViewWindow;
  29 class ModuleBase_ModelWidget;
  30 class ModuleBase_Operation;
  31 class XGUI_OperationMgr;
  32 class QMouseEvent;
  33
  34 /**
  35 * \ingroup Modules
  36 * A class for management of sketch operations
  37   At the time of the sketcher operation active, only the sketch sub-feature results are
  38   displayed in the viewer. After the sketch create/edit operation is finished, the sub-feature
  39   are hidden, the sketch feature result is displayed
  40 */
  41 class PARTSET_EXPORT PartSet_SketcherMgr : public QObject
  42 {
  43   Q_OBJECT
  44   /// Struct to define gp point, with the state is the point is initialized
  45   struct Point
  46   {
  47     /// Constructor
  48     Point()
  49     {
  50       myIsInitialized = false;
  51     }
  52     /// Destructor
  53     ~Point()
  54     {
  55     }
  56
  57     /// clear the initialized flag.
  58     void clear()
  59     {
  60       myIsInitialized = false;
  61     }
  62     /// set the point and switch on the initialized flag
  63     /// \param thePoint the point
  64     void setValue(const double theX, const double theY)
  65     {
  66       myIsInitialized = true;
  67       myCurX = theX;
  68       myCurY = theY;
  69     }
  70
  71     bool myIsInitialized;  /// the state whether the point is set
  72     double myCurX, myCurY; /// the point coordinates
  73   };
  74 public:
  75   /// Constructor
  76   /// \param theModule a pointer to PartSet module
  77   PartSet_SketcherMgr(PartSet_Module* theModule);
  78
  79   virtual ~PartSet_SketcherMgr();
  80
  81   /// Returns true if the operation is the sketch
  82   /// \param theOperation an operation
  83   /// \return the boolean result
  84   static bool isSketchOperation(ModuleBase_Operation* theOperation);
  85
  86   /// Returns true if the operation id is in the sketch operation id list
  87   /// \param theOperation an operation
  88   /// \return the boolean result
  89   static bool isNestedSketchOperation(ModuleBase_Operation* theOperation);
  90
  91   /// Returns true if the operation is a create nested feature one
  92   /// \param theOperation a checked operation
  93   //// \return boolean value
  94   static bool isNestedCreateOperation(ModuleBase_Operation* theOperation);
  95
  96   /// Returns whether the current operation is a sketch entity - line, point, arc or circle
  97   /// \param theId is an id of object
  98   /// \return a boolean value
  99   static bool isEntity(const std::string& theId);
 100
 101   /// Returns whether the current operation is a sketch distance - lenght, distance or radius
 102   /// \param theOperation the operation
 103   /// \return a boolean value
 104   static bool isDistanceOperation(ModuleBase_Operation* theOperation);
 105
 106   /// Returns true if a mouse cursor is over viewer window
 107   bool isMouseOverWindow() { return myIsMouseOverWindow; }
 108
 109   /// Returns current Sketch feature/ Returns NULL if there is no launched sketch operation
 110   CompositeFeaturePtr activeSketch() const { return myCurrentSketch; }
 111
 112   /// Starts sketch operation
 113   void startSketch(ModuleBase_Operation* );
 114
 115   /// Stops sketch operation
 116   void stopSketch(ModuleBase_Operation* );
 117
 118   /// Starts sketch operation, connects to the opeation property panel
 119   /// \param theOperation a committed operation
 120   void startNestedSketch(ModuleBase_Operation* theOperation);
 121
 122   /// Stop sketch operation, disconnects from the opeation property panel
 123   /// \param theOperation a stopped operation
 124   void stopNestedSketch(ModuleBase_Operation* theOperation);
 125
 126   /// Visualizes the operation feature if it is a creation nested feature operation
 127   /// \param theOperation a committed operation
 128   void commitNestedSketch(ModuleBase_Operation* theOperation);
 129
 130   /// Returns True if there are available Undos and the sketch manager allows undo
 131   /// \return the boolean result
 132   bool canUndo() const;
 133
 134   //! Returns True if there are available Redos and the sketch manager allows redo
 135   /// \return the boolean result
 136   bool canRedo() const;
 137
 138   /// Returns False only if the sketch creating feature can not be visualized.
 139   /// \return a boolean value
 140   bool canCommitOperation() const;
 141
 142   /// Returns whether the object can be erased at the bounds of the active operation.
 143   /// Sketch sub-entities can not be erased during the sketch operation
 144   /// \param theObject a model object
 145   bool canEraseObject(const ObjectPtr& theObject) const;
 146
 147   /// Returns whether the object can be displayed at the bounds of the active operation.
 148   /// Display only current operation results for usual operation and ask the sketcher manager
 149   /// if it is a sketch operation
 150   /// \param theObject a model object
 151   bool canDisplayObject(const ObjectPtr& theObject) const;
 152
 153   /// Returns true if the mouse is over viewer or property panel value is changed
 154   /// \return boolean result
 155   bool canDisplayCurrentCreatedFeature() const;
 156
 157   /// Returns state of constraints showing flag
 158   bool isConstraintsShown() const { return myIsConstraintsShown; }
 159
 160   /// Returns true if the object is a current sketch sub feature of a result of the feature
 161   /// \param theObject an object
 162   /// \return boolean value
 163   bool isObjectOfSketch(const ObjectPtr& theObject) const;
 164
 165   /// Saves the current selection in the viewer into an internal container
 166   /// It obtains the selected attributes. The highlighted objects can be processes as the selected ones
 167   /// \param theHighlightedOnly a boolean flag
 168   void storeSelection(const bool theHighlightedOnly = false);
 169
 170   /// Restores previously saved selection state
 171   void restoreSelection();
 172
 173   /// Return error state of the sketch feature, true if the error has happened
 174   /// \return boolean value
 175   bool sketchSolverError();
 176
 177   //! Returns the feature error if the current state of the feature in the sketch is not correct
 178   //! If the feature is correct, it returns an empty value
 179   //! Incorrect states: the feature is sketch, the solver error value
 180   //! The feature value is reset, this is the flag of sketch mgr
 181   //! \return string value
 182   QString getFeatureError(const FeaturePtr& theFeature);
 183
 184   /// Returns list of strings which contains id's of sketch operations
 185   static const QStringList& sketchOperationIdList();
 186
 187   /// Returns list of strings which contains id's of constraints operations
 188   static const QStringList& constraintsIdList();
 189
 190   /// Returns a list of modes, where the AIS objects should be activated
 191   /// \param theModes a list of modes
 192   static void sketchSelectionModes(QIntList& theModes);
 193
 194 public slots:
 195   /// Process sketch plane selected event
 196   void onPlaneSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
 197
 198   /// Toggle show constraints
 199   void onShowConstraintsToggle(bool);
 200
 201 private slots:
 202   /// Process the enter mouse to the view port. If the current operation is a create of
 203   /// a nested sketch feature, it updates internal flags to display the feature on mouse move
 204   void onEnterViewPort();
 205   /// Process the leave mouse of the view port. If the current operation is a create of
 206   /// a nested sketch feature, it hides the feature in the viewer
 207   void onLeaveViewPort();
 208   /// Listens to the value changed signal and display the current operation feature
 209   void onBeforeValuesChangedInPropertyPanel();
 210   /// Listens to the signal about values are to be changed in the property panel
 211   void onValuesChangedInPropertyPanel();
 212   /// Listens to the signal about the modification of the values have been done in the property panel
 213   void onAfterValuesChangedInPropertyPanel();
 214
 215   void onMousePressed(ModuleBase_IViewWindow*, QMouseEvent*);
 216   void onMouseReleased(ModuleBase_IViewWindow*, QMouseEvent*);
 217   void onMouseMoved(ModuleBase_IViewWindow*, QMouseEvent*);
 218   void onMouseDoubleClick(ModuleBase_IViewWindow*, QMouseEvent*);
 219   void onApplicationStarted();
 220   void onBeforeWidgetActivated(ModuleBase_ModelWidget* theWidget);
 221
 222   void onBeforeContextMenu();
 223   void onAfterContextMenu();
 224
 225 private:
 226   /// Launches the operation from current highlighting
 227   void launchEditing();
 228
 229   /// Converts mouse position to 2d coordinates.
 230   /// Member myCurrentSketch has to be correctly defined
 231   void get2dPoint(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent,
 232                   Point& thePoint);
 233
 234   typedef QMap<FeaturePtr, std::pair<std::set<AttributePtr>, std::set<ResultPtr> > >
 235                                                                        FeatureToSelectionMap;
 236
 237   /// Obtains the current selection of the object in the workshop viewer
 238   /// It includes the selection in all modes of activation, even local context - vertices, edges
 239   /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
 240   /// selection owners. If the owner is vertex, the corresponded attribute is seached in
 241   /// the feature, if the owner is edge, the current result is added to the container of results.
 242   /// \param theFeature a feature or result object
 243   /// \param theSketch a current sketch feature
 244   /// \param theWorkshop a workshop to have an access to AIS context and displayer
 245   /// \param theSelection a container for the selection, to save results and attributres for a feature
 246   static void getCurrentSelection(const FeaturePtr& theFeature,
 247                                   const FeaturePtr& theSketch,
 248                                   ModuleBase_IWorkshop* theWorkshop,
 249                                   FeatureToSelectionMap& theSelection);
 250
 251   /// Applyes the current selection to the object in the workshop viewer
 252   /// It includes the selection in all modes of activation, even local context - vertexes, edges
 253   /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
 254   /// selection owners. If the owner is vertex, the corresponded attribute is seached in
 255   /// the feature and if it is in the container of selected attributes, the owner is put in the
 256   /// out container. If the owner is edge and the current result is in the container of selected
 257   /// results, the owner is put in the out container.
 258   /// \param theFeature a feature or result object
 259   /// \param theSketch a current sketch feature
 260   /// \param theWorkshop a workshop to have an access to AIS context and displayer
 261   /// \param theSelection a container of the selection, it has results and attributres for a feature
 262   /// \param theOwnersToSelect an out container of found owners
 263   static void getSelectionOwners(const FeaturePtr& theFeature,
 264                                   const FeaturePtr& theSketch,
 265                                   ModuleBase_IWorkshop* theWorkshop,
 266                                   const FeatureToSelectionMap& theSelection,
 267                                   SelectMgr_IndexedMapOfOwner& anOwnersToSelect);
 268
 269   /// Connects or disconnects to the value changed signal of the property panel widgets
 270   /// \param isToConnect a boolean value whether connect or disconnect
 271   void connectToPropertyPanel(const bool isToConnect);
 272
 273   /// Returns true if the created feature is visible
 274   /// \param
 275   bool isVisibleCreatedFeature() const;
 276
 277   /// Returns a current operation
 278   /// \return an operation
 279   ModuleBase_Operation* getCurrentOperation() const;
 280
 281   /// Erase or display the feature of the current operation. If the mouse over the active view or
 282   /// a current value is changed by property panel, the feature is displayed otherwise it is hidden
 283   /// \param theOperation an operation which feature is to be displayed, it is nested create operation
 284   /// \param isToDisplay a flag about the display or erase the feature
 285   void visualizeFeature(const FeaturePtr& theFeature, const bool isEditOperation,
 286                         const bool isToDisplay, const bool isFlushRedisplay = true);
 287 private:
 288   /// Gives a debug information about internal flags myIsMouseOverWindow and myIsResetCurrentValue
 289   /// \return a string value
 290   QString mouseOverWindowFlagsInfo() const;
 291
 292   XGUI_OperationMgr* operationMgr() const;
 293
 294 private:
 295   PartSet_Module* myModule;
 296
 297   bool myPreviousDrawModeEnabled; // the previous selection enabled state in the viewer
 298   bool myIsDragging;
 299   bool myDragDone;
 300   bool myIsResetCurrentValue; /// the state that value in the property panel is reset
 301   bool myIsMouseOverWindow; /// the state that the mouse over the view
 302   bool myIsMouseOverViewProcessed; /// the state whether the over view state is processed by mouseMove method
 303   bool myIsPopupMenuActive; /// the state of the popup menu is shown
 304   Point myCurrentPoint;
 305   Point myClickedPoint;
 306
 307   CompositeFeaturePtr myCurrentSketch;
 308
 309   Handle(ModuleBase_ShapeInPlaneFilter) myPlaneFilter;
 310   FeatureToSelectionMap myCurrentSelection;
 311   bool myPreviousUpdateViewerEnabled;
 312
 313   bool myIsConstraintsShown;
 314 };
 315
 316
 317 #endif