src/PartSet/PartSet_Module.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 #ifndef PartSet_Module_H
   4 #define PartSet_Module_H
   5
   6 #include "PartSet.h"
   7 #include "PartSet_Filters.h"
   8 #include "PartSet_SketcherMgr.h"
   9
  10 #include <ModuleBase_IModule.h>
  11 #include <ModuleBase_Definitions.h>
  12 #include <ModelAPI_Feature.h>
  13 #include <ModelAPI_Attribute.h>
  14 #include <ModelAPI_CompositeFeature.h>
  15
  16 //#include <StdSelect_FaceFilter.hxx>
  17 #include <TopoDS_Shape.hxx>
  18
  19 #include <QMap>
  20 #include <QMenu>
  21 #include <QObject>
  22
  23 #include <string>
  24
  25 #include <memory>
  26
  27 class ModuleBase_Operation;
  28 class ModuleBase_IViewWindow;
  29
  30 class QAction;
  31
  32 /**
  33 * \ingroup Modules
  34 * Implementation of Partset module
  35 */
  36 class PARTSET_EXPORT PartSet_Module : public ModuleBase_IModule
  37 {
  38 Q_OBJECT
  39
  40 /// Enumeration to specify the restart operation properties.
  41 enum RestartingMode {
  42   RM_None, /// the operation should not be restarted
  43   RM_Forbided, /// the operation should not be restarted after there is no active widget
  44   RM_LastFeatureUsed, /// the operation is restarted and use the previous feature for own initialization
  45   RM_EmptyFeatureUsed /// the operation is restarted and does not use the previous feature
  46 };
  47
  48 public:
  49   /// Constructor
  50   /// \param theWshop a pointer to a workshop
  51   PartSet_Module(ModuleBase_IWorkshop* theWshop);
  52   virtual ~PartSet_Module();
  53
  54   /// Creates custom widgets for property panel
  55   virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,
  56                                                      Config_WidgetAPI* theWidgetApi, std::string theParentId);
  57
  58   /// Call back forlast tuning of property panel before operation performance
  59   virtual void propertyPanelDefined(ModuleBase_Operation* theOperation);
  60
  61
  62   /// Realizes some functionality by an operation start
  63   /// Displays all sketcher sub-Objects, hides sketcher result, appends selection filters
  64   /// \param theOperation a started operation
  65   virtual void operationStarted(ModuleBase_Operation* theOperation);
  66
  67   /// Realizes some functionality by an operation commit
  68   /// Restarts sketcher operation automatically of it is necessary
  69   /// \param theOperation a committed operation
  70   virtual void operationCommitted(ModuleBase_Operation* theOperation);
  71
  72   /// Realizes some functionality by an operation abort
  73   /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
  74   /// \param theOperation an aborted operation
  75   virtual void operationAborted(ModuleBase_Operation* theOperation);
  76
  77   /// Realizes some functionality by an operation stop
  78   /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
  79   /// \param theOperation a stopped operation
  80   virtual void operationStopped(ModuleBase_Operation* theOperation);
  81
  82   /// Returns True if there are available Undos and the sketch manager allows undo
  83   /// \return the boolean result
  84   virtual bool canUndo() const;
  85
  86   //! Returns True if there are available Redos and the sketch manager allows redo
  87   /// \return the boolean result
  88   virtual bool canRedo() const;
  89
  90   /// Returns whether the object can be displayed at the bounds of the active operation.
  91   /// Display only current operation results for usual operation and ask the sketcher manager
  92   /// if it is a sketch operation
  93   /// \param theObject a model object
  94   virtual bool canDisplayObject(const ObjectPtr& theObject) const;
  95   /// Add menu atems for viewer into the given menu
  96   /// \param theMenu a popup menu to be shown in the viewer
  97   virtual void addViewerItems(QMenu* theMenu) const;
  98
  99 public slots:
 100   /// SLOT, that is called by no more widget signal emitted by property panel
 101   /// Set a specific flag to restart the sketcher operation
 102   void onNoMoreWidgets();
 103
 104   /// Processes the context menu action click
 105   /// \param isChecked a state of toggle if the action is checkable
 106   void onAction(bool isChecked);
 107
 108 protected slots:
 109   /// Called when previous operation is finished
 110   virtual void onSelectionChanged();
 111
 112   /// SLOT, that is called by key release in the viewer.
 113   /// \param theWnd a view window
 114   /// \param theEvent the key event
 115   void onKeyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
 116
 117   /// SLOT, that is called by enter key released
 118   /// Set a specific type of restarting the current operation
 119   void onEnterReleased();
 120
 121   /// SLOT, that is called by the current operation filling with the preselection.
 122   /// It commits the operation of it is can be committed
 123   void onOperationActivatedByPreselection();
 124
 125   //! Delete features
 126   void onDeleteObjects();
 127
 128  protected:
 129   /// Register validators for this module
 130   virtual void registerValidators();
 131
 132   /// Register selection filters for this module
 133   virtual void registerFilters();
 134
 135   /// Register properties of this module
 136   virtual void registerProperties();
 137
 138  private slots:
 139    /// Processing of vertex selected
 140    void onVertexSelected();
 141
 142  private:
 143   /// Breaks sequense of automatically resterted operations
 144   void breakOperationSequence();
 145
 146   /// Create all actions for context menus. It is called on creation of module
 147   /// Put the created actions into an internal map
 148   void createActions();
 149
 150   /// Returns action according to the given ID
 151   /// \param theId an action identifier, it should be uniqued in the bounds of the module
 152   QAction* action(const QString& theId) const;
 153
 154   /// Add action to the internal map
 155   /// \param theId - string ID of the item
 156   /// \param theAction - action to add
 157   void addAction(const QString& theId, QAction* theAction);
 158
 159   //! Delete features
 160   void deleteObjects();
 161
 162  private:
 163    QString myLastOperationId;
 164    FeaturePtr myLastFeature;
 165
 166    // Automatical restarting mode flag
 167    RestartingMode myRestartingMode;
 168
 169   /// A filter which provides selection within a current document or whole PartSet
 170   Handle(PartSet_GlobalFilter) myDocumentShapeFilter;
 171
 172   PartSet_SketcherMgr* mySketchMgr;
 173
 174   QMap<QString, QAction*> myActions; // the popup menu actions
 175 };
 176
 177 #endif