-// Copyright (C) 2014-2017 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
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
-// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
-// See http://www.salome-platform.org/ or
-// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
- // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
#ifndef ModuleBase_IModule_H
#define ModuleBase_IModule_H
#include "ModuleBase.h"
#include "ModuleBase_IWorkshop.h"
+#include <ModuleBase_SelectionFilterType.h>
#include <ModelAPI_Feature.h>
#include <ModelAPI_Attribute.h>
#include <GeomAPI_Shape.h>
#include <GeomAPI_ICustomPrs.h>
+#include <SelectMgr_ListOfFilter.hxx>
+
#include <QString>
#include <QObject>
#include <QMap>
#include <vector>
#include <map>
+#ifdef _MSC_VER
+#pragma warning(disable: 4100)
+#endif
+
class QAction;
class QMouseEvent;
class QKeyEvent;
class QMenu;
class Config_WidgetAPI;
+
class ModuleBase_ModelWidget;
class ModuleBase_Operation;
class ModuleBase_ViewerPrs;
-
+class ModuleBase_ITreeNode;
class ModuleBase_IWorkshop;
+
class ModelAPI_Result;
class Events_Message;
/// \param theParent instance of workshop interface
ModuleBase_IModule(ModuleBase_IWorkshop* theParent);
- virtual ~ModuleBase_IModule() {}
-
- /// Add default selection filters of the module to the current viewer
- virtual void activateSelectionFilters() {}
-
- /// Remove default selection filters of the module from the current viewer
- virtual void deactivateSelectionFilters() {}
+ virtual ~ModuleBase_IModule();
/// Stores the current selection
virtual void storeSelection() {}
/// 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
virtual void activeSelectionModes(QIntList& theModes) {}
/// Appends specific selection modes for the module to the list of types
- /// \param theTypes a selection modes to be extended
- virtual void customSubShapesSelectionModes(QIntList& theTypes) {}
+ /// \param theModesType combination of available selection filters
+ /// \param theModes a selection modes to be extended
+ virtual void moduleSelectionModes(int theModesType, QIntList& theModes) = 0;
+
+ /// Appends into container of filters module filters corresponded to the modes type
+ /// \param theFilterTypes container of available selection filters
+ /// \param theSelectionFilters [out] container to be extend by elements
+ virtual void moduleSelectionFilters(const QIntList& theFilterTypes,
+ SelectMgr_ListOfFilter& theSelectionFilters) = 0;
+
+ /// Returns types of registered module selection filters
+ /// \param theSelectionFilters [out] container of type value
+ virtual QIntList selectionFilters();
+
+ /// Returns selection filter
+ /// \param theType selection filter type
+ /// \param theFilter instance of filter
+ 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
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,
/// 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
/// \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;
void getXMLRepresentation(const std::string& theFeatureId, std::string& theXmlCfg,
std::string& theDescription);
+ /// Returns root tree node which represents a data model
+ virtual ModuleBase_ITreeNode* rootNode() const = 0;
+
signals:
/// Segnal emitted when an operation is resumed
/// \param theOp a resumed operation
/// \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() {}
/// 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;
+
};
