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 QMouseEvent;
  32
  33 /**
  34 * \ingroup Modules
  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
  39 */
  40 class PARTSET_EXPORT PartSet_SketcherMgr : public QObject
  41 {
  42   Q_OBJECT
  43   /// Struct to define gp point, with the state is the point is initialized
  44   struct Point
  45   {
  46     /// Constructor
  47     Point()
  48     {
  49       myIsInitialized = false;
  50     }
  51     /// Destructor
  52     ~Point()
  53     {
  54     }
  55
  56     /// clear the initialized flag.
  57     void clear()
  58     {
  59       myIsInitialized = false;
  60     }
  61     /// set the point and switch on the initialized flag
  62     /// \param thePoint the point
  63     void setValue(const double theX, const double theY)
  64     {
  65       myIsInitialized = true;
  66       myCurX = theX;
  67       myCurY = theY;
  68     }
  69
  70     bool myIsInitialized;  /// the state whether the point is set
  71     double myCurX, myCurY; /// the point coordinates
  72   };
  73 public:
  74   /// Constructor
  75   /// \param theModule a pointer to PartSet module
  76   PartSet_SketcherMgr(PartSet_Module* theModule);
  77
  78   virtual ~PartSet_SketcherMgr();
  79
  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);
  84
  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);
  89
  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);
  94
  95   /// Launches the operation from current highlighting
  96   void launchEditing();
  97
  98   /// Returns current Sketch feature/ Returns NULL if there is no launched sketch operation
  99   CompositeFeaturePtr activeSketch() const { return myCurrentSketch; }
 100
 101   /// Starts sketch operation
 102   void startSketch(ModuleBase_Operation* );
 103
 104   /// Stops sketch operation
 105   void stopSketch(ModuleBase_Operation* );
 106
 107   /// Starts sketch operation, connects to the opeation property panel
 108   /// \param theOperation a committed operation
 109   void startNestedSketch(ModuleBase_Operation* theOperation);
 110
 111   /// Stop sketch operation, disconnects from the opeation property panel
 112   /// \param theOperation a stopped operation
 113   void stopNestedSketch(ModuleBase_Operation* theOperation);
 114
 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);
 118
 119   /// Returns True if there are available Undos and the sketch manager allows undo
 120   /// \return the boolean result
 121   bool canUndo() const;
 122
 123   //! Returns True if there are available Redos and the sketch manager allows redo
 124   /// \return the boolean result
 125   bool canRedo() const;
 126
 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;
 132
 133 public slots:
 134   /// Process sketch plane selected event
 135   void onPlaneSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
 136
 137 private slots:
 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 to the value changed signal and display the current operation feature
 145   void onBeforeValuesChangedInPropertyPanel();
 146   /// Listens to the signal about values are to be changed in the property panel
 147   void onValuesChangedInPropertyPanel();
 148   /// Listens to the signal about the modification of the values have been done in the property panel
 149   void onAfterValuesChangedInPropertyPanel();
 150
 151   void onMousePressed(ModuleBase_IViewWindow*, QMouseEvent*);
 152   void onMouseReleased(ModuleBase_IViewWindow*, QMouseEvent*);
 153   void onMouseMoved(ModuleBase_IViewWindow*, QMouseEvent*);
 154   void onMouseDoubleClick(ModuleBase_IViewWindow*, QMouseEvent*);
 155   void onApplicationStarted();
 156   void onBeforeWidgetActivated(ModuleBase_ModelWidget* theWidget);
 157
 158 private:
 159   /// Returns list of strings which contains id's of sketch operations
 160   static QStringList sketchOperationIdList();
 161
 162   /// Converts mouse position to 2d coordinates.
 163   /// Member myCurrentSketch has to be correctly defined
 164   void get2dPoint(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent,
 165                   Point& thePoint);
 166
 167   typedef QList<AttributePtr> AttributeList;
 168   typedef QMap<FeaturePtr, AttributeList> FeatureToAttributesMap;
 169   typedef std::map<FeaturePtr, std::pair<std::set<AttributePtr>, std::set<ResultPtr> > >
 170                                                                        FeatureToSelectionMap;
 171   /// Obtains the current selection of the object in the workshop viewer by a map of feature to attributes
 172   /// It calls the next method for each feature
 173   /// \param theFeatureToAttributes a map of feature to attributes
 174   /// \param theSketch a current sketch feature
 175   /// \param theWorkshop a workshop to have an access to AIS context and displayer
 176   /// \param theSelection a container for the selection, to save results and attributres for a feature
 177   static void getCurrentSelection(const FeatureToAttributesMap& theFeatureToAttributes,
 178                                   const FeaturePtr& theSketch,
 179                                   ModuleBase_IWorkshop* theWorkshop,
 180                                   FeatureToSelectionMap& theSelection);
 181
 182   /// Obtains the current selection of the object in the workshop viewer
 183   /// It includes the selection in all modes of activation, even local context - vertices, edges
 184   /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
 185   /// selection owners. If the owner is vertex, the corresponded attribute is seached in
 186   /// the feature, if the owner is edge, the current result is added to the container of results.
 187   /// \param theFeature a feature or result object
 188   /// \param theSketch a current sketch feature
 189   /// \param theWorkshop a workshop to have an access to AIS context and displayer
 190   /// \param theSelection a container for the selection, to save results and attributres for a feature
 191   static void getCurrentSelection(const FeaturePtr& theFeature,
 192                                   const FeaturePtr& theSketch,
 193                                   ModuleBase_IWorkshop* theWorkshop,
 194                                   FeatureToSelectionMap& theSelection);
 195
 196   /// Applyes the current selection to the object in the workshop viewer
 197   /// It includes the selection in all modes of activation, even local context - vertexes, edges
 198   /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
 199   /// selection owners. If the owner is vertex, the corresponded attribute is seached in
 200   /// the feature and if it is in the container of selected attributes, the owner is put in the
 201   /// out container. If the owner is edge and the current result is in the container of selected
 202   /// results, the owner is put in the out container.
 203   /// \param theFeature a feature or result object
 204   /// \param theSketch a current sketch feature
 205   /// \param theWorkshop a workshop to have an access to AIS context and displayer
 206   /// \param theSelection a container of the selection, it has results and attributres for a feature
 207   /// \param theOwnersToSelect an out container of found owners
 208   static void getSelectionOwners(const FeaturePtr& theFeature,
 209                                   const FeaturePtr& theSketch,
 210                                   ModuleBase_IWorkshop* theWorkshop,
 211                                   const FeatureToSelectionMap& theSelection,
 212                                   SelectMgr_IndexedMapOfOwner& anOwnersToSelect);
 213
 214   /// Connects or disconnects to the value changed signal of the property panel widgets
 215   /// \param isToConnect a boolean value whether connect or disconnect
 216   void connectToPropertyPanel(const bool isToConnect);
 217
 218   /// Returns true if the created feature is visible
 219   /// \param
 220   bool isVisibleCreatedFeature() const;
 221
 222   /// Returns a current operation
 223   /// \return an operation
 224   ModuleBase_Operation* getCurrentOperation() const;
 225
 226   /// Returns true if the operation is a create nested feature one
 227   /// \param theOperation a checked operation
 228   //// \return boolean value
 229   bool isNestedCreateOperation(ModuleBase_Operation* theOperation) const;
 230
 231   /// Erase or display the feature of the current operation. If the mouse over the active view or
 232   /// a current value is changed by property panel, the feature is displayed otherwise it is hidden
 233   /// \param theOperation an operation which feature is to be displayed, it is nested create operation
 234   /// \param isToDisplay a flag about the display or erase the feature
 235   void visualizeFeature(ModuleBase_Operation* theOperation, const bool isToDisplay);
 236
 237   void storeSelection();
 238   void restoreSelection();
 239
 240 private:
 241   PartSet_Module* myModule;
 242
 243   bool myPreviousSelectionEnabled; // the previous selection enabled state in the viewer
 244   bool myIsDragging;
 245   bool myDragDone;
 246   bool myIsPropertyPanelValueChanged; /// the state that value in the property panel is changed
 247   bool myIsMouseOverWindow; /// the state that the mouse over the view
 248   bool myIsMouseOverViewProcessed; /// the state whether the over view state is processed by mouseMove method
 249   Point myCurrentPoint;
 250   Point myClickedPoint;
 251
 252   CompositeFeaturePtr myCurrentSketch;
 253
 254   FeatureToAttributesMap myFeature2AttributeMap; /// a map of a feature to attributes
 255
 256   Handle(ModuleBase_ShapeInPlaneFilter) myPlaneFilter;
 257   FeatureToSelectionMap myCurrentSelection;
 258   bool myPreviousUpdateViewerEnabled;
 259 };
 260
 261
 262 #endif