Salome HOME
Feature selector widget for recover feature.
[modules/shaper.git] / src / PartSet / PartSet_SketcherMgr.h
index a08cf394162255f2f5aa3e2caf9c8fa076b644fb..47ea8850adf1add3897ecfc827f1cc791ff78e40 100644 (file)
@@ -9,6 +9,9 @@
 
 #include "PartSet.h"
 
+#include "PartSet_Filters.h"
+#include "PartSet_Tools.h"
+
 #include <ModelAPI_Feature.h>
 #include <ModelAPI_Attribute.h>
 #include <ModelAPI_CompositeFeature.h>
@@ -16,6 +19,7 @@
 
 #include <ModuleBase_ViewerFilters.h>
 #include <ModuleBase_Definitions.h>
+#include <ModuleBase_ModelWidget.h>
 
 #include <GeomAPI_Pln.h>
 #include <SelectMgr_IndexedMapOfOwner.hxx>
@@ -28,6 +32,11 @@ class PartSet_Module;
 class ModuleBase_IViewWindow;
 class ModuleBase_ModelWidget;
 class ModuleBase_Operation;
+class XGUI_OperationMgr;
+class XGUI_Workshop;
+
+class Handle_AIS_InteractiveObject;
+
 class QMouseEvent;
 
 /**
@@ -82,18 +91,42 @@ public:
   /// \return the boolean result
   static bool isSketchOperation(ModuleBase_Operation* theOperation);
 
-  /// Returns true if the operation id is in the sketch operation id list
+  /// Returns true if the operation feature belongs to list of granted features of Sketch
+  /// operation. An operation of a sketch should be started before.
   /// \param theOperation an operation
   /// \return the boolean result
-  static bool isNestedSketchOperation(ModuleBase_Operation* theOperation);
+  bool isNestedSketchOperation(ModuleBase_Operation* theOperation) const;
+
+  /// Returns true if the operation is a create and nested sketch operationn
+  /// \param theOperation a checked operation
+  /// \param theSketch a sketch feature
+  //// \return boolean value
+  bool isNestedCreateOperation(ModuleBase_Operation* theOperation,
+                                      const CompositeFeaturePtr& /*theSketch*/) const;
+
+  /// Returns true if the operation is an edit nested feature one
+  /// \param theOperation a checked operation
+  //// \return boolean value
+  bool isNestedEditOperation(ModuleBase_Operation* theOperation,
+                                    const CompositeFeaturePtr& /*theSketch*/) const;
+
+  /// Returns whether the current operation is a sketch entity - line, point, arc or circle
+  /// \param theId is an id of object
+  /// \return a boolean value
+  static bool isEntity(const std::string& theId);
 
-  /// Returns whethe the current operation is a sketch distance - lenght, distance or radius
-  /// \param the operation
+  /// Returns whether the current operation is a sketch distance - lenght, distance or radius
+  /// \param theOperation the operation
   /// \return a boolean value
   static bool isDistanceOperation(ModuleBase_Operation* theOperation);
 
-  /// Launches the operation from current highlighting
-  void launchEditing();
+  /// Returns whether the feature kind is a sketch distance - lenght, distance or radius
+  /// \param theKind the feature kind
+  /// \return a boolean value
+  static bool isDistanceKind(std::string& theKind);
+
+  /// Returns true if a mouse cursor is over viewer window
+  bool isMouseOverWindow() { return myIsMouseOverWindow; }
 
   /// Returns current Sketch feature/ Returns NULL if there is no launched sketch operation
   CompositeFeaturePtr activeSketch() const { return myCurrentSketch; }
@@ -104,11 +137,43 @@ public:
   /// Stops sketch operation
   void stopSketch(ModuleBase_Operation* );
 
-  /// Starts sketch operation
-  void startNestedSketch(ModuleBase_Operation* );
+  /// Starts sketch operation, connects to the opeation property panel
+  /// \param theOperation a committed operation
+  void startNestedSketch(ModuleBase_Operation* theOperation);
 
