- // Copyright (C) 2014-20xx 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
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// Lesser General Public License for more details.
+//
+// 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
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
#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;
-class Handle_AIS_InteractiveObject;
+class AIS_InteractiveObject;
/**
* \ingroup GUI
/// \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() {};
+ virtual void storeSelection() {}
/// Restores the current selection
- virtual void restoreSelection() {};
+ virtual void restoreSelection() {}
- /// Reads description of features from XML file
+ /// Reads description of features from XML file
virtual void createFeatures();
/// Called on creation of menu item in desktop
virtual void actionCreated(QAction*);
- /// Launching of a edit operation on the feature
+ /// Launching of a edit operation on the feature
/// \param theFeature feature for editing
virtual void editFeature(FeaturePtr theFeature);
/// Creates an operation and send it to loop
/// \param theCmdId the operation name
- virtual void launchOperation(const QString& theCmdId);
+ /// \param isStartAfterCommitOnly operation is launched if there is no active operation or
+ /// it is committed
+ virtual void launchOperation(const QString& theCmdId,
+ const bool& isStartAfterCommitOnly);
/// Executes feature as a modal dialog box
/// \param theCmdId the operation name
/// Creates custom widgets for property panel
/// \param theType a type of widget
/// \param theParent the parent object
- /// \param theWidgetApi the widget configuration. The attribute of the model widget is obtained from
- virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,
+ /// \param theWidgetApi the widget configuration.
+ /// The attribute of the model widget is obtained from
+ virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType,
+ QWidget* theParent,
Config_WidgetAPI* theWidgetApi)
{
return 0;
/// It is called as on clearing of property panel as on filling with new widgets
virtual void propertyPanelDefined(ModuleBase_Operation* theOperation) {}
- /// Have an opportunity to create widgets for the current operation instead of standard creation in workshop
- /// \param theOperation a started operation
+ /// Have an opportunity to create widgets for the current operation
+ /// instead of standard creation in workshop
+ /// \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
/// \param theObject a model object
virtual bool canDisplayObject(const ObjectPtr& theObject) const;
+ /// Returns whether the started operation may use preselection of the previous one
+ /// Cases are: previous operation is null, edit operation, previuos and started operations
+ /// kinds are the same
+ /// \param thePreviousOperationKind a kind of previous operation
+ /// \param theStartedOperationKind a kind of a started operation
+ virtual bool canUsePreselection(const QString& thePreviousOperationKind,
+ const QString& theStartedOperationKind);
+
/// Make some functionality after the objects are hidden in viewer
/// \param theObjects a list of hidden objects
//virtual void processHiddenObject(const std::list<ObjectPtr>& theObjects) {};
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
/// \return boolean value
- virtual bool isCustomPrsActivated(const ModuleBase_CustomizeFlag& theFlag) const { return false; };
+ virtual bool isCustomPrsActivated(const ModuleBase_CustomizeFlag& theFlag) const
+ { return false; };
/// Activate custom presentation for the object. Default realization is empty.
/// \param theFeature a feature instance
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; };
/// 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;
virtual AttributePtr findAttribute(const ObjectPtr& theObject,
const GeomShapePtr& theGeomShape) = 0;
+ /// Returns reentrant message if it was accepted
+ virtual std::shared_ptr<Events_Message> reentrantMessage() = 0;
+
+ /// Put current selection into reentrant message
+ /// \param theMessage a message of reentrant operation
+ virtual void setReentrantPreSelection(const std::shared_ptr<Events_Message>& theMessage) = 0;
+
/// Returns XML information by the feature index
/// \param theFeatureId a feature id
/// \param theXmlCfg XML configuration
void getXMLRepresentation(const std::string& theFeatureId, std::string& theXmlCfg,
std::string& theDescription);
-signals:
- /// Signal which is emitted when operation is launched
- void operationLaunched();
+ /// 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
void resumed(ModuleBase_Operation* theOp);
/// \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() {}
/// Register validators for this module
virtual void registerValidators() {}
- /// Register selection filters for this module
- virtual void registerFilters() {}
-
/// Register properties of this module
virtual void registerProperties() {}
/// 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;
+
};
