Salome HOME
Construction elements are auxiliary entities:
[modules/shaper.git] / src / PartSet / PartSet_WidgetSketchLabel.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 // File:        PartSet_WidgetSketchLabel.h
4 // Created:     07 July 2014
5 // Author:      Vitaly SMETANNIKOV
6
7 #ifndef PartSet_WidgetSketchLabel_H
8 #define PartSet_WidgetSketchLabel_H
9
10 #include "PartSet.h"
11
12 #include <ModuleBase_ModelWidget.h>
13 #include <ModuleBase_ViewerFilters.h>
14
15 #include <GeomAPI_Pnt.h>
16 #include <GeomAPI_Dir.h>
17 #include <GeomAPI_AISObject.h>
18
19 #include <StdSelect_FaceFilter.hxx>
20 #include <TopoDS_Shape.hxx>
21
22 class QLabel;
23 class QTimer;
24 class XGUI_OperationMgr;
25 class XGUI_Workshop;
26
27 /// the plane edge width
28 #define SKETCH_WIDTH        "4"
29
30 /// face of the square-face displayed for selection of general plane
31 #define PLANE_SIZE          "200"
32
33 /**
34 * \ingroup Modules
35 * A model widget implementation for a label which provides specific behaviour 
36 * for sketcher starting and launching operations
37 */
38 class PARTSET_EXPORT PartSet_WidgetSketchLabel : public ModuleBase_ModelWidget
39 {
40 Q_OBJECT
41  public:
42   /// Constructor
43   /// \param theParent the parent object
44   /// \param theData the widget configuation. The attribute of the model widget is obtained from
45   /// \param theParentId is Id of a parent of the current attribute
46   PartSet_WidgetSketchLabel(QWidget* theParent, const Config_WidgetAPI* theData,
47                             const std::string& theParentId);
48
49   virtual ~PartSet_WidgetSketchLabel();
50
51   virtual bool restoreValue()
52   {
53     return true;
54   }
55
56   /// Returns list of widget controls
57   /// \return a control list
58   virtual QList<QWidget*> getControls() const;
59
60   /// The methiod called when widget is deactivated
61   virtual void deactivate();
62
63   /// Returns pointer to workshop
64   XGUI_Workshop* workshop() const { return myWorkshop; }
65
66   /// Set pointer to workshop
67   /// \param theWork a pointer to workshop
68   void setWorkshop(XGUI_Workshop* theWork) { myWorkshop = theWork; }
69
70   /// Returns sketcher plane
71   std::shared_ptr<GeomAPI_Pln> plane() const;
72
73   /// This control accepts focus
74   virtual bool focusTo() { return true; }
75
76 signals:
77   /// Signal on plane selection
78   void planeSelected(const std::shared_ptr<GeomAPI_Pln>& thePln);
79
80 protected:
81   /// Saves the internal parameters to the given feature
82   /// \return True in success
83   virtual bool storeValueCustom() const
84   {
85     return true;
86   }
87
88   /// The methiod called when widget is activated
89   virtual void activateCustom();
90
91  private slots:
92    /// Slot on plane selection
93   void onPlaneSelected();
94
95   /// Set sketch specific mode of selection
96   void setSketchingMode();
97
98  private:
99    /// Create preview of planes for sketch plane selection
100    /// \param theOrigin an origin of the plane
101    /// \param theNorm a normal vector of the plane
102    /// \param theRGB a color of plane presentation [r, g, b] array
103   AISObjectPtr createPreviewPlane(std::shared_ptr<GeomAPI_Pnt> theOrigin, 
104                                   std::shared_ptr<GeomAPI_Dir> theNorm, 
105                                   const int theRGB[3]);
106
107   /// Set sketch plane by shape
108   /// \param theShape a planar face
109   std::shared_ptr<GeomAPI_Dir> setSketchPlane(const TopoDS_Shape& theShape);
110
111   /// Erase preview planes
112   void erasePreviewPlanes();
113
114   /// Show preview planes
115   void showPreviewPlanes();
116
117
118   QLabel* myLabel;
119   QString myText;
120   QString myTooltip;
121
122   XGUI_Workshop* myWorkshop;
123
124   AISObjectPtr myYZPlane;
125   AISObjectPtr myXZPlane;
126   AISObjectPtr myXYPlane;
127   bool myPreviewDisplayed;
128
129   Handle(StdSelect_FaceFilter) myFaceFilter;
130
131   QTimer* mySelectionTimer;
132 };
133
134 #endif