Salome HOME
Additional check redundant constraints in PlaneGCS to show the "Conflicting constrain...
[modules/shaper.git] / src / PartSet / PartSet_Module.h
index 6c5a5e0b6b70d09da5b863ec6e5bd1346e228063..f6d8fa9210ff5e3dc27fec135e5f0a6f9f2e8fc1 100755 (executable)
@@ -5,6 +5,7 @@
 
 #include "PartSet.h"
 #include "PartSet_Tools.h"
+#include "PartSet_OverconstraintListener.h"
 
 #include <ModuleBase_IModule.h>
 #include <ModuleBase_Definitions.h>
 
 class ModuleBase_Operation;
 class ModuleBase_IViewWindow;
+class XGUI_Workshop;
 class PartSet_MenuMgr;
 class PartSet_CustomPrs;
 class PartSet_SketcherMgr;
 class PartSet_SketcherReetntrantMgr;
+class ModelAPI_Result;
 
 class QAction;
 
@@ -64,9 +67,15 @@ public:
   // Remove default selection filters of the module from the current viewer
   virtual void deactivateSelectionFilters();
 
+  // Stores the current selection
+  virtual void storeSelection();
+
+  // Restores the current selection
+  virtual void restoreSelection();
+
   /// Creates custom widgets for property panel
   virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,
-                                                     Config_WidgetAPI* theWidgetApi, std::string theParentId);
+                                                     Config_WidgetAPI* theWidgetApi);
 
   /// Returns the active widget, by default it is the property panel active widget
   /// If the internal edit operation is started, this is the first widget of the operation
@@ -75,6 +84,22 @@ public:
   /// Call back forlast tuning of property panel before operation performance
   virtual void propertyPanelDefined(ModuleBase_Operation* theOperation);
 
+  /// If there is found selected attribute, widgets are created and contains only a widget for the attribute
+  /// It is important for Property Panel filling by sketch point attribute
+  /// \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<ModuleBase_ModelWidget*>& theWidgets) const;
+
+  /// Launching of a edit operation on the feature 
+  /// \param theFeature feature for editing
+  virtual void editFeature(FeaturePtr theFeature);
+
+  /// Returns true if the operation can be committed. Result in default implementation is true.
+  /// \return boolean value
+  virtual bool canCommitOperation() const;
+
   /// Creates an operation and send it to loop
   /// \param theCmdId the operation name
   virtual void launchOperation(const QString& theCmdId);
@@ -139,7 +164,7 @@ public:
 
   /// 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);
+  //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
@@ -151,16 +176,23 @@ public:
   /// \param theMenu a popup menu to be shown in the object browser
   virtual void addObjectBrowserMenu(QMenu* theMenu) const;
 
-  /// Add menu atems for viewer into the given menu
-  /// \param theMenu a popup menu to be shown in the viewer
+  /// Add menu items for viewer into the actions map
   /// \param theStdActions a map of standard actions
+  /// \param theParent a parent widget
+  /// \param theMenuActions map of action/menu for the desirable index in the viewer menu
   /// \return true if items are added and there is no necessity to provide standard menu
-  virtual bool addViewerMenu(QMenu* theMenu, const QMap<QString, QAction*>& theStdActions) const;
+  virtual bool addViewerMenu(const QMap<QString, QAction*>& theStdActions,
+                             QWidget* theParent,
+                             QMap<int, QAction*>& theMenuActions) const;
 
   /// Returns a list of modes, where the AIS objects should be activated
   /// \param theModes a list of modes
   virtual void activeSelectionModes(QIntList& theModes);
 
+  /// Appends specific selection modes for the module to the list of types
+  /// \param theTypes a selection modes to be extended
+  virtual void customSubShapesSelectionModes(QIntList& theTypes);
+
   /// Returns whether the mouse enter the viewer's window
   /// \return true if items are added and there is no necessity to provide standard menu
   bool isMouseOverWindow();
@@ -171,6 +203,10 @@ public:
   /// Returns sketch reentrant manager
   PartSet_SketcherReetntrantMgr* sketchReentranceMgr() { return mySketchReentrantMgr; }
 
