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,
  39                                  FeaturePtr theSketch);
  40   /// Destructor
  41   virtual ~PartSet_OperationFeatureCreate();
  42
  43   /// Verifies whether this operator can be commited.
  44   /// \return Returns TRUE if current operation can be committed, e.g. all parameters are filled
  45   virtual bool canBeCommitted() const;
  46
  47   /// Returns that this operator can be started above already running one.
  48    /// The runned operation should be the sketch feature modified operation
  49   /// \param theOperation the previous running operation
  50   virtual bool isGranted(ModuleBase_IOperation* theOperation) const;
  51
  52   /// Returns the operation local selection mode
  53   /// \param theFeature the feature object to get the selection mode
  54   /// \return the selection mode
  55   virtual std::list<int> getSelectionModes(FeaturePtr theFeature) const;
  56
  57   /// Initializes the operation with previously created feature. It is used in sequental operations
  58   virtual void initFeature(FeaturePtr theFeature);
  59
  60   /// Initialisation of operation with preliminary selection
  61   /// \param theSelected the list of selected presentations
  62   /// \param theHighlighted the list of highlighted presentations
  63   virtual void initSelection(const std::list<XGUI_ViewerPrs>& theSelected,
  64     const std::list<XGUI_ViewerPrs>& theHighlighted);
  65
  66   /// Returns the operation sketch feature
  67   /// \returns the sketch instance
  68   virtual FeaturePtr sketch() const;
  69
  70   /// Gives the current selected objects to be processed by the operation
  71   /// \param theEvent the mouse event
  72   /// \param theView a viewer to have the viewer the eye position
  73   /// \param theSelected the list of selected presentations
  74   /// \param theHighlighted the list of highlighted presentations
  75  virtual void mouseReleased(QMouseEvent* theEvent, Handle_V3d_View theView,
  76                             const std::list<XGUI_ViewerPrs>& theSelected,
  77                             const std::list<XGUI_ViewerPrs>& theHighlighted);
  78   /// Gives the current mouse point in the viewer
  79   /// \param thePoint a point clicked in the viewer
  80   /// \param theEvent the mouse event
  81   virtual void mouseMoved(QMouseEvent* theEvent, Handle_V3d_View theView);
  82   /// Processes the key pressed in the view
  83   /// \param theKey a key value
  84   virtual void keyReleased(const int theKey);
  85
  86   virtual void keyReleased(std::string theName, QKeyEvent* theEvent);
  87
  88 public slots:
  89   /// Slots which listen the mode widget activation
  90   /// \param theWidget the model widget
  91   virtual void onWidgetActivated(ModuleBase_ModelWidget* theWidget);
  92
  93 protected:
  94   /// \brief Virtual method called when operation is started
  95   /// Virtual method called when operation started (see start() method for more description)
  96   /// After the parent operation body perform, set sketch feature to the created line feature
  97   virtual void startOperation();
  98
  99   /// Virtual method called when operation aborted (see abort() method for more description)
 100   /// Before the feature is aborted, it should be hidden from the viewer
 101   virtual void abortOperation();
 102
 103   /// Virtual method called when operation stopped - committed or aborted.
 104   /// Restore the multi selection state
 105   virtual void stopOperation();
 106
 107   /// Virtual method called after operation committed (see commit() method for more description)
 108   virtual void afterCommitOperation();
 109
 110   /// Creates an operation new feature
 111   /// In addition to the default realization it appends the created line feature to
 112   /// the sketch feature
 113   /// \param theFlushMessage the flag whether the create message should be flushed
 114   /// \returns the created feature
 115   virtual FeaturePtr createFeature(const bool theFlushMessage = true);
 116
 117 protected:
 118   /// Set value to the active widget
 119   /// \param theFeature the feature
 120   /// \param theX the horizontal coordinate
 121   /// \param theY the vertical coordinate
 122   /// \return true if the point is set
 123   bool setWidgetValue(FeaturePtr theFeature, double theX, double theY);
 124
 125 private:
 126   FeaturePtr myInitFeature; ///< the initial feature
 127   FeaturePtr mySketch; ///< the sketch of the feature
 128
 129   ModuleBase_ModelWidget* myActiveWidget; ///< the active widget
 130 };
 131
 132 #endif