-  /// Stops sketch operation
-  void stopNestedSketch(ModuleBase_Operation* );
+  /// Stop sketch operation, disconnects from the opeation property panel
+  /// \param theOperation a stopped operation
+  void stopNestedSketch(ModuleBase_Operation* theOperation);
+
+  /// Visualizes the operation feature if it is a creation nested feature operation
+  /// \param theOperation a committed operation
+  void commitNestedSketch(ModuleBase_Operation* theOperation);
+
+  /// Append the sketch plane filter into the current viewer
+  /// \param toActivate state whether the filter should be activated/deactivated
+  void activatePlaneFilter(const bool& toActivate);
+
+  /// Commit the operation if it is possible. If the operation is dimention constraint,
+  /// it gives widget editor to input dimention value
+  /// \return true if the operation is stopped after activation
+  bool operationActivatedByPreselection();
+
+  /// Returns True if there are available Undos and the sketch manager allows undo
+  /// \return the boolean result
+  bool canUndo() const;
+
+  //! Returns True if there are available Redos and the sketch manager allows redo
+  /// \return the boolean result
+  bool canRedo() const;
+
+  /// Returns False only if the sketch creating feature can not be visualized.
+  /// \return a boolean value
+  //bool canCommitOperation() const;
+
+  /// Returns whether the object can be erased at the bounds of the active operation.
+  /// Sketch sub-entities can not be erased during the sketch operation
+  /// \param theObject a model object
+  bool canEraseObject(const ObjectPtr& theObject) const;
 
   /// Returns whether the object can be displayed at the bounds of the active operation.
   /// Display only current operation results for usual operation and ask the sketcher manager
@@ -116,60 +181,140 @@ public:
   /// \param theObject a model object
   bool canDisplayObject(const ObjectPtr& theObject) const;
 
+  /// Returns whether the constraint object can be displayed. It depends on the sketch check
+  /// box states
+  /// \param theObject a model object
+  /// \param theState the constraint visible state state to be checked
+  /// \param isProcessed an output parameter if it is processed
+  /// \return result value
+  bool canDisplayConstraint(const FeaturePtr& theObject,
+                            const PartSet_Tools::ConstraintVisibleState& theState,
+                            bool& isProcessed) const;
+
+  /// Check the given objects either there are some results of the current sketch. If so,
+  /// it suggests to delete them as there are no functionality to show back hidden sketch objects
+  /// \param theObjects a list of hidden objects
+  //virtual void processHiddenObject(const std::list<ObjectPtr>& theObjects);
+
+  /// Returns true if the mouse is over viewer or property panel value is changed
+  /// \return boolean result
+  bool canDisplayCurrentCreatedFeature() const;
+
+  /// Returns true if the current operation is nested creation or internal reentrant edit
+  /// \param theOperation an operation
+  bool canChangeCursor(ModuleBase_Operation* theOperation) const;
+
+  /// Returns state of constraints showing flag 
+  const QMap<PartSet_Tools::ConstraintVisibleState, bool>& showConstraintStates();
+
+  /// Returns true if the object is a current sketch sub feature of a result of the feature
+  /// \param theObject an object
+  /// \return boolean value
+  bool isObjectOfSketch(const ObjectPtr& theObject) const;
+
+  /// Saves the current selection in the viewer into an internal container
+  /// It obtains the selected attributes. The highlighted objects can be processes as the selected ones
+  /// \param theHighlightedOnly a boolean flag
+  void storeSelection(const bool theHighlightedOnly = false);
+
+  /// Restores previously saved selection state
+  void restoreSelection();
+
+  /// Return error state of the sketch feature, true if the error has happened
+  /// \return boolean value
+  bool sketchSolverError();
+
+  //! Returns the feature error if the current state of the feature in the sketch is not correct
+  //! If the feature is correct, it returns an empty value
+  //! Incorrect states: the feature is sketch, the solver error value
+  //! The feature value is reset, this is the flag of sketch mgr
+  //! \return string value
+  QString getFeatureError(const FeaturePtr& theFeature);
+
+  /// It nullify internal flags concerned to clicked mouse event
+  void clearClickedFlags();
+
+  /// Returns list of strings which contains id's of sketch replication operations
+  static const QStringList& replicationsIdList();
+
+  /// Returns list of strings which contains id's of constraints operations
+  static const QStringList& constraintsIdList();
+
+  /// Returns a list of modes, where the AIS objects should be activated
+  /// \param theModes a list of modes
+  static void sketchSelectionModes(QIntList& theModes);
+
+  /// 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 ResultPtr& theResult);
+
+  /// 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
+  void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect);
+
+  /// Visualize the operation feature if the previous state is modified value in property panel
+  /// \param thePreviousState the previous widget value state
+  void widgetStateChanged(int thePreviousState);
+
+  /// If the current operation is a dimention one, the style of dimension visualization is send for
+  /// the current object
+  /// \param theObject an object to be customized
+  void customizePresentation(const ObjectPtr& theObject);
+
+  /// Update sketch presentations according to the the state
+  /// \param theType a type of sketch visualization style
+  /// \param theState a boolean state
+  void updateBySketchParameters(const PartSet_Tools::ConstraintVisibleState& theType,
+                                bool theState);
+
 public slots:
   /// Process sketch plane selected event
   void onPlaneSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
 
