X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_IModule.h;h=769af80dc43f302a7e168acf2e6b03255da48426;hb=49d5a27258260087aad5e7ca30d6863e08a186d1;hp=45c895ded35147f81ab5f3727f49997f4773b8cc;hpb=e1fe93d90eb9de8f45ad0ba420a2811f40fcaf91;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_IModule.h b/src/ModuleBase/ModuleBase_IModule.h index 45c895ded..769af80dc 100755 --- a/src/ModuleBase/ModuleBase_IModule.h +++ b/src/ModuleBase/ModuleBase_IModule.h @@ -7,12 +7,18 @@ #include "ModuleBase_IWorkshop.h" #include +#include + +#include +#include #include #include #include +#include #include +#include #include class QAction; @@ -23,6 +29,9 @@ class Config_WidgetAPI; class ModuleBase_ModelWidget; class ModuleBase_Operation; class ModuleBase_IWorkshop; +class ModelAPI_Result; + +class Handle_AIS_InteractiveObject; /** * \ingroup GUI @@ -34,9 +43,9 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject public: /// enumeration to know which objects should be customized enum ModuleBase_CustomizeFlag { - CustomizeDependedAndResults = 0x00000000, - CustomizeHighlightedObjects = 0x00000001, - CustomizeAllObjects = CustomizeDependedAndResults | CustomizeHighlightedObjects + CustomizeArguments = 0, /// references of other objects referenced to the current feature + CustomizeResults, /// results of the current feature + CustomizeHighlightedObjects /// highlighted objects of the active widget }; /// Constructor @@ -51,6 +60,12 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject /// Remove default selection filters of the module from the current viewer virtual void deactivateSelectionFilters() {}; + /// Stores the current selection + virtual void storeSelection() {}; + + /// Restores the current selection + virtual void restoreSelection() {}; + /// Reads description of features from XML file virtual void createFeatures(); @@ -61,10 +76,18 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject /// \param theFeature feature for editing virtual void editFeature(FeaturePtr theFeature); + /// Returns true if the operation can be committed. Result in default implementation is true. + /// \return boolean value + virtual bool canCommitOperation() const { return true; } + /// Creates an operation and send it to loop /// \param theCmdId the operation name virtual void launchOperation(const QString& theCmdId); + /// Executes feature as a modal dialog box + /// \param theCmdId the operation name + virtual void launchModal(const QString& theCmdId); + /// Realizes some functionality by an operation start /// \param theOperation a started operation virtual void operationStarted(ModuleBase_Operation* theOperation) {} @@ -86,11 +109,15 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject /// Realizes some functionality by an operation start virtual ModuleBase_Operation* currentOperation() const = 0; - /// Add menu items for viewer into the given menu - /// \param theMenu a popup menu to be shown in the viewer + /// Add menu items for viewer into the actions map /// \param theStdActions a map of standard actions + /// \param theParent a parent widget + /// \param theMenuActions map of action/menu for the desirable index in the viewer menu /// \return true if items are added and there is no necessity to provide standard menu - virtual bool addViewerMenu(QMenu* theMenu, const QMap& theStdActions) const { return false; } + virtual bool addViewerMenu(const QMap& theStdActions, + QWidget* theParent, + QMap& theMenuActions) const + { return false; } /// Add menu items for object browser into the given menu /// \param theMenu a popup menu to be shown in the object browser @@ -100,9 +127,8 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject /// \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 - /// \param theParentId is Id of a parent of the current attribute virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent, - Config_WidgetAPI* theWidgetApi, std::string theParentId) + Config_WidgetAPI* theWidgetApi) { return 0; } @@ -117,6 +143,13 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject /// 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 + /// \param theWidgets a list of created widgets + /// \return boolean result, false by default + virtual bool createWidgets(ModuleBase_Operation* theOperation, + QList& theWidgets) const { return false; } + //! Returns True if there are available Undos and there is not an active operation virtual bool canUndo() const; @@ -141,6 +174,10 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject /// \param theObject a model object virtual bool canDisplayObject(const ObjectPtr& theObject) const; + /// Make some functionality after the objects are hidden in viewer + /// \param theObjects a list of hidden objects + virtual void processHiddenObject(const std::list& theObjects) {}; + /// Returns true if selection for the object can be activate. /// By default a result or feature of the current operation can not be activated /// \param theObject a model object @@ -160,15 +197,32 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject /// \param theModes a list of modes virtual void activeSelectionModes(QIntList& theModes) {} - /** 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, - * otherwise the customize is applyed to the object's feature if it is a custom prs - * \param theObject an object instance - * \param theFlag a flag of level of customization, which means that only part of sub-elements - * 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 - */ + /// Activate custom presentation for the object. Default realization is empty. + /// \param theFeature a feature instance + /// \param theFlag a flag of level of customization, which means that only part of sub-elements + /// \param theUpdateViewer the parameter whether the viewer should be update immediately + virtual void activateCustomPrs(const FeaturePtr& theFeature, + const ModuleBase_CustomizeFlag& theFlag, + const bool theUpdateViewer) {} + + /// Deactivate custom presentation for the object. Default realization is empty. + /// \param theFlag a flag of level of customization, which means that only part of sub-elements + /// \param theUpdateViewer the parameter whether the viewer should be update immediately + virtual void deactivateCustomPrs(const ModuleBase_CustomizeFlag& theFlag, + const bool theUpdateViewer) {} + + /// Modifies the given presentation in the custom way. + virtual bool customisePresentation(std::shared_ptr 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, + /// otherwise the customize is applyed to the object's feature if it is a custom prs + /// \param theObject an object instance + /// \param theFlag a flag of level of customization, which means that only part of sub-elements + /// 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); @@ -184,9 +238,20 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject /// \param theOperation the operation virtual void sendOperation(ModuleBase_Operation* theOperation); + /// Create specific for the module presentation + /// \param theResult an object for presentation + /// \return created presentation or NULL(default value) + virtual Handle_AIS_InteractiveObject createPresentation( + const std::shared_ptr& theResult); + //! Returns data object by AIS virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const = 0; + //! Returns true if the presentation can be shown in shading mode + //! \param theAIS presentation to be checked + //! \return boolean value + virtual bool canBeShaded(Handle(AIS_InteractiveObject) theAIS) const; + /// Update state of pop-up menu items in object browser /// \param theStdActions - a map of standard actions virtual void updateObjectBrowserMenu(const QMap& theStdActions) {} @@ -224,6 +289,25 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject /// Default realization is empty virtual void beforeOperationStopped(ModuleBase_Operation* theOperation) {}; + /// Finds a shape by attribute if it is possible + /// \param theAttribute an attribute + /// \return a geom shape + virtual GeomShapePtr findShape(const AttributePtr& theAttribute) = 0; + + /// Finds an attribute by geom shape if it is possible + /// \param theObject an object of the attribute + /// \param theGeomShape a geom shape + /// \return theAttribute + virtual AttributePtr findAttribute(const ObjectPtr& theObject, + const GeomShapePtr& theGeomShape) = 0; + + /// Returns XML information by the feature index + /// \param theFeatureId a feature id + /// \param theXmlCfg XML configuration + /// \param theDescription feature description + void getXMLRepresentation(const std::string& theFeatureId, std::string& theXmlCfg, + std::string& theDescription); + signals: /// Signal which is emitted when operation is launched void operationLaunched(); @@ -250,8 +334,8 @@ protected slots: /// Called on selection changed event virtual void onSelectionChanged() {} - protected: - /// Register validators for this module +protected: + /// Register validators for this module virtual void registerValidators() {} /// Register selection filters for this module @@ -264,7 +348,6 @@ protected slots: virtual ModuleBase_Operation* getNewOperation(const std::string& theFeatureId); protected: - /// Reference to workshop ModuleBase_IWorkshop* myWorkshop;