Salome HOME
refs #30 - Sketch base GUI: create, draw lines
[modules/shaper.git] / src / PartSet / PartSet_OperationSketchLine.h
1 // File:        PartSet_OperationSketchLine.h
2 // Created:     20 Apr 2014
3 // Author:      Natalia ERMOLAEVA
4
5 #ifndef PartSet_OperationSketchLine_H
6 #define PartSet_OperationSketchLine_H
7
8 #include "PartSet.h"
9
10 #include <PartSet_OperationSketchBase.h>
11 #include <QObject>
12
13 class GeomDataAPI_Point2D;
14 class QMouseEvent;
15
16 /*!
17  \class PartSet_OperationSketchLine
18  * \brief The operation for the sketch feature creation
19 */
20 class PARTSET_EXPORT PartSet_OperationSketchLine : public PartSet_OperationSketchBase
21 {
22   Q_OBJECT
23
24 public:
25   /// Returns the operation type key
26   static std::string Type() { return "SketchLine"; }
27
28 public:
29   /// Constructor
30   /// \param theId the feature identifier
31   /// \param theParent the operation parent
32   /// \param theFeature the parent feature
33   PartSet_OperationSketchLine(const QString& theId, QObject* theParent,
34                               boost::shared_ptr<ModelAPI_Feature> theSketchFeature);
35   /// Destructor
36   virtual ~PartSet_OperationSketchLine();
37
38    /// Returns that this operator can be started above already running one.
39    /// The runned operation should be the sketch feature modified operation
40   virtual bool isGranted() const;
41
42   /// Returns the operation local selection mode
43   /// \param theFeature the feature object to get the selection mode
44   /// \return the selection mode
45   virtual std::list<int> getSelectionModes(boost::shared_ptr<ModelAPI_Feature> theFeature) const;
46
47   /// Initializes some fields accorging to the feature
48   /// \param theFeature the feature
49   virtual void init(boost::shared_ptr<ModelAPI_Feature> theFeature);
50
51   /// Gives the current selected objects to be processed by the operation
52   /// \param thePoint a point clicked in the viewer
53   /// \param theEvent the mouse event
54   /// \param theSelected the list of selected presentations
55  virtual void mouseReleased(QMouseEvent* theEvent, Handle_V3d_View theView,
56                              const std::list<XGUI_ViewerPrs>& theSelected);
57   /// Gives the current mouse point in the viewer
58   /// \param thePoint a point clicked in the viewer
59   /// \param theEvent the mouse event
60   virtual void mouseMoved(QMouseEvent* theEvent, Handle_V3d_View theView);
61   /// Processes the key pressed in the view
62   /// \param theKey a key value
63   virtual void keyReleased(const int theKey);
64
65 protected:
66   /// \brief Virtual method called when operation is started
67   /// Virtual method called when operation started (see start() method for more description)
68   /// After the parent operation body perform, set sketch feature to the created line feature
69   virtual void startOperation();
70
71   /// Virtual method called when operation aborted (see abort() method for more description)
72   /// Before the feature is aborted, it should be hidden from the viewer
73   virtual void abortOperation();
74
75   /// Creates an operation new feature
76   /// In addition to the default realization it appends the created line feature to
77   /// the sketch feature
78   /// \returns the created feature
79   virtual boost::shared_ptr<ModelAPI_Feature> createFeature();
80
81 protected:
82   /// \brief Save the point to the line.
83   /// \param thePoint the 3D point in the viewer
84   /// \param theAttribute the start or end attribute of the line
85   void setLinePoint(const gp_Pnt& thePoint, Handle(V3d_View) theView, const std::string& theAttribute);
86
87 protected:
88   ///< Structure to lists the possible types of point selection modes
89   enum PointSelectionMode {SM_FirstPoint, SM_SecondPoint};
90
91 private:
92   boost::shared_ptr<ModelAPI_Feature> mySketch; ///< the sketch feature
93   boost::shared_ptr<GeomDataAPI_Point2D> myInitPoint; ///< the first line point
94   PointSelectionMode myPointSelectionMode; ///< point selection mode
95 };
96
97 #endif