Salome HOME
Update TestConstraintEqual.py
[modules/shaper.git] / src / PartSet / PartSet_Module.h
index 1a726e21268a9fa4ccd3c95aa670ad92ca8308a5..6c5a5e0b6b70d09da5b863ec6e5bd1346e228063 100755 (executable)
@@ -4,6 +4,7 @@
 #define PartSet_Module_H
 
 #include "PartSet.h"
+#include "PartSet_Tools.h"
 
 #include <ModuleBase_IModule.h>
 #include <ModuleBase_Definitions.h>
@@ -136,6 +137,10 @@ public:
   /// \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<ObjectPtr>& theObjects);
+
   /// Returns true if selection for the object can be activate.
   /// For sketch operation allow the selection activation if the operation is edit, for other
   /// operation uses the default result
@@ -180,14 +185,30 @@ public:
   /// \param theFeature a feature
   void setCustomized(const FeaturePtr& theFeature);
 
-  /** 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 immediatelly
-  * \returns true if the object is modified
-  */
-  virtual bool customizeObject(ObjectPtr theObject, const bool theUpdateViewer);
+  /// Activate custom presentation for the object
+  /// \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
+  /// \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);
+
+  /// 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 immediatelly
+  /// \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 customisation of module specific features
   /// \param theObjectBrowser a pinter on Object Browser widget
@@ -206,19 +227,38 @@ public:
   //! Returns the feature error if the current state of the feature in the module is not correct
   //! If the feature is correct, it returns an empty value
   //! \return string value
-  virtual QString getFeatureError(const FeaturePtr& theFeature, const bool isCheckGUI = true);
+  virtual QString getFeatureError(const FeaturePtr& theFeature);
 
   /// Returns list of granted operation indices
   virtual void grantedOperationIds(ModuleBase_Operation* theOperation, QStringList& theIds) const;
 
   /// Validates the current operation and send the state change to sketch manager
-  /// \thePrevState the previous widget value state
+  /// \param thePreviousState the previous widget value state
   virtual void widgetStateChanged(int thePreviousState);
 
   /// Returns true if the event is processed. It gives the reentrance manager to process the enter.
   /// \param thePreviousAttributeID an index of the previous active attribute
   virtual bool processEnter(const std::string& thePreviousAttributeID);
 
+  /// Performs some GUI actions after an operation transaction is opened
+  /// Default realization is empty
+  virtual void beforeOperationStarted(ModuleBase_Operation* theOperation);
+
+  /// Performs some GUI actions before an operation transaction is stopped
+  /// 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);
+
+  /// 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);
+
 public slots:
   /// Redefines the parent method in order to customize the next case:
   /// If the sketch nested operation is active and the presentation is not visualized in the viewer,
@@ -255,6 +295,10 @@ protected slots:
   /// A slot called on view window creation
   void onViewCreated(ModuleBase_IViewWindow*);
 
+  /// A slot to change property panel title on change of boolean operation type
+  /// \param theOperation the operation type
+  void onBooleanOperationChange(int theOperation);
+
 protected:
   /// Register validators for this module
   virtual void registerValidators();
@@ -290,7 +334,8 @@ protected:
   PartSet_CustomPrs* myCustomPrs;
   int myVisualLayerId;
 
-  bool myHasConstraintShown;
+  /// backup of the visible state to restore them by operation stop
+  QMap<PartSet_Tools::ConstraintVisibleState, bool> myHasConstraintShown;
 
   QModelIndex aActivePartIndex;
 };