src/PartSet/PartSet_SketcherMgr.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        PartSet_SketcherMgr.h
   4 // Created:     19 Dec 2014
   5 // Author:      Vitaly SMETANNIKOV
   6
   7 #ifndef PartSet_SketcherMgr_H
   8 #define PartSet_SketcherMgr_H
   9
  10 #include "PartSet.h"
  11
  12 #include "PartSet_Filters.h"
  13 #include "PartSet_Tools.h"
  14
  15 #include <ModelAPI_Feature.h>
  16 #include <ModelAPI_Attribute.h>
  17 #include <ModelAPI_CompositeFeature.h>
  18 #include <ModelAPI_Result.h>
  19
  20 #include <ModuleBase_ViewerFilters.h>
  21 #include <ModuleBase_Definitions.h>
  22 #include <ModuleBase_ModelWidget.h>
  23
  24 #include <GeomAPI_Pln.h>
  25 #include <SelectMgr_IndexedMapOfOwner.hxx>
  26
  27 #include <QObject>
  28 #include <QList>
  29 #include <QMap>
  30
  31 class PartSet_Module;
  32 class ModuleBase_IViewWindow;
  33 class ModuleBase_ModelWidget;
  34 class ModuleBase_Operation;
  35 class XGUI_OperationMgr;
  36 class XGUI_Workshop;
  37
  38 class QMouseEvent;
  39
  40 /**
  41 * \ingroup Modules
  42 * A class for management of sketch operations
  43   At the time of the sketcher operation active, only the sketch sub-feature results are
  44   displayed in the viewer. After the sketch create/edit operation is finished, the sub-feature
  45   are hidden, the sketch feature result is displayed
  46 */
  47 class PARTSET_EXPORT PartSet_SketcherMgr : public QObject
  48 {
  49   Q_OBJECT
  50   /// Struct to define gp point, with the state is the point is initialized
  51   struct Point
  52   {
  53     /// Constructor
  54     Point()
  55     {
  56       myIsInitialized = false;
  57     }
  58     /// Destructor
  59     ~Point()
  60     {
  61     }
  62
  63     /// clear the initialized flag.
  64     void clear()
  65     {
  66       myIsInitialized = false;
  67     }
  68     /// set the point and switch on the initialized flag
  69     /// \param thePoint the point
  70     void setValue(const double theX, const double theY)
  71     {
  72       myIsInitialized = true;
  73       myCurX = theX;
  74       myCurY = theY;
  75     }
  76
  77     bool myIsInitialized;  /// the state whether the point is set
  78     double myCurX, myCurY; /// the point coordinates
  79   };
  80 public:
  81   /// Constructor
  82   /// \param theModule a pointer to PartSet module
  83   PartSet_SketcherMgr(PartSet_Module* theModule);
  84
  85   virtual ~PartSet_SketcherMgr();
  86
  87   /// Returns true if the operation is the sketch
  88   /// \param theOperation an operation
  89   /// \return the boolean result
  90   static bool isSketchOperation(ModuleBase_Operation* theOperation);
  91
  92   /// Returns true if the operation id is in the sketch operation id list
  93   /// \param theOperation an operation
  94   /// \return the boolean result
  95   static bool isNestedSketchOperation(ModuleBase_Operation* theOperation);
  96
  97   /// Returns true if the operation is a create nested feature one
  98   /// \param theOperation a checked operation
  99   //// \return boolean value
 100   static bool isNestedCreateOperation(ModuleBase_Operation* theOperation);
 101
 102   /// Returns true if the operation is an edit nested feature one
 103   /// \param theOperation a checked operation
 104   //// \return boolean value
 105   static bool isNestedEditOperation(ModuleBase_Operation* theOperation);
 106
 107   /// Returns whether the current operation is a sketch entity - line, point, arc or circle
 108   /// \param theId is an id of object
 109   /// \return a boolean value
 110   static bool isEntity(const std::string& theId);
 111
 112   /// Returns whether the current operation is a sketch distance - lenght, distance or radius
 113   /// \param theOperation the operation
 114   /// \return a boolean value
 115   static bool isDistanceOperation(ModuleBase_Operation* theOperation);
 116
 117   /// Returns whether the feature kind is a sketch distance - lenght, distance or radius
 118   /// \param theKind the feature kind
 119   /// \return a boolean value
 120   static bool isDistanceKind(std::string& theKind);
 121
 122   /// Returns true if a mouse cursor is over viewer window
 123   bool isMouseOverWindow() { return myIsMouseOverWindow; }
 124
 125   /// Returns current Sketch feature/ Returns NULL if there is no launched sketch operation
 126   CompositeFeaturePtr activeSketch() const { return myCurrentSketch; }
 127
 128   /// Starts sketch operation
 129   void startSketch(ModuleBase_Operation* );
 130
 131   /// Stops sketch operation
 132   void stopSketch(ModuleBase_Operation* );
 133
 134   /// Starts sketch operation, connects to the opeation property panel
 135   /// \param theOperation a committed operation
 136   void startNestedSketch(ModuleBase_Operation* theOperation);
 137
 138   /// Stop sketch operation, disconnects from the opeation property panel
 139   /// \param theOperation a stopped operation
 140   void stopNestedSketch(ModuleBase_Operation* theOperation);
 141
 142   /// Visualizes the operation feature if it is a creation nested feature operation
 143   /// \param theOperation a committed operation
 144   void commitNestedSketch(ModuleBase_Operation* theOperation);
 145
 146   /// Append the sketch plane filter into the current viewer
 147   /// \param toActivate state whether the filter should be activated/deactivated
 148   void activatePlaneFilter(const bool& toActivate);
 149
 150   /// Commit the operation if it is possible. If the operation is dimention constraint,
 151   /// it gives widget editor to input dimention value
 152   /// \return true if the operation is stopped after activation
 153   bool operationActivatedByPreselection();
 154
 155   /// Returns True if there are available Undos and the sketch manager allows undo
 156   /// \return the boolean result
 157   bool canUndo() const;
 158
 159   //! Returns True if there are available Redos and the sketch manager allows redo
 160   /// \return the boolean result
 161   bool canRedo() const;
 162
 163   /// Returns False only if the sketch creating feature can not be visualized.
 164   /// \return a boolean value
 165   //bool canCommitOperation() const;
 166
 167   /// Returns whether the object can be erased at the bounds of the active operation.
 168   /// Sketch sub-entities can not be erased during the sketch operation
 169   /// \param theObject a model object
 170   bool canEraseObject(const ObjectPtr& theObject) const;
 171
 172   /// Returns whether the object can be displayed at the bounds of the active operation.
 173   /// Display only current operation results for usual operation and ask the sketcher manager
 174   /// if it is a sketch operation
 175   /// \param theObject a model object
 176   bool canDisplayObject(const ObjectPtr& theObject) const;
 177
 178   /// Returns whether the constraint object can be displayed. It depends on the sketch check
 179   /// box states
 180   /// \param theObject a model object
 181   /// \param theState the constraint visible state state to be checked
 182   /// \param isProcessed an output parameter if it is processed
 183   /// \return result value
 184   bool canDisplayConstraint(const FeaturePtr& theObject,
 185                             const PartSet_Tools::ConstraintVisibleState& theState,
 186                             bool& isProcessed) const;
 187
 188   /// Check the given objects either there are some results of the current sketch. If so,
 189   /// it suggests to delete them as there are no functionality to show back hidden sketch objects
 190   /// \param theObjects a list of hidden objects
 191   virtual void processHiddenObject(const std::list<ObjectPtr>& theObjects);
 192
 193   /// Returns true if the mouse is over viewer or property panel value is changed
 194   /// \return boolean result
 195   bool canDisplayCurrentCreatedFeature() const;
 196
 197   /// Returns true if the current operation is nested creation or internal reentrant edit
 198   /// \param theOperation an operation
 199   bool canChangeCursor(ModuleBase_Operation* theOperation) const;
 200
 201   /// Returns state of constraints showing flag
 202   const QMap<PartSet_Tools::ConstraintVisibleState, bool>& showConstraintStates();
 203
 204   /// Returns true if the object is a current sketch sub feature of a result of the feature
 205   /// \param theObject an object
 206   /// \return boolean value
 207   bool isObjectOfSketch(const ObjectPtr& theObject) const;
 208
 209   /// Saves the current selection in the viewer into an internal container
 210   /// It obtains the selected attributes. The highlighted objects can be processes as the selected ones
 211   /// \param theHighlightedOnly a boolean flag
 212   void storeSelection(const bool theHighlightedOnly = false);
 213
 214   /// Restores previously saved selection state
 215   void restoreSelection();
 216
 217   /// Return error state of the sketch feature, true if the error has happened
 218   /// \return boolean value
 219   bool sketchSolverError();
 220
 221   //! Returns the feature error if the current state of the feature in the sketch is not correct
 222   //! If the feature is correct, it returns an empty value
 223   //! Incorrect states: the feature is sketch, the solver error value
 224   //! The feature value is reset, this is the flag of sketch mgr
 225   //! \return string value
 226   QString getFeatureError(const FeaturePtr& theFeature);
 227
 228   /// It nullify internal flags concerned to clicked mouse event
 229   void clearClickedFlags();
 230
 231   /// Returns list of strings which contains id's of sketch operations
 232   static const QStringList& sketchOperationIdList();
 233
 234   /// Returns list of strings which contains id's of constraints operations
 235   static const QStringList& constraintsIdList();
 236
 237   /// Returns a list of modes, where the AIS objects should be activated
 238   /// \param theModes a list of modes
 239   static void sketchSelectionModes(QIntList& theModes);
 240
 241   /// Create specific for the module presentation
 242   /// \param theResult an object for presentation
 243   /// \return created presentation or NULL(default value)
 244   virtual Handle(AIS_InteractiveObject) createPresentation(const ResultPtr& theResult);
 245
 246   /// Connects or disconnects to the value changed signal of the property panel widgets
 247   /// \param theWidget a property contol widget
 248   /// \param isToConnect a boolean value whether connect or disconnect
 249   void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect);
 250
 251   /// Visualize the operation feature if the previous state is modified value in property panel
 252   /// \param thePreviousState the previous widget value state
 253   void widgetStateChanged(int thePreviousState);
 254
 255   /// If the current operation is a dimention one, the style of dimension visualization is send for
 256   /// the current object
 257   /// \param theObject an object to be customized
 258   void customizePresentation(const ObjectPtr& theObject);
 259
 260   /// Update sketch presentations according to the the state
 261   /// \param theType a type of sketch visualization style
 262   /// \param theState a boolean state
 263   void updateBySketchParameters(const PartSet_Tools::ConstraintVisibleState& theType,
 264                                 bool theState);
 265
 266 public slots:
 267   /// Process sketch plane selected event
 268   void onPlaneSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
 269
 270 private slots:
 271   /// Toggle show constraints
 272   void onShowConstraintsToggle(int theType, bool theState);
 273   /// Process the enter mouse to the view port. If the current operation is a create of
 274   /// a nested sketch feature, it updates internal flags to display the feature on mouse move
 275   void onEnterViewPort();
 276   /// Process the leave mouse of the view port. If the current operation is a create of
 277   /// a nested sketch feature, it hides the feature in the viewer
 278   void onLeaveViewPort();
 279   /// Listens to the value changed signal and display the current operation feature
 280   void onBeforeValuesChangedInPropertyPanel();
 281   /// Listens to the signal about the modification of the values have been done in the property panel
 282   void onAfterValuesChangedInPropertyPanel();
 283
 284   void onMousePressed(ModuleBase_IViewWindow*, QMouseEvent*);
 285   void onMouseReleased(ModuleBase_IViewWindow*, QMouseEvent*);
 286   void onMouseMoved(ModuleBase_IViewWindow*, QMouseEvent*);
 287   void onMouseDoubleClick(ModuleBase_IViewWindow*, QMouseEvent*);
 288   void onApplicationStarted();
 289   //void onBeforeWidgetActivated(ModuleBase_ModelWidget* theWidget);
 290
 291   void onBeforeContextMenu();
 292   void onAfterContextMenu();
 293
 294 private:
 295   /// Launches the operation from current highlighting
 296   void launchEditing();
 297
 298   /// Converts mouse position to 2d coordinates.
 299   /// Member myCurrentSketch has to be correctly defined
 300   void get2dPoint(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent,
 301                   Point& thePoint);
 302
 303   /// Show distance value editor if it is a distance operation and all attribute references
 304   /// are filled by preseletion
 305   /// \return true if the value is accepted
 306   static bool setDistanceValueByPreselection(ModuleBase_Operation* theOperation,
 307                                              ModuleBase_IWorkshop* theWorkshop);
 308
 309   typedef QMap<FeaturePtr, std::pair<std::set<AttributePtr>, std::set<ResultPtr> > >
 310                                                                        FeatureToSelectionMap;
 311
 312   /// Obtains the current selection of the object in the workshop viewer
 313   /// It includes the selection in all modes of activation, even local context - vertices, edges
 314   /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
 315   /// selection owners. If the owner is vertex, the corresponded attribute is seached in
 316   /// the feature, if the owner is edge, the current result is added to the container of results.
 317   /// \param theFeature a feature or result object
 318   /// \param theSketch a current sketch feature
 319   /// \param theWorkshop a workshop to have an access to AIS context and displayer
 320   /// \param theSelection a container for the selection, to save results and attributres for a feature
 321   static void getCurrentSelection(const FeaturePtr& theFeature,
 322                                   const FeaturePtr& theSketch,
 323                                   ModuleBase_IWorkshop* theWorkshop,
 324                                   FeatureToSelectionMap& theSelection);
 325
 326   /// Applyes the current selection to the object in the workshop viewer
 327   /// It includes the selection in all modes of activation, even local context - vertexes, edges
 328   /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
 329   /// selection owners. If the owner is vertex, the corresponded attribute is seached in
 330   /// the feature and if it is in the container of selected attributes, the owner is put in the
 331   /// out container. If the owner is edge and the current result is in the container of selected
 332   /// results, the owner is put in the out container.
 333   /// \param theFeature a feature or result object
 334   /// \param theSketch a current sketch feature
 335   /// \param theWorkshop a workshop to have an access to AIS context and displayer
 336   /// \param theSelection a container of the selection, it has results and attributres for a feature
 337   /// \param theOwnersToSelect an out container of found owners
 338   static void getSelectionOwners(const FeaturePtr& theFeature,
 339                                   const FeaturePtr& theSketch,
 340                                   ModuleBase_IWorkshop* theWorkshop,
 341                                   const FeatureToSelectionMap& theSelection,
 342                                   SelectMgr_IndexedMapOfOwner& anOwnersToSelect);
 343
 344   /// Returns true if the created feature is visible
 345   /// \param
 346   bool isVisibleCreatedFeature() const;
 347
 348   /// Returns a current operation
 349   /// \return an operation
 350   ModuleBase_Operation* getCurrentOperation() const;
 351
 352   /// Get the active widget in the property panel
 353   ModuleBase_ModelWidget* getActiveWidget() const;
 354
 355   /// Erase or display the feature of the current operation. If the mouse over the active view or
 356   /// a current value is changed by property panel, the feature is displayed otherwise it is hidden
 357   /// \param theOperation an operation which feature is to be displayed, it is nested create operation
 358   /// \param isToDisplay a flag about the display or erase the feature
 359   void visualizeFeature(const FeaturePtr& theFeature, const bool isEditOperation,
 360                         const bool isToDisplay, const bool isFlushRedisplay = true);
 361
 362 private:
 363   /// Returns current workshop
 364   XGUI_Workshop* workshop() const;
 365   /// Returns operation manager
 366   XGUI_OperationMgr* operationMgr() const;
 367
 368 private:
 369   PartSet_Module* myModule;
 370
 371   bool myPreviousDrawModeEnabled; // the previous selection enabled state in the viewer
 372   bool myIsDragging;
 373   bool myDragDone;
 374   bool myIsMouseOverWindow; /// the state that the mouse over the view
 375   bool myIsMouseOverViewProcessed; /// the state whether the over view state is processed by mouseMove method
 376   bool myIsPopupMenuActive; /// the state of the popup menu is shown
 377   Point myCurrentPoint;
 378   //Point myClickedPoint;
 379
 380   CompositeFeaturePtr myCurrentSketch;
 381
 382   Handle(PartSet_CirclePointFilter) myCirclePointFilter;
 383   Handle(ModuleBase_ShapeInPlaneFilter) myPlaneFilter;
 384   FeatureToSelectionMap myCurrentSelection;
 385   bool myPreviousUpdateViewerEnabled;
 386
 387   QMap<PartSet_Tools::ConstraintVisibleState, bool> myIsConstraintsShown;
 388 };
 389
 390
 391 #endif