Salome HOME
Update code documentation
[modules/shaper.git] / src / PartSet / PartSet_Module.h
index a3a188ad0347ff9a10f376b7bc06d3f382f84928..529553713b4f43fc956cd2b287b9b2c89851de68 100644 (file)
+// 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 <StdSelect_FaceFilter.hxx>
+#include <ModelAPI_Attribute.h>
+#include <ModelAPI_CompositeFeature.h>
+
+//#include <StdSelect_FaceFilter.hxx>
+#include <TopoDS_Shape.hxx>
 
 #include <QMap>
 #include <QObject>
 
 #include <string>
 
-#include <boost/shared_ptr.hpp>
+#include <memory>
 
-class PartSet_Listener;
-class ModelAPI_Feature;
-class XGUI_ViewerPrs;
-class XGUI_Workshop;
 class ModuleBase_Operation;
-class GeomAPI_AISObject;
+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();
 
-  /// Reads description of features from XML file 
-  virtual void createFeatures();
-
-  /// Called on creation of menu item in desktop
-  virtual void featureCreated(QAction* theFeature);
-
-  std::string featureFile(const std::string&);
-
-  /// Creates an operation and send it to loop
-  /// \param theCmdId the operation name
-  //virtual void launchOperation(const QString& theCmdId);
-
-  /// Updates current operation preview, if it has it.
-  /// \param theCmdId the operation name
-  void updateCurrentPreview(const std::string& theCmdId);
-
   /// Creates custom widgets for property panel
   virtual QWidget* createWidgetByType(const std::string& theType, QWidget* theParent,
-                                      Config_WidgetAPI* theWidgetApi,
+                                      Config_WidgetAPI* theWidgetApi, std::string theParentId,
                                       QList<ModuleBase_ModelWidget*>& theModelWidgets);
 
-  XGUI_Workshop* xWorkshop() const;
-
+  /// Call back forlast tuning of property panel before operation performance
+  virtual void propertyPanelDefined(ModuleBase_Operation* theOperation);
 
-  /// Returns list of selection modes for the given object for sketch operation
-  static QIntList sketchSelectionModes(ObjectPtr theFeature);
 
- public slots:
-  void onFeatureTriggered();
-  /// SLOT, that is called after the operation is started. Connect on the focus activated signal
-  void onOperationStarted(ModuleBase_Operation* theOperation);
-  /// SLOT, that is called after the operation is stopped. Switched off the modfications performed
-  /// by the operation start
-  void onOperationStopped(ModuleBase_Operation* theOperation);
-  /// SLOT, that is called afetr the popup menu action clicked.
-  void onContextMenuCommand(const QString& theId, bool isChecked);
+  /// 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);
 
-  /// SLOT, to apply to the current viewer the operation
-  /// \param theX the X projection value
-  /// \param theY the Y projection value
-  /// \param theZ the Z projection value
-  void onPlaneSelected(double theX, double theY, double theZ);
+  /// 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);
 
-  /// SLOT, to fit all current viewer
-  void onFitAllView();
+  /// 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);
 
-  void onRestartOperation(std::string theName, ObjectPtr theFeature);
+  /// 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);
 
-  /// SLOT, to switch on/off the multi selection in the viewer
-  /// \param theEnabled the enabled state
-  void onMultiSelectionEnabled(bool theEnabled);
+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();
 
-  /// SLOT, to stop or start selection mode for the features
-  /// \param theFeatures a list of features to be disabled
-  /// \param theToStop the boolean state whether it it stopped or non stopped
-  void onStopSelection(const QList<ObjectPtr>& theFeatures, const bool isStop);
-
-  /// SLOT, to set selection
-  /// \param theFeatures a list of features to be selected
-  void onSetSelection(const QList<ObjectPtr>& theFeatures);
-
-  /// SLOT, Defines Sketch editing mode
-  /// \param thePln - plane of current sketch
-  void setSketchingMode(const gp_Pln& thePln);
-
-  /// SLOT, to visualize the feature in another local context mode
-  /// \param theFeature the feature to be put in another local context mode
-  /// \param theMode the mode appeared on the feature
-  void onFeatureConstructed(ObjectPtr theFeature, int theMode);
+protected slots:
+  /// Called when previous operation is finished
+  virtual void onSelectionChanged();
 
-  /// Slot which reacts to the point 2d set to the feature. Creates a constraint
-  /// \param the feature
-  /// \param the attribute of the feature
-  void onStorePoint2D(ObjectPtr theFeature, const std::string& theAttribute);
+  /// 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);
 
-  /// Called when sketch is launched
-  void onSketchLaunched();
+  /// SLOT, that is called by enter key released
+  /// Set a specific type of restarting the current operation
+  void onEnterReleased();
 
-protected slots:
-  /// Called on selection changed event
-  virtual void onSelectionChanged();
+  /// SLOT, that is called by the current operation filling with the preselection.
+  /// It commits the operation of it is can be committed
+  void onOperationActivatedByPreselection();
 
-  /// 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
-  virtual void onMousePressed(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(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(QMouseEvent* theEvent);
-
-  /// SLOT, that is called by the mouse double click in the viewer.
-  /// \param theEvent the mouse event
-  virtual void onMouseDoubleClick(QMouseEvent* theEvent);
-
-  /// SLOT, that is called by the key in the viewer is clicked.
-  /// \param theEvent the mouse event
-  virtual void onKeyRelease(QKeyEvent* theEvent);
 
  protected:
-  /// Creates a new operation
-  /// \param theCmdId the operation name
-  /// \param theFeatureKind a kind of feature to get the feature xml description
-  ModuleBase_Operation* createOperation(const std::string& theCmdId,
-                                        const std::string& theFeatureKind = "");
+  /// Register validators for this module
+  virtual void registerValidators();
 
+  /// Register selection filters for this module
+  virtual void registerFilters();
 
- protected:
-  //! Edits the feature
-  void editFeature(FeaturePtr theFeature);
+ private slots:
+   /// Processing of vertex selected
+   void onVertexSelected();
 
-  gp_Pln getSketchPlane(FeaturePtr theSketch) const;
+ private:
+  /// Breaks sequense of automatically resterted operations
+  void breakOperationSequence();
 
  private:
-  //XGUI_Workshop* myWorkshop;
-  PartSet_Listener* myListener;
+   QString myLastOperationId;
+   FeaturePtr myLastFeature;
+
+   // Automatical restarting mode flag
+   RestartingMode myRestartingMode;
 
-  std::map<std::string, std::string> myFeaturesInFiles;
+  /// A filter which provides selection within a current document or whole PartSet
+  Handle(PartSet_GlobalFilter) myDocumentShapeFilter;
 
-  Handle(StdSelect_FaceFilter) myPlaneFilter;
-  Handle(ModuleBase_ShapeInPlaneFilter) mySketchFilter;
+  PartSet_SketcherMgr* mySketchMgr;
 };
 
 #endif