src/PartSet/PartSet_OperationSketch.h

   1 // File:        PartSet_OperationSketch.h
   2 // Created:     20 Apr 2014
   3 // Author:      Natalia ERMOLAEVA
   4
   5 #ifndef PartSet_OperationSketch_H
   6 #define PartSet_OperationSketch_H
   7
   8 #include "PartSet.h"
   9
  10 #include <PartSet_OperationSketchBase.h>
  11 #include <QObject>
  12
  13 /*!
  14  \class PartSet_OperationSketch
  15  * \brief The operation for the sketch feature creation
  16 */
  17 class PARTSET_EXPORT PartSet_OperationSketch : public PartSet_OperationSketchBase
  18 {
  19   Q_OBJECT
  20 public:
  21   /// Returns the operation type key
  22   static std::string Type() { return "Sketch"; }
  23
  24 public:
  25   /// Constructor
  26   /// \param theId the feature identifier
  27   /// \param theParent the operation parent
  28   PartSet_OperationSketch(const QString& theId, QObject* theParent);
  29   /// Destructor
  30   virtual ~PartSet_OperationSketch();
  31
  32   /// Returns the operation local selection mode
  33   /// \param theFeature the feature object to get the selection mode
  34   /// \return the selection mode
  35   virtual std::list<int> getSelectionModes(boost::shared_ptr<ModelAPI_Feature> theFeature) const;
  36
  37   /// Returns the operation sketch feature
  38   /// \returns the sketch instance
  39   virtual boost::shared_ptr<ModelAPI_Feature> sketch() const;
  40
  41   /// Processes the mouse pressed in the point
  42   /// \param theEvent the mouse event
  43   /// \param theView a viewer to have the viewer the eye position
  44   /// \param theSelected the list of selected presentations
  45   /// \param theHighlighted the list of highlighted presentations
  46   virtual void mousePressed(QMouseEvent* theEvent, Handle_V3d_View theView,
  47                             const std::list<XGUI_ViewerPrs>& theSelected,
  48                             const std::list<XGUI_ViewerPrs>& theHighlighted);
  49   /// Gives the current mouse point in the viewer
  50   /// \param thePoint a point clicked in the viewer
  51   /// \param theEvent the mouse event
  52   virtual void mouseMoved(QMouseEvent* theEvent, Handle_V3d_View theView);
  53
  54   /// Returns the map of the operation previews including the nested feature previews
  55   /// \return the map of feature to the feature preview
  56   virtual std::map<boost::shared_ptr<ModelAPI_Feature>, boost::shared_ptr<GeomAPI_Shape> >
  57                                                                            subPreview() const;
  58
  59   /// Virtual method called when operation stopped - committed or aborted.
  60   /// Emits a signal to hide the preview of the operation
  61   virtual void stopOperation();
  62
  63   /// Returns whether the nested operations are enabled.
  64   /// The state can depend on the operation current state.
  65   /// It returns true after the sketch plane is choosen.
  66   /// \return enabled state
  67   virtual bool isNestedOperationsEnabled() const;
  68
  69 signals:
  70   /// signal about the sketch plane is selected
  71   /// \param theX the value in the X direction of the plane
  72   /// \param theX the value in the Y direction value of the plane
  73   /// \param theX the value in the Z direction of the plane
  74   void planeSelected(double theX, double theY, double theZ);
  75
  76 protected:
  77   /// Returns whether the sketch plane is set
  78   /// \return the boolean value whether the sketch is set
  79   bool hasSketchPlane() const;
  80
  81   /// Set the plane to the current sketch
  82   /// \param theShape the shape
  83   void setSketchPlane(const TopoDS_Shape& theShape);
  84
  85 private:
  86   std::list<XGUI_ViewerPrs> myFeatures; ///< the features to apply the edit operation
  87 };
  88
  89 #endif