Salome HOME
Merge branch 'Dev_1.1.0' of newgeom:newgeom into Dev_1.1.0
[modules/shaper.git] / src / PartSet / PartSet_Module.h
index 42619830db193a82ed69f8d5d594378e6e89e354..5264352dc98b0563d12877f826f862cce2cd67dd 100644 (file)
@@ -1,20 +1,23 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 #ifndef PartSet_Module_H
 #define PartSet_Module_H
 
 #include "PartSet.h"
-#include <PartSet_Filters.h>
+#include "PartSet_Filters.h"
+#include "PartSet_SketcherMgr.h"
 
 #include <ModuleBase_IModule.h>
 #include <ModuleBase_Definitions.h>
-#include <XGUI_Command.h>
 #include <ModelAPI_Feature.h>
 #include <ModelAPI_Attribute.h>
 #include <ModelAPI_CompositeFeature.h>
 
-#include <StdSelect_FaceFilter.hxx>
+//#include <StdSelect_FaceFilter.hxx>
 #include <TopoDS_Shape.hxx>
 
 #include <QMap>
+#include <QMenu>
 #include <QObject>
 
 #include <string>
 class ModuleBase_Operation;
 class ModuleBase_IViewWindow;
 
+class QAction;
+
+/**
+* \ingroup Modules
+* Implementation of Partset module
+*/
 class PARTSET_EXPORT PartSet_Module : public ModuleBase_IModule
 {
 Q_OBJECT
@@ -37,54 +46,87 @@ enum RestartingMode {
 };
 
 public:
+  /// Constructor
+  /// \param theWshop a pointer to a workshop
   PartSet_Module(ModuleBase_IWorkshop* theWshop);
   virtual ~PartSet_Module();
 
   /// Creates custom widgets for property panel
-  virtual QWidget* createWidgetByType(const std::string& theType, QWidget* theParent,
-                                      Config_WidgetAPI* theWidgetApi, std::string theParentId,
-                                      QList<ModuleBase_ModelWidget*>& theModelWidgets);
+  virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,
+                                                     Config_WidgetAPI* theWidgetApi, std::string theParentId);
 
   /// Call back forlast tuning of property panel before operation performance
   virtual void propertyPanelDefined(ModuleBase_Operation* theOperation);
 
-  QStringList sketchOperationIdList() const;
+
+  /// Realizes some functionality by an operation start
+  /// Displays all sketcher sub-Objects, hides sketcher result, appends selection filters
+  /// \param theOperation a started operation
+  virtual void operationStarted(ModuleBase_Operation* theOperation);
+
+  /// Realizes some functionality by an operation commit
+  /// Restarts sketcher operation automatically of it is necessary
+  /// \param theOperation a committed operation
+  virtual void operationCommitted(ModuleBase_Operation* theOperation);
+
+  /// Realizes some functionality by an operation abort
+  /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
+  /// \param theOperation an aborted operation
+  virtual void operationAborted(ModuleBase_Operation* theOperation);
+
+  /// Realizes some functionality by an operation stop
+  /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
+  /// \param theOperation a stopped operation
+  virtual void operationStopped(ModuleBase_Operation* theOperation);
+
+  /// Realizes some functionality by an operation start
+  /// \param theOperation a started operation
+  virtual ModuleBase_Operation* currentOperation() const;
+
+  /// Returns action according to the given ID
+  /// \param theId an action identifier, it should be uniqued in the bounds of the module
+  QAction* action(const QString& theId) const;
+
+  /// Returns True if there are available Undos and the sketch manager allows undo
+  /// \return the boolean result
+  virtual bool canUndo() const;
+
+  //! Returns True if there are available Redos and the sketch manager allows redo
+  /// \return the boolean result
+  virtual bool canRedo() const;
+
+  /// Returns whether the object can be displayed at the bounds of the active operation.
+  /// Display only current operation results for usual operation and ask the sketcher manager
+  /// if it is a sketch operation
+  /// \param theObject a model object
+  virtual bool canDisplayObject(const ObjectPtr& theObject) const;
+
+  /// Add menu atems for viewer into the given menu
+  /// \param theMenu a popup menu to be shown in the viewer
+  /// \param theStdActions a map of standard actions
+  /// \return true if items are added and there is no necessity to provide standard menu
+  virtual bool addViewerItems(QMenu* theMenu, const QMap<QString, QAction*>& theStdActions) const;
 
 public slots:
   /// SLOT, that is called by no more widget signal emitted by property panel
   /// Set a specific flag to restart the sketcher operation
   void onNoMoreWidgets();
 
