src/PartSet/PartSet_SketcherMgr.h

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