src/FeaturesPlugin/FeaturesPlugin_BooleanSmash.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_BooleanSmash_H_
  22 #define FeaturesPlugin_BooleanSmash_H_
  23
  24 #include "FeaturesPlugin_Boolean.h"
  25
  26 #include <ModelAPI_ResultBody.h>
  27
  28 /// \class FeaturesPlugin_BooleanSmash
  29 /// \ingroup Plugins
  30 /// \brief Feature for applying of Boolean Smash operation.
  31 class FeaturesPlugin_BooleanSmash : public FeaturesPlugin_Boolean
  32 {
  33 public:
  34
  35   /// Feature kind.
  36   inline static const std::string& ID()
  37   {
  38     static const std::string MY_ID("Smash");
  39     return MY_ID;
  40   }
  41
  42   /// \return the kind of a feature.
  43   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  44   {
  45     static std::string MY_KIND = FeaturesPlugin_BooleanSmash::ID();
  46     return MY_KIND;
  47   }
  48
  49   /// Attribute name of main objects.
  50   inline static const std::string& OBJECT_LIST_ID()
  51   {
  52     static const std::string MY_OBJECT_LIST_ID("main_objects");
  53     return MY_OBJECT_LIST_ID;
  54   }
  55
  56   /// Attribute name of tool objects.
  57   inline static const std::string& TOOL_LIST_ID()
  58   {
  59     static const std::string MY_TOOL_LIST_ID("tool_objects");
  60     return MY_TOOL_LIST_ID;
  61   }
  62
  63   /// Request for initialization of data model of the feature: adding all attributes.
  64   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  65
  66   /// Creates a new part document if needed.
  67   FEATURESPLUGIN_EXPORT virtual void execute();
  68
  69 public:
  70
  71   /// Use plugin manager for features creation.
  72   FeaturesPlugin_BooleanSmash();
  73
  74 private:
  75
  76   /// Load Naming data structure of the feature to the document
  77   void loadNamingDS(ResultBodyPtr theResultBody,
  78                     const GeomShapePtr theBaseShape,
  79                     const ListOfShape& theTools,
  80                     const GeomShapePtr theResultShape,
  81                     GeomAlgoAPI_MakeShape& theMakeShape,
  82                     GeomAPI_DataMapOfShapeShape& theMapOfShapes);
  83
  84 };
  85
  86 #endif