src/FeaturesPlugin/FeaturesPlugin_RemoveSubShapes.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 FeaturesPlugin_RemoveSubShapes_H_
  22 #define FeaturesPlugin_RemoveSubShapes_H_
  23
  24 #include "FeaturesPlugin.h"
  25
  26 #include <ModelAPI_Feature.h>
  27
  28 /// \class FeaturesPlugin_RemoveSubShapes
  29 /// \ingroup Plugins
  30 /// \brief Feature for removing sub-shapes from collections(wire, shell, compsolid, compound).
  31 class FeaturesPlugin_RemoveSubShapes: public ModelAPI_Feature
  32 {
  33 public:
  34   /// Use plugin manager for features creation
  35   FeaturesPlugin_RemoveSubShapes();
  36
  37   /// Feature kind.
  38   inline static const std::string& ID()
  39   {
  40     static const std::string MY_ID("Remove_SubShapes");
  41     return MY_ID;
  42   }
  43
  44   /// Attribute name of base shape.
  45   inline static const std::string& BASE_SHAPE_ID()
  46   {
  47     static const std::string MY_BASE_SHAPE_ID("base_shape");
  48     return MY_BASE_SHAPE_ID;
  49   }
  50
  51   /// Attribute name for creation method.
  52   inline static const std::string& CREATION_METHOD()
  53   {
  54     static const std::string MY_CREATION_METHOD_ID("creation_method");
  55     return MY_CREATION_METHOD_ID;
  56   }
  57
  58   /// Attribute name for creation method.
  59   inline static const std::string& CREATION_METHOD_BY_KEEP_SUBSHAPES()
  60   {
  61     static const std::string MY_CREATION_METHOD_ID("by_keep_subshapes");
  62     return MY_CREATION_METHOD_ID;
  63   }
  64
  65   /// Attribute name for creation method.
  66   inline static const std::string& CREATION_METHOD_BY_REMOVE_SUBSHAPES()
  67   {
  68     static const std::string MY_CREATION_METHOD_ID("by_remove_subshapes");
  69     return MY_CREATION_METHOD_ID;
  70   }
  71
  72   /// Attribute name of sub-shapes to keep.
  73   inline static const std::string& SUBSHAPES_TO_KEEP_ID()
  74   {
  75     static const std::string MY_SUBSHAPES_ID("subshapes_to_keep");
  76     return MY_SUBSHAPES_ID;
  77   }
  78
  79   /// Attribute name of sub-shapes to remove.
  80   inline static const std::string& SUBSHAPES_TO_REMOVE_ID()
  81   {
  82     static const std::string MY_SUBSHAPES_ID("subshapes_to_remove");
  83     return MY_SUBSHAPES_ID;
  84   }
  85
  86
  87   /// \return the kind of a feature.
  88   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  89   {
  90     static std::string MY_KIND = FeaturesPlugin_RemoveSubShapes::ID();
  91     return MY_KIND;
  92   }
  93
  94   /// Request for initialization of data model of the feature: adding all attributes.
  95   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  96
  97   /// Called on change of any argument-attribute of this object.
  98   /// \param[in] theID identifier of changed attribute.
  99   FEATURESPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
 100
 101   /// Creates a new part document if needed.
 102   FEATURESPLUGIN_EXPORT virtual void execute();
 103
 104 private:
 105   bool myChangedInCode;
 106 };
 107
 108 #endif