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   static const std::string& INCLUDE_INTO_RESULT()
  59   {
  60     static std::string MY_INCLUDE("IncludeToResult");
  61     return MY_INCLUDE;
  62   }
  63
  64   /// Returns true because projected feature is always external
  65   virtual bool isFixed()
  66   { return true; }
  67
  68   /// Returns true if the feature and the feature results can be displayed.
  69   /// \return false
  70   SKETCHPLUGIN_EXPORT virtual bool canBeDisplayed() const
  71   {
  72     return false;
  73   }
  74
  75   /// Creates a new part document if needed
  76   SKETCHPLUGIN_EXPORT virtual void execute();
  77
  78   /// Called on change of any argument-attribute of this object: for external point
  79   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  80
  81   /// Use plugin manager for features creation
  82   SketchPlugin_Projection();
  83
  84 protected:
  85   /// \brief Initializes attributes of derived class.
  86   virtual void initDerivedClassAttributes();
  87
  88 private:
  89   /// \brief Find projection of a feature onto sketch plane
  90   void computeProjection(const std::string& theID);
  91
  92   bool myIsComputing;
  93 };
  94
  95 #endif