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_Tools.h"
   8 #include "PartSet_OverconstraintListener.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 #include <SelectMgr_ListOfFilter.hxx>
  21
  22 #include <QMap>
  23 #include <QMenu>
  24 #include <QObject>
  25 #include <QModelIndex>
  26
  27 #include <string>
  28
  29 #include <memory>
  30
  31 class ModuleBase_Operation;
  32 class ModuleBase_IViewWindow;
  33 class XGUI_Workshop;
  34 class PartSet_MenuMgr;
  35 class PartSet_CustomPrs;
  36 class PartSet_SketcherMgr;
  37 class PartSet_SketcherReetntrantMgr;
  38 class ModelAPI_Result;
  39
  40 class QAction;
  41
  42 /**
  43 * \ingroup Modules
  44 * Implementation of Partset module
  45 */
  46 class PARTSET_EXPORT PartSet_Module : public ModuleBase_IModule, public Events_Listener
  47 {
  48 Q_OBJECT
  49
  50 /// Enumeration to specify the restart operation properties.
  51 enum RestartingMode {
  52   RM_None, /// the operation should not be restarted
  53   RM_Forbided, /// the operation should not be restarted after there is no active widget
  54   RM_LastFeatureUsed, /// the operation is restarted and use the previous feature for own initialization
  55   RM_EmptyFeatureUsed /// the operation is restarted and does not use the previous feature
  56 };
  57
  58 public:
  59
  60   /// Constructor
  61   /// \param theWshop a pointer to a workshop
  62   PartSet_Module(ModuleBase_IWorkshop* theWshop);
  63   virtual ~PartSet_Module();
  64
  65   // Add default selection filters of the module to the current viewer
  66   virtual void activateSelectionFilters();
  67   // Remove default selection filters of the module from the current viewer
  68   virtual void deactivateSelectionFilters();
  69
  70   // Stores the current selection
  71   virtual void storeSelection();
  72
  73   // Restores the current selection
  74   virtual void restoreSelection();
  75
  76   /// Creates custom widgets for property panel
  77   virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,
  78                                                      Config_WidgetAPI* theWidgetApi);
  79
  80   /// Returns the active widget, by default it is the property panel active widget
  81   /// If the internal edit operation is started, this is the first widget of the operation
  82   virtual ModuleBase_ModelWidget* activeWidget() const;
  83
  84   /// Call back forlast tuning of property panel before operation performance
  85   virtual void propertyPanelDefined(ModuleBase_Operation* theOperation);
  86
  87   /// If there is found selected attribute, widgets are created and contains only a widget for the attribute
  88   /// It is important for Property Panel filling by sketch point attribute
  89   /// \param theOperation a started operation
  90   /// \param theWidgets a list of created widgets
  91   /// \return boolean result, false by default
  92   virtual bool createWidgets(ModuleBase_Operation* theOperation,
  93                              QList<ModuleBase_ModelWidget*>& theWidgets) const;
  94
  95   /// Launching of a edit operation on the feature
  96   /// \param theFeature feature for editing
  97   virtual void editFeature(FeaturePtr theFeature);
  98
  99   /// Returns true if the operation can be committed. Result in default implementation is true.
 100   /// \return boolean value
 101   virtual bool canCommitOperation() const;
 102
 103   /// Creates an operation and send it to loop
 104   /// \param theCmdId the operation name
 105   virtual void launchOperation(const QString& theCmdId);
 106
 107   /// Realizes some functionality by an operation start
 108   /// Displays all sketcher sub-Objects, hides sketcher result, appends selection filters
 109   /// Activate the operation presentation
 110   /// \param theOperation a started operation
 111   virtual void operationStarted(ModuleBase_Operation* theOperation);
 112
 113   /// Realizes some functionality by an operation resume
 114   /// Activate the operation presentation
 115   /// \param theOperation a resumed operation
 116   virtual void operationResumed(ModuleBase_Operation* theOperation);
 117
 118   /// Realizes some functionality by an operation commit
 119   /// Restarts sketcher operation automatically of it is necessary
 120   /// \param theOperation a committed operation
 121   virtual void operationCommitted(ModuleBase_Operation* theOperation);
 122
 123   /// Realizes some functionality by an operation abort
 124   /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
 125   /// \param theOperation an aborted operation
 126   virtual void operationAborted(ModuleBase_Operation* theOperation);
 127
 128   /// Realizes some functionality by an operation stop
 129   /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
 130   /// \param theOperation a stopped operation
 131   virtual void operationStopped(ModuleBase_Operation* theOperation);
 132
 133   /// Returns current operation
 134   virtual ModuleBase_Operation* currentOperation() const;
 135
 136   /// Returns True if there are available Undos and the sketch manager allows undo
 137   /// \return the boolean result
 138   virtual bool canUndo() const;
 139
 140   //! Returns True if there are available Redos and the sketch manager allows redo
 141   /// \return the boolean result
 142   virtual bool canRedo() const;
 143
 144   /// Returnas true if the action can be applyed to the object
 145   /// \param theObject a checked object
 146   /// \param theActionId an identifier of action, to be found in the menu manager like "DELETE_CMD"
 147   /// \return the a booean result
 148   virtual bool canApplyAction(const ObjectPtr& theObject, const QString& theActionId) const;
 149
 150   /// Returns True if the current operation can be committed. Asks the sketch manager.
 151   /// \return a boolean value
 152   //virtual bool canCommitOperation() const;
 153
 154   /// Returns whether the object can be erased at the bounds of the active operation.
 155   /// The sub-objects of the current operation can not be erased
 156   /// \param theObject a model object
 157   virtual bool canEraseObject(const ObjectPtr& theObject) const;
 158
 159   /// Returns whether the object can be displayed at the bounds of the active operation.
 160   /// Display only current operation results for usual operation and ask the sketcher manager
 161   /// if it is a sketch operation
 162   /// \param theObject a model object
 163   virtual bool canDisplayObject(const ObjectPtr& theObject) const;
 164
 165   /// Make some functionality after the objects are hidden in viewer
 166   /// \param theObjects a list of hidden objects
 167   virtual void processHiddenObject(const std::list<ObjectPtr>& theObjects);
 168
 169   /// Returns true if selection for the object can be activate.
 170   /// For sketch operation allow the selection activation if the operation is edit, for other
 171   /// operation uses the default result
 172   /// \param theObject a model object
 173   virtual bool canActivateSelection(const ObjectPtr& theObject) const;
 174
 175   /// Add menu atems for object browser into the given menu
 176   /// \param theMenu a popup menu to be shown in the object browser
 177   virtual void addObjectBrowserMenu(QMenu* theMenu) const;
 178
 179   /// Add menu atems for viewer into the given menu
 180   /// \param theMenu a popup menu to be shown in the viewer
 181   /// \param theStdActions a map of standard actions
 182   /// \return true if items are added and there is no necessity to provide standard menu
 183   virtual bool addViewerMenu(QMenu* theMenu, const QMap<QString, QAction*>& theStdActions) const;
 184
 185   /// Returns a list of modes, where the AIS objects should be activated
 186   /// \param theModes a list of modes
 187   virtual void activeSelectionModes(QIntList& theModes);
 188
 189   /// Returns whether the mouse enter the viewer's window
 190   /// \return true if items are added and there is no necessity to provide standard menu
 191   bool isMouseOverWindow();
 192
 193   /// Returns sketch manager object
 194   PartSet_SketcherMgr* sketchMgr() const { return mySketchMgr; }
 195
 196   /// Returns sketch reentrant manager
 197   PartSet_SketcherReetntrantMgr* sketchReentranceMgr() { return mySketchReentrantMgr; }
 198
 199   /// Returns listener of overconstraint signal
 200   /// \return the listener
 201   PartSet_OverconstraintListener* overconstraintListener() { return myOverconstraintListener; }
 202
 203   /// Performs functionality on closing document
 204   virtual void closeDocument();
 205
 206   /// Clears specific presentations in the viewer
 207   virtual void clearViewer();
 208
 209   /// Event Listener method
 210   /// \param theMessage an event message
 211   virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
 212
 213   /// Set the object with the object results are customized
 214   /// \param theFeature a feature
 215   void setCustomized(const FeaturePtr& theFeature);
 216
 217   /// Activate custom presentation for the object
 218   /// \param theFeature a feature instance
 219   /// \param theFlag a flag of level of customization, which means that only part of sub-elements
 220   /// \param theUpdateViewer the parameter whether the viewer should be update immediately
 221   virtual void activateCustomPrs(const FeaturePtr& theFeature,
 222                                  const ModuleBase_CustomizeFlag& theFlag,
 223                                  const bool theUpdateViewer);
 224
 225   /// Deactivate custom presentation for the object
 226   /// \param theFlag a flag of level of customization, which means that only part of sub-elements
 227   /// \param theUpdateViewer the parameter whether the viewer should be update immediately
 228   virtual void deactivateCustomPrs(const ModuleBase_CustomizeFlag& theFlag,
 229                                    const bool theUpdateViewer);
 230
 231   /// Modifies the given presentation in the custom way.
 232   virtual bool customisePresentation(std::shared_ptr<ModelAPI_Result> theResult,
 233                                      AISObjectPtr thePrs,
 234                                      std::shared_ptr<GeomAPI_ICustomPrs> theCustomPrs);
 235
 236   /// Update the object presentable properties such as color, lines width and other
 237   /// If the object is result with the color attribute value set, it is used,
 238   /// otherwise the customize is applyed to the object's feature if it is a custom prs
 239   /// \param theObject an object instance
 240   /// \param theFlag a flag of level of customization, which means that only part of sub-elements
 241   /// should be updated(e.g. only highlighted elements)
 242   /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
 243   /// \returns true if the object is modified
 244   virtual bool customizeObject(ObjectPtr theObject, const ModuleBase_CustomizeFlag& theFlag,
 245                                const bool theUpdateViewer);
 246
 247   /// This method is called on object browser creation for customisation of module specific features
 248   /// \param theObjectBrowser a pinter on Object Browser widget
 249   virtual void customizeObjectBrowser(QWidget* theObjectBrowser);
 250
 251   /// Returns the viewer Z layer
 252   int getVisualLayerId() const { return myVisualLayerId; }
 253
 254   /// Create specific for the module presentation
 255   /// \param theResult an object for presentation
 256   /// \return created presentation or NULL(default value)
 257   virtual Handle(AIS_InteractiveObject) createPresentation(
 258                               const std::shared_ptr<ModelAPI_Result>& theResult);
 259
 260   //! Returns data object by AIS
 261   virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const;
 262
 263   //! Returns true if the presentation can be shown in shading mode
 264   //! \param theAIS presentation to be checked
 265   //! \return boolean value
 266   virtual bool canBeShaded(Handle(AIS_InteractiveObject) theAIS) const;
 267
 268   /// Update state of pop-up menu items in viewer
 269   /// \param theStdActions - a map of standard actions
 270   virtual void updateViewerMenu(const QMap<QString, QAction*>& theStdActions);
 271
 272   //! Returns the feature error if the current state of the feature in the module is not correct
 273   //! If the feature is correct, it returns an empty value
 274   //! \return string value
 275   virtual QString getFeatureError(const FeaturePtr& theFeature);
 276
 277   /// Returns list of granted operation indices
 278   virtual void grantedOperationIds(ModuleBase_Operation* theOperation, QStringList& theIds) const;
 279
 280   /// Validates the current operation and send the state change to sketch manager
 281   /// \param thePreviousState the previous widget value state
 282   virtual void widgetStateChanged(int thePreviousState);
 283
 284   /// Returns true if the event is processed. It gives the reentrance manager to process the enter.
 285   /// \param thePreviousAttributeID an index of the previous active attribute
 286   virtual bool processEnter(const std::string& thePreviousAttributeID);
 287
 288   /// Performs some GUI actions after an operation transaction is opened
 289   /// Default realization is empty
 290   virtual void beforeOperationStarted(ModuleBase_Operation* theOperation);
 291
 292   /// Performs some GUI actions before an operation transaction is stopped
 293   /// Default realization is empty
 294   virtual void beforeOperationStopped(ModuleBase_Operation* theOperation);
 295
 296   /// Finds a shape by attribute if it is possible
 297   /// \param theAttribute an attribute
 298   /// \return a geom shape
 299   virtual GeomShapePtr findShape(const AttributePtr& theAttribute);
 300
 301   /// Finds an attribute by geom shape if it is possible
 302   /// \param theObject an object of the attribute
 303   /// \param theGeomShape a geom shape
 304   /// \return theAttribute
 305   virtual AttributePtr findAttribute(const ObjectPtr& theObject, const GeomShapePtr& theGeomShape);
 306
 307 public slots:
 308   /// Redefines the parent method in order to customize the next case:
 309   /// If the sketch nested operation is active and the presentation is not visualized in the viewer,
 310   /// the operation should be always aborted.
 311   virtual void onFeatureTriggered();
 312
 313   /// Slolt called on object display
 314   /// \param theObject a data object
 315   /// \param theAIS a presentation object
 316   virtual void onObjectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS);
 317
 318   /// Slot called on before object erase
 319   /// \param theObject a data object
 320   /// \param theAIS a presentation object
 321   virtual void onBeforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS);
 322
 323   /// Called on transformation in current viewer
 324   /// \param theTrsfType type of tranformation
 325   void onViewTransformed(int theTrsfType = 2);
 326
 327 protected slots:
 328   /// Called when previous operation is finished
 329   virtual void onSelectionChanged();
 330
 331   /// SLOT, that is called by key release in the viewer.
 332   /// \param theWnd a view window
 333   /// \param theEvent the key event
 334   void onKeyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
 335
 336   /// A slot called on view window creation
 337   void onViewCreated(ModuleBase_IViewWindow*);
 338
 339   /// A slot to change property panel title by choice type change if the title information
 340   /// exists in the XML definition of this control attribute
 341   /// \param theWidget a sender
 342   /// \param theIndex the current choice index
 343   void onChoiceChanged(ModuleBase_ModelWidget* theWidget, int theIndex);
 344
 345 protected:
 346   /// Sets the constraints states in internal map. If the feature kind is a dimensional constraint
 347   /// other dimensions are shown.
 348   /// \param theFeatureKindId a feature kind
 349   void storeConstraintsState(const std::string& theFeatureKindId);
 350
 351   /// Register validators for this module
 352   virtual void registerValidators();
 353
 354   /// Register selection filters for this module
 355   virtual void registerFilters();
 356
 357   /// Register properties of this module
 358   virtual void registerProperties();
 359
 360   /// Connects or disconnects to the value changed signal of the property panel widgets
 361   /// \param theWidget a property contol widget
 362   /// \param isToConnect a boolean value whether connect or disconnect
 363   virtual void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect);
 364
 365   /// Realizes some functionality by an operation start
 366   /// Displays all sketcher sub-Objects, hides sketcher result, appends selection filters
 367   /// Activate the operation presentation
 368   /// \param theOperation a started operation
 369   virtual void operationStartedInternal(ModuleBase_Operation* theOperation);
 370
 371  private slots:
 372    void onTreeViewDoubleClick(const QModelIndex&);
 373
 374    void onActiveDocPopup(const QPoint&);
 375
 376  private:
 377
 378   //! Delete features
 379   virtual bool deleteObjects();
 380
 381   /// Returns the workshop
 382   XGUI_Workshop* getWorkshop() const;
 383
 384  private:
 385   SelectMgr_ListOfFilter mySelectionFilters;
 386
 387   PartSet_SketcherMgr* mySketchMgr;
 388   PartSet_SketcherReetntrantMgr* mySketchReentrantMgr;
 389   PartSet_MenuMgr* myMenuMgr;
 390   /// A default custom presentation, which is used for references objects of started operation
 391   PartSet_CustomPrs* myCustomPrs;
 392   PartSet_OverconstraintListener* myOverconstraintListener;
 393   int myVisualLayerId;
 394
 395   /// backup of the visible state to restore them by operation stop
 396   QMap<PartSet_Tools::ConstraintVisibleState, bool> myHasConstraintShown;
 397
 398   QModelIndex aActivePartIndex;
 399 };
 400
 401 #endif