src/PartSet/PartSet_OperationSketchBase.h

   1 // File:        PartSet_OperationSketchBase.h
   2 // Created:     20 Apr 2014
   3 // Author:      Natalia ERMOLAEVA
   4
   5 #ifndef PartSet_OperationSketchBase_H
   6 #define PartSet_OperationSketchBase_H
   7
   8 #include "PartSet.h"
   9
  10 #include <TopoDS_Shape.hxx>
  11 #include <gp_Pnt.hxx>
  12 #include <NCollection_List.hxx>
  13
  14 #include <ModuleBase_Operation.h>
  15 #include <ModuleBase_Operation.h>
  16 #include <QObject>
  17
  18 #include <map>
  19
  20 class Handle_V3d_View;
  21 class QMouseEvent;
  22 class GeomAPI_Shape;
  23 class XGUI_ViewerPrs;
  24
  25 /*!
  26   \class PartSet_OperationSketchBase
  27   * \brief The base operation for the sketch features.
  28   *  Base class for all sketch operations. It provides an access to the feature preview
  29 */
  30 class PARTSET_EXPORT PartSet_OperationSketchBase : public ModuleBase_Operation
  31 {
  32   Q_OBJECT
  33 public:
  34   enum FeatureActionMode { FM_Activation, FM_Deactivation, FM_Abort };
  35
  36 public:
  37   /// Constructor
  38   /// \param theId an feature index
  39   /// \param theParent the object parent
  40   PartSet_OperationSketchBase(const QString& theId, QObject* theParent);
  41   /// Destructor
  42   virtual ~PartSet_OperationSketchBase();
  43
  44   /// Returns the feature preview shape
  45   /// \param theFeature the feature object to obtain the preview
  46   boost::shared_ptr<GeomAPI_Shape> preview(boost::shared_ptr<ModelAPI_Feature> theFeature) const;
  47
  48   /// Returns the map of the operation previews including the nested feature previews
  49   /// \return the map of feature to the feature preview
  50   virtual std::map<boost::shared_ptr<ModelAPI_Feature>, boost::shared_ptr<GeomAPI_Shape> > preview() 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(boost::shared_ptr<ModelAPI_Feature> theFeature) const = 0;
  56
  57   /// Initializes some fields accorging to the feature
  58   /// \param theFeature the feature
  59   /// \param thePresentations the list of additional presentations
  60   virtual void init(boost::shared_ptr<ModelAPI_Feature> theFeature,
  61                     const std::list<XGUI_ViewerPrs>& thePresentations) {}
  62
  63   /// Processes the mouse pressed in the point
  64   /// \param thePoint a point clicked in the viewer
  65   /// \param theEvent the mouse event
  66   virtual void mousePressed(QMouseEvent* theEvent, Handle_V3d_View theView);
  67
  68   /// Processes the mouse release in the point
  69   /// \param thePoint a point clicked in the viewer
  70   /// \param theEvent the mouse event
  71   /// \param theSelected the list of selected presentations
  72   virtual void mouseReleased(QMouseEvent* theEvent, Handle_V3d_View theView,
  73                              const std::list<XGUI_ViewerPrs>& theSelected);
  74
  75   /// Processes the mouse move in the point
  76   /// \param thePoint a 3D point clicked in the viewer
  77   /// \param theEvent the mouse event
  78   /// \param theSelected the list of selected presentations
  79   virtual void mouseMoved(QMouseEvent* theEvent, Handle_V3d_View theView,
  80                           const std::list<XGUI_ViewerPrs>& theSelected);
  81
  82   /// Processes the key pressed in the view
  83   /// \param theKey a key value
  84   virtual void keyReleased(const int theKey) {};
  85
  86 signals:
  87   /// Signal about the feature construing is finished
  88   /// \param theFeature the result feature
  89   /// \param theMode the mode of the feature modification
  90   void featureConstructed(boost::shared_ptr<ModelAPI_Feature> theFeature,
  91                           int theMode);
  92   /// signal about the request to launch operation
  93   /// theName the operation name
  94   /// theFeature the operation argument
  95   void launchOperation(std::string theName, boost::shared_ptr<ModelAPI_Feature> theFeature);
  96   /// signal to enable/disable multi selection in the viewer
  97   /// \param theEnabled the boolean state
  98   void multiSelectionEnabled(bool theEnabled);
  99
 100 protected:
 101   /// Creates an operation new feature
 102   /// In addition to the default realization it appends the created line feature to
 103   /// the sketch feature
 104   /// \returns the created feature
 105   virtual boost::shared_ptr<ModelAPI_Feature> createFeature();
 106 };
 107
 108 #endif