Salome HOME
updated copyright message
[modules/shaper.git] / src / ModuleBase / ModuleBase_IModule.h
index 90d31cd1400ccbddc887909f0295b98edfe95f25..e60281374f745ab299dc1c5c6c9e774bcd59b91b 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2014-2019  CEA/DEN, EDF R&D
+// Copyright (C) 2014-2023  CEA, EDF
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
@@ -22,6 +22,7 @@
 
 #include "ModuleBase.h"
 #include "ModuleBase_IWorkshop.h"
+#include <ModuleBase_SelectionFilterType.h>
 
 #include <ModelAPI_Feature.h>
 #include <ModelAPI_Attribute.h>
 #include <vector>
 #include <map>
 
+#ifdef _MSC_VER
+#pragma warning(disable: 4100)
+#endif
+
 class QAction;
 class QMouseEvent;
 class QKeyEvent;
@@ -76,7 +81,7 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
    /// \param theParent instance of workshop interface
    ModuleBase_IModule(ModuleBase_IWorkshop* theParent);
 
-  virtual ~ModuleBase_IModule() {}
+   virtual ~ModuleBase_IModule();
 
   /// Stores the current selection
   virtual void storeSelection() {}
@@ -168,10 +173,11 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
 
   /// Have an opportunity to create widgets for the current operation
   /// instead of standard creation in workshop
-  /// \param theOperation a started operation
+  /// \param theFeature a feature of the started operation
+  /// \param theXmlRepr an XML representation of the operation
   /// \param theWidgets a list of created widgets
   /// \return boolean result, false by default
-  virtual bool createWidgets(ModuleBase_Operation* theOperation,
+  virtual bool createWidgets(const FeaturePtr& theFeature, const QString& theXmlRepr,
                              QList<ModuleBase_ModelWidget*>& theWidgets) const { return false; }
 
   //! Returns True if there are available Undos and there is not an active operation
@@ -242,12 +248,18 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
 
   /// Returns types of registered module selection filters
   /// \param theSelectionFilters [out] container of type value
-  virtual QIntList selectionFilters() { return QIntList(); }
+  virtual QIntList selectionFilters();
 
   /// Returns selection filter
   /// \param theType selection filter type
   /// \param theFilter instance of filter
-  virtual Handle(SelectMgr_Filter) selectionFilter(const int theType) = 0;
+  virtual Handle(SelectMgr_Filter) selectionFilter(const int theType);
+
+  /// Append selection filter into the module and type of the filter in internal container
+  /// \param theFilterType selection filter type
+  /// \param theFilter added filter
+  void registerSelectionFilter(const ModuleBase_SelectionFilterType theFilterType,
+    const Handle(SelectMgr_Filter)& theFilter);
 
   /// Return true if the custom presentation is activated
   /// \param theFlag a flag of level of customization, which means that only part of sub-elements
@@ -270,14 +282,14 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
                                    const bool theUpdateViewer) {}
 
   /// Modifies the given presentation in the custom way.
-  virtual bool customisePresentation(std::shared_ptr<ModelAPI_Result> theResult,
-                                     AISObjectPtr thePrs,
-                                     GeomCustomPrsPtr theCustomPrs) { return false; };
+  //virtual bool customisePresentation(std::shared_ptr<ModelAPI_Result> theResult,
+  //                                   AISObjectPtr thePrs,
+  //                                   GeomCustomPrsPtr theCustomPrs) { return false; };
 
-  /// Modifies the given presentation in the custom way after usual customize is performed.
-  virtual bool afterCustomisePresentation(std::shared_ptr<ModelAPI_Result> theResult,
-                                     AISObjectPtr thePrs,
-                                     GeomCustomPrsPtr theCustomPrs) { return false; };
+  ///// Modifies the given presentation in the custom way after usual customize is performed.
+  //virtual bool afterCustomisePresentation(std::shared_ptr<ModelAPI_Result> theResult,
+  //                                   AISObjectPtr thePrs,
+  //                                   GeomCustomPrsPtr theCustomPrs) { return false; };
 
   /// Update the object presentable properties such as color, lines width and other
   /// If the object is result with the color attribute value set, it is used,
@@ -287,8 +299,17 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
   /// should be updated(e.g. only highlighted elements)
   /// \param theUpdateViewer the parameter whether the viewer should be update immediately
   /// \returns true if the object is modified
-  virtual bool customizeObject(ObjectPtr theObject, const ModuleBase_CustomizeFlag& theFlag,
-                               const bool theUpdateViewer);
+  virtual bool customizeFeature(ObjectPtr theObject, const ModuleBase_CustomizeFlag& theFlag,
+    const bool theUpdateViewer) {
+    return false;
+  }
+
+  /// Disable displaying of custom mode
+  /// \param theMode a mode to disable
+  virtual void disableCustomMode(ModuleBase_CustomizeFlag theMode) {}
+
+  /// Enables disabled custom mode
+  virtual void enableCustomModes() {}
 
   /// This method is called on object browser creation for customization of module specific features
   /// \param theObjectBrowser a pinter on Object Browser widget
@@ -298,11 +319,17 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
   /// \param theCmdId the operation name
   virtual ModuleBase_Operation* createOperation(const std::string& theCmdId);
 
-  /// Create specific for the module presentation
+  /// Create specific for the module presentation. The presentation has to be
+  /// customized accordingly to the object.
   /// \param theResult an object for presentation
   /// \return created presentation or NULL(default value)
-  virtual Handle(AIS_InteractiveObject) createPresentation(
-                           const std::shared_ptr<ModelAPI_Result>& theResult);
+  virtual AISObjectPtr createPresentation(const ObjectPtr& theResult);
+
+  /// Customize presentation according to objects attributes
+  /// \param theObject an object for presentation
+  /// \param thePrs a presentation object
+  virtual void customizePresentation(const ObjectPtr& theObject, const AISObjectPtr& thePrs) const
+  {}
 
   //! Returns data object by AIS
   virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const = 0;
@@ -398,6 +425,10 @@ public slots:
   /// \param theAIS a presentation object
   virtual void onBeforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS) {}
 
+  /// Called on transformation in current viewer
+  /// \param theTrsfType type of tranformation
+  virtual void onViewTransformed(int theTrsfType = 2) {}
+
 protected slots:
   /// Called on selection changed event
   virtual void onSelectionChanged() {}
@@ -412,12 +443,27 @@ protected:
   /// Returns new instance of operation object (used in createOperation for customization)
   virtual ModuleBase_Operation* getNewOperation(const std::string& theFeatureId);
 
+  /// Load plugins required license
+  void loadProprietaryPlugins();
+
+  /// Collect features, which have valid license
+  void processProprietaryFeatures();
+
 protected:
   /// Reference to workshop
   ModuleBase_IWorkshop* myWorkshop;
 
   /// Map of features in XML
   std::map<std::string, std::string> myFeaturesInFiles;
+  /// Map of features in XML, which require license but not confirmed yet
+  std::map<std::string, std::string> myProprietaryFeatures;
+  /// Proprietary plugins
+  std::set<std::string> myProprietaryPlugins;
+  /// Features, which have valid license
+  std::set<std::string> myFeaturesValidLicense;
+
+  std::map<ModuleBase_SelectionFilterType, Handle(SelectMgr_Filter)> mySelectionFilters;
+
 };