1 // File: PartSet_OperationSketchLine.h
2 // Created: 20 Apr 2014
3 // Author: Natalia ERMOLAEVA
5 #ifndef PartSet_OperationSketchLine_H
6 #define PartSet_OperationSketchLine_H
10 #include <PartSet_OperationSketchBase.h>
13 class GeomDataAPI_Point2D;
17 \class PartSet_OperationSketchLine
18 * \brief The operation for the sketch feature creation
20 class PARTSET_EXPORT PartSet_OperationSketchLine : public PartSet_OperationSketchBase
25 /// Returns the operation type key
26 static std::string Type() { return "SketchLine"; }
30 /// \param theId the feature identifier
31 /// \param theParent the operation parent
32 /// \param theFeature the parent feature
33 PartSet_OperationSketchLine(const QString& theId, QObject* theParent,
34 boost::shared_ptr<ModelAPI_Feature> theSketchFeature);
36 virtual ~PartSet_OperationSketchLine();
38 /// Returns that this operator can be started above already running one.
39 /// The runned operation should be the sketch feature modified operation
40 /// \param theOperation the previous running operation
41 virtual bool isGranted(ModuleBase_IOperation* theOperation) const;
43 /// Returns the operation local selection mode
44 /// \param theFeature the feature object to get the selection mode
45 /// \return the selection mode
46 virtual std::list<int> getSelectionModes(boost::shared_ptr<ModelAPI_Feature> theFeature) const;
48 /// Initializes some fields accorging to the feature
49 /// \param theFeature the feature
50 /// \param thePresentations the list of additional presentations
51 virtual void init(boost::shared_ptr<ModelAPI_Feature> theFeature,
52 const std::list<XGUI_ViewerPrs>& thePresentations);
54 /// Returns the operation sketch feature
55 /// \returns the sketch instance
56 virtual boost::shared_ptr<ModelAPI_Feature> sketch() const;
58 /// Gives the current selected objects to be processed by the operation
59 /// \param thePoint a point clicked in the viewer
60 /// \param theEvent the mouse event
61 /// \param theSelected the list of selected presentations
62 virtual void mouseReleased(QMouseEvent* theEvent, Handle_V3d_View theView,
63 const std::list<XGUI_ViewerPrs>& theSelected);
64 /// Gives the current mouse point in the viewer
65 /// \param thePoint a point clicked in the viewer
66 /// \param theEvent the mouse event
67 virtual void mouseMoved(QMouseEvent* theEvent, Handle_V3d_View theView);
68 /// Processes the key pressed in the view
69 /// \param theKey a key value
70 virtual void keyReleased(const int theKey);
73 /// \brief Virtual method called when operation is started
74 /// Virtual method called when operation started (see start() method for more description)
75 /// After the parent operation body perform, set sketch feature to the created line feature
76 virtual void startOperation();
78 /// Virtual method called when operation aborted (see abort() method for more description)
79 /// Before the feature is aborted, it should be hidden from the viewer
80 virtual void abortOperation();
82 /// Virtual method called when operation stopped - committed or aborted.
83 /// Restore the multi selection state
84 virtual void stopOperation();
86 /// Creates an operation new feature
87 /// In addition to the default realization it appends the created line feature to
88 /// the sketch feature
89 /// \returns the created feature
90 virtual boost::shared_ptr<ModelAPI_Feature> createFeature();
92 /// Creates a constraint on two points
93 /// \param thePoint1 the first point
94 /// \param thePoint1 the second point
95 void createConstraint(boost::shared_ptr<GeomDataAPI_Point2D> thePoint1,
96 boost::shared_ptr<GeomDataAPI_Point2D> thePoint2);
98 /// Creates constrains of the current
99 /// \param theX the horizontal coordnate of the point
100 /// \param theY the vertical coordnate of the point
101 void setConstraints(double theX, double theY);
103 /// \brief Get the line point 2d coordinates.
104 /// \param theFeature the line feature
105 /// \param theAttribute the start or end attribute of the line
106 /// \param theX the horizontal coordinate
107 /// \param theY the vertical coordinate
108 void getLinePoint(boost::shared_ptr<ModelAPI_Feature> theFeature, const std::string& theAttribute,
109 double& theX, double& theY);
110 /// Find a point in the line with given coordinates
111 /// \param theFeature the line feature
112 /// \param theX the horizontal point coordinate
113 /// \param theY the vertical point coordinate
114 boost::shared_ptr<GeomDataAPI_Point2D> findLinePoint(boost::shared_ptr<ModelAPI_Feature> theFeature,
115 double theX, double theY);
117 /// \brief Save the point to the line.
118 /// \param theX the horizontal coordinate
119 /// \param theY the vertical coordinate
120 /// \param theAttribute the start or end attribute of the line
121 void setLinePoint(double theX, double theY, const std::string& theAttribute);
122 /// \brief Save the point to the line.
123 /// \param thePoint the 3D point in the viewer
124 /// \param theAttribute the start or end attribute of the line
125 void setLinePoint(const gp_Pnt& thePoint, Handle(V3d_View) theView, const std::string& theAttribute);
128 ///< Structure to lists the possible types of point selection modes
129 enum PointSelectionMode {SM_FirstPoint, SM_SecondPoint};
132 boost::shared_ptr<ModelAPI_Feature> mySketch; ///< the sketch feature
133 boost::shared_ptr<GeomDataAPI_Point2D> myInitPoint; ///< the first line point
134 PointSelectionMode myPointSelectionMode; ///< point selection mode