Salome HOME
Issue #805 In the sketch presentation, show both the parameter and its value: providi...
[modules/shaper.git] / src / PartSet / PartSet_Module.h
old mode 100644 (file)
new mode 100755 (executable)
index 9746f43..8a54eff
@@ -4,7 +4,8 @@
 #define PartSet_Module_H
 
 #include "PartSet.h"
-#include "PartSet_DocumentDataModel.h"
+#include "PartSet_Tools.h"
+#include "PartSet_OverconstraintListener.h"
 
 #include <ModuleBase_IModule.h>
 #include <ModuleBase_Definitions.h>
@@ -21,6 +22,7 @@
 #include <QMap>
 #include <QMenu>
 #include <QObject>
+#include <QModelIndex>
 
 #include <string>
 
 
 class ModuleBase_Operation;
 class ModuleBase_IViewWindow;
+class XGUI_Workshop;
 class PartSet_MenuMgr;
 class PartSet_CustomPrs;
 class PartSet_SketcherMgr;
+class PartSet_SketcherReetntrantMgr;
 
 class QAction;
 
@@ -62,13 +66,35 @@ 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
+  virtual ModuleBase_ModelWidget* activeWidget() const;
 
   /// 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);
+
   /// Creates an operation and send it to loop
   /// \param theCmdId the operation name
   virtual void launchOperation(const QString& theCmdId);
@@ -77,27 +103,27 @@ public:
   /// Displays all sketcher sub-Objects, hides sketcher result, appends selection filters
   /// Activate the operation presentation
   /// \param theOperation a started operation
-  virtual void onOperationStarted(ModuleBase_Operation* theOperation);
+  virtual void operationStarted(ModuleBase_Operation* theOperation);
 
   /// Realizes some functionality by an operation resume
   /// Activate the operation presentation
   /// \param theOperation a resumed operation
-  virtual void onOperationResumed(ModuleBase_Operation* theOperation);
+  virtual void operationResumed(ModuleBase_Operation* theOperation);
 
   /// Realizes some functionality by an operation commit
   /// Restarts sketcher operation automatically of it is necessary
   /// \param theOperation a committed operation
-  virtual void onOperationCommitted(ModuleBase_Operation* theOperation);
+  virtual void operationCommitted(ModuleBase_Operation* theOperation);
 
   /// Realizes some functionality by an operation abort
   /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
   /// \param theOperation an aborted operation
-  virtual void onOperationAborted(ModuleBase_Operation* theOperation);
+  virtual void operationAborted(ModuleBase_Operation* theOperation);
 
   /// Realizes some functionality by an operation stop
   /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
   /// \param theOperation a stopped operation
-  virtual void onOperationStopped(ModuleBase_Operation* theOperation);
+  virtual void operationStopped(ModuleBase_Operation* theOperation);
 
   /// Returns current operation
   virtual ModuleBase_Operation* currentOperation() const;
@@ -118,7 +144,7 @@ public:
 
   /// Returns True if the current operation can be committed. Asks the sketch manager.
   /// \return a boolean value
-  virtual bool canCommitOperation() const;
+  //virtual bool canCommitOperation() const;
 
   /// Returns whether the object can be erased at the bounds of the active operation.
   /// The sub-objects of the current operation can not be erased
@@ -131,6 +157,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
@@ -155,12 +185,15 @@ public:
   /// \return true if items are added and there is no necessity to provide standard menu
   bool isMouseOverWindow();
 
+  /// Returns sketch manager object
   PartSet_SketcherMgr* sketchMgr() const { return mySketchMgr; }
 
-#ifdef ModuleDataModel
-  /// Returns data model object for representation of data tree in Object browser
-  virtual ModuleBase_IDocumentDataModel* dataModel() const { return myDataModel; }
-#endif
+  /// 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();
@@ -176,14 +209,34 @@ 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);
+
+  /// Modifies the given presentation in the custom way.
+  virtual bool customisePresentation(ResultPtr 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
+  /// \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
@@ -204,11 +257,37 @@ public:
   //! \return string value
   virtual QString getFeatureError(const FeaturePtr& theFeature);
 
-public slots:
-  /// SLOT, that is called by no more widget signal emitted by property panel
-  /// Set a specific flag to restart the sketcher operation
-  void onNoMoreWidgets();
+  /// 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
+  /// \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,
   /// the operation should be always aborted.
@@ -237,18 +316,21 @@ protected slots:
   /// \param theEvent the key event
   void onKeyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
 
-  /// SLOT, that is called by enter key released
-  /// Set a specific type of restarting the current operation
-  void onEnterReleased();
-
-  /// 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*);
 
- protected:
+  /// 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);
+
   /// Register validators for this module
   virtual void registerValidators();
 
@@ -258,37 +340,43 @@ protected slots:
   /// Register properties of this module
   virtual void registerProperties();
 
- private slots:
-   /// Processing of vertex selected
-   void onVertexSelected();
+  /// Connects or disconnects to the value changed signal of the property panel widgets
+  /// \param theWidget a property contol widget
+  /// \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:
-  /// Breaks sequense of automatically resterted operations
-  void breakOperationSequence();
 
   //! Delete features
   virtual bool deleteObjects();
 
- private:
-   QString myLastOperationId;
-   FeaturePtr myLastFeature;
-
-   // Automatical restarting mode flag
-   RestartingMode myRestartingMode;
+  /// Returns the workshop
+  XGUI_Workshop* getWorkshop() const;
 
+ private:
   SelectMgr_ListOfFilter mySelectionFilters;
 
   PartSet_SketcherMgr* mySketchMgr;
+  PartSet_SketcherReetntrantMgr* mySketchReentrantMgr;
   PartSet_MenuMgr* myMenuMgr;
   /// A default custom presentation, which is used for references objects of started operation
   PartSet_CustomPrs* myCustomPrs;
+  PartSet_OverconstraintListener* myOverconstraintListener;
   int myVisualLayerId;
 
-#ifdef ModuleDataModel
-  PartSet_DocumentDataModel* myDataModel;
-#endif
+  /// backup of the visible state to restore them by operation stop
+  QMap<PartSet_Tools::ConstraintVisibleState, bool> myHasConstraintShown;
 
   QModelIndex aActivePartIndex;
 };