-
 private slots:
-  /// Process the signal about mouse moving into or out of the window
-  /// \param heOverWindow true, if the moving happens to window
-  void onMouseMoveOverWindow(bool theOverWindow);
-  void onValuesChangedInPropertyPanel();
+  /// Toggle show constraints
+  void onShowConstraintsToggle(int theType, bool theState);
+  /// Process the enter mouse to the view port. If the current operation is a create of
+  /// a nested sketch feature, it updates internal flags to display the feature on mouse move
+  void onEnterViewPort();
+  /// Process the leave mouse of the view port. If the current operation is a create of
+  /// a nested sketch feature, it hides the feature in the viewer
+  void onLeaveViewPort();
+  /// Listens to the value changed signal and display the current operation feature
+  void onBeforeValuesChangedInPropertyPanel();
+  /// Listens to the signal about the modification of the values have been done in the property panel
+  void onAfterValuesChangedInPropertyPanel();
+
   void onMousePressed(ModuleBase_IViewWindow*, QMouseEvent*);
   void onMouseReleased(ModuleBase_IViewWindow*, QMouseEvent*);
   void onMouseMoved(ModuleBase_IViewWindow*, QMouseEvent*);
   void onMouseDoubleClick(ModuleBase_IViewWindow*, QMouseEvent*);
   void onApplicationStarted();
-  void onBeforeWidgetActivated(ModuleBase_ModelWidget* theWidget);
+  //void onBeforeWidgetActivated(ModuleBase_ModelWidget* theWidget);
+
+  void onBeforeContextMenu();
+  void onAfterContextMenu();
 
 private:
-  /// Returns list of strings which contains id's of sketch operations
-  static QStringList sketchOperationIdList();
+  /// Launches the operation from current highlighting
+  void launchEditing();
 
   /// Converts mouse position to 2d coordinates. 
   /// Member myCurrentSketch has to be correctly defined
   void get2dPoint(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent, 
                   Point& thePoint);
 
-  typedef QList<AttributePtr> AttributeList;
-  typedef QMap<FeaturePtr, AttributeList> FeatureToAttributesMap;
-  typedef std::map<FeaturePtr, std::pair<std::set<AttributePtr>, std::set<ResultPtr> > >
-                                                                       FeatureToSelectionMap;
-  /// Obtains the current selection of the object in the workshop viewer by a map of feature to attributes
-  /// It calls the next method for each feature
-  /// \param theFeatureToAttributes a map of feature to attributes
-  /// \param theSketch a current sketch feature
-  /// \param theWorkshop a workshop to have an access to AIS context and displayer
-  /// \param theSelection a container for the selection, to save results and attributres for a feature
-  static void getCurrentSelection(const FeatureToAttributesMap& theFeatureToAttributes,
-                                  const FeaturePtr& theSketch,
-                                  ModuleBase_IWorkshop* theWorkshop,
-                                  FeatureToSelectionMap& theSelection);
+  /// Show distance value editor if it is a distance operation and all attribute references
+  /// are filled by preseletion
+  /// \return true if the value is accepted
+  static bool setDistanceValueByPreselection(ModuleBase_Operation* theOperation,
+                                             ModuleBase_IWorkshop* theWorkshop,
+                                             bool& theCanCommitOperation);
 
