-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D\r
+ // Copyright (C) 2014-20xx CEA/DEN, EDF R&D\r
\r
#ifndef ModuleBase_IModule_H\r
#define ModuleBase_IModule_H\r
#include "ModuleBase_IWorkshop.h"\r
\r
#include <ModelAPI_Feature.h>\r
+#include <ModelAPI_Attribute.h>\r
+\r
+#include <GeomAPI_Shape.h>\r
+#include <GeomAPI_ICustomPrs.h>\r
\r
#include <QString>\r
#include <QObject>\r
+#include <QMap>\r
+#include <QList>\r
\r
#include <string>\r
+#include <vector>\r
#include <map>\r
\r
class QAction;\r
class QMouseEvent;\r
class QKeyEvent;\r
+class QMenu;\r
class Config_WidgetAPI;\r
class ModuleBase_ModelWidget;\r
class ModuleBase_Operation;\r
class ModuleBase_IWorkshop;\r
+class ModelAPI_Result;\r
+\r
+class Handle_AIS_InteractiveObject;\r
\r
/**\r
+ * \ingroup GUI\r
* Interface to a module\r
*/\r
class MODULEBASE_EXPORT ModuleBase_IModule : public QObject\r
{\r
Q_OBJECT\r
public:\r
+ /// enumeration to know which objects should be customized\r
+ enum ModuleBase_CustomizeFlag {\r
+ CustomizeArguments = 0, /// references of other objects referenced to the current feature\r
+ CustomizeResults, /// results of the current feature\r
+ CustomizeHighlightedObjects /// highlighted objects of the active widget\r
+ };\r
\r
/// Constructor\r
- /// \param theParent instance of workshop intrface\r
+ /// \param theParent instance of workshop interface\r
ModuleBase_IModule(ModuleBase_IWorkshop* theParent);\r
\r
virtual ~ModuleBase_IModule() {}\r
\r
+ /// Add default selection filters of the module to the current viewer\r
+ virtual void activateSelectionFilters() {};\r
+\r
+ /// Remove default selection filters of the module from the current viewer\r
+ virtual void deactivateSelectionFilters() {};\r
+\r
+ // Stores the current selection\r
+ virtual void storeSelection() {};\r
+\r
+ // Restores the current selection\r
+ virtual void restoreSelection() {};\r
+\r
/// Reads description of features from XML file \r
virtual void createFeatures();\r
\r
/// \param theFeature feature for editing\r
virtual void editFeature(FeaturePtr theFeature);\r
\r
+ /// Returns true if the operation can be committed. Result in default implementation is true.\r
+ /// \return boolean value\r
+ virtual bool canCommitOperation() const { return true; }\r
+\r
/// Creates an operation and send it to loop\r
/// \param theCmdId the operation name\r
virtual void launchOperation(const QString& theCmdId);\r
virtual void operationStarted(ModuleBase_Operation* theOperation) {}\r
\r
/// Realizes some functionality by an operation resume\r
+ /// By default it emits operationResumed signal\r
/// \param theOperation a resumed operation\r
- virtual void operationResumed(ModuleBase_Operation* theOperation) {}\r
+ virtual void operationResumed(ModuleBase_Operation* theOperation);\r
\r
/// Realizes some functionality by an operation stop\r
virtual void operationStopped(ModuleBase_Operation* theOperation) {}\r
/// Realizes some functionality by an operation abort\r
virtual void operationAborted(ModuleBase_Operation* theOperation) {}\r
\r
+ /// Realizes some functionality by an operation start\r
+ virtual ModuleBase_Operation* currentOperation() const = 0;\r
+\r
+ /// Add menu items for viewer into the given menu\r
+ /// \param theMenu a popup menu to be shown in the viewer\r
+ /// \param theStdActions a map of standard actions\r
+ /// \return true if items are added and there is no necessity to provide standard menu\r
+ virtual bool addViewerMenu(QMenu* theMenu, const QMap<QString, QAction*>& theStdActions) const\r
+ { return false; }\r
+\r
+ /// Add menu items for object browser into the given menu\r
+ /// \param theMenu a popup menu to be shown in the object browser\r
+ virtual void addObjectBrowserMenu(QMenu* theMenu) const {};\r
+\r
/// Creates custom widgets for property panel\r
/// \param theType a type of widget\r
/// \param theParent the parent object\r
- /// \param theWidgetApi the widget configuation. The attribute of the model widget is obtained from\r
- /// \param theParentId is Id of a parent of the current attribute\r
- /// \param theModelWidgets list of widget objects\r
- virtual QWidget* createWidgetByType(const std::string& theType, QWidget* theParent,\r
- Config_WidgetAPI* theWidgetApi, std::string theParentId,\r
- QList<ModuleBase_ModelWidget*>& theModelWidgets)\r
+ /// \param theWidgetApi the widget configuration. The attribute of the model widget is obtained from\r
+ virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,\r
+ Config_WidgetAPI* theWidgetApi)\r
{\r
return 0;\r
}\r
\r
+ /// Returns the active widget, by default it is the property panel active widget\r
+ virtual ModuleBase_ModelWidget* activeWidget() const = 0;\r
+\r
/// Returns current workshop\r
ModuleBase_IWorkshop* workshop() const { return myWorkshop; }\r
\r
/// It is called as on clearing of property panel as on filling with new widgets\r
virtual void propertyPanelDefined(ModuleBase_Operation* theOperation) {}\r
\r
- /// Returns whether the object can be displayed at the bounds of the active operation.\r
- /// Display only current operation results\r
+ /// Have an opportunity to create widgets for the current operation instead of standard creation in workshop\r
+ /// \param theOperation a started operation\r
+ /// \param theWidgets a list of created widgets\r
+ /// \return boolean result, false by default\r
+ virtual bool createWidgets(ModuleBase_Operation* theOperation,\r
+ QList<ModuleBase_ModelWidget*>& theWidgets) const { return false; }\r
+\r
+ //! Returns True if there are available Undos and there is not an active operation\r
+ virtual bool canUndo() const;\r
+\r
+ //! Returns True if there are available Redos and there is not an active operation\r
+ virtual bool canRedo() const;\r
+\r
+ /// Returns true if the action can be applyed to the object\r
+ /// \param theObject a checked object\r
+ /// \param theActionId an identifier of action, to be found in the menu manager like "DELETE_CMD"\r
+ /// \return the a boolean result\r
+ virtual bool canApplyAction(const ObjectPtr& theObject, const QString& theActionId) const = 0;\r
+\r
+ /// Returns True if the current operation can be committed. By default it is true.\r
+ /// \return a boolean value\r
+ //virtual bool canCommitOperation() const;\r
+\r
+ /// Returns whether the object can be erased. The default realization returns true.\r
+ /// \param theObject a model object\r
+ virtual bool canEraseObject(const ObjectPtr& theObject) const;\r
+\r
+ /// Returns whether the object can be displayed. The default realization returns true.\r
/// \param theObject a model object\r
virtual bool canDisplayObject(const ObjectPtr& theObject) const;\r
\r
+ /// Make some functionality after the objects are hidden in viewer\r
+ /// \param theObjects a list of hidden objects\r
+ virtual void processHiddenObject(const std::list<ObjectPtr>& theObjects) {};\r
+\r
+ /// Returns true if selection for the object can be activate.\r
+ /// By default a result or feature of the current operation can not be activated\r
+ /// \param theObject a model object\r
+ virtual bool canActivateSelection(const ObjectPtr& theObject) const;\r
+\r
+ /// Reacts to the delete action in module\r
+ /// \returns true if the action is processed\r
+ virtual bool deleteObjects() { return false; };\r
+\r
+ /// Performs functionality on closing document\r
+ virtual void closeDocument() = 0;\r
+\r
+ /// Clears specific presentations in the viewer\r
+ virtual void clearViewer() = 0;\r
+\r
+ /// Returns a list of modes, where the AIS objects should be activated\r
+ /// \param theModes a list of modes\r
+ virtual void activeSelectionModes(QIntList& theModes) {}\r
+\r
+ /// Activate custom presentation for the object. Default realization is empty.\r
+ /// \param theObject an object instance\r
+ /// \param theFlag a flag of level of customization, which means that only part of sub-elements\r
+ /// \param theUpdateViewer the parameter whether the viewer should be update immediately\r
+ virtual void activateCustomPrs(const FeaturePtr& theFeature,\r
+ const ModuleBase_CustomizeFlag& theFlag,\r
+ const bool theUpdateViewer) {}\r
+\r
+ /// Deactivate custom presentation for the object. Default realization is empty.\r
+ /// \param theFlag a flag of level of customization, which means that only part of sub-elements\r
+ /// \param theUpdateViewer the parameter whether the viewer should be update immediately\r
+ virtual void deactivateCustomPrs(const ModuleBase_CustomizeFlag& theFlag,\r
+ const bool theUpdateViewer) {}\r
+\r
+ /// Modifies the given presentation in the custom way.\r
+ virtual bool customisePresentation(std::shared_ptr<ModelAPI_Result> theResult, AISObjectPtr thePrs,\r
+ GeomCustomPrsPtr theCustomPrs) { return false; };\r
+\r
+ /// Update the object presentable properties such as color, lines width and other\r
+ /// If the object is result with the color attribute value set, it is used,\r
+ /// otherwise the customize is applyed to the object's feature if it is a custom prs\r
+ /// \param theObject an object instance\r
+ /// \param theFlag a flag of level of customization, which means that only part of sub-elements\r
+ /// should be updated(e.g. only highlighted elements)\r
+ /// \param theUpdateViewer the parameter whether the viewer should be update immediately\r
+ /// \returns true if the object is modified\r
+ virtual bool customizeObject(ObjectPtr theObject, const ModuleBase_CustomizeFlag& theFlag,\r
+ const bool theUpdateViewer);\r
+\r
+ /// This method is called on object browser creation for customization of module specific features\r
+ /// \param theObjectBrowser a pinter on Object Browser widget\r
+ virtual void customizeObjectBrowser(QWidget* theObjectBrowser) {}\r
+\r
+ /// Creates a new operation\r
+ /// \param theCmdId the operation name\r
+ virtual ModuleBase_Operation* createOperation(const std::string& theCmdId);\r
+\r
+ /// Sends the operation for launching\r
+ /// \param theOperation the operation\r
+ virtual void sendOperation(ModuleBase_Operation* theOperation);\r
+\r
+ /// Create specific for the module presentation\r
+ /// \param theResult an object for presentation\r
+ /// \return created presentation or NULL(default value)\r
+ virtual Handle_AIS_InteractiveObject createPresentation(\r
+ const std::shared_ptr<ModelAPI_Result>& theResult);\r
+\r
+ //! Returns data object by AIS\r
+ virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const = 0;\r
+\r
+ //! Returns true if the presentation can be shown in shading mode\r
+ //! \param theAIS presentation to be checked\r
+ //! \return boolean value\r
+ virtual bool canBeShaded(Handle(AIS_InteractiveObject) theAIS) const;\r
+\r
+ /// Update state of pop-up menu items in object browser\r
+ /// \param theStdActions - a map of standard actions\r
+ virtual void updateObjectBrowserMenu(const QMap<QString, QAction*>& theStdActions) {}\r
+\r
+ /// Update state of pop-up menu items in viewer\r
+ /// \param theStdActions - a map of standard actions\r
+ virtual void updateViewerMenu(const QMap<QString, QAction*>& theStdActions) {}\r
+\r
+ //! Returns the feature error if the current state of the feature in the module is not correct\r
+ //! If the feature is correct, it returns an empty value\r
+ //! \return string value\r
+ virtual QString getFeatureError(const FeaturePtr& theFeature);\r
+\r
+ /// Returns list of granted operation indices\r
+ virtual void grantedOperationIds(ModuleBase_Operation* theOperation, QStringList& theIds) const;\r
+\r
+ /// Connects or disconnects to the value changed signal of the property panel widgets\r
+ /// \param theWidget a property contol widget\r
+ /// \param isToConnect a boolean value whether connect or disconnect\r
+ virtual void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect) {};\r
+\r
+ /// Validates the operation to change the "Apply" button state.\r
+ /// \param thePreviousState the previous state of the widget\r
+ virtual void widgetStateChanged(int thePreviousState) {};\r
+\r
+ /// Returns true if the event is processed.\r
+ /// \param thePreviousAttributeID an index of the previous active attribute\r
+ virtual bool processEnter(const std::string& thePreviousAttributeID) { return false; };\r
+\r
+ /// Performs some GUI actions after an operation transaction is opened\r
+ /// Default realization is empty\r
+ virtual void beforeOperationStarted(ModuleBase_Operation* theOperation) {};\r
+\r
+ /// Performs some GUI actions before an operation transaction is stopped\r
+ /// Default realization is empty\r
+ virtual void beforeOperationStopped(ModuleBase_Operation* theOperation) {};\r
+\r
+ /// Finds a shape by attribute if it is possible\r
+ /// \param theAttribute an attribute\r
+ /// \return a geom shape\r
+ virtual GeomShapePtr findShape(const AttributePtr& theAttribute) = 0;\r
+\r
+ /// Finds an attribute by geom shape if it is possible\r
+ /// \param theObject an object of the attribute\r
+ /// \param theGeomShape a geom shape\r
+ /// \return theAttribute\r
+ virtual AttributePtr findAttribute(const ObjectPtr& theObject,\r
+ const GeomShapePtr& theGeomShape) = 0;\r
+\r
+ /// Returns XML information by the feature index\r
+ /// \param theFeatureId a feature id\r
+ /// \param theXmlCfg XML configuration\r
+ /// \param theDescription feature description\r
+ void getXMLRepresentation(const std::string& theFeatureId, std::string& theXmlCfg,\r
+ std::string& theDescription);\r
+\r
+signals:\r
+ /// Signal which is emitted when operation is launched\r
+ void operationLaunched();\r
+\r
+ /// Segnal emitted when an operation is resumed\r
+ /// \param theOp a resumed operation\r
+ void resumed(ModuleBase_Operation* theOp);\r
+\r
public slots:\r
/// Called on call of command corresponded to a feature\r
- void onFeatureTriggered();\r
+ virtual void onFeatureTriggered();\r
+\r
+ /// Slot called on object display\r
+ /// \param theObject a data object\r
+ /// \param theAIS a presentation object\r
+ virtual void onObjectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS) {}\r
+\r
+ /// Slot called on before object erase\r
+ /// \param theObject a data object\r
+ /// \param theAIS a presentation object\r
+ virtual void onBeforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS) {}\r
\r
protected slots:\r
/// Called on selection changed event\r
virtual void onSelectionChanged() {}\r
\r
protected:\r
- /// Sends the operation for launching\r
- /// \param theOperation the operation\r
- void sendOperation(ModuleBase_Operation* theOperation);\r
-\r
- /// Creates a new operation\r
- /// \param theCmdId the operation name\r
- virtual ModuleBase_Operation* createOperation(const std::string& theCmdId);\r
-\r
/// Register validators for this module\r
virtual void registerValidators() {}\r
\r
/// Register selection filters for this module\r
virtual void registerFilters() {}\r
\r
+ /// Register properties of this module\r
+ virtual void registerProperties() {}\r
+\r
/// Returns new instance of operation object (used in createOperation for customization)\r
virtual ModuleBase_Operation* getNewOperation(const std::string& theFeatureId);\r
\r
protected:\r
-\r
/// Reference to workshop\r
ModuleBase_IWorkshop* myWorkshop;\r
\r
