src/BuildPlugin/BuildPlugin_Solid.h

   1 // Copyright (C) 2017-20xx  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 BuildPlugin_Solid_H_
  22 #define BuildPlugin_Solid_H_
  23
  24 #include "BuildPlugin.h"
  25
  26 #include <GeomAPI_Shape.h>
  27 #include <ModelAPI_Feature.h>
  28
  29 class GeomAlgoAPI_MakeShape;
  30
  31 /// \class BuildPlugin_Solid
  32 /// \ingroup Plugins
  33 /// \brief Feature for creation of solid from faces or shells.
  34 class BuildPlugin_Solid: public ModelAPI_Feature
  35 {
  36 public:
  37   /// Use plugin manager for features creation
  38   BuildPlugin_Solid();
  39
  40   /// Feature kind.
  41   inline static const std::string& ID()
  42   {
  43     static const std::string MY_ID("Solid");
  44     return MY_ID;
  45   }
  46
  47   /// Attribute name of base objects.
  48   inline static const std::string& BASE_OBJECTS_ID()
  49   {
  50     static const std::string MY_BASE_OBJECTS_ID("base_objects");
  51     return MY_BASE_OBJECTS_ID;
  52   }
  53
  54   /// \return the kind of a feature.
  55   BUILDPLUGIN_EXPORT virtual const std::string& getKind()
  56   {
  57     static std::string MY_KIND = BuildPlugin_Solid::ID();
  58     return MY_KIND;
  59   }
  60
  61   /// Request for initialization of data model of the feature: adding all attributes.
  62   BUILDPLUGIN_EXPORT virtual void initAttributes();
  63
  64   /// Creates a new part document if needed.
  65   BUILDPLUGIN_EXPORT virtual void execute();
  66
  67 protected:
  68   /// Build result
  69   /// \param[out] theOriginalShapes list of original shapes
  70   /// \param[out] theAlgorithm      algorithm to build result
  71   /// \return \c true if algorithm finished without errors
  72   bool build(ListOfShape& theOriginalShapes, std::shared_ptr<GeomAlgoAPI_MakeShape>& theAlgorithm);
  73
  74   /// Store result of algorithm
  75   void storeResult(const ListOfShape& theOriginalShapes,
  76                    const GeomShapePtr& theResultShape,
  77                    const std::shared_ptr<GeomAlgoAPI_MakeShape>& theAlgorithm);
  78
  79   /// Check the algorithm is failed
  80   bool isAlgorithmFailed(const std::shared_ptr<GeomAlgoAPI_MakeShape>& theAlgorithm);
  81
  82   /// Explode compound to get single shape of specified type
  83   /// \return Empty shape if there is more than one shape in compound
  84   GeomShapePtr getSingleSubshape(const GeomShapePtr& theCompound,
  85                                  const GeomAPI_Shape::ShapeType theShapeType);
  86 };
  87
  88 #endif