#include "ModuleBase_IWorkshop.h"\r
\r
#include <ModelAPI_Feature.h>\r
+#include <ModelAPI_Attribute.h>\r
+\r
+#include <GeomAPI_Shape.h>\r
\r
#include <QString>\r
#include <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 interface\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 theUpdateViewer the parameter whether the viewer should be update immediately\r
- * \returns true if the object is modified\r
- */\r
- virtual bool customizeObject(ObjectPtr theObject, const bool theUpdateViewer);\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
+ /// 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
/// \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
virtual ModuleBase_Operation* getNewOperation(const std::string& theFeatureId);\r
\r
protected:\r
-\r
/// Reference to workshop\r
ModuleBase_IWorkshop* myWorkshop;\r
\r
