src/BuildPlugin/BuildPlugin_Polyline.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 BuildPlugin_Polyline_H_
  21 #define BuildPlugin_Polyline_H_
  22
  23 #include "BuildPlugin.h"
  24
  25 #include <ModelAPI_Feature.h>
  26
  27 /// \class BuildPlugin_Polyline
  28 /// \ingroup Plugins
  29 /// \brief Feature for creation of polyline from set of points.
  30 class BuildPlugin_Polyline : public ModelAPI_Feature
  31 {
  32 public:
  33         /// Use plugin manager for features creation
  34         BuildPlugin_Polyline();
  35
  36         /// Feature kind.
  37         inline static const std::string& ID()
  38         {
  39                 static const std::string MY_ID("Polyline");
  40                 return MY_ID;
  41         }
  42
  43         /// Attribute name of base objects.
  44         inline static const std::string& BASE_OBJECTS_ID()
  45         {
  46                 static const std::string MY_BASE_OBJECTS_ID("base_objects");
  47                 return MY_BASE_OBJECTS_ID;
  48         }
  49
  50   /// Attribute name of closed flag.
  51   inline static const std::string& CLOSED_ID()
  52   {
  53     static const std::string MY_CLOSED_ID("closed");
  54     return MY_CLOSED_ID;
  55   }
  56
  57   /// Default value of the closed attribute
  58   inline static bool CLOSED_DEFAULT() { return false; }
  59
  60         /// \return the kind of a feature.
  61         BUILDPLUGIN_EXPORT virtual const std::string& getKind()
  62         {
  63                 static std::string MY_KIND = BuildPlugin_Polyline::ID();
  64                 return MY_KIND;
  65         }
  66
  67         /// Request for initialization of data model of the feature: adding all attributes.
  68         BUILDPLUGIN_EXPORT virtual void initAttributes();
  69
  70         /// Creates a new part document if needed.
  71         BUILDPLUGIN_EXPORT virtual void execute();
  72 };
  73
  74 #endif