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_DocumentDataModel.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 <Events_Listener.h>
  17
  18 //#include <StdSelect_FaceFilter.hxx>
  19 #include <TopoDS_Shape.hxx>
  20
  21 #include <QMap>
  22 #include <QMenu>
  23 #include <QObject>
  24
  25 #include <string>
  26
  27 #include <memory>
  28
  29 class ModuleBase_Operation;
  30 class ModuleBase_IViewWindow;
  31 class PartSet_MenuMgr;
  32 class PartSet_SketcherMgr;
  33
  34 class QAction;
  35
  36 /**
  37 * \ingroup Modules
  38 * Implementation of Partset module
  39 */
  40 class PARTSET_EXPORT PartSet_Module : public ModuleBase_IModule, public Events_Listener
  41 {
  42 Q_OBJECT
  43
  44 /// Enumeration to specify the restart operation properties.
  45 enum RestartingMode {
  46   RM_None, /// the operation should not be restarted
  47   RM_Forbided, /// the operation should not be restarted after there is no active widget
  48   RM_LastFeatureUsed, /// the operation is restarted and use the previous feature for own initialization
  49   RM_EmptyFeatureUsed /// the operation is restarted and does not use the previous feature
  50 };
  51
  52 public:
  53
  54   /// Constructor
  55   /// \param theWshop a pointer to a workshop
  56   PartSet_Module(ModuleBase_IWorkshop* theWshop);
  57   virtual ~PartSet_Module();
  58
  59   /// Creates custom widgets for property panel
  60   virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,
  61                                                      Config_WidgetAPI* theWidgetApi, std::string theParentId);
  62
  63   /// Call back forlast tuning of property panel before operation performance
  64   virtual void propertyPanelDefined(ModuleBase_Operation* theOperation);
  65
  66
  67   /// Realizes some functionality by an operation start
  68   /// Displays all sketcher sub-Objects, hides sketcher result, appends selection filters
  69   /// \param theOperation a started operation
  70   virtual void operationStarted(ModuleBase_Operation* theOperation);
  71
  72   /// Realizes some functionality by an operation commit
  73   /// Restarts sketcher operation automatically of it is necessary
  74   /// \param theOperation a committed operation
  75   virtual void operationCommitted(ModuleBase_Operation* theOperation);
  76
  77   /// Realizes some functionality by an operation abort
  78   /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
  79   /// \param theOperation an aborted operation
  80   virtual void operationAborted(ModuleBase_Operation* theOperation);
  81
  82   /// Realizes some functionality by an operation stop
  83   /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
  84   /// \param theOperation a stopped operation
  85   virtual void operationStopped(ModuleBase_Operation* theOperation);
  86
  87   /// Returns current operation
  88   virtual ModuleBase_Operation* currentOperation() const;
  89
  90   /// Returns True if there are available Undos and the sketch manager allows undo
  91   /// \return the boolean result
  92   virtual bool canUndo() const;
  93
  94   //! Returns True if there are available Redos and the sketch manager allows redo
  95   /// \return the boolean result
  96   virtual bool canRedo() const;
  97
  98   /// Returns whether the object can be displayed at the bounds of the active operation.
  99   /// Display only current operation results for usual operation and ask the sketcher manager
 100   /// if it is a sketch operation
 101   /// \param theObject a model object
 102   virtual bool canDisplayObject(const ObjectPtr& theObject) const;
 103
 104   /// Returns true if selection for the object can be activate.
 105   /// For sketch operation allow the selection activation if the operation is edit, for other
 106   /// operation uses the default result
 107   /// \param theObject a model object
 108   virtual bool canActivateSelection(const ObjectPtr& theObject) const;
 109
 110   /// Add menu atems for object browser into the given menu
 111   /// \param theMenu a popup menu to be shown in the object browser
 112   virtual void addObjectBrowserMenu(QMenu* theMenu) const;
 113
 114   /// Add menu atems for viewer into the given menu
 115   /// \param theMenu a popup menu to be shown in the viewer
 116   /// \param theStdActions a map of standard actions
 117   /// \return true if items are added and there is no necessity to provide standard menu
 118   virtual bool addViewerMenu(QMenu* theMenu, const QMap<QString, QAction*>& theStdActions) const;
 119
 120   /// Returns a list of modes, where the AIS objects should be activated
 121   /// \param theModes a list of modes
 122   virtual void activeSelectionModes(QIntList& theModes);
 123
 124   /// Returns whether the mouse enter the viewer's window
 125   /// \return true if items are added and there is no necessity to provide standard menu
 126   bool isMouseOverWindow();
 127
 128   PartSet_SketcherMgr* sketchMgr() const { return mySketchMgr; }
 129
 130   /// Returns data model object for representation of data tree in Object browser
 131   virtual ModuleBase_IDocumentDataModel* dataModel() const { return myDataModel; }
 132
 133   /// Event Listener method
 134   /// \param theMessage an event message
 135   virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
 136
 137   /// This method is called on object browser creation for customisation of module specific features
 138   /// \param theObjectBrowser a pinter on Object Browser widget
 139   virtual void customizeObjectBrowser(QWidget* theObjectBrowser);
 140
 141 public slots:
 142   /// SLOT, that is called by no more widget signal emitted by property panel
 143   /// Set a specific flag to restart the sketcher operation
 144   void onNoMoreWidgets();
 145
 146   /// Redefines the parent method in order to customize the next case:
 147   /// If the sketch nested operation is active and the presentation is not visualized in the viewer,
 148   /// the operation should be always aborted.
 149   virtual void onFeatureTriggered();
 150
 151   /// Slolt called on object display
 152   /// \param theObject a data object
 153   /// \param theAIS a presentation object
 154   virtual void onObjectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS);
 155
 156 protected slots:
 157   /// Called when previous operation is finished
 158   virtual void onSelectionChanged();
 159
 160   /// SLOT, that is called by key release in the viewer.
 161   /// \param theWnd a view window
 162   /// \param theEvent the key event
 163   void onKeyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
 164
 165   /// SLOT, that is called by enter key released
 166   /// Set a specific type of restarting the current operation
 167   void onEnterReleased();
 168
 169   /// SLOT, that is called by the current operation filling with the preselection.
 170   /// It commits the operation of it is can be committed
 171   void onOperationActivatedByPreselection();
 172
 173  protected:
 174   /// Register validators for this module
 175   virtual void registerValidators();
 176
 177   /// Register selection filters for this module
 178   virtual void registerFilters();
 179
 180   /// Register properties of this module
 181   virtual void registerProperties();
 182
 183   /// Sends the operation for launching
 184   /// \param theOperation the operation
 185   virtual void sendOperation(ModuleBase_Operation* theOperation);
 186
 187  private slots:
 188    /// Processing of vertex selected
 189    void onVertexSelected();
 190
 191    /// Called on transformation in current viewer
 192    /// \param theTrsfType type of tranformation
 193    void onViewTransformed(int theTrsfType = 2);
 194
 195    void onTreeViewDoubleClick(const QModelIndex&);
 196
 197  private:
 198   /// Breaks sequense of automatically resterted operations
 199   void breakOperationSequence();
 200
 201   //! Delete features
 202   virtual bool deleteObjects();
 203
 204  private:
 205    QString myLastOperationId;
 206    FeaturePtr myLastFeature;
 207
 208    // Automatical restarting mode flag
 209    RestartingMode myRestartingMode;
 210
 211   /// A filter which provides selection within a current document or whole PartSet
 212   Handle(PartSet_GlobalFilter) myDocumentShapeFilter;
 213
 214   PartSet_SketcherMgr* mySketchMgr;
 215
 216   PartSet_MenuMgr* myMenuMgr;
 217
 218   int myVisualLayerId;
 219
 220   PartSet_DocumentDataModel* myDataModel;
 221 };
 222
 223 #endif