src/ModuleBase/ModuleBase_IModule.h

   1  // Copyright (C) 2014-20xx CEA/DEN, EDF R&D\r
   2 \r
   3 #ifndef ModuleBase_IModule_H\r
   4 #define ModuleBase_IModule_H\r
   5 \r
   6 #include "ModuleBase.h"\r
   7 #include "ModuleBase_IWorkshop.h"\r
   8 \r
   9 #include <ModelAPI_Feature.h>\r
  10 #include <ModelAPI_Attribute.h>\r
  11 \r
  12 #include <GeomAPI_Shape.h>\r
  13 #include <GeomAPI_ICustomPrs.h>\r
  14 \r
  15 #include <QString>\r
  16 #include <QObject>\r
  17 #include <QMap>\r
  18 #include <QList>\r
  19 \r
  20 #include <string>\r
  21 #include <vector>\r
  22 #include <map>\r
  23 \r
  24 class QAction;\r
  25 class QMouseEvent;\r
  26 class QKeyEvent;\r
  27 class QMenu;\r
  28 class Config_WidgetAPI;\r
  29 class ModuleBase_ModelWidget;\r
  30 class ModuleBase_Operation;\r
  31 class ModuleBase_IWorkshop;\r
  32 class ModelAPI_Result;\r
  33 \r
  34 class Handle_AIS_InteractiveObject;\r
  35 \r
  36 /**\r
  37  * \ingroup GUI\r
  38  * Interface to a module\r
  39  */\r
  40 class MODULEBASE_EXPORT ModuleBase_IModule : public QObject\r
  41 {\r
  42   Q_OBJECT\r
  43  public:\r
  44   /// enumeration to know which objects should be customized\r
  45   enum ModuleBase_CustomizeFlag {\r
  46     CustomizeArguments = 0, /// references of other objects referenced to the current feature\r
  47     CustomizeResults, /// results of the current feature\r
  48     CustomizeHighlightedObjects /// highlighted objects of the active widget\r
  49   };\r
  50 \r
  51    /// Constructor\r
  52    /// \param theParent instance of workshop interface\r
  53    ModuleBase_IModule(ModuleBase_IWorkshop* theParent);\r
  54 \r
  55   virtual ~ModuleBase_IModule() {}\r
  56 \r
  57   /// Add default selection filters of the module to the current viewer\r
  58   virtual void activateSelectionFilters() {};\r
  59 \r
  60   /// Remove default selection filters of the module from the current viewer\r
  61   virtual void deactivateSelectionFilters() {};\r
  62 \r
  63   /// Stores the current selection\r
  64   virtual void storeSelection() {};\r
  65 \r
  66   /// Restores the current selection\r
  67   virtual void restoreSelection() {};\r
  68 \r
  69   /// Reads description of features from XML file \r
  70   virtual void createFeatures();\r
  71 \r
  72   /// Called on creation of menu item in desktop\r
  73   virtual void actionCreated(QAction*);\r
  74 \r
  75   /// Launching of a edit operation on the feature \r
  76   /// \param theFeature feature for editing\r
  77   virtual void editFeature(FeaturePtr theFeature);\r
  78 \r
  79   /// Returns true if the operation can be committed. Result in default implementation is true.\r
  80   /// \return boolean value\r
  81   virtual bool canCommitOperation() const { return true; }\r
  82 \r
  83   /// Creates an operation and send it to loop\r
  84   /// \param theCmdId the operation name\r
  85   virtual void launchOperation(const QString& theCmdId);\r
  86 \r
  87   /// Executes feature as a modal dialog box\r
  88   /// \param theCmdId the operation name\r
  89   virtual void launchModal(const QString& theCmdId);\r
  90 \r
  91   /// Realizes some functionality by an operation start\r
  92   /// \param theOperation a started operation\r
  93   virtual void operationStarted(ModuleBase_Operation* theOperation) {}\r
  94 \r
  95   /// Realizes some functionality by an operation resume\r
  96   /// By default it emits operationResumed signal\r
  97   /// \param theOperation a resumed operation\r
  98   virtual void operationResumed(ModuleBase_Operation* theOperation);\r
  99 \r
 100   /// Realizes some functionality by an operation stop\r
 101   virtual void operationStopped(ModuleBase_Operation* theOperation) {}\r
 102 \r
 103   /// Realizes some functionality by an operation commit\r
 104   virtual void operationCommitted(ModuleBase_Operation* theOperation) {}\r
 105 \r
 106   /// Realizes some functionality by an operation abort\r
 107   virtual void operationAborted(ModuleBase_Operation* theOperation) {}\r
 108 \r
 109   /// Realizes some functionality by an operation start\r
 110   virtual ModuleBase_Operation* currentOperation() const = 0;\r
 111 \r
 112   /// Add menu items for viewer into the actions map\r
 113   /// \param theStdActions a map of standard actions\r
 114   /// \param theParent a parent widget\r
 115   /// \param theMenuActions map of action/menu for the desirable index in the viewer menu\r
 116   /// \return true if items are added and there is no necessity to provide standard menu\r
 117   virtual bool addViewerMenu(const QMap<QString, QAction*>& theStdActions,\r
 118                              QWidget* theParent,\r
 119                              QMap<int, QAction*>& theMenuActions) const\r
 120   { return false; }\r
 121 \r
 122   /// Add menu items for object browser into the given menu\r
 123   /// \param theMenu a popup menu to be shown in the object browser\r
 124   virtual void addObjectBrowserMenu(QMenu* theMenu) const {};\r
 125 \r
 126   /// Creates custom widgets for property panel\r
 127   /// \param theType a type of widget\r
 128   /// \param theParent the parent object\r
 129   /// \param theWidgetApi the widget configuration. The attribute of the model widget is obtained from\r
 130   virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,\r
 131                                                      Config_WidgetAPI* theWidgetApi)\r
 132   {\r
 133     return 0;\r
 134   }\r
 135 \r
 136   /// Returns the active widget, by default it is the property panel active widget\r
 137   virtual ModuleBase_ModelWidget* activeWidget() const = 0;\r
 138 \r
 139   /// Returns current workshop\r
 140   ModuleBase_IWorkshop* workshop() const { return myWorkshop; }\r
 141 \r
 142   /// Call back forlast tuning of property panel before operation performance\r
 143   /// It is called as on clearing of property panel as on filling with new widgets\r
 144   virtual void propertyPanelDefined(ModuleBase_Operation* theOperation) {}\r
 145 \r
 146   /// Have an opportunity to create widgets for the current operation instead of standard creation in workshop\r
 147   /// \param theOperation a started operation\r
 148   /// \param theWidgets a list of created widgets\r
 149   /// \return boolean result, false by default\r
 150   virtual bool createWidgets(ModuleBase_Operation* theOperation,\r
 151                              QList<ModuleBase_ModelWidget*>& theWidgets) const { return false; }\r
 152 \r
 153   //! Returns True if there are available Undos and there is not an active operation\r
 154   virtual bool canUndo() const;\r
 155 \r
 156   //! Returns True if there are available Redos and there is not an active operation\r
 157   virtual bool canRedo() const;\r
 158 \r
 159   /// Returns true if the action can be applyed to the object\r
 160   /// \param theObject a checked object\r
 161   /// \param theActionId an identifier of action, to be found in the menu manager like "DELETE_CMD"\r
 162   /// \return the a boolean result\r
 163   virtual bool canApplyAction(const ObjectPtr& theObject, const QString& theActionId) const = 0;\r
 164 \r
 165   /// Returns True if the current operation can be committed. By default it is true.\r
 166   /// \return a boolean value\r
 167   //virtual bool canCommitOperation() const;\r
 168 \r
 169   /// Returns whether the object can be erased. The default realization returns true.\r
 170   /// \param theObject a model object\r
 171   virtual bool canEraseObject(const ObjectPtr& theObject) const;\r
 172 \r
 173   /// Returns whether the object can be displayed. The default realization returns true.\r
 174   /// \param theObject a model object\r
 175   virtual bool canDisplayObject(const ObjectPtr& theObject) const;\r
 176 \r
 177   /// Make some functionality after the objects are hidden in viewer\r
 178   /// \param theObjects a list of hidden objects\r
 179   //virtual void processHiddenObject(const std::list<ObjectPtr>& theObjects) {};\r
 180 \r
 181   /// Returns true if selection for the object can be activate.\r
 182   /// By default a result or feature of the current operation can not be activated\r
 183   /// \param theObject a model object\r
 184   virtual bool canActivateSelection(const ObjectPtr& theObject) const;\r
 185 \r
 186   /// Reacts to the delete action in module\r
 187   /// \returns true if the action is processed\r
 188   virtual bool deleteObjects() { return false; };\r
 189 \r
 190   /// Performs functionality on closing document\r
 191   virtual void closeDocument() = 0;\r
 192 \r
 193   /// Clears specific presentations in the viewer\r
 194   virtual void clearViewer() = 0;\r
 195 \r
 196   /// Returns a list of modes, where the AIS objects should be activated\r
 197   /// \param theModes a list of modes\r
 198   virtual void activeSelectionModes(QIntList& theModes) {}\r
 199 \r
 200   /// Activate custom presentation for the object. Default realization is empty.\r
 201   /// \param theFeature a feature instance\r
 202   /// \param theFlag a flag of level of customization, which means that only part of sub-elements\r
 203   /// \param theUpdateViewer the parameter whether the viewer should be update immediately\r
 204   virtual void activateCustomPrs(const FeaturePtr& theFeature,\r
 205                                  const ModuleBase_CustomizeFlag& theFlag,\r
 206                                  const bool theUpdateViewer) {}\r
 207 \r
 208   /// Deactivate custom presentation for the object. Default realization is empty.\r
 209   /// \param theFlag a flag of level of customization, which means that only part of sub-elements\r
 210   /// \param theUpdateViewer the parameter whether the viewer should be update immediately\r
 211   virtual void deactivateCustomPrs(const ModuleBase_CustomizeFlag& theFlag,\r
 212                                    const bool theUpdateViewer) {}\r
 213 \r
 214   /// Modifies the given presentation in the custom way.\r
 215   virtual bool customisePresentation(std::shared_ptr<ModelAPI_Result> theResult, AISObjectPtr thePrs,\r
 216                                      GeomCustomPrsPtr theCustomPrs) { return false; };\r
 217 \r
 218   /// Update the object presentable properties such as color, lines width and other\r
 219   /// If the object is result with the color attribute value set, it is used,\r
 220   /// otherwise the customize is applyed to the object's feature if it is a custom prs\r
 221   /// \param theObject an object instance\r
 222   /// \param theFlag a flag of level of customization, which means that only part of sub-elements\r
 223   /// should be updated(e.g. only highlighted elements)\r
 224   /// \param theUpdateViewer the parameter whether the viewer should be update immediately\r
 225   /// \returns true if the object is modified\r
 226   virtual bool customizeObject(ObjectPtr theObject, const ModuleBase_CustomizeFlag& theFlag,\r
 227                                const bool theUpdateViewer);\r
 228 \r
 229   /// This method is called on object browser creation for customization of module specific features\r
 230   /// \param theObjectBrowser a pinter on Object Browser widget\r
 231   virtual void customizeObjectBrowser(QWidget* theObjectBrowser) {}\r
 232 \r
 233   /// Creates a new operation\r
 234   /// \param theCmdId the operation name\r
 235   virtual ModuleBase_Operation* createOperation(const std::string& theCmdId);\r
 236 \r
 237   /// Sends the operation for launching\r
 238   /// \param theOperation the operation\r
 239   virtual void sendOperation(ModuleBase_Operation* theOperation);\r
 240 \r
 241   /// Create specific for the module presentation\r
 242   /// \param theResult an object for presentation\r
 243   /// \return created presentation or NULL(default value)\r
 244   virtual Handle_AIS_InteractiveObject createPresentation(\r
 245                            const std::shared_ptr<ModelAPI_Result>& theResult);\r
 246 \r
 247   //! Returns data object by AIS\r
 248   virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const = 0;\r
 249 \r
 250   //! Returns true if the presentation can be shown in shading mode\r
 251   //! \param theAIS presentation to be checked\r
 252   //! \return boolean value\r
 253   virtual bool canBeShaded(Handle(AIS_InteractiveObject) theAIS) const;\r
 254 \r
 255   /// Update state of pop-up menu items in object browser\r
 256   /// \param theStdActions - a map of standard actions\r
 257   virtual void updateObjectBrowserMenu(const QMap<QString, QAction*>& theStdActions) {}\r
 258 \r
 259   /// Update state of pop-up menu items in viewer\r
 260   /// \param theStdActions - a map of standard actions\r
 261   virtual void updateViewerMenu(const QMap<QString, QAction*>& theStdActions) {}\r
 262 \r
 263   //! Returns the feature error if the current state of the feature in the module is not correct\r
 264   //! If the feature is correct, it returns an empty value\r
 265   //! \return string value\r
 266   virtual QString getFeatureError(const FeaturePtr& theFeature);\r
 267 \r
 268   /// Returns list of granted operation indices\r
 269   virtual void grantedOperationIds(ModuleBase_Operation* theOperation, QStringList& theIds) const;\r
 270 \r
 271   /// Connects or disconnects to the value changed signal of the property panel widgets\r
 272   /// \param theWidget a property contol widget\r
 273   /// \param isToConnect a boolean value whether connect or disconnect\r
 274   virtual void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect) {};\r
 275 \r
 276   /// Validates the operation to change the "Apply" button state.\r
 277   /// \param thePreviousState the previous state of the widget\r
 278   virtual void widgetStateChanged(int thePreviousState) {};\r
 279 \r
 280   /// Returns true if the event is processed.\r
 281   /// \param thePreviousAttributeID an index of the previous active attribute\r
 282   virtual bool processEnter(const std::string& thePreviousAttributeID) { return false; };\r
 283 \r
 284   /// Performs some GUI actions after an operation transaction is opened\r
 285   /// Default realization is empty\r
 286   virtual void beforeOperationStarted(ModuleBase_Operation* theOperation) {};\r
 287 \r
 288   /// Performs some GUI actions before an operation transaction is stopped\r
 289   /// Default realization is empty\r
 290   virtual void beforeOperationStopped(ModuleBase_Operation* theOperation) {};\r
 291 \r
 292   /// Finds a shape by attribute if it is possible\r
 293   /// \param theAttribute an attribute\r
 294   /// \return a geom shape\r
 295   virtual GeomShapePtr findShape(const AttributePtr& theAttribute) = 0;\r
 296 \r
 297   /// Finds an attribute by geom shape if it is possible\r
 298   /// \param theObject an object of the attribute\r
 299   /// \param theGeomShape a geom shape\r
 300   /// \return theAttribute\r
 301   virtual AttributePtr findAttribute(const ObjectPtr& theObject,\r
 302                                      const GeomShapePtr& theGeomShape) = 0;\r
 303 \r
 304   /// Returns XML information by the feature index\r
 305   /// \param theFeatureId a feature id\r
 306   /// \param theXmlCfg XML configuration\r
 307   /// \param theDescription feature description\r
 308   void getXMLRepresentation(const std::string& theFeatureId, std::string& theXmlCfg,\r
 309                             std::string& theDescription);\r
 310 \r
 311 signals:\r
 312   /// Signal which is emitted when operation is launched\r
 313   void operationLaunched();\r
 314 \r
 315   /// Segnal emitted when an operation is resumed\r
 316   /// \param theOp a resumed operation\r
 317   void resumed(ModuleBase_Operation* theOp);\r
 318 \r
 319 public slots:\r
 320   /// Called on call of command corresponded to a feature\r
 321   virtual void onFeatureTriggered();\r
 322 \r
 323   /// Slot called on object display\r
 324   /// \param theObject a data object\r
 325   /// \param theAIS a presentation object\r
 326   virtual void onObjectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS) {}\r
 327 \r
 328   /// Slot called on before object erase\r
 329   /// \param theObject a data object\r
 330   /// \param theAIS a presentation object\r
 331   virtual void onBeforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS) {}\r
 332 \r
 333 protected slots:\r
 334   /// Called on selection changed event\r
 335   virtual void onSelectionChanged() {}\r
 336 \r
 337 protected:\r
 338  /// Register validators for this module\r
 339   virtual void registerValidators() {}\r
 340 \r
 341   /// Register selection filters for this module\r
 342   virtual void registerFilters() {}\r
 343 \r
 344   /// Register properties of this module\r
 345   virtual void registerProperties() {}\r
 346 \r
 347   /// Returns new instance of operation object (used in createOperation for customization)\r
 348   virtual ModuleBase_Operation* getNewOperation(const std::string& theFeatureId);\r
 349 \r
 350 protected:\r
 351   /// Reference to workshop\r
 352   ModuleBase_IWorkshop* myWorkshop;\r
 353 \r
 354   /// Map of features in XML\r
 355   std::map<std::string, std::string> myFeaturesInFiles;\r
 356 };\r
 357 \r
 358 \r
 359 \r
 360 //! This function must return a new module instance.\r
 361 extern "C" {\r
 362 typedef ModuleBase_IModule* (*CREATE_FUNC)(ModuleBase_IWorkshop*);\r
 363 }\r
 364 \r
 365 #define CREATE_MODULE "createModule"\r
 366 \r
 367 #endif //ModuleBase_IModule\r