src/PartSet/PartSet_WidgetSketchLabel.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_WidgetSketchLabel_H
  22 #define PartSet_WidgetSketchLabel_H
  23
  24 #include "PartSet.h"
  25
  26 #include "PartSet_Tools.h"
  27
  28 #include <ModuleBase_WidgetValidated.h>
  29 #include <ModuleBase_ViewerFilters.h>
  30
  31 #include <GeomAPI_Dir.h>
  32
  33 #include <TopoDS_Shape.hxx>
  34
  35 #include <QMap>
  36
  37 class PartSet_PreviewPlanes;
  38
  39 class QLabel;
  40 class XGUI_OperationMgr;
  41 class XGUI_Workshop;
  42 class QCheckBox;
  43 class QStackedWidget;
  44 class QLineEdit;
  45
  46 /**
  47 * \ingroup Modules
  48 * A model widget implementation for a label which provides specific behaviour
  49 * for sketcher starting and launching operations
  50 */
  51 class PARTSET_EXPORT PartSet_WidgetSketchLabel : public ModuleBase_WidgetValidated
  52 {
  53 Q_OBJECT
  54
  55 public:
  56   /// Constructor
  57   /// \param theParent the parent object
  58   /// \param theWorkshop a reference to workshop
  59   /// \param theData the widget configuation. The attribute of the model widget is obtained from
  60   /// \param toShowConstraints a current show constraints state
  61   PartSet_WidgetSketchLabel(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
  62                       const Config_WidgetAPI* theData,
  63                       const QMap<PartSet_Tools::ConstraintVisibleState, bool>& toShowConstraints);
  64
  65   virtual ~PartSet_WidgetSketchLabel();
  66
  67   /// Set the given wrapped value to the current widget
  68   /// This value should be processed in the widget according to the needs
  69   /// The method is called by the current operation to process the operation preselection.
  70   /// It is redefined to do nothing if the plane of the sketch has been already set.
  71   /// \param theValues the wrapped selection values
  72   /// \param theToValidate a validation flag
  73   virtual bool setSelection(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues,
  74                             const bool theToValidate);
  75
  76   /// Returns list of widget controls
  77   /// \return a control list
  78   virtual QList<QWidget*> getControls() const;
  79
  80   /// The methiod called when widget is deactivated
  81   virtual void deactivate();
  82
  83   /// The method called if widget should be activated always
  84   virtual bool needToBeActiated() { return true; }
  85
  86   /// Returns sketcher plane
  87   std::shared_ptr<GeomAPI_Pln> plane() const;
  88
  89   /// This control accepts focus
  90   virtual bool focusTo();
  91   virtual void setHighlighted(bool) { /*do nothing*/ };
  92   virtual void enableFocusProcessing();
  93
  94   /// Returns True if the selected presentation can be used for plane definition
  95   /// \param thePrs a presentation
  96   static bool canFillSketch(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
  97
  98   /// Processes Selection action.
  99   virtual bool processAction(ModuleBase_ActionType theActionType);
 100
 101 signals:
 102   /// Signal on plane selection
 103   void planeSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
 104
 105   /// A show constraint toggled signal
 106   /// \param theType a ConstraintVisibleState value
 107   /// \param theState a state of the check box
 108   void showConstraintToggled(int theType, bool theState);
 109
 110 protected:
 111   /// Creates a backup of the current values of the attribute
 112   /// It should be realized in the specific widget because of different
 113   /// parameters of the current attribute
 114   /// \param theAttribute an attribute to be stored
 115   virtual void storeAttributeValue(const AttributePtr& theAttribute);
 116
 117   /// Creates a backup of the current values of the attribute
 118   /// It should be realized in the specific widget because of different
 119   /// parameters of the current attribute
 120   /// \param theAttribute an attribute to be restored
 121   /// \param theValid a boolean flag, if restore happens for valid parameters
 122   virtual void restoreAttributeValue(const AttributePtr& theAttribute,
 123                                      const bool theValid);
 124
 125   /// Fills the attribute with the value of the selected owner
 126   /// \param thePrs a selected owner
 127   virtual bool setSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
 128
 129   /// Saves the internal parameters to the given feature
 130   /// \return True in success
 131   virtual bool storeValueCustom()
 132   {
 133     return true;
 134   }
 135
 136   virtual bool restoreValueCustom()
 137   {
 138     return true;
 139   }
 140
 141   /// The methiod called when widget is activated
 142   virtual void activateCustom();
 143
 144   /// Block the model flush of update and intialization of attribute
 145   /// In additional to curstom realization it blocks initialization for all feature attributes
 146   /// as the current attribute is selection but its modification leads to other attributes change
 147   /// \param theAttribute an attribute
 148   /// \param theToBlock flag whether the model is blocked or unblocked
 149   /// \param isFlushesActived out value if model is blocked, in value if model is unblocked
 150   /// to be used to restore flush state when unblocked
 151   /// \param isAttributeSetInitializedBlocked out value if model is blocked
 152   /// in value if model is unblocked to be used to restore previous state when unblocked
 153   /// \param isAttributeSendUpdatedBlocked out value if model signal is blocked
 154   virtual void blockAttribute(const AttributePtr& theAttribute, const bool& theToBlock,
 155                               bool& isFlushesActived,
 156                               bool& isAttributeSetInitializedBlocked,
 157                               bool& isAttributeSendUpdatedBlocked);
 158
 159   /// Set the given wrapped value to the current widget
 160   /// This value should be processed in the widget according to the needs
 161   /// The method is called by the current operation to process the operation preselection.
 162   /// It is redefined to do nothing if the plane of the sketch has been already set.
 163   /// \param theValues the wrapped selection values
 164   /// \param theToValidate a validation flag
 165   bool setSelectionInternal(const QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues,
 166                             const bool theToValidate);
 167
 168   /// Erase preview planes, disconnect widget, change the view projection
 169   /// \param thePrs a selected presentation
 170   void updateByPlaneSelected(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
 171
 172   /// Set sketch plane from selected object
 173   /// \param theFeature a feature of sketch
 174   /// \param thePrs a presentation
 175   bool fillSketchPlaneBySelection(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
 176
 177  protected:
 178   /// Activate or deactivate selection
 179   void activateSelection(bool toActivate);
 180
 181  private:
 182    /// Slot on change selection
 183   void onSelectionChanged();
 184
 185 private slots:
 186   /// A slot called on set sketch plane view
 187   void onSetPlaneView();
 188
 189   /// Emits signal about check box state changed with information about ConstraintVisibleState
 190   /// \param theOn a flag show constraints or not
 191   void onShowConstraint(bool theOn);
 192
 193  private:
 194   /// Set sketch plane by shape
 195   /// \param theShape a planar face
 196   std::shared_ptr<GeomAPI_Dir> setSketchPlane(const TopoDS_Shape& theShape);
 197
 198   /// Set sketch plane
 199   /// \param thePlane a plane
 200   std::shared_ptr<GeomAPI_Dir> setSketchPlane(std::shared_ptr<GeomAPI_Pln> thePlane);
 201
 202   /**
 203   * Returns list of presentations which have displayed shapes with circular edges
 204   * (circles, arcs) which are in pane of of the given sketch
 205   * \param theSketch - the sketch
 206   */
 207   QList<std::shared_ptr<ModuleBase_ViewerPrs>> findCircularEdgesInPlane();
 208
 209 private:
 210   /// class to show/hide preview planes
 211   PartSet_PreviewPlanes* myPreviewPlanes;
 212
 213   QCheckBox* myViewInverted;
 214
 215   QMap<PartSet_Tools::ConstraintVisibleState, QCheckBox*> myShowConstraints;
 216
 217   QWidget* mySizeOfViewWidget; ///< Size of view widget, visualized if preview planes are shown
 218   QLineEdit* mySizeOfView; ///< Value of square of size of View
 219   QStackedWidget* myStackWidget;
 220 };
 221
 222 #endif