1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: PartSet_WidgetPoint2d.h
4 // Created: 25 Apr 2014
5 // Author: Natalia ERMOLAEVA
7 #ifndef PartSet_WidgetPoint2D_H
8 #define PartSet_WidgetPoint2D_H
11 #include <ModelAPI_CompositeFeature.h>
12 #include <ModuleBase_ModelWidget.h>
16 #include <TopoDS_Shape.hxx>
17 #include <V3d_View.hxx>
19 class ModelAPI_Feature;
20 class ModuleBase_IWorkshop;
21 class ModuleBase_ParamSpinBox;
22 class ModuleBase_IViewWindow;
24 class ModuleBase_IWorkshop;
29 /**\class PartSet_WidgetPoint2D
31 * \brief Implementation of model widget to provide widget to input point 2d
32 * In XML can be defined as folloung:
34 * <sketch-2dpoint_selector id="CircleCenter" title="Center" tooltip="Center coordinates"/>
37 class PARTSET_EXPORT PartSet_WidgetPoint2D : public ModuleBase_ModelWidget
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);
50 virtual ~PartSet_WidgetPoint2D();
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);
59 /// Select the internal content if it can be selected. It is empty in the default realization
60 virtual void selectContent();
62 /// Returns list of widget controls
63 /// \return a control list
64 virtual QList<QWidget*> getControls() const;
66 //bool initFromPrevious(ObjectPtr theObject);
68 /// Defines if the widget can be activated by mouse move.
69 /// By default it returns false
70 virtual bool canBeActivatedByMove();
72 /// The methiod called when widget is deactivated
73 virtual void deactivate();
75 /// \returns the sketch instance
76 CompositeFeaturePtr sketch() const { return mySketch; }
78 /// Set sketch instance
79 void setSketch(CompositeFeaturePtr theSketch) { mySketch = theSketch; }
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);
87 /// Returns coordinate X currently defined in the control
90 /// Returns coordinate Y currently defined in the control
93 /// Returns true if the event is processed.
94 virtual bool processEnter();
96 /// Returns true if the attribute can be changed using the selected shapes in the viewer
97 /// and creating a coincidence constraint to them. This control use them.
98 virtual bool useSelectedShapes() const;
101 /// Signal about selection of an existing vertex from an object
102 void vertexSelected();
105 /// Process mouse move event
106 /// \param theWnd a view window
107 /// \param theEvent a mouse event
108 void onMouseMove(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
110 /// Process mouse release event
111 /// \param theWnd a view window
112 /// \param theEvent a mouse event
113 void onMouseRelease(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
116 /// Saves the internal parameters to the given feature
117 /// \return True in success
118 virtual bool storeValueCustom() const;
120 virtual bool restoreValueCustom();
122 /// Fills the widget with default values
123 /// \return true if the widget current value is reset
124 virtual bool resetCustom();
126 /// The methiod called when widget is activated
127 virtual void activateCustom();
129 /// Returns true if the feature contains Point2D attribute with the same coordinates
130 /// The attribute of the widget is not processed.
131 /// \param theFeature a feature
132 /// \param theX the X coordinate
133 /// \param theY the Y coordinate
134 /// \return boolean result
135 bool isFeatureContainsPoint(const FeaturePtr& theFeature, double theX, double theY);
138 /// Process value changed event
139 //void onValuesChanged();
141 /// Compute the feature default value and fill the controls with it
142 /// or store the control value to the feature
143 /// The widget is not initialize the attribute value in order to avoid the
144 /// incorrect visualization in Sketch. E.g. by a line creation, the line should not
145 /// be visualized immediatelly when the end point widget is activated.
146 virtual void initializeValueByActivate();
149 /// Returns point 2d from selected vertex
150 /// \param theView a view window
151 /// \param theShape a vertex shape
152 /// \param theX an output value of X coordinate
153 /// \param theY an output value of Y coordinate
154 bool getPoint2d(const Handle(V3d_View)& theView, const TopoDS_Shape& theShape,
155 double& theX, double& theY) const;
157 /// Create a coincidence constraint between the attribute and the parameter object
158 /// \theObject a result object
159 void setConstraintWith(const ObjectPtr& theObject);
161 /// Returns if the feature is an orphan point, circle or an arc. Returns true if it
162 /// has no a coincident to other lines. It processes point, circle and arc features
163 /// In circle an arc features, only centers are processed, for other points, it returns
164 /// that the point is not an orphan.
165 /// \param theFeature a checked feature
166 /// \param theSketch a sketch
167 /// \param theX an X coordinate of the point
168 /// \param theY an Y coordinate of the point
169 /// \return boolean result
170 static bool isOrphanPoint(const FeaturePtr& theFeature, const CompositeFeaturePtr& theSketch,
171 double theX, double theY, const bool theSearchInResults = false);
174 ModuleBase_IWorkshop* myWorkshop; ///< workshop
178 QGroupBox* myGroupBox; ///< the parent group box for all intenal widgets
179 ModuleBase_ParamSpinBox* myXSpin; ///< the spin box for the X coordinate
180 ModuleBase_ParamSpinBox* myYSpin; ///< the spin box for the Y coordinate
182 //std::string myOptionParam; /// Parameter name which has to be taken from previous feature
184 CompositeFeaturePtr mySketch;