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
  17 #include <XGUI_Constants.h>
  18 #include <XGUI_Displayer.h>
  19
  20 #include <QObject>
  21
  22 #include <AIS_InteractiveObject.hxx>
  23
  24 #include <map>
  25
  26 class Handle_V3d_View;
  27 class QMouseEvent;
  28 class GeomAPI_Shape;
  29 class ModuleBase_ViewerPrs;
  30
  31 /*!
  32  \class PartSet_OperationSketchBase
  33  * \brief The base operation for the sketch features.
  34  *  Base class for all sketch operations. It provides an access to the feature preview
  35  */
  36 class PARTSET_EXPORT PartSet_OperationSketchBase : public ModuleBase_Operation
  37 {
  38 Q_OBJECT
  39  public:
  40   enum FeatureActionMode
  41   {
  42     FM_Activation,
  43     FM_Deactivation,
  44     FM_Hide
  45   };
  46
  47  public:
  48   /// Constructor
  49   /// \param theId an feature index
  50   /// \param theParent the object parent
  51   PartSet_OperationSketchBase(const QString& theId, QObject* theParent);
  52   /// Destructor
  53   virtual ~PartSet_OperationSketchBase();
  54
  55   /// Returns the feature preview shape
  56   /// \param theFeature the feature object to obtain the preview
  57   static boost::shared_ptr<GeomAPI_Shape> preview(FeaturePtr theFeature);
  58
  59   /// Returns the list of the nested features
  60   /// \return the list of subfeatures
  61   virtual std::list<FeaturePtr> subFeatures() const;
  62
  63   /// Returns the operation local selection mode
  64   /// \param theFeature the feature object to get the selection mode
  65   /// \return the selection mode
  66   virtual std::list<int> getSelectionModes(ObjectPtr theFeature) const;
  67
  68   /// Initialisation of operation with preliminary selection
  69   /// \param theSelected the list of selected presentations
  70   /// \param theHighlighted the list of highlighted presentations
  71   virtual void initSelection(const std::list<ModuleBase_ViewerPrs>& theSelected,
  72                              const std::list<ModuleBase_ViewerPrs>& theHighlighted)
  73   {
  74   }
  75
  76   /// Returns the operation sketch feature
  77   /// \returns the sketch instance
  78   virtual FeaturePtr sketch() const = 0;
  79
  80   /// Processes the mouse pressed in the point
  81   /// \param theEvent the mouse event
  82   /// \param theView a viewer to have the viewer the eye position
  83   /// \param theSelected the list of selected presentations
  84   /// \param theHighlighted the list of highlighted presentations
  85   virtual void mousePressed(QMouseEvent* theEvent, Handle_V3d_View theView,
  86                             const std::list<ModuleBase_ViewerPrs>& theSelected,
  87                             const std::list<ModuleBase_ViewerPrs>& theHighlighted);
  88
  89   /// Processes the mouse release in the point
  90   /// \param theEvent the mouse event
  91   /// \param theView a viewer to have the viewer the eye position
  92   /// \param theSelected the list of selected presentations
  93   /// \param theHighlighted the list of highlighted presentations
  94   virtual void mouseReleased(QMouseEvent* theEvent, Handle_V3d_View theView,
  95                              const std::list<ModuleBase_ViewerPrs>& theSelected,
  96                              const std::list<ModuleBase_ViewerPrs>& theHighlighted);
  97
  98   /// Processes the mouse move in the point
  99   /// \param theEvent the mouse event
 100   /// \param theView a viewer to have the viewer the eye position
 101   virtual void mouseMoved(QMouseEvent* theEvent, Handle_V3d_View theView);
 102
 103   /// Processes the mouse double click in the point
 104   /// \param theEvent the mouse event
 105   /// \param theView a viewer to have the viewer the eye position
 106   /// \param theSelected the list of selected presentations
 107   /// \param theHighlighted the list of highlighted presentations
 108   virtual void mouseDoubleClick(QMouseEvent* theEvent, Handle_V3d_View theView,
 109                                 const std::list<ModuleBase_ViewerPrs>& theSelected,
 110                                 const std::list<ModuleBase_ViewerPrs>& theHighlighted);
 111
 112   /// Emits a signal about the operation start. This signal has an information about the feature.
 113   /// If the provided feature is empty, the current operation feature is used.
 114   /// \param theType a type of an operation started
 115   /// theFeature the operation argument
 116   void restartOperation(const std::string& theType, ObjectPtr theFeature = ObjectPtr());
 117
 118   /// If operation needs to redisplay its result during operation
 119   /// then this method has to return True
 120   virtual bool hasPreview() const { return true; }
 121
 122 signals:
 123   /// signal about the request to launch operation
 124   /// theName the operation name
 125   /// theFeature the operation argument
 126   void restartRequired(std::string theName, ObjectPtr theFeature);
 127
 128   /// Signal about the feature construing is finished
 129   /// \param theFeature the result feature
 130   /// \param theMode the mode of the feature modification
 131   void featureConstructed(ObjectPtr theFeature, int theMode);
 132
 133   /// Signal about the features should be selected
 134   /// \param theSelected the list of selected presentations
 135   void featureSelected(const std::list<ModuleBase_ViewerPrs>& theSelected);
 136
 137   /// signal to enable/disable multi selection in the viewer
 138   /// \param theEnabled the boolean state
 139   void multiSelectionEnabled(bool theEnabled);
 140
 141   /// signal to enable/disable selection in the viewer
 142   /// \param theFeatures a list of features to be disabled
 143   /// \param theToStop the boolean state whether it it stopped or non stopped
 144   void stopSelection(const QList<ObjectPtr>& theFeatures, const bool theToStop);
 145
 146   /// signal to set selection in the viewer
 147   /// \param theFeatures a list of features to be disabled
 148   void setSelection(const QList<ObjectPtr>& theFeatures);
 149
 150   /// signal to close the operation local context if it is opened
 151   void closeLocalContext();
 152
 153  protected:
 154   /// Creates an operation new feature
 155   /// In addition to the default realization it appends the created line feature to
 156   /// the sketch feature
 157   /// \param theFlushMessage the flag whether the create message should be flushed
 158   /// \returns the created feature
 159   virtual FeaturePtr createFeature(const bool theFlushMessage = true);
 160 };
 161
 162 #endif