#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 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
public:\r
/// enumeration to know which objects should be customized\r
enum ModuleBase_CustomizeFlag {\r
- CustomizeDependedAndResults = 0x00000000,\r
- CustomizeHighlightedObjects = 0x00000001,\r
- CustomizeAllObjects = CustomizeDependedAndResults | CustomizeHighlightedObjects\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
/// 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
\r
+ /// Executes feature as a modal dialog box\r
+ /// \param theCmdId the operation name\r
+ virtual void launchModal(const QString& theCmdId);\r
+\r
/// Realizes some functionality by an operation start\r
/// \param theOperation a started operation\r
virtual void operationStarted(ModuleBase_Operation* theOperation) {}\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
+ /// Add menu items for viewer into the actions map\r
/// \param theStdActions a map of standard actions\r
+ /// \param theParent a parent widget\r
+ /// \param theMenuActions map of action/menu for the desirable index in the viewer menu\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 { return false; }\r
+ virtual bool addViewerMenu(const QMap<QString, QAction*>& theStdActions,\r
+ QWidget* theParent,\r
+ QMap<int, QAction*>& theMenuActions) 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
/// \param theType a type of widget\r
/// \param theParent the parent object\r
/// \param theWidgetApi the widget configuration. The attribute of the model widget is obtained from\r
- /// \param theParentId is Id of a parent of the current attribute\r
virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,\r
- Config_WidgetAPI* theWidgetApi, std::string theParentId)\r
+ Config_WidgetAPI* theWidgetApi)\r
{\r
return 0;\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
+ /// 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
/// \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
/// \param theModes a list of modes\r
virtual void activeSelectionModes(QIntList& theModes) {}\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
- */\r
+ /// Activate custom presentation for the object. Default realization is empty.\r
+ /// \param theFeature a feature 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
/// \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
/// 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
/// Called on selection changed event\r
virtual void onSelectionChanged() {}\r
\r
- protected:\r
- /// Register validators for this module\r
+protected:\r
+ /// Register validators for this module\r
virtual void registerValidators() {}\r
\r
/// Register selection filters for this module\r
virtual ModuleBase_Operation* getNewOperation(const std::string& theFeatureId);\r
\r
protected:\r
-\r
/// Reference to workshop\r
ModuleBase_IWorkshop* myWorkshop;\r
\r
