src/BuildPlugin/BuildPlugin_Wire.h

   1 // Copyright (C) 2014-2019  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_Wire_H_
  21 #define BuildPlugin_Wire_H_
  22
  23 #include "BuildPlugin.h"
  24
  25 #include <ModelAPI_Feature.h>
  26
  27 /// \class BuildPlugin_Wire
  28 /// \ingroup Plugins
  29 /// \brief Feature for creation of wire from sketch edges or existing wires.
  30 class BuildPlugin_Wire: public ModelAPI_Feature
  31 {
  32 public:
  33   /// Use plugin manager for features creation
  34   BuildPlugin_Wire();
  35
  36   /// Feature kind.
  37   inline static const std::string& ID()
  38   {
  39     static const std::string MY_ID("Wire");
  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 base objects.
  51   inline static const std::string& ADD_CONTOUR_ACTION_ID()
  52   {
  53     static const std::string MY_ADD_CONTOUR_ACTION_ID("add_contour");
  54     return MY_ADD_CONTOUR_ACTION_ID;
  55   }
  56
  57   /// \return the kind of a feature.
  58   BUILDPLUGIN_EXPORT virtual const std::string& getKind()
  59   {
  60     static std::string MY_KIND = BuildPlugin_Wire::ID();
  61     return MY_KIND;
  62   }
  63
  64   /// Request for initialization of data model of the feature: adding all attributes.
  65   BUILDPLUGIN_EXPORT virtual void initAttributes();
  66
  67   /// Creates a new part document if needed.
  68   BUILDPLUGIN_EXPORT virtual void execute();
  69
  70   /// Performs some functionality by action id.
  71   /// \param[in] theAttributeId action key id.
  72   /// \return false in case if action not perfomed.
  73   BUILDPLUGIN_EXPORT virtual bool customAction(const std::string& theActionId);
  74
  75 private:
  76   /// Action: Adds to the list of segments other segments of the sketcher connected to
  77   /// the already selected ones to create a closed contour.
  78   /// \return false in case if no countours have been added.
  79   bool addContour();
  80 };
  81
  82 #endif