Salome HOME
Restore old planes selection definition
[modules/shaper.git] / src / PartSet / PartSet_OperationFeatureEditMulti.h
1 // File:        PartSet_OperationFeatureEditMulti.h
2 // Created:     05 May 2014
3 // Author:      Natalia ERMOLAEVA
4
5 #ifndef PartSet_OperationFeatureEditMulti_H
6 #define PartSet_OperationFeatureEditMulti_H
7
8 #include "PartSet.h"
9
10 #include <PartSet_OperationSketchBase.h>
11 #include <QObject>
12
13 class QMouseEvent;
14
15 /*!
16  \class PartSet_OperationFeatureEditMulti
17  * \brief The operation for the sketch feature creation
18 */
19 class PARTSET_EXPORT PartSet_OperationFeatureEditMulti : public PartSet_OperationSketchBase                                                 
20 {
21   Q_OBJECT
22   /// Struct to define gp point, with the state is the point is initialized
23   struct Point
24   {
25     /// Constructor
26     Point() {}
27     /// Constructor
28     /// \param thePoint the point
29     Point(gp_Pnt thePoint)
30     {
31       setPoint(thePoint);
32     }
33     ~Point() {}
34
35     /// clear the initialized flag.
36     void clear() { myIsInitialized = false; }
37     /// set the point and switch on the initialized flag
38     /// \param thePoint the point
39     void setPoint(const gp_Pnt& thePoint)
40     {
41       myIsInitialized = true;
42       myPoint = thePoint;
43     }
44
45     bool myIsInitialized; /// the state whether the point is set
46     gp_Pnt myPoint; /// the point
47   };
48
49 public:
50   /// Returns the operation type key
51   static std::string Type() { return "EditMulti"; }
52
53 public:
54   /// Constructor
55   /// \param theId the feature identifier
56   /// \param theParent the operation parent
57   /// \param theFeature the parent feature
58   PartSet_OperationFeatureEditMulti(const QString& theId, QObject* theParent,
59                             FeaturePtr theFeature);
60   /// Destructor
61   virtual ~PartSet_OperationFeatureEditMulti();
62
63   /// Returns that this operator can be started above already running one.
64   /// The runned operation should be the sketch feature modified operation
65   /// \param theOperation the previous running operation
66   virtual bool isGranted(ModuleBase_IOperation* theOperation) const;
67
68   /// Initializes the operation with previously created feature. It is used in sequental operations
69   virtual void initFeature(FeaturePtr theFeature);
70
71   /// Initialisation of operation with preliminary selection
72   /// \param theSelected the list of selected presentations
73   /// \param theHighlighted the list of highlighted presentations
74   virtual void initSelection(const std::list<ModuleBase_ViewerPrs>& theSelected,
75     const std::list<ModuleBase_ViewerPrs>& theHighlighted);
76
77   /// Returns the operation sketch feature
78   /// \returns the sketch instance
79   virtual FeaturePtr sketch() const;
80
81   /// Processes the mouse pressed in the point
82   /// \param theEvent the mouse event
83   /// \param theView a viewer to have the viewer the eye position
84   /// \param theSelected the list of selected presentations
85   /// \param theHighlighted the list of highlighted presentations
86   virtual void mousePressed(QMouseEvent* theEvent, Handle_V3d_View theView,
87                             const std::list<ModuleBase_ViewerPrs>& theSelected,
88                             const std::list<ModuleBase_ViewerPrs>& theHighlighted);
89   /// Gives the current mouse point in the viewer
90   /// \param theEvent the mouse event
91   /// \param theView a viewer to have the viewer the eye position
92   virtual void mouseMoved(QMouseEvent* theEvent, Handle_V3d_View theView);
93   /// Gives the current selected objects to be processed by the operation
94   /// \param thePoint a point clicked in the viewer
95   /// \param theEvent the mouse event
96   /// \param theSelected the list of selected presentations
97   /// \param theHighlighted the list of highlighted presentations
98  virtual void mouseReleased(QMouseEvent* theEvent, Handle_V3d_View theView,
99                             const std::list<ModuleBase_ViewerPrs>& theSelected,
100                             const std::list<ModuleBase_ViewerPrs>& theHighlighted);
101 protected:
102   /// \brief Virtual method called when operation is started
103   /// Virtual method called when operation started (see start() method for more description)
104   /// Switch off the multi selection state
105   virtual void startOperation();
106
107   /// Virtual method called when operation stopped - committed or aborted.
108   /// Restore the multi selection state
109   virtual void stopOperation();
110
111 protected:
112   /// Emits a signal about the selection blocking. Emits a signal to change the selection.
113   /// If the block is true, the signal clear selection, otherwise if restore selection flag allows,
114   /// the internal operation features are to be selected
115   /// \param isBlocked the state whether the operation is blocked or unblocked
116   /// \param isRestoreSelection the state whether the selected objects should be reselected
117   void blockSelection(bool isBlocked, const bool isRestoreSelection = true);
118
119   /// Sends the features
120   void sendFeatures();
121
122 private:
123   FeaturePtr mySketch; ///< the sketch feature
124   std::list<ModuleBase_ViewerPrs> myFeatures; ///< the features to apply the edit operation
125   Point myCurPoint; ///< the current 3D point clicked or moved
126   bool myIsBlockedSelection; ///< the state of the last state of selection blocked signal
127 };
128
129 #endif