Salome HOME
Constraint icons added
[modules/shaper.git] / src / PartSet / PartSet_OperationFeatureCreate.h
1 // File:        PartSet_OperationFeatureCreate.h
2 // Created:     20 Apr 2014
3 // Author:      Natalia ERMOLAEVA
4
5 #ifndef PartSet_OperationFeatureCreate_H
6 #define PartSet_OperationFeatureCreate_H
7
8 #include "PartSet.h"
9
10 #include <PartSet_OperationSketchBase.h>
11 #include <PartSet_Constants.h>
12
13 #include <QObject>
14
15 class GeomDataAPI_Point2D;
16 class QMouseEvent;
17 class QKeyEvent;
18
19 /*!
20  \class PartSet_OperationFeatureCreate
21  * \brief The operation for the sketch feature creation
22  */
23 class PARTSET_EXPORT PartSet_OperationFeatureCreate : public PartSet_OperationSketchBase
24 {
25 Q_OBJECT
26
27  public:
28   /// Returns true if the feature with the given kind can be created by this operation
29   /// \param theId the feature kind
30   /// \return the boolean result
31   static bool canProcessKind(const std::string& theId);
32
33  public:
34   /// Constructor
35   /// \param theId the feature identifier
36   /// \param theParent the operation parent
37   /// \param theSketch the parent feature
38   PartSet_OperationFeatureCreate(const QString& theId, QObject* theParent, FeaturePtr theSketch);
39   /// Destructor
40   virtual ~PartSet_OperationFeatureCreate();
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(ObjectPtr theFeature) const;
46
47   /// Initializes the operation with previously created feature. It is used in sequental operations
48   virtual void initFeature(FeaturePtr theFeature);
49
50   /// Initialisation of operation with preliminary selection
51   /// \param theSelected the list of selected presentations
52   /// \param theHighlighted the list of highlighted presentations
53   virtual void initSelection(const std::list<ModuleBase_ViewerPrs>& theSelected,
54                              const std::list<ModuleBase_ViewerPrs>& theHighlighted);
55
56   /// Returns the operation sketch feature
57   /// \returns the sketch instance
58   virtual FeaturePtr sketch() const;
59
60   /// Gives the current selected objects to be processed by the operation
61   /// \param theEvent the mouse event
62   /// \param theView a viewer to have the viewer the eye position
63   /// \param theSelected the list of selected presentations
64   /// \param theHighlighted the list of highlighted presentations
65   virtual void mouseReleased(QMouseEvent* theEvent, Handle_V3d_View theView,
66                              const std::list<ModuleBase_ViewerPrs>& theSelected,
67                              const std::list<ModuleBase_ViewerPrs>& theHighlighted);
68   /// Gives the current mouse point in the viewer
69   /// \param thePoint a point clicked in the viewer
70   /// \param theEvent the mouse event
71   virtual void mouseMoved(QMouseEvent* theEvent, Handle_V3d_View theView);
72   /// Processes the key pressed in the view
73   /// \param theKey a key value
74   virtual void keyReleased(const int theKey);
75
76  public slots:
77   /// Slots which listen the mode widget activation
78   /// \param theWidget the model widget
79   virtual void onWidgetActivated(ModuleBase_ModelWidget* theWidget);
80
81  protected:
82   /// \brief Virtual method called when operation is started
83   /// Virtual method called when operation started (see start() method for more description)
84   /// After the parent operation body perform, set sketch feature to the created line feature
85   virtual void startOperation();
86
87   /// Virtual method called when operation aborted (see abort() method for more description)
88   /// Before the feature is aborted, it should be hidden from the viewer
89   virtual void abortOperation();
90
91   /// Virtual method called when operation stopped - committed or aborted.
92   /// Restore the multi selection state
93   virtual void stopOperation();
94
95   /// Virtual method called after operation committed (see commit() method for more description)
96   virtual void afterCommitOperation();
97
98   /// Creates an operation new feature
99   /// In addition to the default realization it appends the created line feature to
100   /// the sketch feature
101   /// \param theFlushMessage the flag whether the create message should be flushed
102   /// \returns the created feature
103   virtual FeaturePtr createFeature(const bool theFlushMessage = true);
104
105   /// Verifies whether this operator can be commited.
106   /// \return Returns TRUE if current operation can be committed, e.g. all parameters are filled
107   virtual bool canBeCommitted() const;
108
109  protected:
110   /// Set value to the active widget
111   /// \param theFeature the feature
112   /// \param theX the horizontal coordinate
113   /// \param theY the vertical coordinate
114   /// \return true if the point is set
115   bool setWidgetValue(ObjectPtr theFeature, double theX, double theY);
116
117  private:
118   FeaturePtr myInitFeature;  ///< the initial feature
119   FeaturePtr mySketch;  ///< the sketch of the feature
120
121   ModuleBase_ModelWidget* myActiveWidget;  ///< the active widget
122
123   std::list<ModuleBase_ViewerPrs> myPreSelection;
124 };
125
126 #endif