src/FeaturesPlugin/FeaturesPlugin_Partition.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_Partition_H_
  22 #define FeaturesPlugin_Partition_H_
  23
  24 #include "FeaturesPlugin.h"
  25 #include <ModelAPI_Feature.h>
  26
  27 #include <GeomAlgoAPI_Partition.h>
  28
  29 /// \class FeaturesPlugin_Partition
  30 /// \ingroup Plugins
  31 /// \brief Feature for applying of Partition operations on Shapes. Partition makes conjunctional
  32 /// faces of solids as shared. The result of partitions is a compsolid.
  33 class FeaturesPlugin_Partition : public ModelAPI_Feature
  34 {
  35 public:
  36   /// Feature kind.
  37   inline static const std::string& ID()
  38   {
  39     static const std::string MY_ID("Partition");
  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   /// \return the kind of a feature.
  51   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  52   {
  53     static std::string MY_KIND = FeaturesPlugin_Partition::ID();
  54     return MY_KIND;
  55   }
  56
  57   /// Creates a new part document if needed
  58   FEATURESPLUGIN_EXPORT virtual void execute();
  59
  60   /// Request for initialization of data model of the feature: adding all attributes
  61   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  62
  63   /// Use plugin manager for features creation
  64   FeaturesPlugin_Partition();
  65
  66 private:
  67   /// Stores result of generation.
  68   void storeResult(ListOfShape& theObjects,
  69                    ListOfShape& thePlanes,
  70                    const GeomShapePtr theResultShape,
  71                    const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
  72                    const int theIndex = 0);
  73 };
  74
  75 #endif