src/PartSet/PartSet_SketcherMgr.h

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