]> SALOME platform Git repositories - modules/shaper.git/blob - src/SketchPlugin/SketchPlugin_Projection.h
Salome HOME
Merge branch 'Pre_2.8.0_development'
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Projection.h
1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #ifndef SketchPlugin_Projection_H_
22 #define SketchPlugin_Projection_H_
23
24 #include "SketchPlugin_SketchEntity.h"
25
26 /** \class SketchPlugin_Projection
27  *  \ingroup Plugins
28  *  \brief Feature for creation of external feature as a projection onto the sketch plane.
29  */
30 class SketchPlugin_Projection : public SketchPlugin_SketchEntity
31 {
32 public:
33   /// Projection feature kind
34   inline static const std::string& ID()
35   {
36     static const std::string MY_PROJECTION_ID("SketchProjection");
37     return MY_PROJECTION_ID;
38   }
39   /// Returns the kind of a feature
40   virtual const std::string& getKind()
41   {
42     static std::string MY_KIND = SketchPlugin_Projection::ID();
43     return MY_KIND;
44   }
45
46   static const std::string& EXTERNAL_FEATURE_ID()
47   {
48     static std::string MY_EXT_FEATURE_ID("ExternalFeature");
49     return MY_EXT_FEATURE_ID;
50   }
51
52   static const std::string& PROJECTED_FEATURE_ID()
53   {
54     static std::string MY_PROJ_FEATURE_ID("ProjectedFeature");
55     return MY_PROJ_FEATURE_ID;
56   }
57
58   /// Returns true because projected feature is always external
59   virtual bool isFixed()
60   { return true; }
61
62   /// Returns true if the feature and the feature results can be displayed.
63   /// \return false
64   SKETCHPLUGIN_EXPORT virtual bool canBeDisplayed() const
65   {
66     return false;
67   }
68
69   /// Creates a new part document if needed
70   SKETCHPLUGIN_EXPORT virtual void execute();
71
72   /// Moves the feature
73   /// \param theDeltaX the delta for X coordinate is moved
74   /// \param theDeltaY the delta for Y coordinate is moved
75   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
76
77   /// Called on change of any argument-attribute of this object: for external point
78   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
79
80   /// Use plugin manager for features creation
81   SketchPlugin_Projection();
82
83 protected:
84   /// \brief Initializes attributes of derived class.
85   virtual void initDerivedClassAttributes();
86
87 private:
88   /// \brief Find projection of a feature onto sketch plane
89   void computeProjection(const std::string& theID);
90
91   bool myIsComputing;
92 };
93
94 #endif