src/PartSet/PartSet_SketcherMgr.h

   1 // Copyright (C) 2014-2019  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef PartSet_SketcherMgr_H
  21 #define PartSet_SketcherMgr_H
  22
  23 #include "PartSet.h"
  24
  25 #include "PartSet_PreviewSketchPlane.h"
  26 #include "PartSet_Tools.h"
  27
  28 #include <ModelAPI_Feature.h>
  29 #include <ModelAPI_Attribute.h>
  30 #include <ModelAPI_CompositeFeature.h>
  31 #include <ModelAPI_Result.h>
  32 #include <Events_Listener.h>
  33 #include <ModuleBase_SelectionFilterType.h>
  34
  35 #include <ModuleBase_Definitions.h>
  36 #include <ModuleBase_ModelWidget.h>
  37
  38 #include <GeomAPI_Pln.h>
  39 #include <GeomAPI_AISObject.h>
  40
  41 #ifdef HAVE_SALOME
  42   #include <OCCViewer_ViewModel.h>
  43 #else
  44   #include <AppElements_Viewer.h>
  45 #endif
  46
  47
  48 #include <SelectMgr_IndexedMapOfOwner.hxx>
  49 #include <SelectMgr_ListOfFilter.hxx>
  50
  51 #include <TopoDS_Shape.hxx>
  52 #include <TopTools_MapOfShape.hxx>
  53 #include <AIS_Shape.hxx>
  54
  55 #include <QObject>
  56 #include <QList>
  57 #include <QMap>
  58
  59 #include <set>
  60
  61 class PartSet_Module;
  62 class ModuleBase_IViewWindow;
  63 class ModuleBase_ModelWidget;
  64 class ModuleBase_Operation;
  65 class XGUI_OperationMgr;
  66 class XGUI_Workshop;
  67 class XGUI_Displayer;
  68 class PartSet_ExternalPointsMgr;
  69
  70 class AIS_InteractiveObject;
  71
  72 class QMouseEvent;
  73 class PartSet_SketcherMgr;
  74
  75 #ifdef HAVE_SALOME
  76 class PartSet_Fitter : public OCCViewer_Fitter
  77 #else
  78 class PartSet_Fitter : public AppElements_Fitter
  79 #endif
  80 {
  81 public:
  82   PartSet_Fitter(PartSet_SketcherMgr* theSketchMgr):
  83     mySketchMgr(theSketchMgr) {}
  84
  85   /// A method which has top be reimplemented to provide alterantive implementation FitAll command
  86   /// \param theView - a view which has to be fit
  87   virtual void fitAll(Handle(V3d_View) theView);
  88
  89 private:
  90   PartSet_SketcherMgr* mySketchMgr;
  91 };
  92
  93
  94
  95 /**
  96 * \ingroup Modules
  97 * A class for management of sketch operations
  98   At the time of the sketcher operation active, only the sketch sub-feature results are
  99   displayed in the viewer. After the sketch create/edit operation is finished, the sub-feature
 100   are hidden, the sketch feature result is displayed
 101 */
 102 class PARTSET_EXPORT PartSet_SketcherMgr : public QObject, public Events_Listener
 103 {
 104   Q_OBJECT
 105   /// Struct to define gp point, with the state is the point is initialized
 106   struct Point
 107   {
 108     /// Constructor
 109     Point()
 110     {
 111       myIsInitialized = false;
 112     }
 113     /// Destructor
 114     ~Point()
 115     {
 116     }
 117
 118     /// clear the initialized flag.
 119     void clear()
 120     {
 121       myIsInitialized = false;
 122     }
 123     /// set the point and switch on the initialized flag
 124     /// \param thePoint the point
 125     void setValue(const double theX, const double theY)
 126     {
 127       myIsInitialized = true;
 128       myCurX = theX;
 129       myCurY = theY;
 130     }
 131
 132     bool myIsInitialized;  /// the state whether the point is set
 133     double myCurX, myCurY; /// the point coordinates
 134   };
 135
 136 public:
 137   /// Struct to define selection model information to store/restore selection
 138   struct SelectionInfo
 139   {
 140     std::set<AttributePtr> myAttributes; /// the selected attributes
 141     std::set<ResultPtr> myResults; /// the selected results
 142     TopoDS_Shape myFirstResultShape; /// the first shape of feature result
 143     TopTools_MapOfShape myLocalSelectedShapes; /// shapes of local selection
 144   };
 145   typedef QMap<FeaturePtr, SelectionInfo> FeatureToSelectionMap;
 146
 147 public:
 148   /// Constructor
 149   /// \param theModule a pointer to PartSet module
 150   PartSet_SketcherMgr(PartSet_Module* theModule);
 151
 152   virtual ~PartSet_SketcherMgr();
 153
 154   /// Returns true if the operation is the sketch
 155   /// \param theOperation an operation
 156   /// \return the boolean result
 157   static bool isSketchOperation(ModuleBase_Operation* theOperation);
 158
 159   /// Returns true if the operation feature belongs to list of granted features of Sketch
 160   /// operation. An operation of a sketch should be started before.
 161   /// \param theOperation an operation
 162   /// \return the boolean result
 163   bool isNestedSketchOperation(ModuleBase_Operation* theOperation) const;
 164
 165   /// Returns true if the feature kind belongs to list of granted features of Sketch
 166   /// operation. An operation of a sketch should be started before.
 167   /// \param theOperation an operation
 168   /// \return the boolean result
 169   bool isNestedSketchFeature(const QString& theFeatureKind) const;
 170
 171   /// Returns true if the operation is a create and nested sketch operationn
 172   /// \param theOperation a checked operation
 173   /// \param theSketch a sketch feature
 174   //// \return boolean value
 175   bool isNestedCreateOperation(ModuleBase_Operation* theOperation,
 176                                       const CompositeFeaturePtr& /*theSketch*/) const;
 177
 178   /// Returns true if the operation is an edit nested feature one
 179   /// \param theOperation a checked operation
 180   //// \return boolean value
 181   bool isNestedEditOperation(ModuleBase_Operation* theOperation,
 182                                     const CompositeFeaturePtr& /*theSketch*/) const;
 183
 184   /// Returns whether the current operation is a sketch entity - line, point, arc or circle
 185   /// \param theId is an id of object
 186   /// \return a boolean value
 187   static bool isEntity(const std::string& theId);
 188
 189   /// Returns whether the feature has external attribute filled with 'true' value
 190   /// \param theFeature a feature object
 191   /// \return a boolean value
 192   static bool isExternalFeature(const FeaturePtr& theFeature);
 193
 194   /// Returns whether the current operation is a sketch distance - lenght, distance or radius
 195   /// \param theOperation the operation
 196   /// \return a boolean value
 197   static bool isDistanceOperation(ModuleBase_Operation* theOperation);
 198
 199   /// Returns whether the feature kind is a sketch distance - lenght, distance or radius
 200   /// \param theKind the feature kind
 201   /// \return a boolean value
 202   static bool isDistanceKind(std::string& theKind);
 203
 204   /// Returns true if a mouse cursor is over viewer window
 205   bool isMouseOverWindow() { return myIsMouseOverWindow; }
 206
 207   /// Returns current Sketch feature/ Returns NULL if there is no launched sketch operation
 208   CompositeFeaturePtr activeSketch() const { return myCurrentSketch; }
 209
 210   /// Returns help class to visualize sketcher plane
 211   /// \return a preview plane
 212   PartSet_PreviewSketchPlane* previewSketchPlane() const { return mySketchPlane; }
 213
 214   /// Starts sketch operation
 215   void startSketch(ModuleBase_Operation* );
 216
 217   /// Stops sketch operation
 218   void stopSketch(ModuleBase_Operation* );
 219
 220   /// Starts sketch operation, connects to the opeation property panel
 221   /// \param theOperation a committed operation
 222   void startNestedSketch(ModuleBase_Operation* theOperation);
 223
 224   /// Stop sketch operation, disconnects from the opeation property panel
 225   /// \param theOperation a stopped operation
 226   void stopNestedSketch(ModuleBase_Operation* theOperation);
 227
 228   /// Visualizes the operation feature if it is a creation nested feature operation
 229   /// \param theOperation a committed operation
 230   void commitNestedSketch(ModuleBase_Operation* theOperation);
 231
 232   /// Returns true if the filter is created by the sketch manager
 233   /// \param theFilterType a checked type
 234   /// \return boolean value
 235   bool sketchSelectionFilter(const ModuleBase_SelectionFilterType theFilterType);
 236
 237   /// Append selection filter into the module and type of the filter in internal container
 238   /// \param theFilterType selection filter type
 239   /// \param theFilter added filter
 240   void registerSelectionFilter(const ModuleBase_SelectionFilterType theFilterType,
 241                                const Handle(SelectMgr_Filter)& theFilter);
 242
 243   /// Commit the operation if it is possible. If the operation is dimention constraint,
 244   /// it gives widget editor to input dimention value
 245   /// \return true if the operation is stopped after activation
 246   bool operationActivatedByPreselection();
 247
 248   /// Returns True if there are available Undos and the sketch manager allows undo
 249   /// \return the boolean result
 250   bool canUndo() const;
 251
 252   //! Returns True if there are available Redos and the sketch manager allows redo
 253   /// \return the boolean result
 254   bool canRedo() const;
 255
 256   /// Returns False only if the sketch creating feature can not be visualized.
 257   /// \return a boolean value
 258   //bool canCommitOperation() const;
 259
 260   /// Returns whether the object can be erased at the bounds of the active operation.
 261   /// Sketch sub-entities can not be erased during the sketch operation
 262   /// \param theObject a model object
 263   bool canEraseObject(const ObjectPtr& theObject) const;
 264
 265   /// Returns whether the object can be displayed at the bounds of the active operation.
 266   /// Display only current operation results for usual operation and ask the sketcher manager
 267   /// if it is a sketch operation
 268   /// \param theObject a model object
 269   bool canDisplayObject(const ObjectPtr& theObject) const;
 270
 271   /// Returns whether the constraint object can be displayed. It depends on the sketch check
 272   /// box states
 273   /// \param theObject a model object
 274   /// \param theState the constraint visible state state to be checked
 275   /// \param isProcessed an output parameter if it is processed
 276   /// \return result value
 277   bool canDisplayConstraint(const FeaturePtr& theObject,
 278                             const PartSet_Tools::ConstraintVisibleState& theState,
 279                             bool& isProcessed) const;
 280
 281   /// Check the given objects either there are some results of the current sketch. If so,
 282   /// it suggests to delete them as there are no functionality to show back hidden sketch objects
 283   /// \param theObjects a list of hidden objects
 284   //virtual void processHiddenObject(const std::list<ObjectPtr>& theObjects);
 285
 286   /// Returns true if the mouse is over viewer or property panel value is changed
 287   /// \return boolean result
 288   bool canDisplayCurrentCreatedFeature() const;
 289
 290   /// Returns true if the current operation is nested creation or internal reentrant edit
 291   /// \param theOperation an operation
 292   bool canChangeCursor(ModuleBase_Operation* theOperation) const;
 293
 294   /// Returns state of constraints showing flag
 295   const QMap<PartSet_Tools::ConstraintVisibleState, bool>& showConstraintStates();
 296
 297   /// Returns true if the object is a current sketch sub feature of a result of the feature
 298   /// \param theObject an object
 299   /// \return boolean value
 300   bool isObjectOfSketch(const ObjectPtr& theObject) const;
 301
 302   /// Enumeration for selection mode used
 303   enum SelectionType {
 304     ST_HighlightType, /// Only highlighted objects
 305     ST_SelectType, /// Only selected objects
 306     ST_SelectAndHighlightType /// Both, highlighted and selected objects
 307   };
 308
 309   /// Saves the current selection in the viewer into an internal container
 310   /// It obtains the selected attributes.
 311   /// The highlighted objects can be processes as the selected ones
 312   /// \param theHighlightedOnly a boolean flag
 313   /// \param theCurrentSelection a container filled by the current selection
 314   void storeSelection(const SelectionType theType, FeatureToSelectionMap& theCurrentSelection);
 315
 316   /// Restores previously saved selection state
 317   /// \param theCurrentSelection a container filled by the current selection
 318   void restoreSelection(FeatureToSelectionMap& theCurrentSelection);
 319
 320   /// Return error state of the sketch feature, true if the error has happened
 321   /// \return boolean value
 322   bool sketchSolverError();
 323
 324   //! Returns the feature error if the current state of the feature in the sketch is not correct
 325   //! If the feature is correct, it returns an empty value
 326   //! Incorrect states: the feature is sketch, the solver error value
 327   //! The feature value is reset, this is the flag of sketch mgr
 328   //! \return string value
 329   QString getFeatureError(const FeaturePtr& theFeature);
 330
 331   /// It nullify internal flags concerned to clicked mouse event
 332   void clearClickedFlags();
 333
 334   /// Returns list of strings which contains id's of sketch replication operations
 335   static const QStringList& replicationsIdList();
 336
 337   /// Returns list of strings which contains id's of constraints operations
 338   static const QStringList& constraintsIdList();
 339
 340   /// Returns a list of modes, where the AIS objects should be activated
 341   /// \param theSketch a sketch object, modes are empty if sketch plane is not defined yet
 342   /// \param theModes a list of modes
 343   static void sketchSelectionModes(const CompositeFeaturePtr& theSketch, QIntList& theModes);
 344
 345   /// Create specific for the module presentation
 346   /// \param theResult an object for presentation
 347   /// \return created presentation or NULL(default value)
 348   Handle(AIS_InteractiveObject) createPresentation(const ObjectPtr& theResult);
 349
 350   /// Connects or disconnects to the value changed signal of the property panel widgets
 351   /// \param theWidget a property contol widget
 352   /// \param isToConnect a boolean value whether connect or disconnect
 353   void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect);
 354
 355   /// Visualize the operation feature if the previous state is modified value in property panel
 356   /// \param thePreviousState the previous widget value state
 357   void widgetStateChanged(int thePreviousState);
 358
 359   /// If the current operation is a dimention one, the style of dimension visualization is send for
 360   /// the current object
 361   /// \param theObject an object to be customized
 362   //void customisePresentation(const ObjectPtr& theObject);
 363
 364   void customizeSketchPresentation(const ObjectPtr& theObject, const AISObjectPtr& thePrs) const;
 365
 366   /// Update sketch presentations according to the the state
 367   /// \param theType a type of sketch visualization style
 368   /// \param theState a boolean state
 369   void updateBySketchParameters(const PartSet_Tools::ConstraintVisibleState& theType,
 370                                 bool theState);
 371
 372   bool isShowFreePointsShown() const {
 373     return myPointsHighlight.size() > 0;
 374   }
 375
 376   PartSet_Module* module() const { return myModule; }
 377
 378   /** \brief Implementation of Event Listener method
 379   *  \param[in] theMessage the data of the event
 380   */
 381   virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
 382
 383   bool isSketchStarted() const { return myIsSketchStarted; }
 384
 385
 386 public slots:
 387   /// Process sketch plane selected event
 388   void onPlaneSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
 389
 390   /// The slot is called when user checks "Show free points" button
 391   /// \param toShow a state of the check box
 392   void onShowPoints(bool toShow);
 393
 394 private slots:
 395   /// Toggle show constraints
 396   void onShowConstraintsToggle(int theType, bool theState);
 397   /// Process the enter mouse to the view port. If the current operation is a create of
 398   /// a nested sketch feature, it updates internal flags to display the feature on mouse move
 399   void onEnterViewPort();
 400   /// Process the leave mouse of the view port. If the current operation is a create of
 401   /// a nested sketch feature, it hides the feature in the viewer
 402   void onLeaveViewPort();
 403   /// Listens to the value changed signal and display the current operation feature
 404   //void onBeforeValuesChangedInPropertyPanel();
 405   /// Listens to the signal about the modification of the values
 406   /// have been done in the property panel
 407   //void onAfterValuesChangedInPropertyPanel();
 408
 409   void onMousePressed(ModuleBase_IViewWindow*, QMouseEvent*);
 410   void onMouseReleased(ModuleBase_IViewWindow*, QMouseEvent*);
 411   void onMouseMoved(ModuleBase_IViewWindow*, QMouseEvent*);
 412   void onMouseDoubleClick(ModuleBase_IViewWindow*, QMouseEvent*);
 413   void onApplicationStarted();
 414   //void onBeforeWidgetActivated(ModuleBase_ModelWidget* theWidget);
 415
 416   void onBeforeContextMenu();
 417   void onAfterContextMenu();
 418
 419 private:
 420   /// Launches the operation from current highlighting
 421   void launchEditing();
 422
 423   /// Converts mouse position to 2d coordinates.
 424   /// Member myCurrentSketch has to be correctly defined
 425   void get2dPoint(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent,
 426                   Point& thePoint);
 427
 428   /// Show distance value editor if it is a distance operation and all attribute references
 429   /// are filled by preseletion
 430   /// \return true if the value is accepted
 431   static bool setDistanceValueByPreselection(ModuleBase_Operation* theOperation,
 432                                              ModuleBase_IWorkshop* theWorkshop,
 433                                              bool& theCanCommitOperation);
 434
 435   /// Applyes the current selection to the object in the workshop viewer
 436   /// It includes the selection in all modes of activation, even local context - vertexes, edges
 437   /// It gets all results of the feature, find an AIS object in the viewer and takes all BRep
 438   /// selection owners. If the owner is vertex, the corresponded attribute is seached in
 439   /// the feature and if it is in the container of selected attributes, the owner is put in the
 440   /// out container. If the owner is edge and the current result is in the container of selected
 441   /// results, the owner is put in the out container.
 442   /// \param theFeature a feature or result object
 443   /// \param theSketch a current sketch feature
 444   /// \param theWorkshop a workshop to have an access to AIS context and displayer
 445   /// \param theSelection a container of the selection, it has results and attributres for a feature
 446   /// \param theOwnersToSelect an out container of found owners
 447   static void getSelectionOwners(const FeaturePtr& theFeature,
 448                                   const FeaturePtr& theSketch,
 449                                   ModuleBase_IWorkshop* theWorkshop,
 450                                   const FeatureToSelectionMap& theSelection,
 451                                   SelectMgr_IndexedMapOfOwner& theOwnersToSelect);
 452
 453   /// Returns true if the created feature is visible
 454   /// \param
 455   bool isVisibleCreatedFeature() const;
 456
 457   /// Returns a current operation
 458   /// \return an operation
 459   ModuleBase_Operation* getCurrentOperation() const;
 460
 461   /// Get the active widget in the property panel
 462   ModuleBase_ModelWidget* getActiveWidget() const;
 463
 464   /// Erase or display the feature of the current operation. If the mouse over the active view or
 465   /// a current value is changed by property panel, the feature is displayed otherwise it is hidden
 466   /// \param theOperation an operation which feature is to be displayed,
 467   ///                     it is nested create operation
 468   /// \param isToDisplay a flag about the display or erase the feature
 469   void visualizeFeature(const FeaturePtr& theFeature, const bool isEditOperation,
 470                         const bool isToDisplay, const bool isFlushRedisplay = true);
 471
 472 private:
 473   /// Updates selection priority of the presentation
 474   /// \param theObject object to find a presentation which will be corrected
 475   /// \param theFeature a feature of the presentation
 476   void updateSelectionPriority(ObjectPtr theObject, FeaturePtr theFeature);
 477   /// Returns current workshop
 478   XGUI_Workshop* workshop() const;
 479   /// Returns operation manager
 480   XGUI_OperationMgr* operationMgr() const;
 481
 482 private:
 483   PartSet_Module* myModule;
 484   PartSet_PreviewSketchPlane* mySketchPlane; // display/erase sketch plane on start/stop sketch
 485
 486   bool myPreviousDrawModeEnabled; // the previous selection enabled state in the viewer
 487   bool myIsEditLaunching;
 488   bool myIsDragging;
 489   bool myDragDone;
 490   bool myIsMouseOverWindow; /// the state that the mouse over the view
 491   /// the state whether the over view state is processed by mouseMove method
 492   bool myIsMouseOverViewProcessed;
 493   bool myIsPopupMenuActive; /// the state of the popup menu is shown
 494   Point myCurrentPoint;
 495   //Point myClickedPoint;
 496
 497   CompositeFeaturePtr myCurrentSketch;
 498
 499   std::set<ModuleBase_SelectionFilterType> mySelectionFilterTypes;
 500
 501   FeatureToSelectionMap myCurrentSelection;
 502   bool myPreviousUpdateViewerEnabled;
 503
 504   QMap<PartSet_Tools::ConstraintVisibleState, bool> myIsConstraintsShown;
 505
 506   PartSet_ExternalPointsMgr* myExternalPointsMgr;
 507
 508   QMap<ResultPtr, Handle(AIS_Shape)> myPointsHighlight;
 509
 510   bool myNoDragMoving;
 511
 512   bool myIsSketchStarted;
 513 };
 514
 515
 516 #endif