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_DocumentDataModel.h"
   8
   9 #include <ModuleBase_IModule.h>
  10 #include <ModuleBase_Definitions.h>
  11 #include <ModelAPI_Feature.h>
  12 #include <ModelAPI_Attribute.h>
  13 #include <ModelAPI_CompositeFeature.h>
  14
  15 #include <Events_Listener.h>
  16
  17 //#include <StdSelect_FaceFilter.hxx>
  18 #include <TopoDS_Shape.hxx>
  19 #include <SelectMgr_ListOfFilter.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_CustomPrs;
  33 class PartSet_SketcherMgr;
  34
  35 class QAction;
  36
  37 /**
  38 * \ingroup Modules
  39 * Implementation of Partset module
  40 */
  41 class PARTSET_EXPORT PartSet_Module : public ModuleBase_IModule, public Events_Listener
  42 {
  43 Q_OBJECT
  44
  45 /// Enumeration to specify the restart operation properties.
  46 enum RestartingMode {
  47   RM_None, /// the operation should not be restarted
  48   RM_Forbided, /// the operation should not be restarted after there is no active widget
  49   RM_LastFeatureUsed, /// the operation is restarted and use the previous feature for own initialization
  50   RM_EmptyFeatureUsed /// the operation is restarted and does not use the previous feature
  51 };
  52
  53 public:
  54
  55   /// Constructor
  56   /// \param theWshop a pointer to a workshop
  57   PartSet_Module(ModuleBase_IWorkshop* theWshop);
  58   virtual ~PartSet_Module();
  59
  60   // Add default selection filters of the module to the current viewer
  61   virtual void activateSelectionFilters();
  62   // Remove default selection filters of the module from the current viewer
  63   virtual void deactivateSelectionFilters();
  64
  65   /// Creates custom widgets for property panel
  66   virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,
  67                                                      Config_WidgetAPI* theWidgetApi, std::string theParentId);
  68
  69   /// Call back forlast tuning of property panel before operation performance
  70   virtual void propertyPanelDefined(ModuleBase_Operation* theOperation);
  71
  72   /// Creates an operation and send it to loop
  73   /// \param theCmdId the operation name
  74   virtual void launchOperation(const QString& theCmdId);
  75
  76   /// Realizes some functionality by an operation start
  77   /// Displays all sketcher sub-Objects, hides sketcher result, appends selection filters
  78   /// Activate the operation presentation
  79   /// \param theOperation a started operation
  80   virtual void onOperationStarted(ModuleBase_Operation* theOperation);
  81
  82   /// Realizes some functionality by an operation resume
  83   /// Activate the operation presentation
  84   /// \param theOperation a resumed operation
  85   virtual void onOperationResumed(ModuleBase_Operation* theOperation);
  86
  87   /// Realizes some functionality by an operation commit
  88   /// Restarts sketcher operation automatically of it is necessary
  89   /// \param theOperation a committed operation
  90   virtual void onOperationCommitted(ModuleBase_Operation* theOperation);
  91
  92   /// Realizes some functionality by an operation abort
  93   /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
  94   /// \param theOperation an aborted operation
  95   virtual void onOperationAborted(ModuleBase_Operation* theOperation);
  96
  97   /// Realizes some functionality by an operation stop
  98   /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
  99   /// \param theOperation a stopped operation
 100   virtual void onOperationStopped(ModuleBase_Operation* theOperation);
 101
 102   /// Returns current operation
 103   virtual ModuleBase_Operation* currentOperation() const;
 104
 105   /// Returns True if there are available Undos and the sketch manager allows undo
 106   /// \return the boolean result
 107   virtual bool canUndo() const;
 108
 109   //! Returns True if there are available Redos and the sketch manager allows redo
 110   /// \return the boolean result
 111   virtual bool canRedo() const;
 112
 113   /// Returnas true if the action can be applyed to the object
 114   /// \param theObject a checked object
 115   /// \param theActionId an identifier of action, to be found in the menu manager like "DELETE_CMD"
 116   /// \return the a booean result
 117   virtual bool canApplyAction(const ObjectPtr& theObject, const QString& theActionId) const;
 118
 119   /// Returns True if the current operation can be committed. Asks the sketch manager.
 120   /// \return a boolean value
 121   virtual bool canCommitOperation() const;
 122
 123   /// Returns whether the object can be erased at the bounds of the active operation.
 124   /// The sub-objects of the current operation can not be erased
 125   /// \param theObject a model object
 126   virtual bool canEraseObject(const ObjectPtr& theObject) const;
 127
 128   /// Returns whether the object can be displayed at the bounds of the active operation.
 129   /// Display only current operation results for usual operation and ask the sketcher manager
 130   /// if it is a sketch operation
 131   /// \param theObject a model object
 132   virtual bool canDisplayObject(const ObjectPtr& theObject) const;
 133
 134   /// Returns true if selection for the object can be activate.
 135   /// For sketch operation allow the selection activation if the operation is edit, for other
 136   /// operation uses the default result
 137   /// \param theObject a model object
 138   virtual bool canActivateSelection(const ObjectPtr& theObject) const;
 139
 140   /// Add menu atems for object browser into the given menu
 141   /// \param theMenu a popup menu to be shown in the object browser
 142   virtual void addObjectBrowserMenu(QMenu* theMenu) const;
 143
 144   /// Add menu atems for viewer into the given menu
 145   /// \param theMenu a popup menu to be shown in the viewer
 146   /// \param theStdActions a map of standard actions
 147   /// \return true if items are added and there is no necessity to provide standard menu
 148   virtual bool addViewerMenu(QMenu* theMenu, const QMap<QString, QAction*>& theStdActions) const;
 149
 150   /// Returns a list of modes, where the AIS objects should be activated
 151   /// \param theModes a list of modes
 152   virtual void activeSelectionModes(QIntList& theModes);
 153
 154   /// Returns whether the mouse enter the viewer's window
 155   /// \return true if items are added and there is no necessity to provide standard menu
 156   bool isMouseOverWindow();
 157
 158   PartSet_SketcherMgr* sketchMgr() const { return mySketchMgr; }
 159
 160 #ifdef ModuleDataModel
 161   /// Returns data model object for representation of data tree in Object browser
 162   virtual ModuleBase_IDocumentDataModel* dataModel() const { return myDataModel; }
 163 #endif
 164
 165   /// Performs functionality on closing document
 166   virtual void closeDocument();
 167
 168   /// Clears specific presentations in the viewer
 169   virtual void clearViewer();
 170
 171   /// Event Listener method
 172   /// \param theMessage an event message
 173   virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
 174
 175   /// Set the object with the object results are customized
 176   /// \param theFeature a feature
 177   void setCustomized(const FeaturePtr& theFeature);
 178
 179   /** Update the object presentable properties such as color, lines width and other
 180   * If the object is result with the color attribute value set, it is used,
 181   * otherwise the customize is applyed to the object's feature if it is a custom prs
 182   * \param theObject an object instance
 183   * \param theUpdateViewer the parameter whether the viewer should be update immediatelly
 184   * \returns true if the object is modified
 185   */
 186   virtual bool customizeObject(ObjectPtr theObject, const bool theUpdateViewer);
 187
 188   /// This method is called on object browser creation for customisation of module specific features
 189   /// \param theObjectBrowser a pinter on Object Browser widget
 190   virtual void customizeObjectBrowser(QWidget* theObjectBrowser);
 191
 192   /// Returns the viewer Z layer
 193   int getVisualLayerId() const { return myVisualLayerId; }
 194
 195   //! Returns data object by AIS
 196   virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const;
 197
 198   /// Update state of pop-up menu items in viewer
 199   /// \param theStdActions - a map of standard actions
 200   virtual void updateViewerMenu(const QMap<QString, QAction*>& theStdActions);
 201
 202   //! Returns the feature error if the current state of the feature in the module is not correct
 203   //! If the feature is correct, it returns an empty value
 204   //! \return string value
 205   virtual QString getFeatureError(const FeaturePtr& theFeature);
 206
 207 public slots:
 208   /// SLOT, that is called by no more widget signal emitted by property panel
 209   /// Set a specific flag to restart the sketcher operation
 210   void onNoMoreWidgets();
 211
 212   /// Redefines the parent method in order to customize the next case:
 213   /// If the sketch nested operation is active and the presentation is not visualized in the viewer,
 214   /// the operation should be always aborted.
 215   virtual void onFeatureTriggered();
 216
 217   /// Slolt called on object display
 218   /// \param theObject a data object
 219   /// \param theAIS a presentation object
 220   virtual void onObjectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS);
 221
 222   /// Slot called on before object erase
 223   /// \param theObject a data object
 224   /// \param theAIS a presentation object
 225   virtual void onBeforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS);
 226
 227   /// Called on transformation in current viewer
 228   /// \param theTrsfType type of tranformation
 229   void onViewTransformed(int theTrsfType = 2);
 230
 231 protected slots:
 232   /// Called when previous operation is finished
 233   virtual void onSelectionChanged();
 234
 235   /// SLOT, that is called by key release in the viewer.
 236   /// \param theWnd a view window
 237   /// \param theEvent the key event
 238   void onKeyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
 239
 240   /// SLOT, that is called by enter key released
 241   /// Set a specific type of restarting the current operation
 242   void onEnterReleased();
 243
 244   /// SLOT, that is called by the current operation filling with the preselection.
 245   /// It commits the operation of it is can be committed
 246   void onOperationActivatedByPreselection();
 247
 248   /// A slot called on view window creation
 249   void onViewCreated(ModuleBase_IViewWindow*);
 250
 251  protected:
 252   /// Register validators for this module
 253   virtual void registerValidators();
 254
 255   /// Register selection filters for this module
 256   virtual void registerFilters();
 257
 258   /// Register properties of this module
 259   virtual void registerProperties();
 260
 261  private slots:
 262    /// Processing of vertex selected
 263    void onVertexSelected();
 264
 265    void onTreeViewDoubleClick(const QModelIndex&);
 266
 267  private:
 268   /// Breaks sequense of automatically resterted operations
 269   void breakOperationSequence();
 270
 271   //! Delete features
 272   virtual bool deleteObjects();
 273
 274  private:
 275    QString myLastOperationId;
 276    FeaturePtr myLastFeature;
 277
 278    // Automatical restarting mode flag
 279    RestartingMode myRestartingMode;
 280
 281   SelectMgr_ListOfFilter mySelectionFilters;
 282
 283   PartSet_SketcherMgr* mySketchMgr;
 284   PartSet_MenuMgr* myMenuMgr;
 285   /// A default custom presentation, which is used for references objects of started operation
 286   PartSet_CustomPrs* myCustomPrs;
 287   int myVisualLayerId;
 288
 289   bool myHasConstraintShown;
 290 #ifdef ModuleDataModel
 291   PartSet_DocumentDataModel* myDataModel;
 292 #endif
 293
 294   QModelIndex aActivePartIndex;
 295 };
 296
 297 #endif