Salome HOME
Create Presentation for rigid constraint
[modules/shaper.git] / src / PartSet / PartSet_OperationSketchBase.h
index de7c1ce03e4f647b1a7163f30bc55351c14718e9..c7d639348f858daae620f6403558e1f81e3f17a6 100644 (file)
+// File:        PartSet_OperationSketchBase.h
+// Created:     20 Apr 2014
+// Author:      Natalia ERMOLAEVA
+
 #ifndef PartSet_OperationSketchBase_H
 #define PartSet_OperationSketchBase_H
 
 #include "PartSet.h"
 
 #include <TopoDS_Shape.hxx>
+#include <gp_Pnt.hxx>
+#include <NCollection_List.hxx>
+
+#include <ModuleBase_Operation.h>
+#include <ModuleBase_Operation.h>
+
+#include <XGUI_Constants.h>
+#include <XGUI_Displayer.h>
 
-#include <ModuleBase_PropPanelOperation.h>
 #include <QObject>
 
+#include <AIS_InteractiveObject.hxx>
+
+#include <map>
+
+class Handle_V3d_View;
+class QMouseEvent;
+class GeomAPI_Shape;
+class ModuleBase_ViewerPrs;
+
 /*!
  \class PartSet_OperationSketchBase
  * \brief The base operation for the sketch features.
- *
  *  Base class for all sketch operations. It provides an access to the feature preview
-*/
-class PARTSET_EXPORT PartSet_OperationSketchBase : public ModuleBase_PropPanelOperation
+ */
+class PARTSET_EXPORT PartSet_OperationSketchBase : public ModuleBase_Operation
 {
 Q_OBJECT
-public:
+ public:
+  enum FeatureActionMode
+  {
+    FM_Activation,
+    FM_Deactivation,
+    FM_Hide
+  };
+
+ public:
+  /// Constructor
+  /// \param theId an feature index
+  /// \param theParent the object parent
   PartSet_OperationSketchBase(const QString& theId, QObject* theParent);
+  /// Destructor
   virtual ~PartSet_OperationSketchBase();
 
-  const TopoDS_Shape& preview() const;
+  /// Returns the feature preview shape
+  /// \param theFeature the feature object to obtain the preview
+  static boost::shared_ptr<GeomAPI_Shape> preview(FeaturePtr theFeature);
+
+  /// Returns the list of the nested features
+  /// \return the list of subfeatures
+  virtual std::list<FeaturePtr> subFeatures() const;
+
+  /// Returns the operation sketch feature
+  /// \returns the sketch instance
+  virtual CompositeFeaturePtr sketch() const = 0;
+
+  /// Processes the mouse pressed in the point
+  /// \param theEvent the mouse event
+  /// \param theView a viewer to have the viewer the eye position
+  /// \param theSelected the list of selected presentations
+  /// \param theHighlighted the list of highlighted presentations
+  virtual void mousePressed(QMouseEvent* theEvent, Handle_V3d_View theView,
+                            const std::list<ModuleBase_ViewerPrs>& theSelected,
+                            const std::list<ModuleBase_ViewerPrs>& theHighlighted);
+
+  /// Processes the mouse release in the point
+  /// \param theEvent the mouse event
+  /// \param theView a viewer to have the viewer the eye position
+  /// \param theSelected the list of selected presentations
+  /// \param theHighlighted the list of highlighted presentations
+  virtual void mouseReleased(QMouseEvent* theEvent, Handle_V3d_View theView,
+                             const std::list<ModuleBase_ViewerPrs>& theSelected,
+                             const std::list<ModuleBase_ViewerPrs>& theHighlighted);
+
+  /// Processes the mouse move in the point
+  /// \param theEvent the mouse event
+  /// \param theView a viewer to have the viewer the eye position
+  virtual void mouseMoved(QMouseEvent* theEvent, Handle_V3d_View theView);
+
+  /// Processes the mouse double click in the point
+  /// \param theEvent the mouse event
+  /// \param theView a viewer to have the viewer the eye position
+  /// \param theSelected the list of selected presentations
+  /// \param theHighlighted the list of highlighted presentations
+  virtual void mouseDoubleClick(QMouseEvent* theEvent, Handle_V3d_View theView,
+                                const std::list<ModuleBase_ViewerPrs>& theSelected,
+                                const std::list<ModuleBase_ViewerPrs>& theHighlighted);
+
+  /// Emits a signal about the operation start. This signal has an information about the feature.
+  /// If the provided feature is empty, the current operation feature is used.
+  /// \param theType a type of an operation started
+  /// theFeature the operation argument
+  void restartOperation(const std::string& theType, ObjectPtr theFeature = ObjectPtr());
+
+  /// If operation needs to redisplay its result during operation
+  /// then this method has to return True
+  virtual bool hasPreview() const { return true; }
 
 signals:
-  /**
-   * The signal about preview visualization.
-   * \param isDisplay a state whether the preview should be displayed or erased
-   */
-  void visualizePreview(bool isDisplay);
-
-protected:
-  virtual void startOperation();
-  virtual void stopOperation();
+  /// signal about the request to launch operation
+  /// theName the operation name
+  /// theFeature the operation argument
+  void restartRequired(std::string theName, ObjectPtr theFeature);
+
+  /// Signal about the feature construing is finished
+  /// \param theFeature the result feature
+  /// \param theMode the mode of the feature modification
+  void featureConstructed(ObjectPtr theFeature, int theMode);
+
+  /// Signal about the features should be selected
+  /// \param theSelected the list of selected presentations
+  void featureSelected(const std::list<ModuleBase_ViewerPrs>& theSelected);
+
+  /// signal to enable/disable multi selection in the viewer
+  /// \param theEnabled the boolean state
+  void multiSelectionEnabled(bool theEnabled);
+
+  /// signal to enable/disable selection in the viewer
+  /// \param theFeatures a list of features to be disabled
+  /// \param theToStop the boolean state whether it it stopped or non stopped
+  void stopSelection(const QList<ObjectPtr>& theFeatures, const bool theToStop);
+
+  /// signal to set selection in the viewer
+  /// \param theFeatures a list of features to be disabled
+  void setSelection(const QList<ObjectPtr>& theFeatures);
+
+ protected:
+  /// Creates an operation new feature
+  /// In addition to the default realization it appends the created line feature to
+  /// the sketch feature
+  /// \param theFlushMessage the flag whether the create message should be flushed
+  /// \returns the created feature
+  virtual FeaturePtr createFeature(const bool theFlushMessage = true);
+
+  /// Activates widgets by preselection if it is accepted
+  virtual void activateByPreselection();
 };
 
 #endif