-protected slots:
-  /// Called when previous operation is finished
-  virtual void onOperationComitted(ModuleBase_Operation* theOperation);
-
-  virtual void onOperationAborted(ModuleBase_Operation* theOperation);
+  /// Processes the context menu action click
+  /// \param isChecked a state of toggle if the action is checkable
+  void onAction(bool isChecked);
 
-  virtual void onOperationStarted(ModuleBase_Operation* theOperation);
-
-  virtual void onOperationStopped(ModuleBase_Operation* theOperation);
+  /// Slolt called on object display
+  /// \param theObject a data object
+  /// \param theAIS a presentation object
+  virtual void onObjectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS);
 
+protected slots:
   /// Called when previous operation is finished
   virtual void onSelectionChanged();
 
-  /// SLOT, that is called by mouse press in the viewer.
-  /// The mouse released point is sent to the current operation to be processed.
-  /// \param theEvent the mouse event
-  void onMousePressed(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
-
-  /// SLOT, that is called by mouse release in the viewer.
-  /// The mouse released point is sent to the current operation to be processed.
-  /// \param theEvent the mouse event
-  virtual void onMouseReleased(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
-  
-  /// SLOT, that is called by mouse move in the viewer.
-  /// The mouse moved point is sent to the current operation to be processed.
-  /// \param theEvent the mouse event
-  virtual void onMouseMoved(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
-
   /// SLOT, that is called by key release in the viewer.
-  /// The mouse moved point is sent to the current operation to be processed.
+  /// \param theWnd a view window
   /// \param theEvent the key event
   void onKeyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
 
@@ -92,48 +134,59 @@ protected slots:
   /// Set a specific type of restarting the current operation
   void onEnterReleased();
 
-  /// Launches the operation from current highlighting
-  void launchEditing();
+  /// SLOT, that is called by the current operation filling with the preselection.
+  /// It commits the operation of it is can be committed
+  void onOperationActivatedByPreselection();
 
  protected:
-  /// Returns new instance of operation object (used in createOperation for customization)
-  virtual ModuleBase_Operation* getNewOperation(const std::string& theFeatureId);
-
   /// Register validators for this module
   virtual void registerValidators();
 
+  /// Register selection filters for this module
+  virtual void registerFilters();
+
+  /// Register properties of this module
+  virtual void registerProperties();
+
  private slots:
-   void onVertexSelected(ObjectPtr theObject, const TopoDS_Shape& theShape);
+   /// Processing of vertex selected
+   void onVertexSelected();
 
-   void onPlaneSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
+   /// Called on transformation in current viewer
+   /// \param theTrsfType type of tranformation
+   void onViewTransformed(int theTrsfType = 2);
 
  private:
-   /// Converts mouse position to 2d coordinates. 
-   /// Member myCurrentSketch has to be correctly defined
-  void get2dPoint(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent, 
-                  double& theX, double& theY);
-
   /// Breaks sequense of automatically resterted operations
   void breakOperationSequence();
 
+  /// Create all actions for context menus. It is called on creation of module
+  /// Put the created actions into an internal map
+  void createActions();
+
+  /// Add action to the internal map
+  /// \param theId - string ID of the item
+  /// \param theAction - action to add
+  void addAction(const QString& theId, QAction* theAction);
+
+  //! Delete features
+  virtual bool deleteObjects();
+
  private:
    QString myLastOperationId;
    FeaturePtr myLastFeature;
 
-   bool myIsDragging;
-   bool myDragDone;
-
    // Automatical restarting mode flag
    RestartingMode myRestartingMode;
 
-   double myCurX, myCurY;
-   CompositeFeaturePtr myCurrentSketch;
-   QList<FeaturePtr> myEditingFeatures;
-   QList<AttributePtr> myEditingAttr;
-
-   Handle(ModuleBase_ShapeInPlaneFilter) myPlaneFilter;
   /// A filter which provides selection within a current document or whole PartSet
   Handle(PartSet_GlobalFilter) myDocumentShapeFilter;
+
+  PartSet_SketcherMgr* mySketchMgr;
+
+  QMap<QString, QAction*> myActions; // the popup menu actions
+
+  int myVisualLayerId;
 };
 
 #endif