Salome HOME
Merge branch 'master' of newgeom:newgeom
[modules/shaper.git] / src / PartSet / PartSet_FeaturePointPrs.h
1 // File:        PartSet_FeaturePointPrs.h
2 // Created:     04 Jun 2014
3 // Author:      Natalia ERMOLAEVA
4
5 #ifndef PartSet_FeaturePointPrs_H
6 #define PartSet_FeaturePointPrs_H
7
8 #include "PartSet.h"
9
10 #include "PartSet_FeaturePrs.h"
11 #include "PartSet_Constants.h"
12
13 class GeomDataAPI_Point2D;
14
15 /*!
16  \class PartSet_FeaturePointPrs
17  * \brief The abstract class to define the specific feature manipulation. It is created for
18  * the feature create operation to move out the feature properties set and use one operation
19  * for any type of features.
20 */
21 class PARTSET_EXPORT PartSet_FeaturePointPrs : public PartSet_FeaturePrs
22 {
23 public:
24   /// Constructor
25   /// \param theSketch the sketch feature
26   PartSet_FeaturePointPrs(FeaturePtr theSketch);
27   /// Destructor
28   virtual ~PartSet_FeaturePointPrs() {};
29
30   /// Sets the point to the feature in an attribute depending on the selection mode
31   /// \param theX the 2D point horizontal coordinate
32   /// \param theY the 2D point vertical coordinate
33   /// \param theMode the selection mode
34   /// \return the new selection mode
35   virtual PartSet_SelectionMode setPoint(double theX, double theY,
36                                          const PartSet_SelectionMode& theMode);
37
38   /// Returns the feature attribute name for the selection mode
39   /// \param theMode the current operation selection mode. The feature attribute depends on the mode
40   virtual std::string getAttribute(const PartSet_SelectionMode& theMode) const;
41
42   /// Returns the next selection mode after the attribute
43   /// \param theAttribute the feature attribute name
44   /// \return next attribute selection mode
45   virtual PartSet_SelectionMode getNextMode(const std::string& theAttribute) const;
46
47 protected:
48   /// Initializes current feature by the given
49   /// \param theSourceFeature the feature, which attributes are used to initialize the current feature
50   virtual void initFeature(FeaturePtr theSourceFeature);
51
52   /// Returns the feature point in the selection mode position.
53   /// \param theMode the current operation selection mode. The feature attribute depends on the mode
54   virtual boost::shared_ptr<GeomDataAPI_Point2D> featurePoint(const PartSet_SelectionMode& theMode);
55 };
56
57 #endif