src/FeaturesPlugin/FeaturesPlugin_Loft.h

   1 // Copyright (C) 2014-2023  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 email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef FeaturesPlugin_Loft_H_
  21 #define FeaturesPlugin_Loft_H_
  22
  23 #include "FeaturesPlugin.h"
  24
  25 #include <GeomAlgoAPI_Loft.h>
  26
  27 #include <ModelAPI_Feature.h>
  28 #include <ModelAPI_ResultBody.h>
  29
  30 class GeomAPI_Pnt;
  31
  32 /// \class FeaturesPlugin_Loft
  33 /// \ingroup Plugins
  34 /// \brief Feature for creation of extrusion along a path.
  35 /// Pipe creates extrusion of objects along a path.
  36 /// It produces the following results from objects:
  37 /// Vertex -> Edge
  38 /// Edge -> Face
  39 /// Wire -> Shell
  40 /// Face -> Solid
  41 class FeaturesPlugin_Loft : public ModelAPI_Feature
  42 {
  43 public:
  44   /// Feature kind.
  45   inline static const std::string& ID()
  46   {
  47     static const std::string MY_FEATURE_ID("Loft");
  48     return MY_FEATURE_ID;
  49   }
  50
  51   /// Attribute name for first object selected.
  52   inline static const std::string& FIRST_OBJECT_ID()
  53   {
  54     static const std::string MY_FIRST_OBJECT("first_object");
  55     return MY_FIRST_OBJECT;
  56   }
  57
  58   /// Attribute name for second object selected.
  59   inline static const std::string& SECOND_OBJECT_ID()
  60   {
  61     static const std::string MY_SECOND_OBJECT("second_object");
  62     return MY_SECOND_OBJECT;
  63   }
  64
  65   /// \return the kind of a feature.
  66   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  67   {
  68     static std::string MY_KIND = FeaturesPlugin_Loft::ID();
  69     return MY_KIND;
  70   }
  71
  72   /// Performs the algorithm and stores results it in the data structure.
  73   FEATURESPLUGIN_EXPORT virtual void execute();
  74
  75   /// Request for initialization of data model of the feature: adding all attributes
  76   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  77
  78   /// Use plugin manager for features creation
  79   FeaturesPlugin_Loft();
  80 };
  81
  82 #endif