-  /// Obtains the current selection of the object in the workshop viewer 
-  /// It includes the selection in all modes of activation, even local context - vertices, edges
-  /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
-  /// selection owners. If the owner is vertex, the corresponded attribute is seached in
-  /// the feature, if the owner is edge, the current result is added to the container of results.
-  /// \param theFeature a feature or result object
-  /// \param theSketch a current sketch feature
-  /// \param theWorkshop a workshop to have an access to AIS context and displayer
-  /// \param theSelection a container for the selection, to save results and attributres for a feature
-  static void getCurrentSelection(const FeaturePtr& theFeature,
-                                  const FeaturePtr& theSketch,
-                                  ModuleBase_IWorkshop* theWorkshop,
-                                  FeatureToSelectionMap& theSelection);
+  typedef QMap<FeaturePtr, std::pair<std::set<AttributePtr>, std::set<ResultPtr> > >
+                                                                       FeatureToSelectionMap;
 
   /// Applyes the current selection to the object in the workshop viewer 
   /// It includes the selection in all modes of activation, even local context - vertexes, edges
@@ -189,28 +334,54 @@ private:
                                   const FeatureToSelectionMap& theSelection,
                                   SelectMgr_IndexedMapOfOwner& anOwnersToSelect);
 
-  /// Connects or disconnects to the value changed signal of the property panel widgets
-  /// \param isToConnect a boolean value whether connect or disconnect
-  void connectToPropertyPanel(const bool isToConnect);
+  /// Returns true if the created feature is visible
+  /// \param 
+  bool isVisibleCreatedFeature() const;
+
+  /// Returns a current operation
+  /// \return an operation
+  ModuleBase_Operation* getCurrentOperation() const;
+
+  /// Get the active widget in the property panel
+  ModuleBase_ModelWidget* getActiveWidget() const;
 
-  void updateVisibilityOfCreatedFeature();
+  /// Erase or display the feature of the current operation. If the mouse over the active view or
+  /// a current value is changed by property panel, the feature is displayed otherwise it is hidden
+  /// \param theOperation an operation which feature is to be displayed, it is nested create operation
+  /// \param isToDisplay a flag about the display or erase the feature
+  void visualizeFeature(const FeaturePtr& theFeature, const bool isEditOperation,
+                        const bool isToDisplay, const bool isFlushRedisplay = true);
+
+private:
+  /// Updates selection priority of the presentation
+  /// \param theObject object to find a presentation which will be corrected
+  /// \param theFeature a feature of the presentation
+  void updateSelectionPriority(ObjectPtr theObject, FeaturePtr theFeature);
+  /// Returns current workshop
+  XGUI_Workshop* workshop() const;
+  /// Returns operation manager
+  XGUI_OperationMgr* operationMgr() const;
 
 private:
   PartSet_Module* myModule;
 
-  bool myPreviousSelectionEnabled; // the previous selection enabled state in the viewer
+  bool myPreviousDrawModeEnabled; // the previous selection enabled state in the viewer
   bool myIsDragging;
   bool myDragDone;
-  bool myIsMouseOverWindow; /// the state that mouse is over view
-  bool myIsPropertyPanelValueChanged; /// the state that value in the property panel is changed
+  bool myIsMouseOverWindow; /// the state that the mouse over the view
+  bool myIsMouseOverViewProcessed; /// the state whether the over view state is processed by mouseMove method
+  bool myIsPopupMenuActive; /// the state of the popup menu is shown
   Point myCurrentPoint;
-  Point myClickedPoint;
+  //Point myClickedPoint;
 
   CompositeFeaturePtr myCurrentSketch;
 
-  FeatureToAttributesMap myFeature2AttributeMap; /// a map of a feature to attributes
-
+  Handle(PartSet_CirclePointFilter) myCirclePointFilter;
   Handle(ModuleBase_ShapeInPlaneFilter) myPlaneFilter;
+  FeatureToSelectionMap myCurrentSelection;
+  bool myPreviousUpdateViewerEnabled;
+
+  QMap<PartSet_Tools::ConstraintVisibleState, bool> myIsConstraintsShown;
 };