+  /// Returns listener of overconstraint signal
+  /// \return the listener
+  PartSet_OverconstraintListener* overconstraintListener() { return myOverconstraintListener; }
+
   /// Performs functionality on closing document
   virtual void closeDocument();
 
@@ -199,6 +235,11 @@ public:
   virtual void deactivateCustomPrs(const ModuleBase_CustomizeFlag& theFlag,
                                    const bool theUpdateViewer);
 
+  /// Modifies the given presentation in the custom way.
+  virtual bool customisePresentation(std::shared_ptr<ModelAPI_Result> theResult,
+                                     AISObjectPtr thePrs,
+                                     std::shared_ptr<GeomAPI_ICustomPrs> theCustomPrs);
+
   /// 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
@@ -217,9 +258,20 @@ public:
   /// Returns the viewer Z layer
   int getVisualLayerId() const { return myVisualLayerId; }
 
+  /// Create specific for the module presentation
+  /// \param theResult an object for presentation
+  /// \return created presentation or NULL(default value)
+  virtual Handle(AIS_InteractiveObject) createPresentation(
+                              const std::shared_ptr<ModelAPI_Result>& theResult);
+
   //! Returns data object by AIS
   virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const;
 
+  //! Returns true if the presentation can be shown in shading mode
+  //! \param theAIS presentation to be checked
+  //! \return boolean value
+  virtual bool canBeShaded(Handle(AIS_InteractiveObject) theAIS) const;
+
   /// Update state of pop-up menu items in viewer
   /// \param theStdActions - a map of standard actions
   virtual void updateViewerMenu(const QMap<QString, QAction*>& theStdActions); 
@@ -288,18 +340,26 @@ protected slots:
   /// \param theEvent the key event
   void onKeyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
 
-  /// SLOT, that is called by the current operation filling with the preselection.
-  /// It commits the operation of it is can be committed
-  void onOperationActivatedByPreselection();
-
   /// 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);
+  /// A slot to change property panel title by choice type change if the title information
+  /// exists in the XML definition of this control attribute
+  /// \param theWidget a sender
+  /// \param theIndex the current choice index
+  void onChoiceChanged(ModuleBase_ModelWidget* theWidget, int theIndex);
 
 protected:
+  /// Sets the constraints states in internal map. If the feature kind is a dimensional constraint
+  /// other dimensions are shown.
+  /// \param theFeatureKindId a feature kind
+  void storeConstraintsState(const std::string& theFeatureKindId);
+
+  /// If the feature kind is a geometrical or dimensional constraint, set visible state for
+  /// all types of constraints
+  /// \param theFeatureKindId a feature kind
+  void updateConstraintsState(const std::string& theFeatureKind);
+
   /// Register validators for this module
   virtual void registerValidators();
 
@@ -314,17 +374,27 @@ protected:
   /// \param isToConnect a boolean value whether connect or disconnect
   virtual void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect);
 
+  /// Realizes some functionality by an operation start
+  /// Displays all sketcher sub-Objects, hides sketcher result, appends selection filters
+  /// Activate the operation presentation
+  /// \param theOperation a started operation
+  virtual void operationStartedInternal(ModuleBase_Operation* theOperation);
+
  private slots:
    void onTreeViewDoubleClick(const QModelIndex&);
 
    void onActiveDocPopup(const QPoint&);
 
  private:
-
   //! Delete features
   virtual bool deleteObjects();
 
- private:
+  /// Returns the workshop
+  XGUI_Workshop* getWorkshop() const;
+
+  void setDefaultConstraintShown();
+
+private:
   SelectMgr_ListOfFilter mySelectionFilters;
 
   PartSet_SketcherMgr* mySketchMgr;
@@ -332,6 +402,7 @@ protected:
   PartSet_MenuMgr* myMenuMgr;
   /// A default custom presentation, which is used for references objects of started operation
   PartSet_CustomPrs* myCustomPrs;
+  PartSet_OverconstraintListener* myOverconstraintListener;
   int myVisualLayerId;
 
   /// backup of the visible state to restore them by operation stop