Salome HOME
Update code documentation
[modules/shaper.git] / src / PartSet / PartSet_Module.h
index 7c90584b8548ce9914254f306e0c1f18acba31a8..529553713b4f43fc956cd2b287b9b2c89851de68 100644 (file)
@@ -1,16 +1,19 @@
+// 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_SketcherMgr.h"
 
 #include <ModuleBase_IModule.h>
 #include <ModuleBase_Definitions.h>
-#include <ModuleBase_ViewerFilters.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>
 class ModuleBase_Operation;
 class ModuleBase_IViewWindow;
 
+/**
+* \ingroup Module
+* Implementation of Partset module
+*/
 class PARTSET_EXPORT PartSet_Module : public ModuleBase_IModule
 {
 Q_OBJECT
 
- public:
+/// Enumeration to specify the restart operation properties.
+enum RestartingMode {
+  RM_None, /// the operation should not be restarted
+  RM_Forbided, /// the operation should not be restarted after there is no active widget
+  RM_LastFeatureUsed, /// the operation is restarted and use the previous feature for own initialization
+  RM_EmptyFeatureUsed /// the operation is restarted and does not use the previous feature
+};
+
+public:
+  /// Constructor
+  /// \param theWshop a pointer to a workshop
   PartSet_Module(ModuleBase_IWorkshop* theWshop);
   virtual ~PartSet_Module();
 
@@ -39,55 +56,62 @@ Q_OBJECT
   /// Call back forlast tuning of property panel before operation performance
   virtual void propertyPanelDefined(ModuleBase_Operation* theOperation);
 
-  QStringList sketchOperationIdList() const;
 
-protected slots:
-  /// Called when previous operation is finished
-  virtual void onOperationComitted(ModuleBase_Operation* theOperation);
+  /// 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);
 
-  virtual void onOperationAborted(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);
 
-  virtual void onOperationStarted(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);
 
-  virtual void onOperationStopped(ModuleBase_Operation* theOperation);
+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 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 key release in the viewer.
+  /// \param theWnd a view window
+  /// \param theEvent the key event
+  void onKeyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* 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 enter key released
+  /// 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);
 
+ protected:
   /// Register validators for this module
   virtual void registerValidators();
 
+  /// Register selection filters for this module
+  virtual void registerFilters();
+
  private slots:
-   void onVertexSelected(ObjectPtr theObject, const TopoDS_Shape& theShape);
+   /// Processing of vertex selected
+   void onVertexSelected();
 
  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();
 
@@ -95,15 +119,13 @@ protected slots:
    QString myLastOperationId;
    FeaturePtr myLastFeature;
 
-   bool myIsDragging;
-   bool myDragDone;
-
    // Automatical restarting mode flag
-   bool myRestartingMode;
+   RestartingMode myRestartingMode;
+
+  /// A filter which provides selection within a current document or whole PartSet
+  Handle(PartSet_GlobalFilter) myDocumentShapeFilter;
 
-   double myCurX, myCurY;
-   CompositeFeaturePtr myCurrentSketch;
-   QList<FeaturePtr> myEditingFeatures;
+  PartSet_SketcherMgr* mySketchMgr;
 };
 
 #endif