1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: PartSet_WidgetSketchLabel.h
4 // Created: 07 July 2014
5 // Author: Vitaly SMETANNIKOV
7 #ifndef PartSet_WidgetSketchLabel_H
8 #define PartSet_WidgetSketchLabel_H
12 #include "PartSet_Tools.h"
14 #include <ModuleBase_WidgetValidated.h>
15 #include <ModuleBase_ViewerFilters.h>
17 #include <GeomAPI_Pnt.h>
18 #include <GeomAPI_Dir.h>
19 #include <GeomAPI_AISObject.h>
21 #include <TopoDS_Shape.hxx>
26 class XGUI_OperationMgr;
31 /// the plane edge width
32 #define SKETCH_WIDTH "4"
34 /// face of the square-face displayed for selection of general plane
35 #define PLANE_SIZE "200"
39 * A model widget implementation for a label which provides specific behaviour
40 * for sketcher starting and launching operations
42 class PARTSET_EXPORT PartSet_WidgetSketchLabel : public ModuleBase_WidgetValidated
48 /// \param theParent the parent object
49 /// \param theWorkshop a reference to workshop
50 /// \param theData the widget configuation. The attribute of the model widget is obtained from
51 /// \param toShowConstraints a current show constraints state
52 PartSet_WidgetSketchLabel(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
53 const Config_WidgetAPI* theData,
54 const QMap<PartSet_Tools::ConstraintVisibleState, bool>& toShowConstraints);
56 virtual ~PartSet_WidgetSketchLabel();
58 /// Set the given wrapped value to the current widget
59 /// This value should be processed in the widget according to the needs
60 /// The method is called by the current operation to process the operation preselection.
61 /// It is redefined to do nothing if the plane of the sketch has been already set.
62 /// \param theValues the wrapped selection values
63 /// \param theToValidate a validation flag
64 virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
65 const bool theToValidate);
67 /// Returns list of widget controls
68 /// \return a control list
69 virtual QList<QWidget*> getControls() const;
71 /// The methiod called when widget is deactivated
72 virtual void deactivate();
74 /// Returns sketcher plane
75 std::shared_ptr<GeomAPI_Pln> plane() const;
77 /// This control accepts focus
78 virtual bool focusTo();
79 virtual void setHighlighted(bool) { /*do nothing*/ };
80 virtual void enableFocusProcessing();
82 static bool fillSketchPlaneBySelection(const FeaturePtr& theFeature,
83 const ModuleBase_ViewerPrs& thePrs);
86 /// Signal on plane selection
87 void planeSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
89 /// A show constraint toggled signal
90 /// \param theType a ConstraintVisibleState value
91 /// \param theState a state of the check box
92 void showConstraintToggled(int theType, bool theState);
95 /// Creates a backup of the current values of the attribute
96 /// It should be realized in the specific widget because of different
97 /// parameters of the current attribute
98 virtual void storeAttributeValue();
100 /// Creates a backup of the current values of the attribute
101 /// It should be realized in the specific widget because of different
102 /// parameters of the current attribute
103 /// \param theValid a boolean flag, if restore happens for valid parameters
104 virtual void restoreAttributeValue(const bool theValid);
106 /// Fills the attribute with the value of the selected owner
107 /// \param thePrs a selected owner
108 virtual bool setSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
110 /// Saves the internal parameters to the given feature
111 /// \return True in success
112 virtual bool storeValueCustom() const
117 virtual bool restoreValueCustom()
122 /// The methiod called when widget is activated
123 virtual void activateCustom();
125 /// Block the model flush of update and intialization of attribute
126 /// In additional to curstom realization it blocks initialization for all feature attributes
127 /// as the current attribute is selection but its modification leads to other attributes change
128 /// \param theToBlock flag whether the model is blocked or unblocked
129 /// \param isActive out value if model is blocked, in value if model is unblocked
130 /// to be used to restore flush state when unblocked
131 /// \param isAttributeSetInitializedBlocked out value if model is blocked
132 /// in value if model is unblocked to be used to restore previous state when unblocked
133 virtual void blockAttribute(const bool& theToBlock, bool& isFlushesActived,
134 bool& isAttributeSetInitializedBlocked);
136 /// Erase preview planes, disconnect widget, change the view projection
137 /// \param thePrs a selected presentation
138 void updateByPlaneSelected(const ModuleBase_ViewerPrs& thePrs);
141 /// Activate or deactivate selection
142 void activateSelection(bool toActivate);
145 /// Slot on change selection
146 void onSelectionChanged();
148 /// A slot called on set sketch plane view
149 void onSetPlaneView();
151 /// Emits signal about check box state changed with information about ConstraintVisibleState
152 /// \param theOn a flag show constraints or not
153 void onShowConstraint(bool theOn);
156 /// Create preview of planes for sketch plane selection
157 /// \param theOrigin an origin of the plane
158 /// \param theNorm a normal vector of the plane
159 /// \param theRGB a color of plane presentation [r, g, b] array
160 AISObjectPtr createPreviewPlane(std::shared_ptr<GeomAPI_Pnt> theOrigin,
161 std::shared_ptr<GeomAPI_Dir> theNorm,
162 const int theRGB[3]);
165 XGUI_Workshop* workshop() const;
167 /// Set sketch plane by shape
168 /// \param theShape a planar face
169 static std::shared_ptr<GeomAPI_Dir> setSketchPlane(const FeaturePtr& theFeature,
170 const TopoDS_Shape& theShape);
172 /// Erase preview planes
173 void erasePreviewPlanes();
175 /// Show preview planes
176 void showPreviewPlanes();
179 AISObjectPtr myYZPlane;
180 AISObjectPtr myXZPlane;
181 AISObjectPtr myXYPlane;
182 bool myPreviewDisplayed;
184 QCheckBox* myViewInverted;
186 QMap<PartSet_Tools::ConstraintVisibleState, QCheckBox*> myShowConstraints;
188 QStackedWidget* myStackWidget;