Salome HOME
Merge remote-tracking branch 'origin/BR_REENTRANCE_OPERATION' into origin_Dev_1.5.0
[modules/shaper.git] / src / PartSet / PartSet_WidgetPoint2d.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 // File:        PartSet_WidgetPoint2d.h
4 // Created:     25 Apr 2014
5 // Author:      Natalia ERMOLAEVA
6
7 #ifndef PartSet_WidgetPoint2D_H
8 #define PartSet_WidgetPoint2D_H
9
10 #include "PartSet.h"
11 #include <ModelAPI_CompositeFeature.h>
12 #include <ModuleBase_ModelWidget.h>
13
14 #include <QObject>
15
16 #include <TopoDS_Shape.hxx>
17 #include <V3d_View.hxx>
18
19 class ModelAPI_Feature;
20 class ModuleBase_IWorkshop;
21 class ModuleBase_ParamSpinBox;
22 class ModuleBase_IViewWindow;
23 class GeomAPI_Pnt2d;
24 class ModuleBase_IWorkshop;
25
26 class QGroupBox;
27 class QMouseEvent;
28
29 /**\class PartSet_WidgetPoint2D
30  * \ingroup Modules
31  * \brief Implementation of model widget to provide widget to input point 2d
32  * In XML can be defined as folloung:
33  * \code
34  * <sketch-2dpoint_selector id="CircleCenter" title="Center" tooltip="Center coordinates"/>
35  * \endcode
36  */
37 class PARTSET_EXPORT PartSet_WidgetPoint2D : public ModuleBase_ModelWidget
38 {
39 Q_OBJECT
40  public:
41   /// Constructor
42   /// \param theParent the parent object
43   /// \param theWorkshop a current workshop
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_WidgetPoint2D(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
47                         const Config_WidgetAPI* theData, 
48                         const std::string& theParentId);
49   /// Destructor
50   virtual ~PartSet_WidgetPoint2D();
51
52   /// Set the given wrapped value to the current widget
53   /// This value should be processed in the widget according to the needs
54   /// \param theValues the wrapped widget values
55   /// \param theToValidate a validation flag
56   virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
57                             const bool theToValidate);
58
59   /// Select the internal content if it can be selected. It is empty in the default realization
60   virtual void selectContent();
61
62   /// Returns list of widget controls
63   /// \return a control list
64   virtual QList<QWidget*> getControls() const;
65
66   //bool initFromPrevious(ObjectPtr theObject);
67
68   /// Defines if the widget can be activated by mouse move.
69   /// By default it returns false
70   virtual bool canBeActivatedByMove();
71
72   /// The methiod called when widget is deactivated
73   virtual void deactivate();
74
75   /// \returns the sketch instance
76   CompositeFeaturePtr sketch() const { return mySketch; }
77
78   /// Set sketch instance
79   void setSketch(CompositeFeaturePtr theSketch) { mySketch = theSketch; }
80
81   /// Fill the widget values by given point
82   /// \param theX the X coordinate
83   /// \param theY the Y coordinate
84   /// \returns True in case of success
85   bool setPoint(double theX, double theY);
86
87   /// Returns coordinate X currently defined in the control
88   double x() const;
89
90   /// Returns coordinate Y currently defined in the control
91   double y() const;
92
93   /// Returns true if the event is processed.
94   virtual bool processEnter();
95
96 signals:
97   /// Signal about selection of an existing vertex from an object
98   void vertexSelected();
99
100 public slots:
101   /// Process mouse move event
102   /// \param theWnd a view window
103   /// \param theEvent a mouse event
104   void onMouseMove(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
105
106   /// Process mouse release event
107   /// \param theWnd a view window
108   /// \param theEvent a mouse event
109   void onMouseRelease(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
110
111 protected:
112   /// Saves the internal parameters to the given feature
113   /// \return True in success
114   virtual bool storeValueCustom() const;
115
116   virtual bool restoreValueCustom();
117
118   /// Fills the widget with default values
119   /// \return true if the widget current value is reset
120   virtual bool resetCustom();
121
122   /// The methiod called when widget is activated
123   virtual void activateCustom();
124
125   /// Returns true if the feature contains Point2D attribute with the same coordinates
126   /// The attribute of the widget is not processed.
127   /// \param theFeature a feature
128   /// \param theX the X coordinate
129   /// \param theY the Y coordinate
130   /// \return boolean result
131   bool isFeatureContainsPoint(const FeaturePtr& theFeature, double theX, double theY);
132
133 //private slots:
134   /// Process value changed event
135   //void onValuesChanged();
136
137  private:
138    /// Returns point 2d from selected vertex
139    /// \param theView a view window
140    /// \param theShape a vertex shape
141    /// \param theX an output value of X coordinate
142    /// \param theY an output value of Y coordinate
143    bool getPoint2d(const Handle(V3d_View)& theView, const TopoDS_Shape& theShape, 
144                    double& theX, double& theY) const;
145
146    /// Create a coincidence constraint between the attribute and the parameter object
147    /// \theObject a result object
148    void setConstraintWith(const ObjectPtr& theObject);
149
150    /// Returns if the feature is an orphan point, circle or an arc. Returns true if it
151    /// has no a coincident to other lines. In Circle and arc only center points are processed.
152    /// \param theFeature a checked feature
153    /// \param theSketch a sketch
154    /// \return boolean result
155    static bool isOrphanPoint(const FeaturePtr& theFeature, const CompositeFeaturePtr& theSketch);
156
157 protected:
158   ModuleBase_IWorkshop* myWorkshop; ///< workshop
159
160 private:
161
162   QGroupBox* myGroupBox;  ///< the parent group box for all intenal widgets
163   ModuleBase_ParamSpinBox* myXSpin;  ///< the spin box for the X coordinate
164   ModuleBase_ParamSpinBox* myYSpin;  ///< the spin box for the Y coordinate
165
166   //std::string myOptionParam;  /// Parameter name which has to be taken from previous feature
167
168   CompositeFeaturePtr mySketch;
169 };
170
171 #endif