Salome HOME
Merge branch 'MessagesGroups'
[modules/shaper.git] / src / PartSet / PartSet_OperationEditLine.h
1 // File:        PartSet_OperationEditLine.h
2 // Created:     05 May 2014
3 // Author:      Natalia ERMOLAEVA
4
5 #ifndef PartSet_OperationEditLine_H
6 #define PartSet_OperationEditLine_H
7
8 #include "PartSet.h"
9
10 #include <PartSet_OperationSketchBase.h>
11 #include <QObject>
12
13 class QMouseEvent;
14
15 /*!
16  \class PartSet_OperationEditLine
17  * \brief The operation for the sketch feature creation
18 */
19 class PARTSET_EXPORT PartSet_OperationEditLine : 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 "EditLine"; }
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_OperationEditLine(const QString& theId, QObject* theParent,
59                             boost::shared_ptr<ModelAPI_Feature> theFeature);
60   /// Destructor
61   virtual ~PartSet_OperationEditLine();
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   /// Returns the operation local selection mode
69   /// \param theFeature the feature object to get the selection mode
70   /// \return the selection mode
71   virtual std::list<int> getSelectionModes(boost::shared_ptr<ModelAPI_Feature> theFeature) const;
72
73   /// Initializes some fields accorging to the feature
74   /// \param theFeature the feature
75   /// \param thePresentations the list of additional presentations
76   virtual void init(boost::shared_ptr<ModelAPI_Feature> theFeature,
77                     const std::list<XGUI_ViewerPrs>& thePresentations);
78
79   /// Returns the operation sketch feature
80   /// \returns the sketch instance
81   virtual boost::shared_ptr<ModelAPI_Feature> sketch() const;
82
83   /// Processes the mouse pressed in the point
84   /// \param thePoint a point clicked in the viewer
85   /// \param theEvent the mouse event
86   virtual void mousePressed(QMouseEvent* theEvent, Handle_V3d_View theView);
87   /// Gives the current mouse point in the viewer
88   /// \param thePoint a point clicked in the viewer
89   /// \param theEvent the mouse event
90   virtual void mouseMoved(QMouseEvent* theEvent, Handle_V3d_View theView);
91   /// Gives the current selected objects to be processed by the operation
92   /// \param thePoint a point clicked in the viewer
93   /// \param theEvent the mouse event
94   /// \param theSelected the list of selected presentations
95  virtual void mouseReleased(QMouseEvent* theEvent, Handle_V3d_View theView,
96                             const std::list<XGUI_ViewerPrs>& theSelected);
97 protected:
98   /// \brief Virtual method called when operation is started
99   /// Virtual method called when operation started (see start() method for more description)
100   /// Switch off the multi selection state
101   virtual void startOperation();
102
103   /// Virtual method called when operation stopped - committed or aborted.
104   /// Restore the multi selection state
105   virtual void stopOperation();
106
107   /// Creates an operation new feature
108   /// Returns NULL feature. This is an operation of edition, not creation.
109   /// \param theFlushMessage the flag whether the create message should be flushed
110   /// \returns the created feature
111   virtual boost::shared_ptr<ModelAPI_Feature> createFeature(const bool theFlushMessage = true);
112
113 protected:
114   /// \brief Save the point to the line.
115   /// \param theFeature the source feature
116   /// \param theDeltaX the delta for X coordinate is moved
117   /// \param theDeltaY the delta for Y coordinate is moved
118   /// \param theAttribute the start or end attribute of the line
119   void  moveLinePoint(boost::shared_ptr<ModelAPI_Feature> theFeature,
120                       double theDeltaX, double theDeltaY,
121                       const std::string& theAttribute);
122   /// Sends the features
123   void sendFeatures();
124
125 private:
126   boost::shared_ptr<ModelAPI_Feature> mySketch; ///< the sketch feature
127   std::list<XGUI_ViewerPrs> myFeatures; ///< the features to apply the edit operation
128   Point myCurPoint; ///< the current 3D point clicked or moved
129   gp_Pnt myCurPressed; ///< the current 3D point clicked or moved
130 };
131
132 #endif