1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef PartSet_WidgetSketchLabel_H
22 #define PartSet_WidgetSketchLabel_H
26 #include "PartSet_Tools.h"
28 #include <ModuleBase_WidgetValidated.h>
29 #include <ModuleBase_ViewerFilters.h>
31 #include <GeomAPI_Dir.h>
33 #include <TopoDS_Shape.hxx>
37 class PartSet_PreviewPlanes;
40 class XGUI_OperationMgr;
48 * A model widget implementation for a label which provides specific behaviour
49 * for sketcher starting and launching operations
51 class PARTSET_EXPORT PartSet_WidgetSketchLabel : public ModuleBase_WidgetValidated
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);
65 virtual ~PartSet_WidgetSketchLabel();
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);
76 /// Fills given container with selection modes if the widget has it
77 // \param theModes [out] a container of modes
78 /// \param isAdditional if true, the modes are combinated with the module ones
79 virtual void selectionModes(QIntList& theModes, bool& isAdditional);
81 /// Using widget selection filter only if plane is not defined.
82 /// \param [out] selection filters
83 virtual void selectionFilters(SelectMgr_ListOfFilter& theSelectionFilters);
85 /// Returns list of widget controls
86 /// \return a control list
87 virtual QList<QWidget*> getControls() const;
89 /// The methiod called when widget is deactivated
90 virtual void deactivate();
92 /// The method called if widget should be activated always
93 virtual bool needToBeActiated() { return true; }
95 /// Returns sketcher plane
96 std::shared_ptr<GeomAPI_Pln> plane() const;
98 /// This control accepts focus
99 virtual bool focusTo();
100 virtual void setHighlighted(bool) { /*do nothing*/ };
101 virtual void enableFocusProcessing();
103 /// Returns True if the selected presentation can be used for plane definition
104 /// \param thePrs a presentation
105 static bool canFillSketch(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
108 /// Signal on plane selection
109 void planeSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
111 /// A show constraint toggled signal
112 /// \param theType a ConstraintVisibleState value
113 /// \param theState a state of the check box
114 void showConstraintToggled(int theType, bool theState);
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 stored
121 virtual void storeAttributeValue(const AttributePtr& theAttribute);
123 /// Creates a backup of the current values of the attribute
124 /// It should be realized in the specific widget because of different
125 /// parameters of the current attribute
126 /// \param theAttribute an attribute to be restored
127 /// \param theValid a boolean flag, if restore happens for valid parameters
128 virtual void restoreAttributeValue(const AttributePtr& theAttribute,
129 const bool theValid);
131 /// Fills the attribute with the value of the selected owner
132 /// \param thePrs a selected owner
133 virtual bool setSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
135 /// Saves the internal parameters to the given feature
136 /// \return True in success
137 virtual bool storeValueCustom()
142 virtual bool restoreValueCustom()
147 /// The methiod called when widget is activated
148 virtual void activateCustom();
150 /// Block the model flush of update and intialization of attribute
151 /// In additional to curstom realization it blocks initialization for all feature attributes
152 /// as the current attribute is selection but its modification leads to other attributes change
153 /// \param theAttribute an attribute
154 /// \param theToBlock flag whether the model is blocked or unblocked
155 /// \param isFlushesActived out value if model is blocked, in value if model is unblocked
156 /// to be used to restore flush state when unblocked
157 /// \param isAttributeSetInitializedBlocked out value if model is blocked
158 /// in value if model is unblocked to be used to restore previous state when unblocked
159 /// \param isAttributeSendUpdatedBlocked out value if model signal is blocked
160 virtual void blockAttribute(const AttributePtr& theAttribute, const bool& theToBlock,
161 bool& isFlushesActived,
162 bool& isAttributeSetInitializedBlocked,
163 bool& isAttributeSendUpdatedBlocked);
165 /// Returns true if envent is processed.
166 virtual bool processSelection();
168 /// Set the given wrapped value to the current widget
169 /// This value should be processed in the widget according to the needs
170 /// The method is called by the current operation to process the operation preselection.
171 /// It is redefined to do nothing if the plane of the sketch has been already set.
172 /// \param theValues the wrapped selection values
173 /// \param theToValidate a validation flag
174 bool setSelectionInternal(const QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues,
175 const bool theToValidate);
177 /// Erase preview planes, disconnect widget, change the view projection
178 /// \param thePrs a selected presentation
179 void updateByPlaneSelected(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
181 /// Set sketch plane from selected object
182 /// \param theFeature a feature of sketch
183 /// \param thePrs a presentation
184 bool fillSketchPlaneBySelection(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
187 /// A slot called on set sketch plane view
188 void onSetPlaneView();
190 /// Emits signal about check box state changed with information about ConstraintVisibleState
191 /// \param theOn a flag show constraints or not
192 void onShowConstraint(bool theOn);
195 /// Set sketch plane by shape
196 /// \param theShape a planar face
197 std::shared_ptr<GeomAPI_Dir> setSketchPlane(const TopoDS_Shape& theShape);
200 /// \param thePlane a plane
201 std::shared_ptr<GeomAPI_Dir> setSketchPlane(std::shared_ptr<GeomAPI_Pln> thePlane);
204 * Returns list of presentations which have displayed shapes with circular edges
205 * (circles, arcs) which are in pane of of the given sketch
206 * \param theSketch - the sketch
208 QList<std::shared_ptr<ModuleBase_ViewerPrs>> findCircularEdgesInPlane();
211 /// class to show/hide preview planes
212 PartSet_PreviewPlanes* myPreviewPlanes;
214 QCheckBox* myViewInverted;
216 QMap<PartSet_Tools::ConstraintVisibleState, QCheckBox*> myShowConstraints;
218 QWidget* mySizeOfViewWidget; ///< Size of view widget, visualized if preview planes are shown
219 QLineEdit* mySizeOfView; ///< Value of square of size of View
220 QStackedWidget* myStackWidget;