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