src/FeaturesPlugin/FeaturesPlugin_Intersection.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 email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  18 //
  19
  20 #ifndef FeaturesPlugin_Intersection_H_
  21 #define FeaturesPlugin_Intersection_H_
  22
  23 #include "FeaturesPlugin.h"
  24
  25 #include <ModelAPI_Feature.h>
  26
  27 #include <GeomAPI_Shape.h>
  28
  29 class GeomAlgoAPI_MakeShape;
  30
  31 /// \class FeaturesPlugin_Intersection
  32 /// \ingroup Plugins
  33 /// \brief Intersection feature takes a list of shapes as objects and list of shapes as tools.
  34 /// The types of objects and tools may be different:
  35 /// whole objects, compsoilds, solids, shells, faces or edges.
  36 /// The result is less than the minimal dimension from pair of intersection:
  37 /// for two solids or two faces it is wire, for the edge and face it is vertex, etc.
  38 class FeaturesPlugin_Intersection : public ModelAPI_Feature
  39 {
  40 public:
  41   /// Feature kind.
  42   inline static const std::string& ID()
  43   {
  44     static const std::string MY_ID("Intersection");
  45     return MY_ID;
  46   }
  47
  48   /// Attribute name of objects.
  49   inline static const std::string& OBJECT_LIST_ID()
  50   {
  51     static const std::string MY_OBJECT_LIST_ID("main_objects");
  52     return MY_OBJECT_LIST_ID;
  53   }
  54
  55   /// Attribute name of tools.
  56   inline static const std::string& TOOL_LIST_ID()
  57   {
  58     static const std::string MY_TOOL_LIST_ID("tool_objects");
  59     return MY_TOOL_LIST_ID;
  60   }
  61
  62   /// Returns the kind of a feature.
  63   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  64   {
  65     static std::string MY_KIND = FeaturesPlugin_Intersection::ID();
  66     return MY_KIND;
  67   }
  68
  69   /// Executes feature.
  70   FEATURESPLUGIN_EXPORT virtual void execute();
  71
  72   /// Request for initialization of data model of the feature: adding all attributes.
  73   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  74
  75   /// Use plugin manager for features creation.
  76   FeaturesPlugin_Intersection();
  77
  78 private:
  79   /// Load Naming data structure of the feature to the document.
  80   void loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
  81                     const std::shared_ptr<GeomAPI_Shape> theBaseShape,
  82                     const ListOfShape& theTools,
  83                     GeomAlgoAPI_MakeShape& theMakeShape);
  84 };
  85
  86 #endif