X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_IModule.h;h=75a962dad7abdc0608b485fc8273deb31ad0614a;hb=061a63480f6840b6d945f7744b3b972e2d4cb25d;hp=acd6b49acef50c0332d35978bfdaf2c63b38693b;hpb=cbde248859fb0072f6012907391ea90cfc254574;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_IModule.h b/src/ModuleBase/ModuleBase_IModule.h index acd6b49ac..75a962dad 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; @@ -32,6 +38,12 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject { Q_OBJECT public: + /// enumeration to know which objects should be customized + enum ModuleBase_CustomizeFlag { + 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 /// \param theParent instance of workshop interface @@ -111,6 +123,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; @@ -135,6 +154,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 @@ -154,14 +177,34 @@ 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 theUpdateViewer the parameter whether the viewer should be update immediately - * \returns true if the object is modified - */ - virtual bool customizeObject(ObjectPtr theObject, const bool theUpdateViewer); + /// Activate custom presentation for the object. Default realization is empty. + /// \param theObject an object 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(ResultPtr 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); /// This method is called on object browser creation for customization of module specific features /// \param theObjectBrowser a pinter on Object Browser widget @@ -191,11 +234,6 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject //! \return string value virtual QString getFeatureError(const FeaturePtr& theFeature); - //! Returns the widget error, get it from the attribute validator and state of the widget - //! If the feature is correct, it returns an empty value - //! \return string value - virtual QString getWidgetError(ModuleBase_ModelWidget* theWidget); - /// Returns list of granted operation indices virtual void grantedOperationIds(ModuleBase_Operation* theOperation, QStringList& theIds) const; @@ -220,6 +258,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(); @@ -260,7 +317,6 @@ protected slots: virtual ModuleBase_Operation* getNewOperation(const std::string& theFeatureId); protected: - /// Reference to workshop ModuleBase_IWorkshop* myWorkshop;