]> SALOME platform Git repositories - modules/shaper.git/blob - src/PartSet/PartSet_WidgetSketchLabel.h
Salome HOME
Prevent crash of small arcs presentations
[modules/shaper.git] / 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   /// Fills given container with selection modes if the widget has it
77   /// \param [out] theModuleSelectionModes module additional modes, -1 means all default modes
78   /// \param theModes [out] a container of modes
79   virtual void selectionModes(int& theModuleSelectionModes, QIntList& theModes);
80
81   /// Using widget selection filter only if plane is not defined.
82   /// \param [out] theModuleSelectionFilters module additional modes, -1 means all default modes
83   /// \param [out] selection filters
84   virtual void selectionFilters(QIntList& theModuleSelectionFilters,
85                                 SelectMgr_ListOfFilter& theSelectionFilters);
86
87   /// Returns list of widget controls
88   /// \return a control list
89   virtual QList<QWidget*> getControls() const;
90
91   /// The methiod called when widget is deactivated
92   virtual void deactivate();
93
94   /// The method called if widget should be activated always
95   virtual bool needToBeActiated() { return true; }
96
97   /// Returns sketcher plane
98   std::shared_ptr<GeomAPI_Pln> plane() const;
99
100   /// This control accepts focus
101   virtual bool focusTo();
102   virtual void setHighlighted(bool) { /*do nothing*/ };
103   virtual void enableFocusProcessing();
104
105   /// Returns True if the selected presentation can be used for plane definition
106   /// \param thePrs a presentation
107   static bool canFillSketch(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
108
109 signals:
110   /// Signal on plane selection
111   void planeSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
112
113   /// A show constraint toggled signal
114   /// \param theType a ConstraintVisibleState value
115   /// \param theState a state of the check box
116   void showConstraintToggled(int theType, bool theState);
117
118 protected:
119   /// Creates a backup of the current values of the attribute
120   /// It should be realized in the specific widget because of different
121   /// parameters of the current attribute
122   /// \param theAttribute an attribute to be stored
123   virtual void storeAttributeValue(const AttributePtr& theAttribute);
124
125   /// Creates a backup of the current values of the attribute
126   /// It should be realized in the specific widget because of different
127   /// parameters of the current attribute
128   /// \param theAttribute an attribute to be restored
129   /// \param theValid a boolean flag, if restore happens for valid parameters
130   virtual void restoreAttributeValue(const AttributePtr& theAttribute,
131                                      const bool theValid);
132
133   /// Fills the attribute with the value of the selected owner
134   /// \param thePrs a selected owner
135   virtual bool setSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
136
137   /// Saves the internal parameters to the given feature
138   /// \return True in success
139   virtual bool storeValueCustom()
140   {
141     return true;
142   }
143
144   virtual bool restoreValueCustom()
145   {
146     return true;
147   }
148
149   /// The methiod called when widget is activated
150   virtual void activateCustom();
151
152   /// Block the model flush of update and intialization of attribute
153   /// In additional to curstom realization it blocks initialization for all feature attributes
154   /// as the current attribute is selection but its modification leads to other attributes change
155   /// \param theAttribute an attribute
156   /// \param theToBlock flag whether the model is blocked or unblocked
157   /// \param isFlushesActived out value if model is blocked, in value if model is unblocked
158   /// to be used to restore flush state when unblocked
159   /// \param isAttributeSetInitializedBlocked out value if model is blocked
160   /// in value if model is unblocked to be used to restore previous state when unblocked
161   /// \param isAttributeSendUpdatedBlocked out value if model signal is blocked
162   virtual void blockAttribute(const AttributePtr& theAttribute, const bool& theToBlock,
163                               bool& isFlushesActived,
164                               bool& isAttributeSetInitializedBlocked,
165                               bool& isAttributeSendUpdatedBlocked);
166
167   /// Returns true if envent is processed.
168   virtual bool processSelection();
169
170   /// Set the given wrapped value to the current widget
171   /// This value should be processed in the widget according to the needs
172   /// The method is called by the current operation to process the operation preselection.
173   /// It is redefined to do nothing if the plane of the sketch has been already set.
174   /// \param theValues the wrapped selection values
175   /// \param theToValidate a validation flag
176   bool setSelectionInternal(const QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues,
177                             const bool theToValidate);
178
179   /// Erase preview planes, disconnect widget, change the view projection
180   /// \param thePrs a selected presentation
181   void updateByPlaneSelected(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
182
183   /// Set sketch plane from selected object
184   /// \param theFeature a feature of sketch
185   /// \param thePrs a presentation
186   bool fillSketchPlaneBySelection(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
187
188 private slots:
189   /// A slot called on set sketch plane view
190   void onSetPlaneView();
191
192   /// Emits signal about check box state changed with information about ConstraintVisibleState
193   /// \param theOn a flag show constraints or not
194   void onShowConstraint(bool theOn);
195
196 private:
197   /// Set sketch plane by shape
198   /// \param theShape a planar face
199   std::shared_ptr<GeomAPI_Dir> setSketchPlane(const TopoDS_Shape& theShape);
200
201   /// Set sketch plane
202   /// \param thePlane a plane
203   std::shared_ptr<GeomAPI_Dir> setSketchPlane(std::shared_ptr<GeomAPI_Pln> thePlane);
204
205   /**
206   * Returns list of presentations which have displayed shapes with circular edges
207   * (circles, arcs) which are in pane of of the given sketch
208   * \param theSketch - the sketch
209   */
210   QList<std::shared_ptr<ModuleBase_ViewerPrs>> findCircularEdgesInPlane();
211
212 private:
213   /// class to show/hide preview planes
214   PartSet_PreviewPlanes* myPreviewPlanes;
215
216   QCheckBox* myViewInverted;
217
218   QMap<PartSet_Tools::ConstraintVisibleState, QCheckBox*> myShowConstraints;
219
220   QWidget* mySizeOfViewWidget; ///< Size of view widget, visualized if preview planes are shown
221   QLineEdit* mySizeOfView; ///< Value of square of size of View
222   QStackedWidget* myStackWidget;
223 };
224
225 #endif