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 action according to the given ID
  83   /// \param theId an action identifier, it should be uniqued in the bounds of the module
  84   QAction* action(const QString& theId) const;
  85
  86   /// Returns True if there are available Undos and the sketch manager allows undo
  87   /// \return the boolean result
  88   virtual bool canUndo() const;
  89
  90   //! Returns True if there are available Redos and the sketch manager allows redo
  91   /// \return the boolean result
  92   virtual bool canRedo() const;
  93
  94   /// Returns whether the object can be displayed at the bounds of the active operation.
  95   /// Display only current operation results for usual operation and ask the sketcher manager
  96   /// if it is a sketch operation
  97   /// \param theObject a model object
  98   virtual bool canDisplayObject(const ObjectPtr& theObject) const;
  99   /// Add menu atems for viewer into the given menu
 100   /// \param theMenu a popup menu to be shown in the viewer
 101   virtual void addViewerItems(QMenu* theMenu) const;
 102
 103 public slots:
 104   /// SLOT, that is called by no more widget signal emitted by property panel
 105   /// Set a specific flag to restart the sketcher operation
 106   void onNoMoreWidgets();
 107
 108   /// Processes the context menu action click
 109   /// \param isChecked a state of toggle if the action is checkable
 110   void onAction(bool isChecked);
 111
 112 protected slots:
 113   /// Called when previous operation is finished
 114   virtual void onSelectionChanged();
 115
 116   /// SLOT, that is called by key release in the viewer.
 117   /// \param theWnd a view window
 118   /// \param theEvent the key event
 119   void onKeyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
 120
 121   /// SLOT, that is called by enter key released
 122   /// Set a specific type of restarting the current operation
 123   void onEnterReleased();
 124
 125   /// SLOT, that is called by the current operation filling with the preselection.
 126   /// It commits the operation of it is can be committed
 127   void onOperationActivatedByPreselection();
 128
 129  protected:
 130   /// Register validators for this module
 131   virtual void registerValidators();
 132
 133   /// Register selection filters for this module
 134   virtual void registerFilters();
 135
 136   /// Register properties of this module
 137   virtual void registerProperties();
 138
 139  private slots:
 140    /// Processing of vertex selected
 141    void onVertexSelected();
 142
 143  private:
 144   /// Breaks sequense of automatically resterted operations
 145   void breakOperationSequence();
 146
 147   /// Create all actions for context menus. It is called on creation of module
 148   /// Put the created actions into an internal map
 149   void createActions();
 150
 151   /// Add action to the internal map
 152   /// \param theId - string ID of the item
 153   /// \param theAction - action to add
 154   void addAction(const QString& theId, QAction* theAction);
 155
 156   //! Delete features
 157   virtual bool deleteObjects();
 158
 159  private:
 160    QString myLastOperationId;
 161    FeaturePtr myLastFeature;
 162
 163    // Automatical restarting mode flag
 164    RestartingMode myRestartingMode;
 165
 166   /// A filter which provides selection within a current document or whole PartSet
 167   Handle(PartSet_GlobalFilter) myDocumentShapeFilter;
 168
 169   PartSet_SketcherMgr* mySketchMgr;
 170
 171   QMap<QString, QAction*> myActions; // the popup menu actions
 172 };
 173
 174 #endif